Last modified Information Relaying Specification
更新時刻情報受け渡しデータ仕様(LIRS)仕様書

作成日時：1999/10/13 18:00
更新日時：1999/11/03 03:25
ver.1.1

LIRSとは

• LIRSとは、更新時刻取得エージェント間で交換される有益な更新時刻取得情報の中で、もっとも必要である最小最低限の情報を選りすぐって、円滑に交換しあうために定義されたデータ形式および交換手段である。
• LIRSでは、更新時刻を取得する対象のサイトに、更新時刻を取得するための最低限のこと以外の負担をかけないことを前提としている。
• LIRSに関するすべての仕様の取り決めは、情報の散乱を防ぐために、立案者であるひや(mailto:hiya@hauN.org)が専任して執り行う。

注意事項

• LIRSでは内部情報を全てGMTの1970年1月1日0時0分0秒からの秒数(UTC)で表す。
• LIRSは原則として、UNIXのサーバーにおいて運用される更新時刻取得アンテナで用いることを前提として定義されており、これ以外の環境は想定していない。
• LIRSの内部漢字コードは、EUC限定である。改行コードはLFを推奨するが、LIRS.pmはCRLFにも対応している。なお、CRのみは推奨されない。
• 「#」で始まる行はコメントとする。

データ書式

LIRSは、ヘッダ部「LIRS,」と、「,」で区切られるデータ部、そしてフッタ部「,(\r)\n」をひとつのデータレコードとして構成される。

データの書式は下記のようになっている。

LIRS,938779260,938781002,32400,49383,http://aniki.hauN.org/d/,隠語日記,ひや,http://amano.hauN.org/,(etc.etc...),(\r)\n

左より、

LIRSレコードヘッダ,更新時刻(Last-Modified：GMT),更新時刻を取得した時刻(Last-Detected：GMT),対象サイトのGMTとの誤差(秒),対象サイトの容量(Content-Length：バイト),対象サイトのURL,対象サイトのタイトル,対象サイトの管理者名,情報取得元サイトのURL,(拡張部...),(\r)\n

• データは全て「,」一つで区切られる。末尾には独自拡張の情報を付け加えることができるが、行末には必ず区切り文字を一つ余分に入れておくこと。
• データには、「,」を含めてはならない。通常、「,」を使わなければならない、という事例はあまり無いと思われるが、「,」を含める場合は「\,」としてエスケープすること。
• 全ての項において、値無しの場合は「0」が入る。原則として値無し(空欄)ということはない(拡張部に関しては例外)。
• 更新時刻取得に失敗したサイトは、更新時刻「0」、取得時刻「0」とし、事実上使えない情報として記載される。

更新時刻(Last-Modified：GMT)

そのサイトが更新された時刻。LIRSでは内部情報を全てGMTの1970年1月1日0時0分0秒からの秒数(UTC)で表すため、ここの秒数もGMTである。
この項は、0-9以外の文字は使用できない。

更新時刻を取得した時刻(Last-Detected：GMT)

そのサイトの更新時刻を最後に直接(自力で)得た時刻。更新されたことを最初に検知した時刻ではない。これはHEAD/GETリクエスト、もしくはFILE取得の場合にのみ書き換えることができるが、リモート取得の時はリモート情報から受けたLast-Detectedを継承する。
現在時刻からこの時刻を差し引いた値が大きければ大きいほど、この情報の優先度が下がっていき、それがexpiresCount(下記参照)に指定されている時刻(秒)を越えると、この情報は無視されるようになる。
この項は、0-9以外の文字は使用できない。

対象サイトのGMTとの誤差(秒)

前述の通り、LIRSでは内部情報を全てGMTの1970年1月1日0時0分0秒からの秒数(UTC)で表すため、対象サイトの更新時刻をローカルタイムで表すための、GMTからの誤差の情報を必要とする。
日本国内で使う場合は常に(+)32400固定と思って良い。
この項は、0-9と、+と-以外の文字は使用できない。

対象サイトの容量(Content-Length：バイト)

