source: branches/comu-ver2/data/class/pages/LC_Page.php @ 17095

Revision 17095, 10.1 KB checked in by pineray, 14 years ago (diff)

Chgset17037,17040-17046のマージ

  • 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-2007 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    // {{{ functions
77
78    /**
79     * Page を初期化する.
80     *
81     * @return void
82     */
83    function init() {}
84
85    /**
86     * Page のプロセス.
87     *
88     * @return void
89     */
90    function process() {}
91
92    /**
93     * デストラクタ.
94     *
95     * @return void
96     */
97    function destroy() {}
98
99    /**
100     * 指定の URL へリダイレクトする.
101     *
102     * リダイレクト先 URL に SITE_URL 及び SSL_URL を含むかチェックし,
103     * LC_Page::getToken() の値を URLパラメータで自動的に付与する.
104     *
105     * @param string $url リダイレクト先 URL
106     * @param boolean $isMobile モバイル用にセッションIDを付与する場合 true
107     * @return void|boolean $url に SITE_URL 及び, SSL_URL を含まない場合 false,
108     *                       正常に遷移可能な場合は, $url の URL へ遷移する.
109     * @see Net_URL
110     */
111    function sendRedirect($url, $isMobile = false) {
112
113        if (preg_match("/(" . preg_quote(SITE_URL, '/')
114                          . "|" . preg_quote(SSL_URL, '/') . ")/", $url)) {
115
116            $netURL = new Net_URL($url);
117            if (!empty($_SERVER['QUERY_STRING'])) {
118                $netURL->addRawQueryString($_SERVER['QUERY_STRING']);
119            }
120            if ($isMobile) {
121                $netURL->addQueryString(session_name(), session_id());
122            }
123            $netURL->addQueryString(TRANSACTION_ID_NAME, $this->getToken());
124            header("Location: " . $netURL->getURL());
125        }
126        return false;
127    }
128
129    // }}}
130    // {{{ protected functions
131
132    /**
133     * トランザクショントークンを生成し, 取得する.
134     *
135     * 悪意のある不正な画面遷移を防止するため, 予測困難な文字列を生成して返す.
136     * 同時に, この文字列をセッションに保存する.
137     *
138     * この関数を使用するためには, 生成した文字列を次画面へ渡すパラメータとして
139     * 出力する必要がある.
140     *
141     * 例)
142     * <input type="hidden" name="transactionid" value="この関数の返り値" />
143     *
144     * 遷移先のページで, LC_Page::isValidToken() の返り値をチェックすることにより,
145     * 画面遷移の妥当性が確認できる.
146     *
147     * @access protected
148     * @return string トランザクショントークンの文字列
149     */
150    function getToken() {
151        if (empty($_SESSION[TRANSACTION_ID_NAME])) {
152            $_SESSION[TRANSACTION_ID_NAME] = $this->createToken();
153        }
154        return $_SESSION[TRANSACTION_ID_NAME];
155    }
156
157    /**
158     * トランザクショントークンの妥当性をチェックする.
159     *
160     * 前画面で生成されたトランザクショントークンの妥当性をチェックする.
161     * この関数を使用するためには, 前画面のページクラスで LC_Page::getToken()
162     * を呼んでおく必要がある.
163     *
164     * @access protected
165     * @return boolean トランザクショントークンが有効な場合 true
166     */
167    function isValidToken() {
168
169        $checkToken = "";
170
171        // $_POST の値を優先する
172        if (isset($_POST[TRANSACTION_ID_NAME])) {
173
174            $checkToken = $_POST[TRANSACTION_ID_NAME];
175        } elseif (isset($_GET[TRANSACTION_ID_NAME])) {
176
177            $checkToken = $_GET[TRANSACTION_ID_NAME];
178        }
179
180        $ret = false;
181        // token の妥当性チェック
182        if ($checkToken === $_SESSION[TRANSACTION_ID_NAME]) {
183
184            $ret = true;
185        }
186
187        unset($_SESSION[TRANSACTION_ID_NAME]);
188        return $ret;
189    }
190
191    /**
192     * $path から URL を取得する.
193     *
194     * 以下の順序で 引数 $path から URL を取得する.
195     * 1. realpath($path) で $path の 絶対パスを取得
196     * 2. $_SERVER['DOCUMENT_ROOT'] と一致する文字列を削除
197     * 3. $useSSL の値に応じて, SITE_URL 又は, SSL_URL を付与する.
198     *
199     * 返り値に, QUERY_STRING を含めたい場合は, key => value 形式
200     * の配列を $param へ渡す.
201     *
202     * @access protected
203     * @param string $path 結果を取得するためのパス
204     * @param array $param URL に付与するパラメータの配列
205     * @param mixed $useSSL 結果に SSL_URL を使用する場合 true,
206     *                         SITE_URL を使用する場合 false,
207     *                         デフォルト "escape" 現在のスキーマを使用
208     * @return string $path の存在する http(s):// から始まる絶対パス
209     * @see Net_URL
210     */
211    function getLocation($path, $param = array(), $useSSL = "escape") {
212
213        // $path が / で始まっている場合
214        if (substr($path, 0, 1) == "/") {
215            $realPath = realpath(HTML_PATH . substr_replace($path, "", 0, strlen(URL_DIR)));
216        // 相対パスの場合
217        } else {
218            $realPath = realpath($path);
219        }
220
221        // FIXME OS依存の処理は別クラスに分ける?
222        // Windowsの場合は, ディレクトリの区切り文字を\から/に変換する
223        if (substr(PHP_OS, 0, 3) == 'WIN') {
224            $realPath = str_replace("\\", "/", $realPath);
225            $htmlPath = str_replace("\\", "/", HTML_PATH);
226            $rootPath = str_replace($htmlPath, "", $realPath);
227        } else {
228            // HTML_PATH を削除した文字列を取得.
229            $rootPath = str_replace(HTML_PATH, "", $realPath);
230        }
231
232
233        // スキーマを定義
234        if ($useSSL === true) {
235            $url = SSL_URL . $rootPath;
236        } elseif ($useSSL === false){
237            $url = SITE_URL . $rootPath;
238        } elseif ($useSSL == "escape") {
239            if (SC_Utils_Ex::sfIsHTTPS()) {
240                $url = SSL_URL . $rootPath;
241            } else {
242                $url = SITE_URL . $rootPath;
243            }
244        } else {
245            die("[BUG] Illegal Parametor of \$useSSL ");
246        }
247
248        $netURL = new Net_URL($url);
249        // QUERY_STRING 生成
250        foreach ($param as $key => $val) {
251            $netURL->addQueryString($key, $val);
252        }
253
254        return $netURL->getURL();
255    }
256
257    /**
258     * ページをリロードする.
259     *
260     * 引数 $queryString に, $_SERVER['QUERY_STRING'] の値を使用してはならない.
261     * この関数は, 内部で LC_Page::sendRedirect() を使用するため,
262     * $_SERVER['QUERY_STRING'] の値は自動的に付与される.
263     *
264     * @param array $queryString QueryString の配列
265     * @param bool $removeQueryString 付与されていた QueryString を削除する場合 true
266     * @return void
267     * @see Net_URL
268     */
269    function reload($queryString = array(), $removeQueryString = false) {
270
271        // 現在の URL を取得
272        $netURL = new Net_URL();
273
274        if ($removeQueryString) {
275            $netURL->querystring = array();
276            $_SERVER['QUERY_STRING'] = '';
277        }
278
279        // QueryString を付与
280        if (!empty($queryString)) {
281            foreach ($queryString as $key => $val) {
282                $netURL->addQueryString($key, $val);
283            }
284        }
285
286        $this->sendRedirect($netURL->getURL());
287    }
288
289    /**
290     * クライアントのキャッシュを許可する.
291     *
292     * session_start時のno-cacheヘッダーを抑制することで
293     * 「戻る」ボタン使用時の有効期限切れ表示を抑制する.
294     *
295     * @access protected
296     * @return void
297     */
298    function allowClientCache() {
299        session_cache_limiter('private-no-expire');
300    }
301
302    /**
303     * デバック出力を行う.
304     *
305     * デバック用途のみに使用すること.
306     *
307     * @access protected
308     * @param mixed $val デバックする要素
309     * @return void
310     */
311    function p($val) {
312        SC_Utils_Ex::sfPrintR($val);
313    }
314
315    // }}}
316    // {{{ private functions
317
318    /**
319     * トランザクショントークン用の予測困難な文字列を生成して返す.
320     *
321     * @access private
322     * @return string トランザクショントークン用の文字列
323     */
324    function createToken() {
325        return sha1(uniqid(rand(), true));
326    }
327}
328?>
Note: See TracBrowser for help on using the repository browser.