Configuration/ディレクティブ - mod_chxj Wiki - mod_chxj

ディレクティブ

Up: 設定

Prev: 設定

Next: デバイス定義

Outline

• ChxjLoadDeviceDataディレクティブ
• ChxjLoadEmojiDataディレクティブ
• ChxjImageEngineディレクティブ
• ChxjImageCacheDirディレクティブ
• ChxjImageCacheLimitディレクティブ
• ChxjImageCopyrightディレクティブ
• ChxjConvertRuleディレクティブ
• ChxjCookieDirディレクティブ
• ChxjCookieTimeoutディレクティブ
• ChxjCookieStoreTypeディレクティブ
• ChxjCookieLazyModeディレクティブ
• ChxjCookieMysqlHostディレクティブ
• ChxjCookieMysqlPortディレクティブ
• ChxjCookieMysqlDatabaseディレクティブ
• ChxjCookieMysqlUsernameディレクティブ
• ChxjCookieMysqlPasswordディレクティブ
• ChxjCookieMysqlSocketPathディレクティブ
• ChxjCookieMysqlCharsetディレクティブ
• ChxjCookieMysqlTablenameディレクティブ
• ChxjCookieMemcacheHostディレクティブ
• ChxjCookieMemcachePortディレクティブ
• ChxjAllowedCookieDomainディレクティブ
• ChxjNewLineTypeディレクティブ
• ChxjImodeEmojiColorディレクティブ(0.13.0以降)
• ChxjAddDeviceDataTSVディレクティブ(0.13.0以降)
• ChxjImageRewriteディレクティブ(0.13.0以降)
• ChxjImageRewriteUrlディレクティブ(0.13.0以降)
• ChxjImageRewriteModeディレクティブ(0.13.0以降)
• ChxjUseEmojiImageディレクティブ(0.14.0以降）
• ChxjEmojiImageUrlディレクティブ(0.14.0以降）

ChxjLoadDeviceDataディレクティブ

説明	デバイス定義ファイルを指定します
構文	ChxjLoadDeviceData デバイス定義ファイルパス
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

このディレクティブは携帯端末の情報が記述されたデバイス定義ファイルのパスを指定します。 ここで指定されたデバイス定義ファイルの内容により、mod_chxjの動作がほぼ決定されます。
mod_chxjを動作させる場合には必須です。

例:

ChxjLoadDeviceData /etc/apache2/device.xml

---

ChxjLoadEmojiDataディレクティブ

説明	絵文字変換定義ファイルを指定します
構文	ChxjLoadEmojiData 絵文字変換定義ファイルパス
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

このディレクティブでDoCoMo/au/SoftBank毎の絵文字を定義されたファイルのパスを指定します。 mod_chxjを動作させる場合には必須です。

例:

ChxjLoadEmojiData   /etc/apache2/chxj/emoji.xml

---

ChxjImageEngineディレクティブ

説明	画像変換エンジンを有効・無効にします
構文	ChxjImageEngine On/Off
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

このディレクティブを使用することで、画像変換エンジンを有効（または無効）にします。 指定できるパラメータは"On"または"Off"のみです。 !On以外の値を指定した場合はOffとして扱われます。

例:

ChxjImageEngine On

---

ChxjImageCacheDirディレクティブ

説明	画像変換エンジンが作成する一時ファイル保存場所を指定します
構文	ChxjImageEngine 一時ファイル保存パス
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

このディレクティブを使用することで、画像変換エンジンで使用する一時ファイルの設置場所を指定できます。 指定されない場合は/tmpになります。

例:

ChxjImageCacheDir   /tmp

---

ChxjImageCacheLimitディレクティブ

説明	画像変換エンジンが作成する一時ファイル保存場所の最大合計保存サイズを指定します。
構文	ChxjImageCacheLimit バイト数
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

このディレクティブを使用することで、画像変換エンジンで使用する一時ファイルの設置場所最大合計量を制限できます。 指定単位は「バイト」です。
※画像変換結果が、パラメータに指定したバイト数以上あるときには、INTERNAL_SERVER_ERRORを返します。十分な領域を確保するか、変換元画像サイズを小さくしてください。

例:

# 1MByteの場合のリミット
ChxjImageCacheLimit   1048576

---

ChxjImageCopyrightディレクティブ

説明	画像に著作権情報を付与します。
構文	ChxjImageCopyright 著作権情報文字列
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

mod_chxjの画像変換エンジンに転送禁止設定を行うよう指示します。 パラメータとして任意の文字列をとります。

例:

ChxjImageCopyright "chosakuken jyoho"

例のように指定した場合、画像のコメント部に以下の文字列を埋め込みます。

• DoCoMoの場合

  copy="NO",chosakuken jyoho
  

• auの場合

  kddi_copyright=on,chosakuken jyoho
  

• SoftBankの場合

  x-jphone-copyright:no-transfer
  

※SoftBankの場合にはリクエストURLの最後が.pnzか、.jpzで終わるようにダミーを付けなければなりません。

---

ChxjConvertRuleディレクティブ

説明	HTML変換エンジンの適用ルールを記述します
構文	ChxjConvertRule パターン 機能のオン／オフ 文字コード [PCフラグ [Dummy User-Agent]]
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

HTML変換エンジン機能のオン・オフ、クッキーシミュレータ機能のオン・オフを指定します。 ルールは記述された順番に評価されます。必須パラメータは「パターン」「機能のオン／オフ｣「文字コード」の3つです。
下記にそれぞれのパラメータの説明を記します。

• 第一引数(パターン)

本ルールを適用するリクエストURLにマッチさせるパターンを指定します。!Perl互換正規表現が使用できます。

• 第二引数(機能のオン／オフ)

リクエストURLが第一引数で指定したパターンにマッチした場合のmod_chxjの「動作」を指定します。 指定できる「動作」は以下のとおりです。

EngineOn	HTML変換エンジンを有効にします。
EngineOff	HTML変換エンジンを無効にします。
CookieOn	クッキーシミュレータを有効にします。
CookieOff	クッキーシミュレータを無効にします。
Z2hOn	全角カタカナを半角カタカナに変換する機能を有効にします。 (0.12.23以降、EngineOn状態である必要があります。)
Z2hOff	全角カタカナを半角カタカナに変換する機能を無効にします。 (0.12.23以降、EngineOn状態である必要があります。)
Z2hAlphaOn	全角英字を半角英字に変換する機能を有効にします。 (0.12.25以降、EngineOn状態である必要があります。)
Z2hAlphaOff	全角英字を半角英字に変換する機能を無効にします。 (0.12.25以降、EngineOn状態である必要があります。)
Z2hNumOn	全角数字を半角数字に変換する機能を有効にします。 (0.12.25以降、EngineOn状態である必要があります。)
Z2hNumOff	全角数字を半角数字に変換する機能を無効にします。 (0.12.25以降、EngineOn状態である必要があります。)
Z2hAllOn	Z2hOn、Z2hAlphaOn、Z2hNumOnの3つを有効にします。 (0.12.25以降、EngineOn状態である必要があります。)
Z2hAllOff	Z2hOn、Z2hAlphaOn、Z2hNumOnの3つを無効にします。 (0.12.25以降、EngineOn状態である必要があります。)
QSConvOff	form中のQUERY_STRINGをhiddenタグに振り替える処理を無効にします。 (0.12.31以降、EngineOn状態である必要があります。)
JRConvOff	SoftBank予約パラメータを透過的に扱うための変換処理を無効にします。 (0.12.31以降、EngineOn状態である必要があります。)
NoCacheOn	"Pragma: no-cache" "Expires: Thu, 01 Jan 1970 00:00:00 GMT" "Cache-Control: no-cache, no-store" の3つのヘッダを強制出力します。 画像などを端末に保存させる場合には保存できなくなりますので使用しないでください。 (0.12.31以降、EngineOn状態である必要があります。)
EmojiOnly	絵文字の変換のみ行います。 (0.12.32以降、EngineOn状態である必要があります。) (0.12.39以降、0.13.1以降ではEngineOn状態である必要はありません。)
EnvInfoOnly	機種情報ヘッダの付加のみ行います。EmojiOnlyと併用可。 (0.12.34以降、EngineOn状態である必要があります。)
CookieOnly	クッキーシミュレータのみ有効にします。EnjineOnと併用した場合の動作は未定義です。(0.12.38以降)
CssOn	CSS変換機能を有効にします。 (0.13.0以降、EngineOn状態である必要があります。)

• 第三引数(文字コード)

サーバ側コンテンツの文字コードを指定します。指定できる文字コードはglibc/iconvに依存します。特に変換させない場合は"NONE"を指定します。

• 第四引数(PCフラグ)

サーバ側コンテンツがPC用HTMLの場合には"PC"を指定します。

• 第五引数(Dummy User-Agent)

サーバ側へここで指定されたUser-Agentでアクセスします。

以下にいくつかのChxjConvertRuleの例を記します。

例1)
ChxjConvertRule "^/chxj.+$" EngineOn EUC-JP-WIN

上記はURLが^/chxj.+$にマッチする場合、HTML変換エンジンを有効(EngineOn)にし、サーバ側文字コードはEUC-JP-WINであることをあらわします。

例2)
ChxjConvertRule "^/.+$" EngineOn,CookieOn UTF-8 PC "DoCoMo/1.0/D501i"

