X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_response_object.c;h=72289b65f291fc71025eb04262abb32fdd03695c;hp=61b3c82353220524775c7830ba036c8dcc7ccf11;hb=39feb7a7e30bb4b393a6f76aa2f35d4e9275523e;hpb=c07ee6eaef449abb292bb84d5ba61c19a467e184

diff --git a/http_response_object.c b/http_response_object.c
index 61b3c82..72289b6 100644
--- a/http_response_object.c
+++ b/http_response_object.c
@@ -41,6 +41,9 @@
 #ifdef HTTP_HAVE_MHASH
 #	include <mhash.h>
 #endif
+#ifdef HTTP_HAVE_MAGIC
+#	include <magic.h>
+#endif
 
 ZEND_EXTERN_MODULE_GLOBALS(http);
 
@@ -238,8 +241,14 @@ static inline void _http_response_object_declare_default_properties(TSRMLS_D)
 	DCL_STATIC_PROP(PROTECTED, double, throttleDelay, 0.0);
 
 #ifndef WONKY
+	DCL_CONST(long, "REDIRECT", HTTP_REDIRECT);
+	DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM);
+	DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST);
+	DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP);
+	
 	DCL_CONST(long, "ETAG_MD5", HTTP_ETAG_MD5);
 	DCL_CONST(long, "ETAG_SHA1", HTTP_ETAG_SHA1);
