source: branches/version-2_5-dev/data/class/SC_Response.php @ 19913

Revision 19913, 12.9 KB checked in by Seasoft, 10 years ago (diff)

#714(パス指定によるリダイレクトの記述を簡潔にする)

  • コメント追記
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/**
25 * HttpResponse を扱うクラス.
26 *
27 * @author Ryuichi Tokugami
28 * @version $Id$
29 */
30class SC_Response{
31
32    /**
33     * コンテンツタイプ
34     * Enter description here ...
35     * @var unknown_type
36     */
37    var $contentType;
38    var $body;
39    var $statuscode;
40    var $header = array();
41
42    var $statusTexts = array(
43            '100' => 'Continue',
44            '101' => 'Switching Protocols',
45            '200' => 'OK',
46            '201' => 'Created',
47            '202' => 'Accepted',
48            '203' => 'Non-Authoritative Information',
49            '204' => 'No Content',
50            '205' => 'Reset Content',
51            '206' => 'Partial Content',
52            '300' => 'Multiple Choices',
53            '301' => 'Moved Permanently',
54            '302' => 'Found',
55            '303' => 'See Other',
56            '304' => 'Not Modified',
57            '305' => 'Use Proxy',
58            '306' => '(Unused)',
59            '307' => 'Temporary Redirect',
60            '400' => 'Bad Request',
61            '401' => 'Unauthorized',
62            '402' => 'Payment Required',
63            '403' => 'Forbidden',
64            '404' => 'Not Found',
65            '405' => 'Method Not Allowed',
66            '406' => 'Not Acceptable',
67            '407' => 'Proxy Authentication Required',
68            '408' => 'Request Timeout',
69            '409' => 'Conflict',
70            '410' => 'Gone',
71            '411' => 'Length Required',
72            '412' => 'Precondition Failed',
73            '413' => 'Request Entity Too Large',
74            '414' => 'Request-URI Too Long',
75            '415' => 'Unsupported Media Type',
76            '416' => 'Requested Range Not Satisfiable',
77            '417' => 'Expectation Failed',
78            '500' => 'Internal Server Error',
79            '501' => 'Not Implemented',
80            '502' => 'Bad Gateway',
81            '503' => 'Service Unavailable',
82            '504' => 'Gateway Timeout',
83            '505' => 'HTTP Version Not Supported',
84        );
85
86
87    /**
88     *
89     * Enter description here ...
90     */
91    var $encoding;
92
93    function SC_Response() {
94    }
95
96    /**
97     * レスポンス出力を書き込む.
98     */
99    function write() {
100        $this->sendHeader();
101        echo $this->body;
102    }
103
104    function sendHeader() {
105        // HTTPのヘッダ
106        //        header('HTTP/1.1 '.$this->statuscode.' '.$this->statusTexts[$this->statuscode]);
107        foreach ($this->header as $name => $head){
108            header($name.': '.$head);
109        }
110    }
111
112
113    function setContentType($contentType) {
114        $this->header['Content-Type'] = $contentType;
115    }
116
117    function setResposeBody($body){
118        $this->body = $body;
119    }
120
121    function addHeader($name, $value) {
122        $this->header[$name] = $value;
123    }
124
125    function containsHeader($name) {
126        return isset($this->header[$name]);
127    }
128
129    function sendError($errorcode) {
130        header('HTTP/1.1 '.$errorcode.' '.$this->statusTexts[$errorcode]);
131    }
132
133    /**
134     * アプリケーション内でリダイレクトする
135     *
136     * @param string $location 「url-path」「現在のURLからのパス」「URL」のいずれか。「../」の解釈は行なわない。
137     * @return void
138     * @static
139     */
140    function sendRedirect($location, $arrQueryString = array(), $inheritQueryString = false, $useSsl = null) {
141
142        // url-path → URL 変換
143        if ($location[0] === '/') {
144            $netUrl = new Net_URL();
145            $netUrl->path = $location;
146            $location = $netUrl->getUrl();
147        }
148
149        // URL の場合
150        if (preg_match('/^https?:/', $location)) {
151            $url = $location;
152            if (is_bool($useSsl)) {
153                if ($useSsl) {
154                    $pattern = '/^' . preg_quote(HTTP_URL, '/') . '(.*)/';
155                    $replacement = HTTPS_URL . '\1';
156                    $url = preg_replace($pattern, $replacement, $url);
157                }
158                else {
159                    $pattern = '/^' . preg_quote(HTTPS_URL, '/') . '(.*)/';
160                    $replacement = HTTP_URL . '\1';
161                    $url = preg_replace($pattern, $replacement, $url);
162                }
163            }
164        }
165        // 現在のURLからのパス
166        else {
167            if (!is_bool($useSsl)) {
168                $useSsl = SC_Utils_Ex::sfIsHTTPS();
169            }
170            $netUrl = new Net_URL($useSsl ? HTTPS_URL : HTTP_URL);
171            $netUrl->path = dirname($_SERVER['PHP_SELF']) . '/' . $location;
172            $url = $netUrl->getUrl();
173        }
174
175        $pattern = '/^(' . preg_quote(HTTP_URL, '/') . '|' . preg_quote(HTTPS_URL, '/') . ')/';
176
177        // アプリケーション外へのリダイレクトは扱わない
178        if (preg_match($pattern, $url) === 0) {
179            SC_Utils_Ex::sfDispException();
180        }
181
182        $netUrl = new Net_URL($url);
183        $arrQueryString = array_merge($netUrl->querystring, $arrQueryString);
184        $netUrl->querystring = array();
185
186        if ($inheritQueryString) {
187            if (!empty($_SERVER['QUERY_STRING'])) {
188                $netUrl->addRawQueryString($_SERVER['QUERY_STRING']);
189            }
190        }
191
192        foreach ($arrQueryString as $key => $val) {
193            $netUrl->addQueryString($key, $val);
194        }
195
196        $url = $netUrl->getURL();
197
198        $session = SC_SessionFactory::getInstance();
199        if (SC_MobileUserAgent::isMobile() || $session->useCookie() == false) {
200            $netUrl->addQueryString(session_name(), session_id());
201        }
202
203        $netUrl->addQueryString(TRANSACTION_ID_NAME, SC_Helper_Session_Ex::getToken());
204        $url = $netUrl->getURL();
205
206        header("Location: $url");
207        exit;
208    }
209
210    /**
211     * /html/ からのパスを指定してリダイレクトする
212     *
213     * FIXME メソッド名を分かりやすくしたい。現状だと、引数が「url-path より後」とも「url-path」とも読み取れる。(前者が意図したいところ)
214     * @param string $location /html/ からのパス。先頭に / を含むかは任意。「../」の解釈は行なわない。
215     * @return void
216     * @static
217     */
218    function sendRedirectFromUrlPath($location, $arrQueryString = array(), $inheritQueryString = false, $useSsl = null) {
219        $location = URL_PATH . ltrim($location, '/');
220        SC_Response_Ex::sendRedirect($location, $arrQueryString, $inheritQueryString, $useSsl);
221    }
222
223    /**
224     * @static
225     */
226    function reload($arrQueryString = array(), $removeQueryString = false) {
227        // 現在の URL を取得
228        $netUrl = new Net_URL($_SERVER['REQUEST_URI']);
229
230        if (!$removeQueryString) {
231            $arrQueryString = array_merge($netUrl->querystring, $arrQueryString);
232        }
233        $netUrl->querystring = array();
234
235        SC_Response_Ex::sendRedirect($netUrl->getURL(), $arrQueryString);
236    }
237
238    function setHeader($headers) {
239        $this->header = $headers;
240    }
241
242    function setStatus($sc = 202) {
243        $this->statuscode = $sc;
244    }
245
246    /**
247     * HTTPステータスコードを送出する。
248     *
249     * @param integer $code HTTPステータスコード
250     * @return void
251     * @author Seasoft (新規作成)
252     * @see Moony_Action::status() (オリジナル)
253     * @link http://moony.googlecode.com/ (オリジナル)
254     * @author YAMAOKA Hiroyuki (オリジナル)
255     * @copyright 2005-2008 YAMAOKA Hiroyuki (オリジナル)
256     * @license http://opensource.org/licenses/bsd-license.php New BSD License (オリジナル)
257     * @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 (邦訳)
258     * @license http://www.gnu.org/licenses/fdl.html GFDL (邦訳)
259     * @static
260     */
261    function sendHttpStatus($code) {
262        $protocol = $_SERVER['SERVER_PROTOCOL'];
263        $httpVersion = (strpos($protocol, '1.1') !== false) ? '1.1' : '1.0';
264        $messages = array(
265            // Informational 1xx                        // 【情報】
266            100 => 'Continue',                          // 継続
267            101 => 'Switching Protocols',               // プロトコル切替え
268            // Success 2xx                              // 【成功】
269            200 => 'OK',                                // OK
270            201 => 'Created',                           // 作成
271            202 => 'Accepted',                          // 受理
272            203 => 'Non-Authoritative Information',     // 信頼できない情報
273            204 => 'No Content',                        // 内容なし
274            205 => 'Reset Content',                     // 内容のリセット
275            206 => 'Partial Content',                   // 部分的内容
276            // Redirection 3xx                          // 【リダイレクション】
277            300 => 'Multiple Choices',                  // 複数の選択
278            301 => 'Moved Permanently',                 // 恒久的に移動した
279            302 => 'Found',  // 1.1                     // 発見した (リクエストしたリソースは一時的に移動されているときに返される)
280            303 => 'See Other',                         // 他を参照せよ
281            304 => 'Not Modified',                      // 未更新
282            305 => 'Use Proxy',                         // プロキシを使用せよ
283            // 306 is no longer used but still reserved // 将来のために予約されている
284            307 => 'Temporary Redirect',                // 一時的リダイレクト
285            // Client Error 4xx                         // 【クライアントエラー】
286            400 => 'Bad Request',                       // リクエストが不正である
287            401 => 'Unauthorized',                      // 認証が必要である
288            402 => 'Payment Required',                  // 支払いが必要である
289            403 => 'Forbidden',                         // 禁止されている
290            404 => 'Not Found',                         // 未検出
291            405 => 'Method Not Allowed',                // 許可されていないメソッド
292            406 => 'Not Acceptable',                    // 受理できない
293            407 => 'Proxy Authentication Required',     // プロキシ認証が必要である
294            408 => 'Request Timeout',                   // リクエストタイムアウト
295            409 => 'Conflict',                          // 矛盾
296            410 => 'Gone',                              // 消滅した
297            411 => 'Length Required',                   // 長さが必要
298            412 => 'Precondition Failed',               // 前提条件で失敗した
299            413 => 'Request Entity Too Large',          // リクエストエンティティが大きすぎる
300            414 => 'Request-URI Too Long',              // リクエストURIが大きすぎる
301            415 => 'Unsupported Media Type',            // サポートしていないメディアタイプ
302            416 => 'Requested Range Not Satisfiable',   // リクエストしたレンジは範囲外にある
303            417 => 'Expectation Failed',                // 期待するヘッダに失敗
304            // Server Error 5xx                         // 【サーバエラー】
305            500 => 'Internal Server Error',             // サーバ内部エラー
306            501 => 'Not Implemented',                   // 実装されていない
307            502 => 'Bad Gateway',                       // 不正なゲートウェイ
308            503 => 'Service Unavailable',               // サービス利用不可
309            504 => 'Gateway Timeout',                   // ゲートウェイタイムアウト
310            505 => 'HTTP Version Not Supported',        // サポートしていないHTTPバージョン
311            509 => 'Bandwidth Limit Exceeded'           // 帯域幅制限超過
312        );
313        if (isset($messages[$code])) {
314            if ($httpVersion !== '1.1') {
315                // HTTP/1.0
316                $messages[302] = 'Moved Temporarily';
317            }
318            header("HTTP/{$httpVersion} {$code} {$messages[$code]}");
319            header("Status: {$code} {$messages[$code]}", true, $code);
320        }
321    }
322}
Note: See TracBrowser for help on using the repository browser.