[Laravel7.x] マルチテナントアーキテクチャで構築する2

8系がうまくいかないので、7系でやります。

$ composer create-project –prefer-dist laravel/laravel tenancy “7.*”
$ cd tenancy
$ php artisan -V
Laravel Framework 7.30.4

config/database.phpと.envを編集
$ composer require “hyn/multi-tenant:5.6.*”
$ php artisan vendor:publish –tag=tenancy
$ php artisan migrate –database=system
mysql> use tenancy
mysql> show tables;
mysql> describe users;
mysql> describe hostnames;
+————————-+—————–+——+—–+———+—————-+
| Field | Type | Null | Key | Default | Extra |
+————————-+—————–+——+—–+———+—————-+
| id | bigint unsigned | NO | PRI | NULL | auto_increment |
| fqdn | varchar(255) | NO | UNI | NULL | |
| redirect_to | varchar(255) | YES | | NULL | |
| force_https | tinyint(1) | NO | | 0 | |
| under_maintenance_since | timestamp | YES | | NULL | |
| website_id | bigint unsigned | YES | MUL | NULL | |
| created_at | timestamp | YES | | NULL | |
| updated_at | timestamp | YES | | NULL | |
| deleted_at | timestamp | YES | | NULL | |
+————————-+—————–+——+—–+———+—————-+

### テナントの作成
テナントを作成すると同時にデータベースにテーブルが作成されるが、テーブルの作成には前準備が必要となる。
テナント用のテーブルを作成するmigration fileはmigrations/tenant以下に作成する
https://tenancy.dev/docs/hyn/5.6/migrations

config/tenancy.php

'tenant-migrations-path' => database_path('migrations/tenant'),

'uuid-limit-length-to-32' => env('LIMIT_UUID_LENGTH_32', true),

$ cd database/migrations
$ mkdir tenant
$ ls
2014_10_12_000000_create_users_table.php
2014_10_12_100000_create_password_resets_table.php
2017_01_01_000003_tenancy_websites.php
2017_01_01_000005_tenancy_hostnames.php
2018_04_06_000001_tenancy_websites_needs_db_host.php
2019_08_19_000000_create_failed_jobs_table.php
tenant
// usersとpassword_resetsもtenantの中に入れる
$ cp 2014_10_12* tenant

### テナント作成
https://tenancy.dev/docs/hyn/5.6/creating-tenants
routes/web.php

use Hyn\Tenancy\Models\Hostname;
use Hyn\Tenancy\Contracts\Repositories\HostnameRepository;
use Hyn\Tenancy\Models\Website;
use Hyn\Tenancy\Contracts\Repositories\WebsiteRepository;


Route::get('create_tenant', function () {

    $website = new Website;
    app(WebsiteRepository::class)->create($website);

    $hostname = new Hostname;
    
    $hostname->fqdn = 'test.localhost';
    $hostname = app(HostnameRepository::class)->create($hostname);

    app(HostnameRepository::class)->attach($hostname, $website);
    
	return redirect('/');

});

$ php artisan serve –host 192.168.33.10 –port 8000
http://192.168.33.10:8000/create_tenant

mysql> select * from hostnames;
+—-+—————-+————-+————-+————————-+————+———————+———————+————+
| id | fqdn | redirect_to | force_https | under_maintenance_since | website_id | created_at | updated_at | deleted_at |
+—-+—————-+————-+————-+————————-+————+———————+———————+————+
| 1 | test.localhost | NULL | 0 | NULL | 1 | 2021-02-13 09:07:52 | 2021-02-13 09:07:52 | NULL |
+—-+—————-+————-+————-+————————-+————+———————+———————+————+
1 row in set (0.00 sec)

mysql> select * from websites;
+—-+———————————-+———————+———————+————+——————————–+
| id | uuid | created_at | updated_at | deleted_at | managed_by_database_connection |
+—-+———————————-+———————+———————+————+——————————–+
| 1 | 214594e5f86a418bbd990b6583d37131 | 2021-02-13 09:07:52 | 2021-02-13 09:07:52 | NULL | NULL |
+—-+———————————-+———————+———————+————+——————————–+
1 row in set (0.00 sec)
mysql> show databases;

