アーカイブの展開
🤖/file/decompress はアーカイブ全体を展開し、他の Robot で処理したり、個別のファイルとしてエクスポートしたりできるようにします。

この Robot は、次のアーカイブ形式に対応しています。
- ZIP アーカイブ(非圧縮または「deflate」圧縮のエントリーに対応、パスワード保護付きも含む)
- 7-Zip アーカイブ(AES-256 暗号化も含む)
- RAR アーカイブ(暗号化されたものも含む)
- GNU tar 形式(GNU の長いファイル名、長いリンク名、スパースファイルも含む)
- Solaris 9 拡張 tar 形式(ACL も含む)
- 旧 V7 tar アーカイブ
- POSIX ustar
- POSIX pax 交換形式
- POSIX オクテット指向 cpio
- SVR4 ASCII cpio
- バイナリ cpio(ビッグエンディアンまたはリトルエンディアン)
- ISO9660 CD-ROM イメージ(オプションの Rockridge または Joliet 拡張に対応)
- GNU および BSD の「ar」アーカイブ
- 「mtree」形式
- Microsoft CAB 形式
- LHA および LZH アーカイブ
- XAR アーカイブ
この Robot は、アーカイブファイルを評価する前に、次の形式や圧縮方式も検出して処理します。
- uuencode されたファイル
- RPM ラッパー付きのファイル
- gzip 圧縮
- bzip2 圧縮
- compress/LZW 圧縮
- lzma、lzip、xz 圧縮
セキュリティ上の理由により、アーカイブ内のディレクトリの外部を指すシンボリックリンクが含まれている場合、Assembly は失敗します。
入力アーカイブごとに、展開後のデータの累計は 10 GiB、ファイルとディレクトリのエントリー数の累計は暗黙の親ディレクトリを含めて 10,000 に制限されます。最初の展開、入れ子のアーカイブ、中間アーカイブファイルはすべてこの上限に計上されます。中間アーカイブを削除しても、その分の使用量は戻りません。
最初の展開後、入れ子のアーカイブは最大 10 回にわたって展開されます。展開とファイル名の正規化には、合計 10 分の制限時間があります。リソースの上限を超えると、Assembly は FILE_DECOMPRESS_INVALID_INPUT エラーで失敗します。上限を超える場合は、より小さいアーカイブを使用してください。
展開されたファイルとディレクトリの名前に含まれる、対応するアクセント付きラテン文字とキリル文字は翻字されます。たとえば、café.pdf は cafe.pdf になります。
パスワード保護されたアーカイブ(ZipCrypto または AES 暗号化を使用する ZIP、暗号化された RAR、AES-256 を使用する 7z)には、password パラメーターで対応しています。
使用例
アップロードしたアーカイブを展開します:
{
"steps": {
"decompressed": {
"robot": "/file/decompress",
"use": ":original"
}
}
}パラメーター
interpolateboolean | Record<string, boolean>処理設定の各フィールドで Assembly Variables を展開するかどうかを制御します。
デフォルトでは、Robot の処理設定のほとんどのフィールドで Assembly Variables が展開されます。すべての設定フィールドをリテラルテキストとして扱うには、このパラメーターを
falseに設定してください。特定のフィールドだけをリテラルテキストとして扱うには、そのフィールドのパスをfalseに設定してください。デフォルトでリテラルとして扱われる Robot 固有のフィールドで展開を有効にするには、このパラメーターをtrueに設定するか、そのフィールドのパスをtrueに設定してください。pathのようなフィールド名を使用してください。ネストされたオブジェクトには、ffmpeg.vfのようなドット区切りのパスを使用してください。output_metaRecord<string, boolean> | boolean | Array<string>算出に多くの CPU リソースを要するメタデータを指定できます。Assembly の処理速度を維持するため、これらはデフォルトで無効になっています。
画像の場合、このオブジェクトに
"has_transparency": trueを追加すると、画像に透明な部分が含まれるかどうかを抽出できます。"dominant_colors": trueを追加すると、画像から 16 進数のカラーコードの配列を抽出できます。画像の場合、
"blurhash": trueを追加すると、画像のプレースホルダーをコンパクトに表す BlurHash 文字列も抽出できます。画像全体の読み込み中に、ぼかしたプレビューを表示するのに役立ちます。画像の場合、代わりに
"thumbhash": trueを使用すると、base64 エンコードされた ThumbHash をmeta.thumbhashに抽出し、meta.has_alpha(完全に不透明な場合も含め、アルファチャンネルが存在するかどうか)も抽出します。ThumbHash は EXIF の向きを反映したピクセルを表し、アニメーション画像では最初のフレームを使用します。抽出はベストエフォートです。40 メガピクセルを超える画像、非対応の形式、デコードの失敗やデコード処理の上限への到達があった場合、プレースホルダーは生成されません。抽出に成功すると、そのファイルのバイト数の 20% に相当するメタデータ料金が加算されます。無効な場合やハッシュが生成されない場合、ThumbHash の追加料金は発生しません。このオプションは画像を生成する Step に設定してください。たとえば、アップロードされた元画像では
/upload/handle、処理済みの出力では/image/resizeに設定します。/transloadit/storeにのみ設定しても、抽出は要求されません。ストレージは生成元のメタデータを保持します。Transloadit Storage は生成されたハッシュをその不変のバージョンとともに永続化し、保存済みの結果やネイティブのアセット読み取り時に返します。S3 への直接アップロードではプレースホルダーは生成されません。プレースホルダーには画像情報が含まれるため、画像全体と同じアクセス制御で保護してください。動画の場合、
"colorspace": trueパラメーターを追加すると、出力動画の色空間を抽出できます。動画の場合、
"interlaced": trueを追加すると、インターレース動画かどうかも検出できます。これは、低コストの ffprobe のfield_orderフラグと、ソースの先頭フレームに対する処理範囲を制限したidetサンプリング処理を組み合わせ、file.metaの下にinterlaced、field_order、診断用のinterlace_detectionオブジェクトを出力します。この処理は計算コストが高く、それに応じて課金されます。音声の場合、
"mean_volume": trueを追加すると、音声ファイルの平均音量を表す単一の値を取得できます。また、
falseに設定すると、メタデータの抽出をスキップしてトランスコードを高速化できます。user_metaRecord<string, any>(デフォルト:{})出力される各ファイルに、ファイルの内容を変更せずにカスタム JSON メタデータを追加します。ネストしたオブジェクトと配列に対応しています。
継承の動作は Robot によって異なります。値は出力ファイルの既存の
user_metaとマージされ、一致するトップレベルのキーは現在の Step によって置き換えられます。Robot が新しい出力を作成する場合は、必要なキーを明示的に割り当ててください。処理 Step では、
${file.*}は最初の入力を、${result.*}は出力されるファイルを参照します。値は Robot の実行後、後続のメタデータ抽出と一時保存の前に、出力ごとに評価されます。:originalでは、メタデータ抽出の前にアップロードごとに値が評価されます。後続の Step は
${file.user_meta.key}を読み取ります。完全な例と継承ルールについては、カスタムメタデータ を参照してください。resultboolean(デフォルト:false)この Step の結果を Assembly Status JSON に含めるかどうか
queuebatchqueue を 'batch' に設定すると、このステップのジョブの優先度を手動で下げ、キューの待ち時間がゼロである必要のないジョブが優先ジョブスロットを消費しないようにします。
force_acceptboolean(デフォルト:false)通常は無視するファイルタイプを Robot に強制的に受け入れさせます。
デフォルトでは、Robot は認識できないファイルを無視します。たとえば、🤖/video/encodeは入力画像を無視します。
force_acceptパラメーターをtrueに設定すると、Robot に渡されたすべてのファイルを強制的に受け入れさせることができます。通常、この設定はエラーにつながるため、デバッグやエッジケースへの対処にのみ使用してください。ignore_errorsboolean | Array<meta | execute>(デフォルト:[])処理の特定のフェーズでエラーを無視します。
このパラメーターを
["meta"]に設定すると、Robot はメタデータ抽出中のエラーを無視します。このパラメーターを
["execute"]に設定すると、Robot はメイン実行フェーズ中のエラーを無視します。このパラメーターを
trueに設定すると、["meta", "execute"]と同じ動作になり、両方のフェーズでエラーを無視します。アーカイブ内のファイルは、サイズが 0 バイトの場合などにメタデータの抽出に失敗することがあります。その場合も展開を続行するには、
"meta"フェーズのエラーを無視するように設定してください。usestring | Array<string> | Array<object> | object入力として使用する Step を指定します。
- Step には任意の名前を付けられます。ただし、
":original"は Transloadit が処理するユーザーアップロード用に予約されています。 - 配列を使用して、複数の Step を入力として指定できます。
{ "use": [ ":original", "encoded", "resized" ] } - 入力 Step に
asでタグを付けて、意味上の用途を Robot に伝えることもできます。{ "use": [ { "name": ":original", "as": "image" }, { "name": ":original", "as": "mask" } ] }
ヒントuseについては、通常ここまでの内容で十分ですが、高度な使用例 も参照できます。- Step には任意の名前を付けられます。ただし、
passwordstringパスワード保護されたアーカイブの復号に使用するパスワードです。
暗号化された ZIP(ZipCrypto および AES)、RAR(暗号化)、7z(AES-256 暗号化)アーカイブに対応しています。
セキュリティのため、この値は Assembly Instructions に直接記述せず、Template 変数(
${fields.archive_password})または Template 認証情報で渡してください。パスワードがログに記録されたり、Assembly のステータスレスポンスに含まれたりすることはありません。アーカイブが暗号化されているのにパスワードが指定されていない場合、またはパスワードが正しくない場合、Assembly は
FILE_DECOMPRESS_PASSWORD_REQUIREDまたはFILE_DECOMPRESS_PASSWORD_INCORRECTエラーで失敗します。turboboolean(デフォルト:true)/file/decompressの Turbo Mode を有効にします。この設定のデフォルト値は
trueです。Turbo Mode を無効にするには、falseに設定してください。有効にすると、展開されたファイルが利用可能になり次第出力されるため、大きなアーカイブの後続処理を高速化できる場合があります。
Turbo Mode では使用量の計算方法も変わります。出力された展開済みファイルのバイト数と元の入力アーカイブのバイト数には、割増料金(デフォルトで 25%)が適用されます。