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

Revision 15384, 8.6 KB checked in by nanasess, 13 years ago (diff)

不要(そう)な関数削除

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