source: tags/eccube-2.1.2/data/class/pages/LC_Page.php @ 17255

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