Macro on ララジャパン

レスポンスマクロを一箇所にまとめて定義

Sat, 25 Aug 2018 05:51:31 +0900

前回、前々回のレスポンスのマクロの定義は、app/Providers/AppServiceProvider.phpのアプリのサービスプロバイダーに入れましたが、マクロの定義が増えてくると整理した方が良いのと、コントローラ以外では必要もないので、単独のサービスに移します。

まず、app/Providers/ResponseMacroServiceProvider.phpを作成して、２つのマクロを定義します。

app/Providers/ResponseMacroServiceProvider.php

namespace App\Providers;

use Illuminate\Routing\ResponseFactory;
use Illuminate\Support\Facades\View;
use Illuminate\Support\ServiceProvider;

class ResponseMacroServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap the application services.
     *
     * @param ResponseFactory $response
     * @return void
     */
    public function boot(ResponseFactory $response) //レスポンスのオブジェクトを渡すこと可能
    {
        $response->macro('viewWithS3', function ($view, $data) {
            $host = '//example.s3.amazonaws.com';
            $html = View::make($view)->with($data)->render();
            $output = preg_replace('#/user/images/#', $host . '/user/images/, $html);
            return $this->make($output); 
        });

        $response->macro('downloadNoCache', function ($path) {
            return $this->download($path, basename($path), [
                'Cache-Control' => 'no-store',
            ])->setPrivate();   // Cache-Controlにpublicが追加されるのを回避
        });
    }
}

上のboot()の関数の定義では、引数にレスポンスのオブジェクトを渡すことが可能です。以下に説明あります。

https://laravel.com/docs/5.5/providers#the-boot-method

この新しいサービスプロバイダーを使うには、以下のようにconfig/app.phpで登録が必要です。

config/app.php

return [
...
    'providers' => [
...

        /*
         * Application Service Providers...
         */
        App\Providers\AppServiceProvider::class,
        App\Providers\AuthServiceProvider::class,
        // App\Providers\BroadcastServiceProvider::class,
        App\Providers\EventServiceProvider::class,
        App\Providers\ResponseMacroServiceProvider::class,
        App\Providers\RouteServiceProvider::class,
    ],
...
];

これで以下のように、コントローラでこれらのマクロの使用が可能となります。

return response()->viewWithS3('user/product', compact('page', 'product'));

return response()->downloadNoCache($pathToFile);

レスポンスマクロでダウンロードファイルを保護

Sun, 19 Aug 2018 07:32:37 +0900

一度気に入ると、より使って見たくなるのが人の常。ということでさらにマクロの活用です。今回は、前回と同様なレスポンスマクロを使用して、サイトからダウンロードするファイルを保護します。

ファイルのダウンロード

ファイルのダウンロードの機能は、すでにLaravelでは提供されています。例えば、storage/data.txtのファイルのダウンロードは以下のようにコントローラのレスポンスにdownload()をチェーンして、ファイルダウンロードのレスポンスとします。

...
class DownloadFileController extends Controller
{
...
    public function download()
    {
        $pathToFile = storage_path() . '/data.csv';
        return response()->download($pathToFile);
    }
}

さて、ブラウザーで、このファイルのダウンロードのレスポンスのヘッダーを見ると、

HTTP/1.1 200 OK
Date: Fri, 17 Aug 2018 22:05:43 GMT
Server: Apache/2.4.27 (Fedora) OpenSSL/1.0.2k-fips PHP/7.1.14
X-Powered-By: PHP/7.1.14
Cache-Control: public
...

Cache-Control: publicの部分、パブリックと設定されているので、ファイルの中身がサーバーとクライアント（ユーザー）の間のプロキシでキャッシュされるかもしれません。このファイルが例えば公共に見られてよい画像とかなら問題はないのですが、ファイルがサイトの会員とか注文データだとセキュリティの問題となります。私としては以下と設定したいのです。

...
Cache-Control: private
...

ここを修正すべく、まず思ったのは、download()のパラメータを使用してのCache-Controlの設定です。

return response()->download($pathToFile, 'data.csv', ['Cache-control' => 'private']);

しかし、これが効きません! 相変わらず、レスポンスのヘッダーはCache-Control: publicです。試しに、以下のように違うCache-Controlの属性を設定してみると、

return response()->download($pathToFile, 'data.csv', ['Cache-control' => 'no-store']);

今度は、Cache-Control: no-store, publicという変な結果になりましたが、設定はできるようです。となると、どこかでprivateを弾いているみたいです。

どこでpublicが設定されている？

ymikomeさんが探偵のようにコードを追跡してくれました。

問題は、

vendor/laravel/framework/src/Illuminate/Routing/ResponseFactory.php

