mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 22:08:20 +01:00
1919 lines
77 KiB
PHP
1919 lines
77 KiB
PHP
<?php //$Id$
|
|
|
|
define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7'); //unique string constant
|
|
|
|
require_once("$CFG->libdir/file/file_exceptions.php");
|
|
require_once("$CFG->libdir/file/file_storage.php");
|
|
require_once("$CFG->libdir/file/file_browser.php");
|
|
|
|
require_once("$CFG->libdir/packer/zip_packer.php");
|
|
|
|
function get_file_url($path, $options=null, $type='coursefile') {
|
|
global $CFG;
|
|
|
|
$path = str_replace('//', '/', $path);
|
|
$path = trim($path, '/'); // no leading and trailing slashes
|
|
|
|
// type of file
|
|
switch ($type) {
|
|
case 'questionfile':
|
|
$url = $CFG->wwwroot."/question/exportfile.php";
|
|
break;
|
|
case 'rssfile':
|
|
$url = $CFG->wwwroot."/rss/file.php";
|
|
break;
|
|
case 'user':
|
|
$url = $CFG->wwwroot."/user/pix.php";
|
|
break;
|
|
case 'usergroup':
|
|
$url = $CFG->wwwroot."/user/pixgroup.php";
|
|
break;
|
|
case 'httpscoursefile':
|
|
$url = $CFG->httpswwwroot."/file.php";
|
|
break;
|
|
case 'coursefile':
|
|
default:
|
|
$url = $CFG->wwwroot."/file.php";
|
|
}
|
|
|
|
if ($CFG->slasharguments) {
|
|
$parts = explode('/', $path);
|
|
$parts = array_map('rawurlencode', $parts);
|
|
$path = implode('/', $parts);
|
|
$ffurl = $url.'/'.$path;
|
|
$separator = '?';
|
|
} else {
|
|
$path = rawurlencode('/'.$path);
|
|
$ffurl = $url.'?file='.$path;
|
|
$separator = '&';
|
|
}
|
|
|
|
if ($options) {
|
|
foreach ($options as $name=>$value) {
|
|
$ffurl = $ffurl.$separator.$name.'='.$value;
|
|
$separator = '&';
|
|
}
|
|
}
|
|
|
|
return $ffurl;
|
|
}
|
|
|
|
/**
|
|
* Converts absolute links in text and moves draft files.
|
|
* @param int $draftitemid
|
|
* @param string $text usually html text with embedded links to draft area
|
|
* @param int $contextid
|
|
* @param string $filearea
|
|
* @param int $itemid
|
|
* @param boolean $https force https
|
|
* @return string text with relative links starting with @@PLUGINFILE@@
|
|
*/
|
|
function file_convert_draftarea($text, $draftitemid, $contextid, $filearea, $itemid, $https=false) {
|
|
global $CFG, $USER;
|
|
|
|
if ($CFG->slasharguments) {
|
|
$draftbase = "$CFG->wwwroot/draftfile.php/user_draft/$draftitemid/";
|
|
} else {
|
|
$draftbase = "$CFG->wwwroot/draftfile.php?file=/user_draft/$draftitemid/";
|
|
}
|
|
|
|
if ($https) {
|
|
$draftbase = str_replace('http://', 'https://', $draftbase);
|
|
}
|
|
|
|
// replace absolute links
|
|
$text = str_ireplace($draftbase, '@@PLUGINFILE@@/');
|
|
|
|
$usercontext = get_context_instance(CONTEXT_USER, $USER->id);
|
|
|
|
// move draft files
|
|
$fs = get_file_storage();
|
|
if ($files = $fs->get_area_files($usercontext->id, 'user_draft', $draftitemid, 'id', 'false')) {
|
|
$file_record = array('contextid'=>$contextid, 'filearea'=>$filearea, 'itemid'=>$itemid);
|
|
foreach ($files as $file) {
|
|
$fs->create_file_from_stored($file_record, $file);
|
|
$file->delete();
|
|
}
|
|
}
|
|
|
|
return $text;
|
|
}
|
|
|
|
/**
|
|
* Finds occurences of a link to "draftfile.php" in text and replaces the
|
|
* address based on passed information. Matching is performed using the given
|
|
* current itemid, contextid and filearea and $CFG->wwwroot. This function
|
|
* replaces all the urls for one file. If more than one files were sent, it
|
|
* must be called once for each file.
|
|
*
|
|
* @uses $CFG
|
|
* @see file_storage::move_draft_to_final()
|
|
*
|
|
* @param $text string text to modify
|
|
* @param $contextid int context that the files should be assigned to
|
|
* @param $filepath string filepath under which the files should be saved
|
|
* @param $filearea string filearea into which the files should be saved
|
|
* @param $itemid int the itemid to assign to the files
|
|
* @param $currentcontextid int the current contextid of the files
|
|
* @param $currentfilearea string the current filearea of the files (defaults
|
|
* to "user_draft")
|
|
* @return string modified $text, or null if an error occured.
|
|
*/
|
|
function file_rewrite_urls($text, $contextid, $filepath, $filearea, $itemid, $currentcontextid, $currentfilearea = 'user_draft') {
|
|
global $CFG;
|
|
|
|
$context = get_context_instance_by_id($contextid);
|
|
$currentcontext = get_context_instance_by_id($currentcontextid);
|
|
$fs = get_file_storage();
|
|
|
|
//Make sure this won't match wrong stuff, as much as possible (can probably be improved)
|
|
// * using $currentcontextid in here ensures that we're only matching files belonging to current user
|
|
// * placeholders: {wwwroot}/draftfile.php/{currentcontextid}/{currentfilearea}/{itemid}{/filepath}/{filename}
|
|
// * filepath is optional, everything else is guaranteed to be there.
|
|
$re = '|'. preg_quote($CFG->wwwroot) .'/draftfile.php/'. $currentcontextid .'/'. $currentfilearea .'/([0-9]+)(/[A-Fa-f0-9]+)?/([^\'^"^\>]+)|';
|
|
$matches = array();
|
|
if (!preg_match_all($re, $text, $matches, PREG_SET_ORDER)) {
|
|
return $text; // no draftfile url in text, no replacement necessary.
|
|
}
|
|
|
|
$replacedfiles = array();
|
|
foreach($matches as $file) {
|
|
|
|
$currenturl = $file[0];
|
|
$currentitemid = $file[1];
|
|
if (!empty($file[2])) {
|
|
$currentfilepath = $file[2];
|
|
}
|
|
$currentfilepath .= '/';
|
|
$currentfilename = $file[3];
|
|
|
|
// if a new upload has the same file path/name as an existing file, but different content, we put it in a distinct path.
|
|
$existingfile = $fs->get_file($currentcontextid, $currentfilearea, $currentitemid, $currentfilepath, $currentfilename);
|
|
$uploadedfile = $fs->get_file($contextid, $filearea, $itemid, $filepath, $currentfilename);
|
|
if ($existingfile->get_contenthash() != $uploadedfile->get_contenthash()) {
|
|
$filepath .= $currentitemid .'/';
|
|
}
|
|
|
|
if ($newfiles = $fs->move_draft_to_final($currentitemid, $contextid, $filearea, $itemid, $filepath, false)) {
|
|
foreach($newfiles as $newfile) {
|
|
if (in_array($newfile, $replacedfiles)) {
|
|
// if a file is being used more than once, all occurences will be replaced the first time, so ignore it when it comes back.
|
|
// ..it wouldn't be in user_draft anymore anyway!
|
|
continue;
|
|
}
|
|
$replacedfiles[] = $newfile;
|
|
if ($context->contextlevel == CONTEXT_USER) {
|
|
$newurl = $CFG->wwwroot .'/userfile.php/'. $contextid .'/'. $filearea . $newfile->get_filepath() . $newfile->get_filename();
|
|
} else {
|
|
$newurl = $CFG->wwwroot .'/pluginfile.php/'. $contextid .'/'. $filearea .'/'. $itemid . $newfile->get_filepath() . $newfile->get_filename();
|
|
}
|
|
$text = str_replace('"'. $currenturl .'"', '"'. $newurl .'"', $text);
|
|
}
|
|
} // else file not found, wrong file, or string is just not a file so we leave it alone.
|
|
|
|
}
|
|
return $text;
|
|
}
|
|
|
|
/**
|
|
* Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
|
|
* Due to security concerns only downloads from http(s) sources are supported.
|
|
*
|
|
* @param string $url file url starting with http(s)://
|
|
* @param array $headers http headers, null if none. If set, should be an
|
|
* associative array of header name => value pairs.
|
|
* @param array $postdata array means use POST request with given parameters
|
|
* @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
|
|
* (if false, just returns content)
|
|
* @param int $timeout timeout for complete download process including all file transfer
|
|
* (default 5 minutes)
|
|
* @param int $connecttimeout timeout for connection to server; this is the timeout that
|
|
* usually happens if the remote server is completely down (default 20 seconds);
|
|
* may not work when using proxy
|
|
* @param bool $skipcertverify If true, the peer's SSL certificate will not be checked. Only use this when already in a trusted location.
|
|
* @return mixed false if request failed or content of the file as string if ok.
|
|
*/
|
|
function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false) {
|
|
global $CFG;
|
|
|
|
// some extra security
|
|
$newlines = array("\r", "\n");
|
|
if (is_array($headers) ) {
|
|
foreach ($headers as $key => $value) {
|
|
$headers[$key] = str_replace($newlines, '', $value);
|
|
}
|
|
}
|
|
$url = str_replace($newlines, '', $url);
|
|
if (!preg_match('|^https?://|i', $url)) {
|
|
if ($fullresponse) {
|
|
$response = new object();
|
|
$response->status = 0;
|
|
$response->headers = array();
|
|
$response->response_code = 'Invalid protocol specified in url';
|
|
$response->results = '';
|
|
$response->error = 'Invalid protocol specified in url';
|
|
return $response;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// check if proxy (if used) should be bypassed for this url
|
|
$proxybypass = is_proxybypass( $url );
|
|
|
|
if (!extension_loaded('curl') or ($ch = curl_init($url)) === false) {
|
|
require_once($CFG->libdir.'/snoopy/Snoopy.class.inc');
|
|
$snoopy = new Snoopy();
|
|
$snoopy->read_timeout = $timeout;
|
|
$snoopy->_fp_timeout = $connecttimeout;
|
|
if (!$proxybypass) {
|
|
$snoopy->proxy_host = $CFG->proxyhost;
|
|
$snoopy->proxy_port = $CFG->proxyport;
|
|
if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
|
|
// this will probably fail, but let's try it anyway
|
|
$snoopy->proxy_user = $CFG->proxyuser;
|
|
$snoopy->proxy_password = $CFG->proxypassword;
|
|
}
|
|
}
|
|
|
|
if (is_array($headers) ) {
|
|
$client->rawheaders = $headers;
|
|
}
|
|
|
|
if (is_array($postdata)) {
|
|
$fetch = @$snoopy->fetch($url, $postdata); // use more specific debug code bellow
|
|
} else {
|
|
$fetch = @$snoopy->fetch($url); // use more specific debug code bellow
|
|
}
|
|
|
|
if ($fetch) {
|
|
if ($fullresponse) {
|
|
//fix header line endings
|
|
foreach ($snoopy->headers as $key=>$unused) {
|
|
$snoopy->headers[$key] = trim($snoopy->headers[$key]);
|
|
}
|
|
$response = new object();
|
|
$response->status = $snoopy->status;
|
|
$response->headers = $snoopy->headers;
|
|
$response->response_code = trim($snoopy->response_code);
|
|
$response->results = $snoopy->results;
|
|
$response->error = $snoopy->error;
|
|
return $response;
|
|
|
|
} else if ($snoopy->status != 200) {
|
|
debugging("Snoopy request for \"$url\" failed, http response code: ".$snoopy->response_code, DEBUG_ALL);
|
|
return false;
|
|
|
|
} else {
|
|
return $snoopy->results;
|
|
}
|
|
} else {
|
|
if ($fullresponse) {
|
|
$response = new object();
|
|
$response->status = $snoopy->status;
|
|
$response->headers = array();
|
|
$response->response_code = $snoopy->response_code;
|
|
$response->results = '';
|
|
$response->error = $snoopy->error;
|
|
return $response;
|
|
} else {
|
|
debugging("Snoopy request for \"$url\" failed with: ".$snoopy->error, DEBUG_ALL);
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
// set extra headers
|
|
if (is_array($headers) ) {
|
|
$headers2 = array();
|
|
foreach ($headers as $key => $value) {
|
|
$headers2[] = "$key: $value";
|
|
}
|
|
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers2);
|
|
}
|
|
|
|
|
|
if ($skipcertverify) {
|
|
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
|
|
}
|
|
|
|
// use POST if requested
|
|
if (is_array($postdata)) {
|
|
foreach ($postdata as $k=>$v) {
|
|
$postdata[$k] = urlencode($k).'='.urlencode($v);
|
|
}
|
|
$postdata = implode('&', $postdata);
|
|
curl_setopt($ch, CURLOPT_POST, true);
|
|
curl_setopt($ch, CURLOPT_POSTFIELDS, $postdata);
|
|
}
|
|
|
|
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
|
|
curl_setopt($ch, CURLOPT_HEADER, true);
|
|
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connecttimeout);
|
|
curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
|
|
if (!ini_get('open_basedir') and !ini_get('safe_mode')) {
|
|
// TODO: add version test for '7.10.5'
|
|
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
|
|
curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
|
|
}
|
|
|
|
if (!empty($CFG->proxyhost) and !$proxybypass) {
|
|
// SOCKS supported in PHP5 only
|
|
if (!empty($CFG->proxytype) and ($CFG->proxytype == 'SOCKS5')) {
|
|
if (defined('CURLPROXY_SOCKS5')) {
|
|
curl_setopt($ch, CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
|
|
} else {
|
|
curl_close($ch);
|
|
if ($fullresponse) {
|
|
$response = new object();
|
|
$response->status = '0';
|
|
$response->headers = array();
|
|
$response->response_code = 'SOCKS5 proxy is not supported in PHP4';
|
|
$response->results = '';
|
|
$response->error = 'SOCKS5 proxy is not supported in PHP4';
|
|
return $response;
|
|
} else {
|
|
debugging("SOCKS5 proxy is not supported in PHP4.", DEBUG_ALL);
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, false);
|
|
|
|
if (empty($CFG->proxyport)) {
|
|
curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost);
|
|
} else {
|
|
curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost.':'.$CFG->proxyport);
|
|
}
|
|
|
|
if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
|
|
curl_setopt($ch, CURLOPT_PROXYUSERPWD, $CFG->proxyuser.':'.$CFG->proxypassword);
|
|
if (defined('CURLOPT_PROXYAUTH')) {
|
|
// any proxy authentication if PHP 5.1
|
|
curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_BASIC | CURLAUTH_NTLM);
|
|
}
|
|
}
|
|
}
|
|
|
|
$data = curl_exec($ch);
|
|
|
|
// try to detect encoding problems
|
|
if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
|
|
curl_setopt($ch, CURLOPT_ENCODING, 'none');
|
|
$data = curl_exec($ch);
|
|
}
|
|
|
|
if (curl_errno($ch)) {
|
|
$error = curl_error($ch);
|
|
$error_no = curl_errno($ch);
|
|
curl_close($ch);
|
|
|
|
if ($fullresponse) {
|
|
$response = new object();
|
|
if ($error_no == 28) {
|
|
$response->status = '-100'; // mimic snoopy
|
|
} else {
|
|
$response->status = '0';
|
|
}
|
|
$response->headers = array();
|
|
$response->response_code = $error;
|
|
$response->results = '';
|
|
$response->error = $error;
|
|
return $response;
|
|
} else {
|
|
debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL);
|
|
return false;
|
|
}
|
|
|
|
} else {
|
|
$info = curl_getinfo($ch);
|
|
curl_close($ch);
|
|
|
|
if (empty($info['http_code'])) {
|
|
// for security reasons we support only true http connections (Location: file:// exploit prevention)
|
|
$response = new object();
|
|
$response->status = '0';
|
|
$response->headers = array();
|
|
$response->response_code = 'Unknown cURL error';
|
|
$response->results = ''; // do NOT change this!
|
|
$response->error = 'Unknown cURL error';
|
|
|
|
} else {
|
|
// strip redirect headers and get headers array and content
|
|
$data = explode("\r\n\r\n", $data, $info['redirect_count'] + 2);
|
|
$results = array_pop($data);
|
|
$headers = array_pop($data);
|
|
$headers = explode("\r\n", trim($headers));
|
|
|
|
$response = new object();;
|
|
$response->status = (string)$info['http_code'];
|
|
$response->headers = $headers;
|
|
$response->response_code = $headers[0];
|
|
$response->results = $results;
|
|
$response->error = '';
|
|
}
|
|
|
|
if ($fullresponse) {
|
|
return $response;
|
|
} else if ($info['http_code'] != 200) {
|
|
debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code, DEBUG_ALL);
|
|
return false;
|
|
} else {
|
|
return $response->results;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return List of information about file types based on extensions.
|
|
* Associative array of extension (lower-case) to associative array
|
|
* from 'element name' to data. Current element names are 'type' and 'icon'.
|
|
* Unknown types should use the 'xxx' entry which includes defaults.
|
|
*/
|
|
function get_mimetypes_array() {
|
|
static $mimearray = 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'),
|
|
'csv' => array ('type'=>'text/csv', 'icon'=>'excel.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'),
|
|
'docx' => array ('type'=>'application/msword', 'icon'=>'docx.gif'),
|
|
'docm' => array ('type'=>'application/msword', 'icon'=>'docm.gif'),
|
|
'dotx' => array ('type'=>'application/msword', 'icon'=>'dotx.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'),
|
|
'fdf' => array ('type'=>'application/pdf', 'icon'=>'pdf.gif'),
|
|
'flv' => array ('type'=>'video/x-flv', 'icon'=>'video.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'),
|
|
'htc' => array ('type'=>'text/x-component', 'icon'=>'text.gif'),
|
|
'html' => array ('type'=>'text/html', 'icon'=>'html.gif'),
|
|
'xhtml'=> array ('type'=>'application/xhtml+xml', 'icon'=>'html.gif'),
|
|
'htm' => array ('type'=>'text/html', 'icon'=>'html.gif'),
|
|
'ico' => array ('type'=>'image/vnd.microsoft.icon', 'icon'=>'image.gif'),
|
|
'ics' => array ('type'=>'text/calendar', 'icon'=>'text.gif'),
|
|
'isf' => array ('type'=>'application/inspiration', 'icon'=>'isf.gif'),
|
|
'ist' => array ('type'=>'application/inspiration.template', 'icon'=>'isf.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'=>'odm.gif'),
|
|
'odg' => array ('type'=>'application/vnd.oasis.opendocument.graphics', 'icon'=>'odg.gif'),
|
|
'otg' => array ('type'=>'application/vnd.oasis.opendocument.graphics-template', 'icon'=>'odg.gif'),
|
|
'odp' => array ('type'=>'application/vnd.oasis.opendocument.presentation', 'icon'=>'odp.gif'),
|
|
'otp' => array ('type'=>'application/vnd.oasis.opendocument.presentation-template', 'icon'=>'odp.gif'),
|
|
'ods' => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet', 'icon'=>'ods.gif'),
|
|
'ots' => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet-template', 'icon'=>'ods.gif'),
|
|
'odc' => array ('type'=>'application/vnd.oasis.opendocument.chart', 'icon'=>'odc.gif'),
|
|
'odf' => array ('type'=>'application/vnd.oasis.opendocument.formula', 'icon'=>'odf.gif'),
|
|
'odb' => array ('type'=>'application/vnd.oasis.opendocument.database', 'icon'=>'odb.gif'),
|
|
'odi' => array ('type'=>'application/vnd.oasis.opendocument.image', 'icon'=>'odi.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'),
|
|
'pptx' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'pptx.gif'),
|
|
'pptm' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'pptm.gif'),
|
|
'potx' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'potx.gif'),
|
|
'potm' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'potm.gif'),
|
|
'ppam' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'ppam.gif'),
|
|
'ppsx' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'ppsx.gif'),
|
|
'ppsm' => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'ppsm.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'),
|
|
'svg' => array ('type'=>'image/svg+xml', 'icon'=>'image.gif'),
|
|
'svgz' => array ('type'=>'image/svg+xml', 'icon'=>'image.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'),
|
|
'xdp' => array ('type'=>'application/pdf', 'icon'=>'pdf.gif'),
|
|
'xfd' => array ('type'=>'application/pdf', 'icon'=>'pdf.gif'),
|
|
'xfdf' => array ('type'=>'application/pdf', 'icon'=>'pdf.gif'),
|
|
'xls' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'excel.gif'),
|
|
'xlsx' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'xlsx.gif'),
|
|
'xlsm' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'xlsm.gif'),
|
|
'xltx' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'xltx.gif'),
|
|
'xltm' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'xltm.gif'),
|
|
'xlsb' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'xlsb.gif'),
|
|
'xlam' => array ('type'=>'application/vnd.ms-excel', 'icon'=>'xlam.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')
|
|
);
|
|
return $mimearray;
|
|
}
|
|
|
|
/**
|
|
* Obtains information about a filetype based on its extension. Will
|
|
* use a default if no information is present about that particular
|
|
* extension.
|
|
* @param string $element Desired information (usually 'icon'
|
|
* for icon filename or 'type' for MIME type)
|
|
* @param string $filename Filename we're looking up
|
|
* @return string Requested piece of information from array
|
|
*/
|
|
function mimeinfo($element, $filename) {
|
|
$mimeinfo = get_mimetypes_array();
|
|
|
|
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
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Obtains information about a filetype based on the MIME type rather than
|
|
* the other way around.
|
|
* @param string $element Desired information (usually 'icon')
|
|
* @param string $mimetype MIME type we're looking up
|
|
* @return string Requested piece of information from array
|
|
*/
|
|
function mimeinfo_from_type($element, $mimetype) {
|
|
$mimeinfo = get_mimetypes_array();
|
|
|
|
foreach($mimeinfo as $values) {
|
|
if($values['type']==$mimetype) {
|
|
if(isset($values[$element])) {
|
|
return $values[$element];
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
return $mimeinfo['xxx'][$element]; // Default
|
|
}
|
|
|
|
/**
|
|
* Get information about a filetype based on the icon file.
|
|
* @param string $element Desired information (usually 'icon')
|
|
* @param string $icon Icon file path.
|
|
* @param boolean $all return all matching entries (defaults to false - last match)
|
|
* @return string Requested piece of information from array
|
|
*/
|
|
function mimeinfo_from_icon($element, $icon, $all=false) {
|
|
$mimeinfo = get_mimetypes_array();
|
|
|
|
if (preg_match("/\/(.*)/", $icon, $matches)) {
|
|
$icon = $matches[1];
|
|
}
|
|
$info = array($mimeinfo['xxx'][$element]); // Default
|
|
foreach($mimeinfo as $values) {
|
|
if($values['icon']==$icon) {
|
|
if(isset($values[$element])) {
|
|
$info[] = $values[$element];
|
|
}
|
|
//No break, for example for 'excel.gif' we don't want 'csv'!
|
|
}
|
|
}
|
|
if ($all) {
|
|
return $info;
|
|
}
|
|
return array_pop($info); // Return last match (mimicking behaviour/comment inside foreach loop)
|
|
}
|
|
|
|
/**
|
|
* Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
|
|
* mimetypes.php language file.
|
|
* @param string $mimetype MIME type (can be obtained using the mimeinfo function)
|
|
* @param bool $capitalise If true, capitalises first character of result
|
|
* @return string Text description
|
|
*/
|
|
function get_mimetype_description($mimetype,$capitalise=false) {
|
|
$result=get_string($mimetype,'mimetypes');
|
|
// Surrounded by square brackets indicates that there isn't a string for that
|
|
// (maybe there is a better way to find this out?)
|
|
if(strpos($result,'[')===0) {
|
|
$result=get_string('document/unknown','mimetypes');
|
|
}
|
|
if($capitalise) {
|
|
$result=ucfirst($result);
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Reprot file is not found or not accessible
|
|
* @return does not return, terminates script
|
|
*/
|
|
function send_file_not_found() {
|
|
global $CFG, $COURSE;
|
|
header('HTTP/1.0 404 not found');
|
|
print_error('filenotfound', 'error', $CFG->wwwroot.'/course/view.php?id='.$COURSE->id); //this is not displayed on IIS??
|
|
}
|
|
|
|
/**
|
|
* Handles the sending of temporary file to user, download is forced.
|
|
* File is deleted after abort or succesful sending.
|
|
* @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
|
|
* @param string $filename proposed file name when saving file
|
|
* @param bool $path is content of file
|
|
* @return does not return, script terminated
|
|
*/
|
|
function send_temp_file($path, $filename, $pathisstring=false) {
|
|
global $CFG;
|
|
|
|
// close session - not needed anymore
|
|
@session_write_close();
|
|
|
|
if (!$pathisstring) {
|
|
if (!file_exists($path)) {
|
|
header('HTTP/1.0 404 not found');
|
|
print_error('filenotfound', 'error', $CFG->wwwroot.'/');
|
|
}
|
|
// executed after normal finish or abort
|
|
@register_shutdown_function('send_temp_file_finished', $path);
|
|
}
|
|
|
|
//IE compatibiltiy HACK!
|
|
if (ini_get('zlib.output_compression')) {
|
|
ini_set('zlib.output_compression', 'Off');
|
|
}
|
|
|
|
// if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
|
|
if (check_browser_version('MSIE')) {
|
|
$filename = urlencode($filename);
|
|
}
|
|
|
|
$filesize = $pathisstring ? strlen($path) : filesize($path);
|
|
|
|
@header('Content-Disposition: attachment; filename='.$filename);
|
|
@header('Content-Length: '.$filesize);
|
|
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
|
|
|
|
while (@ob_end_flush()); //flush the buffers - save memory and disable sid rewrite
|
|
if ($pathisstring) {
|
|
echo $path;
|
|
} else {
|
|
@readfile($path);
|
|
}
|
|
|
|
die; //no more chars to output
|
|
}
|
|
|
|
/**
|
|
* Internal callnack function used by send_temp_file()
|
|
*/
|
|
function send_temp_file_finished($path) {
|
|
if (file_exists($path)) {
|
|
@unlink($path);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles the sending of file data to the user's browser, including support for
|
|
* byteranges etc.
|
|
* @param string $path Path of file on disk (including real filename), or actual content of file as string
|
|
* @param string $filename Filename to send
|
|
* @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
|
|
* @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
|
|
* @param bool $pathisstring If true (default false), $path is the content to send and not the pathname
|
|
* @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
|
|
* @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
|
|
* @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
|
|
* if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
|
|
* you must detect this case when control is returned using connection_aborted. Please not that session is closed
|
|
* and should not be reopened.
|
|
* @return no return or void, script execution stopped unless $dontdie is true
|
|
*/
|
|
function send_file($path, $filename, $lifetime = 'default' , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='', $dontdie=false) {
|
|
global $CFG, $COURSE, $SESSION;
|
|
|
|
if ($dontdie) {
|
|
ignore_user_abort(true);
|
|
}
|
|
|
|
// MDL-11789, apply $CFG->filelifetime here
|
|
if ($lifetime === 'default') {
|
|
if (!empty($CFG->filelifetime)) {
|
|
$filetime = $CFG->filelifetime;
|
|
} else {
|
|
$filetime = 86400;
|
|
}
|
|
}
|
|
|
|
session_write_close(); // unlock session during fileserving
|
|
|
|
// Use given MIME type if specified, otherwise guess it using mimeinfo.
|
|
// IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
|
|
// only Firefox saves all files locally before opening when content-disposition: attachment stated
|
|
$isFF = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
|
|
$mimetype = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
|
|
($mimetype ? $mimetype : mimeinfo('type', $filename));
|
|
$lastmodified = $pathisstring ? time() : filemtime($path);
|
|
$filesize = $pathisstring ? strlen($path) : filesize($path);
|
|
|
|
/* - MDL-13949
|
|
//Adobe Acrobat Reader XSS prevention
|
|
if ($mimetype=='application/pdf' or mimeinfo('type', $filename)=='application/pdf') {
|
|
//please note that it prevents opening of pdfs in browser when http referer disabled
|
|
//or file linked from another site; browser caching of pdfs is now disabled too
|
|
if (!empty($_SERVER['HTTP_RANGE'])) {
|
|
//already byteserving
|
|
$lifetime = 1; // >0 needed for byteserving
|
|
} else if (empty($_SERVER['HTTP_REFERER']) or strpos($_SERVER['HTTP_REFERER'], $CFG->wwwroot)!==0) {
|
|
$mimetype = 'application/x-forcedownload';
|
|
$forcedownload = true;
|
|
$lifetime = 0;
|
|
} else {
|
|
$lifetime = 1; // >0 needed for byteserving
|
|
}
|
|
}
|
|
*/
|
|
|
|
//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 user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
|
|
if (check_browser_version('MSIE')) {
|
|
$filename = rawurlencode($filename);
|
|
}
|
|
|
|
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) {
|
|
$handle = fopen($filename, 'rb');
|
|
byteserving_send_file($handle, $mimetype, $ranges, $filesize);
|
|
}
|
|
}
|
|
} 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 (empty($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 = $SESSION->sid_ob_rewrite($path);
|
|
$filesize = strlen($path);
|
|
$pathisstring = true;
|
|
} else if ($mimetype == 'text/plain') {
|
|
@header('Content-Type: Text/plain; charset=utf-8'); //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($path);
|
|
}
|
|
} else { // Try to put the file through filters
|
|
if ($mimetype == 'text/html') {
|
|
$options = new object();
|
|
$options->noclean = true;
|
|
$options->nocache = true; // temporary workaround for MDL-5136
|
|
$text = $pathisstring ? $path : implode('', file($path));
|
|
|
|
$text = file_modify_html_header($text);
|
|
$output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
|
|
if (!empty($CFG->usesid) && empty($_COOKIE['MoodleSession'.$CFG->sessioncookie])) {
|
|
//cookieless mode - rewrite links
|
|
$output = $SESSION->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;
|
|
// only filter text if filter all files is selected
|
|
} else if (($mimetype == 'text/plain') and ($filter == 1)) {
|
|
$options = new object();
|
|
$options->newlines = false;
|
|
$options->noclean = true;
|
|
$text = htmlentities($pathisstring ? $path : implode('', file($path)));
|
|
$output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
|
|
if (!empty($CFG->usesid) && empty($_COOKIE['MoodleSession'.$CFG->sessioncookie])) {
|
|
//cookieless mode - rewrite links
|
|
$output = $SESSION->sid_ob_rewrite($output);
|
|
}
|
|
|
|
@header('Content-Length: '.strlen($output));
|
|
@header('Content-Type: text/html; charset=utf-8'); //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($path);
|
|
}
|
|
}
|
|
}
|
|
if ($dontdie) {
|
|
return;
|
|
}
|
|
die; //no more chars to output!!!
|
|
}
|
|
|
|
/**
|
|
* Handles the sending of file data to the user's browser, including support for
|
|
* byteranges etc.
|
|
* @param object $stored_file local file object
|
|
* @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
|
|
* @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
|
|
* @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
|
|
* @param string $filename Override filename
|
|
* @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
|
|
* @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
|
|
* if this is passed as true, ignore_user_abort is called. if you don't want your processing to continue on cancel,
|
|
* you must detect this case when control is returned using connection_aborted. Please not that session is closed
|
|
* and should not be reopened.
|
|
* @return no return or void, script execution stopped unless $dontdie is true
|
|
*/
|
|
function send_stored_file($stored_file, $lifetime=86400 , $filter=0, $forcedownload=false, $filename=null, $dontdie=false) {
|
|
global $CFG, $COURSE, $SESSION;
|
|
|
|
if ($dontdie) {
|
|
ignore_user_abort(true);
|
|
}
|
|
|
|
session_write_close(); // unlock session during fileserving
|
|
|
|
// Use given MIME type if specified, otherwise guess it using mimeinfo.
|
|
// IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
|
|
// only Firefox saves all files locally before opening when content-disposition: attachment stated
|
|
$filename = is_null($filename) ? $stored_file->get_filename() : $filename;
|
|
$isFF = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
|
|
$mimetype = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
|
|
($stored_file->get_mimetype() ? $stored_file->get_mimetype() : mimeinfo('type', $filename));
|
|
$lastmodified = $stored_file->get_timemodified();
|
|
$filesize = $stored_file->get_filesize();
|
|
|
|
//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 user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
|
|
if (check_browser_version('MSIE')) {
|
|
$filename = rawurlencode($filename);
|
|
}
|
|
|
|
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) && $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($stored_file->get_content_file_handle(), $mimetype, $ranges, $filesize);
|
|
}
|
|
}
|
|
} 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 (empty($filter)) {
|
|
$filtered = false;
|
|
if ($mimetype == 'text/html' && !empty($CFG->usesid) && empty($_COOKIE['MoodleSession'.$CFG->sessioncookie])) {
|
|
//cookieless mode - rewrite links
|
|
@header('Content-Type: text/html');
|
|
$text = $stored_file->get_content();
|
|
$text = $SESSION->sid_ob_rewrite($text);
|
|
$filesize = strlen($text);
|
|
$filtered = true;
|
|
} else if ($mimetype == 'text/plain') {
|
|
@header('Content-Type: Text/plain; charset=utf-8'); //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 ($filtered) {
|
|
echo $text;
|
|
} else {
|
|
$stored_file->readfile();
|
|
}
|
|
|
|
} else { // Try to put the file through filters
|
|
if ($mimetype == 'text/html') {
|
|
$options = new object();
|
|
$options->noclean = true;
|
|
$options->nocache = true; // temporary workaround for MDL-5136
|
|
$text = $stored_file->get_content();
|
|
$text = file_modify_html_header($text);
|
|
$output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
|
|
if (!empty($CFG->usesid) && empty($_COOKIE['MoodleSession'.$CFG->sessioncookie])) {
|
|
//cookieless mode - rewrite links
|
|
$output = $SESSION->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;
|
|
// only filter text if filter all files is selected
|
|
} else if (($mimetype == 'text/plain') and ($filter == 1)) {
|
|
$options = new object();
|
|
$options->newlines = false;
|
|
$options->noclean = true;
|
|
$text = $stored_file->get_content();
|
|
$output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
|
|
if (!empty($CFG->usesid) && empty($_COOKIE['MoodleSession'.$CFG->sessioncookie])) {
|
|
//cookieless mode - rewrite links
|
|
$output = $SESSION->sid_ob_rewrite($output);
|
|
}
|
|
|
|
@header('Content-Length: '.strlen($output));
|
|
@header('Content-Type: text/html; charset=utf-8'); //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
|
|
$stored_file->readfile();
|
|
}
|
|
}
|
|
if ($dontdie) {
|
|
return;
|
|
}
|
|
die; //no more chars to output!!!
|
|
}
|
|
|
|
function get_records_csv($file, $table) {
|
|
global $CFG, $DB;
|
|
|
|
if (!$metacolumns = $DB->get_columns($table)) {
|
|
return false;
|
|
}
|
|
|
|
if(!($handle = @fopen($file, 'r'))) {
|
|
print_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->get_columns($table)) {
|
|
return false;
|
|
}
|
|
|
|
echo "x";
|
|
|
|
if(!($fp = @fopen($CFG->dataroot.'/temp/'.$file, 'w'))) {
|
|
print_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;
|
|
}
|
|
|
|
|
|
/**
|
|
* Recursively delete the file or folder with path $location. That is,
|
|
* if it is a file delete it. If it is a folder, delete all its content
|
|
* then delete it. If $location does not exist to start, that is not
|
|
* considered an error.
|
|
*
|
|
* @param $location the path to remove.
|
|
*/
|
|
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 (file_exists($location)) {
|
|
if (!unlink($location)) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Send requested byterange of file.
|
|
*/
|
|
function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
|
|
$chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
|
|
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);
|
|
@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;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* add includes (js and css) into uploaded files
|
|
* before returning them, useful for themes and utf.js includes
|
|
* @param string text - text to search and replace
|
|
* @return string - text with added head includes
|
|
*/
|
|
function file_modify_html_header($text) {
|
|
// first look for <head> tag
|
|
global $CFG;
|
|
|
|
$stylesheetshtml = '';
|
|
foreach ($CFG->stylesheets as $stylesheet) {
|
|
$stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
|
|
}
|
|
|
|
$filters = explode(",", $CFG->textfilters);
|
|
if (in_array('filter/mediaplugin', $filters)) {
|
|
// this script is needed by most media filter plugins.
|
|
$ufo = "\n".'<script type="text/javascript" src="'.$CFG->wwwroot.'/lib/ufo.js"></script>'."\n";
|
|
} else {
|
|
$ufo = '';
|
|
}
|
|
|
|
preg_match('/\<head\>|\<HEAD\>/', $text, $matches);
|
|
if ($matches) {
|
|
$replacement = '<head>'.$ufo.$stylesheetshtml;
|
|
$text = preg_replace('/\<head\>|\<HEAD\>/', $replacement, $text, 1);
|
|
return $text;
|
|
}
|
|
|
|
// if not, look for <html> tag, and stick <head> right after
|
|
preg_match('/\<html\>|\<HTML\>/', $text, $matches);
|
|
if ($matches) {
|
|
// replace <html> tag with <html><head>includes</head>
|
|
$replacement = '<html>'."\n".'<head>'.$ufo.$stylesheetshtml.'</head>';
|
|
$text = preg_replace('/\<html\>|\<HTML\>/', $replacement, $text, 1);
|
|
return $text;
|
|
}
|
|
|
|
// if not, look for <body> tag, and stick <head> before body
|
|
preg_match('/\<body\>|\<BODY\>/', $text, $matches);
|
|
if ($matches) {
|
|
$replacement = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".'<body>';
|
|
$text = preg_replace('/\<body\>|\<BODY\>/', $replacement, $text, 1);
|
|
return $text;
|
|
}
|
|
|
|
// if not, just stick a <head> tag at the beginning
|
|
$text = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".$text;
|
|
return $text;
|
|
}
|
|
|
|
/**
|
|
* RESTful cURL class
|
|
*
|
|
* This is a wrapper class for curl, it is quite easy to use:
|
|
*
|
|
* $c = new curl;
|
|
* // enable cache
|
|
* $c = new curl(array('cache'=>true));
|
|
* // enable cookie
|
|
* $c = new curl(array('cookie'=>true));
|
|
* // enable proxy
|
|
* $c = new curl(array('proxy'=>true));
|
|
*
|
|
* // HTTP GET Method
|
|
* $html = $c->get('http://example.com');
|
|
* // HTTP POST Method
|
|
* $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
|
|
* // HTTP PUT Method
|
|
* $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
|
|
*
|
|
* @author Dongsheng Cai <dongsheng@cvs.moodle.org>
|
|
* @version 0.4 dev
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
|
|
*/
|
|
|
|
class curl {
|
|
public $cache = false;
|
|
public $proxy = false;
|
|
public $version = '0.4 dev';
|
|
public $response = array();
|
|
public $header = array();
|
|
public $info;
|
|
public $error;
|
|
|
|
private $options;
|
|
private $proxy_host = '';
|
|
private $proxy_auth = '';
|
|
private $proxy_type = '';
|
|
private $debug = false;
|
|
private $cookie = false;
|
|
|
|
public function __construct($options = array()){
|
|
global $CFG;
|
|
if (!function_exists('curl_init')) {
|
|
$this->error = 'cURL module must be enabled!';
|
|
trigger_error($this->error, E_USER_ERROR);
|
|
return false;
|
|
}
|
|
// the options of curl should be init here.
|
|
$this->resetopt();
|
|
if (!empty($options['debug'])) {
|
|
$this->debug = true;
|
|
}
|
|
if(!empty($options['cookie'])) {
|
|
if($options['cookie'] === true) {
|
|
$this->cookie = $CFG->dataroot.'/curl_cookie.txt';
|
|
} else {
|
|
$this->cookie = $options['cookie'];
|
|
}
|
|
}
|
|
if (!empty($options['cache'])) {
|
|
if (class_exists('curl_cache')) {
|
|
$this->cache = new curl_cache;
|
|
}
|
|
}
|
|
if (!empty($options['proxy'])) {
|
|
if (!empty($CFG->proxyhost)) {
|
|
if (empty($CFG->proxyport)) {
|
|
$this->proxy_host = $CFG->proxyhost;
|
|
} else {
|
|
$this->proxy_host = $CFG->proxyhost.':'.$CFG->proxyport;
|
|
}
|
|
if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
|
|
$this->proxy_auth = $CFG->proxyuser.':'.$CFG->proxypassword;
|
|
$this->setopt(array(
|
|
'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM,
|
|
'proxyuserpwd'=>$this->proxy_auth));
|
|
}
|
|
if (!empty($CFG->proxytype)) {
|
|
if ($CFG->proxytype == 'SOCKS5') {
|
|
$this->proxy_type = CURLPROXY_SOCKS5;
|
|
} else {
|
|
$this->proxy_type = CURLPROXY_HTTP;
|
|
$this->setopt(array('httpproxytunnel'=>true));
|
|
}
|
|
$this->setopt(array('proxytype'=>$this->proxy_type));
|
|
}
|
|
}
|
|
if (!empty($this->proxy_host)) {
|
|
$this->proxy = array('proxy'=>$this->proxy_host);
|
|
}
|
|
}
|
|
}
|
|
public function resetopt(){
|
|
$this->options = array();
|
|
$this->options['CURLOPT_USERAGENT'] = 'MoodleBot/1.0';
|
|
// True to include the header in the output
|
|
$this->options['CURLOPT_HEADER'] = 0;
|
|
// True to Exclude the body from the output
|
|
$this->options['CURLOPT_NOBODY'] = 0;
|
|
// TRUE to follow any "Location: " header that the server
|
|
// sends as part of the HTTP header (note this is recursive,
|
|
// PHP will follow as many "Location: " headers that it is sent,
|
|
// unless CURLOPT_MAXREDIRS is set).
|
|
$this->options['CURLOPT_FOLLOWLOCATION'] = 1;
|
|
$this->options['CURLOPT_MAXREDIRS'] = 10;
|
|
$this->options['CURLOPT_ENCODING'] = '';
|
|
// TRUE to return the transfer as a string of the return
|
|
// value of curl_exec() instead of outputting it out directly.
|
|
$this->options['CURLOPT_RETURNTRANSFER'] = 1;
|
|
$this->options['CURLOPT_BINARYTRANSFER'] = 0;
|
|
$this->options['CURLOPT_SSL_VERIFYPEER'] = 0;
|
|
$this->options['CURLOPT_SSL_VERIFYHOST'] = 2;
|
|
$this->options['CURLOPT_CONNECTTIMEOUT'] = 30;
|
|
}
|
|
|
|
/**
|
|
* Reset Cookie
|
|
*
|
|
* @param array $options If array is null, this function will
|
|
* reset the options to default value.
|
|
*
|
|
*/
|
|
public function resetcookie() {
|
|
if (!empty($this->cookie)) {
|
|
if (is_file($this->cookie)) {
|
|
$fp = fopen($this->cookie, 'w');
|
|
if (!empty($fp)) {
|
|
fwrite($fp, '');
|
|
fclose($fp);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set curl options
|
|
*
|
|
* @param array $options If array is null, this function will
|
|
* reset the options to default value.
|
|
*
|
|
*/
|
|
public function setopt($options = array()) {
|
|
if (is_array($options)) {
|
|
foreach($options as $name => $val){
|
|
if (stripos($name, 'CURLOPT_') === false) {
|
|
$name = strtoupper('CURLOPT_'.$name);
|
|
}
|
|
$this->options[$name] = $val;
|
|
}
|
|
}
|
|
}
|
|
/**
|
|
* Reset http method
|
|
*
|
|
*/
|
|
public function cleanopt(){
|
|
unset($this->options['CURLOPT_HTTPGET']);
|
|
unset($this->options['CURLOPT_POST']);
|
|
unset($this->options['CURLOPT_POSTFIELDS']);
|
|
unset($this->options['CURLOPT_PUT']);
|
|
unset($this->options['CURLOPT_INFILE']);
|
|
unset($this->options['CURLOPT_INFILESIZE']);
|
|
unset($this->options['CURLOPT_CUSTOMREQUEST']);
|
|
}
|
|
|
|
/**
|
|
* Set HTTP Request Header
|
|
*
|
|
* @param array $headers
|
|
*
|
|
*/
|
|
public function setHeader($header) {
|
|
if (is_array($header)){
|
|
foreach ($header as $v) {
|
|
$this->setHeader($v);
|
|
}
|
|
} else {
|
|
$this->header[] = $header;
|
|
}
|
|
}
|
|
/**
|
|
* Set HTTP Response Header
|
|
*
|
|
*/
|
|
public function getResponse(){
|
|
return $this->response;
|
|
}
|
|
/**
|
|
* private callback function
|
|
* Formatting HTTP Response Header
|
|
*
|
|
*/
|
|
private function formatHeader($ch, $header)
|
|
{
|
|
$this->count++;
|
|
if (strlen($header) > 2) {
|
|
list($key, $value) = explode(" ", rtrim($header, "\r\n"), 2);
|
|
$key = rtrim($key, ':');
|
|
if (!empty($this->response[$key])) {
|
|
if (is_array($this->response[$key])){
|
|
$this->response[$key][] = $value;
|
|
} else {
|
|
$tmp = $this->response[$key];
|
|
$this->response[$key] = array();
|
|
$this->response[$key][] = $tmp;
|
|
$this->response[$key][] = $value;
|
|
|
|
}
|
|
} else {
|
|
$this->response[$key] = $value;
|
|
}
|
|
}
|
|
return strlen($header);
|
|
}
|
|
|
|
/**
|
|
* Set options for individual curl instance
|
|
*/
|
|
private function apply_opt($curl, $options) {
|
|
// Clean up
|
|
$this->cleanopt();
|
|
// set cookie
|
|
if (!empty($this->cookie) || !empty($options['cookie'])) {
|
|
$this->setopt(array('cookiejar'=>$this->cookie,
|
|
'cookiefile'=>$this->cookie
|
|
));
|
|
}
|
|
|
|
// set proxy
|
|
if (!empty($this->proxy) || !empty($options['proxy'])) {
|
|
$this->setopt($this->proxy);
|
|
}
|
|
$this->setopt($options);
|
|
// reset before set options
|
|
curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this,'formatHeader'));
|
|
// set headers
|
|
if (empty($this->header)){
|
|
$this->setHeader(array(
|
|
'User-Agent: MoodleBot/1.0',
|
|
'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
|
|
'Connection: keep-alive'
|
|
));
|
|
}
|
|
curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
|
|
|
|
if ($this->debug){
|
|
echo '<h1>Options</h1>';
|
|
var_dump($this->options);
|
|
echo '<h1>Header</h1>';
|
|
var_dump($this->header);
|
|
}
|
|
|
|
// set options
|
|
foreach($this->options as $name => $val) {
|
|
if (is_string($name)) {
|
|
$name = constant(strtoupper($name));
|
|
}
|
|
curl_setopt($curl, $name, $val);
|
|
}
|
|
return $curl;
|
|
}
|
|
/*
|
|
* Download multiple files in parallel
|
|
* $c = new curl;
|
|
* $c->download(array(
|
|
* array('url'=>'http://localhost/', 'file'=>fopen('a', 'wb')),
|
|
* array('url'=>'http://localhost/20/', 'file'=>fopen('b', 'wb'))
|
|
* ));
|
|
*/
|
|
public function download($requests, $options = array()) {
|
|
$options['CURLOPT_BINARYTRANSFER'] = 1;
|
|
$options['RETURNTRANSFER'] = false;
|
|
return $this->multi($requests, $options);
|
|
}
|
|
/*
|
|
* Mulit HTTP Requests
|
|
* This function could run multi-requests in parallel.
|
|
*/
|
|
protected function multi($requests, $options = array()) {
|
|
$count = count($requests);
|
|
$handles = array();
|
|
$results = array();
|
|
$main = curl_multi_init();
|
|
for ($i = 0; $i < $count; $i++) {
|
|
$url = $requests[$i];
|
|
foreach($url as $n=>$v){
|
|
$options[$n] = $url[$n];
|
|
}
|
|
$handles[$i] = curl_init($url['url']);
|
|
$this->apply_opt($handles[$i], $options);
|
|
curl_multi_add_handle($main, $handles[$i]);
|
|
}
|
|
$running = 0;
|
|
do {
|
|
curl_multi_exec($main, $running);
|
|
} while($running > 0);
|
|
for ($i = 0; $i < $count; $i++) {
|
|
if (!empty($optins['CURLOPT_RETURNTRANSFER'])) {
|
|
$results[] = true;
|
|
} else {
|
|
$results[] = curl_multi_getcontent($handles[$i]);
|
|
}
|
|
curl_multi_remove_handle($main, $handles[$i]);
|
|
}
|
|
curl_multi_close($main);
|
|
return $results;
|
|
}
|
|
/**
|
|
* Single HTTP Request
|
|
*/
|
|
protected function request($url, $options = array()){
|
|
// create curl instance
|
|
$curl = curl_init($url);
|
|
$options['url'] = $url;
|
|
$this->apply_opt($curl, $options);
|
|
if ($this->cache && $ret = $this->cache->get($this->options)) {
|
|
return $ret;
|
|
} else {
|
|
$ret = curl_exec($curl);
|
|
if ($this->cache) {
|
|
$this->cache->set($this->options, $ret);
|
|
}
|
|
}
|
|
|
|
$this->info = curl_getinfo($curl);
|
|
$this->error = curl_error($curl);
|
|
|
|
if ($this->debug){
|
|
echo '<h1>Return Data</h1>';
|
|
var_dump($ret);
|
|
echo '<h1>Info</h1>';
|
|
var_dump($this->info);
|
|
echo '<h1>Error</h1>';
|
|
var_dump($this->error);
|
|
}
|
|
|
|
curl_close($curl);
|
|
|
|
if (empty($this->error)){
|
|
return $ret;
|
|
} else {
|
|
throw new moodle_exception($this->error, 'curl');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* HTTP HEAD method
|
|
*/
|
|
public function head($url, $options = array()){
|
|
$options['CURLOPT_HTTPGET'] = 0;
|
|
$options['CURLOPT_HEADER'] = 1;
|
|
$options['CURLOPT_NOBODY'] = 1;
|
|
return $this->request($url, $options);
|
|
}
|
|
|
|
/**
|
|
* HTTP POST method
|
|
*/
|
|
public function post($url, $params = array(), $options = array()){
|
|
$options['CURLOPT_POST'] = 1;
|
|
$this->_tmp_file_post_params = array();
|
|
foreach ($params as $key => $value) {
|
|
if ($value instanceof stored_file) {
|
|
$value->add_to_curl_request($this, $key);
|
|
} else {
|
|
$this->_tmp_file_post_params[$key] = $value;
|
|
}
|
|
}
|
|
$options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
|
|
unset($this->_tmp_file_post_params);
|
|
return $this->request($url, $options);
|
|
}
|
|
|
|
/**
|
|
* HTTP GET method
|
|
*/
|
|
public function get($url, $params = array(), $options = array()){
|
|
$options['CURLOPT_HTTPGET'] = 1;
|
|
|
|
if (!empty($params)){
|
|
$url .= (stripos($url, '?') !== false) ? '&' : '?';
|
|
$url .= http_build_query($params, '', '&');
|
|
}
|
|
return $this->request($url, $options);
|
|
}
|
|
|
|
/**
|
|
* HTTP PUT method
|
|
*/
|
|
public function put($url, $params = array(), $options = array()){
|
|
$file = $params['file'];
|
|
if (!is_file($file)){
|
|
return null;
|
|
}
|
|
$fp = fopen($file, 'r');
|
|
$size = filesize($file);
|
|
$options['CURLOPT_PUT'] = 1;
|
|
$options['CURLOPT_INFILESIZE'] = $size;
|
|
$options['CURLOPT_INFILE'] = $fp;
|
|
if (!isset($this->options['CURLOPT_USERPWD'])){
|
|
$this->setopt(array('CURLOPT_USERPWD'=>'anonymous: noreply@moodle.org'));
|
|
}
|
|
$ret = $this->request($url, $options);
|
|
fclose($fp);
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* HTTP DELETE method
|
|
*/
|
|
public function delete($url, $param = array(), $options = array()){
|
|
$options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
|
|
if (!isset($options['CURLOPT_USERPWD'])) {
|
|
$options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
|
|
}
|
|
$ret = $this->request($url, $options);
|
|
return $ret;
|
|
}
|
|
/**
|
|
* HTTP TRACE method
|
|
*/
|
|
public function trace($url, $options = array()){
|
|
$options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
|
|
$ret = $this->request($url, $options);
|
|
return $ret;
|
|
}
|
|
/**
|
|
* HTTP OPTIONS method
|
|
*/
|
|
public function options($url, $options = array()){
|
|
$options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
|
|
$ret = $this->request($url, $options);
|
|
return $ret;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This class is used by cURL class, use case:
|
|
*
|
|
* $CFG->repository_cache_expire = 120;
|
|
* $c = new curl(array('cache'=>true));
|
|
* $ret = $c->get('http://www.google.com');
|
|
*
|
|
*/
|
|
class curl_cache {
|
|
public $dir = '';
|
|
function __construct(){
|
|
global $CFG;
|
|
if (!file_exists($CFG->dataroot.'/cache/repository/')) {
|
|
mkdir($CFG->dataroot.'/cache/repository/', 0777, true);
|
|
}
|
|
if(is_dir($CFG->dataroot.'/cache/repository/')) {
|
|
$this->dir = $CFG->dataroot.'/cache/repository/';
|
|
}
|
|
if (empty($CFG->repository_cache_expire)) {
|
|
$CFG->repository_cache_expire = 120;
|
|
}
|
|
}
|
|
public function get($param){
|
|
global $CFG, $USER;
|
|
$this->cleanup($CFG->repository_cache_expire);
|
|
$filename = 'u'.$USER->id.'_'.md5(serialize($param));
|
|
if(file_exists($this->dir.$filename)) {
|
|
$lasttime = filemtime($this->dir.$filename);
|
|
if(time()-$lasttime > $CFG->repository_cache_expire)
|
|
{
|
|
return false;
|
|
} else {
|
|
$fp = fopen($this->dir.$filename, 'r');
|
|
$size = filesize($this->dir.$filename);
|
|
$content = fread($fp, $size);
|
|
return unserialize($content);
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
public function set($param, $val){
|
|
global $CFG, $USER;
|
|
$filename = 'u'.$USER->id.'_'.md5(serialize($param));
|
|
$fp = fopen($this->dir.$filename, 'w');
|
|
fwrite($fp, serialize($val));
|
|
fclose($fp);
|
|
}
|
|
public function cleanup($expire){
|
|
if($dir = opendir($this->dir)){
|
|
while (false !== ($file = readdir($dir))) {
|
|
if(!is_dir($file) && $file != '.' && $file != '..') {
|
|
$lasttime = @filemtime($this->dir.$file);
|
|
if(time() - $lasttime > $expire){
|
|
@unlink($this->dir.$file);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
/**
|
|
* delete current user's cache file
|
|
*
|
|
* @return null
|
|
*/
|
|
public function refresh(){
|
|
global $CFG, $USER;
|
|
if($dir = opendir($this->dir)){
|
|
while (false !== ($file = readdir($dir))) {
|
|
if(!is_dir($file) && $file != '.' && $file != '..') {
|
|
if(strpos($file, 'u'.$USER->id.'_')!==false){
|
|
@unlink($this->dir.$file);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|