All posts

独自の URL スキームを使って、ブラウザからローカルの処理を呼び出す

Web アプリケーションから、Illustrator を起動して指定したファイルを開いたり、PC 上のファイルを移動したりしたい案件がありました。

ブラウザ上の JavaScript には、利用者の PC を保護するための制約があります。そこで今回は、Windows に独自の URL スキームを登録し、ブラウザからローカルのプログラムを呼び出す方法を試しました。

この記事は、当時の構成と考え方をまとめたものです。

URL スキームとは

スマートフォンでリンクをタップしたときに、ブラウザから地図アプリなどが起動することがあります。アプリを呼び出す方法の一つが、URL スキームです。

たとえば、Web ページの URL に使う https:// の https がスキームにあたります。OS に独自のスキームとアプリケーションを関連付けておけば、そのスキームの URL を開いた際に、登録されたアプリケーションを呼び出せます。

Windows でも、独自の URL スキームをアプリケーションに関連付けることができます。[Microsoft の URI アクティブ化に関するドキュメント]

今回の構成

今回は、Windows に chikuwa:// という独自スキームを登録し、次の流れで Ruby の処理を呼び出しました。

ブラウザのリンク
    │
    ▼
chikuwa:// で始まる URL
    │
    ▼
Windows に登録した処理
    │
    ▼
VBScript から Ruby スクリプトを起動
    │
    ▼
Ruby で必要な処理を行う

URL の中にパラメーターを含め、Ruby スクリプト側で受け取ります。

Windows に URL スキームを登録する

当時は、次のようなレジストリファイルを作り、独自スキームを登録しました。

Windows Registry Editor Version 5.00

[HKEY_CLASSES_ROOT\chikuwa]
@="URL:Chikuwa Protocol"
"URL Protocol"=""

[HKEY_CLASSES_ROOT\chikuwa\shell]

[HKEY_CLASSES_ROOT\chikuwa\shell\open]

[HKEY_CLASSES_ROOT\chikuwa\shell\open\command]
@="\"wscript.exe\" \"C:\\MyApps\\app.vbs\" \"%1\""

この設定は、chikuwa:// で始まる URL を開いたときに、C:\MyApps\app.vbs を呼び出すものです。URL は引数として渡されます。

ブラウザや Windows の設定によっては、アプリケーションを開く前に確認画面が表示されます。

VBScript を経由して Ruby を起動する

当時の環境では、Ruby のバージョンアップによって実行ファイルのパスが変わることを避けるため、間に VBScript を置きました。

VBScript からは、環境変数に設定されたパスを使って Ruby を呼び出す構成です。

URL スキーム → app.vbs → app.rb

Ruby 側では、渡された URL を解析し、含まれているパラメーターを取り出して処理します。当時の実装では、JavaScript でデータを JSON に変換し、さらに URL エンコードして渡していました。

この方法で、Web 側の操作をきっかけに、ローカルのプログラムを実行する流れを作ることができました。

URL から受け取る値の扱いに注意する

独自スキームは、登録したアプリケーションを呼び出すための仕組みです。呼び出したページが、自分のサイトであることを保証するものではありません。

別の Web サイトやアプリケーションから、任意の値を含む URL を渡される可能性があります。そのため、受け取った値をそのままコマンドやファイルパスとして使わず、実行できる操作や対象を制限する必要があります。

特に、ファイルの移動・削除などを URL の値だけで実行する設計は避け、操作内容の検証や利用者への確認を含めて考えたいところです。Microsoft も、URI のパラメーターを信頼できない入力として扱うよう案内しています。[Microsoft の URI アクティブ化におけるセキュリティ]

独自の URL スキームを使うことで、ブラウザとローカルプログラムを連携できました。Web 画面から PC 上の処理を呼び出したいときに、選択肢の一つになる方法です。

Discussion