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

Revision 19924, 11.2 KB checked in by Seasoft, 10 years ago (diff)

#642(共通ロジックの機能向上)

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