PHP による XML-RPC API 利用メソッドの実装に関わって、 ISO 8601 の日本版規格であるJISX0301から、時刻の表記について考えてみた。

この規格では、時刻にどのような値が取り得るのか、どのような値は不正なのか。

JISX0301 規格を読むと、夜の12時についての説明があり、

  • a)基本形式[000000]拡張形式[00:00:00]を一日の始まり
  • b)基本形式[240000]拡張形式[24:00:00]を一日の終わり
  • 一日の終わりは、次の日の始まりと同一とする

とされていた。

時刻について、25時とか26時という表記が許されるのか、また、24:00:00を超えた時刻表記、例えば、24:15:30などが許されるのかについて考えてみた:

5-3 時刻 この規格は、普通使われている24時制を基としており、時は[00]~[24]、分は[00]~[59]、秒は[00]~[60]の2けたの数字でそれぞれ表記する。一般的用途では時刻は、4けたの数字[hhmm]で表す。

[24]という時の表記は、夜の12時を表記する場合にだけ許される(5.3.2参照)。

[60]という秒の表記は、正のうるう秒又はその秒内の時点を支持する場合にだけ許される。

という説明があった。「夜の12時」とは、ジャスト12時のことだと考えられるので、24時という表記が許されるのは、一日の終わりである[24:00:00]を表記する場合のみ、と考えられる。[24:00:01]すら許されないということだ。

また、この説明中の「…秒は[00]~[60]の2けたの数字でそれぞれ表記する」を読んで、「あれ?」と思った。普通に考えると、「…秒は[00]~[59]の2けたの数字でそれぞれ表記する」となるはずでは?現に、「分は[00]~[59]の2けたの数字で表記する」とされている、秒も同じと考えるのが自然な思考だ。おそらく、説明中に出てくる「正のうるう秒」という部分がカギになっているだろうと考え検索してみたら見つかった。

国立天文台の「うるう秒」の説明によると、

  • 古くは、地球の自転を基準にして「1日」の長さが決められ、その24分の1を1時間、さらにその60分の1を1分、その60分の1を1秒としていた。
  • 原子時計で正確な時間が測定できるようになると、実は地球の回転速度にはムラがあり、常に等速で回転しているわけではないことが分かった。
  • 地球の自転が遅い状態が続いたり、速い状態が続いたりすると、地球の自転で決まる時刻と原子時計で決まる時計のずれが大きくなる。
  • そのようなとき、時刻のずれを修正するために「うるう秒」を実施する。
  • 地球の自転速度は、原子時計と比較されながら観測が続けられていて、地球の自転と原子時計によって決まる時刻の差が±0.9秒の範囲に入るように、うるう秒による調整が行われている。
  • 地球の自転と原子時計の時刻の差が1秒に達するような場合に、うるう秒として1秒を挿入することによって、時刻の調整を行う。
  • うるう秒による調整は、6月か12月の末日の最後の秒(世界時)で行われる。
  • それでも調整しきれない場合、3月か9月の末日の最後の秒(世界時)でも行われる。
  • 地球の自転が遅い(1回転にかかる時間が長い)場合には、23時59分59秒の後に23時59分60秒として1秒を挿入し、その次の秒が00時00分00秒となる。
  • 地球の自転が速い(1回転にかかる時間が短い)場合は、23時59分58秒の次の59秒をとばし、00時00分00秒にすることにより、1秒減らす。
  • ただし、日本の地方時は、世界時より9時間進んでいるため、日本では7月か1月の初日(それでも調整しきれない場合、4月か10月の初日)の午前8時59分の最後の秒で調整が行われる。

