LaravelのFilesystem S3アダプタ管理下のオブジェクトをバケット間コピー

Laravelには色んな種類のファイルシステムを操作する便利機能が用意されていて当然その対象にはS3も含まれている。

ちょっとS3バケット間でファイルをコピーしたいと思った。

こんなメソッドシグネチャで考える。

<?php
function copyOverBucket($fromDiskName, $fromPath, $toDickName, $toPath);

LaravelのFileSystem（実体は File Storage Abstraction for PHP - Flysystem ）には汎用的なファイル操作APIが提供されている。

そこに別のFileSystemインスタンスとの間のファイルコピーはない。

したがって、素直にコピーしようとするとこのようになる。

<?php
function copyOverBucket($fromDiskName, $fromPath, $toDickName, $toPath) {
  Storage::disk($toDiskName)->put($toPath, Storage::disk($fromDiskName)->get($fromPath));
}

そうするとコピー元のS3バケットから一度オブジェクトをダウンロードして、それをコピー先のS3バケットにアップロードする動きになる。

（実際には大して問題にならないレイテンシや転送量のコストでも気分的に）嫌だ。

バケット間で直接コピーしたい。

PHPのSDKを直接使用したサンプルは提示されている。

docs.aws.amazon.com

Aws S3 (v3) Adapter - Flysystem の実装も参考になりそうだ。

github.com

とりあえず動きはした。

Aws S3 (v3) Adapterはしっかり実装が隠蔽されていて無理やりな感じになってしまった。

汎用的なファイル操作APIとS3固有のAPIでの操作を混在させるのは筋が悪いかもしれない。参考程度に見てください。

<?php
function copyOverBucket($fromDiskName, $fromPath, $toDickName, $toPath) {
        // AwsS3V3Adapter がプレフィクサを公開していないので実装に合わせて処理する
        $fromDisk = Storage::disk($fromDiskName);
        $fromPrefixer = new PathPrefixer($fromDisk->getConfig()['path'] ?? '');
        $toDisk = Storage::disk($toDiskName);
        $toPrefixer = new PathPrefixer($toDisk ->getConfig()['path'] ?? '');

        // S3ディスクの実体はちょっと拡張されたラッパーなのでS3のクライアントを取得できる
        $toDisk->getClient()->copyObject([
            'Bucket'     => $toDisk->getConfig()['bucket'],
            'Key'        => $toPrefixer->prefixPath($toPath),
            'CopySource' => "{$fromDisk->getConfig()['bucket']}/{$fromPrefixer->prefixPath($fromPath)}",
        ]);
}