上記はURLが^/.+$にマッチする場合、HTML変換エンジンを有効(EngineOn)に、クッキーシミュレータを有効(CookieOn)にして、サーバ側文字コードはUTF-8、変換対象はPC用HTMLで、サーバ側には!User-Agent: DoCoMo/1.0/D501iでアクセスすることを表します。

---

ChxjCookieDirディレクティブ

説明	クッキーシミュレータのクッキーの保存ディレクトリを指定します。（DBMの場合のみ）
構文	ChxjCookieDir クッキー保存ディレクトリパス
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先をdbmにする場合（デフォルト）指定します。クッキーの内容を保存するディレクトリを指定します。 指定しない場合は/tmpに保存されます。 詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieTimeoutディレクティブ

説明	クッキーの保持期間を秒単位で指定します
構文	ChxjCookieTimeout クッキー保存時間（秒）
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキーを使用する場合に指定します。 指定しない場合は、1800秒でクッキーデータを破棄します。 詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieStoreTypeディレクティブ

説明	クッキー保存先（タイプ）を指定します。
構文	ChxjCookieStoreType 保存先タイプ
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

指定できるものは以下のとおりです。

指定できる値	意味	指定例
"dbm"	dbmを選択します。	ChxjCookieStoreType "dbm"
"mysql"	mysqlを選択します。有効にするにはconfigure時にMYSQL COOKIE機能を有効にする必要があります	ChxjCookieStoreType "mysql"
"memcache"	memcacheを選択します。有効にするにはconfigure時にMEMCACHE COOKIE機能を有効にする必要があります	ChxjCookieStoreType "memcache"

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieLazyModeディレクティブ

