Changeset 2444 for trunk/framework/Web

Timestamp:

04/21/2008 07:32:12 AM (9 months ago)

Author:

tof

Message:

Fixed #770

Files:

• trunk/framework/Web/THttpResponse.php (modified) (6 diffs)

trunk/framework/Web/THttpResponse.php

@@ -43 +43 @@
  * or {@link TGlobalization::setCharset() TGlobalization.Charset} is set.
  *
+ * Since 3.1.2, HTTP status code can be set with the {@link setStatusCode StatusCode} property.
+ * 
+ * Note: Some HTTP Status codes can require additional header or body information. So, if you use {@link setStatusCode StatusCode}
+ * in your application, be sure to add theses informations.
+ * E.g : to make an http authentication :
+ * <code>
+ *  public function clickAuth ($sender, $param)
+ *  {
+ *     $response=$this->getResponse();
+ *     $response->setStatusCode(401);
+ *     $response->appendHeader('WWW-Authenticate: Basic realm="Test"');
+ *  } 
+ * </code>
+ *    
+ * This event handler will sent the 401 status code (Unauthorized) to the browser, with the WWW-Authenticate header field. This
+ * will force the browser to ask for a username and a password.
+ *  
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @version $Id$
@@ -51 +68 @@
 {
         /**
+         * @var The differents defined status code by RFC 2616 {@link http://www.faqs.org/rfcs/rfc2616}
+         */
+        private static $HTTP_STATUS_CODES = array(
+                100 => 'Continue', 101 => 'Switching Protocols', 
+                200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 
+                300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 
+                400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed', 
+                500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported'
+        );
+
+        /**
          * @var boolean whether to buffer output
          */
@@ -66 +94 @@
          */
         private $_status=200;
+        /**
+         * @var string reason correspond to status code
+         */
+        private $_reason='OK';
         /**
          * @var string HTML writer type
@@ -225 +257 @@
 
         /**
+         * Set the HTTP status code for the response.
+         * 
          * @param integer HTTP status code
          */
-        public function setStatusCode($status)
-        {
-                $this->_status=TPropertyValue::ensureInteger($status);
+        public function setStatusCode($status, $reason=null)
+        {
+                $status=TPropertyValue::ensureInteger($status);
+                if(isset(self::$HTTP_STATUS_CODES[$status])) {
+                        $this->_reason=self::$HTTP_STATUS_CODES[$status];
+                }else{
+                        if($reason===null || $reason==='') {
+                                throw new TInvalidDataValueException("response_status_reason_missing");
+                        }
+                        $reason=TPropertyValue::ensureString($reason);
+                        if(strpos($reason, "\r")!=false || strpos($reason, "\n")!=false) {
+                                throw new TInvalidDataValueException("response_status_reason_barchars");
+                        }
+                        $this->_reason=$reason;
+                }
+                $this->_status=$status;
+        }
+
+        /**
+         * @param string HTTP status reason
+         */
+        public function getStatusReason() {
+                return $this->_reason;
         }
 
@@ -288 +342 @@
                 }
                 $fn=basename($fileName);
+                header("HTTP/1.1 {$this->_status} {$this->_reason}", true, $this->_status);
                 if(is_array($headers))
                 {
@@ -367 +422 @@
         {
                 Prado::trace("Flushing output",'System.Web.THttpResponse');
+                $this->sendHttpHeader();
                 $this->sendContentTypeHeader();
                 if($this->_bufferOutput)
                         ob_flush();
+        }
+        
+        /**
+         * Send the HTTP header with the status code (defaults to 200) and status reason (defaults to OK)
+         */
+        protected function sendHttpHeader ()
+        {
+                header("HTTP/1.1 {$this->_status} {$this->_reason}", true, $this->_status);
         }