source: branches/camp/camp-2_5-B/data/class/pages/LC_Page.php @ 18950

Revision 18950, 18.1 KB checked in by Yammy, 12 years ago (diff)

各ページクラスのprocess()より表示部分をLC_Page::display()に出す案

  • 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 $site_frame;
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        $this->tpl = SITE_FRAME;
92    }
93
94    /**
95     * Page のプロセス.
96     *
97     * @return void
98     */
99    function process() {}
100
101    /**
102     *  Page の表示プロセス
103     *
104     * @return void
105     */
106    function display() {
107echo "\$this->tpl = $this->tpl<br />\n";
108echo "LC_Page::disp<br />\n";
109
110        // SC_Helper_Pagin_Ex::process();
111        $this->objView->assignobj($this);
112
113        // campaign
114        #if (is_object($this->objCampaignSess)) {
115            #$this->tpl = $this->objCampaignSess->getPageFrame();
116        #}
117
118        if (!empty($this->redirect_url)) {
119echo "redirect<br />\n";
120            $this->sendRedirect($this->redirect_url);
121        } elseif(!empty($this->download)) {
122echo "download<br />\n";
123        } else {
124echo "default<br />\n";
125            $this->objView->display($this->tpl);
126        }
127
128    }
129
130    /**
131     * デストラクタ.
132     *
133     * @return void
134     */
135    function destroy() {}
136
137    /**
138     * 指定の URL へリダイレクトする.
139     *
140     * リダイレクト先 URL に SITE_URL 及び SSL_URL を含むかチェックし,
141     * LC_Page::getToken() の値を URLパラメータで自動的に付与する.
142     *
143     * @param string $url リダイレクト先 URL
144     * @param boolean $isMobile モバイル用にセッションIDを付与する場合 true
145     * @return void|boolean $url に SITE_URL 及び, SSL_URL を含まない場合 false,
146     *                       正常に遷移可能な場合は, $url の ロケーションヘッダを出力する.
147     * @see Net_URL
148     */
149    function sendRedirect($url, $isMobile = false) {
150
151        if (preg_match("/(" . preg_quote(SITE_URL, '/')
152                          . "|" . preg_quote(SSL_URL, '/') . ")/", $url)) {
153
154            $netURL = new Net_URL($url);
155            if (!empty($_SERVER['QUERY_STRING'])) {
156                $netURL->addRawQueryString($_SERVER['QUERY_STRING']);
157            }
158
159            $session = SC_SessionFactory::getInstance();
160            if ($isMobile || $session->useCookie() == false) {
161                $netURL->addQueryString(session_name(), session_id());
162            }
163
164            $netURL->addQueryString(TRANSACTION_ID_NAME, $this->getToken());
165            header("Location: " . $netURL->getURL());
166            //return true;
167            exit();
168        }
169        return false;
170    }
171
172    // }}}
173    // {{{ protected functions
174
175    /**
176     * トランザクショントークンを生成し, 取得する.
177     *
178     * 悪意のある不正な画面遷移を防止するため, 予測困難な文字列を生成して返す.
179     * 同時に, この文字列をセッションに保存する.
180     *
181     * この関数を使用するためには, 生成した文字列を次画面へ渡すパラメータとして
182     * 出力する必要がある.
183     *
184     * 例)
185     * <input type="hidden" name="transactionid" value="この関数の返り値" />
186     *
187     * 遷移先のページで, LC_Page::isValidToken() の返り値をチェックすることにより,
188     * 画面遷移の妥当性が確認できる.
189     *
190     * @access protected
191     * @return string トランザクショントークンの文字列
192     */
193    function getToken() {
194        if (empty($_SESSION[TRANSACTION_ID_NAME])) {
195            $_SESSION[TRANSACTION_ID_NAME] = $this->createToken();
196        }
197        return $_SESSION[TRANSACTION_ID_NAME];
198    }
199
200    /**
201     * トランザクショントークンの妥当性をチェックする.
202     *
203     * 前画面で生成されたトランザクショントークンの妥当性をチェックする.
204     * この関数を使用するためには, 前画面のページクラスで LC_Page::getToken()
205     * を呼んでおく必要がある.
206     *
207     * @access protected
208     * @return boolean トランザクショントークンが有効な場合 true
209     */
210    function isValidToken() {
211
212        $checkToken = "";
213
214        // $_POST の値を優先する
215        if (isset($_POST[TRANSACTION_ID_NAME])) {
216
217            $checkToken = $_POST[TRANSACTION_ID_NAME];
218        } elseif (isset($_GET[TRANSACTION_ID_NAME])) {
219
220            $checkToken = $_GET[TRANSACTION_ID_NAME];
221        }
222
223        $ret = false;
224        // token の妥当性チェック
225        if ($checkToken === $_SESSION[TRANSACTION_ID_NAME]) {
226
227            $ret = true;
228        }
229
230        unset($_SESSION[TRANSACTION_ID_NAME]);
231        return $ret;
232    }
233
234    /**
235     * $path から URL を取得する.
236     *
237     * 以下の順序で 引数 $path から URL を取得する.
238     * 1. realpath($path) で $path の 絶対パスを取得
239     * 2. $_SERVER['DOCUMENT_ROOT'] と一致する文字列を削除
240     * 3. $useSSL の値に応じて, SITE_URL 又は, SSL_URL を付与する.
241     *
242     * 返り値に, QUERY_STRING を含めたい場合は, key => value 形式
243     * の配列を $param へ渡す.
244     *
245     * @access protected
246     * @param string $path 結果を取得するためのパス
247     * @param array $param URL に付与するパラメータの配列
248     * @param mixed $useSSL 結果に SSL_URL を使用する場合 true,
249     *                         SITE_URL を使用する場合 false,
250     *                         デフォルト "escape" 現在のスキーマを使用
251     * @return string $path の存在する http(s):// から始まる絶対パス
252     * @see Net_URL
253     */
254    function getLocation($path, $param = array(), $useSSL = "escape") {
255        $rootPath = $this->getRootPath($path);
256
257        // スキーマを定義
258        if ($useSSL === true) {
259            $url = SSL_URL . $rootPath;
260        } elseif ($useSSL === false){
261            $url = SITE_URL . $rootPath;
262        } elseif ($useSSL == "escape") {
263            if (SC_Utils_Ex::sfIsHTTPS()) {
264                $url = SSL_URL . $rootPath;
265            } else {
266                $url = SITE_URL . $rootPath;
267            }
268        } else {
269            die("[BUG] Illegal Parametor of \$useSSL ");
270        }
271
272        $netURL = new Net_URL($url);
273        // QUERY_STRING 生成
274        foreach ($param as $key => $val) {
275            $netURL->addQueryString($key, $val);
276        }
277
278        return $netURL->getURL();
279    }
280
281    /**
282     * EC-CUBE のWEBルート(/html/)を / としたパスを返す
283     *
284     * @param string $path 結果を取得するためのパス
285     * @return string EC-CUBE のWEBルート(/html/)を / としたパス
286     */
287    function getRootPath($path) {
288        // Windowsの場合は, ディレクトリの区切り文字を\から/に変換する
289        $path = str_replace('\\', '/', $path);
290        $htmlPath = str_replace('\\', '/', HTML_PATH);
291       
292        // PHP 5.1 対策 ( http://xoops.ec-cube.net/modules/newbb/viewtopic.php?topic_id=4277&forum=9 )
293        if (strlen($path) == 0) {
294            $path = '.';
295        }
296       
297        // $path が / で始まっている場合
298        if (substr($path, 0, 1) == '/') {
299            $realPath = realpath($htmlPath . substr_replace($path, '', 0, strlen(URL_DIR)));
300        // 相対パスの場合
301        } else {
302            $realPath = realpath($path);
303        }
304        $realPath = str_replace('\\', '/', $realPath);
305       
306        // $path が / で終わっている場合、realpath によって削られた末尾の / を復元する。
307        if (substr($path, -1, 1) == '/' && substr($realPath, -1, 1) != '/') {
308            $realPath .= '/';
309        }
310       
311        // HTML_PATH を削除した文字列を取得.
312        $rootPath = str_replace($htmlPath, '', $realPath);
313        $rootPath = ltrim($rootPath, '/');
314
315        return $rootPath;
316    }
317
318    /**
319     * ページをリロードする.
320     *
321     * 引数 $queryString に, $_SERVER['QUERY_STRING'] の値を使用してはならない.
322     * この関数は, 内部で LC_Page::sendRedirect() を使用するため,
323     * $_SERVER['QUERY_STRING'] の値は自動的に付与される.
324     *
325     * @param array $queryString QueryString の配列
326     * @param bool $removeQueryString 付与されていた QueryString を削除する場合 true
327     * @return void
328     * @see Net_URL
329     */
330    function reload($queryString = array(), $removeQueryString = false) {
331
332        // 現在の URL を取得
333        $netURL = new Net_URL($_SERVER['REQUEST_URI']);
334
335        if ($removeQueryString) {
336            $netURL->querystring = array();
337            $_SERVER['QUERY_STRING'] = ''; // sendRedirect() での処理用らしい
338        }
339
340        // QueryString を付与
341        if (!empty($queryString)) {
342            foreach ($queryString as $key => $val) {
343                $netURL->addQueryString($key, $val);
344            }
345        }
346
347        $this->sendRedirect($netURL->getURL());
348    }
349
350    /**
351     * 互換性確保用メソッド
352     *
353     * @access protected
354     * @return void
355     * @deprecated 決済モジュール互換のため
356     */
357    function allowClientCache() {
358        LC_Page::httpCacheControl('private');
359    }
360
361    /**
362     * クライアント・プロキシのキャッシュを制御する.
363     *
364     * @access protected
365     * @param string $mode (nocache/private)
366     * @return void
367     */
368    function httpCacheControl($mode = '') {
369        switch ($mode) {
370            case 'nocache':
371                header('Pragma: no-cache');
372                header('Expires: Thu, 19 Nov 1981 08:52:00 GMT');
373                header('Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0');
374                header('Last-Modified:');
375                break;
376               
377            case 'private':
378                $cache_expire = session_cache_expire() * 60;
379                header('Pragma: no-cache');                                                            // anti-proxy
380                header('Expires:');                                                                    // anti-mozilla
381                header("Cache-Control: private, max-age={$cache_expire}, pre-check={$cache_expire}");  // HTTP/1.1 client
382                header('Last-Modified:');
383                break;
384               
385            default:
386                break;
387        }
388    }
389
390    /**
391     * デバック出力を行う.
392     *
393     * デバック用途のみに使用すること.
394     *
395     * @access protected
396     * @param mixed $val デバックする要素
397     * @return void
398     */
399    function p($val) {
400        SC_Utils_Ex::sfPrintR($val);
401    }
402
403    // }}}
404    // {{{ private functions
405
406    /**
407     * トランザクショントークン用の予測困難な文字列を生成して返す.
408     *
409     * @access private
410     * @return string トランザクショントークン用の文字列
411     */
412    function createToken() {
413        return sha1(uniqid(rand(), true));
414    }
415   
416    /**
417     * HTTPステータスコードを送出する。
418     *
419     * @param integer $code HTTPステータスコード
420     * @return void
421     * @author Seasoft (新規作成)
422     * @see Moony_Action::status() (オリジナル)
423     * @link http://moony.googlecode.com/ (オリジナル)
424     * @author YAMAOKA Hiroyuki (オリジナル)
425     * @copyright 2005-2008 YAMAOKA Hiroyuki (オリジナル)
426     * @license http://opensource.org/licenses/bsd-license.php New BSD License (オリジナル)
427     * @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 (邦訳)
428     * @license http://www.gnu.org/licenses/fdl.html GFDL (邦訳)
429     */
430    function sendHttpStatus($code) {
431        $protocol = $_SERVER['SERVER_PROTOCOL'];
432        $httpVersion = (strpos($protocol, '1.1') !== false) ? '1.1' : '1.0';
433        $messages = array(
434            // Informational 1xx                        // 【情報】
435            100 => 'Continue',                          // 継続
436            101 => 'Switching Protocols',               // プロトコル切替え
437            // Success 2xx                              // 【成功】
438            200 => 'OK',                                // OK
439            201 => 'Created',                           // 作成
440            202 => 'Accepted',                          // 受理
441            203 => 'Non-Authoritative Information',     // 信頼できない情報
442            204 => 'No Content',                        // 内容なし
443            205 => 'Reset Content',                     // 内容のリセット
444            206 => 'Partial Content',                   // 部分的内容
445            // Redirection 3xx                          // 【リダイレクション】
446            300 => 'Multiple Choices',                  // 複数の選択
447            301 => 'Moved Permanently',                 // 恒久的に移動した
448            302 => 'Found',  // 1.1                     // 発見した (リクエストしたリソースは一時的に移動されているときに返される)
449            303 => 'See Other',                         // 他を参照せよ
450            304 => 'Not Modified',                      // 未更新
451            305 => 'Use Proxy',                         // プロキシを使用せよ
452            // 306 is no longer used but still reserved // 将来のために予約されている
453            307 => 'Temporary Redirect',                // 一時的リダイレクト
454            // Client Error 4xx                         // 【クライアントエラー】
455            400 => 'Bad Request',                       // リクエストが不正である
456            401 => 'Unauthorized',                      // 認証が必要である
457            402 => 'Payment Required',                  // 支払いが必要である
458            403 => 'Forbidden',                         // 禁止されている
459            404 => 'Not Found',                         // 未検出
460            405 => 'Method Not Allowed',                // 許可されていないメソッド
461            406 => 'Not Acceptable',                    // 受理できない
462            407 => 'Proxy Authentication Required',     // プロキシ認証が必要である
463            408 => 'Request Timeout',                   // リクエストタイムアウト
464            409 => 'Conflict',                          // 矛盾
465            410 => 'Gone',                              // 消滅した
466            411 => 'Length Required',                   // 長さが必要
467            412 => 'Precondition Failed',               // 前提条件で失敗した
468            413 => 'Request Entity Too Large',          // リクエストエンティティが大きすぎる
469            414 => 'Request-URI Too Long',              // リクエストURIが大きすぎる
470            415 => 'Unsupported Media Type',            // サポートしていないメディアタイプ
471            416 => 'Requested Range Not Satisfiable',   // リクエストしたレンジは範囲外にある
472            417 => 'Expectation Failed',                // 期待するヘッダに失敗
473            // Server Error 5xx                         // 【サーバエラー】
474            500 => 'Internal Server Error',             // サーバ内部エラー
475            501 => 'Not Implemented',                   // 実装されていない
476            502 => 'Bad Gateway',                       // 不正なゲートウェイ
477            503 => 'Service Unavailable',               // サービス利用不可
478            504 => 'Gateway Timeout',                   // ゲートウェイタイムアウト
479            505 => 'HTTP Version Not Supported',        // サポートしていないHTTPバージョン
480            509 => 'Bandwidth Limit Exceeded'           // 帯域幅制限超過
481        );
482        if (isset($messages[$code])) {
483            if ($httpVersion !== '1.1') {
484                // HTTP/1.0
485                $messages[302] = 'Moved Temporarily';
486            }
487            header("HTTP/{$httpVersion} {$code} {$messages[$code]}");
488            header("Status: {$code} {$messages[$code]}", true, $code);
489        }
490    }
491}
492?>
Note: See TracBrowser for help on using the repository browser.