OK, なんとなくマルチテナントの仕組みはわかったかも。
vagrantで開発している場合、mac側で名前解決せなあかんね。

[Laravel 8.x] Composerのパッケージ作成手順しようと思ったが…

composer.json

{
    "name": "laravel/laravel",
    "type": "project",
    "description": "The Laravel Framework.",
    "keywords": [
        "framework",
        "laravel"
    ],
// 省略

composer.jsonから、name -> “laravel/laravel” となっていることがわかる。

composer.json

"autoload": {
        "psr-4": {
            "App\\": "app/",
            "Database\\Factories\\": "database/factories/",
            "Database\\Seeders\\": "database/seeders/",
            "Laravel\\Laravel\\" : "app/Providers/" // 追加
        }
    },


    "extra": {
        "laravel": {
            "dont-discover": [],
            "providers": [
                "Laravel\\Laravel\\HogeServiceProvider"
            ]
        }
    },
[/code]

$ php artisan make:provider HogeServiceProvider
app/Providers/HogeServiceProvider.php

namespace Laravel\Laravel; // 修正
use Illuminate\Support\ServiceProvider;

class HogeServiceProvider extends ServiceProvider
{
    public function register()
    {}
    public function boot()
    {
        //
        dump("What's up Laravel!");
    }
}

composer.json

"repositories": [
        {
            "type": "path",
            "url" : "packages/username/hoge",
            "symlink": true
        }
    ],
    "require": {
        // 省略
        "hpscript/hoge": "dev-master"
    },

$ composer update

[RuntimeException]
The `url` supplied for the path (packages/username/hoge) repository does not exist

うーん、なんかちゃうな。。
packageの作り方を良く理解してないようだ。

[Laravel8.16.0] CSVをimportする

1.fopenして、fputcsvで作成する手法。

public function csv(){
        $ary = [
            ["山田", "12", "O",""],
            ["田中", "20", "A",""],
            ["吉田", "18", "AB",""],
            ["伊藤", "19", "B", "エンジニア"]
        ]; 

        foreach($ary as $key => $value){
             array_splice($ary[$key], 1, 0, "");
        }

        $column = ["名前", "無記入", "年齢", "血液型", "備考"];
        array_unshift($ary, $column);

        $filename = "hogehoge.csv";
        $f = fopen($filename, "w");
        stream_filter_prepend($f,'convert.iconv.utf-8/cp932');
        if($f) {
            foreach($ary as $line){
                fputcsv($f, $line);
            }
        }
        header('Content-Type: application/octet-stream');
        header('Content-Length: '.filesize($filename));
        header('Content-Disposition: attachment; filename=hogehoge.csv');

        readfile($filename);
    }

2. StreamedResponseを使う書き方

public function csv(){
        $data = User::all(); 
        $response = new StreamedResponse(function() use($data){
                $stream = fopen('php://output', 'w');
                stream_filter_prepend($stream, 'convert.iconv.utf-8/cp932//TRANSLIT');
                fputcsv($stream, ['id','name','email',]);
                foreach($data as $user){
                     fputcsv($stream, [$user['id'],$user['name'],$user['email'],]);
                }
                fclose($stream);
        });
        $response->headers->set('Content-Type', 'application/octet-stream');
        $response->headers->set('Content-Disposition', 'attachment; filename="user.csv"');
        return $response;
    }

やってることは一緒なんだけど、StreamedResponseの方が良い。

[Laravel8.16.0] バッチ処理を実装する

$ php artisan make:command TestBatch

-> app/Console/Commands に TestBatch.phpが出来ます。

protected $signature = 'batch:test';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        echo "hello";
    }

$ php artisan list
batch
batch:test Command description

$ php artisan batch:test
hello

あとはsudo vi /etc/crontab で、$ php artisan batch:testを実行すればいいだけ。
そうだ、思い出した。