説明	クッキーIDを毎回新しく発行するかどうかを指定する
構文	ChxjCookieLazyMode trueかfalse
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

trueを指定すると、クッキーIDは毎回同じ値が使用されます。よってブラウザ等の戻るボタンで戻った際にもセッションを継続することが可能です。 true以外を指定すると、クッキーIDは毎回別の値がしようされます（One-Time ID）。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMysqlHostディレクティブ

説明	!MySQLサーバの動作するホストを指定します。
構文	ChxjCookieMysqlHost ホスト名/IP
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先に!MySQLを選択した場合に指定します。configure時にMYSQL COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMysqlPortディレクティブ

説明	!MySQLサーバのポート番号を指定します。
構文	ChxjCookieMysqlPort ポート番号
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先に!MySQLを選択した場合に指定します。configure時にMYSQL COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMysqlDatabaseディレクティブ

説明	!MySQLサーバのデータベース名を指定します。
構文	ChxjCookieMysqlDatabase データベース名
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先に!MySQLを選択した場合に指定します。configure時にMYSQL COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMysqlUsernameディレクティブ

説明	MySQLサーバに接続する際に使用するユーザ名を指定します。
構文	ChxjCookieMysqlUsername ユーザ名
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先に!MySQLを選択した場合に指定します。configure時にMYSQL COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMysqlPasswordディレクティブ

