Source for file Ethna_Session.php

Documentation is available at Ethna_Session.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_Session.php
  5.  *
  6.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id: Ethna_Session.php 417 2006-11-17 09:03:53Z cocoitiban $
  10.  */
  11.  
  12. // {{{ Ethna_Session
  13. /**
  14.  *  セッションクラス
  15.  *
  16.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  17.  *  @access     public
  18.  *  @package    Ethna
  19.  */
  20. class Ethna_Session
  21. {
  22.     /**#@+
  23.      *  @access private
  24.      */
  25.  
  26.     /** @var    object  Ethna_Logger    loggerオブジェクト */
  27.     var $logger;
  28.  
  29.     /** @var    string  セッション名 */
  30.     var $session_name;
  31.  
  32.     /** @var    string  セッションデータ保存ディレクトリ */
  33.     var $session_save_dir;
  34.  
  35.     /** @var    bool    セッション開始フラグ */
  36.     var $session_start = false;
  37.  
  38.     /** @var    bool    匿名セッションフラグ */
  39.     var $anonymous = false;
  40.  
  41.     /**#@-*/
  42.  
  43.     /**
  44.      *  Ethna_Sessionクラスのコンストラクタ
  45.      *
  46.      *  @access public
  47.      *  @param  string  $appid      アプリケーションID(セッション名として使用)
  48.      *  @param  string  $save_dir   セッションデータを保存するディレクトリ
  49.      */
  50.     function Ethna_Session($appid, $save_dir, $logger)
  51.     {
  52.         $this->session_name = "${appid}SESSID";
  53.         $this->session_save_dir = $save_dir;
  54.         $this->logger =& $logger;
  55.  
  56.         if ($this->session_save_dir != "") {
  57.             session_save_path($this->session_save_dir);
  58.         }
  59.  
  60.         session_name($this->session_name);
  61.         session_cache_limiter('private, must-revalidate');
  62.  
  63.         $this->session_start = false;
  64.         if (isset($_SERVER['REQUEST_METHOD']) == false) {
  65.             return;
  66.         }
  67.  
  68.         if (strcasecmp($_SERVER['REQUEST_METHOD'], 'post') == 0) {
  69.             $http_vars =& $_POST;
  70.         } else {
  71.             $http_vars =& $_GET;
  72.         }
  73.         if (array_key_exists($this->session_name, $http_vars)
  74.             && $http_vars[$this->session_name] != null) {
  75.             $_COOKIE[$this->session_name] = $http_vars[$this->session_name];
  76.         }
  77.     }
  78.  
  79.     /**
  80.      *  セッションを復帰する
  81.      *
  82.      *  @access public
  83.      */
  84.     function restore()
  85.     {
  86.         if (!empty($_COOKIE[$this->session_name]) ||
  87.         (ini_get("session.use_trans_sid") == 1 &&
  88.         !empty($_REQUEST[$this->session_name]))
  89.         ) {
  90.             session_start();
  91.             $this->session_start = true;
  92.  
  93.             // check session
  94.             if ($this->isValid() == false) {
  95.                 setcookie($this->session_name, "", 0, "/");
  96.                 $this->session_start = false;
  97.             }
  98.  
  99.             // check anonymous
  100.             if ($this->get('__anonymous__')) {
  101.                 $this->anonymous = true;
  102.             }
  103.         }
  104.     }
  105.  
  106.     /**
  107.      *  セッションの正当性チェック
  108.      *
  109.      *  @access public
  110.      *  @return bool    true:正当なセッション false:不当なセッション
  111.      */
  112.     function isValid()
  113.     {
  114.         if (!$this->session_start) {
  115.             if (!empty($_COOKIE[$this->session_name]) || session_id() != null) {
  116.                 setcookie($this->session_name, "", 0, "/");
  117.             }
  118.             return false;
  119.         }
  120.  
  121.         // check remote address
  122.         if (!isset($_SESSION['REMOTE_ADDR'])
  123.             || $this->_validateRemoteAddr($_SESSION['REMOTE_ADDR'],
  124.                                           $_SERVER['REMOTE_ADDR']) == false) {
  125.             // we do not allow this
  126.             setcookie($this->session_name, "", 0, "/");
  127.             session_destroy();
  128.             $this->session_start = false;
  129.             return false;
  130.         }
  131.  
  132.         return true;
  133.     }
  134.  
  135.     /**
  136.      *  セッションを開始する
  137.      *
  138.      *  @access public
  139.      *  @param  int     $lifetime   セッション有効期間(秒単位, 0ならセッションクッキー)
  140.      *  @return bool    true:正常終了 false:エラー
  141.      */
  142.     function start($lifetime = 0, $anonymous = false)
  143.     {
  144.         if ($this->session_start) {
  145.             // we need this?
  146.             $_SESSION['REMOTE_ADDR'] = $_SERVER['REMOTE_ADDR'];
  147.             $_SESSION['__anonymous__'] = $anonymous;
  148.             return true;
  149.         }
  150.  
  151.         if (is_null($lifetime)) {
  152.             ini_set('session.use_cookies', 0);
  153.         } else {
  154.             ini_set('session.use_cookies', 1);
  155.         }
  156.  
  157.         session_set_cookie_params($lifetime);
  158.         session_id(Ethna_Util::getRandom());
  159.         session_start();
  160.         $_SESSION['REMOTE_ADDR'] = $_SERVER['REMOTE_ADDR'];
  161.         $_SESSION['__anonymous__'] = $anonymous;
  162.         $this->session_start = true;
  163.  
  164.         return true;
  165.     }
  166.  
  167.     /**
  168.      *  セッションを破棄する
  169.      *
  170.      *  @access public
  171.      *  @return bool    true:正常終了 false:エラー
  172.      */
  173.     function destroy()
  174.     {
  175.         if (!$this->session_start) {
  176.             return true;
  177.         }
  178.         
  179.         session_destroy();
  180.         $this->session_start = false;
  181.         setcookie($this->session_name, "", 0, "/");
  182.  
  183.         return true;
  184.     }
  185.  
  186.     /**
  187.      *  セッションIDを再生成する
  188.      *
  189.      *  @access public
  190.      *  @return bool    true:正常終了 false:エラー
  191.      */
  192.     function regenerateId($lifetime = 0, $anonymous = false)
  193.     {
  194.         if (! $this->session_start) {
  195.             return false;
  196.         }
  197.        
  198.         $tmp = $_SESSION;
  199.  
  200.         $this->destroy();
  201.         $this->start($lifetime, $anonymous);
  202.         
  203.         unset($tmp['REMOTE_ADDR']);
  204.         unset($tmp['__anonymous__']);
  205.         foreach ($tmp as $key => $value) {
  206.             $_SESSION[$key] = $value;
  207.         }
  208.  
  209.         return true;
  210.     }
  211.  
  212.     /**
  213.      *  セッション値へのアクセサ(R)
  214.      *
  215.      *  @access public
  216.      *  @param  string  $name   キー
  217.      *  @return mixed   取得した値(null:セッションが開始されていない)
  218.      */
  219.     function get($name)
  220.     {
  221.         if (!$this->session_start) {
  222.             return null;
  223.         }
  224.  
  225.         if (!isset($_SESSION[$name])) {
  226.             return null;
  227.         }
  228.         return $_SESSION[$name];
  229.     }
  230.  
  231.     /**
  232.      *  セッション値へのアクセサ(W)
  233.      *
  234.      *  @access public
  235.      *  @param  string  $name   キー
  236.      *  @param  string  $value  値
  237.      *  @return bool    true:正常終了 false:エラー(セッションが開始されていない)
  238.      */
  239.     function set($name, $value)
  240.     {
  241.         if (!$this->session_start) {
  242.             // no way
  243.             return false;
  244.         }
  245.  
  246.         $_SESSION[$name] = $value;
  247.  
  248.         return true;
  249.     }
  250.  
  251.     /**
  252.      *  セッションの値を破棄する
  253.      *
  254.      *  @access public
  255.      *  @param  string  $name   キー
  256.      *  @return bool    true:正常終了 false:エラー(セッションが開始されていない)
  257.      */
  258.     function remove($name)
  259.     {
  260.         if (!$this->session_start) {
  261.             return false;
  262.         }
  263.  
  264.         unset($_SESSION[$name]);
  265.  
  266.         return true;
  267.     }
  268.  
  269.     /**
  270.      *  セッションが開始されているかどうかを返す
  271.      *
  272.      *  @access public
  273.      *  @param  string  $anonymous  匿名セッションを「開始」とみなすかどうか(default: false)
  274.      *  @return bool    true:開始済み false:開始されていない
  275.      */
  276.     function isStart($anonymous = false)
  277.     {
  278.         if ($anonymous) {
  279.             return $this->session_start;
  280.         } else {
  281.             if ($this->session_start && $this->isAnonymous() != true) {
  282.                 return true;
  283.             } else {
  284.                 return false;
  285.             }
  286.         }
  287.     }
  288.  
  289.     /**
  290.      *  匿名セッションかどうかを返す
  291.      *
  292.      *  @access public
  293.      *  @return bool    true:匿名セッション false:非匿名セッション/セッション開始されていない
  294.      */
  295.     function isAnonymous()
  296.     {
  297.         return $this->anonymous;
  298.     }
  299.  
  300.     /**
  301.      *  セッションに保存されたIPアドレスとアクセス元のIPアドレスが
  302.      *  同一ネットワーク範囲かどうかを判別する(16bit mask)
  303.      *
  304.      *  @access private
  305.      *  @param  string  $src_ip     セッション開始時のアクセス元IPアドレス
  306.      *  @param  string  $dst_ip     現在のアクセス元IPアドレス
  307.      *  @return bool    true:正常終了 false:不正なIPアドレス
  308.      */
  309.     function _validateRemoteAddr($src_ip, $dst_ip)
  310.     {
  311.         $src = ip2long($src_ip);
  312.         $dst = ip2long($dst_ip);
  313.  
  314.         if (($src & 0xffff0000) == ($dst & 0xffff0000)) {
  315.             return true;
  316.         } else {
  317.             $this->logger->log(LOG_NOTICE, "session IP validation failed [%s] - [%s]",
  318.                                $src_ip, $dst_ip);
  319.             return false;
  320.         }
  321.     }
  322. }
  323. // }}}
  324. ?>

Documentation generated on Thu, 08 May 2008 00:15:27 +0900 by phpDocumentor 1.4.2