tora3^TMaux　オンライン自動アップデーター　マニュアル

TOP MANUAL HISTORY FAQ

■概要

tora3^TMauxは、既存アプリケーションに、プログラムやデータをwebを通じて更新するサービスを提供するものです。

• アプリケーションを起動する際に、自動的にwebサーバに接続して、更新されるファイルの有無を調べます
• 更新されるファイルがあれば、自動的にダウンロードしてファイルを更新します
• ＯＳによってロックされているファイルがある場合は、次回Windows起動時に更新を実行します
• アップデータ自身も自動的にアップデートできます

■アップデータの配置

※相対指定は、アプリケーションのフォルダを起点に記述します。
アップデータ用のフォルダは、アプリのフォルダの直下にあることを期待しています。フォルダ名は任意です。
アップデータ用のフォルダに、以下の３つのファイルとDownloadというテンポラリフォルダを作ります。


スタータ Exec.exe

アプリケーション起動の際に、最初に起動する実行ファイルです。
スタータのファイル名は任意に変更可能です。
スタータのアイコンはリソースエディタ等で書き換えてください。
アプリケーションにコマンドラインオプションが必要な場合はExec.exeを起動するときに指定してください。
Exec.exeを起動したときのコマンドラインオプションはそのままアプリケーションに渡されます。

なお、スタータのファイル名はアプリケーション名にbootを付けたものにすることを推奨します。

例

アプリケーション名  apl.exe
スタータ名         aplboot.exe

アップデータ tora3aux.exe

アップデータ本体です。Execによって呼び出され
更新の確認や更新を行います。
アプリケーションから呼び出しても、更新動作を行います。

iniファイル tora3.ini

アップデータの動作を記述する定義ファイルです。

dllファイル tora3aux_lang.dll

アップデータの言語を決めるdllです。英語版dllと置き換えるとメッセージが英語化されます。

作業用フォルダ download

アップデート用のファイルを一旦格納するためのフォルダです。

例

アプリケーションフォルダー名がApplicationの時
<./Application> アプリケーションフォルダー


  |-<tora3> 任意のフォルダ名でよい。アップデータ本体が収納
     |-Exec.exe
     |-tora3aux.exe
     |-tora3.ini
     |-tora3aux_lang.dll
     |-<Download> アップデータのワークフォルダ

スタータを直接起動するか、アプリにスタータを起動してもらうかすれば
.htaccess認証とアップデートをします。

アップデートの際に、アップデートするファイルがロックされている場合
アップデータはファイルのダウンロードのみを行い、Windowsのrunonceにアップデート情報を記述します。
その後、通常通りにアプリケーションを起動します。
このような場合、Windowsの次回起動時に実際のアップデートが行われます。

■Exec.exeの配置場所の拡張について

Ver.1.30より、Exec.exeを以下のような制限のもとに、アプリケーションのインストールフォルダに配置できるようになりました。

(1)　アップデータのフォルダ名をtora3にする

この場合(2)のtora3fld.iniは必要ありません。

(2)　アプリケーションのフォルダにtora3fld.iniという名で次の2行の内容のファイルを用意する

[update]
updaterdir=アップデータのフォルダ名

このファイルを用意しアップデータのフォルダ名を明記することで、Exec.exeをアプリケーションフォルダに配置した場合でも、アップデータの配置されるフォルダ名を自由に変更できます。
ただし、このファイルを用意してもアップデータのフォルダはアプリケーションのフォルダの直下でなければなりません。

■定義ファイル tora3.ini

アップデータのフォルダに入れておくべきもの。
アップデータの設定を記述します。
このファイルが見つからない場合は、アプリケーションを起動できませんので
アップデートする対象がない場合でも、このファイルは必要です。
また、tora3.ini自身をアップデータで更新することもできます。
tora3.iniには以下のセクションがあります。

[update]　ここから次のセクションまでに初期情報を書きます
list= アップデートされたファイルのリスト(list.txt)のURL list2= アップデートされたファイルのリスト(list.txt)のURL list3= アップデートされたファイルのリスト(list.txt)のURL

アップデートされたファイルのリスト(list.txt)が存在するURLを記述します。
list,list2,list3の順に参照して、最初に見つかったlistを使用します。第１候補（list=）のサーバがタイムアウトしたとき（URL→IPの解決が付かない時も含む）には第２候補(list2=)、 第３候補(list3=)と順に見に行きます。

