ファイルのダウンロード on ララジャパン

ダウンロードファイル名禁止文字に対応

Sun, 14 Jun 2020 08:58:25 +0900

Windows 10では、ファイル名として使用してはいけない文字がいくつかあります。入力しようとすると、「ファイル名に次の文字は使えません」とエラーになります。さて、ダウンロードのファイルにこれらの禁止文字が使用されていたらどうしましょう？

例えば、サーバーにアップされているファイル名は「567.jpg」と商品ID.jpgのフォーマットとします。しかし、ユーザーがダウンロードする時には「世界一おいしい? りんご、4/1から販売.jpg」と商品名.jpgにしたいときです。しかし、商品名に含まれる、?（半角疑問符）や/（半角バックスラッシュ）が禁止文字なのです。

手っ取り早いのは、半角の禁止文字を皆全角に置き換えてしまえばよいです。

ということでヘルパーの関数を作成します。

app/Helpers/MyHelper.php

namespace App\Helpers;

class MyHelper
{
    /**
     * 禁止半角文字を全角に
     * @param  string $value
     * @return  string
     */
    public static function convertToValidFilename($value)
    {
        $from = ['\\', '/', ':', '*', '?', '"', '>', '<', '|'];
        $to = ['￥', '／', '：', '＊', '？', '”', '＞', '＜', '｜'];

        $patterns = array_map(function($val) { return '#\\'.$val.'#'; }, $from);

        return preg_replace($patterns, $to, $value);
    }
}

preg_replace()の最初の引数に、その前の行のarray_map()で作成された配列を与えているところに注意してください。

通常は、

>>> preg_replace('/123/', 'xyz', '01234');
=> "0xyz4"

のように、パターンには/（半角スラッシュ）で囲んだ文字列を与えますが、配列を与えて複数の置き換えをすべて実行することもできます。

convertToValidFilename()では、$patternsが以下のような配列となり、

Array
(
    [0] => #\\#
    [1] => #\/#
    [2] => #\:#
    [3] => #\*#
    [4] => #\?#
    [5] => #\"#
    [6] => #\>#
    [7] => #\<#
    [8] => #\|#
)

これらは、以下の対応する$toに、

Array
(
    [0] => \
    [1] => /
    [2] => :
    [3] => *
    [4] => ?
    [5] => "
    [6] => >
    [7] => <
    [8] => |
)

に置き換えます。

パターンにおいて、通常使われる/（半角バックスラッシュ）の代わりに、#（半角シャープ）で囲まれているのは、/（半角バックスラッシュ）がパターン内の文字としてありエスケープ文字となってしまうからです。preg_replace()のパターンの境界文字は、そのように必要に応じて変えることができるのです。

早速、tinkerを使用して試してみましょう。

>>> use App\Helpers\MyHelper;
>>> MyHelper::convertToValidFileName('世界一おいしい? りんご、4/1から販売.jpg');
=> "世界一おいしい？ りんご、4／1から販売.jpg"

禁止文字が半角から全角に置き換わりましたね。

最後に、これを用いたコントローラのダウンロードメソッドは、こんな感じとなります。

public function download(Product $product)
{
    Storage::download(storage_path().'/'.$product->product-id.'.jpg',     
        MyHelper::convertToValidFileName($product->name).'jpg');
}

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

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
...