+	DCL_CONST(long, "ETAG_CRC32", HTTP_ETAG_CRC32);
 	
 #	ifdef HTTP_HAVE_MHASH
 	{
@@ -267,7 +276,19 @@ static void _http_grab_response_headers(void *data, void *arg TSRMLS_DC)
 
 /* ### USERLAND ### */
 
-/* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true)
+/* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
+ *
+ * Send an HTTP header.
+ * 
+ * Expects a string parameter containing the name of the header and a mixed
+ * parameter containing the value of the header, which will be converted to
+ * a string.  Additionally accepts an optional boolean parameter, which
+ * specifies whether an existing header should be replaced.  If the second
+ * parameter is unset no header with this name will be sent. 
+ * 
+ * Returns TRUE on success, or FALSE on failure.
+ * 
+ * Throws HttpHeaderException if http.only_exceptions is TRUE.
  */
 PHP_METHOD(HttpResponse, setHeader)
 {
@@ -313,6 +334,15 @@ PHP_METHOD(HttpResponse, setHeader)
 /* }}} */
 
 /* {{{ proto static mixed HttpResponse::getHeader([string name])
+ *
+ * Get header(s) about to be sent.
+ * 
+ * Accepts a string as optional parameter which specifies the name of the
+ * header to read.  If the parameter is empty or omitted, an associative array
+ * with all headers will be returned.
+ * 
+ * Returns either a string containing the value of the header matching name,
+ * FALSE on failure, or an associative array with all headers. 
  */
 PHP_METHOD(HttpResponse, getHeader)
 {
@@ -358,6 +388,10 @@ PHP_METHOD(HttpResponse, getHeader)
  *
  * NOTE: If you're using sessions, be shure that you set session.cache_limiter
  * to something more appropriate than "no-cache"!
+ * 
+ * Expects a boolean as parameter specifying whether caching should be attempted.
+ * 
+ * Returns TRUE ons success, or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setCache)
 {
@@ -374,6 +408,8 @@ PHP_METHOD(HttpResponse, setCache)
 /* {{{ proto static bool HttpResponse::getCache()
  *
  * Get current caching setting.
+ * 
+ * Returns TRUE if caching should be attempted, else FALSE.
  */
 PHP_METHOD(HttpResponse, getCache)
 {
@@ -390,6 +426,10 @@ PHP_METHOD(HttpResponse, getCache)
 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
  *
  * Enable on-thy-fly gzipping of the sent entity.
+ * 
+ * Expects a boolean as parameter indicating if GZip compression should be enabled.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setGzip)
 {
@@ -406,6 +446,8 @@ PHP_METHOD(HttpResponse, setGzip)
 /* {{{ proto static bool HttpResponse::getGzip()
  *
  * Get current gzipping setting.
+ * 
+ * Returns TRUE if GZip compression is enabled, else FALSE.
  */
 PHP_METHOD(HttpResponse, getGzip)
 {
@@ -419,10 +461,18 @@ PHP_METHOD(HttpResponse, getGzip)
 }
 /* }}} */
 
-/* {{{ proto static bool HttpResponse::setCacheControl(string control[, long max_age = 0])
+/* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0])
  *
  * Set a custom cache-control header, usually being "private" or "public";
  * The max_age parameter controls how long the cache entry is valid on the client side.
+ * 
+ * Expects a string parameter containing the primary cache control setting.
+ * Addtitionally accepts an int parameter specifying the max-age setting.
+ * 
+ * Returns TRUE on success, or FALSE if control does not match one of
+ * "public" , "private" or "no-cache".
+ * 
+ * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
  */
 PHP_METHOD(HttpResponse, setCacheControl)
 {
@@ -448,6 +498,8 @@ PHP_METHOD(HttpResponse, setCacheControl)
 /* {{{ proto static string HttpResponse::getCacheControl()
  *
  * Get current Cache-Control header setting.
+ * 
+ * Returns the current cache control setting as a string like sent in a header.
  */
 PHP_METHOD(HttpResponse, getCacheControl)
 {
@@ -464,6 +516,13 @@ PHP_METHOD(HttpResponse, getCacheControl)
 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
  *
  * Set the content-type of the sent entity.
+ * 
+ * Expects a string as parameter specifying the content type of the sent entity.
+ * 
+ * Returns TRUE on success, or FALSE if the content type does not seem to
+ * contain a primary and secondary content type part.
+ * 
+ * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
  */
 PHP_METHOD(HttpResponse, setContentType)
 {
@@ -474,11 +533,7 @@ PHP_METHOD(HttpResponse, setContentType)
 		RETURN_FALSE;
 	}
 
-	if (!strchr(ctype, '/')) {
-		http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype);
-		RETURN_FALSE;
-	}
-
+	HTTP_CHECK_CONTENT_TYPE(ctype, RETURN_FALSE);
 	RETURN_SUCCESS(UPD_STATIC_STRL(contentType, ctype, ctype_len));
 }
 /* }}} */
@@ -486,6 +541,8 @@ PHP_METHOD(HttpResponse, setContentType)
 /* {{{ proto static string HttpResponse::getContentType()
  *
  * Get current Content-Type header setting.
+ * 
+ * Returns the currently set content type as string.
  */
 PHP_METHOD(HttpResponse, getContentType)
 {
@@ -499,9 +556,19 @@ PHP_METHOD(HttpResponse, getContentType)
 }
 /* }}} */
 
-/* {{{ proto static string HttpResponse::guessContentType(string magic_file[, long magic_mode])
+/* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
  *
  * Attempts to guess the content type of supplied payload through libmagic.
+ * If the attempt is successful, the guessed content type will automatically
+ * be set as response content type.  
+ * 
+ * Expects a string parameter specifying the magic.mime database to use.
+ * Additionally accepts an optional int parameter, being flags for libmagic.
+ * 
+ * Returns the guessed content type on success, or FALSE on failure.
+ * 
+ * Throws HttpRuntimeException, HttpInvalidParamException 
+ * if http.only_exceptions is TRUE.
  */
 PHP_METHOD(HttpResponse, guessContentType)
 {
@@ -509,7 +576,10 @@ PHP_METHOD(HttpResponse, guessContentType)
 	int magic_file_len;
 	long magic_mode = 0;
 	
-	RETVAL_NULL();
+	RETVAL_FALSE;
+	
+#ifdef HTTP_HAVE_MAGIC
+	magic_mode = MAGIC_MIME;
 	
 	SET_EH_THROW_HTTP();
 	if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &magic_file, &magic_file_len, &magic_mode)) {
@@ -541,14 +611,24 @@ PHP_METHOD(HttpResponse, guessContentType)
 		}
 	}
 	SET_EH_NORMAL();
+#else
+	http_error(HE_THROW, HTTP_E_RUNTIME, "Cannot guess Content-Type; libmagic not available");
+#endif
 }
 /* }}} */
 
 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
  *
- * Set the Content-Disposition of the sent entity.  This setting aims to suggest
- * the receiveing user agent how to handle the sent entity;  usually the client
- * will show the user a "Save As..." popup.
+ * Set the Content-Disposition.  The Content-Disposition header is very useful
+ * if the data actually sent came from a file or something similar, that should
+ * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
+ *
+ * Expects a string parameter specifying the file name the "Save as..." dialogue
+ * should display.  Optionally accepts a bool parameter, which, if set to true
+ * and the user agent knows how to handle the content type, will probably not
+ * cause the popup window to be shown.
+ * 
+ * Returns TRUE on success or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setContentDisposition)
 {
@@ -570,6 +650,8 @@ PHP_METHOD(HttpResponse, setContentDisposition)
 /* {{{ proto static string HttpResponse::getContentDisposition()
  *
  * Get current Content-Disposition setting.
+ * 
+ * Returns the current content disposition as string like sent in a header.
  */
 PHP_METHOD(HttpResponse, getContentDisposition)
 {
@@ -586,6 +668,10 @@ PHP_METHOD(HttpResponse, getContentDisposition)
 /* {{{ proto static bool HttpResponse::setETag(string etag)
  *
  * Set a custom ETag.  Use this only if you know what you're doing.
+ * 
+ * Expects an unquoted string as parameter containing the ETag.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setETag)
 {
@@ -603,6 +689,8 @@ PHP_METHOD(HttpResponse, setETag)
 /* {{{ proto static string HttpResponse::getETag()
  *
  * Get calculated or previously set custom ETag.
+ * 
+ * Returns the calculated or previously set ETag as unquoted string.
  */
 PHP_METHOD(HttpResponse, getETag)
 {
@@ -616,9 +704,14 @@ PHP_METHOD(HttpResponse, getETag)
 }
 /* }}} */
 
-/* {{{ proto static bool HttpResponse::setLastModified(long timestamp)
+/* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
  *
  * Set a custom Last-Modified date.
+ * 
+ * Expects an unix timestamp as parameter representing the last modification
+ * time of the sent entity.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setLastModified)
 {
@@ -632,9 +725,11 @@ PHP_METHOD(HttpResponse, setLastModified)
 }
 /* }}} */
 
-/* {{{ proto static HttpResponse::getLastModified()
+/* {{{ proto static int HttpResponse::getLastModified()
  *
  * Get calculated or previously set custom Last-Modified date.
+ * 
+ * Returns the calculated or previously set unix timestamp.
  */
 PHP_METHOD(HttpResponse, getLastModified)
 {
@@ -650,6 +745,17 @@ PHP_METHOD(HttpResponse, getLastModified)
 
 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
  *
+ * Sets the throttle delay for use with HttpResponse::setBufferSize().
+ * 
+ * Provides a basic throttling mechanism, which will yield the current process
+ * resp. thread until the entity has been completely sent, though.
+ * 
+ * Note: This doesn't really work with the FastCGI SAPI.
+ *
+ * Expects a double parameter specifying the seconds too sleep() after
+ * each chunk sent.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setThrottleDelay)
 {
@@ -664,6 +770,9 @@ PHP_METHOD(HttpResponse, setThrottleDelay)
 
 /* {{{ proto static double HttpResponse::getThrottleDelay()
  *
+ * Get the current throttle delay.
+ * 
+ * Returns a double representing the throttle delay in seconds.
  */
 PHP_METHOD(HttpResponse, getThrottleDelay)
 {
@@ -677,8 +786,18 @@ PHP_METHOD(HttpResponse, getThrottleDelay)
 }
 /* }}} */
 
-/* {{{ proto static bool HttpResponse::setBufferSize(long bytes)
+/* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
  *
+ * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
+ * 
+ * Provides a basic throttling mechanism, which will yield the current process
+ * resp. thread until the entity has been completely sent, though.
+ * 
+ * Note: This doesn't really work with the FastCGI SAPI.
+ *
+ * Expects an int parameter representing the chunk size in bytes.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setBufferSize)
 {
@@ -691,8 +810,11 @@ PHP_METHOD(HttpResponse, setBufferSize)
 }
 /* }}} */
 
-/* {{{ proto static long HttpResponse::getBufferSize()
+/* {{{ proto static int HttpResponse::getBufferSize()
  *
+ * Get current buffer size.
+ * 
+ * Returns an int representing the current buffer size in bytes.
  */
 PHP_METHOD(HttpResponse, getBufferSize)
 {
@@ -706,12 +828,18 @@ PHP_METHOD(HttpResponse, getBufferSize)
 }
 /* }}} */
 
-/* {{{ proto static bool HttpResponse::setData(string data)
+/* {{{ proto static bool HttpResponse::setData(mixed data)
  *
  * Set the data to be sent.
+ * 
+ * Expects one parameter, which will be converted to a string and contains 
+ * the data to send.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setData)
 {
+	char *etag;
 	zval *the_data;
 
 	if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_data)) {
@@ -726,15 +854,10 @@ PHP_METHOD(HttpResponse, setData)
 		RETURN_FALSE;
 	}
 	
-	if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified))) > 0)) {
-		UPD_STATIC_PROP(long, lastModified, http_last_modified(the_data, SEND_DATA));
-	}
-	if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) {
-		char *etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA);
-		if (etag) {
-			UPD_STATIC_PROP(string, eTag, etag);
-			efree(etag);
-		}
+	UPD_STATIC_PROP(long, lastModified, http_last_modified(the_data, SEND_DATA));
+	if (etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA)) {
+		UPD_STATIC_PROP(string, eTag, etag);
+		efree(etag);
 	}
 
 	RETURN_TRUE;
@@ -744,6 +867,8 @@ PHP_METHOD(HttpResponse, setData)
 /* {{{ proto static string HttpResponse::getData()
  *
  * Get the previously set data to be sent.
+ * 
+ * Returns a string containing the previously set data to send.
  */
 PHP_METHOD(HttpResponse, getData)
 {
@@ -760,9 +885,15 @@ PHP_METHOD(HttpResponse, getData)
 /* {{{ proto static bool HttpResponse::setStream(resource stream)
  *
  * Set the resource to be sent.
+ * 
+ * Expects a resource parameter referencing an already opened stream from
+ * which the data to send will be read.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setStream)
 {
+	char *etag;
 	zval *the_stream;
 	php_stream *the_real_stream;
 	php_stream_statbuf ssb;
@@ -782,15 +913,10 @@ PHP_METHOD(HttpResponse, setStream)
 	}
 	zend_list_addref(Z_LVAL_P(the_stream));
 	
-	if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified))) > 0)) {
-		UPD_STATIC_PROP(long, lastModified, http_last_modified(the_real_stream, SEND_RSRC));
-	}
-	if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) {
-		char *etag = http_etag(the_real_stream, 0, SEND_RSRC);
-		if (etag) {
-			UPD_STATIC_PROP(string, eTag, etag);
-			efree(etag);
-		}
+	UPD_STATIC_PROP(long, lastModified, http_last_modified(the_real_stream, SEND_RSRC));
+	if (etag = http_etag(the_real_stream, 0, SEND_RSRC)) {
+		UPD_STATIC_PROP(string, eTag, etag);
+		efree(etag);
 	}
 
 	RETURN_TRUE;
@@ -800,6 +926,8 @@ PHP_METHOD(HttpResponse, setStream)
 /* {{{ proto static resource HttpResponse::getStream()
  *
  * Get the previously set resource to be sent.
+ * 
+ * Returns the previously set resource.
  */
 PHP_METHOD(HttpResponse, getStream)
 {
@@ -814,10 +942,14 @@ PHP_METHOD(HttpResponse, getStream)
 /* {{{ proto static bool HttpResponse::setFile(string file)
  *
  * Set the file to be sent.
+ * 
+ * Expects a string as parameter, specifying the path to the file to send.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_METHOD(HttpResponse, setFile)
 {
-	char *the_file;
+	char *the_file, *etag;
 	int file_len;
 	php_stream_statbuf ssb;
 
@@ -834,15 +966,10 @@ PHP_METHOD(HttpResponse, setFile)
 		RETURN_FALSE;
 	}
 
-	if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified))) > 0)) {
-		UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1));
-	}
-	if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) {
-		char *etag = http_etag(the_file, 0, -1);
-		if (etag) {
-			UPD_STATIC_PROP(string, eTag, etag);
-			efree(etag);
-		}
+	UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1));
+	if (etag = http_etag(the_file, 0, -1)) {
+		UPD_STATIC_PROP(string, eTag, etag);
+		efree(etag);
 	}
 
 	RETURN_TRUE;
@@ -852,6 +979,8 @@ PHP_METHOD(HttpResponse, setFile)
 /* {{{ proto static string HttpResponse::getFile()
  *
  * Get the previously set file to be sent.
+ * 
+ * Returns the previously set path to the file to send as string.
  */
 PHP_METHOD(HttpResponse, getFile)
 {
@@ -868,6 +997,15 @@ PHP_METHOD(HttpResponse, getFile)
 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
  *
  * Finally send the entity.
+ * 
+ * Accepts an optional boolean parameter, specifying wheter the ouput
+ * buffers should be discarded prior sending.  A successful caching attempt
+ * will cause a script termination, and write a log entry if the INI setting
+ * http.cache_log is set.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
+ * 
+ * Throws HttpHeaderException, HttpResponseException if http.onyl_excpetions is TRUE.
  *
  * Example:
  * <pre>
@@ -929,13 +1067,6 @@ PHP_METHOD(HttpResponse, send)
 		php_end_ob_buffers(0 TSRMLS_CC);
 	}
 
-	/* gzip */
-	if (zval_is_true(GET_STATIC_PROP(gzip))) {
-		php_start_ob_buffer_named("ob_gzhandler", 0, 0 TSRMLS_CC);
-	} else {
-		php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC);
-	}
-
 	/* caching */
 	if (zval_is_true(GET_STATIC_PROP(cache))) {
 		zval *cctl, *etag, *lmod;
@@ -979,29 +1110,34 @@ PHP_METHOD(HttpResponse, send)
 		HTTP_G(send).throttle_delay = Z_DVAL_P(convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay)));
 	}
 
+	/* gzip */
+	if (zval_is_true(GET_STATIC_PROP(gzip))) {
+		php_start_ob_buffer_named("ob_gzhandler", HTTP_G(send).buffer_size, 0 TSRMLS_CC);
+	} else {
+		php_start_ob_buffer(NULL, HTTP_G(send).buffer_size, 0 TSRMLS_CC);
+	}
+
 	/* send */
+	switch (Z_LVAL_P(GET_STATIC_PROP(mode)))
 	{
-		switch (Z_LVAL_P(GET_STATIC_PROP(mode)))
+		case SEND_DATA:
 		{
-			case SEND_DATA:
-			{
-				zval *zdata = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(data));
-				RETURN_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata), 1));
-			}
+			zval *zdata = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(data));
+			RETURN_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata), 1));
+		}
 
-			case SEND_RSRC:
-			{
-				php_stream *the_real_stream;
-				zval *the_stream = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream));
-				the_stream->type = IS_RESOURCE;
-				php_stream_from_zval(the_real_stream, &the_stream);
-				RETURN_SUCCESS(http_send_stream_ex(the_real_stream, 0, 1));
-			}
+		case SEND_RSRC:
+		{
+			php_stream *the_real_stream;
+			zval *the_stream = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream));
+			the_stream->type = IS_RESOURCE;
+			php_stream_from_zval(the_real_stream, &the_stream);
+			RETURN_SUCCESS(http_send_stream_ex(the_real_stream, 0, 1));
+		}
 
-			default:
-			{
-				RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file))), 1));
-			}
+		default:
+		{
+			RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file))), 1));
 		}
 	}
 }
@@ -1027,7 +1163,7 @@ PHP_METHOD(HttpResponse, capture)
 	UPD_STATIC_PROP(long, catch, 1);
 
 	php_end_ob_buffers(0 TSRMLS_CC);
-	php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC);
+	php_start_ob_buffer(NULL, 40960, 0 TSRMLS_CC);
 
 	/* register shutdown function */
 	{