Laravel のバックアップ(No.5)

_ 今日のLaravel

これは、2018アドベントカレンダー記事で、Laravel(5.4)を使った開発の中で気づいた事を毎日一つメモしていくものです。

今日のLaravel

_ 2018/12/5 resourceのroute名の変更方法

開発を進めていくと、routeの記述がどうしても長大になりがちな中で、resource定義は一行で複数の挙動が定義できて、しかもroute名も自動で定義してくれてとても助かります。
しかし、例えば以下のように別々のディレクトリ内で同じ定義名を使いたい場合があります。

1 2	`Route::resource('user/regist', 'UserHogeController'); Route::resource('product/regist', 'ProductHogeController');`

この場合、route名はどちらも「regist.index」等となってしまい、別々に識別することができなくなってしまいます。

この問題の解決方法として、マニュアルでは以下のように再定義できると書かれています。

  1
  2
  3

Route::resource('photo', 'PhotoController', ['names' => [
    'create' => 'photo.build'
]]);

しかし、アクションがindex,create,store,show,edit,update,destroyと7つもあるのに、いちいち書いていたらroute定義が無駄に長くなってしまいます。そこで、resource()のソースを確認すると、Illuminate\Routing\ResourceRegistrar::getResourceRouteName()で以下のように作成していました。

if (isset($options['names'])) {
    if (is_string($options['names'])) {
        $name = $options['names'];
    } elseif (isset($options['names'][$method])) {
        return $options['names'][$method];
    }
}
(後略)

stringも許可しています。なので、以下の通り指定すると7つのアクション全てを書き換えてくれます。

1 2	`Route::resource('user/regist', 'UserHogeController',['names'=>'user-regist']); Route::resource('product/regist', 'ProductHogeController',['names'=>'product-regist']);`

便利(^^)

↑

_ 2018/12/6 apiでセッションを使おうとするとformと両立できない

LaravelではAPIアクセスはapi.phpで定義できますが、ステートレスなアクセスを前提としているため、セッションを使うことができません。*1
参考ページの通りに対応すればセッションが有効になりますが、以下の手順で操作した場合にCSRFエラーになります。

フォームの中でボタンを押すとajaxを使用してAPIアクセス
フォームからpostでsubmit

想像ですが、APIアクセス時にセッション保持しているCSRFトークンが書き換わってしまい、フォームに埋め込まれたトークンと一致しなくなってしまうと考えられます。

私の場合はやむなく無認証にしましたが、どうしても認証したい場合は、アクセストークン方式にする必要があるのではないかと思います。

↑

_ 2018/12/7 php5とphp7での配列を使ったメソッド呼び出しの挙動の違い

以下のコードにおいて、php5とphp7で挙動の違いがありました。

<?php
 
class test {
 
    public function __construct() {
        echo "test!\n";
        $method[0] = "test2";
        $this->$method[0]();
    }
 
    private function test2() {
        echo "test2\n";
    }
 
}
 
new test();

php5(5.6.30)の場合
```
>php test.php
test!
test2
```

php7(7.1.24)の場合

>php test.php
test!
PHP Notice:  Array to string conversion in F:\test.php on line 8
PHP Stack trace:
PHP   1. {main}() F:\test.php:0
PHP   2. test->__construct() F:\test.php:17
        :
PHP Fatal error:  Uncaught Error: Function name must be a string in F:\test.php:8

どうやら変数が配列の場合、php7だと「$this->$method」で一旦区切って解釈するようです。

解決方法は以下の通り。

-	$this->$method[0]();
+	$this->{$method[0]}();

これでphp5でも7でも動作するコードになりました。

↑

_ 2018/12/8 WYSWYGエディタには要注意

WYSWYGはWhat You See What You Getの略で、直訳すると見たままの物が得られる、という意味です。
そんなの当たり前じゃん、と言っているそこの若者！これが誕生した頃は画期的だったのですよ（Appleが広めた）。

まあそんなことはいいとして、フリーで使えるWYSWYGエディタは各種あります。*2
私が試したのはTrumbowyg。簡単にこんなTEXTAREAが得られます。

使い方はこんな感じ。

{{Form::textarea('description')}}
 {{Html::style(asset('trumbowyg/dist/ui/trumbowyg.min.css'))}}
 {{Html::script(asset('trumbowyg/dist/trumbowyg.min.js'))}}
 {{Html::script(asset('trumbowyg/dist/langs/ja.min.js'))}}
 <script language="JavaScript">
    $('textarea').trumbowyg({
        lang: 'ja',
    });
 </script>

(スクショはプラグインを幾つか入れてます)

このエディタ、画面上に得るべき物を表示しているということは、HTMLタグをレンダリングしているということになります。このTrumbowygは生HTMLも書けるので、試しにJavascriptタグを埋めてみます。

