source: branches/camp/camp-2_5-E/data/class/pages/LC_Page.php @ 19331

Revision 19331, 18.2 KB checked in by kim, 12 years ago (diff)

【開発合宿】 mobileProcessをLC_Pageにも追加

  • 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-2010 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// {{{ requires
25require_once(DATA_PATH . 'module/Net/URL.php');
26
27/**
28 * Web Page を制御する基底クラス
29 *
30 * Web Page を制御する Page クラスは必ずこのクラスを継承する.
31 * PHP4 ではこのような抽象クラスを作っても継承先で何でもできてしまうため、
32 * あまり意味がないが、アーキテクトを統一するために作っておく.
33 *
34 * @package Page
35 * @author LOCKON CO.,LTD.
36 * @version $Id:LC_Page.php 15532 2007-08-31 14:39:46Z nanasess $
37 */
38class LC_Page {
39
40    // {{{ properties
41
42    /** メインテンプレート */
43    var $tpl_mainpage;
44
45    /** テンプレートのカラム数 */
46    var $tpl_column_num = 2;
47
48    /** メインナンバー */
49    var $tpl_mainno;
50
51    /** CSS のパス */
52    var $tpl_css;
53
54    /** JavaScript */
55    var $tpl_javascript;
56
57    /** タイトル */
58    var $tpl_title;
59
60    /** カテゴリ */
61    var $tpl_page_category;
62
63    /** ログインメールアドレス */
64    var $tpl_login_email;
65
66    /** body タグの onload 属性 */
67    var $tpl_onload;
68
69    /** 送料合計 */
70    var $tpl_total_deliv_fee;
71
72    /** トランザクションID */
73    var $transactionid;
74
75    /** テンプレート名 */
76    var $template;
77
78    // }}}
79    // {{{ functions
80
81    /**
82     * Page を初期化する.
83     *
84     * @return void
85     */
86    function init() {
87        $this->tpl_authority = $_SESSION['authority'];
88        // XXX すべてのページで宣言するべき
89        $layout = new SC_Helper_PageLayout_Ex();
90        $layout->sfGetPageLayout($this, false);
91
92        $this->template = SITE_FRAME;
93
94        // ディスプレイクラス生成
95        $this->objDisp = new SC_Display();
96
97        // プラグインクラス生成
98        #$this->objPlagin = new SC_Helper_Plugin_Ex();
99        #$this->objPlagin->preProcess($this);
100    }
101
102    /**
103     * Page のプロセス.
104     *
105     * @return void
106     */
107    function process() {}
108
109    /**
110     * Page のプロセス.(モバイル)
111     *
112     * @return void
113     */
114    function mobileProcess() {}
115
116    /**
117     * Page のアクション.
118     *
119     * @return void
120     */
121    function sendResponse() {
122        $this->objDisp->hoge($this);
123        $this->objDisp->response->response();
124    }
125
126    /**
127     * デストラクタ.
128     *
129     * @return void
130     */
131    function destroy() {}
132
133    /**
134     * テンプレート取得
135     *
136     */
137    function getTemplate() {
138        return $this->template;
139    }
140
141    /**
142     * テンプレート設定(ポップアップなどの場合)
143     *
144     */
145    function setTemplate($template) {
146        $this->template = $template;
147    }
148
149    /**
150     * 指定の URL へリダイレクトする.
151     *
152     * リダイレクト先 URL に SITE_URL 及び SSL_URL を含むかチェックし,
153     * LC_Page::getToken() の値を URLパラメータで自動的に付与する.
154     *
155     * @param string $url リダイレクト先 URL
156     * @param boolean $isMobile モバイル用にセッションIDを付与する場合 true
157     * @return void|boolean $url に SITE_URL 及び, SSL_URL を含まない場合 false,
158     *                       正常に遷移可能な場合は, $url の ロケーションヘッダを出力する.
159     * @see Net_URL
160     */
161    function sendRedirect($url, $isMobile = false) {
162
163        if (preg_match("/(" . preg_quote(SITE_URL, '/')
164                          . "|" . preg_quote(SSL_URL, '/') . ")/", $url)) {
165
166            $netURL = new Net_URL($url);
167            if (!empty($_SERVER['QUERY_STRING'])) {
168                $netURL->addRawQueryString($_SERVER['QUERY_STRING']);
169            }
170
171            $session = SC_SessionFactory::getInstance();
172            if ($isMobile || $session->useCookie() == false) {
173                $netURL->addQueryString(session_name(), session_id());
174            }
175
176            $netURL->addQueryString(TRANSACTION_ID_NAME, $this->getToken());
177            header("Location: " . $netURL->getURL());
178            //return true;
179            exit();
180        }
181        return false;
182    }
183
184    // }}}
185    // {{{ protected functions
186
187    /**
188     * トランザクショントークンを生成し, 取得する.
189     *
190     * 悪意のある不正な画面遷移を防止するため, 予測困難な文字列を生成して返す.
191     * 同時に, この文字列をセッションに保存する.
192     *
193     * この関数を使用するためには, 生成した文字列を次画面へ渡すパラメータとして
194     * 出力する必要がある.
195     *
196     * 例)
197     * <input type="hidden" name="transactionid" value="この関数の返り値" />
198     *
199     * 遷移先のページで, LC_Page::isValidToken() の返り値をチェックすることにより,
200     * 画面遷移の妥当性が確認できる.
201     *
202     * @access protected
203     * @return string トランザクショントークンの文字列
204     */
205    function getToken() {
206        if (empty($_SESSION[TRANSACTION_ID_NAME])) {
207            $_SESSION[TRANSACTION_ID_NAME] = $this->createToken();
208        }
209        return $_SESSION[TRANSACTION_ID_NAME];
210    }
211
212    /**
213     * トランザクショントークンの妥当性をチェックする.
214     *
215     * 前画面で生成されたトランザクショントークンの妥当性をチェックする.
216     * この関数を使用するためには, 前画面のページクラスで LC_Page::getToken()
217     * を呼んでおく必要がある.
218     *
219     * @access protected
220     * @return boolean トランザクショントークンが有効な場合 true
221     */
222    function isValidToken() {
223
224        $checkToken = "";
225
226        // $_POST の値を優先する
227        if (isset($_POST[TRANSACTION_ID_NAME])) {
228
229            $checkToken = $_POST[TRANSACTION_ID_NAME];
230        } elseif (isset($_GET[TRANSACTION_ID_NAME])) {
231
232            $checkToken = $_GET[TRANSACTION_ID_NAME];
233        }
234
235        $ret = false;
236        // token の妥当性チェック
237        if ($checkToken === $_SESSION[TRANSACTION_ID_NAME]) {
238
239            $ret = true;
240        }
241
242        unset($_SESSION[TRANSACTION_ID_NAME]);
243        return $ret;
244    }
245
246    /**
247     * $path から URL を取得する.
248     *
249     * 以下の順序で 引数 $path から URL を取得する.
250     * 1. realpath($path) で $path の 絶対パスを取得
251     * 2. $_SERVER['DOCUMENT_ROOT'] と一致する文字列を削除
252     * 3. $useSSL の値に応じて, SITE_URL 又は, SSL_URL を付与する.
253     *
254     * 返り値に, QUERY_STRING を含めたい場合は, key => value 形式
255     * の配列を $param へ渡す.
256     *
257     * @access protected
258     * @param string $path 結果を取得するためのパス
259     * @param array $param URL に付与するパラメータの配列
260     * @param mixed $useSSL 結果に SSL_URL を使用する場合 true,
261     *                         SITE_URL を使用する場合 false,
262     *                         デフォルト "escape" 現在のスキーマを使用
263     * @return string $path の存在する http(s):// から始まる絶対パス
264     * @see Net_URL
265     */
266    function getLocation($path, $param = array(), $useSSL = "escape") {
267        $rootPath = $this->getRootPath($path);
268
269        // スキーマを定義
270        if ($useSSL === true) {
271            $url = SSL_URL . $rootPath;
272        } elseif ($useSSL === false){
273            $url = SITE_URL . $rootPath;
274        } elseif ($useSSL == "escape") {
275            if (SC_Utils_Ex::sfIsHTTPS()) {
276                $url = SSL_URL . $rootPath;
277            } else {
278                $url = SITE_URL . $rootPath;
279            }
280        } else {
281            die("[BUG] Illegal Parametor of \$useSSL ");
282        }
283
284        $netURL = new Net_URL($url);
285        // QUERY_STRING 生成
286        foreach ($param as $key => $val) {
287            $netURL->addQueryString($key, $val);
288        }
289
290        return $netURL->getURL();
291    }
292
293    /**
294     * EC-CUBE のWEBルート(/html/)を / としたパスを返す
295     *
296     * @param string $path 結果を取得するためのパス
297     * @return string EC-CUBE のWEBルート(/html/)を / としたパス
298     */
299    function getRootPath($path) {
300        // Windowsの場合は, ディレクトリの区切り文字を\から/に変換する
301        $path = str_replace('\\', '/', $path);
302        $htmlPath = str_replace('\\', '/', HTML_PATH);
303       
304        // PHP 5.1 対策 ( http://xoops.ec-cube.net/modules/newbb/viewtopic.php?topic_id=4277&forum=9 )
305        if (strlen($path) == 0) {
306            $path = '.';
307        }
308       
309        // $path が / で始まっている場合
310        if (substr($path, 0, 1) == '/') {
311            $realPath = realpath($htmlPath . substr_replace($path, '', 0, strlen(URL_DIR)));
312        // 相対パスの場合
313        } else {
314            $realPath = realpath($path);
315        }
316        $realPath = str_replace('\\', '/', $realPath);
317       
318        // $path が / で終わっている場合、realpath によって削られた末尾の / を復元する。
319        if (substr($path, -1, 1) == '/' && substr($realPath, -1, 1) != '/') {
320            $realPath .= '/';
321        }
322       
323        // HTML_PATH を削除した文字列を取得.
324        $rootPath = str_replace($htmlPath, '', $realPath);
325        $rootPath = ltrim($rootPath, '/');
326
327        return $rootPath;
328    }
329
330    /**
331     * ページをリロードする.
332     *
333     * 引数 $queryString に, $_SERVER['QUERY_STRING'] の値を使用してはならない.
334     * この関数は, 内部で LC_Page::sendRedirect() を使用するため,
335     * $_SERVER['QUERY_STRING'] の値は自動的に付与される.
336     *
337     * @param array $queryString QueryString の配列
338     * @param bool $removeQueryString 付与されていた QueryString を削除する場合 true
339     * @return void
340     * @see Net_URL
341     */
342    function reload($queryString = array(), $removeQueryString = false) {
343
344        // 現在の URL を取得
345        $netURL = new Net_URL($_SERVER['REQUEST_URI']);
346
347        if ($removeQueryString) {
348            $netURL->querystring = array();
349            $_SERVER['QUERY_STRING'] = ''; // sendRedirect() での処理用らしい
350        }
351
352        // QueryString を付与
353        if (!empty($queryString)) {
354            foreach ($queryString as $key => $val) {
355                $netURL->addQueryString($key, $val);
356            }
357        }
358
359        $this->sendRedirect($netURL->getURL());
360    }
361
362    /**
363     * 互換性確保用メソッド
364     *
365     * @access protected
366     * @return void
367     * @deprecated 決済モジュール互換のため
368     */
369    function allowClientCache() {
370        LC_Page::httpCacheControl('private');
371    }
372
373    /**
374     * クライアント・プロキシのキャッシュを制御する.
375     *
376     * @access protected
377     * @param string $mode (nocache/private)
378     * @return void
379     */
380    function httpCacheControl($mode = '') {
381        switch ($mode) {
382            case 'nocache':
383                header('Pragma: no-cache');
384                header('Expires: Thu, 19 Nov 1981 08:52:00 GMT');
385                header('Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0');
386                header('Last-Modified:');
387                break;
388               
389            case 'private':
390                $cache_expire = session_cache_expire() * 60;
391                header('Pragma: no-cache');                                                            // anti-proxy
392                header('Expires:');                                                                    // anti-mozilla
393                header("Cache-Control: private, max-age={$cache_expire}, pre-check={$cache_expire}");  // HTTP/1.1 client
394                header('Last-Modified:');
395                break;
396               
397            default:
398                break;
399        }
400    }
401
402    /**
403     * デバック出力を行う.
404     *
405     * デバック用途のみに使用すること.
406     *
407     * @access protected
408     * @param mixed $val デバックする要素
409     * @return void
410     */
411    function p($val) {
412        SC_Utils_Ex::sfPrintR($val);
413    }
414
415    // }}}
416    // {{{ private functions
417
418    /**
419     * トランザクショントークン用の予測困難な文字列を生成して返す.
420     *
421     * @access private
422     * @return string トランザクショントークン用の文字列
423     */
424    function createToken() {
425        return sha1(uniqid(rand(), true));
426    }
427   
428    /**
429     * HTTPステータスコードを送出する。
430     *
431     * @param integer $code HTTPステータスコード
432     * @return void
433     * @author Seasoft (新規作成)
434     * @see Moony_Action::status() (オリジナル)
435     * @link http://moony.googlecode.com/ (オリジナル)
436     * @author YAMAOKA Hiroyuki (オリジナル)
437     * @copyright 2005-2008 YAMAOKA Hiroyuki (オリジナル)
438     * @license http://opensource.org/licenses/bsd-license.php New BSD License (オリジナル)
439     * @link http://ja.wikipedia.org/wiki/HTTP%E3%82%B9%E3%83%86%E3%83%BC%E3%82%BF%E3%82%B9%E3%82%B3%E3%83%BC%E3%83%89 (邦訳)
440     * @license http://www.gnu.org/licenses/fdl.html GFDL (邦訳)
441     */
442    function sendHttpStatus($code) {
443        $protocol = $_SERVER['SERVER_PROTOCOL'];
444        $httpVersion = (strpos($protocol, '1.1') !== false) ? '1.1' : '1.0';
445        $messages = array(
446            // Informational 1xx                        // 【情報】
447            100 => 'Continue',                          // 継続
448            101 => 'Switching Protocols',               // プロトコル切替え
449            // Success 2xx                              // 【成功】
450            200 => 'OK',                                // OK
451            201 => 'Created',                           // 作成
452            202 => 'Accepted',                          // 受理
453            203 => 'Non-Authoritative Information',     // 信頼できない情報
454            204 => 'No Content',                        // 内容なし
455            205 => 'Reset Content',                     // 内容のリセット
456            206 => 'Partial Content',                   // 部分的内容
457            // Redirection 3xx                          // 【リダイレクション】
458            300 => 'Multiple Choices',                  // 複数の選択
459            301 => 'Moved Permanently',                 // 恒久的に移動した
460            302 => 'Found',  // 1.1                     // 発見した (リクエストしたリソースは一時的に移動されているときに返される)
461            303 => 'See Other',                         // 他を参照せよ
462            304 => 'Not Modified',                      // 未更新
463            305 => 'Use Proxy',                         // プロキシを使用せよ
464            // 306 is no longer used but still reserved // 将来のために予約されている
465            307 => 'Temporary Redirect',                // 一時的リダイレクト
466            // Client Error 4xx                         // 【クライアントエラー】
467            400 => 'Bad Request',                       // リクエストが不正である
468            401 => 'Unauthorized',                      // 認証が必要である
469            402 => 'Payment Required',                  // 支払いが必要である
470            403 => 'Forbidden',                         // 禁止されている
471            404 => 'Not Found',                         // 未検出
472            405 => 'Method Not Allowed',                // 許可されていないメソッド
473            406 => 'Not Acceptable',                    // 受理できない
474            407 => 'Proxy Authentication Required',     // プロキシ認証が必要である
475            408 => 'Request Timeout',                   // リクエストタイムアウト
476            409 => 'Conflict',                          // 矛盾
477            410 => 'Gone',                              // 消滅した
478            411 => 'Length Required',                   // 長さが必要
479            412 => 'Precondition Failed',               // 前提条件で失敗した
480            413 => 'Request Entity Too Large',          // リクエストエンティティが大きすぎる
481            414 => 'Request-URI Too Long',              // リクエストURIが大きすぎる
482            415 => 'Unsupported Media Type',            // サポートしていないメディアタイプ
483            416 => 'Requested Range Not Satisfiable',   // リクエストしたレンジは範囲外にある
484            417 => 'Expectation Failed',                // 期待するヘッダに失敗
485            // Server Error 5xx                         // 【サーバエラー】
486            500 => 'Internal Server Error',             // サーバ内部エラー
487            501 => 'Not Implemented',                   // 実装されていない
488            502 => 'Bad Gateway',                       // 不正なゲートウェイ
489            503 => 'Service Unavailable',               // サービス利用不可
490            504 => 'Gateway Timeout',                   // ゲートウェイタイムアウト
491            505 => 'HTTP Version Not Supported',        // サポートしていないHTTPバージョン
492            509 => 'Bandwidth Limit Exceeded'           // 帯域幅制限超過
493        );
494        if (isset($messages[$code])) {
495            if ($httpVersion !== '1.1') {
496                // HTTP/1.0
497                $messages[302] = 'Moved Temporarily';
498            }
499            header("HTTP/{$httpVersion} {$code} {$messages[$code]}");
500            header("Status: {$code} {$messages[$code]}", true, $code);
501        }
502    }
503}
504?>
Note: See TracBrowser for help on using the repository browser.