これは何か？
iOSの「ショートカットアプリ」用のショートカットをサーバー側で生成して、iPhoneからはQRコードを読むだけでインストールできるようにする、Movable Typeのプラグインです。
このプラグインを使って生成したショートカットでは「Data APIのURL」のような設定が最初から埋め込まれているので、iPhone側では何も設定することなく利用することができます。（「Webサービスのパスワード」も埋め込むことができますが、暗号化はされません。その辺りの問題については以前の「iOS12のショートカットアプリとMovable TypeのData API」のサンプルの記事の「サンプルを利用する場合の注意事項」参照してください）
使い方
プラグインのZIPファイルをダウンロードして、Movable Typeへインストールすると利用できるようになります。設定は特に必要ありません。
インストールすると左側のメニューに「ツール > ショートカット.app」が追加され、メニューをクリックすると利用できるショートカットの一覧が表示されます。一覧からは、「インストールボタンのクリック -> iOS端末でQRコードを読み込み -> 表示された画面からインストール」の流れでiOS端末にショートカットをインストールすることができます。
管理者ユーザーでアクセスしている場合には、一覧のインストールボタンの左側にユーザーアカウントの選択肢が表示されます。「パスワードを埋め込む」を選択した場合には、ここで選択したユーザーのWebサービスパスワードが埋め込まれたショートカットを用意できます。これを使うと「管理者ユーザーが代理でMT上で操作を行い、ショートカットの利用者にはメールでインストール用のURLを送る」というような運用をすることができます。
同梱されているショートカット
以下の2つのショートカットが同梱されています。
写真を投稿
「写真」アプリのシェアボタンから、ショートカットを選択するとそのまま記事を投稿できます。以前の記事の「iOS12のショートカットアプリとMovable TypeのData API」のサンプルで紹介したショートカットと同じものです。
「パスワードを埋め込む」を選択していない場合には、投稿時にWebサービスのパスワードの入力が必要になります。
再構築
すべてのテンプレートを再構築します。
システムコンテキストからインストールした場合にはMovable Type 内のすべてのサイトが、サイトのコンテキストでインストールした場合にはそのサイトが、それぞれ再構築されます。
Siriに再構築をお願いすることもできます。
ショートカットの追加
ショートカットは、「テーマ」のように後から追加することもできるようになっています。
ショートカットの書き出しファイルの仕様は以前の記事でも触れたのですが、アプリから書き出されるバイナリファイルをXML形式に変換して編集することが可能です。また、以前の記事の時点からの新しい発見もあって、「ショートカットアプリには、XML形式を再びバイナリに戻して読み込ませる必要がある」かと思っていたところ必ずしもそうではなく「shortcuts://import-shortcut というURLを使った場合には、XML形式のまま読み込ませることができる」ということが分かりました。このプラグインではこの方法を利用して、ショートカットをMTMLを使ったテンプレートで管理しています。バイナリ形式に戻す必要がないため（XMLファイルさえ生成できればよいので）、インストール先のサーバー環境を選ばずに動作するようになっています。
具体的なカスタマイズの手順
手順は以下の通りです。
- iOSのショートカットアプリでショートカットを作成する
- ファイルとして書き出す
- XML形式に変換する
- ショートカットの定義（プラグイン独自の shortcut.yaml ）を書く
- プラグイン内のshortcutsディレクトリの下に入れる
1が非常につらい作業（ショートカットアプリ内で、GUIでかつ限りられた機能だけでのプログラミング）ではありますが、他は特に難しいことはないと思います。基本的にはテーマを追加するのと同じような手順です。
XML形式への変換
Macであれば以下のコマンドが利用できます。
plutil -convert xml1 -o MT用テンプレート.tmpl 書き出したファイル.shortcut
またはDockerを利用できる環境であれば、以下のコマンドが利用できます。
docker run -it --rm -v $PWD:/files usualoma/libplist plistutil -i /files/書き出したファイル.shortcut -o /files/MT用テンプレート.xml.shortcut
shortcut.yamlを書く
ショートカットの定義をshortcut.yamlに書きます。テーマでのtheme.yamlのようなもので、主なキーの意味は以下の通りです。
- id : ショートカットのID
- label : MTの管理画面上での名前
- version : バージョン
- name : インストール先のショートカットアプリでの名前
- description : ショートカットの説明
- install_instruction : インストールの手順などの説明文
- view : 利用可能なコンテキスト（system、website、blog）
- template : ショートカットのテンプレートのファイル
- expires_in : インストール用URLの有効期限の秒数
同梱されているショートカットを雛形にすると簡単かもしれません。
トラブルシューティング
写真の投稿ができない
iOSの問題だと思うのですが、時々ショートカットが正常にインストールできないことがあり、「写真の情報を取得できない」という問題が発生することがあります。この問題は「インストール前に写真アプリを開いておく」ということで発生確率を下げることができそうなのですが、それでも発生することが稀にあります。
発生した場合には、インストールしたショートカットを一度削除して、インストールし直すという手順で修正されると思います。
まとめ
「写真アプリからのシェア操作で投稿できる」というのはなかなか新鮮な体験だと思うので、ぜひ試してもらえればと思います。
またこのプラグインの例ではでは「写真のアップロードから、記事の作成と公開」まで行っていますが、もっとシンプルに「写真をアップローロドするだけ」というようなショートカットも実際の運用では便利だったりすると思うので、ショートカットアプリとData APIを連携は考え方しだいで、いろいろと面白いことができそうな気がします。
この記事について
この記事は Movable Type Advent Calendar 2018 の10日目の記事です。
Happy Holidays!