Tripletail::Session - セッション
$TL->startCgi( -DB => 'DB', -Session => 'Session', -main => \&main, ); sub main { my $session = $TL->getSession('Session'); my $oldValue = $session->getValue; $session->setValue(12345); ... }
$TL->setInputFilter('Tripletail::InputFilter::MobileHTML'); $TL->startCgi( -DB => 'DB', -Session => 'Session', -main => \&main, ); sub main { $TL->setContentFilter( 'Tripletail::Filter::MobileHTML', charset => 'Shift_JIS', ); my $session = $TL->getSession('Session'); my $oldValue = $session->getValue; $session->setValue(12345); ... }
64bit符号無し整数値の管理機能を持ったセッション管理クラス。
セッションは64bit整数から負の数を除いた範囲（0〜9223372036854775807）以外の データを取り扱えない為、その他のデータを管理したい場合は、 セッションキーを用い別途管理する必要がある。
セッションの管理は DB を利用して行われる。
また、保存に利用するテーブルは自動的に作成される。 デフォルトでは tl_session_Session という名前になる。 (Ini 項目 "sessiontable" 参照)
tl_session_Session
プログラム本体とDB接続を共有するため、以下の点に注意しなければならない。
セッションの操作は、トランザクション中及びテーブルロック中には行わない。
コンテンツの出力操作は、トランザクション中及びテーブルロック中には行わない。
セッションキーは、 出力フィルタ に Tripletail::Filter::HTML を使用している場合は クッキー に、 Tripletail::Filter::MobileHTML の場合は クエリ に、それぞれ挿入される。
また、 入力フィルタ に Tripletail::InputFilter::HTML を使用している場合は クッキー から、Tripletail::InputFilter::MobileHTML の場合は クエリ から、それぞれ読み取られる。
出力フィルタに Tripletail::Filter::HTML を利用した場合は、 入力フィルタに Tripletail::InputFilter::HTML を使用する必要がある。
同様に、出力フィルタに Tripletail::Filter::MobileHTML を利用した場合は、 入力フィルタに Tripletail::InputFilter::MobileHTML を使用する必要がある。
出力フィルタに Tripletail::Filter::MobileHTML を利用する場合は フォームの利用の仕方に注意が必要であるため、 Tripletail::Filter::MobileHTML ドキュメントに書かれている 利用方法を別途確認すること。
$TL->getSession
$session = $TL->getSession($group)
Tripletail::Session オブジェクトを取得。 引数には ini で設定したグループ名を渡す。省略可能。
このメソッドは、 Tripletail#startCgi の呼び出し時に -Session => '(Iniグループ名)' で指定されたグループのセッションが有効化 されていなければ die する。
-Session => '(Iniグループ名)'
die
引数省略時は 'Session' グループが使用される。
isHttps
$session->isHttps
現在のリクエストがhttpsなら1を、そうでなければundefを返す。
if ($session->isHttps) { ... }
get
$sid = $session->get
ユニークなセッションキーを取得する。
セッションキーは64bit整数値の負の数を除いた範囲となる。
Perlでは通常32bit整数値までしか扱えないため、セッションキーを数値として扱ってはならない。
セッションが存在しなければ、新規に発行する。
セッションの発行は常に行え、double モード時の非SSL側からの get メソッド呼び出しでもセッションは設定される。 ただし、SSL側からアクセスした際にセッションが無効になるため、その時にセッションIDは再作成される。
このメソッドの呼び出しは、コンテンツデータを返す前に行わなければならない。
renew
$sid = $session->renew
新しくユニークなセッションキーを発行し、取得する。
以前のセッションキーが存在した場合、そのセッションキーは無効となる。 また、以前のセッションに保存されていた値も破棄される。
discard
$session->discard
現在のセッションキーを無効にする。 また、セッションに保存されていた値も破棄される。
setValue
$session->setValue($value)
セッションに値を設定する。
設定できる値は '64bit符号無し整数' のみ（※PostgreSQL利用時は64bit整数値のみ）。 その他のデータを管理したい場合は、セッションキーを用いて別途実装する必要がある。
doubleモードの場合は、SSL起動時の場合に限り、両方のセッションに書き込まれる。 doubleモードで非SSL側からこのメソッドを使ってセッションを書換えようとした場合、 httpsモードで非SSL側から書き換えようとした場合は die する。
getValue
$value = $session->getValue
セッションから値を取得する。
セッションが存在しない場合は undef を返す。
getSessionInfo
($name, $sid, $checkval) = $session->getSessionInfo
セッション情報を取得する。
クッキーやフォームにセッションを保存する際の名称、セッションキー、チェック値を返す。 チェック値は、現在のリクエストが https/http によって使用されているものが返される。 そのため、double モードの場合、現在のリクエスト状態に応じてチェック値が異なる。
セッションが存在しない場合は $sid、$checkval には undef が返る。
TripletaiL は、古いセッションデータを削除することはしません。
パフォーマンスを維持するため、古いセッションデータを定期的に削除するバッチを作成し、定期的に 実行するようにして下さい。
削除は以下のようなクエリで行えます。
DELETE FROM tablename WHERE updatetime < now() - INTERVAL 7 DAY LIMIT 10000
セッションの保存期間にあわせて、WHERE条件を変更して下さい。
また、セッションテーブルがMyISAM形式の場合は、LIMIT句を付けて一度に削除する レコード件数を制限し、長時間ロックがかからないようにすることを推奨します。
DELETE結果の件数が0件になるまで、ループして処理して下さい。
セッションテーブルがInnoDB形式の場合も、トランザクションが大きくなりすぎないよう、 LIMIT句を利用することを推奨します。
TripletaiL 0.29 以前では、セッションテーブルを作成する際に、 updatetime カラムにインデックスを張っていませんでした。
レコードの件数が多い場合、古いデータの削除に時間がかかることがあります。 その場合は、updatetime カラムにインデックスを張るようにして下さい。
0.30以降では、セッションテーブル作成時にインデックスを張るように動作が変更されています。
ALTER TABLE tablename ADD INDEX (updatetime); CREATE INDEX tablename_updtime_idx ON tablename (updatetime);
mode = double
設定可能な値は、'http'、 'https'、 'double'のいずれか。省略可能。
デフォルトはdouble。
SSLでの保護がないセッションを利用する。http/httpsの両方で使用できるが、セッションキーはhttp側から漏洩する可能性があるため、https領域からアクセスした場合も、十分な安全性は確保できないことに注意する必要がある。
SSLでの保護があるセッションを利用する。セッションキーはhttp側からの漏洩を防ぐため、http通信上には出力されない。https側でのみセッションへのアクセスが可能。
http側とhttps側で二重にセッションを張る。 https側からのみセッションへの書き込み・破棄が行え、その際にhttp側のセッション情報も同時に書き換えられる。 http側からはhttps側からセットされたセッション情報の参照のみが出来る。
http側はセッションキー漏洩の危険性があり、十分な安全性は確保できないが、https側は十分な安全性が確保できる。http側からセッションキーが漏洩した場合でも、https領域でのアクセスは安全である。
http領域読込 http領域書込 https領域読込 http領域書込 httpモード ○ ○ ○ ○ httpsモード die die ○ ○ doubleモード ○ die ○ ○
cookie = Cookie
http領域で使用するクッキーのグループ名を指定する。省略可能。
デフォルトは'Cookie'。
https 領域で使用するクッキーのグループ名を指定する。省略可能。 secureフラグが付いていなければエラーとなる。
デフォルトは'SecureCookie'．
timeout = 30 min
指定の時間経過したセッションは無効とする。度量衡 参照。省略可能。 最短で timeout - updateinterval の時間でタイムアウトする可能性がある。
デフォルトは30min。
updateinterval = 10 min
最終更新時刻から指定時間以上経過していたら、DBの更新時刻を更新する。度量衡 参照。省略可能。 最短で timeout - updateinterval の時間でタイムアウトする可能性がある。
デフォルトは10min。
setvaluewithrenew = 1
setValueした際に自動的にrenewを行うか否か。 0の場合、行わない。 1の場合、行う。
デフォルトは1。
dbgroup = DB
使用するDBのグループ名。 ini で設定したグループ名を渡す。 Tripletail#startCgi で有効化しなければならない。
dbset = W_Trans
使用する書き込み用DBセット名。 Tripletail#startCgi で有効化しなければならない。 ini で設定したグループ名を渡す。
readdbset = R_Trans
使用する読み込み用DBセット名。 Tripletail#startCgi で有効化しなければならない。 ini で設定したグループ名を渡す。
省略された場合は dbset と同じものが使用される。
sessiontable = tl_session
セッションで使用するテーブル名。 デフォルトは tl_session_グループ名 が使用される。
mysqlsessiontabletype = InnoDB
MySQLの場合、セッションで使用するテーブルの種類を何にするかを指定する。 デフォルトは指定無し。
セッションの管理情報が重要である場合、例えばアフィリエイトの追跡に 利用していて、セッションが意図せず途切れるとユーザに金銭的被害が 生じるような場合は、InnoDB を利用することを推奨します。
それ以外の場合は、MyISAM を利用することを推奨します。 TripletaiL のセッションテーブルは Fixed 型となるため、 非常に高速にアクセスできます。
csrfkey = JLapCbI4XW7G8oEi
addSessionCheck及びhaveSessionCheckで使用するキー。 サイト毎に値を変更する必要性がある。
logging = 1
セッション管理のログを出力するかを指定する。 1 を指定するとセッション管理情報をログに出力する。0 なら出力しない。 デフォルトは 0。
Copyright 2006 YMIRLINK Inc.
This framework is free software; you can redistribute it and/or modify it under the same terms as Perl itself
このフレームワークはフリーソフトウェアです。あなたは Perl と同じライセンスの 元で再配布及び変更を行うことが出来ます。
Address bug reports and comments to: tl@tripletail.jp
HP : http://tripletail.jp/
To install Tripletail, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tripletail
CPAN shell
perl -MCPAN -e shell install Tripletail
For more information on module installation, please visit the detailed CPAN module installation guide.