level * * $_Encode = new Conteg( * array( * 'noprint' => TRUE * )); // <==== line 3 replacement * ... * echo "Page Compression: ". * (( $_Encode->negotiateEncoding()) * ? _GZIP_ENCODE_STAT. "% at level " ._GZIP_ENCODE_LEVEL * : "None (Browser does not accept)" * ); * ... * $_Encode->show(); * * www.modem-help.com shows typical values of +70% at level 8/9 * (reduction to one third of original size), with some pages better * than 80% (reduction to one fifth). On admin-edit pages (masses of * duplicated drop-down boxes) reductions exceed 90%. Wow! * The routine takes < 0.002 secs on a twin Xeon 2.4 GHz, Linux 2.6. * * - added by AK 20 Mar 04 */ // -------------- Start of Global Defines ----------------- define( '_GZIP_ENCODE_STAT', '__COMPRESSION__' ); define( '_GZIP_ENCODE_LEVEL', '__COMPRESSION_LEVEL__' ); // -------------- End of Global Defines ------------------- // -------------- Start of Class Declaration -------------- class Conteg { // public variables // Response/Request-Header variables var $accept = array(); // 1.0 sec D.2.1; 1.1 sec 14.1 (request header) var $accept_charset = array(); // 1.0 sec D.2.2; 1.1 sec 14.2 (request header) var $accept_encoding = array(); // 1.0 sec D.2.3; 1.1 sec 14.3 (request header) var $accept_language = array(); // 1.0 sec D.2.4; 1.1 sec 14.4 (request header) var $browserAgent; // string var $browserOS; // string var $browserVersion; // string var $content_type = ''; // 1.0 sec 10.5; 1.1 sec 14.17 (response header) var $content_lang = ''; // 1.0 sec D.2.5; 1.1 sec 14.12 (response header) var $etag = ''; // 1.1 rfc2616-sec14.html#sec14.19 (response header) var $expires; // timestamp; 1.0 rfc1945.txt section 10.7 (response header) var $if_match = array(); // 1.1 rfc2616-sec14.html#sec14.24 (request header) var $if_modified_since = ''; // timestamp; 1.0 rfc1945.txt section 10.9 (request header) var $if_none_match = array(); // 1.1 rfc2616-sec14.html#sec14.26 (request header) var $if_match = array(); // 1.1 rfc2616-sec14.html#sec14.24 (request header) var $if_range = ''; // timestamp/string; 1.1 sec14.html#sec14.27 (request header) var $if_unmodified_since = ''; // timestamp; 1.1 sec14.html#sec14.28 (request header) var $last_modified; // timestamp; 1.0 rfc1945.txt section 10.10 (response header) var $method = ''; // GET, POST, HEAD var $now = ''; // timestamp var $protocol = ''; // HTTP/1.1 or HTTP/1.0 var $range = array(); // 1.1 rfc2616-sec14.html#sec14.35 (request header) var $vary = ''; // 1.1 rfc2616-sec14.html#sec14.44 (response header) var $user_agent = ''; // 1.1 rfc2616-sec14.html#sec14.43 (request header) // compress variables - set by prog processing var $data; // the un-compressed content var $encoding; // string; the actual data encoding to apply var $gzdata; // the compressed content var $gzsize; // bytes; size of the compressed content var $level; // Compression level (0-9) var $search = array(); // item(s) to replace before compression var $size; // bytes; size of the uncompressed content var $stat; // compression percentage (0-100, 0==none) var $replace = array(); // replace $search item(s) // private variables var $_charset; // string; doc charset; applied to $content_type if http/1.1 var $_contentType; // string; if !http/1.1 is === $content_type var $_encodings = array(); // string; data encoding(s) on the menu var $_error = ''; // string; contents of internal error message var $_inputNote; // string; Apache-Note name for deflate Input Note var $_is304 = FALSE; // TRUE/FALSE Not Modified rfc2616-sec10.html#sec10.3.5 var $_is406 = FALSE; // TRUE/FALSE Not Acceptable rfc2616-sec10.html#sec10.4.7 var $_is412 = FALSE; // TRUE/FALSE Precondition Failed rfc2616-sec10.html#sec10.4.13 var $_isWeakETag; // TRUE/FALSE 1.1 rfc2616-sec3.html#sec3.11 var $_isExtETag = FALSE; // TRUE/FALSE ETag obtained from outside Class var $_outputNote; // string; Apache-Note name for deflate Output Note var $_noAccept; // TRUE/FALSE (negotiate according to Accept header) var $_noAcceptCharset; // TRUE/FALSE (negotiate according to Accept-Charset header) var $_noAcceptEncode; // TRUE/FALSE (negotiate according to Accept-Encoding header) var $_noAcceptLang; // TRUE/FALSE (negotiate according to Accept-Language header) var $_noAcceptRanges; // TRUE/FALSE (negotiate according to Range, If-Range header) var $_noContentType; // TRUE/FALSE (use Content-Type Response header) var $_noContentLang; // TRUE/FALSE (use Content-Language Response header) var $_noETag; // TRUE/FALSE (use ETags) var $_noNotes; // TRUE/FALSE (use Apache Notes) var $_noPrint; // TRUE/FALSE (print immediate on declaration) var $_noSearch; // TRUE/FALSE (use global search/replace) var $_port = ''; // string; server-port, ref: $etag var $_preferOrder = array(); // array; array of int => value pairs for IM, IMS, etc. var $_query = ''; // string; ref: $etag var $_ratioNote; // string; Apache-Note name for deflate Ratio Note var $_scriptName = ''; // string; ref: $etag var $_SERVER_ARRAY; // string; used in _initRequest() var $_SESSION_ARRAY = '_SESSION'; // string; used in _initRequest() var $_session = ''; // string; ref: $etag var $_version = '0.10'; // Version of the Conteg class /* * Conteg constructor - initialises the Class * * parameter: $param = array() - array of key => value pairs * (see setup() for details) */ function Conteg( $param = array() ) { // sanity check if( ob_get_length() === FALSE ) { ob_start(); $this->_trigger_error( 'Conteg::Conteg: output buffering switched OFF; any output before this point will trigger errors when headers are sent.', E_USER_NOTICE ); } // clear to go; init Class variables $this->now = time(); $this->setup( $param ); $this->_initRequest(); if( $this->_noPrint == TRUE ) return; else $this->show(); } // Conteg::Conteg() /* * charsetAccepted() - Whether a charset is acceptable or not. * * parameter: $mediaType; default: $_charset * * Returns TRUE/FALSE (charset not acceptable) */ function charsetAccepted( $charset = array() ) { if( empty( $charset ) and empty( $this->_charset )) return $this->_trigger_error( 'Conteg::charsetAccepted(): Supplied charset and Class charset both empty.', E_USER_WARNING ); elseif( empty( $this->accept_charset )) return $this->_trigger_error( 'Conteg::charsetAccepted(): Request charset(s) empty, cannot compare.', E_USER_NOTICE ); else if( empty( $charset )) $charset = array( $this->_charset ); if( isset( $this->accept_charset[ '*' ]) and ( $this->accept_charset[ '*' ] > 0 )) return TRUE; else foreach( $charset AS $val ) { $val = strtoupper( $val ); if( isset( $this->accept_charset[ $val ]) and ( $this->accept_charset[ $val ] > 0 )) return TRUE; } return FALSE; // no acceptable charset found } // Conteg::charsetAccepted() /* * compress() - encode the current contents * * Returns: TRUE or FALSE (problem obtaining ob_contents or $data empty) */ function compress( $refresh = TRUE // (TRUE/FALSE) refresh $data/reuse existing $data ) { // sanity checks if( $refresh ) { if(( $this->data = ob_get_contents()) === FALSE ) return $this->_trigger_error( 'Conteg::compress(): No ob_contents to compress.', E_USER_ERROR ); } else if( empty( $this->data )) return $this->_trigger_error( 'Conteg::compress(): No $data contents to compress.', E_USER_NOTICE ); $encoding = ( empty( $this->encoding )) ? 'identity' : (( strlen( $this->data ) > 1000 ) ? $this->encoding : 'identity' // not worth the effort ); // clear to go; init compression variables $this->size = strlen( $this->data ); switch( $encoding ) { case 'gzip': // see http://www.faqs.org/rfcs/rfc1952 case 'x-gzip': if( version_compare( PHP_VERSION, '4.2', '>=' )) { $this->gzdata = gzencode( $this->data, $this->level, FORCE_GZIP ); } else { // effective kludge for php < 4.2 (no level parameter) $crc = crc32( $this->data ); $this->gzdata = "\x1f\x8b\x08\x00\x00\x00\x00\x00". // gzip header gzcompress( $this->data, $this->level ); $this->gzdata = substr( $this->gzdata, 0, -4 ). // fix crc bug pack( 'V', $crc ) . pack( 'V', $this->size ); } $this->gzsize = strlen( $this->gzdata ); $this->stat = round(( 1 - ( $this->gzsize / $this->size )) * 100 ); break; case 'deflate': // see http://www.faqs.org/rfcs/rfc1951 $this->gzdata = gzdeflate( $this->data, $this->level ); $this->gzsize = strlen( $this->gzdata ); $this->stat = round(( 1 - ( $this->gzsize / $this->size )) * 100 ); break; case 'compress': // see http://www.faqs.org/rfcs/rfc1950 case 'x-compress': $this->gzdata = gzcompress( $this->data, $this->level ); $this->gzsize = strlen( $this->gzdata ); $this->stat = round(( 1 - ( $this->gzsize / $this->size )) * 100 ); break; case 'identity': default: $this->crc = NULL; $this->gzdata = ''; $this->gzsize = $this->size; $this->stat = '(none)'; $this->encoding = 'identity'; } // switch( $encoding ) return TRUE; } // Conteg::compress() /* * getAccept() - For external negotiation on media-type. * * Returns array ($accept). */ function getAccept() { // note: double arsort returns array to Request order return arsort( $this->accept ); } /* * getAcceptCharset() - For external negotiation on charset. * * Returns array ($accept_charset). */ function getAcceptCharset() { // note: double arsort returns array to Request order return arsort( $this->accept_charset ); } /* * getAcceptLang() - For external negotiation on language. * * Returns array ($accept_charset). */ function getAcceptLang() { // note: double arsort returns array to Request order return arsort( $this->accept_language ); } /* * getCompLevel() - The level of compression we should use. * * Returns an int between 0 and 9 inclusive. * * Help: if you use an OS other then linux please send the *+ code to make this work with your OS - Thanks */ function getCompLevel() { $uname = posix_uname(); switch ( $uname[ 'sysname' ]) { case 'Linux': $cl = ( 1 - $this->_loadAvgLinux()) * 10; $level = ( int ) max( min( 9, $cl ), 0 ); break; case 'FreeBSD': $cl = ( 1 - $this->_loadAvgFreeBSD()) * 10; $level = ( int ) max( min( 9, $cl ), 0 ); break; default: $level = 3; break; } return $level; } // Conteg::getCompLevel() /* * getSize() - The size of the (un/)compressed data. * * Returns $gzsize (same as $size when not compressed)/FALSE */ function getSize() { return ( $this->gzsize ) ? $this->gzsize : FALSE; } /* * isError() - return $_error/FALSE */ function isError() { return ( $this->_error != '' ) ? $this->_error : FALSE; } /* * mediaTypeAccepted() - Whether a media-type is acceptable or not. * * parameter: $mediaType; default: $_contentType * * Returns TRUE/FALSE (media-type not acceptable) (eg text/html) */ function mediaTypeAccepted( $mediaType = array() ) { if( empty( $mediaType ) and empty( $this->_contentType )) return $this->_trigger_error( 'Conteg::mediaTypeAccepted(): Supplied media-type and Class _contentType both empty.', E_USER_WARNING ); elseif( empty( $this->accept )) return $this->_trigger_error( 'Conteg::mediaTypeAccepted(): Request media-type(s) empty, cannot compare.', E_USER_NOTICE ); else if( empty( $mediaType )) $mediaType = array( $this->_contentType ); if( isset( $this->accept_charset[ '*/*' ]) and ( $this->accept_charset[ '*/*' ] > 0 )) return TRUE; else foreach( $mediaType AS $val ) { if( isset( $this->accept[ $val ]) and ( $this->accept[ $val ] > 0 )) return TRUE; if(( $p = strpos( $val, '/' )) !== FALSE ) $t = substr( $val, 0, $p ) .'/*'; if( isset( $this->accept[ $t ]) and ( $this->accept[ $t ] > 0 )) return TRUE; } return FALSE; // no acceptable media-type found } // Conteg::mediaTypeAccepted() /* * negotiateEncoding() - Negotiate acceptable encoding(s) * * parameter: $encoding: array of acceptable encodings; choose from: * gzip, compress, deflate, identity * see rfc2616-sec3.html#sec3.5 * http/1.0: x-gzip, x-compress * default: $_encodings or ALL encodings * * Returns array of accepted encodings/FALSE (none supplied acceptable) */ function negotiateEncoding( $encoding = array() ) { if( empty( $this->accept_encoding )) return $this->_trigger_error( 'Conteg::negotiateEncoding(): Request encoding(s) empty, cannot compare.', E_USER_NOTICE ); elseif( empty( $encoding ) and empty( $this->_encodings )) { $encoding = ( $this->protocol == 'HTTP/1.1' ) ? array( 'gzip', 'compress', 'deflate' ) : array( 'x-gzip', 'x-compress' ); } else if( empty( $encoding )) $encoding = $this->_encodings; foreach( $this->accept_encoding AS $key => $val ) { if( in_array( $key, $encoding )) { // check for media-type + browser bugs switch( $key ) { case 'gzip': case 'x-gzip': case 'compress': case 'x-compress': case 'deflate': if( empty( $this->_contentType )) { // Care! cannot check every possible content-type if(( $magic = ob_get_contents()) === FALSE ) { break; // in fact, cannot check any, so safety-first } else $magic = substr( $magic, 0, 4 ); if( substr( $magic, 0, 2 ) === '^_' ) break; // gzip data elseif( substr( $magic, 0, 3 ) === 'GIF' ) break; // gif images elseif( substr( $magic, 0, 2 ) === "\xFF\xD8" ) break; // jpeg images elseif( substr( $magic, 0, 4 ) === "\x89PNG" ) break; // png images elseif( substr( $magic, 0, 2 ) === 'PK' ) break; // pk zip file elseif( substr( $magic, 0, 3 ) === 'FWS' ) { // Shockwave Flash if(( !empty( $this->browserOS )) and ( $this->browserOS == 'Win' )) { // Flash on windows incorrectly claims to accept gzip'd content. $v = 'User-Agent'; $this->vary .= ( empty( $this->vary )) ? $v : (( strpos( $this->vary, $v ) === FALSE ) ? ",$v" : '' ); break; } // assume text beyond this point } elseif(( !empty( $this->browserAgent )) and ( !empty( $this->browserVersion ))) { $v = 'User-Agent'; $this->vary .= ( empty( $this->vary )) ? $v : (( strpos( $this->vary, $v ) === FALSE ) ? ",$v" : '' ); // see schroepl.net/projekte/mod_gzip/browser.htm if(( $this->browserAgent == 'MOZILLA' ) and ereg( '^([0-9])\.([0-9]{1,2})', $this->browserVersion, $match )) { // Netscape 4.x has problems but does not know it if( $match[ 1 ] == '4' ) break; } } } else { // if( empty( $this->_contentType )) switch( $this->_contentType ) { // see ietf.org/rfc/rfc1521.txt case 'text/html': case 'text/plain': case 'text/css': case 'text/xml': case 'application/xml': case 'application/xhtml+xml': case 'application/rss+xml': if(( empty( $this->browserAgent )) or ( empty( $this->browserVersion ))) { // trust that they know what they are doing } else { $v = 'User-Agent'; $this->vary .= ( empty( $this->vary )) ? $v : (( strpos( $this->vary, $v ) === FALSE ) ? ",$v" : '' ); // see schroepl.net/projekte/mod_gzip/browser.htm if(( $this->browserAgent == 'MOZILLA' ) and ereg( '^([0-9])\.([0-9]{1,2})', $this->browserVersion, $match )) { if( $match[ 1 ] == '4' ) { // Netscape 4.x has problems but does not know it if( ereg( '0[678]', $match[ 2 ])) { // 4.06-4.08? forget it break 2; } else if( $this->_contentType != 'text/html' ) break 2; } } // end Netscape 4.x check if(( !empty( $this->browserOS )) and ( $this->browserOS == 'Mac' )) { if(( $this->browserAgent == 'IE' ) and ereg( '^([0-9])', $this->browserVersion, $match )) { if( $match[ 1 ] <= '5' ) { // reported php manual gzcompress.php break 2; } } } } // end browser-check break; case 'application/octet-stream': // a few examples... case 'audio/basic': case 'image/gif': case 'image/jpeg': case 'image/png': case 'video/mpeg': default: // ...all designated not to be encoded break 2; } // switch( $this->_contentType ) } // if( empty( $this->_contentType )) else case 'identity': default: $accepted[ $key ] = $this->accept_encoding[ $key ]; } // switch( $key ) } // if( in_array( $key, $encoding )) } // foreach( $encoding AS $key => $val ) if( isset( $accepted )) { arsort( $accepted ); // note: double arsort returns array to Request order return $accepted; } else return FALSE; // no acceptable encoding found */ } // Conteg::negotiateEncoding() /* * setup() - Sets certain Class variables according to supplied array * Note: this can be called many times, but after the first * call (Constructor) most empty values are ignored. * * parameter: $param = array() - array of key => value pairs * * No immediate output Switch (TRUE, FALSE): 'noprint' => FALSE * TRUE: No auto-output on instantiation; allows external negotiation, * +debugging, ... * +Affects constructor ONLY. * FALSE: (default) Print immediately. * * Modification (Unix timestamp): 'modified' => NULL * TimeStamp: Sets `Last-Modified' header to this value (no checking). * (empty): (default) Sets `Last-Modified' header to current time. * * Expiry (int, seconds): 'expiry' => 3600 * int: Sets `Expiry' header to current time + this value (no checking). * (empty): (default) Sets `Expiry' header to current time + 1 hour. * * Use-ETag Switch (TRUE, FALSE): 'use_etag' => FALSE * TRUE: Sets `$_noETag' to FALSE * FALSE: (default) Sets `$_noETag' to TRUE (do not use ETags) * * External ETag (string/empty): 'etag' => '' * string: Sets `$etag' to the given value + `$_noETag' to FALSE * +$_isExtETag to TRUE; important to set 'weak_etag' correctly * (empty): (default) No change * * Weak ETags (TRUE, FALSE): 'weak_etag' => TRUE * TRUE: (default) Sets `$_isWeakETag' to TRUE * +Also important for Accept-Ranges (below). * FALSE: Sets `$_isWeakETag' to FALSE * * Search + Replace Switch (FALSE, not-set, filled-array): 'search' => array() * ARRAY: format: array( $search_item => $replace_item, ... ) * +Used to do global search/replace on page contents. * not-set (default) Use stats search + replace only; * +Search: `_GZIP_ENCODE_STAT'; replace: compression % (0-100), * +Search: `_GZIP_ENCODE_LEVEL'; replace: compression level (off, 0-9). * FALSE: Do not use any search/replace. * * Apache-Notes Switch (TRUE, FALSE): 'use_apache_notes' => FALSE * TRUE: Apache-Notes are available, and will be set. * +Used to log compression values within Apache logfiles * FALSE: (default) Do not use Apache-Notes to log compression values. * (do please send the means to set for other web-servers) * * Apache-Notes Input: (string): 'input' => 'instream' * string: The Apache-Note name for input-bytes is set to this value * +The name used within httpd.conf for the Deflate Input Note * EMPTY: (default) $_inputNote is set to 'instream' * * Apache-Notes Output: (string): 'output' => 'outstream' * string: The Apache-Note name for output-bytes is set to this value * +The name used within httpd.conf for the Deflate Output Note * EMPTY: (default) $_outputNote is set to 'outstream' * * Apache-Notes Ratio: (string): 'ratio' => 'ratio' * string: The Apache-Note name for compression ratio is set to this value * +The name used within httpd.conf for the Deflate Ratio Note * EMPTY: (default) $_ratioNote is set to 'ratio' * * Use Content-Type Switch: (TRUE/FALSE): 'use_content_type' => TRUE * TRUE: (default) Use a Content-Type Response header for the page * +(need then also to set the Content Type + charset, below) * FALSE: Do not use a Content-Type header for the page * * Character Set: (string, http/1.1 only): 'charset' => 'ISO-8859-1' * string: The document charset; see also Content Type * +See rfc2616-sec3.html#sec3.7 + rfc2616-sec14.html#sec14.17 * EMPTY: (default) $_charset is set to 'ISO-8859-1' * * Content Encodings: (array): 'encodings' => array( 'gzip', ... ) * array : Possible encodings to use in addition to 'identity' * +See rfc2616-sec3.html#sec3.5 * EMPTY: (default) $_encodings set to array( 'gzip','deflate','compress' ) * * Content Type: (string): 'type' => 'text/html' * string: The media-type for the Content-Type header; see also Character Set * +See rfc2616-sec3.html#sec3.7 + rfc2616-sec3.html#sec3.10 * EMPTY: (default) $_contentType is set to 'text/html' * * Use Content-Language Switch: (TRUE/FALSE): 'use_content_lang' => TRUE * TRUE: (default) Use a Content-Language Response header for the page * +(need then also to set the lang, below) * FALSE: Do not use a Content-Language header for the page * * Language: (string): 'lang' => 'en' * string: The document language * +See rfc2616-sec14.html#sec14.12 + rfc2616-sec14.html#sec14.17 * EMPTY: (default) $content_lang is set to 'en' * * Content Negotiation; Use Accept Switch: (TRUE/FALSE): 'use_accept' => FALSE * TRUE: (default) Respond to Accept (media) Request headers * +See rfc2616-sec14.html#sec14.1; see also 'type' above * FALSE: Do not respond to Accept Request headers * * Content Negotiation; Use Accept-Charset Switch: (TRUE/FALSE): 'use_accept_charset' => FALSE * TRUE: (default) Respond to Accept-Charset Request headers * +See rfc2616-sec14.html#sec14.2; see also Character Set * FALSE: Do not respond to Accept-Charset Request headers * * Content Negotiation; Use Accept-Encoding Switch: (TRUE, FALSE, 0-9): 'use_accept_encode' => TRUE * Note: This is the only content negotiated INSIDE the Class. * FALSE: No attempt at compression * 0: No compression (still encodes as gzip-ed) * 1: Min compression * ... Some compression (integer from 1 to 9) * 9: Max compression * TRUE: (default) Dynamic, load-balanced compression; * +the higher the system load, the lower the compression. * * Content Negotiation; Use Accept-Language Switch: (TRUE/FALSE): 'use_accept_lang' => FALSE * TRUE: Respond to Accept-Language Request headers * +See rfc2616-sec14.html#sec14.4 * FALSE: (default) Do not vary response by Accept-Language headers * * Content Negotiation; Use Accept-Ranges Switch: (TRUE/FALSE): 'use_accept_ranges' => FALSE * TRUE: Respond to Accept-Ranges Request headers * +See rfc2616-sec14.html#sec14.5 * +Note: use of weak ETags will switch this to FALSE; $if_range may * +be a mod-date, which is dodgy if the current page/file is not byte- * +by-byte compatible, and this is decided by the 'weak_etag' switch. * FALSE: (default) Do not vary response by Accept-Ranges headers * * Request Header Preference-order (empty, filled-array): 'prefer' => array() * ARRAY: format: array( 'Request_Header_Code1', Request_Header_Code2, ... ) * +Request headers are preferred in the order given. * EMPTY (default) See code for the preference-order. * * returns TRUE/FALSE (error) * * - added 02 Sep 05 -AK */ function setup( $param = array() // format: array( $switch => $value, ... ) ) { if( $this->isError()) return FALSE; // need to examine $_error // print-on-declaration switch // No output during Class constructor if( !isset( $this->_noPrint )) { // apply defaults on first call only if( !isset( $param[ 'noprint' ])) $param[ 'noprint' ] = FALSE; } if( isset( $param[ 'noprint' ])) $this->_noPrint = ( bool ) $param[ 'noprint' ]; // Essentials - Modification + Expiry // Modification date - Unix timestamp if( !isset( $this->last_modified )) { // apply defaults on first call only if( empty( $param[ 'modified' ])) $param[ 'modified' ] = $this->now; } if( isset( $param[ 'modified' ])) $this->last_modified = $param[ 'modified' ]; // Expiry time - seconds if( !isset( $this->expires )) { // apply defaults on first call only if( !isset( $param[ 'expires' ])) $param[ 'expiry' ] = 3600; } if( isset( $param[ 'expiry' ])) $this->expires = $this->now + $param[ 'expiry' ]; // http/1.1 - ETags // Use ETags if( !isset( $this->_noETag )) { // apply defaults on first call only if( !isset( $param[ 'use_etag' ])) $param[ 'use_etag' ] = FALSE; } if( isset( $param[ 'use_etag' ])) $this->_noETag = !$param[ 'use_etag' ]; // Use Weak ETags (academic unless $this->_noETag == FALSE) if( !isset( $this->_isWeakETag )) { // apply defaults on first call only if( !isset( $param[ 'weak_etag' ])) $param[ 'weak_etag' ] = TRUE; } if( isset( $param[ 'weak_etag' ])) $this->_isWeakETag = ( bool ) $param[ 'weak_etag' ]; // ETag - set from outside Class (make sure is unique) if( !empty( $param[ 'etag' ])) { $this->etag = $param[ 'etag' ]; $this->_isExtETag = TRUE; $this->_noETag = FALSE; } // Apache-Notes compression-logging // Use Apache-Notes if( !isset( $this->_noNotes )) { // apply defaults on first call only if( !isset( $param[ 'use_apache_notes' ])) $param[ 'use_apache_notes' ] = FALSE; if( !isset( $param[ 'input' ])) $param[ 'input' ] = 'instream'; if( !isset( $param[ 'output' ])) $param[ 'output' ] = 'outstream'; if( !isset( $param[ 'ratio' ])) $param[ 'ratio' ] = 'ratio'; } if( isset( $param[ 'use_apache_notes' ])) $this->_noNotes = !$param[ 'use_apache_notes' ]; if( isset( $param[ 'input' ])) $this->_inputNote = $param[ 'input' ]; if( isset( $param[ 'output' ])) $this->_outputNote = $param[ 'output' ]; if( isset( $param[ 'ratio' ])) $this->_ratioNote = $param[ 'ratio' ]; // Content Negotiation; the actual negotiation occurs outside this Class // Accept Request header; academic unless 'type' is also set // Content-Type Response header; academic unless 'type' is also set if( !isset( $this->_noAccept )) { // apply defaults on first call only if( !isset( $param[ 'use_accept' ])) $param[ 'use_accept' ] = FALSE; if( !isset( $param[ 'charset' ])) $param[ 'charset' ] = 'ISO-8859-1'; if( !isset( $param[ 'type' ])) $param[ 'type' ] = 'text/html'; if( !isset( $param[ 'use_content_type' ])) $param[ 'use_content_type' ] = TRUE; } if( isset( $param[ 'use_accept' ])) $this->_noAccept = !$param[ 'use_accept' ]; if( isset( $param[ 'charset' ])) $this->_charset = $param[ 'charset' ]; if( isset( $param[ 'type' ])) $this->_contentType = $param[ 'type' ]; if( isset( $param[ 'use_content_type' ])) $this->_noContentType = !$param[ 'use_content_type' ]; // Accept-Charset Request header; academic unless 'charset' is also set if( !isset( $this->_noAcceptCharset )) { // apply defaults on first call only if( !isset( $param[ 'use_accept_charset' ])) $param[ 'use_accept_charset' ] = FALSE; } if( isset( $param[ 'use_accept_charset' ])) $this->_noAcceptCharset = !$param[ 'use_accept_charset' ]; // Accept-Encoding Request header (Compression) if( !isset( $this->_noAcceptEncode )) { // apply defaults on first call only if( !isset( $param[ 'use_accept_encode' ])) $param[ 'use_accept_encode' ] = TRUE; if( !isset( $param[ 'encodings' ])) $param[ 'encodings' ] = array( 'gzip', 'deflate', 'compress', 'x-gzip', 'x-compress' ); } if( isset( $param[ 'encodings' ])) $this->_encodings = $param[ 'encodings' ]; if( isset( $param[ 'use_accept_encode' ])) { // FALSE, 0-9 or TRUE if( $param[ 'use_accept_encode' ] === FALSE ) { // no compression attempt $this->_noAcceptEncode = TRUE; $this->level = 0; } else { // sanity checks if( !extension_loaded( 'zlib' )) { $this->_noAcceptEncode = TRUE; $this->level = 0; $this->_trigger_error( 'Conteg::setup: zlib required for compression.', E_USER_NOTICE ); } elseif( ini_get( 'zlib.output_compression' ) != '' ) { // compression handled externally $this->_noAcceptEncode = TRUE; $this->level = 0; $this->_trigger_error( 'Conteg::setup: zlib.output_compression activated.', E_USER_NOTICE ); } elseif( ini_get( 'output_handler' ) == 'ob_gzhandler' ) { // compression handled externally $this->_noAcceptEncode = TRUE; $this->level = 0; $this->_trigger_error( 'Conteg::setup: ob_gzhandler() registered.', E_USER_NOTICE ); } elseif( !function_exists( 'crc32' )) { $this->_noAcceptEncode = TRUE; $this->level = 0; $this->_trigger_error( 'Conteg::setup: crc32() not found, PHP >= 4.0.1 required.', E_USER_NOTICE ); } else { $this->_noAcceptEncode = FALSE; if(( $this->level = $param[ 'use_accept_encode' ]) === TRUE ) $this->level = $this->getCompLevel(); // load-balanced compression } } } // Accept-Language Request header; this ONLY sets the Vary: Response header // Content-Language Response header; academic unless 'lang' is also set (consistency) if( !isset( $this->_noAcceptLang )) { // apply defaults on first call only if( !isset( $param[ 'use_accept_lang' ])) $param[ 'use_accept_lang' ] = FALSE; if( !isset( $param[ 'use_content_lang' ])) $param[ 'use_content_lang' ] = TRUE; if( !isset( $param[ 'lang' ])) $param[ 'lang' ] = 'en'; } if( isset( $param[ 'use_accept_lang' ])) $this->_noAcceptLang = !$param[ 'use_accept_lang' ]; if( isset( $param[ 'use_content_lang' ])) $this->_noContentLang = !$param[ 'use_content_lang' ]; if( isset( $param[ 'lang' ])) $this->content_lang = $param[ 'lang' ]; // Accept-Ranges Request header if( !isset( $this->_noAcceptRanges )) { // apply defaults on first call only if( !isset( $param[ 'use_accept_ranges' ])) $param[ 'use_accept_ranges' ] = FALSE; } if( isset( $param[ 'use_accept_ranges' ])) $this->_noAcceptRanges = !$param[ 'use_accept_ranges' ]; if( $this->_isWeakETag ) $this->_noAcceptRanges = TRUE; // Request Header oddity // Preference-order; later is lesser; make sure all exist! if( !isset( $this->_preferOrder )) { // apply defaults on first call only if( !isset( $param[ 'prefer' ])) $param[ 'prefer' ] = array( 'IM', // if_match 'INM', // if_none_match 'IMS', // if_modified_since 'IUS' // if_unmodified_since ); } if( !empty( $param[ 'prefer' ])) $this->_preferOrder = $param[ 'prefer' ]; // Global page search/replace if( !isset( $this->_noSearch )) { // apply defaults on first call only if( !isset( $param[ 'search' ])) $param[ 'search' ] = array( _GZIP_ENCODE_STAT => '(filled in later)', _GZIP_ENCODE_LEVEL => (( $this->_noAcceptEncode == TRUE ) ? '(off)' : $this->level ) ); } if( isset( $param[ 'search' ])) { if( $param[ 'search' ] === FALSE ) { $this->_noSearch = TRUE; } else { $this->_noSearch = FALSE; if( $this->setSearch( $param[ 'search' ]) == FALSE ) return FALSE; } } return TRUE; } // Conteg::setup() /* * setSearch() - Sets $search + $replace; used for stats reporting, etc. * * returns TRUE/FALSE (error) */ function setSearch( $replace = array() // format: array( $search_item => $replace_item, ... ) ) { if( $this->isError()) return FALSE; elseif( empty( $replace )) { $this->search = $this->replace = array(); $this->_noSearch = TRUE; } else { foreach( $replace as $s => $r ) { $this->search[] = $s; $this->replace[] = $r; } $this->search = array_unique( $this->search ); $this->replace = array_unique( $this->replace ); // paranoia programming if( count( $this->search ) != count( $this->replace )) { $this->search = $this->replace = array(); $this->_noSearch = TRUE; return $this->_trigger_error( 'Conteg::setSearch(): Search + Replace do not balance.', E_USER_NOTICE ); } else $this->_noSearch = FALSE; }; return TRUE; } // Conteg::setSearch() /* * show() - Displays the page * * returns TRUE/FALSE (error) */ function show( $refresh = FALSE // ( TRUE ) force-refresh $data; (FALSE) reuse existing $data ) { // sanity warnings if( headers_sent()) { return $this->_trigger_error( 'Conteg::show(): Cannot print; headers already sent.', E_USER_WARNING ); } else if( $this->isError()) return FALSE; $this->_initResponse(); // common HTTP/1.x Response headers if( !empty( $this->last_modified )) header( 'Last-Modified: '. gmdate( 'D, d M Y H:i:s \G\M\T', $this->last_modified )); if( !empty( $this->expires )) header( 'Expires: '. gmdate( 'D, d M Y H:i:s \G\M\T', $this->expires )); if( !empty( $this->content_type )) header( 'Content-Type: '. $this->content_type ); if( !empty( $this->content_lang )) header( 'Content-Language: '. $this->content_lang ); // common HTTP/1.1 Response headers if( !empty( $this->vary )) header( 'Vary: '. $this->vary ); if(( $this->_noETag == FALSE ) and ( !empty( $this->etag ))) header( 'ETag: '. $this->etag ); if( $this->_noAcceptRanges == FALSE ) header( 'Accept-Ranges: bytes' ); if( $this->_is304 or $this->_is406 or $this->_is412 ) { // can avoid sending the data...? ob_end_clean(); if( $this->_is304 ) { header((( $this->protocol == 'HTTP/1.1' ) ? 'HTTP/1.1' : 'HTTP/1.0' ) .' 304 Not Modified' ); header( 'Content-Length: 0' ); // my server sending a mysterious 20 bytes body (?) } elseif( $this->_is406 ) { header( 'HTTP/1.1 406 Not Acceptable' ); header( 'Cache-Control: private, max-age=0, must-revalidate' ); if( $this->method != 'HEAD' ) { header( 'Content-Type: text/plain' ); // last header wins echo "HTTP/1.1 Error 406 Not Acceptable:\n\nAvailable server charsets and/or media-type not acceptable to client.\n". (( $this->_contentType ) ? "Media-Type: $this->_contentType\n" : '' ). (( $this->_charset ) ? "Charset: $this->_charset\n" : '' ); } } else { header( 'HTTP/1.1 412 Precondition Failed' ); header( 'Cache-Control: private, max-age=0, must-revalidate' ); if( $this->method != 'HEAD' ) { header( 'Content-Type: text/plain' ); // last header wins echo "HTTP/1.1 Error 412 Precondition Failed: Precondition request failed positive evaluation\n"; } } } else { // ...no? oh, OK, go ahead and send it then if(( $this->_noSearch == FALSE )) { // search + replace if(( $key = array_search( _GZIP_ENCODE_STAT, $this->search )) !== FALSE ) { // compression is run twice to get compression stats; run #1 if( $this->compress() == FALSE ) return FALSE; // error triggered $this->replace[ $key ] = $this->stat; // compression stats on page $refresh = FALSE; // just refreshed $data } if( !empty( $this->search )) { // do the business if( empty( $this->data ) or $refresh ) { if(( $this->data = ob_get_contents()) === FALSE ) return $this->_trigger_error( 'Conteg::show(): No ob_contents to do search/replace on.', E_USER_ERROR ); } $this->data = str_replace( $this->search, $this->replace, $this->data ); $refresh = FALSE; // else will lose search/replace } } // end search + replace if( $this->compress( $refresh ) == FALSE ) return FALSE; // error triggered ob_end_clean(); // note: prog errors below this point cannot be seen if( $this->encoding == 'identity' ) { if( $this->method != 'HEAD' ) { if(( $this->_noAcceptRanges == FALSE ) and ( !empty( $this->range ))) { if( $this->_checkRange() == FALSE ) { // error within the range - send a 416 header( 'HTTP/1.1 416 Requested Range Not Satisfiable' ); header( "Content-Range: */$this->size" ); } else { // range is fine - send a 206 header( 'HTTP/1.1 206 Partial content' ); foreach( $this->range AS $begin => $end ) { // currently, only one entry in array $len = $end - $begin + 1; header( "Content-Range: bytes $begin-$end/$this->size" ); header( 'Content-Length: '. $len ); echo substr( $this->data, $begin, $len ); } } } else { header( 'Content-Length: '. $this->size ); echo $this->data; } } else { // if( $this->method != 'HEAD' ) echo ''; } } else { // contents compressed header( 'Content-Encoding: '. $this->encoding ); header( 'Content-Length: '. $this->gzsize ); header( 'X-Content-Encoded-By: class.Conteg.'. $this->_version ); if( $this->method != 'HEAD' ) { if( $this->_noNotes == FALSE ) { apache_note( $this->_inputNote, $this->size ); apache_note( $this->_outputNote, $this->gzsize ); apache_note( $this->_ratioNote, round(( $this->gzsize / $this->size ) * 100 )); } echo $this->gzdata; } else { echo ''; } } } // the return() allows post-processing; be *very* careful not to cause more output return TRUE; } // Conteg::show() /* * _checkRange() - Check $range for validity now that $size is known * Note: Currently, this Class does not deal with * multi-part ranges (it sends a 200 response) * * Returns TRUE (send a 206) or FALSE (send a 416) */ function _checkRange() { if( isset( $this->range[ 'begin' ]) and (( $begin = $this->range[ 'begin' ]) > $this->size )) { return FALSE; } elseif( isset( $this->range[ 'end' ]) and (( $end = $this->range[ 'end' ]) > $this->size )) { return FALSE; } if( isset( $begin )) { $this->range = array( $begin => ( $this->size - 1 )); return TRUE; } elseif( isset( $end )) { if( $end <= 0 ) return FALSE; $this->range = array(( $this->size - $end ) => ( $this->size - 1 )); return TRUE; } else foreach( $this->range AS $begin => $end ) { // just one element currently if( $begin >= $this->size ) return FALSE; if( $end >= $this->size ) { $begin = 0; $end = $this->size - 1; $this->range = array( $begin => $end ); } } return TRUE; } // Conteg::_checkRange() /* * _initRequest() - Set conditional Request headers + various browser-dependant variables * * Many stolen from phpMyAdmin defines.lib.php * Returns TRUE * * - added 25 Aug 05 -AK */ function _initRequest() { if( !empty( $GLOBALS[ '_SERVER' ])) { $this->_SERVER_ARRAY = '_SERVER'; } elseif( !empty( $GLOBALS[ 'HTTP_SERVER_VARS' ])) { $this->_SERVER_ARRAY = 'HTTP_SERVER_VARS'; } else { $this->_SERVER_ARRAY = 'GLOBALS'; } global ${$this->_SERVER_ARRAY}; // http protocol $this->protocol = (( !empty( ${$this->_SERVER_ARRAY}[ 'SERVER_PROTOCOL' ])) and ( strtoupper( stripslashes( ${$this->_SERVER_ARRAY}[ 'SERVER_PROTOCOL' ])) == 'HTTP/1.1' )) ? 'HTTP/1.1' : 'HTTP/1.0'; // http method $this->method = ( empty( ${$this->_SERVER_ARRAY}[ 'REQUEST_METHOD' ])) ? 'GET' : strtoupper( stripslashes( ${$this->_SERVER_ARRAY}[ 'REQUEST_METHOD' ])); // ETag-related calling-script variables begins // server port $this->_port = ( empty( ${$this->_SERVER_ARRAY}[ 'SERVER_PORT' ])) ? '80' : stripslashes( ${$this->_SERVER_ARRAY}[ 'SERVER_PORT' ]); // $_scriptName if( isset( ${$this->_SERVER_ARRAY}[ 'SCRIPT_FILENAME' ])) { $this->_scriptName = ${$this->_SERVER_ARRAY}[ 'SCRIPT_FILENAME' ]; // see notes on PHP 4.3.2 at http://www.php.net/reserved.variables re: foll } elseif( isset( ${$this->_SERVER_ARRAY}[ 'PATH_TRANSLATED' ])) { $this->_scriptName = ${$this->_SERVER_ARRAY}[ 'PATH_TRANSLATED' ]; } elseif( isset( ${$this->_SERVER_ARRAY}[ 'REQUEST_URI' ])) { $this->_scriptName = ${$this->_SERVER_ARRAY}[ 'REQUEST_URI' ]; } else $this->_noETag = TRUE; // $_query if( isset( ${$this->_SERVER_ARRAY}[ 'QUERY_STRING' ])) $this->_query = ${$this->_SERVER_ARRAY}[ 'QUERY_STRING' ]; else $this->_query = ''; // $_session; strictly, not necessary if SID is set, as will be in $_query if( !empty( $GLOBALS[ '_SESSION' ])) { $this->_SESSION_ARRAY = '_SESSION'; } elseif( !empty( $GLOBALS[ 'HTTP_SESSION_VARS' ])) { $this->_SESSION_ARRAY = 'HTTP_SESSION_VARS'; } global ${$this->_SESSION_ARRAY}; if(( !empty( ${$this->_SESSION_ARRAY} )) and (( $this->_session = session_id()) != '' )) $this->_session = session_name() .'='. $this->_session; // ETag-related calling-script variables ends // Request-Header variables if(( $this->protocol != 'HTTP/1.1' ) and ( $this->method == 'HEAD' )) { // http/1.0 rfc1945.txt section 8.2: conditional Headers are ignored } else { // $if_modified_since if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_MODIFIED_SINCE' ])) { $temp = stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_MODIFIED_SINCE' ]); if(( $p = strpos( $temp, ';' )) !== FALSE ) $temp = substr( $temp, 0, $p ); if(( $this->if_modified_since = strtotime( $temp )) == -1 ) $this->if_modified_since = ''; if( $this->if_modified_since > $this->now ) $this->if_modified_since = ''; } // $accept // media-type template: `type/sub-type[[;accept-extension=(digit|quoted-str)][;q=(digit[.digit])]][,]` // any 'accept-extension' are thrown away in this implementation // default q (quality) value is 10 (also max value); min is 0 if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT' ])) { $temp = strtolower( stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT' ])); $match = explode( ',', $temp ); if( !is_array( $match )) $match = array( $match ); foreach( $match AS $val ) { if( strpos( $val, 'q=' ) === FALSE ) { $q = 10; $val = trim( $val ); } else { preg_match( '@^(.+);[ ]*q=(1.*|(?:0\.[0-9]+))@', $val, $str ); $q = ( $str[ 2 ] == 1 ) ? 10 : ( int ) ( 10 * (( float ) $str[ 2 ])); $val = trim( $str[ 1 ]); } if(( $p = strpos( $val, ';' )) !== FALSE ) $val = substr( $val, 0, $p ); $this->accept[ $val ] = $q; } if( empty( $this->accept )) { // more defensive programming $this->accept[ '*/*' ] = 10; } else { arsort( $this->accept ); // highest q-value at the beginning } } else { // if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT' ])) if( $this->_noAccept == FALSE ) { // Accept negotiation is on // rfc2616-sec14.html#sec14.1 - default is client accepts all media types $this->accept[ '*/*' ] = 10; } } // end $accept // $accept_charset // charset template: `charset[;q=(digit[.digit])][,]` if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT_CHARSET' ])) { $temp = strtoupper( stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT_CHARSET' ])); $match = explode( ',', $temp ); if( !is_array( $match )) $match = array( $match ); foreach( $match AS $val ) { if( strpos( $val, '=' ) === FALSE ) { $this->accept_charset[ trim( $val )] = 10; } else { preg_match( '@^(.+?)[;q= ]*(1.*|(?:0\.[0-9]+))$@', $val, $str ); $q = ( $str[ 2 ] == 1 ) ? 10 : ( int ) ( 10 * (( float ) $str[ 2 ])); $this->accept_charset[ trim( $str[ 1 ])] = $q; } } if( empty( $this->accept_charset )) { // more defensive programming $this->accept_charset[ '*' ] = 10; } else { if(( array_search( '*', $this->accept_charset ) === FALSE ) and ( array_search( 'ISO-8859-1', $this->accept_charset ) === FALSE )) { $this->accept_charset[ 'ISO-8859-1' ] = 10; } arsort( $this->accept_charset ); // highest q-value at the beginning } } else { // if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT_CHARSET' ])) if( $this->_noAcceptCharset == FALSE ) { // Accept-Charset negotiation is on // rfc2616-sec14.html#sec14.2 - default is any character set is acceptable $this->accept_charset[ '*' ] = 10; } } // end $accept_charset // $accept_encoding // encoding template: `encoding[;q=(digit[.digit])][,]` if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT_ENCODING' ])) { $temp = strtolower( stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT_ENCODING' ])); $match = explode( ',', $temp ); if( !is_array( $match )) $match = array( $match ); foreach( $match AS $val ) { if( strpos( $val, '=' ) === FALSE ) { $this->accept_encoding[ trim( $val )] = 10; } else { preg_match( '@^(.+?)[;q= ]*(1.*|(?:0\.[0-9]+))$@', $val, $str ); $q = ( $str[ 2 ] == 1 ) ? 10 : ( int ) ( 10 * (( float ) $str[ 2 ])); $this->accept_encoding[ trim( $str[ 1 ])] = $q; } } if( empty( $this->accept_encoding )) { // more defensive programming $this->accept_encoding[ 'identity' ] = 10; } else { if( isset( $this->accept_encoding[ '*' ])) { $val = $this->accept_encoding[ '*' ]; if( empty( $this->accept_encoding[ 'gzip' ]) and empty( $this->accept_encoding[ 'x-gzip' ])) $this->accept_encoding[ 'gzip' ] = $val; if( empty( $this->accept_encoding[ 'compress' ]) and empty( $this->accept_encoding[ 'x-compress' ])) $this->accept_encoding[ 'compress' ] = $val; if( empty( $this->accept_encoding[ 'deflate' ])) $this->accept_encoding[ 'deflate' ] = $val; if( empty( $this->accept_encoding[ 'identity' ])) $this->accept_encoding[ 'identity' ] = $val; } foreach( $this->accept_encoding AS $key => $val ) { if( $val <= 0 ) unset( $this->accept_encoding[ $key ]); } // we depart from the rfc here; rfc2616 has situations where the combo of // accept-encodings can lead to sending a 406; we take the attitude that // no-encoding (identity) is always acceptable and the backstop if( empty( $this->accept_encoding )) { $this->accept_encoding[ 'identity' ] = 10; } else { arsort( $this->accept_encoding ); // highest q-value at the beginning } } } else { // if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT_ENCODING' ])) // rfc2616-sec14.html#sec14.3 (isset but empty) identity is only acceptable encoding // rfc2616-sec14.html#sec14.2 (not set at all) default is identity encoding $this->accept_encoding[ 'identity' ] = 10; } // end $accept_encoding // $accept_language // language template: `language[;q=(digit[.digit])][,]` if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT_LANGUAGE' ])) { $temp = strtolower( stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT_LANGUAGE' ])); $match = explode( ',', $temp ); if( !is_array( $match )) $match = array( $match ); foreach( $match AS $val ) { if( strpos( $val, '=' ) === FALSE ) { $this->accept_language[ trim( $val )] = 10; } else { preg_match( '@^(.+?)[;q= ]*(1.*|(?:0\.[0-9]+))$@', $val, $str ); $q = ( $str[ 2 ] == 1 ) ? 10 : ( int ) ( 10 * (( float ) $str[ 2 ])); $this->accept_language[ trim( $str[ 1 ])] = $q; } } if( empty( $this->accept_language )) { // more defensive programming $this->accept_language[ '*' ] = 10; } else { arsort( $this->accept_language ); // highest q-value at the beginning } } else { // if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_ACCEPT_LANGUAGE' ])) $this->accept_language[ '*' ] = 10; } // end $accept_language } // if(( $this->protocol != 'HTTP/1.1' ) and ( $this->method == 'HEAD' )) else if( $this->protocol == 'HTTP/1.1' ) { // $if_unmodified_since if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_UNMODIFIED_SINCE' ])) { $temp = stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_UNMODIFIED_SINCE' ]); if(( $p = strpos( $temp, ';' )) !== FALSE ) $temp = substr( $temp, 0, $p ); if(( $this->if_unmodified_since = strtotime( $temp )) == -1 ) $this->if_unmodified_since = ''; if( $this->if_unmodified_since > $this->now ) $this->if_unmodified_since = ''; } if( $this->_isWeakETag == FALSE ) { // MUST use the strong comparison function // $range - can only be used with strong ETags if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_RANGE' ])) { $temp = stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_RANGE' ]); if(( $p = strpos( $temp, ';' )) !== FALSE ) $temp = substr( $temp, 0, $p ); $temp = explode( ',', $temp ); if( !is_array( $temp )) $temp = array( $temp ); // now contains an array of `'begin-integer''-''end-integer'` pairs // either integer (but not both) may be empty foreach( $temp AS $val ) { if(( $p = strpos( $val, '-' )) !== FALSE ) { if( $p == 0 ) { $this->range[ 'end' ] = ( int ) substr( $val, 1 ); // no 'begin-integer' } elseif( $p == ( strlen( $val ) - 1 )) { $this->range[ 'begin' ] = ( int ) substr( $val, 0, -1 ); // no 'end-integer' } else { $start = ( int ) substr( $val, 0, $p ); $end = ( int ) substr( $val, $p + 1 ); if( $end >= $start ) $this->range[ $start ] = $end; else { // invalid spec - ignore the whole thing $this->range = array(); break; } } } } if( count( $this->range ) > 1 ) { // we do not currently send multipart/byteranges... $this->range = array(); // ...so lie } } // end $range // $if_match if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_MATCH' ])) { $temp = stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_MATCH' ]); if(( $p = strpos( $temp, ';' )) !== FALSE ) $temp = substr( $temp, 0, $p ); $this->if_match = explode( ',', $temp ); if( !is_array( $this->if_match )) $this->if_match = array( $temp ); // check validity foreach( $this->if_match AS $val ) { if( substr( $val, 0, 2 ) == 'W/' ) { // whoops $this->if_match = array(); break; } } } // end $if_match // $if_range if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_RANGE' ]) and ( !empty( $this->range ))) { $temp = stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_RANGE' ]); if(( $p = strpos( $temp, ';' )) !== FALSE ) $temp = substr( $temp, 0, $p ); if( substr( $temp, 0, 2 ) == 'W/' ) { // is weak ETag - cannot do ranges } else { if(( substr( $temp, 0, 1 ) == '"' ) and ( substr( $temp, -1 ) == '"' )) { // ETag $this->if_range = $temp; if( empty( $this->if_match )) { $this->if_match = array( $temp ); } else { $this->if_match[] = $temp; $this->if_match = array_unique( $this->if_match ); } } else { // date if(( $this->if_range = strtotime( $temp )) == -1 ) $this->if_range = ''; elseif( $this->if_range > $this->now ) $this->if_range = ''; elseif( empty( $this->if_unmodified_since )) $this->if_unmodified_since = $this->if_range; else if( $this->if_unmodified_since != $this->if_range ) { // a plague on both their houses $this->if_unmodified_since = $this->if_range = ''; } } } } } else if(( $this->method == 'GET' ) or ( $this->method == 'HEAD' )) { // then weak is fine // $if_none_match if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_NONE_MATCH' ])) { $temp = stripslashes( ${$this->_SERVER_ARRAY}[ 'HTTP_IF_NONE_MATCH' ]); if(( $p = strpos( $temp, ';' )) !== FALSE ) $temp = substr( $temp, 0, $p ); $this->if_none_match = explode( ',', $temp ); if( !is_array( $this->if_none_match )) $this->if_none_match = array( $temp ); } } } // $user_agent if( !empty( ${$this->_SERVER_ARRAY}[ 'HTTP_USER_AGENT' ])) { $this->user_agent = ${$this->_SERVER_ARRAY}[ 'HTTP_USER_AGENT' ]; // 1 Platform if( strstr( $this->user_agent, 'Win' )) { $this->browserOS = 'Win'; } else if( strstr( $this->user_agent, 'Mac' )) { $this->browserOS = 'Mac'; } else if( strstr( $this->user_agent, 'Linux' )) { $this->browserOS = 'Linux'; } else if( strstr( $this->user_agent, 'Unix' )) { $this->browserOS = 'Unix'; } else if( strstr( $this->user_agent, 'OS/2' )) { $this->browserOS = 'OS/2'; } else { $this->browserOS = 'Other'; } // 2 browser and version; $browserVersion accurate upto v12.34.56.78 // must check everything else before Mozilla if( preg_match( '@Opera(/| )([0-9]{1,2}(?:\.[0-9]{1,2}){0,3})@', $this->user_agent, $match )) { $this->browserVersion = $match[ 2 ]; $this->browserAgent = 'OPERA'; } elseif( preg_match( '@MSIE ([0-9]{1,2}(?:\.[0-9]{1,2}){0,3})@', $this->user_agent, $match )) { $this->browserVersion = $match[ 1 ]; $this->browserAgent = 'IE'; } elseif( preg_match( '@Firefox(/| )([0-9]{1,2}(?:\.[0-9]{1,2}){0,3})@', $this->user_agent, $match )) { $this->browserVersion = $match[ 2 ]; $this->browserAgent = 'FIREFOX'; } elseif( preg_match( '@OmniWeb/([0-9]{1,2}(?:\.[0-9]{1,2}){0,3})@', $this->user_agent, $match )) { $this->browserVersion = $match[ 1 ]; $this->browserAgent = 'OMNIWEB'; // Konqueror 2.2.2 says Konqueror/2.2.2 // Konqueror 3.0.3 says Konqueror/3 } elseif( preg_match( '@(Konqueror/)(.*)(;)@', $this->user_agent, $match )) { $this->browserVersion = $match[ 2 ]; $this->browserAgent = 'KONQUEROR'; } elseif( preg_match( '@Mozilla/([0-9]{1,2}(?:\.[0-9]{1,2}){0,3})@', $this->user_agent, $match1 ) && preg_match('@Safari/([0-9]*)@', $this->user_agent, $match2 )) { $this->browserVersion = $match1[ 2 ] . '.' . $match2[ 1 ]; $this->browserAgent = 'SAFARI'; } elseif( preg_match( '@Mozilla/([0-9]{1,2}(?:\.[0-9]{1,2}){0,3})@', $this->user_agent, $match )) { $this->browserVersion = $match[ 1 ]; $this->browserAgent = 'MOZILLA'; } else { $this->browserVersion = 0; $this->browserAgent = 'OTHER'; } } // end $user_agent return TRUE; } // Conteg::_initRequest() /* * _initResponse() - Init page Response Headers, $_is304, $_is406, $_is412 * * Returns TRUE * * - added 25 Aug 05 -AK */ function _initResponse() { // Content-Type if( empty( $this->_contentType ) or ( $this->_noContentType == TRUE )) { $this->content_type = ''; } else { $this->content_type = $this->_contentType . (( $this->protocol == 'HTTP/1.1' ) ? (( empty( $this->_charset )) ? '' : '; charset='. $this->_charset ) : '' // do not use charset for old clients - rfc2616-sec3.html#sec3.7 ); } // Content-Language if( $this->_noContentLang == TRUE ) { $this->content_lang = ''; } // If-Modified-Since if(( !empty( $this->last_modified )) and ( !empty( $this->if_modified_since ))) { if(( $this->protocol != 'HTTP/1.1' ) and ( $this->method == 'HEAD' )) { // rfc1945.txt: conditional Headers are ignored } else { $IMSis304 = ( $this->if_modified_since >= $this->last_modified ); } } // Accept (media-type) if(( $this->_noAccept == FALSE ) and ( !empty( $this->_contentType ))) { $this->_is406 = ( $this->mediaTypeAccepted()) ? FALSE : TRUE; } // Accept-Charset if(( $this->_noAcceptCharset == FALSE ) and ( !empty( $this->_charset )) and ( $this->_is406 != TRUE )) { $this->_is406 = ( $this->charsetAccepted()) ? FALSE : TRUE; } if( $this->protocol == 'HTTP/1.1' ) { // If-Unmodified-Since if(( !empty( $this->last_modified )) and ( !empty( $this->if_unmodified_since ))) { $IUSis412 = ( $this->last_modified > $this->if_unmodified_since ); } // ETags if( $this->_noETag == FALSE ) { // use ETags if( $this->_isExtETag == FALSE ) { // ETag NOT set by Class if( $this->_isWeakETag ) { $this->etag = 'W/"'. md5( $this->_scriptName. $this->_port. $this->_query. $this->_session. $this->last_modified. $this->content_type. $this->content_lang. $this->_charset ). '"'; } elseif( !empty( $this->data )) { // byte-identical ETag $this->etag = '"'. md5( $this->data ) .'"'; } } if( !empty( $this->etag )) { // If-None-Match if( !empty( $this->if_none_match )) { $etag = ( $this->_isWeakETag ) ? substr( $this->etag, 2 ) : $this->etag; $INMfound = FALSE; foreach( $this->if_none_match AS $val ) { if(( strpos( $val, $etag ) !== FALSE ) or ( $val == '*' )) { $INMfound = TRUE; break; } } } // If-Match if( !empty( $this->if_match ) and ( $this->_isWeakETag == FALSE )) { $IMfound = FALSE; foreach( $this->if_match AS $val ) { if(( strpos( $val, $this->etag ) !== FALSE ) or ( $val == '*' )) { $IMfound = TRUE; break; } } } // end If-Match } // if( !empty( $this->etag ) } // if( $this->_noETag == FALSE ) } // if( $this->protocol == 'HTTP/1.1' ) if( isset( $IMfound ) and ( $IMfound == FALSE )) $this->_is412 = TRUE; if( isset( $INMfound ) and ( $INMfound == TRUE )) { if( isset( $IMSis304 ) and ( IMSis304 == FALSE )) { // rfc2616-sec14.html#sec14.26 - do nothing } else { if(( $this->method == 'GET' ) or ( $this->method == 'HEAD' )) { $this->_is304 = TRUE; } else { $this->_is412 = TRUE; } } } if( isset( $IMSis304 ) and ( $IMSis304 == TRUE )) $this->_is304 = TRUE; if( isset( $IUSis412 ) and ( $IUSis412 == TRUE )) $this->_is412 = TRUE; // If-Range if(( $this->_noAcceptRanges == FALSE ) and ( !empty( $this->if_range )) and ( !empty( $this->range ))) { // If-Range modifies conditional behaviour: // if 'send a 412' then send the whole data instead (updated entity) if( $this->_is412 == TRUE ) { $this->_is412 = FALSE; $this->range = array(); } else { // if 'send the data' then send just the ranges (not-modified entity) // note: gzip-encoded data is NOT sent in ranges $this->_noAcceptEncode = TRUE; } } // Content-Encoding Negotiation $this->encoding = 'identity'; // no 406s here if(( $this->_noAcceptEncode == FALSE ) and // can compress (( $this->_noAcceptRanges == TRUE ) or empty( $this->range )) and // do not compress ranges ( !( $this->_is304 or $this->_is406 or $this->_is412 )) // no point here either ) { if(( !empty( $this->_encodings )) and (( $this->encoding = $this->negotiateEncoding()) != FALSE )) { $this->encoding = key( $this->encoding ); } } // end Content-Encoding Negotiation if(( $this->_is304 == TRUE ) and ( $this->_is412 == TRUE )) { // defensive programming; not supposed to happen (perhaps I mis-understood?) foreach( $this->_preferOrder AS $val ) { switch( $val ) { case 'IM': // if_match if( isset( $IMfound ) and ( $IMfound == FALSE )) { $this->_is304 = FALSE; break 2; } else break; case 'INM': // if_none_match if( isset( $INMfound ) and ( $INMfound == TRUE )) { if(( $this->method == 'GET' ) or ( $this->method == 'HEAD' )) { $this->_is412 = FALSE; } else { $this->_is304 = FALSE; } break 2; } else break; case 'IUS': // if_unmodified_since if( isset( $IUSis412 ) and ( $IUSis412 == TRUE )) { $this->_is304 = FALSE; break 2; } else break; case 'IMS': // if_modified_since default: if( isset( $IMSis304 ) and ( $IMSis304 == TRUE )) { $this->_is412 = FALSE; break 2; } else break; } } } // end resolve $_is304 == $_is412 == TRUE condundrum // Vary; header field-names used to negotiate content (for caches) // the server may add to these + W3C page shows none! if( $this->protocol == 'HTTP/1.1' ) { if( $this->_noAccept == FALSE ) { $v = 'Accept'; $this->vary .= ( empty( $this->vary )) ? $v : (( strpos( $this->vary, $v ) === FALSE ) ? ",$v" : '' ); } if( $this->_noAcceptCharset == FALSE ) { $v = 'Accept-Charset'; $this->vary .= ( empty( $this->vary )) ? $v : (( strpos( $this->vary, $v ) === FALSE ) ? ",$v" : '' ); } if( $this->_noAcceptLang == FALSE ) { $v = 'Accept-Language'; $this->vary .= ( empty( $this->vary )) ? $v : (( strpos( $this->vary, $v ) === FALSE ) ? ",$v" : '' ); } if( $this->_noAcceptEncode == FALSE ) { $v = 'Accept-Encoding'; $this->vary .= ( empty( $this->vary )) ? $v : (( strpos( $this->vary, $v ) === FALSE ) ? ",$v" : '' ); } } return TRUE; } // Conteg::_initResponse() /* * _loadAvgFreeBSD() - Gets the max() system load average from uname(1) * * The max() Load Average will be returned */ function _loadAvgFreeBSD() { $buffer = `uptime`; ereg( "averag(es|e): ([0-9][.][0-9][0-9]),([0-9][.][0-9][0-9]),([0-9][.][0-9][0-9]*)", $buffer, $load ); return max(( float ) $load[ 2 ], ( float ) $load[ 3 ], ( float ) $load[ 4 ]); } // Conteg::_loadAvgFreeBSD() /* * _loadAvgLinux() - Gets the max() system load average from /proc/loadavg * * The max() Load Average will be returned */ function _loadAvgLinux() { $buffer = '0 0 0'; $f = fopen( '/proc/loadavg', 'r' ); if( !feof( $f )) $buffer = fgets( $f, 1024 ); fclose( $f ); $load = explode( ' ', $buffer ); return max(( float ) $load[ 0 ], ( float ) $load[ 1 ], ( float ) $load[ 2 ]); } // Conteg::_loadAvgLinux() /* * _trigger_error() - Sets $_error + issues notices * * Either exit() or return FALSE */ function _trigger_error( $err, $level = E_USER_NOTICE ) { switch( $level ) { // case E_NOTICE: // default no print, no stop case E_USER_NOTICE: trigger_error( $err, $level ); return FALSE; // case E_COMPILE_WARNING: // default print, no stop // case E_CORE_WARNING: case E_USER_WARNING: // case E_WARNING: $this->_error .= "
\n$err"; trigger_error( $err, $level ); return FALSE; // case E_COMPILE_ERROR: // default print, stop // case E_CORE_ERROR: // case E_ERROR: // case E_PARSE: case E_USER_ERROR: default: $this->_error .= "
\n$err"; trigger_error( $err, $level ); die(); } // switch( $level ) } // Conteg::_trigger_error() } // class Conteg // -------------- End of Class Declaration ---------------- /* * Help, Advice + Other Stuff * * Requirements: * PHP 4.0.1+: Uses the '===' operator, output buffering, crc32(); * PHP 4.0.3+: track_vars = On (for external variables) * PHP 4.1.0+: $_SERVER ($_ENV, $_COOKIE, $_GET, $_POST, $_FILES, $_SESSION + $_REQUEST) * zlib: Needed for compression encoding (odds are you have it). * `ExtendedStatus On' in httpd.conf (Apache) (re: $_SERVER variables) * * How to use: * Simplest possible usage requires 3 lines: * 1 Turn Output Buffering on. * 2 Include the Class file. * 3 On the *very* last line create an instance of the Class. * * ------------Start of file--------------- * | * -------------End of file---------------- * * Things to note: * 1 The '' tag MUST be the final characters of the file. * +Be careful of a space hiding there. * 3 Output buffering can be turned on in the main config file, in which * +case line 1 above is optional. * 4 An auto_prepend_file is a possibility for `ob_start()' and an * +auto_append_file for `new Conteg()'. * * Variations: * A `$param' array is available as a setup parameter to the Class constructor * +(line 3). It is an array of `parameter-name' => `parameter-value' pairs. * * Here is the simplest HTTP/1.0 usage: * * $param = array( * 'modified' => strtotime( $mdate ), // (string) default is now [time()] * 'expiry' => 864000 // set expiry date 10 days from now * ); //+default is 1 hour * $Encode = new Conteg( $param ); * * HTTP/1.1 is very much more complex. At the most basic, decide whether to * use ETags, and (if so) whether they will be Strong or Weak ETags: * Strong ETags: 2 pages with the same ETag are byte-by-byte the same * Weak ETags: 2 pages with the same ETag are *essentially* the same. * * An example from modem-help.com is that the hit-counter, etc. may change, * +but the rest of the content remains unchanged. If principal content changes * +then the Modification Date is changed, which changes the (weak) ETag. * * For Strong ETags the Class md5's the content, which can be slow on extremely * +large files. An external ETag can be provided for these cases. * * Here is the simplest HTTP/1.1 usage: * * $param = array( * 'use_etag' => TRUE, // default is Weak ETags * 'modified' => $mdate, // (Unix timestamp) * 'expiry' => 3600 // set expiry date 1 hour from now() * )); * $Encode = new Conteg( $param ); * * Content Negotiation: * Accept: (media-type)(negotiate outside Class) (default text/html) * $accept[ 'type/sub-type' ] = quality-integer (0-10) * * Accept-Charset: (negotiate outside Class) (default ISO-8859-1) * $accept_charset[ 'charset' ] = quality-integer (0-10) * * Accept-Encoding: Negotiated inside the Class (gzip, deflate, compress) * +Default is load-balanced compression * * Accept-Language: (negotiate outside Class) (default en) * $accept_language[ 'lang' ] = quality-integer (0-10) * * To execute Negotiation (exception: Encoding) will require the 'noprint' * +parameter: * * $Encode = new Conteg( * array( * 'noprint' => TRUE * )); * ... * (negotiation processing, etc.) * ... * $Encode->show(); * * References: * compression: rfc2616 (Sections: 3.5, 14.3, 14.11) * HTTP/1.1: http://www.w3.org/Protocols/rfc2616/rfc2616.html * HTTP/1.0: http://www.w3.org/Protocols/rfc1945/rfc1945.txt * Media-types: http://www.ietf.org/rfc/rfc1521.txt * * Notes: * 1 Compression extended from Gzip_encode v0.67s.3; see * +http://leknor.com/code/gziped.php for stats on how a page may compress. * 2 Class also reports Browser + OS-platform; active use made within * +negotiateEncoding(). Further reports on other browsers, etc welcomed. * 3 Global search/replace available via `search' parameter. Default is * +compression stats. * * Change Log: * Small Bug-fix to _trigger_error() 15 Feb 06 * 0.10: Gzip_encode rewritten; Request + Response headers added. 25 Aug 05 * +Browser detect added to negotiateEncoding() to fix blanks 09 Sep 05 * +Content-Negotiation completed for compression-Encoding 16 Sep 05 * * Thanks To: * Gzip-encoding originally from work by Sandy McArthur,Jr. * +(see leknor.com); Response headers inspired by work by * +Alexandre Alapetite (alexandre.alapetite.net) and others. * * This version available from: * http://www.modem-help.freeserve.co.uk/download/Conteg.include.txt */ /* * Constructor parameter array * * These are all the possible array values within the parameter string supplied to * +the constructor, and acted upon within setup(), with defaults. * +Note: none of the following is *required* - these are the program defaults: * array( 'charset' => 'ISO-8859-1', 'encodings' => array( 'gzip','deflate','compress' ), 'etag' => '', 'expiry' => 3600, 'input' => 'instream', 'lang' => 'en', 'modified' => NULL, 'noprint' => FALSE, 'output' => 'outstream', 'prefer' => array(), 'ratio' => 'ratio', 'search' => array(), 'type' => 'text/html', 'use_accept' => FALSE, 'use_accept_charset' => FALSE, 'use_accept_encode' => TRUE, 'use_accept_lang' => FALSE, 'use_accept_ranges' => FALSE, 'use_apache_notes' => FALSE, 'use_content_lang' => TRUE, 'use_content_type' => TRUE, 'use_etag' => FALSE, 'weak_etag' => TRUE ) */ ?>