東京メトロのWebAPIを叩くシェルスクリプト書いてみた

More than 1 year has passed since last update.

今、東京メトロのコンテストが熱い!

ウワサでは知っていると思うが、今、東京メトロが設立10周年を記念して「オープンデータ活用コンテスト」というのをやっている。

駅の設備はもちろん、リアルタイムの列車位置なんかも公開するという大盤振る舞い。「これで役立つアプリ作ってね」ということなのだが、じゃあ俺がシェルスクリプトで何か作ってやろうじゃないかということで書いてみたので紹介する。

WebAPIの仕様はコンテスト応募予定者限定公開なので作ったソースコードも公開はできないのかなと思っていたら、開発者フォーラム内で「アクセストークン(後述)出さなければソースコードも公開OK」という回答があったので、公開に踏み切ることにした。

接近情報表示コマンド「メトロパイパー」

まず接近情報とは何かだが、駅のホームへ行くとそこの電光掲示板に表示される

【こんど】快速 東葉勝田台行
【つぎ 】各停 西船橋行

とか(「こんど」&「つぎ」とかいつの時代だ!)、

前々駅 -◆- 前駅 --- 当駅

というアレである。

しかし、今まではその駅のホームに行かないと見ることが出来なかったし、2つよりも前の接近情報はわからなかった。

  • あ、特急ロマンスカーが霞ヶ関駅あたりに来てる。じゃあそろそろ表参道駅へ行くか。
  • あー、南栗橋行間に合わなかった! えぇと次の東武線直通電車は今どのあたりに……? うーんもうしばらく後か、じゃあトイレに行っとくか。

という具合に、今いる駅からもっと手前の駅の接近情報や、あるいは駅にいなくてもこれから行く予定の駅の接近情報は知りたいもの。そんなアナタの願いを叶えるのがこのコマンドだ。

特徴

POSIXの範囲のシェルと標準UNIXに、あとはcurlコマンドさえあれば動く。というわけで、シェルスクリプトで書かれている。パイプ|を駆使しコマンドをいくつも繋ぐというパイプの鮮やかな活用こそまさにシェルスクリプトの真髄だと思う。

パイプ駆使し、東京メトロのパイプ(=路線)の中身を覗いてしまえ!

つかいかた

前置きはこのくらいにして、使い方の説明いくぞ。

2014/09/17追記
Webインターフェース版を作ったぞ。これで下記の手順をすっ飛ばして、誰でも使えるぞ。まぁ、本来はコマンド版をデプロイして使ってみてもらいたいのだが……。

0. 必要なもの

なぁに、大したものは要らん。UNIX環境と少々の追加コマンドがあれば動く。
レンタルサーバーなら大抵全部初めから揃っていることだろう。

必要なもの 備考
POSIX準拠シェル(/bin/sh)とコマンド群 FreeBSDやLinuxも勿論OK(BashやGNU拡張機能等は一切不要)
curlコマンド インストールしておく(主要Linuxディストリには大抵ある)

シェルスクリプトはPOSIX準拠で書いているつもりなので、curlコマンドさえどうにか用意することができればおそらくどこのUNIX環境でも動くはずだ。

1. 準備作業

シェルスクリプトで書いてあるからコンパイルなど一切不要。このプログラム一式をコピーして、最初にマスターデータを生成するシェルスクリプトを動かせば完了だ。

あ、ユーザー登録をして、アクセストークンを貰ってくるのを忘れんようにな。それがないとこのアプリは動かせないぞ。

1) 開発者サイトにサインアップ

サインアップがまだならサインアップをすること。サイトはここだ。なお、サインアップにはメールアドレスと、少々の時間(最長2日くらいらしいが、私は2時間くらいだった)が必要だ。

2) アクセストークンを発行する

アクセストークンとは、Twitterで言うところのApplication IDみたいなものだ。東京メトロのWebAPIにおいても、自作のWebアプリケーションを使いたければ発行しなければならない。残念ながらこれは公開してなならないので、このアプリ「メトロパイパー」を動かしたいなら各自取ってくること。

発行を受け付けている場所はここだ。ただし、サインアップしたらデフォルトで1個生成されているので、それを使ってもよいのだが。

3) 「メトロパイパー」をダウンロード

ZIPでダウンロードして展開してもよいが、gitコマンドが使えるなら下記のようにしてgit cloneするのが手っ取り早いぞ。

gitコマンド一発でメトロパイパー一式を取得
$ git clone https://github.com/ShellShoccar-jpn/metropiper0.git
$ cd metropiper # ←メトロパイパーのホームディレクトリーに移動しておく

4) アクセストークンを設定

CONFというディレクトリーの中にあるACCESSTOKEN.TXTというファイルに、2)で取得してきたアクセストークンを書き込む。私が取得した時は64桁の16進数だったので、そうでなかったらそれはアクセストークンではないかもしれんぞ。

5) マスターファイルを作る準備

