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

Revision 15210, 6.9 KB checked in by nanasess, 17 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/**
9 * Web Page を制御する基底クラス
10 *
11 * Web Page を制御する Page クラスは必ずこのクラスを継承する.
12 * PHP4 ではこのような抽象クラスを作っても継承先で何でもできてしまうため、
13 * あまり意味がないが、アーキテクトを統一するために作っておく.
14 *
15 * @package Page
16 * @author LOCKON CO.,LTD.
17 * @version $Id$
18 */
19class LC_Page {
20
21    // {{{ properties
22
23    /** メインテンプレート */
24    var $tpl_mainpage;
25
26    /** メインナンバー */
27    var $tpl_mainno;
28
29    /** CSS のパス */
30    var $tpl_css;
31
32    /** タイトル */
33    var $tpl_title;
34
35    /** カテゴリ */
36    var $tpl_page_category;
37
38    /** ログインメールアドレス */
39    var $tpl_login_email;
40
41    /** body タグの onload 属性 */
42    var $tpl_onload;
43
44    /** トランザクションID */
45    var $transactionid;
46
47    // }}}
48    // {{{ functions
49
50    /**
51     * Page を初期化する.
52     *
53     * @return void
54     */
55    function init() {}
56
57    /**
58     * Page のプロセス.
59     *
60     * @return void
61     */
62    function process() {}
63
64    /**
65     * デストラクタ.
66     *
67     * @return void
68     */
69    function destroy() {}
70
71    /**
72     * 遷移元が自サイトかどうかチェックする.
73     *
74     * 遷移元が自サイト以外の場合はエラーページへ遷移する.
75     *
76     * @return void
77     */
78    function checkPreviousURI() {
79        // TODO 必要性検討
80    }
81
82    /**
83     * 指定の URL へリダイレクトする.
84     *
85     * リダイレクト先 URL に SITE_URL 及び SSL_URL を含むかチェックし,
86     * LC_Page::getToken() の値を URLパラメータで自動的に付与する.
87     *
88     * @param string $url リダイレクト先 URL
89     * @return void|boolean $url に SITE_URL 及び, SSL_URL を含まない場合 false,
90     *                       正常に遷移可能な場合は, $url の URL へ遷移する.
91     */
92    function sendRedirect($url) {
93
94        if (preg_match("/(" . preg_quote(SITE_URL, '/')
95                          . "|" . preg_quote(SSL_URL, '/') . ")/", $url)) {
96
97            $suffix = "?";
98            if (!empty($_SERVER['QUERY_STRING'])) {
99                $suffix = "&";
100            }
101            header("Location: " . $url . $suffix . TRANSACTION_ID_NAME . "=" . $this->getToken());
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     * @return string トランザクショントークンの文字列
125     */
126    function getToken() {
127        if (empty($_SESSION[TRANSACTION_ID_NAME])) {
128            $_SESSION[TRANSACTION_ID_NAME] = $this->createToken();
129        }
130        return $_SESSION[TRANSACTION_ID_NAME];
131    }
132
133    /**
134     * トランザクショントークンの妥当性をチェックする.
135     *
136     * 前画面で生成されたトランザクショントークンの妥当性をチェックする.
137     * この関数を使用するためには, 前画面のページクラスで LC_Page::getToken()
138     * を呼んでおく必要がある.
139     *
140     * @return boolean トランザクショントークンが有効な場合 true
141     */
142    function isValidToken() {
143
144        $checkToken = "";
145
146        // $_POST の値を優先する
147        if (isset($_POST[TRANSACTION_ID_NAME])) {
148
149            $checkToken = $_POST[TRANSACTION_ID_NAME];
150        } elseif (isset($_GET[TRANSACTION_ID_NAME])) {
151
152            $checkToken = $_GET[TRANSACTION_ID_NAME];
153        }
154
155        $ret = false;
156        // token の妥当性チェック
157        if ($checkToken === $_SESSION[TRANSACTION_ID_NAME]) {
158
159            $ret = true;
160        }
161
162        unset($_SESSION[TRANSACTION_ID_NAME]);
163        return $ret;
164    }
165
166    /**
167     * $path から URL を取得する.
168     *
169     * 以下の順序で 引数 $path から URL を取得する.
170     * 1. realpath($path) で $path の 絶対パスを取得
171     * 2. $_SERVER['DOCUMENT_ROOT'] と一致する文字列を削除
172     * 3. $useSSL の値に応じて, SITE_URL 又は, SSL_URL を付与する.
173     *
174     * 返り値に, QUERY_STRING を含めたい場合は, key => value 形式
175     * の配列を $param へ渡す.
176     *
177     * @param string $path 結果を取得するためのパス
178     * @param array $param URL に付与するパラメータの配列
179     * @param boolean $useSSL 結果に SSL_URL を使用する場合 true,
180     *                         SITE_URL を使用する場合 false,
181     *                         デフォルト false
182     * @param string $documentRoot DocumentRoot の文字列. 指定しない場合は,
183     *                              $_SERVER['DOCUMENT_ROOT'] が付与される.
184     * @return string $path の存在する http(s):// から始まる絶対パス
185     */
186    function getLocation($path, $param = array(), $useSSL = false, $documentRoot = "") {
187
188        // TODO $_SERVER['DOCUMENT_ROOT'] をインストーラでチェックする.
189        if (empty($documentRoot)) {
190            $documentRoot = $_SERVER['DOCUMENT_ROOT'];
191
192            if (empty($documentRoot)) {
193                die("[BUG] can't get DOCUMENT_ROOT");
194            }
195        }
196        // DocumentRoot を削除した文字列を取得.
197        $root = str_replace($documentRoot, "", realpath($path));
198        // 先頭の / を削除
199        $root = substr_replace($root, "", 0, 1);
200
201        if ($useSSL) {
202            $url = SSL_URL . $root;
203        } else {
204            $url = SITE_URL . $root;
205        }
206
207        // QUERY_STRING 生成
208        $queryString = "";
209        $i = count($param);
210        foreach ($param as $key => $val) {
211            $queryString .= $key . "=" . $val;
212
213            if ($i > 1) {
214                $queryString .= "&";
215            }
216            $i--;
217        }
218
219        // QUERY_STRING が存在する場合は付与して返す.
220        if (empty($queryString)) {
221            return $url;
222        } else {
223            return $url . "?" . $queryString;
224        }
225    }
226
227    // }}}
228    // {{{ private functions
229
230    /**
231     * トランザクショントークン用の予測困難な文字列を生成して返す.
232     *
233     * @return string トランザクショントークン用の文字列
234     */
235    function createToken() {
236        return sha1(uniqid(rand(), true));
237    }
238}
239?>
Note: See TracBrowser for help on using the repository browser.