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

Revision 16133, 9.9 KB checked in by nanasess, 15 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 * 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:LC_Page.php 15532 2007-08-31 14:39:46Z nanasess $
21 */
22class LC_Page {
23
24    // {{{ properties
25
26    /** メインテンプレート */
27    var $tpl_mainpage;
28
29    /** テンプレートのカラム数 */
30    var $tpl_column_num = 2;
31
32    /** メインナンバー */
33    var $tpl_mainno;
34
35    /** CSS のパス */
36    var $tpl_css;
37
38    /** JavaScript */
39    var $tpl_javascript;
40
41    /** タイトル */
42    var $tpl_title;
43
44    /** カテゴリ */
45    var $tpl_page_category;
46
47    /** ログインメールアドレス */
48    var $tpl_login_email;
49
50    /** body タグの onload 属性 */
51    var $tpl_onload;
52
53    /** 送料合計 */
54    var $tpl_total_deliv_fee;
55
56    /** トランザクションID */
57    var $transactionid;
58
59    // }}}
60    // {{{ functions
61
62    /**
63     * Page を初期化する.
64     *
65     * @return void
66     */
67    function init() {
68
69        // 携帯端末の場合は mobile 以下へリダイレクトする。
70        if (GC_MobileUserAgent::isMobile()) {
71            if (preg_match('|^' . URL_DIR . '(.*)$|', $_SERVER['REQUEST_URI'], $matches)) {
72                $path = $matches[1];
73            } else {
74                $path = '';
75            }
76            $this->sendRedirect($this->getLocation(URL_DIR . "mobile/" . $path));
77            exit;
78        }
79        // 絵文字変換 (除去) フィルターを組み込む。
80        ob_start(array('GC_MobileEmoji', 'handler'));
81
82        // アップデートで取得したPHPを読み出す
83        SC_Utils_Ex::sfLoadUpdateModule();
84    }
85
86    /**
87     * Page のプロセス.
88     *
89     * @return void
90     */
91    function process() {}
92
93    /**
94     * デストラクタ.
95     *
96     * @return void
97     */
98    function destroy() {}
99
100    /**
101     * 指定の URL へリダイレクトする.
102     *
103     * リダイレクト先 URL に SITE_URL 及び SSL_URL を含むかチェックし,
104     * LC_Page::getToken() の値を URLパラメータで自動的に付与する.
105     *
106     * @param string $url リダイレクト先 URL
107     * @return void|boolean $url に SITE_URL 及び, SSL_URL を含まない場合 false,
108     *                       正常に遷移可能な場合は, $url の URL へ遷移する.
109     * @see Net_URL
110     */
111    function sendRedirect($url) {
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            $netURL->addQueryString(TRANSACTION_ID_NAME, $this->getToken());
121            header("Location: " . $netURL->getURL());
122        }
123        return false;
124    }
125
126    // }}}
127    // {{{ protected functions
128
129    /**
130     * トランザクショントークンを生成し, 取得する.
131     *
132     * 悪意のある不正な画面遷移を防止するため, 予測困難な文字列を生成して返す.
133     * 同時に, この文字列をセッションに保存する.
134     *
135     * この関数を使用するためには, 生成した文字列を次画面へ渡すパラメータとして
136     * 出力する必要がある.
137     *
138     * 例)
139     * <input type="hidden" name="transactionid" value="この関数の返り値" />
140     *
141     * 遷移先のページで, LC_Page::isValidToken() の返り値をチェックすることにより,
142     * 画面遷移の妥当性が確認できる.
143     *
144     * @access protected
145     * @return string トランザクショントークンの文字列
146     */
147    function getToken() {
148        if (empty($_SESSION[TRANSACTION_ID_NAME])) {
149            $_SESSION[TRANSACTION_ID_NAME] = $this->createToken();
150        }
151        return $_SESSION[TRANSACTION_ID_NAME];
152    }
153
154    /**
155     * トランザクショントークンの妥当性をチェックする.
156     *
157     * 前画面で生成されたトランザクショントークンの妥当性をチェックする.
158     * この関数を使用するためには, 前画面のページクラスで LC_Page::getToken()
159     * を呼んでおく必要がある.
160     *
161     * @access protected
162     * @return boolean トランザクショントークンが有効な場合 true
163     */
164    function isValidToken() {
165
166        $checkToken = "";
167
168        // $_POST の値を優先する
169        if (isset($_POST[TRANSACTION_ID_NAME])) {
170
171            $checkToken = $_POST[TRANSACTION_ID_NAME];
172        } elseif (isset($_GET[TRANSACTION_ID_NAME])) {
173
174            $checkToken = $_GET[TRANSACTION_ID_NAME];
175        }
176
177        $ret = false;
178        // token の妥当性チェック
179        if ($checkToken === $_SESSION[TRANSACTION_ID_NAME]) {
180
181            $ret = true;
182        }
183
184        unset($_SESSION[TRANSACTION_ID_NAME]);
185        return $ret;
186    }
187
188    /**
189     * $path から URL を取得する.
190     *
191     * 以下の順序で 引数 $path から URL を取得する.
192     * 1. realpath($path) で $path の 絶対パスを取得
193     * 2. $_SERVER['DOCUMENT_ROOT'] と一致する文字列を削除
194     * 3. $useSSL の値に応じて, SITE_URL 又は, SSL_URL を付与する.
195     *
196     * 返り値に, QUERY_STRING を含めたい場合は, key => value 形式
197     * の配列を $param へ渡す.
198     *
199     * @access protected
200     * @param string $path 結果を取得するためのパス
201     * @param array $param URL に付与するパラメータの配列
202     * @param mixed $useSSL 結果に SSL_URL を使用する場合 true,
203     *                         SITE_URL を使用する場合 false,
204     *                         デフォルト "escape" 現在のスキーマを使用
205     * @param string $documentRoot DocumentRoot の文字列. 指定しない場合は,
206     *                              $_SERVER['DOCUMENT_ROOT'] が付与される.
207     * @return string $path の存在する http(s):// から始まる絶対パス
208     * @see Net_URL
209     */
210    function getLocation($path, $param = array(), $useSSL = "escape", $documentRoot = "") {
211
212        // TODO $_SERVER['DOCUMENT_ROOT'] をインストーラでチェックする.
213        if (empty($documentRoot)) {
214            $documentRoot = $_SERVER['DOCUMENT_ROOT'];
215
216            if (empty($documentRoot)) {
217                die("[BUG] can't get DOCUMENT_ROOT");
218            }
219        }
220
221        // $path が / で始まっている場合
222        if (substr($path, 0, 1) == "/") {
223            $realPath = realpath(HTML_PATH . substr_replace($path, "", 0, 1));
224        } else {
225            // 相対パスの場合
226            $realPath = realpath($path);
227        }
228
229        // FIXME OS依存の処理は別クラスに分ける?
230        // Windowsの場合は, ディレクトリの区切り文字を\から/に変換する
231        if (substr(PHP_OS, 0, 3) == 'WIN') {
232            $realPath = str_replace("\\", "/", $realPath);
233        }
234
235        // DocumentRoot を削除した文字列を取得.
236        $root = str_replace($documentRoot, "", $realPath);
237        // 先頭の / を削除
238        $root = substr_replace($root, "", 0, 1);
239
240        // スキーマを定義
241        if ($useSSL === true) {
242            $url = SSL_URL . $root;
243        } elseif ($useSSL === false){
244            $url = SITE_URL . $root;
245        } elseif ($useSSL == "escape") {
246            if (SC_Utils_Ex::sfIsHTTPS()) {
247                $url = SSL_URL . $root;
248            } else {
249                $url = SITE_URL . $root;
250            }
251        } else {
252            die("[BUG] Illegal Parametor of \$useSSL ");
253        }
254
255        $netURL = new Net_URL($url);
256        // QUERY_STRING 生成
257        foreach ($param as $key => $val) {
258            $netURL->addQueryString($key, $val);
259        }
260
261        return $netURL->getURL();
262    }
263
264    /**
265     * ページをリロードする.
266     *
267     * 引数 $queryString に, $_SERVER['QUERY_STRING'] の値を使用してはならない.
268     * この関数は, 内部で LC_Page::sendRedirect() を使用するため,
269     * $_SERVER['QUERY_STRING'] の値は自動的に付与される.
270     *
271     * @param array $queryString QueryString の配列
272     * @return void
273     * @see Net_URL
274     */
275    function reload($queryString = array()) {
276
277        // 現在の URL を取得
278        $netURL = new Net_URL();
279
280        // QueryString を付与
281        if (!empty($queryString)) {
282            foreach ($queryString as $key => $val) {
283                $netURL->addQueryString($key, $val);
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.