source: branches/version-2_5-dev/data/class/pages/LC_Page.php @ 19705

Revision 19705, 19.9 KB checked in by nanasess, 12 years ago (diff)

#627(ソース整形・ソースコメントの改善)

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