説明	!MySQLサーバに接続する際に使用するパスワードを指定します。
構文	ChxjCookieMysqlPassword パスワード
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先に!MySQLを選択した場合に指定します。configure時にMYSQL COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMysqlSocketPathディレクティブ

説明	!MySQLのソケットパスを指定します。
構文	ChxjCookieMysqlSocketPath ソケットパス
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先に!MySQLを選択した場合に指定します。configure時にMYSQL COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMysqlCharsetディレクティブ

説明	!MySQLのエンコードを指定します。
構文	ChxjCookieMysqlCharset エンコーディング
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先に!MySQLを選択した場合に指定します。configure時にMYSQL COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMysqlTablenameディレクティブ

説明	!MySQLのクッキーを保存するテーブル名を指定します。
構文	ChxjCookieMysqlTablename テーブル名
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

ここで、たとえば"chxj_cookie"と指定すると、実際にはchxj_cookieテーブルと、chxj_cookie_expireテーブルが作成されます。 クッキー保存先に!MySQLを選択した場合に指定します。configure時にMYSQL COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMemcacheHostディレクティブ

説明	memcachedの動作するホストを指定します。
構文	ChxjCookieMemcacheHost ホスト名/IP
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先にmemcachedを選択した場合に指定します。configure時にMEMCACHE COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjCookieMemcachePortディレクティブ

説明	memcachedのポート番号を指定します。
構文	!chxjCookieMemcachePort ポート番号
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess

クッキー保存先にmemcachedを選択した場合に指定します。configure時にMEMCACHE COOKIE機能を有効にしていない場合はエラーになります。

詳細はクッキーシミュレート機能を参照してください。

---

ChxjAllowedCookieDomainディレクティブ

説明	クッキー制御パラメータを付加するドメインを指定します。
構文	ChxjAllowedCookieDomain ドメイン文字列
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess
互換性	0.12.34以降で対応

詳細はクッキーシミュレート機能を参照してください。

---

ChxjNewLineTypeディレクティブ

説明	変換結果のHTMLにおける改行コードを指定します。
構文	ChxjNewLineType 改行コード指示子
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess
互換性	0.12.0以降で対応

指定できる改行コード指示子は以下のとおりです。

改行コード指示子	意味
crlf	HTMLの改行コードにcrlfを使用します。
cr	HTMLの改行コードにcrを使用します。
lf	HTMLの改行コードにlfを使用します。
none	HTMLには改行コードを埋め込みません。

出力結果のサイズを少しでも小さくしたい場合にはnoneを指定します。その際、出力結果は1行でクライアントに送信されます。 デフォルトではcrlfが選択されます。 大文字小文字は区別しません。
例) 出力結果の改行コードにcrlfを使用する場合。

 ChxjNewLineType CRLF

ChxjImodeEmojiColorディレクティブ(0.13.0以降)

説明	クライアント端末がimodeの場合、変換後絵文字に色を自動で付加するかどうかを指定します。
構文	ChxjImodeEmojiColor ON/OFF/AUTO
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess
互換性	0.13.0以降で対応

ONが指定された場合は絵文字定義ファイルの<color>属性の値にしたがって絵文字に色を付与します。 AUTOが指定された場合は該当絵文字の直接の親タグがspanタグもしくはfontタグ以外であれば絵文字に色を付与します。
例) 絵文字の色をつける

 ChxjImodeEmojiColor ON

ChxjAddDeviceDataTSVディレクティブ(0.13.0以降)

説明	device_data.xmlで定義されている機種情報をtsvファイルで上書きする場合に指定します。
構文	ChxjAddDeviceDataTSV "tsvファイル名"
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess
互換性	0.13.0以降で対応

tsvファイルの先頭行は上書きしたいキーをtab区切りで指定します。 2行目以降は先頭行の指定したキーの順番に上書きしたい値をtab区切りで指定します。

指定できるキーは以下のとおり。