namespace Illuminate\Routing;
...
class ResponseFactory implements FactoryContract
{
...
    public function download($file, $name = null, array $headers = [], $disposition = 'attachment')
    {
        $response = new BinaryFileResponse($file, 200, $headers, true, $disposition); //ここの4番目のtrueの設定が問題！

        if (! is_null($name)) {
            return $response->setContentDisposition($disposition, $name, str_replace('%', '', Str::ascii($name)));
        }

        return $response;
    }
...

download()の定義の中の、BinaryFileResponse()のコールで、その4番目のtrueの値が、以下ようにsetPublic()のコールとなります。注意してください。もうここからは、Laravelのコードでなく、Symfonyのコードです。

vendor/symfony/http-foundation/BinaryFileResponse.php

namespace Symfony\Component\HttpFoundation;
...
class BinaryFileResponse extends Response
{
...
    public function __construct($file, $status = 200, $headers = array(), $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
    {
        parent::__construct(null, $status, $headers);

        $this->setFile($file, $contentDisposition, $autoEtag, $autoLastModified);

        if ($public) {
            $this->setPublic(); // $public = trueだからここを実行！
        }
    }
...

そして、このsetPublic()の定義は、

vendor/symfony/http-foundation/Response.php

namespace Symfony\Component\HttpFoundation;

/**
 * Response represents an HTTP response.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
class Response
{
...
    public function setPublic()
    {
        $this->headers->addCacheControlDirective('public');
        $this->headers->removeCacheControlDirective('private');　//ここでprivateが弾かれる！
    
        return $this;
    }
...

headersでprivateを設定してもここで抜かれる訳です。

どうprivateを設定する？

さて、Cache-Controlがいつもpublicとなる原因はわかりましたが、どうこれをprivateと設定するのが今度は問題となりました。ResponseFactory::download()を上書きするのが良いように思えますが、ResponseFactoryのクラスそのものを継承とかなるようで、trueをfalseとする目的のためには大袈裟すぎます。

困ったと思ったときに、見たのは先のSymfonyのコード、setPublic()の定義を含むファイルには、setPrivate()もあるではないですか！

ということで、以下のようなマクロの定義となりました。内部では一旦publicにしたものをprivateにすることになりますが、ここでは意図が明確でスッキリとしています。

       Response::macro('downloadNoCache', function ($path) {
            return $this->download($path, basename($path), [
                'Cache-Control' => 'no-store',
            ])->setPrivate();   // Cache-Controlにpublicが追加されるのを回避
        });

no-storeですが、これはブラウザがファイルをキャッシュするのを防ぎます。毎回ダウンロードでデータが変わるときには必要です。

このマクロの使用は、以下のようになります。

return response()->downloadNoCache($pathToFile);

この実行は以下のように思い通りのヘッダーとなりました。

HTTP/1.1 200 OK
Date: Fri, 17 Aug 2018 23:40:33 GMT
Server: Apache/2.4.27 (Fedora) OpenSSL/1.0.2k-fips PHP/7.1.14
X-Powered-By: PHP/7.1.14
Cache-Control: no-store, private
...

レスポンスマクロを使ってLaravel風に問題解決

Sun, 12 Aug 2018 01:02:23 +0900

前回、validate()のソースコードで登場したマクロ、今回は有用なマクロの活用の例を紹介します。

マクロに関してのLaravelのマニュアルでは以下で、response()のマクロの例が紹介されています。

https://laravel.com/docs/5.5/responses#response-macros

これを見て「あ、これはここで使える！」と思ったのは、コントローラから出力するHTMLの中身の画像のURLの変換です。

まずは、ちょっと背景説明を。

私のお客さんのサイトでは画像がかなり多いので、サーバー（EC2）の負担を減らすために画像はすべてAWSのS3にアップしています。どれだけアクセスがあっても画像はS3から配信されるのでサーバーが落ちる心配もないし、サーバーをアップグレードする必要もなくコストセーブとなります。

しかし、ブレードを管理するデザイナーに、

<img src="/user/images/example.jpg">

のような参照を、

<img src="//example.s3.amazonaws.com/user/images/example.jpg">

と毎回書き換えてもらうのは、やっかい。もちろん、エディターやsassとかでのプリ処理は可能だけれども、１つステップ増えるしプログラマでないデザイナーにはちょっと。また、S3のURLも本サイトと開発サイトでは変えたいケースもあり、そうしてもらうとこちらも困ります。

ということで、出力時にダイナミックに変えるのは必須となりました。ダイナミックに変えるには、ウェブサーバーでの設定でも可能ですが、やはり、HTMLの中にS3のURLが入るのがサーバーにも負担にならず、ユーザーにとっても表示速度の点で最適です。

このために、以下のようなユーザー定義のヘルパーを作成して、

Lob.php

// Lobは、私の会社 Lots of Bytesの略です。

class Lob {
    ...
    public static function view($view, $data)
    {       
        $host = '//example.s3.amazonaws.com';
        $html = View::make($view)->with($data)->render());
        $output = preg_replace('#/user/images/#', $host.'/user/images/, $html);    

        return response($output);
    }
　　...
}

コントローラで以下のように、コールしていました。

    return Lob::view('user/product', compact('page', 'product'));

これで用は足りるのですが、なんかLaravelらしくない。

そこで、マクロの登場です。

app/Providers/AppServiceProvider.phpを編集して、viewWithS3のマクロを定義します。

app/Providers/AppServiceProvider.php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Schema;

use Illuminate\Support\Facades\Response;
use Illuminate\Support\Facades\View;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        Schema::defaultStringLength(191);

        Response::macro('viewWithS3', function ($view, $data) {
            $host = '//example.s3.amazonaws.com';
            $html = View::make($view)->with($data)->render());
            $output = preg_replace('#/user/images/#', $host.'/user/images/, $html);

            // 以下の$thisは、AppServiceProviderのインスタンスでなく、Illuminate\Http\Response
            return $this->make($output); 
        });
    }
...
}

コントローラでは、以下のようにコールします。Laravelらしくわかりやすくなりましたね。

        return response()->viewWithS3('user/product', compact('page', 'product'));