駅名や路線名など、最初に一回だけ入手しておけばよい情報を取得して、各種マスターファイルを作る作業を行う。

しかし一部はWebAPIではなくて、Web上に公開されているドキュメントページのHTMLをスクレイピングしなければならない。そこで、下記に指定するWebページのHTMLソースコードをどこかに保存しておくこと。

https://developer.tokyometroapp.jp/documents/odpt

このページはログインしていないと表示されないので、Webブラウザーでログインしてからソースを表示し、コピペするというのが現実的ではないかと思う。そしてここでは説明の都合で、DATAディレクトリーの中にmetro_vocabulary.htmlという名前で保存したものとする。

6) マスターファイルを生成

最後にコマンドを一発実行して、各種マスターファイルを生成する。インターネットに繋がっていれば5秒もかからずに生成できるだろう。下記のコマンドを実行せよ。

マスターファイルを生成する
$ SHELL/MK_METRO_MST.SH DATA/metro_vocabulary.html

2. 普段の使い方

コマンド版

今現在のどこかの駅の接近情報が知りたいなーと思ったら、SHELLディレクトリーにあるVIEW_METROLOC.SHコマンドを実行すればよい。ただしこのコマンドは引数を2つとる。

  • 第1引数…知りたい駅の駅ナンバー
  • 第2引数…行きたい駅の駅ナンバー(ただし同一路線であること)

東京メトロ各線の駅ナンバーは、駅ナンバリング路線図参照。

Web版

こりゃ便利なので、誰でも使えるようにとWebインターフェースを追加した。(Webサーバーの公開ディレクトリーにデプロイして使ってちょーだい)

というわけで、メトロパイパーWeb版をWebブラウザーで開く。使い方は、説明しなくてもわかるでしょ?

コマンドの例と、ありし日・時刻の実行結果

東陽町(T14)における西船橋方面(T23)接近情報

使用例(東陽町駅における中野方面の接近情報)
$ SHELL/VIEW_METROLOC.SH T14 T01
2014/11/15 12:08:18発表

   T01 中野       各停 西船橋行     (JR東日本車両)     約28分後
   T01 中野       快速 東葉勝田台行 (東葉高速鉄道車両) 約28分後
   |
   T02 落合
   |           ↓各停 西船橋行     (東葉高速鉄道車両) 約23.5分後
   T03 高田馬場
   |
   T04 早稲田     快速 東葉勝田台行 (東葉高速鉄道車両) 約19分後
   |
   T05 神楽坂
   |
   T06 飯田橋     各停 西船橋行     (東京メトロ車両)   約15分後
   |
   T07 九段下
   |
   T08 竹橋
   |
   T09 大手町     各停 西船橋行     (東京メトロ車両)   約9分後
   |
   T10 日本橋
   |
   T11 茅場町
   |           ↓快速 東葉勝田台行 (東京メトロ車両)   約4.5分後
   T12 門前仲町
   |
   T13 木場
   |
>> T14 東陽町     各停 西船橋行     (東京メトロ車両)   到着
   |
   T15 南砂町
   |
   T16 西葛西
   |           ↓各停 西船橋行     (JR東日本車両)     7分前
   T17 葛西
   |
   T18 浦安
   |
   T19 南行徳     各停 西船橋行     (東京メトロ車両)   12分前
   |
   T20 行徳
   |
   T21 妙典
   |           ↓快速 東葉勝田台行 (東葉高速鉄道車両) 12.5分前
   T22 原木中山
   |           ↓各停 西船橋行     (東京メトロ車両)   20.5分前
   T23 西船橋
$ 

「お、もうすぐ快速がくるじゃん!西船橋に早く帰れる」

補遺

ここで出てくるA1とかA2というのは出口ではない。(知ってた?)

A1. ディレクトリー構成

このプログラムのディレクトリー構成を記す。

