Python CGIでファイルダウンロードダイアログを表示させる方法

ファイルダウンロードダイアログとは

Webサイトを運営していると、ユーザーがリンクをクリックした際に、実際のコンテンツをブラウザ上に表示するのではなく、「ファイルダウンロード」ダイアログボックスをポップアップ表示させたいケースがあります。たとえば、テキストファイルやCSVデータをそのまま開かせず、保存させたい場合などが該当します。

この動作は、HTTPヘッダーを適切に設定するだけで簡単に実現できます。

HTTPヘッダーの設定方法

ポイントとなるのは、以下の2つのヘッダーです。

• Content-Type: application/octet-stream — ファイルをバイナリデータとして扱い、ブラウザが自動的に内容を解釈・表示しないようにします。
• Content-Disposition: attachment — コンテンツを添付ファイルとして扱うよう指示し、ダウンロードダイアログを表示させます。

サンプルコード（Python CGI）

たとえば、特定のリンクから「FileName」というファイルをダウンロードできるようにしたい場合、CGIスクリプトは次のように記述します。

#!/usr/bin/python
# -*- coding: utf-8 -*-

# HTTPヘッダーを出力
print("Content-Type: application/octet-stream; name=\"FileName\"\r\n")
print("Content-Disposition: attachment; filename=\"FileName\"\r\n\n")

# 実際のファイル内容を出力
fo = open("foo.txt", "rb")
data = fo.read()
print(data)

# 開いたファイルを閉じる
fo.close()

コードの解説

処理の流れは以下の通りです。

1. まずContent-TypeヘッダーでMIMEタイプを「application/octet-stream」に指定し、ファイル名を通知します。
2. 続いてContent-Dispositionヘッダーに「attachment」を指定することで、ブラウザにダウンロードダイアログを表示させます。
3. ヘッダーの後は空行で区切り、そこから実際のファイル内容を出力します。
4. 対象ファイル（ここでは foo.txt）をバイナリモードで読み込み、標準出力へ書き出した後、ファイルをクローズします。

注意点

日本語ファイル名などを扱う場合は、filenameパラメータのエンコーディングに注意が必要です。また、ヘッダーと本文の間には必ず空行を挿入しなければならないため、\r\n\nのような改行の付け忘れに気をつけてください。正しく設定すれば、ユーザーがリンクをクリックした瞬間にダウンロードダイアログが表示され、意図したファイルを保存してもらえるようになります。