対象サイトの容量を表す。これはエージェントにより異なるが、対象サイトの容量から更新時刻を取得するエージェントのために用意されている。
内部処理としては、キャッシュに保存されたLIRSの容量情報と比較し、このサイズと異なった場合に「更新された」と認識する。
この情報が取得できなかった場合は0に設定する。
なお、この方法による更新時刻取得は、現段階ではLast-Detectedの対象外とする。
この項は、0-9以外の文字は使用できない。

対象サイトのURL

対象サイトのURLは、LIRS形式においてユニークなキーとして扱われる。
URLは、大小文字の判定はしないこととする。
また、末尾のindex.htmlは原則として内部では消去して扱われる。
この項は、URLとして使用できる文字以外は使用できない。

対象サイトのタイトル

対象サイトのタイトルは、タイトルや管理者名を記さなくても更新できるエージェントに提供される情報として用意されている。

対象サイトの管理者名

対象サイトの管理者名は、タイトルや管理者名を記さなくても更新できるエージェントに提供される情報として用意されている。

情報取得元サイトのURL

このレコードの情報を取得した元のサイトのURLを記しておく。原則として、自力取得したサイトを指す。
これの利用法は各エージェントに委ねられる。

独自情報の追記

上記情報以外の、エージェント独自の情報は、これらの情報を書き出した後に追記することができる。
ただし、一行につき一サイトの原則は守らなければならず、行末に区切り文字を含めなければならない。

LIRS形式のデータを扱うエージェントで、設定に追加していただきたい項目

LIRS形式のデータを扱うエージェントは、下記の設定項目を追加すること。

• サーバーの時刻帯(GMTよりの誤差を秒で：日本は-32400)
  localTimeZone = -32400;
  
• gzipの場所
  gzip = '/usr/bin/gzip';
  

LIRS形式のデータを出力するエージェントに必要なことがら

LIRS形式のデータを扱うエージェントは、下記の要項に従うこと。

• 内部で利用するキャッシュ情報を、LIRS形式で保存しておく必要がある。
  
• LIRSのファイルは、出力完了後UNIX gzipで圧縮して保管しておく必要がある。この際、元のLIRSファイルを削除しないようにする。
  また、LIRSファイルを受けるときはHTTPを用い、gzipで展開した上で用いる。
  
• 更新時刻取得時刻から換算して更新時刻情報を無視するまでの時間を、ユーザーが設定ファイルで更新できない場所で設定する必要がある。
  expiresCount = 28800;
  この値は28800固定である。
  

転送方法

LIRS形式のデータを送受信する際は、下記の要項に従うこと。

• 転送は、HTTPで行う。この際、データはgzipで圧縮されている必要がある。受け取った後、gzipで展開後読み込む。
  

LIRSにおける「情報の鮮度」の概念

LIRSにおいて、情報の鮮度の計測方法は、そのサイトに対して直に情報を取得して(Last-Detected)からどれだけの時間が経過しているか、を基準としている。
時間が経過するごとに、その情報の価値がどんどん下がっていき、ある一定の値(expiresCount)を越えたところで、その情報は破棄される。

また、LIRSにおいては、情報がリモートで渡ってきたときに、そこに記載されている更新時刻取得時刻の情報を元にして、Last-Detectedを指定し出力する。エージェントによるが、必ずしも継承される必要はない。

LIRSにおける「時差(誤差)」の概念

LIRSにおける「時差(誤差)」の概念は、一般的に「プログラムが動作するサーバーのGMTを基準」として、それぞれのサーバー(あるいはAuthor)所在地との時差(誤差)を指す。
この「時差(誤差)」は、それがタイムゾーンを越えた時差であるのか、サーバーごとの時間設定の誤差であるのか、どちらでも構わないが、LIRS内の全ての情報をどちらか一方に揃える必要がある。

その他

• LIRS ver.1.1のデータ構造・圧縮展開処理を扱いやすくするPerl5のモジュールを下記にて提供している。
  http://amano.hauN.org/LIRS.pm
  

改版履歴他

1999/11/11 19:41

HTML化と、それにともない微修正。

1999/11/03 03:25

DIに関する議論のなかで出てきた事柄などを考慮に入れ、微修正。
「LIRSとは」などを追加。

1999/10/13 18:00

原文作成。