ということだそうだ。実際、1972年にうるう秒による調整が開始され、それ以来、2014年までに25回のうるう秒(いずれも挿入)が実施されているようだ。(余談だが、うるう秒については、この説明よりさらに深い説明が国立天文台に掲載されており、それを読むと、なぜ、現在までのところ、正のうるう秒だけが実施されているのかなどが分かる。(地球の自転が徐々に遅くなってきているため。)

ただし、うるう秒の実施については、うるう年のように計算で求められるものではなく、地球の自転速度の変化を長期にわたって予測ができないため、将来の実施時期は不明だそうだ。

前振りが長くなったが、うるう秒についてのバリデーションが可能かどうかについて考察すると、うるう秒がいつ挿入されるかは、UTCにおいては5月または12月または3月または9月の末日の一日の終わりの最後の秒と決まっているので、 XML-RPC での実装を考えると、サーバの規定するローカル時刻のUTCからの時差を考慮し、その時差分を差し引けば、サーバの規定するローカル時刻での、うるう秒が実施される可能性のある日時を決定することは可能だが、実際にうるう秒が実施された時刻かどうかの判定は、過去に実施されたすべてのうるう秒のデータベースでも持たない限り不可能だし、未来に関しては決定不可能だ。あくまで「うるう秒が来る可能性のある日時」しか分からない。

考えてみれば、 UNIX time はうるう秒なんぞ考慮に入れていない。未来の日時が、うるう秒の追加でいつ1秒ずれるかなんて分かるわけもないし、過去にうるう秒が追加されるたびに、 UNIX time の値と経過時刻との関係をずらす処理をOSどころか全アプリケーション、既存の全日時データをアップデートして更新する、なんて馬鹿げたことをするわけもない。

そもそも PHP の日付・時刻に関する標準関数に、うるう秒を表記した日時を渡した場合どうなるかについて調べてみた:

function validateDate($date, $format = 'Y-m-d H:i:s')
{
     $d = DateTime::createFromFormat($format, $date);
     return $d && $d->format($format) == $date;
}
     $v = '2018-12-08 23:59:60';
     print 'validateDate('.$v.')='.(validateDate($v)?'true':'false').'<br />';

は、 false となった。「 DateTime クラスの createFromFormat() に渡す ‘s’ は[00]~[59] 」と、 php.net のマニュアルにも明記されている。うるう秒なぞ秒として認めない、ということだ。一方で、与えられたパラメータを元に UNIX time を返す mktime() は、引数 second に 60 以上の値を渡してもエラーにはせず、 59 より多い秒数分時刻を加算する動作をする。 「 60 秒」をエラーにするかしないかは関数によってまちまちだが、「うるう秒を考慮したものではない」ということは共通している。

要するに、うるう秒についての ISO 8601 の規定は、規定通りに処理することが現実的に無理なのだ。だが、それでも稀に XML-RPC を利用したメソッドに対し、うるう秒の時刻が送られて来ることは考えられる。そのときのことを考慮すると、「エラーにはせず、1秒ずれた時刻として扱われる」という形にする必要があるが、 DateTime クラスの例のように、「60秒はエラー」として false を返したり例外を投げたりするクラスや関数があるだろうことを考えると、コードの全体を注意深く確認して修正しないといけないだろうし、便利に使用していた標準クラスや関数が「使えなく」なるかも知れない。うるう秒対策って、結構面倒な問題なのではなかろうか。


rn_xmlrpc.php を修正 2018-12-10 (月) 02:43:56+09:00

ソフトウェア

日時指定での投稿時の動作の修正をした。

これまでは、 XML-RPC の規格に沿って、 metaWeblog API newPost, editPost の dateCreated ( ISO 8601 形式)に UTC 、タイムゾーンが付加されずに送信されることを前提に、送信されてきた dateCreated に無条件で “Z” を付加し UTC であることを明示していた。

しかし、

そこで、 ISO 8601 形式のバリデーションの方法を参考にしながら、 rn_xmlrpc.php を対応させた。

現在の動作は、

ISO 8601 形式(基本形式、拡張形式、混在形式)( UTC 、タイムゾーンなし)⇒UTC形式として処理し表示。

ISO 8601 形式(基本形式、拡張形式、混在形式)( UTC またはタイムゾーンあり)⇒タイムゾーンを処理し表示。

となった。

Windows/Open Live Writer が dateCreated に ISO 8601 規約違反の形式(YYYYMMDDThh:mm:ss)で日時を送ってくるので、やむを得ずその形式(混在形式)にも対応させた。


Windows Live Writer および Open Live Writer で、公開日付指定で記事を投稿した際に、 metaWeblog API newPost, editPost で送信されてくる dateCreated ( dateTime.iso8601 ) の形式は:

<member>
  <name>dateCreated</name>
  <value>
    <dateTime.iso8601>20181209T12:00:00</dateTime.iso8601>
  </value>
</member>
<member>
  <name>date_created_gmt</name>
  <value>
    <dateTime.iso8601>20181209T12:00:00</dateTime.iso8601>
  </value>
</member>

のような表記となっている。

しかし、メモに投稿しておいた「ISO 8601 規格について」通り、 ISO 8601 規格では日付の基本形式である[20181209]と時刻の拡張形式である[12:00:00]は混在させてはならないので、この形式は規格に違反している。

日付の形式に合わせるならば、[20181209T120000]とするのが正しい。


rn_xmlrpc.php を修正 2018-12-08 (土) 15:12:00+09:00

ソフトウェア

Windows Live Writer, Open Live Writer で投稿する場合に、 Writer 側で metaWeblog API, Movable Type API の2種類のアカウントで問題なく使用できるように API の処理を修正した。

rNote の現状の課題:

rNote の構造上、カテゴリ=ディレクトリなので、そのままでは複数カテゴリを指定された記事を実現できない。現在は、複数カテゴリを指定された記事を投稿された場合、先頭に指定されたカテゴリのみを採用し、残りは破棄している。(シンボリックリンクのような機能を追加すれば実現可能だが・・・。)

複数カテゴリを持てるようにするには仕様の検討が必要だが、記事の属性を表すために、既にキーワードを実装しており、キーワードは複数の属性を表現できるため、カテゴリまで複数持たす必要性を感じない。カテゴリにせよキーワードにせよ、使い道は単語をキーに記事を検索する用途だと思うので、キーワードが実装され検索できる以上カテゴリ複数化はしなくていい気がする。

Windows/Open Live Writer の現状の課題:

やはり追記を書く機能がないこと。 Open Live Writer のソースを読むと内部的には mt_text_more を処理しているので、追記をユーザーインターフェースを追加すればよさそう。画面上の部品のレイアウト変更・部品追加と、ブラウザコントロールの追加管理を実装する必要があるので、ちょっと面倒そう。画面上の構成としては Blog Write のとっている形が一番自然でよいと思う。


rn_xmlrpc.php を修正し、Windows Live Writer, Open Live Writer から日付指定で投稿した場合に、正常に日付が設定されるよう修正した。

記事は、 metaWeblog::newPost, metaWeblog::editPost で投稿され、投稿日時は dateCreated パラメータで送信される。 rn_xmlrpc.php XML-RPC Server 側でこのパラメータを受信して記事の投稿日時を設定し公開するところまではまずできたが、公開された記事の日時が意図したものより9時間前のものになっていた。

こうなる理由を探していて、下のような記事が見つかった。

どうやら、 XML-RPC specification によると、 XML-RPC API では dateCreated は ISO8601 形式で送信されるが、タイムゾーンは送信されないことになっているらしい。

What timezone should be assumed for the dateTime.iso8601 type? UTC? localtime?

Don't assume a timezone. It should be specified by the server in its documentation what assumptions it makes about timezones.

Windows Live Writer / Open Live Writer の XML-RPC 送信データを覗いてみると、 metaWeblog::newPost, metaWeblog::editPost での記事の送信で dateCreated を付加する場合、 “20181207T12:00” のようにタイムゾーンのない ISO 8601 形式で送信されているのが分かった。どうしてそうなるのか推測してみた。

  1. 例えば、 Windows/Open Live Writer から、タイムゾーンが “Asia/Tokyo” の地域で、2018年12月7日21時00分を投稿日時として記事を送信した場合:
  2. Windows/Open Live Writer は、 “20181207T12:00:00+09:00” のような ISO 8601 形式をつくり、 metaWeblog::newPost で記事を送信する。
  3. metaWeblog::newPost の内部で使用されているXML-RPC API が dateCreated の ISO 8601 形式の日付情報から時差の部分を除去してしまい( “20181207T12:00” になる)、その後、それを送信する。
  4. 結果的に、時差の部分が無くなった UTC での投稿日時が送信される。
  5. 送られてきた dateCreated の日時をブログ側でそのまま表示すると、 UTC での日時なので9時間前になる。

ということだろう。

他の XML-RPC クライアントからも、同じ状況の日時が送信されるのか不明だが、恐らく同じなのではないかと思う。

この推論をもとに、先ほど紹介した一つ目の記事を参考に、WordPress と同様の動作(タイムゾーンが指定されていなければ日付を UTC として扱う)をするように修正した。記事によると、タイムゾーンがついている場合はそのタイムゾーン情報に従って日付を扱うとされているが、 Windows/Open Live Writer で送信した場合タイムゾーンは無くなることと、そもそもそのようにタイムゾーン付きで ISO 8601 形式の dateCreated を送信してくる動作自体が XML-RPC specification に違反する動作なので、現状この処理(=タイムゾーンがついている場合の動作)は実装していない。

とりあえずは、これで問題なく動作していることを確認した。

2018-12-15 : 上の推論の間違いに気づいたので訂正。

Windows/Open Live Writer が、タイムゾーンが “Asia/Tokyo”の地域で、2018年12月7日21時00分を投稿日時として記事を送信した場合、もし最初に UTC からの時差を付けた ISO 8601 形式の日時を作るのであれば、 “20181207T21:00:00+09:00”とするはずなので、これの時差の部分が除去されても、“20181207T21:00:00”となり、これを PHP はローカル時刻と考えるので、9時間前の時刻にはならない。

ところが実際は9時間前の時刻として表示されるということは、 Windiws/Open Live Writer は最初から UTC の時刻を作成し、しかも末尾に“Z”または“+00:00”を付加していない、あるいは、付加しているが XML-RPC API が “Z”を削除して送信している、ということになる。