moodle/lib/filelib.php
2006-01-16 22:55:17 +00:00

518 lines
23 KiB
PHP

<?php //$Id$
define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7'); //unique string constant
function mimeinfo($element, $filename) {
$mimeinfo = array (
'xxx' => array ('type'=>'document/unknown', 'icon'=>'unknown.gif'),
'3gp' => array ('type'=>'video/quicktime', 'icon'=>'video.gif'),
'ai' => array ('type'=>'application/postscript', 'icon'=>'image.gif'),
'aif' => array ('type'=>'audio/x-aiff', 'icon'=>'audio.gif'),
'aiff' => array ('type'=>'audio/x-aiff', 'icon'=>'audio.gif'),
'aifc' => array ('type'=>'audio/x-aiff', 'icon'=>'audio.gif'),
'applescript' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'asc' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'asm' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'au' => array ('type'=>'audio/au', 'icon'=>'audio.gif'),
'avi' => array ('type'=>'video/x-ms-wm', 'icon'=>'avi.gif'),
'bmp' => array ('type'=>'image/bmp', 'icon'=>'image.gif'),
'c' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'cct' => array ('type'=>'shockwave/director', 'icon'=>'flash.gif'),
'cpp' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'cs' => array ('type'=>'application/x-csh', 'icon'=>'text.gif'),
'css' => array ('type'=>'text/css', 'icon'=>'text.gif'),
'dv' => array ('type'=>'video/x-dv', 'icon'=>'video.gif'),
'dmg' => array ('type'=>'application/octet-stream', 'icon'=>'dmg.gif'),
'doc' => array ('type'=>'application/msword', 'icon'=>'word.gif'),
'dcr' => array ('type'=>'application/x-director', 'icon'=>'flash.gif'),
'dif' => array ('type'=>'video/x-dv', 'icon'=>'video.gif'),
'dir' => array ('type'=>'application/x-director', 'icon'=>'flash.gif'),
'dxr' => array ('type'=>'application/x-director', 'icon'=>'flash.gif'),
'eps' => array ('type'=>'application/postscript', 'icon'=>'pdf.gif'),
'gif' => array ('type'=>'image/gif', 'icon'=>'image.gif'),
'gtar' => array ('type'=>'application/x-gtar', 'icon'=>'zip.gif'),
'tgz' => array ('type'=>'application/g-zip', 'icon'=>'zip.gif'),
'gz' => array ('type'=>'application/g-zip', 'icon'=>'zip.gif'),
'gzip' => array ('type'=>'application/g-zip', 'icon'=>'zip.gif'),
'h' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'hpp' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'hqx' => array ('type'=>'application/mac-binhex40', 'icon'=>'zip.gif'),
'html' => array ('type'=>'text/html', 'icon'=>'html.gif'),
'htm' => array ('type'=>'text/html', 'icon'=>'html.gif'),
'java' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'jcb' => array ('type'=>'text/xml', 'icon'=>'jcb.gif'),
'jcl' => array ('type'=>'text/xml', 'icon'=>'jcl.gif'),
'jcw' => array ('type'=>'text/xml', 'icon'=>'jcw.gif'),
'jmt' => array ('type'=>'text/xml', 'icon'=>'jmt.gif'),
'jmx' => array ('type'=>'text/xml', 'icon'=>'jmx.gif'),
'jpe' => array ('type'=>'image/jpeg', 'icon'=>'image.gif'),
'jpeg' => array ('type'=>'image/jpeg', 'icon'=>'image.gif'),
'jpg' => array ('type'=>'image/jpeg', 'icon'=>'image.gif'),
'jqz' => array ('type'=>'text/xml', 'icon'=>'jqz.gif'),
'js' => array ('type'=>'application/x-javascript', 'icon'=>'text.gif'),
'latex'=> array ('type'=>'application/x-latex', 'icon'=>'text.gif'),
'm' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'mov' => array ('type'=>'video/quicktime', 'icon'=>'video.gif'),
'movie'=> array ('type'=>'video/x-sgi-movie', 'icon'=>'video.gif'),
'm3u' => array ('type'=>'audio/x-mpegurl', 'icon'=>'audio.gif'),
'mp3' => array ('type'=>'audio/mp3', 'icon'=>'audio.gif'),
'mp4' => array ('type'=>'video/mp4', 'icon'=>'video.gif'),
'mpeg' => array ('type'=>'video/mpeg', 'icon'=>'video.gif'),
'mpe' => array ('type'=>'video/mpeg', 'icon'=>'video.gif'),
'mpg' => array ('type'=>'video/mpeg', 'icon'=>'video.gif'),
'odt' => array ('type'=>'application/vnd.oasis.opendocument.text', 'icon'=>'odt.gif'),
'ott' => array ('type'=>'application/vnd.oasis.opendocument.text-template', 'icon'=>'odt.gif'),
'oth' => array ('type'=>'application/vnd.oasis.opendocument.text-web', 'icon'=>'odt.gif'),
'odm' => array ('type'=>'application/vnd.oasis.opendocument.text-master', 'icon'=>'odt.gif'),
'odg' => array ('type'=>'application/vnd.oasis.opendocument.graphics', 'icon'=>'odt.gif'),
'otg' => array ('type'=>'application/vnd.oasis.opendocument.graphics-template', 'icon'=>'odt.gif'),
'odp' => array ('type'=>'application/vnd.oasis.opendocument.presentation', 'icon'=>'odt.gif'),
'otp' => array ('type'=>'application/vnd.oasis.opendocument.presentation-template', 'icon'=>'odt.gif'),
'ods' => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet', 'icon'=>'odt.gif'),
'ots' => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet-template', 'icon'=>'odt.gif'),
'odc' => array ('type'=>'application/vnd.oasis.opendocument.chart', 'icon'=>'odt.gif'),
'odf' => array ('type'=>'application/vnd.oasis.opendocument.formula', 'icon'=>'odt.gif'),
'odb' => array ('type'=>'application/vnd.oasis.opendocument.database', 'icon'=>'odt.gif'),
'odi' => array ('type'=>'application/vnd.oasis.opendocument.image', 'icon'=>'odt.gif'),
'pct' => array ('type'=>'image/pict', 'icon'=>'image.gif'),
'pdf' => array ('type'=>'application/pdf', 'icon'=>'pdf.gif'),
'php' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'pic' => array ('type'=>'image/pict', 'icon'=>'image.gif'),
'pict' => array ('type'=>'image/pict', 'icon'=>'image.gif'),
'png' => array ('type'=>'image/png', 'icon'=>'image.gif'),
'pps' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint.gif'),
'ppt' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint.gif'),
'ps' => array ('type'=>'application/postscript', 'icon'=>'pdf.gif'),
'qt' => array ('type'=>'video/quicktime', 'icon'=>'video.gif'),
'ra' => array ('type'=>'audio/x-realaudio', 'icon'=>'audio.gif'),
'ram' => array ('type'=>'audio/x-pn-realaudio', 'icon'=>'audio.gif'),
'rhb' => array ('type'=>'text/xml', 'icon'=>'xml.gif'),
'rm' => array ('type'=>'audio/x-pn-realaudio', 'icon'=>'audio.gif'),
'rtf' => array ('type'=>'text/rtf', 'icon'=>'text.gif'),
'rtx' => array ('type'=>'text/richtext', 'icon'=>'text.gif'),
'sh' => array ('type'=>'application/x-sh', 'icon'=>'text.gif'),
'sit' => array ('type'=>'application/x-stuffit', 'icon'=>'zip.gif'),
'smi' => array ('type'=>'application/smil', 'icon'=>'text.gif'),
'smil' => array ('type'=>'application/smil', 'icon'=>'text.gif'),
'sqt' => array ('type'=>'text/xml', 'icon'=>'xml.gif'),
'swa' => array ('type'=>'application/x-director', 'icon'=>'flash.gif'),
'swf' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash.gif'),
'swfl' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash.gif'),
'sxw' => array ('type'=>'application/vnd.sun.xml.writer', 'icon'=>'odt.gif'),
'stw' => array ('type'=>'application/vnd.sun.xml.writer.template', 'icon'=>'odt.gif'),
'sxc' => array ('type'=>'application/vnd.sun.xml.calc', 'icon'=>'odt.gif'),
'stc' => array ('type'=>'application/vnd.sun.xml.calc.template', 'icon'=>'odt.gif'),
'sxd' => array ('type'=>'application/vnd.sun.xml.draw', 'icon'=>'odt.gif'),
'std' => array ('type'=>'application/vnd.sun.xml.draw.template', 'icon'=>'odt.gif'),
'sxi' => array ('type'=>'application/vnd.sun.xml.impress', 'icon'=>'odt.gif'),
'sti' => array ('type'=>'application/vnd.sun.xml.impress.template', 'icon'=>'odt.gif'),
'sxg' => array ('type'=>'application/vnd.sun.xml.writer.global', 'icon'=>'odt.gif'),
'sxm' => array ('type'=>'application/vnd.sun.xml.math', 'icon'=>'odt.gif'),
'tar' => array ('type'=>'application/x-tar', 'icon'=>'zip.gif'),
'tif' => array ('type'=>'image/tiff', 'icon'=>'image.gif'),
'tiff' => array ('type'=>'image/tiff', 'icon'=>'image.gif'),
'tex' => array ('type'=>'application/x-tex', 'icon'=>'text.gif'),
'texi' => array ('type'=>'application/x-texinfo', 'icon'=>'text.gif'),
'texinfo' => array ('type'=>'application/x-texinfo', 'icon'=>'text.gif'),
'tsv' => array ('type'=>'text/tab-separated-values', 'icon'=>'text.gif'),
'txt' => array ('type'=>'text/plain', 'icon'=>'text.gif'),
'wav' => array ('type'=>'audio/wav', 'icon'=>'audio.gif'),
'wmv' => array ('type'=>'video/x-ms-wmv', 'icon'=>'avi.gif'),
'asf' => array ('type'=>'video/x-ms-asf', 'icon'=>'avi.gif'),
'xls' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'excel.gif'),
'xml' => array ('type'=>'application/xml', 'icon'=>'xml.gif'),
'xsl' => array ('type'=>'text/xml', 'icon'=>'xml.gif'),
'zip' => array ('type'=>'application/zip', 'icon'=>'zip.gif')
);
if (eregi('\.([a-z0-9]+)$', $filename, $match)) {
if (isset($mimeinfo[strtolower($match[1])][$element])) {
return $mimeinfo[strtolower($match[1])][$element];
} else {
return $mimeinfo['xxx'][$element]; // By default
}
} else {
return $mimeinfo['xxx'][$element]; // By default
}
}
function send_file($path, $filename, $lifetime=86400 , $filter=false, $pathisstring=false, $forcedownload=false) {
global $CFG;
$mimetype = $forcedownload ? 'application/x-forcedownload' : mimeinfo('type', $filename);
$lastmodified = $pathisstring ? time() : filemtime($path);
$filesize = $pathisstring ? strlen($path) : filesize($path);
//IE compatibiltiy HACK!
if (ini_get('zlib.output_compression')) {
ini_set('zlib.output_compression', 'Off');
}
//try to disable automatic sid rewrite in cookieless mode
@ini_set("session.use_trans_sid", "false");
//do not put '@' before the next header to detect incorrect moodle configurations,
//error should be better than "weird" empty lines for admins/users
//TODO: should we remove all those @ before the header()? Are all of the values supported on all servers?
header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
if ($forcedownload) {
@header('Content-Disposition: attachment; filename='.$filename);
} else {
@header('Content-Disposition: inline; filename='.$filename);
}
if ($lifetime > 0) {
@header('Cache-Control: max-age='.$lifetime);
@header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
@header('Pragma: ');
if (empty($CFG->disablebyteserving) && !$pathisstring && $mimetype != 'text/plain' && $mimetype != 'text/html') {
@header('Accept-Ranges: bytes');
if (!empty($_SERVER['HTTP_RANGE']) && strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
// byteserving stuff - for acrobat reader and download accelerators
// see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
// inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
$ranges = false;
if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
foreach ($ranges as $key=>$value) {
if ($ranges[$key][1] == '') {
//suffix case
$ranges[$key][1] = $filesize - $ranges[$key][2];
$ranges[$key][2] = $filesize - 1;
} else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
//fix range length
$ranges[$key][2] = $filesize - 1;
}
if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
//invalid byte-range ==> ignore header
$ranges = false;
break;
}
//prepare multipart header
$ranges[$key][0] = "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
$ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
}
} else {
$ranges = false;
}
if ($ranges) {
byteserving_send_file($path, $mimetype, $ranges);
}
}
} else {
/// Do not byteserve (disabled, strings, text and html files).
@header('Accept-Ranges: none');
}
} else { // Do not cache files in proxies and browsers
if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
@header('Cache-Control: max-age=10');
@header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
@header('Pragma: ');
} else { //normal http - prevent caching at all cost
@header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
@header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
@header('Pragma: no-cache');
}
@header('Accept-Ranges: none'); // Do not allow byteserving when caching disabled
}
if (!$filter) {
if ($mimetype == 'text/html' && !empty($CFG->usesid) && empty($_COOKIE['MoodleSession'.$CFG->sessioncookie])) {
//cookieless mode - rewrite links
@header('Content-Type: text/html');
$path = $pathisstring ? $path : implode('', file($path));
$path = sid_ob_rewrite($path);
$filesize = strlen($path);
$pathisstring = true;
} else if ($mimetype == 'text/plain') {
@header('Content-Type: Text/plain; charset='.current_charset()); //add encoding
} else {
@header('Content-Type: '.$mimetype);
}
@header('Content-Length: '.$filesize);
while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
if ($pathisstring) {
echo $path;
} else {
readfile_chunked($path);
}
} else { // Try to put the file through filters
global $course; // HACK!
if (!empty($course->id)) {
$courseid = $course->id;
} else {
$courseid = SITEID;
}
if ($mimetype == 'text/html') {
$options->noclean = true;
$text = $pathisstring ? $path : implode('', file($path));
$output = format_text($text, FORMAT_HTML, $options, $courseid);
if (!empty($CFG->usesid) && empty($_COOKIE['MoodleSession'.$CFG->sessioncookie])) {
//cookieless mode - rewrite links
$output = sid_ob_rewrite($output);
}
@header('Content-Length: '.strlen($output));
@header('Content-Type: text/html');
while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
echo $output;
} else if ($mimetype == 'text/plain') {
$options->newlines = false;
$options->noclean = true;
$text = htmlentities($pathisstring ? $path : implode('', file($path)));
$output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $courseid) .'</pre>';
if (!empty($CFG->usesid) && empty($_COOKIE['MoodleSession'.$CFG->sessioncookie])) {
//cookieless mode - rewrite links
$output = sid_ob_rewrite($output);
}
@header('Content-Length: '.strlen($output));
@header('Content-Type: text/html; charset='.current_charset()); //add encoding
while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
echo $output;
} else { // Just send it out raw
@header('Content-Length: '.$filesize);
@header('Content-Type: '.$mimetype);
while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
if ($pathisstring) {
echo $path;
}else {
readfile_chunked($path);
}
}
}
die; //no more chars to output!!!
}
function get_records_csv($file, $table) {
global $CFG, $db;
if (!$metacolumns = $db->MetaColumns($CFG->prefix . $table)) {
return false;
}
if(!($handle = @fopen($file, 'r'))) {
error('get_records_csv failed to open '.$file);
}
$fieldnames = fgetcsv($handle, 4096);
if(empty($fieldnames)) {
fclose($handle);
return false;
}
$columns = array();
foreach($metacolumns as $metacolumn) {
$ord = array_search($metacolumn->name, $fieldnames);
if(is_int($ord)) {
$columns[$metacolumn->name] = $ord;
}
}
$rows = array();
while (($data = fgetcsv($handle, 4096)) !== false) {
$item = new stdClass;
foreach($columns as $name => $ord) {
$item->$name = $data[$ord];
}
$rows[] = $item;
}
fclose($handle);
return $rows;
}
function put_records_csv($file, $records, $table = NULL) {
global $CFG, $db;
if (empty($records)) {
return true;
}
$metacolumns = NULL;
if ($table !== NULL && !$metacolumns = $db->MetaColumns($CFG->prefix . $table)) {
return false;
}
echo "x";
if(!($fp = @fopen($CFG->dataroot.'/temp/'.$file, 'w'))) {
error('put_records_csv failed to open '.$file);
}
$proto = reset($records);
if(is_object($proto)) {
$fields_records = array_keys(get_object_vars($proto));
}
else if(is_array($proto)) {
$fields_records = array_keys($proto);
}
else {
return false;
}
echo "x";
if(!empty($metacolumns)) {
$fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
$fields = array_intersect($fields_records, $fields_table);
}
else {
$fields = $fields_records;
}
fwrite($fp, implode(',', $fields));
fwrite($fp, "\r\n");
foreach($records as $record) {
$array = (array)$record;
$values = array();
foreach($fields as $field) {
if(strpos($array[$field], ',')) {
$values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
}
else {
$values[] = $array[$field];
}
}
fwrite($fp, implode(',', $values)."\r\n");
}
fclose($fp);
return true;
}
if (!function_exists('file_get_contents')) {
function file_get_contents($file) {
$file = file($file);
return !$file ? false : implode('', $file);
}
}
function fulldelete($location) {
if (is_dir($location)) {
$currdir = opendir($location);
while (false !== ($file = readdir($currdir))) {
if ($file <> ".." && $file <> ".") {
$fullfile = $location."/".$file;
if (is_dir($fullfile)) {
if (!fulldelete($fullfile)) {
return false;
}
} else {
if (!unlink($fullfile)) {
return false;
}
}
}
}
closedir($currdir);
if (! rmdir($location)) {
return false;
}
} else {
if (!unlink($location)) {
return false;
}
}
return true;
}
/**
* Improves memory consumptions and works around buggy readfile() in PHP 5.0.4 (2MB readfile limit).
*/
function readfile_chunked($filename, $retbytes=true) {
$chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
$buffer = '';
$cnt =0;// $handle = fopen($filename, 'rb');
$handle = fopen($filename, 'rb');
if ($handle === false) {
return false;
}
while (!feof($handle)) {
@set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
$buffer = fread($handle, $chunksize);
echo $buffer;
flush();
if ($retbytes) {
$cnt += strlen($buffer);
}
}
$status = fclose($handle);
if ($retbytes && $status) {
return $cnt; // return num. bytes delivered like readfile() does.
}
return $status;
}
/**
* Send requested byterange of file.
*/
function byteserving_send_file($filename, $mimetype, $ranges) {
$chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
$handle = fopen($filename, 'rb');
if ($handle === false) {
die;
}
if (count($ranges) == 1) { //only one range requested
$length = $ranges[0][2] - $ranges[0][1] + 1;
@header('HTTP/1.1 206 Partial content');
@header('Content-Length: '.$length);
@header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.filesize($filename));
@header('Content-Type: '.$mimetype);
while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
$buffer = '';
fseek($handle, $ranges[0][1]);
while (!feof($handle) && $length > 0) {
@set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
$buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
echo $buffer;
flush();
$length -= strlen($buffer);
}
fclose($handle);
die;
} else { // multiple ranges requested - not tested much
$totallength = 0;
foreach($ranges as $range) {
$totallength .= strlen($range[0]) + $range[2] - $range[1] + 1;
}
$totallength .= strlen("\r\n--".BYTESERVING_BOUNDARY."--\r\n");
@header('HTTP/1.1 206 Partial content');
@header('Content-Length: '.$totallength);
@header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY);
//TODO: check if "multipart/x-byteranges" is more compatible with current readers/browsers/servers
while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
foreach($ranges as $range) {
$length = $range[2] - $range[1] + 1;
echo $range[0];
$buffer = '';
fseek($handle, $range[1]);
while (!feof($handle) && $length > 0) {
@set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
$buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
echo $buffer;
flush();
$length -= strlen($buffer);
}
}
echo "\r\n--".BYTESERVING_BOUNDARY."--\r\n";
fclose($handle);
die;
}
}
?>