キー	内容
device_name	デバイス名(device_idではない)
width	画像の幅
heigh	画像の高さ
height	画像の高さ
wp_width	壁紙の幅
wp_heigh	壁紙の高さ
wp_height	壁紙の高さ
cache	キャッシュサイズ
gif	gif画像が使用できるかどうか。(true|false)
jpeg	jpeg画像が使用できるかどうか。(true|false)
png	png画像が使用できるかどうか。(true|false)
bmp2	bmp2画像が使用できるかどうか。(true|false)
bmp4	bmp4画像が使用できるかどうか。(true|false)
color	色数
emoji_type	絵文字タイプ(auの場合にのみ有効)
html_spec_type	変換後htmlタイプ
output_encoding	端末へ送信する出力文字コード

なお、キーの詳細はデバイス定義を参照してください。

ChxjImageRewriteディレクティブ(0.13.0以降)

説明	imgタグのurlや画像へのリクエストをリライトする機能を有効にするOn|Off
構文	ChxjImageRewrite On/Off
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess
互換性	0.13.0以降で対応

ChxjImageRewriteUrlディレクティブ、ChxjImageRewriteModeディレクティブとともに使用します。

ChxjImageRewriteUrlディレクティブ(0.13.0以降)

説明	imgタグのurlや画像へのリクエストをリライト先URLを指定する
構文	ChxjImageRewriteUrl リライト先URL
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess
互換性	0.13.0以降で対応

ChxjImageRewriteModeで"tag"が指定されている場合にはimgタグなどの画像へのURLが書き換えられます。 ChxjImageRewriteModeで"all"が指定されている場合には画像へのリクエスト全てが指定のURLへのリクエストに 書き換えられ、内部リダイレクトします。 ChxjImageRewriteModeで"user"が指定されている場合にはパラメータ"_x-chxj_imgrewrite=on"が指定されている imgタグ、リクエストurlを全てChxjImageRewriteUrlディレクティブで指定されたリライト先URLへ内部リダイレクトします。

ChxjImageRewriteModeディレクティブ(0.13.0以降)

説明	画像リライトモードを指定します。
構文	ChxjImageRewriteMode user/tag/all
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess
互換性	0.13.0以降で対応

指定されたモードの内容は以下のとおりです。

指定モード	内容
all	画像へのリクエスト全てをChxjImageRewriteUrlで指定された!URLへ内部リダイレクトします。
tag	imgタグ全ての!URLをChxjImageRewriteUrlで指定された!URLへ内部リダイレクトします。
user	ユーザが任意にパラメータ"_x-chxj_imgrewrite=on"を付与したリクエストをChxjImageRewriteUrlで指定された!URLへ内部リダイレクトします。

ChxjUseEmojiImageディレクティブ(0.14.0以降）

説明	変換後絵文字に画像を使用するかどうかを指定します。
構文	ChxjUseEmojiImage !On/!Off
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess
互換性	0.14.0以降で対応

絵文字定義ファイルに"image"が指定されている場合でChxjUseEmojiImage !On、かつChxjEmojiImageUrlに値が設定されている場合 変換後絵文字は画像(imgタグ)に変換されます。
※現在android、iPhone2の場合には必須としています。

ChxjEmojiImageUrlディレクティブ(0.14.0以降）

説明	絵文字用画像が置いてあるUrlを指定します。
構文	ChxjEmojiImageUrl url
コンテキスト	サーバ設定ファイル, バーチャルホスト, ディレクトリ, .htaccess
互換性	0.14.0以降で対応

絵文字定義ファイルに"image"が指定されている場合でChxjUseEmojiImage !On、かつChxjEmojiImageUrlに値が設定されている場合 変換後絵文字は画像(imgタグ)に変換されます。
例)

 ChxjUseEmojiImage On
 ChxjEmojiImageUrl /images/emoji

と指定があり、絵文字定義ファイル(emoji.xml)に以下のような設定があったとします。

   <set>
     <no>1</no>
     〜  略  〜
     <android>
       <string>image</string>
     </android>
   </set>

この状態でAndroid端末からアクセスがあった場合は、 絵文字定義ファイルのno1の絵文字は

 <img src="/images/emoji/1" />

と変換されます。

※現在android、iPhone2の場合には必須としています。

Up: 設定

Prev: 設定

Next: デバイス定義