これはあくまでサーバ障害に対する対策ですので、それ以外のエラー(認証失敗：404などでファイルが見つからない：etc）は、次のサーバを見に行かないので注意してください。

第一候補となるlist=は必ず記述しなければなりません。list2=,list3=については空欄でも結構です。

日本語等の２バイトコードURLには対応していません。
URLが変更になった場合、サーバ側にLocationによるリダイレクトを設定すれば、リダイレクト先を見に行きます。

exec= 認証とアップデート後の実行ファイル

アップデータが終了した後、実際に起動するアプリケーションを記述します。
コマンドラインオプションはここには書けません。
コマンドラインオプションが必要な場合はExec.exeを起動するときに指定してください。
Exec.exeを起動したときのコマンドラインオプションはそのままアプリケーションに渡されます。

user= 認証ユーザー名
pass= 認証パスワード

ここでの認証とは、.htaccessによる認証を意味します。
.htaccessによる認証を利用しない場合は無視されます。

proxy= 必要ならHTTPプロクシサーバ名
proxyport= 必要ならHTTPプロクシのポート（なければ80)

企業内などでプロキシーサーバを通してインターネットに接続している場合、ここにhttpプロキシサーバアドレスと使用ポートを記述します。
これは、アプリケーションのユーザーが直接tora3.iniを編集しなければなりません。

timeout=　HTTPのセッションタイムアウト（秒）

デフォルトは20秒です。0秒以下を指定した場合も20秒待ちます。

appname= タイトル名

アップデータ動作時のタイトルバーに表示する文字列を記述します
ここに記述された文字列が
「タイトル名：アップデータ」の様に表示されます。

offline= 0 あるいは 1

tora3auxが正常に終了しなかった際のアプリケーションの起動状態を設定します。
0の場合は終了します。
1の場合はアプリケーションを起動します。
デフォルトは0になっています。
オフラインでも使うアプリケーションなどは1に設定してください。

[other]　このセクションは無視されます。コメントなどに使います。

■定義ファイル list.txt

サーバ上にある更新内容のリスト
アップデート情報を記述します。
このファイルにTABを記入しても、アップデータは無視します。

[update]　ここから次のセクションまでに更新情報を書きます。

./updta.txt?www.domainname.com/upld/a.txt?2003/1/10?10:10:10?195
./folder/updtb.txt?www.domainname.com/upld/b.txt?2003/1/11?10:10:10?195

といった風に以下の情報を「?」で区切って書きます。

・アプリのフォルダからの相対指定のファイル名

実際にローカルマシンに配置する場所、及びファイル名を、アプリケーションフォルダを規準とした相対パスで書きます。

・そのファイルのURL

サーバ上に置かれたそのファイルのURLを書きます。ファイル名はローカルに配置される際には、前項で指定されたものに書き換わります。

・ファイルの日付

ローカルマシンに配置する際に、そのファイルに与えるタイムスタンプの日付を書きます。形式は　yyyy/(m)m/(d)d　となります。

・ファイルの時刻

ローカルマシンに配置する際に、そのファイルに与えるタイムスタンプの時刻を書きます。形式は24時間制で　(h)h:(m)m:(s)s　となります。

注意！
Windowsのファイルシステムの制約でリストの時刻の秒に奇数秒を指定すると、そのような時刻を持つファイルを作ることができない場合があるため、アップデートが正常に行われないことがあります。リスト内の時刻は必ず偶数秒にしてください。
また、サーバ上のファイルのタイムスタンプは無視します。

・ファイルサイズ

そのファイルのサイズをbyte単位で書きます。現在のところDLが正常に行われたかどうかは、このサイズでチェックしています(CRC等については今後サポート予定)

ファイル名が同一のものが複数行あった場合（本来これはIllegal）は、日時の一番新しいものだけを見て古いものは無視します。
日時も同じものが複数あった場合、どちらが残るかは未定義です。

実際のアップデートは以下の条件を満たしたファイルに対して行われます。

• 指定されたファイルがローカルに存在しない場合
• 指定されたファイルのサイズがローカルのファイルサイズと異なる場合
• 指定されたファイルのタイムスタンプがローカルのタイムスタンプと「異なる」場合

