All posts

Headless CMS Cockpit 公式のDockerイメージを使うと、日本語ファイル名が使えない問題

Headless CMS の Cockpit と Nuxt.js を使った Web サイトを制作していたところ、日本語のファイル名でアップロードしたファイルから、日本語の部分が削除されてしまいました。

Cockpit のソースコードを調べ、コンテナ内に日本語ロケールを追加したところ、今回の環境では日本語ファイル名を使えるようになりました。そのときの調査と設定のメモです。

この記事は Cockpit 0.9.2 の Docker イメージを使った当時の作業記録です。現在の Cockpit では、設定ファイルや日本語化の方法が異なる場合があります。

basename とロケールを確認する

Cockpit のソースコードを読んだところ、ファイル名の取得に PHP の basename() が使われていました。

PHP のドキュメントを確認すると、basename() はロケールの影響を受けることが分かりました。そこで、日本語ロケールを設定すれば改善するのではないかと考えました。[PHP の basename ドキュメント]

setlocale(LC_ALL, 'ja_JP.UTF-8');

Cockpit の実行時には設定ファイルの config.php が読み込まれるため、そこに追加すれば Cockpit 本体のソースを変更せずに済みそうです。

ところが、設定を追加してコンテナを再起動しても、ファイル名の問題は解消しませんでした。

コンテナ内のロケールを確認する

次に、Cockpit のコンテナ内で利用可能なロケールを確認しました。

locale -a

結果は次のとおりです。

C
POSIX

指定した ja_JP.UTF-8 がありません。setlocale() に名前を指定しても、OS 側でそのロケールを利用できなければ設定できないため、コンテナに追加することにしました。

Docker イメージにロケールを追加する

当時は、Cockpit の公式イメージを基に、次の Dockerfile を作成しました。

ARG COCKPIT_VERSION=0.9.2

FROM agentejo/cockpit:${COCKPIT_VERSION}

RUN apt-get install -y locales \
  && echo "ja_JP UTF-8" >> /etc/locale.gen \
  && locale-gen

COPY config.php /var/www/html/config/config.php
COPY ja.php /var/www/html/config/cockpit/i18n/ja.php

RUN echo "\n\nphp_value post_max_size 1024M" >> /var/www/html/.htaccess \
  && echo "\nphp_value upload_max_filesize 1024M" >> /var/www/html/.htaccess

ロケールの追加に加えて、次の設定も含めています。

  • カスタマイズした config.php を配置
  • 管理画面の日本語表示用ファイル ja.php を配置
  • PHP のアップロードサイズに関する設定を追加

この Dockerfile は当時の環境で使ったものです。特に post_max_size と upload_max_filesize を同じ値にした設定では、フォームのほかのデータも POST サイズに含まれるため、上限いっぱいのファイルを確実にアップロードできるわけではありません。

大きなファイルを扱う場合は、post_max_size を upload_max_filesize より大きくするほか、タイムアウトやサーバー側の制限も含めて確認する必要があります。[PHP の設定ディレクティブ]

config.php にロケール設定を追加する

config.php の先頭には、次のように setlocale() を追加しました。

<?php

setlocale(LC_ALL, 'ja_JP.UTF-8');

$configs = [];

if (!empty(getenv('COCKPIT_SESSION_NAME'))) {
    $configs['session.name'] = getenv('COCKPIT_SESSION_NAME');
}

if (!empty(getenv('COCKPIT_SALT'))) {
    $configs['sec-key'] = getenv('COCKPIT_SALT');
}

// 以下、既存の設定が続く

新しいイメージをビルドして起動したところ、今回の環境では日本語のファイル名を含むファイルをアップロードできるようになりました。

Discussion