そして生HTMLモードを解除してみると・・・

うーん、ダメだこりゃ。これではユーザーが自由にこのサーバー上でJavascriptを動かせちゃうということです。
生HTMLは書けないモードにして使う必要がありそうです。
Trumbowygはボタンのカスタマイズができますので、例えばこんな感じです。

<script language="JavaScript">
    $('textarea').trumbowyg({
        lang: 'ja',
        btns: [
            ['undo', 'redo'], // Only supported in Blink browsers
            ['formatting'],
            ['strong', 'em', 'del'],
            ['superscript', 'subscript'],
            ['link'],
            ['insertImage'],
            ['justifyLeft', 'justifyCenter', 'justifyRight', 'justifyFull'],
            ['unorderedList', 'orderedList'],
            ['horizontalRule'],
            ['removeformat'],
            ['fullscreen'],
        ]
    });
</script>

ただし、これでもブラウザのJavascriptを無効にして、<script>タグ書いて、再度有効にすればやはり実行できます。うーん悩ましい・・・。

↑

_ 2018/12/9 Laravelのファイルストレージ(S3)を使う

一番ひっかかっのはS3の設定です(^^;)。当初S3の設定が良く分からなかったのですが、こちら*3に非常に詳しく書かれています。感謝！
S3のバケットを作るだけではダメで、S3とは独立した設定でユーザーを作るのが必要でした。AWSの基本?(^^;)
但し、上記の方法はユーザーの認証情報とバケットを結びつけていないため、このユーザーのS3には全てアクセスできてしまうと思われます。実際には当該バケットに限定した権限設定が必要でしょう。

まずはコードの確認でlocalに保存してみます。

View
1 2 3 4
{{Form::open(['files' => true])}} {{Form::file('file')}} {{Form::submit()}} {{Form::close()}}
いや、まあこれだけじゃないでしょうけど(笑)、Form::open()に'files' => trueを付けるのを忘れずに。

Controller

  1
  2
  3

$file = $request->file('file');
$filename = $file->getClientOriginalName();
$path= Storage::disk('local')->putFile('hoge', $file);

hogeはサブディレクトリ名です。特に必要がなければ'/'。

すると、storage/app/hogeの下に、ユニークなファイル名でファイルが保存されます。(Oc4GsSGFIe3NkjnUUttt4mnaRtpKklQhv5ZArdMq.txt みたいな感じ)
従って、元のファイル名はgetClientOriginalName()を使って別途保存しておく必要があります。

次に、S3に保存してみます。
これは簡単で、コードを以下のように変えるだけです。(もちろんS3の設定、.envの設定、league/flysystem-aws-s3-v3の導入は済んでいる前提です)

1	`$path= Storage::disk('s3')->putFile('hoge', $file);`

しかし、ここで問題が起きました（ネタ、来た(笑)）
以下のようなエラーが発生しました。

要約すると、ローカルの証明書が無いからSSLアクセスができない、ということです。調べるとWindowsのCURLはデフォルトで証明書が無いためSSLアクセスがエラーになるということが分かりました（S3関係ないやん・・・(笑)）。
検索するとCURLにオプションを付ける対策などが出てくるのですが、LaravelFWをいじることになるので却下。
こちら*4のページにある方法で解決しました。

http://curl.haxx.se/ca/cacert.pemから証明書をダウンロード。
適当なディレクトリに保存。
php.iniでcurl.cainfo = "C:\php5.6.37\cacert.pem"のように指定
Apache再起動

実行後、S3のコンソールでファイルが確認できれば成功です。
ちなみに、localからS3に切り替える場合、いちいちコードを修正しなければいけないのでしょうか? もちろんそんなことはありません。Storage::disk()のソースを見ると、

public function disk($name = null)
{
   $name = $name ?: $this->getDefaultDriver();
   return $this->disks[$name] = $this->get($name);
}
      :
public function getDefaultDriver()
{
   return $this->app['config']['filesystems.default'];
}

のようになっています。つまりStorage::disk()と引数無しにしておけば、.envを変更するだけで切り替えられるようになります。（もちろん切り替え時のデータ移行は必要ですけど）

LaravelでセッションIDで認証状態をチェックするステートフルなAPIを使う
https://qiita.com/pinekta/items/d10c8374b1a3003cd952

商用でも利用できる、イケてるWYSIWYGエディタ7選 2017年版
https://engineer.blog.lancers.jp/2017/12/wysiwyg_editor_best_7/

超簡単！LaravelでS3を利用する手順
https://qiita.com/tiwu_official/items/ecb115a92ebfebf6a92f

cURL error 60: SSL certificate in Laravel 5.4
https://stackoverflow.com/questions/42094842/curl-error-60-ssl-certificate-in-laravel-5-4

skimemo