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

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