source: branches/version-2_13-dev/data/class/sessionfactory/SC_SessionFactory_UseRequest.php @ 23493

Revision 23493, 15.8 KB checked in by pineray, 10 years ago (diff)

#2565 セッションに関するクラスや関数を整理

セッションハンドラの登録をファクトリーへ移動.

  • Property svn:eol-style set to LF
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-httpd-php; charset=UTF-8
Line 
1<?php
2/*
3 * This file is part of EC-CUBE
4 *
5 * Copyright(c) 2000-2013 LOCKON CO.,LTD. All Rights Reserved.
6 *
7 * http://www.lockon.co.jp/
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 */
23
24/**
25 * Cookieを使用せず、リクエストパラメーターによりセッションを継続する設定を行うクラス.
26 *
27 * このクラスを直接インスタンス化しないこと.
28 * 必ず SC_SessionFactory クラスを経由してインスタンス化する.
29 * また, SC_SessionFactory クラスの関数を必ずオーバーライドしている必要がある.
30 *
31 * @package SC_SessionFactory
32 * @author LOCKON CO.,LTD.
33 * @version $Id$
34 */
35class SC_SessionFactory_UseRequest extends SC_SessionFactory_Ex
36{
37    /** @var LC_UseRequest_State_Mobile|LC_UseRequest_State_PC  */
38    public $state = null;
39
40    /**
41     * PC/モバイルのセッション管理オブジェクトを切り替える
42     *
43     * @param string $state
44     */
45    public function setState($state = 'pc')
46    {
47        switch ($state) {
48            case 'mobile':
49                $this->state = new LC_UseRequest_State_Mobile;
50                break;
51
52            case 'pc':
53            default:
54                $this->state = new LC_UseRequest_State_PC;
55                break;
56        }
57    }
58
59    /**
60     * Cookieを使用するかどうか
61     *
62     * @return boolean 常にfalseを返す
63     */
64    public function useCookie()
65    {
66        return false;
67    }
68
69    /**
70     * dtb_mobile_ext_session_id テーブルを検索してセッションIDを取得する。
71     * PCサイトでもモバイルサイトでもこのテーブルを利用する.
72     *
73     * @return string|null 取得したセッションIDを返す。
74     *                     取得できなかった場合は null を返す。
75     */
76    public function getExtSessionId()
77    {
78        if (!preg_match('|^' . ROOT_URLPATH . '(.*)$|', $_SERVER['SCRIPT_NAME'], $matches)) {
79            return null;
80        }
81
82        $url = $matches[1];
83        $lifetime = $this->state->getLifeTime();
84        $time = date('Y-m-d H:i:s', time() - $lifetime);
85        $objQuery =& SC_Query_Ex::getSingletonInstance();
86
87        foreach ($_REQUEST as $key => $value) {
88            $session_id = $objQuery->get('session_id', 'dtb_mobile_ext_session_id',
89                                         'param_key = ? AND param_value = ? AND url = ? AND create_date >= ?',
90                                         array($key, $value, $url, $time));
91            if (isset($session_id)) {
92                return $session_id;
93            }
94        }
95
96        return null;
97    }
98
99    /**
100     * 外部サイト連携用にセッションIDとパラメーターの組み合わせを保存する。
101     *
102     * @param  string $param_key   パラメーター名
103     * @param  string $param_value パラメーター値
104     * @param  string $url         URL
105     * @return void
106     */
107    public function setExtSessionId($param_key, $param_value, $url)
108    {
109        $objQuery =& SC_Query_Ex::getSingletonInstance();
110
111        // GC
112        $lifetime = $this->state->getLifeTime();
113        $time = date('Y-m-d H:i:s', time() - $lifetime);
114        $objQuery->delete('dtb_mobile_ext_session_id', 'create_date < ?', array($time));
115
116        $arrValues = array(
117            'session_id'  => session_id(),
118            'param_key'   => $param_key,
119            'param_value' => $param_value,
120            'url'         => $url,
121        );
122
123        $objQuery->insert('dtb_mobile_ext_session_id', $arrValues);
124    }
125
126    /**
127     * セッションデータが有効かどうかをチェックする。
128     *
129     * @return boolean セッションデータが有効な場合は true、無効な場合は false を返す。
130     */
131    public function validateSession()
132    {
133        /**
134         * PCサイトでは
135         *  ・セッションデータが適切に設定されているか
136         *  ・UserAgent
137         *  ・IPアドレス
138         *  ・有効期限
139         * モバイルサイトでは
140         *  ・セッションデータが適切に設定されているか
141         *  ・機種名
142         *  ・IPアドレス
143         *  ・有効期限
144         *  ・phone_id
145         * がチェックされる
146         */
147
148        return $this->state->validateSessionData();
149    }
150
151    /**
152     * パラメーターから有効なセッションIDを取得する。
153     *
154     * @return string|false 取得した有効なセッションIDを返す。
155     *                      取得できなかった場合は false を返す。
156     */
157    public function getSessionId()
158    {
159        // パラメーターからセッションIDを取得する。
160        $sessionId = @$_POST[session_name()];
161        if (!isset($sessionId)) {
162            $sessionId = @$_GET[session_name()];
163            // AU動画音声ファイルダウンロード対策
164            // キャリアがAUで、動画、音声ファイルをダウンロードする際に
165            // SESSIONIDの後に余計なパラメータが付与され、セッションが無効になるケースがある
166            if (SC_MobileUserAgent::getCarrier() == 'ezweb') {
167                $idArray = split("\?", $sessionId);
168                $sessionId = $idArray[0];
169            }
170        }
171        if (!isset($sessionId)) {
172            $sessionId = $this->getExtSessionId();
173        }
174        if (!isset($sessionId)) {
175            return false;
176        }
177
178        // セッションIDの存在をチェックする。
179        if ($this->sfSessRead($sessionId) === null) {
180            GC_Utils_Ex::gfPrintLog("Non-existent session id : sid=$sessionId");
181
182            return false;
183        }
184
185        return session_id($sessionId);
186    }
187
188    /**
189     * セッション初期処理を行う。
190     *
191     * @return void
192     */
193    public function initSession()
194    {
195        parent::initSession();
196
197        // セッションIDの受け渡しにクッキーを使用しない。
198        ini_set('session.use_cookies', '0');
199        ini_set('session.use_trans_sid', '1');
200        ini_set('session.use_only_cookies', '0');
201
202        // パラメーターから有効なセッションIDを取得する。
203        $sessionId = $this->getSessionId();
204
205        if (!$sessionId) {
206            session_start();
207        }
208
209        /*
210         * PHP4 では session.use_trans_sid が PHP_INI_PREDIR なので
211         * ini_set() で設定できない
212         */
213        if (!ini_get('session.use_trans_sid')) {
214            output_add_rewrite_var(session_name(), session_id());
215        }
216
217        // セッションIDまたはセッションデータが無効な場合は、セッションIDを再生成
218        // し、セッションデータを初期化する。
219        if ($sessionId === false || !$this->validateSession()) {
220            session_regenerate_id(true);
221            // セッションデータの初期化
222            $this->state->inisializeSessionData();
223
224            // 新しいセッションIDを付加してリダイレクトする。
225            if ($_SERVER['REQUEST_METHOD'] == 'GET') {
226                // GET の場合は同じページにリダイレクトする。
227                $objMobile = new SC_Helper_Mobile_Ex;
228                header('Location: ' . $objMobile->gfAddSessionId());
229            } else {
230                // GET 以外の場合はトップページへリダイレクトする。
231                header('Location: ' . TOP_URL . '?' . SID);
232            }
233            exit;
234        }
235
236        // 有効期限を更新する.
237        $this->state->updateExpire();
238    }
239}
240/**
241 * セッションデータ管理クラスの基底クラス
242 *
243 */
244class LC_UseRequest_State
245{
246    /** 名前空間(pc/mobile) */
247    public $namespace = '';
248    /** 有効期間 */
249    public $lifetime  = 0;
250    /** エラーチェック関数名の配列 */
251    public $validate  = array();
252
253    /**
254     * 名前空間を取得する
255     *
256     * @return string
257     */
258    public function getNameSpace()
259    { return $this->namespace; }
260
261    /**
262     * 有効期間を取得する
263     *
264     * @return integer
265     */
266    public function getLifeTime()
267    { return $this->lifetime; }
268
269    /**
270     * セッションデータが設定されているかを判定する.
271     * $_SESSION[$namespace]の値が配列の場合に
272     * trueを返す.
273     *
274     * @return boolean
275     */
276    public function validateNameSpace()
277    {
278        $namespace = $this->getNameSpace();
279        if (isset($_SESSION[$namespace]) && is_array($_SESSION[$namespace])) {
280            return true;
281        }
282        GC_Utils_Ex::gfPrintLog("NameSpace $namespace not found in session data : sid=" . session_id());
283
284        return false;
285    }
286
287    /**
288     * セッションのデータを取得する
289     * 取得するデータは$_SESSION[$namespace][$key]となる.
290     *
291     * @param  string     $key
292     * @return mixed|null
293     */
294    public function getValue($key)
295    {
296        $namespace = $this->getNameSpace();
297
298        return isset($_SESSION[$namespace][$key])
299            ? $_SESSION[$namespace][$key]
300            : null;
301    }
302
303    /**
304     * セッションにデータを登録する.
305     * $_SESSION[$namespace][$key] = $valueの形で登録される.
306     *
307     * @param string $key
308     * @param mixed  $value
309     */
310    public function setValue($key, $value)
311    {
312        $namespace = $this->getNameSpace();
313        $_SESSION[$namespace][$key] = $value;
314    }
315
316    /**
317     * 有効期限を取得する.
318     *
319     * @return integer
320     */
321    public function getExpire()
322    {
323        return $this->getValue('expires');
324    }
325
326    /**
327     * 有効期限を設定する.
328     *
329     */
330    public function updateExpire()
331    {
332        $lifetime = $this->getLifeTime();
333        $this->setValue('expires', time() + $lifetime);
334    }
335
336    /**
337     * 有効期限内かどうかを判定する.
338     *
339     * @return boolean
340     */
341    public function validateExpire()
342    {
343        $expire = $this->getExpire();
344        if (intval($expire) > time()) {
345            return true;
346        }
347        $date = date('Y/m/d H:i:s', $expire);
348        GC_Utils_Ex::gfPrintLog("Session expired at $date : sid=" . session_id());
349
350        return false;
351    }
352
353    /**
354     * IPアドレスを取得する.
355     *
356     * @return string
357     */
358    public function getIp()
359    {
360        return $this->getValue('ip');
361    }
362
363    /**
364     * IPアドレスを設定する.
365     *
366     */
367    public function updateIp()
368    {
369        $this->setValue('ip', $_SERVER['REMOTE_ADDR']);
370    }
371
372    /**
373     * REMOTE_ADDRとセッション中のIPが同じかどうかを判定する.
374     * 同じ場合にtrueが返る
375     *
376     * @return boolean
377     */
378    public function validateIp()
379    {
380        $ip = $this->getIp();
381        if (!empty($_SERVER['REMOTE_ADDR']) && $ip === $_SERVER['REMOTE_ADDR']) {
382            return true;
383        }
384
385        $msg = sprintf('Ip Addr mismatch : %s != %s(expected) : sid=%s', $_SERVER['REMOTE_ADDR'], $ip, session_id());
386        GC_Utils_Ex::gfPrintLog($msg);
387
388        return false;
389    }
390
391    /**
392     * UserAgentもしくは携帯の機種名を取得する.
393     *
394     * @return string
395     */
396    public function getModel()
397    {
398        return $this->getValue('model');
399    }
400
401    /**
402     * セッション中のデータ検証する
403     *
404     * @return boolean
405     */
406    public function validateSessionData()
407    {
408        foreach ($this->validate as $method) {
409            $method = 'validate' . $method;
410            if (!$this->$method()) {
411                return false;
412            }
413        }
414
415        return true;
416    }
417
418    /**
419     * セッションデータを初期化する.
420     *
421     */
422    public function inisializeSessionData()
423    {
424    }
425}
426
427/**
428 * PCサイト用のセッションデータ管理クラス
429 *
430 */
431class LC_UseRequest_State_PC extends LC_UseRequest_State
432{
433    /**
434     * コンストラクタ
435     * セッションのデータ構造は下のようになる.
436     * $_SESSION['pc']=> array(
437     *     ['model']   => 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)'
438     *     ['ip']      => '127.0.0.1'
439     *     ['expires'] => 1204699031
440     * )
441     *
442     * @return LC_UseRequest_State_PC
443     */
444    public function LC_UseRequest_State_PC()
445    {
446        $this->namespace = 'pc';
447        $this->lifetime  = SESSION_LIFETIME;
448        $this->validate  = array('NameSpace', 'Model', 'Ip', 'Expire');
449    }
450
451    /**
452     * セッションにUserAgentを設定する.
453     *
454     */
455    public function updateModel()
456    {
457        $this->setValue('model', $_SERVER['HTTP_USER_AGENT']);
458    }
459
460    /**
461     * UserAgentを検証する.
462     *
463     * @return boolean
464     */
465    public function validateModel()
466    {
467        $ua = $this->getModel();
468        if (!empty($_SERVER['HTTP_USER_AGENT']) && $_SERVER['HTTP_USER_AGENT'] === $ua) {
469            return true;
470        }
471        $msg = sprintf('User agent model mismatch : %s != %s(expected), sid=%s',
472                       $_SERVER['HTTP_USER_AGENT'], $ua, session_id());
473        GC_Utils_Ex::gfPrintLog($msg);
474
475        return false;
476    }
477
478    /**
479     * セッションデータを初期化する.
480     *
481     */
482    public function inisializeSessionData()
483    {
484        $_SESSION = array();
485        $this->updateModel();
486        $this->updateIp();
487        $this->updateExpire();
488    }
489}
490
491/**
492 * モバイルサイト用のセッションデータ管理クラス
493 *
494 */
495class LC_UseRequest_State_Mobile extends LC_UseRequest_State
496{
497    /**
498     * コンストラクタ
499     * セッションのデータ構造は下のようになる.
500     * $_SESSION['mobile']=> array(
501     *     ['model']   => 901sh
502     *     ['ip']      => 127.0.0.1
503     *     ['expires'] => 1204699031
504     *     ['phone_id']=> ****
505     * )
506     *
507     * @return LC_UseRequest_State_Mobile
508     */
509    public function LC_UseRequest_State_Mobile()
510    {
511        $this->namespace = 'mobile';
512        $this->lifetime  = MOBILE_SESSION_LIFETIME;
513        $this->validate  = array('NameSpace', 'Model', 'Expire');
514    }
515
516    /**
517     * 携帯の機種名を設定する
518     *
519     */
520    public function updateModel()
521    {
522        $this->setValue('model', SC_MobileUserAgent_Ex::getModel());
523    }
524
525    /**
526     * セッション中の携帯機種名と、アクセスしてきたブラウザの機種名が同じかどうかを判定する
527     *
528     * @return boolean
529     */
530    public function validateModel()
531    {
532        $modelInSession = $this->getModel();
533        $model = SC_MobileUserAgent_Ex::getModel();
534        if (!empty($model) && $model === $modelInSession) {
535            return true;
536        }
537
538        return false;
539    }
540
541    /**
542     * 携帯のIDを取得する
543     *
544     * @return string
545     */
546    public function getPhoneId()
547    {
548        return $this->getValue('phone_id');
549    }
550
551    /**
552     * 携帯のIDを登録する.
553     *
554     */
555    public function updatePhoneId()
556    {
557        $this->setValue('phone_id', SC_MobileUserAgent_Ex::getId());
558    }
559
560    /**
561     * セッションデータを初期化する.
562     *
563     */
564    public function inisializeSessionData()
565    {
566        $_SESSION = array();
567        $this->updateModel();
568        $this->updateIp();
569        $this->updateExpire();
570        $this->updatePhoneId();
571    }
572}
573/*
574 * Local variables:
575 * coding: utf-8
576 * End:
577 */
Note: See TracBrowser for help on using the repository browser.