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

Revision 15301, 8.3 KB checked in by nanasess, 13 years ago (diff)

URL を扱う関数で Net_URL を使うように修正

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