website_jukni/dokuwiki/inc/httputils.php
2017-12-29 15:51:59 +01:00

346 lines
10 KiB
PHP

<?php
/**
* Utilities for handling HTTP related tasks
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Andreas Gohr <andi@splitbrain.org>
*/
define('HTTP_MULTIPART_BOUNDARY','D0KuW1K1B0uNDARY');
define('HTTP_HEADER_LF',"\r\n");
define('HTTP_CHUNK_SIZE',16*1024);
/**
* Checks and sets HTTP headers for conditional HTTP requests
*
* @author Simon Willison <swillison@gmail.com>
* @link http://simonwillison.net/2003/Apr/23/conditionalGet/
*
* @param int $timestamp lastmodified time of the cache file
* @returns void or exits with previously header() commands executed
*/
function http_conditionalRequest($timestamp){
// A PHP implementation of conditional get, see
// http://fishbowl.pastiche.org/2002/10/21/http_conditional_get_for_rss_hackers/
$last_modified = substr(gmdate('r', $timestamp), 0, -5).'GMT';
$etag = '"'.md5($last_modified).'"';
// Send the headers
header("Last-Modified: $last_modified");
header("ETag: $etag");
// See if the client has provided the required headers
if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
$if_modified_since = stripslashes($_SERVER['HTTP_IF_MODIFIED_SINCE']);
}else{
$if_modified_since = false;
}
if (isset($_SERVER['HTTP_IF_NONE_MATCH'])){
$if_none_match = stripslashes($_SERVER['HTTP_IF_NONE_MATCH']);
}else{
$if_none_match = false;
}
if (!$if_modified_since && !$if_none_match){
return;
}
// At least one of the headers is there - check them
if ($if_none_match && $if_none_match != $etag) {
return; // etag is there but doesn't match
}
if ($if_modified_since && $if_modified_since != $last_modified) {
return; // if-modified-since is there but doesn't match
}
// Nothing has changed since their last request - serve a 304 and exit
header('HTTP/1.0 304 Not Modified');
// don't produce output, even if compression is on
@ob_end_clean();
exit;
}
/**
* Let the webserver send the given file via x-sendfile method
*
* @author Chris Smith <chris@jalakai.co.uk>
*
* @param string $file absolute path of file to send
* @returns void or exits with previous header() commands executed
*/
function http_sendfile($file) {
global $conf;
//use x-sendfile header to pass the delivery to compatible web servers
if($conf['xsendfile'] == 1){
header("X-LIGHTTPD-send-file: $file");
ob_end_clean();
exit;
}elseif($conf['xsendfile'] == 2){
header("X-Sendfile: $file");
ob_end_clean();
exit;
}elseif($conf['xsendfile'] == 3){
// FS#2388 nginx just needs the relative path.
$file = DOKU_REL.substr($file, strlen(fullpath(DOKU_INC)) + 1);
header("X-Accel-Redirect: $file");
ob_end_clean();
exit;
}
}
/**
* Send file contents supporting rangeRequests
*
* This function exits the running script
*
* @param resource $fh - file handle for an already open file
* @param int $size - size of the whole file
* @param int $mime - MIME type of the file
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function http_rangeRequest($fh,$size,$mime){
$ranges = array();
$isrange = false;
header('Accept-Ranges: bytes');
if(!isset($_SERVER['HTTP_RANGE'])){
// no range requested - send the whole file
$ranges[] = array(0,$size,$size);
}else{
$t = explode('=', $_SERVER['HTTP_RANGE']);
if (!$t[0]=='bytes') {
// we only understand byte ranges - send the whole file
$ranges[] = array(0,$size,$size);
}else{
$isrange = true;
// handle multiple ranges
$r = explode(',',$t[1]);
foreach($r as $x){
$p = explode('-', $x);
$start = (int)$p[0];
$end = (int)$p[1];
if (!$end) $end = $size - 1;
if ($start > $end || $start > $size || $end > $size){
header('HTTP/1.1 416 Requested Range Not Satisfiable');
print 'Bad Range Request!';
exit;
}
$len = $end - $start + 1;
$ranges[] = array($start,$end,$len);
}
}
}
$parts = count($ranges);
// now send the type and length headers
if(!$isrange){
header("Content-Type: $mime",true);
}else{
header('HTTP/1.1 206 Partial Content');
if($parts == 1){
header("Content-Type: $mime",true);
}else{
header('Content-Type: multipart/byteranges; boundary='.HTTP_MULTIPART_BOUNDARY,true);
}
}
// send all ranges
for($i=0; $i<$parts; $i++){
list($start,$end,$len) = $ranges[$i];
// multipart or normal headers
if($parts > 1){
echo HTTP_HEADER_LF.'--'.HTTP_MULTIPART_BOUNDARY.HTTP_HEADER_LF;
echo "Content-Type: $mime".HTTP_HEADER_LF;
echo "Content-Range: bytes $start-$end/$size".HTTP_HEADER_LF;
echo HTTP_HEADER_LF;
}else{
header("Content-Length: $len");
if($isrange){
header("Content-Range: bytes $start-$end/$size");
}
}
// send file content
fseek($fh,$start); //seek to start of range
$chunk = ($len > HTTP_CHUNK_SIZE) ? HTTP_CHUNK_SIZE : $len;
while (!feof($fh) && $chunk > 0) {
@set_time_limit(30); // large files can take a lot of time
print fread($fh, $chunk);
flush();
$len -= $chunk;
$chunk = ($len > HTTP_CHUNK_SIZE) ? HTTP_CHUNK_SIZE : $len;
}
}
if($parts > 1){
echo HTTP_HEADER_LF.'--'.HTTP_MULTIPART_BOUNDARY.'--'.HTTP_HEADER_LF;
}
// everything should be done here, exit (or return if testing)
if (defined('SIMPLE_TEST')) return;
exit;
}
/**
* Check for a gzipped version and create if necessary
*
* return true if there exists a gzip version of the uncompressed file
* (samepath/samefilename.sameext.gz) created after the uncompressed file
*
* @author Chris Smith <chris.eureka@jalakai.co.uk>
*
* @param string $uncompressed_file
* @return bool
*/
function http_gzip_valid($uncompressed_file) {
if(!DOKU_HAS_GZIP) return false;
$gzip = $uncompressed_file.'.gz';
if (filemtime($gzip) < filemtime($uncompressed_file)) { // filemtime returns false (0) if file doesn't exist
return copy($uncompressed_file, 'compress.zlib://'.$gzip);
}
return true;
}
/**
* Set HTTP headers and echo cachefile, if useable
*
* This function handles output of cacheable resource files. It ses the needed
* HTTP headers. If a useable cache is present, it is passed to the web server
* and the script is terminated.
*
* @param string $cache cache file name
* @param bool $cache_ok if cache can be used
*/
function http_cached($cache, $cache_ok) {
global $conf;
// check cache age & handle conditional request
// since the resource files are timestamped, we can use a long max age: 1 year
header('Cache-Control: public, max-age=31536000');
header('Pragma: public');
if($cache_ok){
http_conditionalRequest(filemtime($cache));
if($conf['allowdebug']) header("X-CacheUsed: $cache");
// finally send output
if ($conf['gzip_output'] && http_gzip_valid($cache)) {
header('Vary: Accept-Encoding');
header('Content-Encoding: gzip');
readfile($cache.".gz");
} else {
http_sendfile($cache);
readfile($cache);
}
exit;
}
http_conditionalRequest(time());
}
/**
* Cache content and print it
*
* @param string $file file name
* @param string $content
*/
function http_cached_finish($file, $content) {
global $conf;
// save cache file
io_saveFile($file, $content);
if(DOKU_HAS_GZIP) io_saveFile("$file.gz",$content);
// finally send output
if ($conf['gzip_output'] && DOKU_HAS_GZIP) {
header('Vary: Accept-Encoding');
header('Content-Encoding: gzip');
print gzencode($content,9,FORCE_GZIP);
} else {
print $content;
}
}
/**
* Fetches raw, unparsed POST data
*
* @return string
*/
function http_get_raw_post_data() {
static $postData = null;
if ($postData === null) {
$postData = file_get_contents('php://input');
}
return $postData;
}
/**
* Set the HTTP response status and takes care of the used PHP SAPI
*
* Inspired by CodeIgniter's set_status_header function
*
* @param int $code
* @param string $text
*/
function http_status($code = 200, $text = '') {
static $stati = array(
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',
304 => 'Not Modified',
305 => 'Use Proxy',
307 => 'Temporary Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Timeout',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Request Entity Too Large',
414 => 'Request-URI Too Long',
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 Timeout',
505 => 'HTTP Version Not Supported'
);
if($text == '' && isset($stati[$code])) {
$text = $stati[$code];
}
$server_protocol = (isset($_SERVER['SERVER_PROTOCOL'])) ? $_SERVER['SERVER_PROTOCOL'] : false;
if(substr(php_sapi_name(), 0, 3) == 'cgi' || defined('SIMPLE_TEST')) {
header("Status: {$code} {$text}", true);
} elseif($server_protocol == 'HTTP/1.1' OR $server_protocol == 'HTTP/1.0') {
header($server_protocol." {$code} {$text}", true, $code);
} else {
header("HTTP/1.1 {$code} {$text}", true, $code);
}
}