ディレクトリー構成
     metropiper/
     ├─ SHELL/                ・シェルコマンドとして呼び出されるプログラムの置き場所
     │   ├─ MK_METRO_MST.SH    - マスターファイル群生成スクリプト(最初に実行)
     │   ├─ MK_RWMINS.SH       - 路線内標準所要時間テーブル作成スクリプト
     │   │                      - (MK_METRO_MST.SHから呼び出される為、単独実行不要)
     │   ├─ VIEW_METROLOC.SH   - 接近情報表示コマンド
     │   │                      - (GET_LOCTBL.SHが出すデータをコンソール画面用に加工)
     │   ├─ GET_LOCTBL.SH      - 接近情報生成スクリプト(親。子のどれかをexec)
     │   ├─ GET_LOCTBL_0.SH    - 接近情報生成スクリプト(子。通常の分岐なし路線用)
     │   ├─ GET_LOCTBL_C.SH    - 接近情報生成スクリプト(子。千代田線専用)
     │   ├─ GET_LOCTBL_FY.SH   - 接近情報生成スクリプト(子。副都心線・有楽町線専用)
     │   ├─ GET_LOCTBL_M.SH    - 接近情報生成スクリプト(子。丸ノ内本線専用)
     │   ├─ GET_LOCTBL_mb.SH   - 接近情報生成スクリプト(子。丸ノ内支線専用)
     │   └─ GET_LOCTBL_N.SH    - 接近情報生成スクリプト(子。南北線専用)
     │                             (GET_LOCTBL.SHの内容をコンソール向けに加工)
     ├─ CONF/                 ・各種設定ファイル置き場
     │   └─ ACCESSTOKEN.TXT    - 取得したアクセストークンを設定するファイル
     ├─ DATA/                 ・各種マスターデータ等の置き場
     │   ├─ SNUM2RWSN_MST.TXT  - 駅ナンバーから各種情報を引くためのマスター
     │   ├─ RWC2RWN_MST.TXT    - 路線コードから路線名を引くためのマスター
     │   ├─ RWC2DIRC_MST.TXT   - 路線コードから路線の方面を引くためのマスター
     │   ├─ RWMINS_*.TXT       - 路線別・方面別、標準到着所要時間マスターファイル
     │   └─ METRO_VOC_MST.TXT  - その他各種コードから名称を引くためのマスター
     ├─ TMP/                  ・過密なAPIアクセス回避のためのキャッシュファイル置き場
     ├─ CGI/                  ・Webインターフェース用CGIプログラムの置き場所
     │   ├─ GET_SNUM_HTMLPART.AJAX.CGI
     │   │                      - 駅の一覧の<option>タグを生成する(Ajax)
     │   └─ GET_LOCINFO.AJAX.CGI
     │                           - VIEW_METROLOC.SHのWebインターフェース版(Ajax)
     ├─ HTML/                 ・Webディレクトリー
     │   ├─ MAIN.HTML          - メインページのテンプレートHTML
     │   │                        (TEMPLATE.HTMLの中にあるもののハードリンク)
     │   └─ JS/              ・Webインターフェースが用いるJavaScript置き場
     │        └─ SYSTEM.JS     - 本アプリのシステムJavaScript
     ├─ TEMPLATE.HTML/        ・Webインターフェース用のテンプレートHTMLの置き場所
     │   ├─ MAIN.HTML          - メインページのテンプレートHTML
     │   └─ LOCTABLE_PART.HTML - 結果表示用の部分HTMLテンプレート
     ├─ TOOL/                 ・シェルスクリプトアプリ開発を助けるコマンド群
     │                           ("Open usp Tukubai"という名で公開されているもの)
     │                           (ただしそれのシェルスクリプトによるクローン版)
     └─ UTL/                  ・その他、本システムで利用する汎用的なコマンド群
          └─ parsrj.sh          - シェルスクリプト製自作JSONパーサー

A2. 課題

[完了]和光市-小竹向原の副都心線・有楽町線共有駅

「この区間は両線が完全に同じホームを共有しているのだから、異路線の車両接近情報も表示すべきではないか」という鋭いツッコミが……。

おっしゃる通り。今後対応します!→対応しました(2014/11/15)

[完了]分岐のある路線の表示がおかしい

分岐のある路線は、分岐線の処理にうまく対応していないため、正しく表示されない。(ただし行先などを見ればわかるレベル)→ 2014/09/21 対応済

[完了]一部の駅名がローマ字表記される

例えば、田園東急田園都市線の長津田、鷺沼など、他社線の途中駅の名称の多くが漢字にならない。

これは公開されている名称(ボキャブラリー)マスターデータが不足しているためであり、データが存在しないものに関しては元のコードのローマ字名称をコピーして辛うじて対応しているためだ。不足しているマスターデータは今後提供されるそうなので提供され次第対応する予定だ。→2014/11/15 更新済

[完了]「あとn分」表示

画面に表示されている列車が、「知りたい駅」(自分のいる駅)に対しあと何分でやってくるのか(或いは何分前に出発したのか)を表示する機能が欲しい。→2014/11/15 実装済

その他

何らか不具合が出るかもしれない。ちなみに2014/09/21早朝には、しばらく時間帯、APIを叩いても接近情報データが得られないという不具合があった。

こんかいのデータ公開は、コンテスト作品募集のみならず、結果的に「クローズドベータテスト」の側面がある。つまり、APIサーバーの動作や、あるいはデータそのものに残存する不具合を、コンテスト参加者からの指摘で修正していっているのだ。というわけで、コンテストへの応募意志がなくてもバグ潰し協力のために参加してあげるといいと思う。

A3. JSONパーサーについて

これは、拙作のパーサーで、中身はシェルスクリプト+標準コマンドのみというPOSIX原理主義溢れるものである。

詳細は「jq、xmllintコマンドさようなら。俺はパイプが好きだから」を見てもらいたい。jqコマンドでは、このメトロパイパーのようなパイプと親和性の高いコード書けないはず。