Laravel7.x、EC2でphp artisan down –allow=${ip}が効かない時

本番環境でメンテナンスモードにして、特定のIPだけ操作を許可したい場合は、

$ php artisan down --allow=${ip}

と書く。EC2で実行したところ、指定したipでもメンテナンスモードの画面に。

EC2 ELB: ELBを使って、SSL対応している

ELBを挟んでいるため、ip取得のclassにHTTP_X_FORWARDED_FORを追加する
$ sudo vi vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/CheckForMaintenanceMode.php

public function handle($request, Closure $next)
    {
        if ($this->app->isDownForMaintenance()) {
            $data = json_decode(file_get_contents($this->app->storagePath().'/framework/down'), true);

            // 追加
            if (isset($data['allowed']) && IpUtils::checkIp($request->server->get('HTTP_X_FORWARDED_FOR'), (array) $data['allowed'])) {
                return $next($request);
            }

            if (isset($data['allowed']) && IpUtils::checkIp($request->ip(), (array) $data['allowed'])) {
                return $next($request);
            }

            if ($this->inExceptArray($request)) {
                return $next($request);
            }

            throw new MaintenanceModeException($data['time'], $data['retry'], $data['message']);
        }

        return $next($request);
    }

※HTTP_X_FORWARDED_FOR: リバースプロキシを挟んだアクセス元のIPを取得する

これで、メンテナンスモード時に、特定IPのみ操作できるようになります。
$ php artisan down –allow=${myIP}
$ php artisan up

Laravel 6.x command(スケジューラ)の使い方

### make:command
$ php artisan make:command TestCommand

app/Console/Commands/TestCommand.php

protected $signature = 'command:testcommand';
public function handle()
    {
        //
        echo "test command execute!";
    }

app/Console/Kernel.php

 protected $commands = [
        //
        \App\Console\Commands\TestCommand::class,
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        // $schedule->command('inspire')
        //          ->hourly();
        $schedule->command('command:testcommand')->daily();
    }

### command実行
$ php artisan list;
$ php artisan command:testcommand;

$ crontab -e

実用性から考えると、バッチ処理はcronで直書きの方が楽そうですが、Githubなどで全てソースコードで管理したい場合は使えるかもしれません。どちらが良いかは好みやコンセンサスでしょうか。

Laravel Logの設定

### .env
Log channelはdefaultでstackに設定されている

LOG_CHANNEL=stack

### config/logging.php
stackで、channelsは’single’に設定されています。

'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['single'],
            'ignore_exceptions' => false,
        ],

        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
        ],
        // 省略
    ],

### ログの出力先
storate/logs/laravel.log

###コマンドラインで出力
less +F storage/logs/laravel.log

### controllerからログ出力
$ php artisan make:controller –resource LogController

Route::get('log', 'LogController@index');
public function index()
    {
        //
        \Log::info('ログ出力test');
        return 'test';
    }

heplerを使う場合

logger()->info('something has happened');

laravel.log

[2020-02-24 14:13:10] local.INFO: ログ出力test 
[2020-02-24 14:22:10] local.INFO: something has happened  

### ログレベル
emergency, alert, critical, error, warning, notice, info, debug

ログの設定は、運用体制と併せて柔軟に検討する必要がある。

laravelでcsv出力

### view
csvダウンロードボタンを作り、postメソッドのhiddenで引数を渡します。

{!! Form::open(['method'=>'POST', 'action'=>['HogeController@download'] ]) !!}
 <input type="hidden" name="period" value="{{ $inputs&#91;'data'&#93; }}">
 {!! Form::submit('CSVダウンロード',['class'=>'btn', 'name'=>'csv']) !!}
{!! Form::close() !!}

### route
csvファイルをreturnするだけなので、設計のコンベンションが無ければディレクトリは然程きにする必要なし。

Route::post('/dir/csv', 'HogeController@download');

### controller

