source: branches/feature-module-update/data/class/pages/LC_Page.php @ 15383

Revision 15383, 8.8 KB checked in by nanasess, 13 years ago (diff)

getLocation() 関数で, $useSSL が escape(デフォルト値) の場合は, 現在のスキーマを適用するように修正

  • Property svn:keywords set to Id
  • Property svn:mime-type set to application/x-httpd-php; charset=UTF-8
Line 
1<?php
2/*
3 * Copyright(c) 2000-2007 LOCKON CO.,LTD. All Rights Reserved.
4 *
5 * http://www.lockon.co.jp/
6 */
7
8// {{{ requires
9require_once(DATA_PATH . 'module/Net/URL.php');
10
11/**
12 * Web Page を制御する基底クラス
13 *
14 * Web Page を制御する Page クラスは必ずこのクラスを継承する.
15 * PHP4 ではこのような抽象クラスを作っても継承先で何でもできてしまうため、
16 * あまり意味がないが、アーキテクトを統一するために作っておく.
17 *
18 * @package Page
19 * @author LOCKON CO.,LTD.
20 * @version $Id$
21 */
22class LC_Page {
23
24    // {{{ properties
25
26    /** メインテンプレート */
27    var $tpl_mainpage;
28
29    /** メインナンバー */
30    var $tpl_mainno;
31
32    /** CSS のパス */
33    var $tpl_css;
34
35    /** JavaScript */
36    var $tpl_javascript;
37
38    /** タイトル */
39    var $tpl_title;
40
41    /** カテゴリ */
42    var $tpl_page_category;
43
44    /** ログインメールアドレス */
45    var $tpl_login_email;
46
47    /** body タグの onload 属性 */
48    var $tpl_onload;
49
50    /** 送料合計 */
51    var $tpl_total_deliv_fee;
52
53    /** トランザクションID */
54    var $transactionid;
55
56    // }}}
57    // {{{ functions
58
59    /**
60     * Page を初期化する.
61     *
62     * @return void
63     */
64    function init() {}
65
66    /**
67     * Page のプロセス.
68     *
69     * @return void
70     */
71    function process() {}
72
73    /**
74     * デストラクタ.
75     *
76     * @return void
77     */
78    function destroy() {}
79
80    /**
81     * 遷移元が自サイトかどうかチェックする.
82     *
83     * 遷移元が自サイト以外の場合はエラーページへ遷移する.
84     *
85     * @return void
86     */
87    function checkPreviousURI() {
88        // TODO 必要性検討
89    }
90
91    /**
92     * 指定の URL へリダイレクトする.
93     *
94     * リダイレクト先 URL に SITE_URL 及び SSL_URL を含むかチェックし,
95     * LC_Page::getToken() の値を URLパラメータで自動的に付与する.
96     *
97     * @param string $url リダイレクト先 URL
98     * @return void|boolean $url に SITE_URL 及び, SSL_URL を含まない場合 false,
99     *                       正常に遷移可能な場合は, $url の URL へ遷移する.
100     * @see Net_URL
101     */
102    function sendRedirect($url) {
103
104        if (preg_match("/(" . preg_quote(SITE_URL, '/')
105                          . "|" . preg_quote(SSL_URL, '/') . ")/", $url)) {
106
107            $netURL = new Net_URL($url);
108            if (!empty($_SERVER['QUERY_STRING'])) {
109                $netURL->addRawQueryString($_SERVER['QUERY_STRING']);
110            }
111            $netURL->addQueryString(TRANSACTION_ID_NAME, $this->getToken());
112            header("Location: " . $netURL->getURL());
113        }
114        return false;
115    }
116
117    // }}}
118    // {{{ protected functions
119
120    /**
121     * トランザクショントークンを生成し, 取得する.
122     *
123     * 悪意のある不正な画面遷移を防止するため, 予測困難な文字列を生成して返す.
124     * 同時に, この文字列をセッションに保存する.
125     *
126     * この関数を使用するためには, 生成した文字列を次画面へ渡すパラメータとして
127     * 出力する必要がある.
128     *
129     * 例)
130     * <input type="hidden" name="transactionid" value="この関数の返り値" />
131     *
132     * 遷移先のページで, LC_Page::isValidToken() の返り値をチェックすることにより,
133     * 画面遷移の妥当性が確認できる.
134     *
135     * @access protected
136     * @return string トランザクショントークンの文字列
137     */
138    function getToken() {
139        if (empty($_SESSION[TRANSACTION_ID_NAME])) {
140            $_SESSION[TRANSACTION_ID_NAME] = $this->createToken();
141        }
142        return $_SESSION[TRANSACTION_ID_NAME];
143    }
144
145    /**
146     * トランザクショントークンの妥当性をチェックする.
147     *
148     * 前画面で生成されたトランザクショントークンの妥当性をチェックする.
149     * この関数を使用するためには, 前画面のページクラスで LC_Page::getToken()
150     * を呼んでおく必要がある.
151     *
152     * @access protected
153     * @return boolean トランザクショントークンが有効な場合 true
154     */
155    function isValidToken() {
156
157        $checkToken = "";
158
159        // $_POST の値を優先する
160        if (isset($_POST[TRANSACTION_ID_NAME])) {
161
162            $checkToken = $_POST[TRANSACTION_ID_NAME];
163        } elseif (isset($_GET[TRANSACTION_ID_NAME])) {
164
165            $checkToken = $_GET[TRANSACTION_ID_NAME];
166        }
167
168        $ret = false;
169        // token の妥当性チェック
170        if ($checkToken === $_SESSION[TRANSACTION_ID_NAME]) {
171
172            $ret = true;
173        }
174
175        unset($_SESSION[TRANSACTION_ID_NAME]);
176        return $ret;
177    }
178
179    /**
180     * $path から URL を取得する.
181     *
182     * 以下の順序で 引数 $path から URL を取得する.
183     * 1. realpath($path) で $path の 絶対パスを取得
184     * 2. $_SERVER['DOCUMENT_ROOT'] と一致する文字列を削除
185     * 3. $useSSL の値に応じて, SITE_URL 又は, SSL_URL を付与する.
186     *
187     * 返り値に, QUERY_STRING を含めたい場合は, key => value 形式
188     * の配列を $param へ渡す.
189     *
190     * @access protected
191     * @param string $path 結果を取得するためのパス
192     * @param array $param URL に付与するパラメータの配列
193     * @param mixed $useSSL 結果に SSL_URL を使用する場合 true,
194     *                         SITE_URL を使用する場合 false,
195     *                         デフォルト "escape" 現在のスキーマを使用
196     * @param string $documentRoot DocumentRoot の文字列. 指定しない場合は,
197     *                              $_SERVER['DOCUMENT_ROOT'] が付与される.
198     * @return string $path の存在する http(s):// から始まる絶対パス
199     * @see Net_URL
200     */
201    function getLocation($path, $param = array(), $useSSL = "escape", $documentRoot = "") {
202
203        // TODO $_SERVER['DOCUMENT_ROOT'] をインストーラでチェックする.
204        if (empty($documentRoot)) {
205            $documentRoot = $_SERVER['DOCUMENT_ROOT'];
206
207            if (empty($documentRoot)) {
208                die("[BUG] can't get DOCUMENT_ROOT");
209            }
210        }
211
212        // $path が / で始まっている場合
213        if (substr($path, 0, 1) == "/") {
214            $realPath = realpath(HTML_PATH . substr_replace($path, "", 0, 1));
215        } else {
216            // 相対パスの場合
217            $realPath = realpath($path);
218        }
219
220        // DocumentRoot を削除した文字列を取得.
221        $root = str_replace($documentRoot, "", $realPath);
222        // 先頭の / を削除
223        $root = substr_replace($root, "", 0, 1);
224
225        // スキーマを定義
226        if ($useSSL === true) {
227            $url = SSL_URL . $root;
228        } elseif ($useSSL === false){
229            $url = SITE_URL . $root;
230        } elseif ($useSSL == "escape") {
231            if (SC_Utils_Ex::sfIsHTTPS()) {
232                $url = SSL_URL . $root;
233            } else {
234                $url = SITE_URL . $root;
235            }
236        } else {
237            die("[BUG] Illegal Parametor of \$useSSL ");
238        }
239
240        $netURL = new Net_URL($url);
241        // QUERY_STRING 生成
242        foreach ($param as $key => $val) {
243            $netURL->addQueryString($key, $val);
244        }
245
246        return $netURL->getURL();
247    }
248
249    /**
250     * ページをリロードする.
251     *
252     * 引数 $queryString に, $_SERVER['QUERY_STRING'] の値を使用してはならない.
253     * この関数は, 内部で LC_Page::sendRedirect() を使用するため,
254     * $_SERVER['QUERY_STRING'] の値は自動的に付与される.
255     *
256     * @param array $queryString QueryString の配列
257     * @return void
258     * @see Net_URL
259     */
260    function reload($queryString = array()) {
261
262        // 現在の URL を取得
263        $netURL = new Net_URL();
264
265        // QueryString を付与
266        if (!empty($queryString)) {
267            foreach ($queryString as $key => $val) {
268                $netURL->addQueryString($key, $val);
269            }
270        }
271        $this->sendRedirect($netURL->getURL());
272    }
273
274    /**
275     * クライアントのキャッシュを許可する.
276     *
277     * session_start時のno-cacheヘッダーを抑制することで
278     * 「戻る」ボタン使用時の有効期限切れ表示を抑制する.
279     *
280     * @access protected
281     * @return void
282     */
283    function allowClientCache() {
284        session_cache_limiter('private-no-expire');
285    }
286
287    // }}}
288    // {{{ private functions
289
290    /**
291     * トランザクショントークン用の予測困難な文字列を生成して返す.
292     *
293     * @access private
294     * @return string トランザクショントークン用の文字列
295     */
296    function createToken() {
297        return sha1(uniqid(rand(), true));
298    }
299}
300?>
Note: See TracBrowser for help on using the repository browser.