$$needed$$

リスト中に$$needed$$と書かれた行があると、アップデータはアップデートが完了するまでアプリケーションを起動しません。
これは、オンランゲームソフトのように、古いバージョンでの起動を禁止したい場合や、緊急性の高いアップデートに利用できます。
$$needed$$とかかれていなければ、アップデートを次回にしてもアプリケーションは起動します。
「$$needed$$」の行は[update]セクション内の任意の位置に書けますが、これはファイルに付く属性ではありません。全てのファイルをアップデートしないとアプリケーションの起動はできません。

[message]　アップデート確認時のダイアログに表示するメッセージ文字列を書きます。

[message]セクションにある文字列をアップデート時の確認メッセージとして表示します。次のセクションかファイルの最後までが(改行や空行もそのまま)メッセージとして利用されます。
このメッセージが見つからない場合にはデフォルトのメッセージが表示されます。
メッセージをデフォルトのままとしたい時には[message]セクションごと削除してください。

デフォルトメッセージ

[updete]セクションに$$needed$$がある場合

「 アップデートが必要なファイルが見つかりました
ダウンロードをしないとアプリケーションを起動できません
いまここでダウンロードしますか？」

[updete]セクションに$$needed$$がない場合

「アップデート可能なファイルが見つかりました
いまここでダウンロードしますか？」

[other]　このセクションは無視されます。コメントなどに使います。

■アップデータのアップデートについて

アップデータをアップデートするには、以下のような手順で行います。

• 新しいアップデータをサーバに用意する。
• list.txtには「アプリのフォルダからの相対指定のファイル名」部を$$update$$と記述する。

例：$$update$$?www.domainname.com/upld/tora3aux.exe?2003/1/10?10:10:10?195

これで、次回アプリケーション起動時にアップデータのアップデートが行われ、tora3aux.exeが更新されます。

■tora3aux_lang.dllのアップデートについて

tora3aux_lang.dllをアップデートするには、以下のような手順で行います。

• 新しいtora3aux_lang.dllをサーバに用意する。
• list.txtには「アプリのフォルダからの相対指定のファイル名」部を$$language$$と記述する。

例：$$language$$?www.domainname.com/upld/tora3aux_lang.dll?2003/1/10?10:10:10?195

これで、次回アプリケーション起動時にtora3aux_lang.dllのアップデートが行われ、tora3aux_lang.dllが更新されます。

■tora3^TMauxの組み込み手順

STEP1

■アップデータの配置に従って、アプリケーションフォルダ内にtora3^TMauxのファイル群を配置し、Exec.exeの名称、アイコンなどを好みに書き換え、アップデータのフォルダ内にあるtora3.iniを■定義ファイル tora3.iniの説明に従って書き換える。

STEP2

できれば、アプリケーションのヘルプメニューに以下のメニューを追加する。

• ヘルプメニュー内に「tora3aux自動アップデートについて」というメニューを設置
• 動作：デフォルトのブラウザーにてhttp://aux.tora3.net/を開く。

STEP3

アプリケーション配布サイトあるいはホームページに以下のいずれかのバナーを表示し、http://aux.tora3.net/へのリンクにする（笑）

■制限事項

Windowsのrunonce以前に起動するものに関してはアップデートできません。
アプリケーションのフォルダー及びそのサブフォルダ外のファイルはアップデートできません。
アプリケーションフォルダ外のファイルの更新には、ベンダー様向けに「tora3^TMauxpro」を別途ご用意しています。「tora3^TMauxpro」についてはaux@tora3.netまでお問い合わせください。

■必須環境

• Windows98以降のWindowsOS。
• インターネットとの接続。

■著作権

本システムのプログラム、実行ファイル、ドキュメント等の一切の権利はNTTechnology社にあります。
Copyright 2003 NTTechnology, Inc.

■ご利用条件

本システムの選択、導入、使用、使用結果につきまして、著作権者はいかなる責任も負い兼ねます。ご利用者が責任をもって使用してください。
また、本システムのアプリケーションのアップデートの目的以外での販売については、システム単体・同梱に関わらずaux@tora3.netまでお問い合わせください。
この使用条件については、予告無く変更・追加されることがあることをご了承ください。

以上の条件を満たす限りにおいて、本システムを自由にご利用ください。

■更新履歴