use Symfony\Component\HttpFoundation\StreamedResponse;
public function download(Request $request){
// 省略

// CSV生成
        $response = new StreamedResponse(function() use($data1, $data2){
                $stream = fopen('php://output', 'w');
                stream_filter_prepend($stream, 'convert.iconv.utf-8/cp932//TRANSLIT');
                fputcsv($stream, ['id','raw1','raw2','raw3','raw4','raw5']);
                foreach($data as $value){
                     fputcsv($stream, ['id',$value->raw1,$value->raw2,$value->raw3,$value->raw4,$value->raw5]);
                }
                fclose($stream);
        });
        $response->headers->set('Content-Type', 'application/octet-stream');
        $response->headers->set('Content-Disposition', 'attachment; filename="user.csv"');
        return $response;

特段ストレージやS3などに一時保存しなくて良いので、シンプルだ。
上記はユーザがダウンロードボタンを押した時の処理だが、月次のバッチ処理によるcsv出力なども比較的簡単に実装できそうだ。

LaravelでtinyMCE & filemanagerの使い方

tinyMCEだと、textareaで文字の装飾はもちろん画像の挿入ができる

### viewの作成
views/includes/tinyeditor.blade.php

<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/5/tinymce.min.js" referrerpolicy="origin"></script>
<script>tinymce.init({selector:'textarea'});</script>

posts/create.blade.php

@extends('layouts.admin')

@section('content')

    @include('includes.tinyeditor')
...

### filemanager install
https://unisharp.github.io/laravel-filemanager/installation

$ php composer.phar require unisharp/laravel-filemanager
$ php composer.phar require intervention/image

Unisharp\Laravelfilemanager\LaravelFilemanagerServiceProvider::class,
        Intervention\Image\ImageServiceProvider::class,

'Image' => Intervention\Image\Facades\Image::class,

$ php artisan vendor:publish –tag=lfm_config
$ php artisan vendor:publish –tag=lfm_public

### tinyeditor.blade.php

<script src="//cdn.tinymce.com/4/tinymce.min.js"></script>
<script>
  var editor_config = {
    path_absolute : "/",
    selector: "textarea",
    plugins: [
      "advlist autolink lists link image charmap print preview hr anchor pagebreak",
      "searchreplace wordcount visualblocks visualchars code fullscreen",
      "insertdatetime media nonbreaking save table contextmenu directionality",
      "emoticons template paste textcolor colorpicker textpattern"
    ],
    toolbar: "insertfile undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image media",
    relative_urls: false,
    file_browser_callback : function(field_name, url, type, win) {
      var x = window.innerWidth || document.documentElement.clientWidth || document.getElementsByTagName('body')[0].clientWidth;
      var y = window.innerHeight|| document.documentElement.clientHeight|| document.getElementsByTagName('body')[0].clientHeight;

      var cmsURL = editor_config.path_absolute + 'laravel-filemanager?field_name=' + field_name;
      if (type == 'image') {
        cmsURL = cmsURL + "&type=Images";
      } else {
        cmsURL = cmsURL + "&type=Files";
      }

      tinyMCE.activeEditor.windowManager.open({
        file : cmsURL,
        title : 'Filemanager',
        width : x * 0.8,
        height : y * 0.8,
        resizable : "yes",
        close_previous : "no"
      });
    }
  };

  tinymce.init(editor_config);
</script>

### config
lfm.php

'base_directory' => 'public',
'images_folder_name' => 'images',

### view
post.blade.php

<p>{!! $post->body !!}</p>

{{$post->body}}だと画像が表示されないので注意が必要
殆ど公式に書いてあるので、公式との闘いになりそう

Gravatarとは?

https://ja.gravatar.com/support/what-is-gravatar/

Model User.php

public function getGravatarAttribute(){
        $hash = md5(strtolower(trim($this->attribute['email'])));
        return "http://www.gravatar.com/avatar/$hash";
    }

Viewのimg srcでAuth::user()->gravatar()と書くと、gravatarに登録した画像が表示される

公式ドキュメント
https://ja.gravatar.com/site/implement/images/
https://www.gravatar.com/avatar/${hashedUrl}

あんまり使ってるの見たことないけど、アバターのマイナンバーみたいな発想は面白い