File Source for Session.php

<?php
// vim: foldmethod=marker
/**
* Session.php
*
* @author Masaki Fujimoto <fujimoto@php.net>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @package Ethna
* @version $Id: 8848afe7c9ad34755d9310889de6dd982fc2c59c $
*/
// {{{ Ethna_Session
/**
* セッションクラス
*
* @author Masaki Fujimoto <fujimoto@php.net>
* @access public
* @package Ethna
*/
class Ethna_Session
{
/**#@+
* @access private
*/
/** @protected object Ethna_Logger loggerオブジェクト */
protected $logger;
/** @protected string セッション名 */
protected $session_name;
/** @protected string セッションデータ保存ディレクトリ */
protected $session_save_dir;
/** @protected bool セッション開始フラグ */
protected $session_start = false;
/** @protected bool 匿名セッションフラグ */
protected $anonymous = false;
/** @protected array Configuration for session */
protected $config = array(
'handler' => 'files',
'path' => 'tmp',
'check_remote_addr' => true,
'cache_limiter' => 'nocache',
'cache_expire' => '180',
'suffix' => 'SESSID',
);
/**#@-*/
/**
* Ethna_Sessionクラスのコンストラクタ
*
* @access public
* @param string $appid アプリケーションID(セッション名として使用)
* @param string $save_dir セッションデータを保存するディレクトリ
*/
public function __construct($ctl, $appid)
{
$this->ctl = $ctl;
$this->logger = $this->ctl->getLogger();
$config = $this->ctl->getConfig()->get('session');
if ($config) {
$this->config = array_merge($this->config, $config);
}
$this->session_save_dir = $this->config['path'];
if (($dir = $this->ctl->getDirectory($this->config['path'])) !== null) {
$this->session_save_dir = $dir;
}
$this->session_name = $appid . $this->config['suffix'];
// set session handler
ini_set('session.save_handler', $this->config['handler']);
session_save_path($this->session_save_dir);
session_name($this->session_name);
session_cache_limiter($this->config['cache_limiter']);
session_cache_expire($this->config['cache_expire']);
$this->session_start = false;
if (isset($_SERVER['REQUEST_METHOD']) == false) {
return;
}
if (strcasecmp($_SERVER['REQUEST_METHOD'], 'post') == 0) {
$http_vars = $_POST;
} else {
$http_vars = $_GET;
}
if (array_key_exists($this->session_name, $http_vars)
&& $http_vars[$this->session_name] != null) {
$_COOKIE[$this->session_name] = $http_vars[$this->session_name];
}
}
/**
* セッションを復帰する
*
* @access public
*/
public function restore()
{
if (!empty($_COOKIE[$this->session_name])
|| (ini_get("session.use_trans_sid") == 1
&& !empty($_REQUEST[$this->session_name]))
) {
session_start();
$this->session_start = true;
// check remote address changed
if ($this->config['check_remote_addr']) {
if ($this->isValid() == false) {
setcookie($this->session_name, "", 0, "/");
$this->session_start = false;
}
}
// check anonymous
if ($this->get('__anonymous__')) {
$this->anonymous = true;
}
}
}
/**
* セッションIDを取得する
*
* @access public
* @return string session id
*/
public function getId()
{
return session_id();
}
/**
* セッションの正当性チェック
*
* @access public
* @return bool true:正当なセッション false:不当なセッション
*/
public function isValid()
{
if (!$this->session_start) {
if (!empty($_COOKIE[$this->session_name]) || session_id() != null) {
setcookie($this->session_name, "", 0, "/");
}
return false;
}
// check remote address
if (!isset($_SESSION['REMOTE_ADDR'])
|| $this->_validateRemoteAddr($_SESSION['REMOTE_ADDR'],
$_SERVER['REMOTE_ADDR']) == false) {
// we do not allow this
setcookie($this->session_name, "", 0, "/");
session_destroy();
$this->session_start = false;
return false;
}
return true;
}
/**
* セッションを開始する
*
* @access public
* @param int $lifetime セッション有効期間(秒単位, 0ならセッションクッキー)
* @return bool true:正常終了 false:エラー
*/
public function start($lifetime = 0, $anonymous = false)
{
if ($this->session_start) {
// we need this?
$_SESSION['REMOTE_ADDR'] = $_SERVER['REMOTE_ADDR'];
$_SESSION['__anonymous__'] = $anonymous;
return true;
}
if (is_null($lifetime)) {
ini_set('session.use_cookies', 0);
} else {
ini_set('session.use_cookies', 1);
}
session_set_cookie_params($lifetime);
session_id(Ethna_Util::getRandom());
session_start();
$_SESSION['REMOTE_ADDR'] = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR']: false;
$_SESSION['__anonymous__'] = $anonymous;
$this->anonymous = $anonymous;
$this->session_start = true;
$this->logger->log(LOG_INFO, 'Session started.');
return true;
}
/**
* セッションを破棄する
*
* @access public
* @return bool true:正常終了 false:エラー
*/
public function destroy()
{
if (!$this->session_start) {
return true;
}
session_destroy();
$this->session_start = false;
setcookie($this->session_name, "", 0, "/");
return true;
}
/**
* セッションIDを再生成する
*
* @access public
* @return bool true:正常終了 false:エラー
*/
public function regenerateId($lifetime = 0, $anonymous = false)
{
if (! $this->session_start) {
return false;
}
$tmp = $_SESSION;
$this->destroy();
$this->start($lifetime, $anonymous);
unset($tmp['REMOTE_ADDR']);
unset($tmp['__anonymous__']);
foreach ($tmp as $key => $value) {
$_SESSION[$key] = $value;
}
return true;
}
/**
* セッション値へのアクセサ(R)
*
* @access public
* @param string $name キー
* @return mixed 取得した値(null:セッションが開始されていない)
*/
public function get($name)
{
if (!$this->session_start) {
return null;
}
if (!isset($_SESSION[$name])) {
return null;
}
return $_SESSION[$name];
}
/**
* セッション値へのアクセサ(W)
*
* @access public
* @param string $name キー
* @param string $value 値
* @return bool true:正常終了 false:エラー(セッションが開始されていない)
*/
public function set($name, $value)
{
if (!$this->session_start) {
// no way
return false;
}
$_SESSION[$name] = $value;
return true;
}
/**
* セッションの値を破棄する
*
* @access public
* @param string $name キー
* @return bool true:正常終了 false:エラー(セッションが開始されていない)
*/
public function remove($name)
{
if (!$this->session_start) {
return false;
}
unset($_SESSION[$name]);
return true;
}
/**
* セッションが開始されているかどうかを返す
*
* @access public
* @param string $anonymous 匿名セッションを「開始」とみなすかどうか(default: false)
* @return bool true:開始済み false:開始されていない
*/
public function isStart($anonymous = false)
{
if ($anonymous) {
return $this->session_start;
} else {
if ($this->session_start && $this->isAnonymous() != true) {
return true;
} else {
return false;
}
}
}
/**
* 匿名セッションかどうかを返す
*
* @access public
* @return bool true:匿名セッション false:非匿名セッション/セッション開始されていない
*/
public function isAnonymous()
{
return $this->anonymous;
}
/**
* セッションに保存されたIPアドレスとアクセス元のIPアドレスが
* 同一ネットワーク範囲かどうかを判別する(16bit mask)
*
* @access private
* @param string $src_ip セッション開始時のアクセス元IPアドレス
* @param string $dst_ip 現在のアクセス元IPアドレス
* @return bool true:正常終了 false:不正なIPアドレス
*/
private function _validateRemoteAddr($src_ip, $dst_ip)
{
$src = ip2long($src_ip);
$dst = ip2long($dst_ip);
if (($src & 0xffff0000) == ($dst & 0xffff0000)) {
return true;
} else {
$this->logger->log(LOG_NOTICE, "session IP validation failed [%s] - [%s]",
$src_ip, $dst_ip);
return false;
}
}
}
// }}}

Documentation generated on Fri, 11 Nov 2011 03:59:03 +0900 by phpDocumentor 1.4.3

Source for file Session.php