source: branches/camp/camp-2_5-E/data/class/pages/LC_Page.php @ 19219

Revision 19219, 18.1 KB checked in by shutta, 12 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 * This file is part of EC-CUBE
4 *
5 * Copyright(c) 2000-2010 LOCKON CO.,LTD. All Rights Reserved.
6 *
7 * http://www.lockon.co.jp/
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 */
23
24// {{{ requires
25require_once(DATA_PATH . 'module/Net/URL.php');
26
27/**
28 * Web Page を制御する基底クラス
29 *
30 * Web Page を制御する Page クラスは必ずこのクラスを継承する.
31 * PHP4 ではこのような抽象クラスを作っても継承先で何でもできてしまうため、
32 * あまり意味がないが、アーキテクトを統一するために作っておく.
33 *
34 * @package Page
35 * @author LOCKON CO.,LTD.
36 * @version $Id:LC_Page.php 15532 2007-08-31 14:39:46Z nanasess $
37 */
38class LC_Page {
39
40    // {{{ properties
41
42    /** メインテンプレート */
43    var $tpl_mainpage;
44
45    /** テンプレートのカラム数 */
46    var $tpl_column_num = 2;
47
48    /** メインナンバー */
49    var $tpl_mainno;
50
51    /** CSS のパス */
52    var $tpl_css;
53
54    /** JavaScript */
55    var $tpl_javascript;
56
57    /** タイトル */
58    var $tpl_title;
59
60    /** カテゴリ */
61    var $tpl_page_category;
62
63    /** ログインメールアドレス */
64    var $tpl_login_email;
65
66    /** body タグの onload 属性 */
67    var $tpl_onload;
68
69    /** 送料合計 */
70    var $tpl_total_deliv_fee;
71
72    /** トランザクションID */
73    var $transactionid;
74
75    /** テンプレート名 */
76    var $template;
77
78    // }}}
79    // {{{ functions
80
81    /**
82     * Page を初期化する.
83     *
84     * @return void
85     */
86    function init() {
87        $this->tpl_authority = $_SESSION['authority'];
88        // XXX すべてのページで宣言するべき
89        $layout = new SC_Helper_PageLayout_Ex();
90        $layout->sfGetPageLayout($this, false);
91
92        $this->template = SITE_FRAME;
93
94        // ディスプレイクラス生成
95        $this->objDisp = new SC_Display();
96
97        // プラグインクラス生成
98        #$this->objPlagin = new SC_Helper_Plugin_Ex();
99        #$this->objPlagin->preProcess($this);
100    }
101
102    /**
103     * Page のプロセス.
104     *
105     * @return void
106     */
107    function process() {}
108
109    /**
110     * Page のアクション.
111     *
112     * @return void
113     */
114    function sendResponse() {
115        $this->objDisp->hoge($this);
116        $this->objDisp->response->response();
117    }
118
119    /**
120     * デストラクタ.
121     *
122     * @return void
123     */
124    function destroy() {}
125
126    /**
127     * テンプレート取得
128     *
129     */
130    function getTemplate() {
131        return $this->template;
132    }
133
134    /**
135     * テンプレート設定(ポップアップなどの場合)
136     *
137     */
138    function setTemplate($template) {
139        $this->template = $template;
140    }
141
142    /**
143     * 指定の URL へリダイレクトする.
144     *
145     * リダイレクト先 URL に SITE_URL 及び SSL_URL を含むかチェックし,
146     * LC_Page::getToken() の値を URLパラメータで自動的に付与する.
147     *
148     * @param string $url リダイレクト先 URL
149     * @param boolean $isMobile モバイル用にセッションIDを付与する場合 true
150     * @return void|boolean $url に SITE_URL 及び, SSL_URL を含まない場合 false,
151     *                       正常に遷移可能な場合は, $url の ロケーションヘッダを出力する.
152     * @see Net_URL
153     */
154    function sendRedirect($url, $isMobile = false) {
155
156        if (preg_match("/(" . preg_quote(SITE_URL, '/')
157                          . "|" . preg_quote(SSL_URL, '/') . ")/", $url)) {
158
159            $netURL = new Net_URL($url);
160            if (!empty($_SERVER['QUERY_STRING'])) {
161                $netURL->addRawQueryString($_SERVER['QUERY_STRING']);
162            }
163
164            $session = SC_SessionFactory::getInstance();
165            if ($isMobile || $session->useCookie() == false) {
166                $netURL->addQueryString(session_name(), session_id());
167            }
168
169            $netURL->addQueryString(TRANSACTION_ID_NAME, $this->getToken());
170            header("Location: " . $netURL->getURL());
171            //return true;
172            exit();
173        }
174        return false;
175    }
176
177    // }}}
178    // {{{ protected functions
179
180    /**
181     * トランザクショントークンを生成し, 取得する.
182     *
183     * 悪意のある不正な画面遷移を防止するため, 予測困難な文字列を生成して返す.
184     * 同時に, この文字列をセッションに保存する.
185     *
186     * この関数を使用するためには, 生成した文字列を次画面へ渡すパラメータとして
187     * 出力する必要がある.
188     *
189     * 例)
190     * <input type="hidden" name="transactionid" value="この関数の返り値" />
191     *
192     * 遷移先のページで, LC_Page::isValidToken() の返り値をチェックすることにより,
193     * 画面遷移の妥当性が確認できる.
194     *
195     * @access protected
196     * @return string トランザクショントークンの文字列
197     */
198    function getToken() {
199        if (empty($_SESSION[TRANSACTION_ID_NAME])) {
200            $_SESSION[TRANSACTION_ID_NAME] = $this->createToken();
201        }
202        return $_SESSION[TRANSACTION_ID_NAME];
203    }
204
205    /**
206     * トランザクショントークンの妥当性をチェックする.
207     *
208     * 前画面で生成されたトランザクショントークンの妥当性をチェックする.
209     * この関数を使用するためには, 前画面のページクラスで LC_Page::getToken()
210     * を呼んでおく必要がある.
211     *
212     * @access protected
213     * @return boolean トランザクショントークンが有効な場合 true
214     */
215    function isValidToken() {
216
217        $checkToken = "";
218
219        // $_POST の値を優先する
220        if (isset($_POST[TRANSACTION_ID_NAME])) {
221
222            $checkToken = $_POST[TRANSACTION_ID_NAME];
223        } elseif (isset($_GET[TRANSACTION_ID_NAME])) {
224
225            $checkToken = $_GET[TRANSACTION_ID_NAME];
226        }
227
228        $ret = false;
229        // token の妥当性チェック
230        if ($checkToken === $_SESSION[TRANSACTION_ID_NAME]) {
231
232            $ret = true;
233        }
234
235        unset($_SESSION[TRANSACTION_ID_NAME]);
236        return $ret;
237    }
238
239    /**
240     * $path から URL を取得する.
241     *
242     * 以下の順序で 引数 $path から URL を取得する.
243     * 1. realpath($path) で $path の 絶対パスを取得
244     * 2. $_SERVER['DOCUMENT_ROOT'] と一致する文字列を削除
245     * 3. $useSSL の値に応じて, SITE_URL 又は, SSL_URL を付与する.
246     *
247     * 返り値に, QUERY_STRING を含めたい場合は, key => value 形式
248     * の配列を $param へ渡す.
249     *
250     * @access protected
251     * @param string $path 結果を取得するためのパス
252     * @param array $param URL に付与するパラメータの配列
253     * @param mixed $useSSL 結果に SSL_URL を使用する場合 true,
254     *                         SITE_URL を使用する場合 false,
255     *                         デフォルト "escape" 現在のスキーマを使用
256     * @return string $path の存在する http(s):// から始まる絶対パス
257     * @see Net_URL
258     */
259    function getLocation($path, $param = array(), $useSSL = "escape") {
260        $rootPath = $this->getRootPath($path);
261
262        // スキーマを定義
263        if ($useSSL === true) {
264            $url = SSL_URL . $rootPath;
265        } elseif ($useSSL === false){
266            $url = SITE_URL . $rootPath;
267        } elseif ($useSSL == "escape") {
268            if (SC_Utils_Ex::sfIsHTTPS()) {
269                $url = SSL_URL . $rootPath;
270            } else {
271                $url = SITE_URL . $rootPath;
272            }
273        } else {
274            die("[BUG] Illegal Parametor of \$useSSL ");
275        }
276
277        $netURL = new Net_URL($url);
278        // QUERY_STRING 生成
279        foreach ($param as $key => $val) {
280            $netURL->addQueryString($key, $val);
281        }
282
283        return $netURL->getURL();
284    }
285
286    /**
287     * EC-CUBE のWEBルート(/html/)を / としたパスを返す
288     *
289     * @param string $path 結果を取得するためのパス
290     * @return string EC-CUBE のWEBルート(/html/)を / としたパス
291     */
292    function getRootPath($path) {
293        // Windowsの場合は, ディレクトリの区切り文字を\から/に変換する
294        $path = str_replace('\\', '/', $path);
295        $htmlPath = str_replace('\\', '/', HTML_PATH);
296       
297        // PHP 5.1 対策 ( http://xoops.ec-cube.net/modules/newbb/viewtopic.php?topic_id=4277&forum=9 )
298        if (strlen($path) == 0) {
299            $path = '.';
300        }
301       
302        // $path が / で始まっている場合
303        if (substr($path, 0, 1) == '/') {
304            $realPath = realpath($htmlPath . substr_replace($path, '', 0, strlen(URL_DIR)));
305        // 相対パスの場合
306        } else {
307            $realPath = realpath($path);
308        }
309        $realPath = str_replace('\\', '/', $realPath);
310       
311        // $path が / で終わっている場合、realpath によって削られた末尾の / を復元する。
312        if (substr($path, -1, 1) == '/' && substr($realPath, -1, 1) != '/') {
313            $realPath .= '/';
314        }
315       
316        // HTML_PATH を削除した文字列を取得.
317        $rootPath = str_replace($htmlPath, '', $realPath);
318        $rootPath = ltrim($rootPath, '/');
319
320        return $rootPath;
321    }
322
323    /**
324     * ページをリロードする.
325     *
326     * 引数 $queryString に, $_SERVER['QUERY_STRING'] の値を使用してはならない.
327     * この関数は, 内部で LC_Page::sendRedirect() を使用するため,
328     * $_SERVER['QUERY_STRING'] の値は自動的に付与される.
329     *
330     * @param array $queryString QueryString の配列
331     * @param bool $removeQueryString 付与されていた QueryString を削除する場合 true
332     * @return void
333     * @see Net_URL
334     */
335    function reload($queryString = array(), $removeQueryString = false) {
336
337        // 現在の URL を取得
338        $netURL = new Net_URL($_SERVER['REQUEST_URI']);
339
340        if ($removeQueryString) {
341            $netURL->querystring = array();
342            $_SERVER['QUERY_STRING'] = ''; // sendRedirect() での処理用らしい
343        }
344
345        // QueryString を付与
346        if (!empty($queryString)) {
347            foreach ($queryString as $key => $val) {
348                $netURL->addQueryString($key, $val);
349            }
350        }
351
352        $this->sendRedirect($netURL->getURL());
353    }
354
355    /**
356     * 互換性確保用メソッド
357     *
358     * @access protected
359     * @return void
360     * @deprecated 決済モジュール互換のため
361     */
362    function allowClientCache() {
363        LC_Page::httpCacheControl('private');
364    }
365
366    /**
367     * クライアント・プロキシのキャッシュを制御する.
368     *
369     * @access protected
370     * @param string $mode (nocache/private)
371     * @return void
372     */
373    function httpCacheControl($mode = '') {
374        switch ($mode) {
375            case 'nocache':
376                header('Pragma: no-cache');
377                header('Expires: Thu, 19 Nov 1981 08:52:00 GMT');
378                header('Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0');
379                header('Last-Modified:');
380                break;
381               
382            case 'private':
383                $cache_expire = session_cache_expire() * 60;
384                header('Pragma: no-cache');                                                            // anti-proxy
385                header('Expires:');                                                                    // anti-mozilla
386                header("Cache-Control: private, max-age={$cache_expire}, pre-check={$cache_expire}");  // HTTP/1.1 client
387                header('Last-Modified:');
388                break;
389               
390            default:
391                break;
392        }
393    }
394
395    /**
396     * デバック出力を行う.
397     *
398     * デバック用途のみに使用すること.
399     *
400     * @access protected
401     * @param mixed $val デバックする要素
402     * @return void
403     */
404    function p($val) {
405        SC_Utils_Ex::sfPrintR($val);
406    }
407
408    // }}}
409    // {{{ private functions
410
411    /**
412     * トランザクショントークン用の予測困難な文字列を生成して返す.
413     *
414     * @access private
415     * @return string トランザクショントークン用の文字列
416     */
417    function createToken() {
418        return sha1(uniqid(rand(), true));
419    }
420   
421    /**
422     * HTTPステータスコードを送出する。
423     *
424     * @param integer $code HTTPステータスコード
425     * @return void
426     * @author Seasoft (新規作成)
427     * @see Moony_Action::status() (オリジナル)
428     * @link http://moony.googlecode.com/ (オリジナル)
429     * @author YAMAOKA Hiroyuki (オリジナル)
430     * @copyright 2005-2008 YAMAOKA Hiroyuki (オリジナル)
431     * @license http://opensource.org/licenses/bsd-license.php New BSD License (オリジナル)
432     * @link http://ja.wikipedia.org/wiki/HTTP%E3%82%B9%E3%83%86%E3%83%BC%E3%82%BF%E3%82%B9%E3%82%B3%E3%83%BC%E3%83%89 (邦訳)
433     * @license http://www.gnu.org/licenses/fdl.html GFDL (邦訳)
434     */
435    function sendHttpStatus($code) {
436        $protocol = $_SERVER['SERVER_PROTOCOL'];
437        $httpVersion = (strpos($protocol, '1.1') !== false) ? '1.1' : '1.0';
438        $messages = array(
439            // Informational 1xx                        // 【情報】
440            100 => 'Continue',                          // 継続
441            101 => 'Switching Protocols',               // プロトコル切替え
442            // Success 2xx                              // 【成功】
443            200 => 'OK',                                // OK
444            201 => 'Created',                           // 作成
445            202 => 'Accepted',                          // 受理
446            203 => 'Non-Authoritative Information',     // 信頼できない情報
447            204 => 'No Content',                        // 内容なし
448            205 => 'Reset Content',                     // 内容のリセット
449            206 => 'Partial Content',                   // 部分的内容
450            // Redirection 3xx                          // 【リダイレクション】
451            300 => 'Multiple Choices',                  // 複数の選択
452            301 => 'Moved Permanently',                 // 恒久的に移動した
453            302 => 'Found',  // 1.1                     // 発見した (リクエストしたリソースは一時的に移動されているときに返される)
454            303 => 'See Other',                         // 他を参照せよ
455            304 => 'Not Modified',                      // 未更新
456            305 => 'Use Proxy',                         // プロキシを使用せよ
457            // 306 is no longer used but still reserved // 将来のために予約されている
458            307 => 'Temporary Redirect',                // 一時的リダイレクト
459            // Client Error 4xx                         // 【クライアントエラー】
460            400 => 'Bad Request',                       // リクエストが不正である
461            401 => 'Unauthorized',                      // 認証が必要である
462            402 => 'Payment Required',                  // 支払いが必要である
463            403 => 'Forbidden',                         // 禁止されている
464            404 => 'Not Found',                         // 未検出
465            405 => 'Method Not Allowed',                // 許可されていないメソッド
466            406 => 'Not Acceptable',                    // 受理できない
467            407 => 'Proxy Authentication Required',     // プロキシ認証が必要である
468            408 => 'Request Timeout',                   // リクエストタイムアウト
469            409 => 'Conflict',                          // 矛盾
470            410 => 'Gone',                              // 消滅した
471            411 => 'Length Required',                   // 長さが必要
472            412 => 'Precondition Failed',               // 前提条件で失敗した
473            413 => 'Request Entity Too Large',          // リクエストエンティティが大きすぎる
474            414 => 'Request-URI Too Long',              // リクエストURIが大きすぎる
475            415 => 'Unsupported Media Type',            // サポートしていないメディアタイプ
476            416 => 'Requested Range Not Satisfiable',   // リクエストしたレンジは範囲外にある
477            417 => 'Expectation Failed',                // 期待するヘッダに失敗
478            // Server Error 5xx                         // 【サーバエラー】
479            500 => 'Internal Server Error',             // サーバ内部エラー
480            501 => 'Not Implemented',                   // 実装されていない
481            502 => 'Bad Gateway',                       // 不正なゲートウェイ
482            503 => 'Service Unavailable',               // サービス利用不可
483            504 => 'Gateway Timeout',                   // ゲートウェイタイムアウト
484            505 => 'HTTP Version Not Supported',        // サポートしていないHTTPバージョン
485            509 => 'Bandwidth Limit Exceeded'           // 帯域幅制限超過
486        );
487        if (isset($messages[$code])) {
488            if ($httpVersion !== '1.1') {
489                // HTTP/1.0
490                $messages[302] = 'Moved Temporarily';
491            }
492            header("HTTP/{$httpVersion} {$code} {$messages[$code]}");
493            header("Status: {$code} {$messages[$code]}", true, $code);
494        }
495    }
496}
497?>
Note: See TracBrowser for help on using the repository browser.