7d8830bcb7ecb86fbc33d02a6c7f4992da404200
[moodle.git] / lib / filelib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Functions for file handling.
20  *
21  * @package    core
22  * @subpackage file
23  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /** @var string unique string constant. */
30 define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7');
32 require_once("$CFG->libdir/filestorage/file_exceptions.php");
33 require_once("$CFG->libdir/filestorage/file_storage.php");
34 require_once("$CFG->libdir/filestorage/zip_packer.php");
35 require_once("$CFG->libdir/filebrowser/file_browser.php");
37 /**
38  * Encodes file serving url
39  *
40  * @deprecated use moodle_url factory methods instead
41  *
42  * @global object
43  * @param string $urlbase
44  * @param string $path /filearea/itemid/dir/dir/file.exe
45  * @param bool $forcedownload
46  * @param bool $https https url required
47  * @return string encoded file url
48  */
49 function file_encode_url($urlbase, $path, $forcedownload=false, $https=false) {
50     global $CFG;
52 //TODO: deprecate this
54     if ($CFG->slasharguments) {
55         $parts = explode('/', $path);
56         $parts = array_map('rawurlencode', $parts);
57         $path  = implode('/', $parts);
58         $return = $urlbase.$path;
59         if ($forcedownload) {
60             $return .= '?forcedownload=1';
61         }
62     } else {
63         $path = rawurlencode($path);
64         $return = $urlbase.'?file='.$path;
65         if ($forcedownload) {
66             $return .= '&amp;forcedownload=1';
67         }
68     }
70     if ($https) {
71         $return = str_replace('http://', 'https://', $return);
72     }
74     return $return;
75 }
77 /**
78  * Prepares 'editor' formslib element from data in database
79  *
80  * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
81  * function then copies the embedded files into draft area (assigning itemids automatically),
82  * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
83  * displayed.
84  * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
85  * your mform's set_data() supplying the object returned by this function.
86  *
87  * @param object $data database field that holds the html text with embedded media
88  * @param string $field the name of the database field that holds the html text with embedded media
89  * @param array $options editor options (like maxifiles, maxbytes etc.)
90  * @param object $context context of the editor
91  * @param string $component
92  * @param string $filearea file area name
93  * @param int $itemid item id, required if item exists
94  * @return object modified data object
95  */
96 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
97     $options = (array)$options;
98     if (!isset($options['trusttext'])) {
99         $options['trusttext'] = false;
100     }
101     if (!isset($options['forcehttps'])) {
102         $options['forcehttps'] = false;
103     }
104     if (!isset($options['subdirs'])) {
105         $options['subdirs'] = false;
106     }
107     if (!isset($options['maxfiles'])) {
108         $options['maxfiles'] = 0; // no files by default
109     }
110     if (!isset($options['noclean'])) {
111         $options['noclean'] = false;
112     }
114     if (is_null($itemid) or is_null($context)) {
115         $contextid = null;
116         $itemid = null;
117         if (!isset($data->{$field})) {
118             $data->{$field} = '';
119         }
120         if (!isset($data->{$field.'format'})) {
121             $data->{$field.'format'} = editors_get_preferred_format();
122         }
123         if (!$options['noclean']) {
124             $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
125         }
127     } else {
128         if ($options['trusttext']) {
129             // noclean ignored if trusttext enabled
130             if (!isset($data->{$field.'trust'})) {
131                 $data->{$field.'trust'} = 0;
132             }
133             $data = trusttext_pre_edit($data, $field, $context);
134         } else {
135             if (!$options['noclean']) {
136                 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
137             }
138         }
139         $contextid = $context->id;
140     }
142     if ($options['maxfiles'] != 0) {
143         $draftid_editor = file_get_submitted_draft_itemid($field);
144         $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
145         $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
146     } else {
147         $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
148     }
150     return $data;
153 /**
154  * Prepares the content of the 'editor' form element with embedded media files to be saved in database
155  *
156  * This function moves files from draft area to the destination area and
157  * encodes URLs to the draft files so they can be safely saved into DB. The
158  * form has to contain the 'editor' element named foobar_editor, where 'foobar'
159  * is the name of the database field to hold the wysiwyg editor content. The
160  * editor data comes as an array with text, format and itemid properties. This
161  * function automatically adds $data properties foobar, foobarformat and
162  * foobartrust, where foobar has URL to embedded files encoded.
163  *
164  * @param object $data raw data submitted by the form
165  * @param string $field name of the database field containing the html with embedded media files
166  * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
167  * @param object $context context, required for existing data
168  * @param string component
169  * @param string $filearea file area name
170  * @param int $itemid item id, required if item exists
171  * @return object modified data object
172  */
173 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
174     $options = (array)$options;
175     if (!isset($options['trusttext'])) {
176         $options['trusttext'] = false;
177     }
178     if (!isset($options['forcehttps'])) {
179         $options['forcehttps'] = false;
180     }
181     if (!isset($options['subdirs'])) {
182         $options['subdirs'] = false;
183     }
184     if (!isset($options['maxfiles'])) {
185         $options['maxfiles'] = 0; // no files by default
186     }
187     if (!isset($options['maxbytes'])) {
188         $options['maxbytes'] = 0; // unlimited
189     }
191     if ($options['trusttext']) {
192         $data->{$field.'trust'} = trusttext_trusted($context);
193     } else {
194         $data->{$field.'trust'} = 0;
195     }
197     $editor = $data->{$field.'_editor'};
199     if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
200         $data->{$field} = $editor['text'];
201     } else {
202         $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
203     }
204     $data->{$field.'format'} = $editor['format'];
206     return $data;
209 /**
210  * Saves text and files modified by Editor formslib element
211  *
212  * @param object $data $database entry field
213  * @param string $field name of data field
214  * @param array $options various options
215  * @param object $context context - must already exist
216  * @param string $component
217  * @param string $filearea file area name
218  * @param int $itemid must already exist, usually means data is in db
219  * @return object modified data obejct
220  */
221 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
222     $options = (array)$options;
223     if (!isset($options['subdirs'])) {
224         $options['subdirs'] = false;
225     }
226     if (is_null($itemid) or is_null($context)) {
227         $itemid = null;
228         $contextid = null;
229     } else {
230         $contextid = $context->id;
231     }
233     $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
234     file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
235     $data->{$field.'_filemanager'} = $draftid_editor;
237     return $data;
240 /**
241  * Saves files modified by File manager formslib element
242  *
243  * @param object $data $database entry field
244  * @param string $field name of data field
245  * @param array $options various options
246  * @param object $context context - must already exist
247  * @param string $component
248  * @param string $filearea file area name
249  * @param int $itemid must already exist, usually means data is in db
250  * @return object modified data obejct
251  */
252 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
253     $options = (array)$options;
254     if (!isset($options['subdirs'])) {
255         $options['subdirs'] = false;
256     }
257     if (!isset($options['maxfiles'])) {
258         $options['maxfiles'] = -1; // unlimited
259     }
260     if (!isset($options['maxbytes'])) {
261         $options['maxbytes'] = 0; // unlimited
262     }
264     if (empty($data->{$field.'_filemanager'})) {
265         $data->$field = '';
267     } else {
268         file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id, $component, $filearea, $itemid, $options);
269         $fs = get_file_storage();
271         if ($fs->get_area_files($context->id, $component, $filearea, $itemid)) {
272             $data->$field = '1'; // TODO: this is an ugly hack (skodak)
273         } else {
274             $data->$field = '';
275         }
276     }
278     return $data;
281 /**
282  *
283  * @global object
284  * @global object
285  * @return int a random but available draft itemid that can be used to create a new draft
286  * file area.
287  */
288 function file_get_unused_draft_itemid() {
289     global $DB, $USER;
291     if (isguestuser() or !isloggedin()) {
292         // guests and not-logged-in users can not be allowed to upload anything!!!!!!
293         print_error('noguest');
294     }
296     $contextid = get_context_instance(CONTEXT_USER, $USER->id)->id;
298     $fs = get_file_storage();
299     $draftitemid = rand(1, 999999999);
300     while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
301         $draftitemid = rand(1, 999999999);
302     }
304     return $draftitemid;
307 /**
308  * Initialise a draft file area from a real one by copying the files. A draft
309  * area will be created if one does not already exist. Normally you should
310  * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
311  *
312  * @global object
313  * @global object
314  * @param int &$draftitemid the id of the draft area to use, or 0 to create a new one, in which case this parameter is updated.
315  * @param integer $contextid This parameter and the next two identify the file area to copy files from.
316  * @param string $component
317  * @param string $filearea helps indentify the file area.
318  * @param integer $itemid helps identify the file area. Can be null if there are no files yet.
319  * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
320  * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
321  * @return string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
322  */
323 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
324     global $CFG, $USER, $CFG;
326     $options = (array)$options;
327     if (!isset($options['subdirs'])) {
328         $options['subdirs'] = false;
329     }
330     if (!isset($options['forcehttps'])) {
331         $options['forcehttps'] = false;
332     }
334     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
335     $fs = get_file_storage();
337     if (empty($draftitemid)) {
338         // create a new area and copy existing files into
339         $draftitemid = file_get_unused_draft_itemid();
340         $file_record = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
341         if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
342             foreach ($files as $file) {
343                 if ($file->is_directory() and $file->get_filepath() === '/') {
344                     // we need a way to mark the age of each draft area,
345                     // by not copying the root dir we force it to be created automatically with current timestamp
346                     continue;
347                 }
348                 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
349                     continue;
350                 }
351                 $fs->create_file_from_storedfile($file_record, $file);
352             }
353         }
354         if (!is_null($text)) {
355             // at this point there should not be any draftfile links yet,
356             // because this is a new text from database that should still contain the @@pluginfile@@ links
357             // this happens when developers forget to post process the text
358             $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
359         }
360     } else {
361         // nothing to do
362     }
364     if (is_null($text)) {
365         return null;
366     }
368     // relink embedded files - editor can not handle @@PLUGINFILE@@ !
369     return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id, 'user', 'draft', $draftitemid, $options);
372 /**
373  * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
374  *
375  * @global object
376  * @param string $text The content that may contain ULRs in need of rewriting.
377  * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
378  * @param integer $contextid This parameter and the next two identify the file area to use.
379  * @param string $component
380  * @param string $filearea helps identify the file area.
381  * @param integer $itemid helps identify the file area.
382  * @param array $options text and file options ('forcehttps'=>false)
383  * @return string the processed text.
384  */
385 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
386     global $CFG;
388     $options = (array)$options;
389     if (!isset($options['forcehttps'])) {
390         $options['forcehttps'] = false;
391     }
393     if (!$CFG->slasharguments) {
394         $file = $file . '?file=';
395     }
397     $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
399     if ($itemid !== null) {
400         $baseurl .= "$itemid/";
401     }
403     if ($options['forcehttps']) {
404         $baseurl = str_replace('http://', 'https://', $baseurl);
405     }
407     return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
410 /**
411  * Returns information about files in a draft area.
412  *
413  * @global object
414  * @global object
415  * @param integer $draftitemid the draft area item id.
416  * @return array with the following entries:
417  *      'filecount' => number of files in the draft area.
418  * (more information will be added as needed).
419  */
420 function file_get_draft_area_info($draftitemid) {
421     global $CFG, $USER;
423     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
424     $fs = get_file_storage();
426     $results = array();
428     // The number of files
429     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id', false);
430     $results['filecount'] = count($draftfiles);
431     $results['filesize'] = 0;
432     foreach ($draftfiles as $file) {
433         $results['filesize'] += $file->get_filesize();
434     }
436     return $results;
439 /**
440  * Get used space of files
441  * @return int total bytes
442  */
443 function file_get_user_used_space() {
444     global $DB, $USER;
446     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
447     $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
448             JOIN (SELECT contenthash, filename, MAX(id) AS id
449             FROM {files}
450             WHERE contextid = ? AND component = ? AND filearea != ?
451             GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
452     $params = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft');
453     $record = $DB->get_record_sql($sql, $params);
454     return (int)$record->totalbytes;
457 /**
458  * Convert any string to a valid filepath
459  * @param string $str
460  * @return string path
461  */
462 function file_correct_filepath($str) { //TODO: what is this? (skodak)
463     if ($str == '/' or empty($str)) {
464         return '/';
465     } else {
466         return '/'.trim($str, './@#$ ').'/';
467     }
470 /**
471  * Generate a folder tree of draft area of current USER recursively
472  * @param int $itemid
473  * @param string $filepath
474  * @param mixed $data //TODO: use normal return value instead, this does not fit the rest of api here (skodak)
475  */
476 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
477     global $USER, $OUTPUT, $CFG;
478     $data->children = array();
479     $context = get_context_instance(CONTEXT_USER, $USER->id);
480     $fs = get_file_storage();
481     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
482         foreach ($files as $file) {
483             if ($file->is_directory()) {
484                 $item = new stdClass();
485                 $item->sortorder = $file->get_sortorder();
486                 $item->filepath = $file->get_filepath();
488                 $foldername = explode('/', trim($item->filepath, '/'));
489                 $item->fullname = trim(array_pop($foldername), '/');
491                 $item->id = uniqid();
492                 file_get_drafarea_folders($draftitemid, $item->filepath, $item);
493                 $data->children[] = $item;
494             } else {
495                 continue;
496             }
497         }
498     }
501 /**
502  * Listing all files (including folders) in current path (draft area)
503  * used by file manager
504  * @param int $draftitemid
505  * @param string $filepath
506  * @return mixed
507  */
508 function file_get_drafarea_files($draftitemid, $filepath = '/') {
509     global $USER, $OUTPUT, $CFG;
511     $context = get_context_instance(CONTEXT_USER, $USER->id);
512     $fs = get_file_storage();
514     $data = new stdClass();
515     $data->path = array();
516     $data->path[] = array('name'=>get_string('files'), 'path'=>'/');
518     // will be used to build breadcrumb
519     $trail = '';
520     if ($filepath !== '/') {
521         $filepath = file_correct_filepath($filepath);
522         $parts = explode('/', $filepath);
523         foreach ($parts as $part) {
524             if ($part != '' && $part != null) {
525                 $trail .= ('/'.$part.'/');
526                 $data->path[] = array('name'=>$part, 'path'=>$trail);
527             }
528         }
529     }
531     $list = array();
532     $maxlength = 12;
533     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
534         foreach ($files as $file) {
535             $item = new stdClass();
536             $item->filename = $file->get_filename();
537             $item->filepath = $file->get_filepath();
538             $item->fullname = trim($item->filename, '/');
539             $filesize = $file->get_filesize();
540             $item->filesize = $filesize ? display_size($filesize) : '';
542             $icon = mimeinfo_from_type('icon', $file->get_mimetype());
543             $item->icon = $OUTPUT->pix_url('f/' . $icon)->out();
544             $item->sortorder = $file->get_sortorder();
546             if ($icon == 'zip') {
547                 $item->type = 'zip';
548             } else {
549                 $item->type = 'file';
550             }
552             if ($file->is_directory()) {
553                 $item->filesize = 0;
554                 $item->icon = $OUTPUT->pix_url('f/folder')->out();
555                 $item->type = 'folder';
556                 $foldername = explode('/', trim($item->filepath, '/'));
557                 $item->fullname = trim(array_pop($foldername), '/');
558             } else {
559                 // do NOT use file browser here!
560                 $item->url = moodle_url::make_draftfile_url($draftitemid, $item->filepath, $item->filename)->out();
561             }
562             $list[] = $item;
563         }
564     }
565     $data->itemid = $draftitemid;
566     $data->list = $list;
567     return $data;
570 /**
571  * Returns draft area itemid for a given element.
572  *
573  * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
574  * @return integer the itemid, or 0 if there is not one yet.
575  */
576 function file_get_submitted_draft_itemid($elname) {
577     $param = optional_param($elname, 0, PARAM_INT);
578     if ($param) {
579         require_sesskey();
580     }
581     if (is_array($param)) {
582         if (!empty($param['itemid'])) {
583             $param = $param['itemid'];
584         } else {
585             debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER);
586             return false;
587         }
588     }
589     return $param;
592 /**
593  * Saves files from a draft file area to a real one (merging the list of files).
594  * Can rewrite URLs in some content at the same time if desired.
595  *
596  * @global object
597  * @global object
598  * @param integer $draftitemid the id of the draft area to use. Normally obtained
599  *      from file_get_submitted_draft_itemid('elementname') or similar.
600  * @param integer $contextid This parameter and the next two identify the file area to save to.
601  * @param string $component
602  * @param string $filearea indentifies the file area.
603  * @param integer $itemid helps identifies the file area.
604  * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
605  * @param string $text some html content that needs to have embedded links rewritten
606  *      to the @@PLUGINFILE@@ form for saving in the database.
607  * @param boolean $forcehttps force https urls.
608  * @return string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
609  */
610 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
611     global $USER;
613     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
614     $fs = get_file_storage();
616     $options = (array)$options;
617     if (!isset($options['subdirs'])) {
618         $options['subdirs'] = false;
619     }
620     if (!isset($options['maxfiles'])) {
621         $options['maxfiles'] = -1; // unlimited
622     }
623     if (!isset($options['maxbytes'])) {
624         $options['maxbytes'] = 0; // unlimited
625     }
627     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
628     $oldfiles   = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
630     if (count($draftfiles) < 2) {
631         // means there are no files - one file means root dir only ;-)
632         $fs->delete_area_files($contextid, $component, $filearea, $itemid);
634     } else if (count($oldfiles) < 2) {
635         $filecount = 0;
636         // there were no files before - one file means root dir only ;-)
637         $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
638         foreach ($draftfiles as $file) {
639             if (!$options['subdirs']) {
640                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
641                     continue;
642                 }
643             }
644             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
645                 // oversized file - should not get here at all
646                 continue;
647             }
648             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
649                 // more files - should not get here at all
650                 break;
651             }
652             if (!$file->is_directory()) {
653                 $filecount++;
654             }
655             $fs->create_file_from_storedfile($file_record, $file);
656         }
658     } else {
659         // we have to merge old and new files - we want to keep file ids for files that were not changed
660         // we change time modified for all new and changed files, we keep time created as is
661         $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
663         $newhashes = array();
664         foreach ($draftfiles as $file) {
665             $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
666             $newhashes[$newhash] = $file;
667         }
668         $filecount = 0;
669         foreach ($oldfiles as $oldfile) {
670             $oldhash = $oldfile->get_pathnamehash();
671             if (!isset($newhashes[$oldhash])) {
672                 // delete files not needed any more - deleted by user
673                 $oldfile->delete();
674                 continue;
675             }
676             $newfile = $newhashes[$oldhash];
677             if ($oldfile->get_contenthash() != $newfile->get_contenthash() or $oldfile->get_sortorder() != $newfile->get_sortorder()
678                 or $oldfile->get_status() != $newfile->get_status() or $oldfile->get_license() != $newfile->get_license()
679                 or $oldfile->get_author() != $newfile->get_author() or $oldfile->get_source() != $newfile->get_source()) {
680                 // file was changed, use updated with new timemodified data
681                 $oldfile->delete();
682                 continue;
683             }
684             // unchanged file or directory - we keep it as is
685             unset($newhashes[$oldhash]);
686             if (!$oldfile->is_directory()) {
687                 $filecount++;
688             }
689         }
691         // now add new/changed files
692         // the size and subdirectory tests are extra safety only, the UI should prevent it
693         foreach ($newhashes as $file) {
694             if (!$options['subdirs']) {
695                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
696                     continue;
697                 }
698             }
699             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
700                 // oversized file - should not get here at all
701                 continue;
702             }
703             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
704                 // more files - should not get here at all
705                 break;
706             }
707             if (!$file->is_directory()) {
708                 $filecount++;
709             }
710             $fs->create_file_from_storedfile($file_record, $file);
711         }
712     }
714     // note: do not purge the draft area - we clean up areas later in cron,
715     //       the reason is that user might press submit twice and they would loose the files,
716     //       also sometimes we might want to use hacks that save files into two different areas
718     if (is_null($text)) {
719         return null;
720     } else {
721         return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
722     }
725 /**
726  * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
727  * ready to be saved in the database. Normally, this is done automatically by
728  * {@link file_save_draft_area_files()}.
729  * @param string $text the content to process.
730  * @param int $draftitemid the draft file area the content was using.
731  * @param bool $forcehttps whether the content contains https URLs. Default false.
732  * @return string the processed content.
733  */
734 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
735     global $CFG, $USER;
737     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
739     $wwwroot = $CFG->wwwroot;
740     if ($forcehttps) {
741         $wwwroot = str_replace('http://', 'https://', $wwwroot);
742     }
744     // relink embedded files if text submitted - no absolute links allowed in database!
745     $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
747     if (strpos($text, 'draftfile.php?file=') !== false) {
748         $matches = array();
749         preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
750         if ($matches) {
751             foreach ($matches[0] as $match) {
752                 $replace = str_ireplace('%2F', '/', $match);
753                 $text = str_replace($match, $replace, $text);
754             }
755         }
756         $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
757     }
759     return $text;
762 /**
763  * Set file sort order
764  * @global object $DB
765  * @param integer $contextid the context id
766  * @param string $component
767  * @param string $filearea file area.
768  * @param integer $itemid itemid.
769  * @param string $filepath file path.
770  * @param string $filename file name.
771  * @param integer $sortorer the sort order of file.
772  * @return boolean
773  */
774 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
775     global $DB;
776     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
777     if ($file_record = $DB->get_record('files', $conditions)) {
778         $sortorder = (int)$sortorder;
779         $file_record->sortorder = $sortorder;
780         $DB->update_record('files', $file_record);
781         return true;
782     }
783     return false;
786 /**
787  * reset file sort order number to 0
788  * @global object $DB
789  * @param integer $contextid the context id
790  * @param string $component
791  * @param string $filearea file area.
792  * @param integer $itemid itemid.
793  * @return boolean
794  */
795 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
796     global $DB;
798     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
799     if ($itemid !== false) {
800         $conditions['itemid'] = $itemid;
801     }
803     $file_records = $DB->get_records('files', $conditions);
804     foreach ($file_records as $file_record) {
805         $file_record->sortorder = 0;
806         $DB->update_record('files', $file_record);
807     }
808     return true;
811 /**
812  * Returns description of upload error
813  *
814  * @param int $errorcode found in $_FILES['filename.ext']['error']
815  * @return string error description string, '' if ok
816  */
817 function file_get_upload_error($errorcode) {
819     switch ($errorcode) {
820     case 0: // UPLOAD_ERR_OK - no error
821         $errmessage = '';
822         break;
824     case 1: // UPLOAD_ERR_INI_SIZE
825         $errmessage = get_string('uploadserverlimit');
826         break;
828     case 2: // UPLOAD_ERR_FORM_SIZE
829         $errmessage = get_string('uploadformlimit');
830         break;
832     case 3: // UPLOAD_ERR_PARTIAL
833         $errmessage = get_string('uploadpartialfile');
834         break;
836     case 4: // UPLOAD_ERR_NO_FILE
837         $errmessage = get_string('uploadnofilefound');
838         break;
840     // Note: there is no error with a value of 5
842     case 6: // UPLOAD_ERR_NO_TMP_DIR
843         $errmessage = get_string('uploadnotempdir');
844         break;
846     case 7: // UPLOAD_ERR_CANT_WRITE
847         $errmessage = get_string('uploadcantwrite');
848         break;
850     case 8: // UPLOAD_ERR_EXTENSION
851         $errmessage = get_string('uploadextension');
852         break;
854     default:
855         $errmessage = get_string('uploadproblem');
856     }
858     return $errmessage;
861 /**
862  * Recursive function formating an array in POST parameter
863  * @param array $arraydata - the array that we are going to format and add into &$data array
864  * @param string $currentdata - a row of the final postdata array at instant T
865  *                when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
866  * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
867  */
868 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
869         foreach ($arraydata as $k=>$v) {
870             $newcurrentdata = $currentdata;
871             if (is_array($v)) { //the value is an array, call the function recursively
872                 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
873                 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
874             }  else { //add the POST parameter to the $data array
875                 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
876             }
877         }
880 /**
881  * Transform a PHP array into POST parameter
882  * (see the recursive function format_array_postdata_for_curlcall)
883  * @param array $postdata
884  * @return array containing all POST parameters  (1 row = 1 POST parameter)
885  */
886 function format_postdata_for_curlcall($postdata) {
887         $data = array();
888         foreach ($postdata as $k=>$v) {
889             if (is_array($v)) {
890                 $currentdata = urlencode($k);
891                 format_array_postdata_for_curlcall($v, $currentdata, $data);
892             }  else {
893                 $data[] = urlencode($k).'='.urlencode($v);
894             }
895         }
896         $convertedpostdata = implode('&', $data);
897         return $convertedpostdata;
903 /**
904  * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
905  * Due to security concerns only downloads from http(s) sources are supported.
906  *
907  * @param string $url file url starting with http(s)://
908  * @param array $headers http headers, null if none. If set, should be an
909  *   associative array of header name => value pairs.
910  * @param array $postdata array means use POST request with given parameters
911  * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
912  *   (if false, just returns content)
913  * @param int $timeout timeout for complete download process including all file transfer
914  *   (default 5 minutes)
915  * @param int $connecttimeout timeout for connection to server; this is the timeout that
916  *   usually happens if the remote server is completely down (default 20 seconds);
917  *   may not work when using proxy
918  * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
919  *   Only use this when already in a trusted location.
920  * @param string $tofile store the downloaded content to file instead of returning it.
921  * @param bool $calctimeout false by default, true enables an extra head request to try and determine
922  *   filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
923  * @return mixed false if request failed or content of the file as string if ok. True if file downloaded into $tofile successfully.
924  */
925 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
926     global $CFG;
928     // some extra security
929     $newlines = array("\r", "\n");
930     if (is_array($headers) ) {
931         foreach ($headers as $key => $value) {
932             $headers[$key] = str_replace($newlines, '', $value);
933         }
934     }
935     $url = str_replace($newlines, '', $url);
936     if (!preg_match('|^https?://|i', $url)) {
937         if ($fullresponse) {
938             $response = new stdClass();
939             $response->status        = 0;
940             $response->headers       = array();
941             $response->response_code = 'Invalid protocol specified in url';
942             $response->results       = '';
943             $response->error         = 'Invalid protocol specified in url';
944             return $response;
945         } else {
946             return false;
947         }
948     }
950     // check if proxy (if used) should be bypassed for this url
951     $proxybypass = is_proxybypass($url);
953     if (!$ch = curl_init($url)) {
954         debugging('Can not init curl.');
955         return false;
956     }
958     // set extra headers
959     if (is_array($headers) ) {
960         $headers2 = array();
961         foreach ($headers as $key => $value) {
962             $headers2[] = "$key: $value";
963         }
964         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers2);
965     }
967     if ($skipcertverify) {
968         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
969     }
971     // use POST if requested
972     if (is_array($postdata)) {
973         $postdata = format_postdata_for_curlcall($postdata);
974         curl_setopt($ch, CURLOPT_POST, true);
975         curl_setopt($ch, CURLOPT_POSTFIELDS, $postdata);
976     }
978     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
979     curl_setopt($ch, CURLOPT_HEADER, false);
980     curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connecttimeout);
982     if (!ini_get('open_basedir') and !ini_get('safe_mode')) {
983         // TODO: add version test for '7.10.5'
984         curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
985         curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
986     }
988     if (!empty($CFG->proxyhost) and !$proxybypass) {
989         // SOCKS supported in PHP5 only
990         if (!empty($CFG->proxytype) and ($CFG->proxytype == 'SOCKS5')) {
991             if (defined('CURLPROXY_SOCKS5')) {
992                 curl_setopt($ch, CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
993             } else {
994                 curl_close($ch);
995                 if ($fullresponse) {
996                     $response = new stdClass();
997                     $response->status        = '0';
998                     $response->headers       = array();
999                     $response->response_code = 'SOCKS5 proxy is not supported in PHP4';
1000                     $response->results       = '';
1001                     $response->error         = 'SOCKS5 proxy is not supported in PHP4';
1002                     return $response;
1003                 } else {
1004                     debugging("SOCKS5 proxy is not supported in PHP4.", DEBUG_ALL);
1005                     return false;
1006                 }
1007             }
1008         }
1010         curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, false);
1012         if (empty($CFG->proxyport)) {
1013             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost);
1014         } else {
1015             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost.':'.$CFG->proxyport);
1016         }
1018         if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
1019             curl_setopt($ch, CURLOPT_PROXYUSERPWD, $CFG->proxyuser.':'.$CFG->proxypassword);
1020             if (defined('CURLOPT_PROXYAUTH')) {
1021                 // any proxy authentication if PHP 5.1
1022                 curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_BASIC | CURLAUTH_NTLM);
1023             }
1024         }
1025     }
1027     // set up header and content handlers
1028     $received = new stdClass();
1029     $received->headers = array(); // received headers array
1030     $received->tofile  = $tofile;
1031     $received->fh      = null;
1032     curl_setopt($ch, CURLOPT_HEADERFUNCTION, partial('download_file_content_header_handler', $received));
1033     if ($tofile) {
1034         curl_setopt($ch, CURLOPT_WRITEFUNCTION, partial('download_file_content_write_handler', $received));
1035     }
1037     if (!isset($CFG->curltimeoutkbitrate)) {
1038         //use very slow rate of 56kbps as a timeout speed when not set
1039         $bitrate = 56;
1040     } else {
1041         $bitrate = $CFG->curltimeoutkbitrate;
1042     }
1044     // try to calculate the proper amount for timeout from remote file size.
1045     // if disabled or zero, we won't do any checks nor head requests.
1046     if ($calctimeout && $bitrate > 0) {
1047         //setup header request only options
1048         curl_setopt_array ($ch, array(
1049             CURLOPT_RETURNTRANSFER => false,
1050             CURLOPT_NOBODY         => true)
1051         );
1053         curl_exec($ch);
1054         $info = curl_getinfo($ch);
1055         $err = curl_error($ch);
1057         if ($err === '' && $info['download_content_length'] > 0) { //no curl errors
1058             $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024))); //adjust for large files only - take max timeout.
1059         }
1060         //reinstate affected curl options
1061         curl_setopt_array ($ch, array(
1062             CURLOPT_RETURNTRANSFER => true,
1063             CURLOPT_NOBODY         => false)
1064         );
1065     }
1067     curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
1068     $result = curl_exec($ch);
1070     // try to detect encoding problems
1071     if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1072         curl_setopt($ch, CURLOPT_ENCODING, 'none');
1073         $result = curl_exec($ch);
1074     }
1076     if ($received->fh) {
1077         fclose($received->fh);
1078     }
1080     if (curl_errno($ch)) {
1081         $error    = curl_error($ch);
1082         $error_no = curl_errno($ch);
1083         curl_close($ch);
1085         if ($fullresponse) {
1086             $response = new stdClass();
1087             if ($error_no == 28) {
1088                 $response->status    = '-100'; // mimic snoopy
1089             } else {
1090                 $response->status    = '0';
1091             }
1092             $response->headers       = array();
1093             $response->response_code = $error;
1094             $response->results       = false;
1095             $response->error         = $error;
1096             return $response;
1097         } else {
1098             debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL);
1099             return false;
1100         }
1102     } else {
1103         $info = curl_getinfo($ch);
1104         curl_close($ch);
1106         if (empty($info['http_code'])) {
1107             // for security reasons we support only true http connections (Location: file:// exploit prevention)
1108             $response = new stdClass();
1109             $response->status        = '0';
1110             $response->headers       = array();
1111             $response->response_code = 'Unknown cURL error';
1112             $response->results       = false; // do NOT change this, we really want to ignore the result!
1113             $response->error         = 'Unknown cURL error';
1115         } else {
1116             $response = new stdClass();;
1117             $response->status        = (string)$info['http_code'];
1118             $response->headers       = $received->headers;
1119             $response->response_code = $received->headers[0];
1120             $response->results       = $result;
1121             $response->error         = '';
1122         }
1124         if ($fullresponse) {
1125             return $response;
1126         } else if ($info['http_code'] != 200) {
1127             debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code, DEBUG_ALL);
1128             return false;
1129         } else {
1130             return $response->results;
1131         }
1132     }
1135 /**
1136  * internal implementation
1137  */
1138 function download_file_content_header_handler($received, $ch, $header) {
1139     $received->headers[] = $header;
1140     return strlen($header);
1143 /**
1144  * internal implementation
1145  */
1146 function download_file_content_write_handler($received, $ch, $data) {
1147     if (!$received->fh) {
1148         $received->fh = fopen($received->tofile, 'w');
1149         if ($received->fh === false) {
1150             // bad luck, file creation or overriding failed
1151             return 0;
1152         }
1153     }
1154     if (fwrite($received->fh, $data) === false) {
1155         // bad luck, write failed, let's abort completely
1156         return 0;
1157     }
1158     return strlen($data);
1161 /**
1162  * @return array List of information about file types based on extensions.
1163  *   Associative array of extension (lower-case) to associative array
1164  *   from 'element name' to data. Current element names are 'type' and 'icon'.
1165  *   Unknown types should use the 'xxx' entry which includes defaults.
1166  */
1167 function get_mimetypes_array() {
1168     static $mimearray = array (
1169         'xxx'  => array ('type'=>'document/unknown', 'icon'=>'unknown'),
1170         '3gp'  => array ('type'=>'video/quicktime', 'icon'=>'video'),
1171         'aac'  => array ('type'=>'audio/aac', 'icon'=>'audio'),
1172         'ai'   => array ('type'=>'application/postscript', 'icon'=>'image'),
1173         'aif'  => array ('type'=>'audio/x-aiff', 'icon'=>'audio'),
1174         'aiff' => array ('type'=>'audio/x-aiff', 'icon'=>'audio'),
1175         'aifc' => array ('type'=>'audio/x-aiff', 'icon'=>'audio'),
1176         'applescript'  => array ('type'=>'text/plain', 'icon'=>'text'),
1177         'asc'  => array ('type'=>'text/plain', 'icon'=>'text'),
1178         'asm'  => array ('type'=>'text/plain', 'icon'=>'text'),
1179         'au'   => array ('type'=>'audio/au', 'icon'=>'audio'),
1180         'avi'  => array ('type'=>'video/x-ms-wm', 'icon'=>'avi'),
1181         'bmp'  => array ('type'=>'image/bmp', 'icon'=>'image'),
1182         'c'    => array ('type'=>'text/plain', 'icon'=>'text'),
1183         'cct'  => array ('type'=>'shockwave/director', 'icon'=>'flash'),
1184         'cpp'  => array ('type'=>'text/plain', 'icon'=>'text'),
1185         'cs'   => array ('type'=>'application/x-csh', 'icon'=>'text'),
1186         'css'  => array ('type'=>'text/css', 'icon'=>'text'),
1187         'csv'  => array ('type'=>'text/csv', 'icon'=>'excel'),
1188         'dv'   => array ('type'=>'video/x-dv', 'icon'=>'video'),
1189         'dmg'  => array ('type'=>'application/octet-stream', 'icon'=>'dmg'),
1191         'doc'  => array ('type'=>'application/msword', 'icon'=>'word'),
1192         'docx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'icon'=>'docx'),
1193         'docm' => array ('type'=>'application/vnd.ms-word.document.macroEnabled.12', 'icon'=>'docm'),
1194         'dotx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 'icon'=>'dotx'),
1195         'dotm' => array ('type'=>'application/vnd.ms-word.template.macroEnabled.12', 'icon'=>'dotm'),
1197         'dcr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1198         'dif'  => array ('type'=>'video/x-dv', 'icon'=>'video'),
1199         'dir'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1200         'dxr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1201         'eps'  => array ('type'=>'application/postscript', 'icon'=>'pdf'),
1202         'fdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1203         'flv'  => array ('type'=>'video/x-flv', 'icon'=>'video'),
1204         'f4v'  => array ('type'=>'video/mp4', 'icon'=>'video'),
1205         'gif'  => array ('type'=>'image/gif', 'icon'=>'image'),
1206         'gtar' => array ('type'=>'application/x-gtar', 'icon'=>'zip'),
1207         'tgz'  => array ('type'=>'application/g-zip', 'icon'=>'zip'),
1208         'gz'   => array ('type'=>'application/g-zip', 'icon'=>'zip'),
1209         'gzip' => array ('type'=>'application/g-zip', 'icon'=>'zip'),
1210         'h'    => array ('type'=>'text/plain', 'icon'=>'text'),
1211         'hpp'  => array ('type'=>'text/plain', 'icon'=>'text'),
1212         'hqx'  => array ('type'=>'application/mac-binhex40', 'icon'=>'zip'),
1213         'htc'  => array ('type'=>'text/x-component', 'icon'=>'text'),
1214         'html' => array ('type'=>'text/html', 'icon'=>'html'),
1215         'xhtml'=> array ('type'=>'application/xhtml+xml', 'icon'=>'html'),
1216         'htm'  => array ('type'=>'text/html', 'icon'=>'html'),
1217         'ico'  => array ('type'=>'image/vnd.microsoft.icon', 'icon'=>'image'),
1218         'ics'  => array ('type'=>'text/calendar', 'icon'=>'text'),
1219         'isf'  => array ('type'=>'application/inspiration', 'icon'=>'isf'),
1220         'ist'  => array ('type'=>'application/inspiration.template', 'icon'=>'isf'),
1221         'java' => array ('type'=>'text/plain', 'icon'=>'text'),
1222         'jcb'  => array ('type'=>'text/xml', 'icon'=>'jcb'),
1223         'jcl'  => array ('type'=>'text/xml', 'icon'=>'jcl'),
1224         'jcw'  => array ('type'=>'text/xml', 'icon'=>'jcw'),
1225         'jmt'  => array ('type'=>'text/xml', 'icon'=>'jmt'),
1226         'jmx'  => array ('type'=>'text/xml', 'icon'=>'jmx'),
1227         'jpe'  => array ('type'=>'image/jpeg', 'icon'=>'image'),
1228         'jpeg' => array ('type'=>'image/jpeg', 'icon'=>'image'),
1229         'jpg'  => array ('type'=>'image/jpeg', 'icon'=>'image'),
1230         'jqz'  => array ('type'=>'text/xml', 'icon'=>'jqz'),
1231         'js'   => array ('type'=>'application/x-javascript', 'icon'=>'text'),
1232         'latex'=> array ('type'=>'application/x-latex', 'icon'=>'text'),
1233         'm'    => array ('type'=>'text/plain', 'icon'=>'text'),
1234         'mbz'  => array ('type'=>'application/vnd.moodle.backup', 'icon'=>'moodle'),
1235         'mov'  => array ('type'=>'video/quicktime', 'icon'=>'video'),
1236         'movie'=> array ('type'=>'video/x-sgi-movie', 'icon'=>'video'),
1237         'm3u'  => array ('type'=>'audio/x-mpegurl', 'icon'=>'audio'),
1238         'mp3'  => array ('type'=>'audio/mp3', 'icon'=>'audio'),
1239         'mp4'  => array ('type'=>'video/mp4', 'icon'=>'video'),
1240         'm4v'  => array ('type'=>'video/mp4', 'icon'=>'video'),
1241         'm4a'  => array ('type'=>'audio/mp4', 'icon'=>'audio'),
1242         'mpeg' => array ('type'=>'video/mpeg', 'icon'=>'video'),
1243         'mpe'  => array ('type'=>'video/mpeg', 'icon'=>'video'),
1244         'mpg'  => array ('type'=>'video/mpeg', 'icon'=>'video'),
1246         'odt'  => array ('type'=>'application/vnd.oasis.opendocument.text', 'icon'=>'odt'),
1247         'ott'  => array ('type'=>'application/vnd.oasis.opendocument.text-template', 'icon'=>'odt'),
1248         'oth'  => array ('type'=>'application/vnd.oasis.opendocument.text-web', 'icon'=>'odt'),
1249         'odm'  => array ('type'=>'application/vnd.oasis.opendocument.text-master', 'icon'=>'odm'),
1250         'odg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics', 'icon'=>'odg'),
1251         'otg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics-template', 'icon'=>'odg'),
1252         'odp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation', 'icon'=>'odp'),
1253         'otp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation-template', 'icon'=>'odp'),
1254         'ods'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet', 'icon'=>'ods'),
1255         'ots'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet-template', 'icon'=>'ods'),
1256         'odc'  => array ('type'=>'application/vnd.oasis.opendocument.chart', 'icon'=>'odc'),
1257         'odf'  => array ('type'=>'application/vnd.oasis.opendocument.formula', 'icon'=>'odf'),
1258         'odb'  => array ('type'=>'application/vnd.oasis.opendocument.database', 'icon'=>'odb'),
1259         'odi'  => array ('type'=>'application/vnd.oasis.opendocument.image', 'icon'=>'odi'),
1260         'oga'  => array ('type'=>'audio/ogg', 'icon'=>'audio'),
1261         'ogg'  => array ('type'=>'audio/ogg', 'icon'=>'audio'),
1262         'ogv'  => array ('type'=>'video/ogg', 'icon'=>'video'),
1264         'pct'  => array ('type'=>'image/pict', 'icon'=>'image'),
1265         'pdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1266         'php'  => array ('type'=>'text/plain', 'icon'=>'text'),
1267         'pic'  => array ('type'=>'image/pict', 'icon'=>'image'),
1268         'pict' => array ('type'=>'image/pict', 'icon'=>'image'),
1269         'png'  => array ('type'=>'image/png', 'icon'=>'image'),
1271         'pps'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint'),
1272         'ppt'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint'),
1273         'pptx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'icon'=>'pptx'),
1274         'pptm' => array ('type'=>'application/vnd.ms-powerpoint.presentation.macroEnabled.12', 'icon'=>'pptm'),
1275         'potx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.template', 'icon'=>'potx'),
1276         'potm' => array ('type'=>'application/vnd.ms-powerpoint.template.macroEnabled.12', 'icon'=>'potm'),
1277         'ppam' => array ('type'=>'application/vnd.ms-powerpoint.addin.macroEnabled.12', 'icon'=>'ppam'),
1278         'ppsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 'icon'=>'ppsx'),
1279         'ppsm' => array ('type'=>'application/vnd.ms-powerpoint.slideshow.macroEnabled.12', 'icon'=>'ppsm'),
1281         'ps'   => array ('type'=>'application/postscript', 'icon'=>'pdf'),
1282         'qt'   => array ('type'=>'video/quicktime', 'icon'=>'video'),
1283         'ra'   => array ('type'=>'audio/x-realaudio-plugin', 'icon'=>'audio'),
1284         'ram'  => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio'),
1285         'rhb'  => array ('type'=>'text/xml', 'icon'=>'xml'),
1286         'rm'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio'),
1287         'rmvb' => array ('type'=>'application/vnd.rn-realmedia-vbr', 'icon'=>'video'),
1288         'rtf'  => array ('type'=>'text/rtf', 'icon'=>'text'),
1289         'rtx'  => array ('type'=>'text/richtext', 'icon'=>'text'),
1290         'rv'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'video'),
1291         'sh'   => array ('type'=>'application/x-sh', 'icon'=>'text'),
1292         'sit'  => array ('type'=>'application/x-stuffit', 'icon'=>'zip'),
1293         'smi'  => array ('type'=>'application/smil', 'icon'=>'text'),
1294         'smil' => array ('type'=>'application/smil', 'icon'=>'text'),
1295         'sqt'  => array ('type'=>'text/xml', 'icon'=>'xml'),
1296         'svg'  => array ('type'=>'image/svg+xml', 'icon'=>'image'),
1297         'svgz' => array ('type'=>'image/svg+xml', 'icon'=>'image'),
1298         'swa'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1299         'swf'  => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash'),
1300         'swfl' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash'),
1302         'sxw'  => array ('type'=>'application/vnd.sun.xml.writer', 'icon'=>'odt'),
1303         'stw'  => array ('type'=>'application/vnd.sun.xml.writer.template', 'icon'=>'odt'),
1304         'sxc'  => array ('type'=>'application/vnd.sun.xml.calc', 'icon'=>'odt'),
1305         'stc'  => array ('type'=>'application/vnd.sun.xml.calc.template', 'icon'=>'odt'),
1306         'sxd'  => array ('type'=>'application/vnd.sun.xml.draw', 'icon'=>'odt'),
1307         'std'  => array ('type'=>'application/vnd.sun.xml.draw.template', 'icon'=>'odt'),
1308         'sxi'  => array ('type'=>'application/vnd.sun.xml.impress', 'icon'=>'odt'),
1309         'sti'  => array ('type'=>'application/vnd.sun.xml.impress.template', 'icon'=>'odt'),
1310         'sxg'  => array ('type'=>'application/vnd.sun.xml.writer.global', 'icon'=>'odt'),
1311         'sxm'  => array ('type'=>'application/vnd.sun.xml.math', 'icon'=>'odt'),
1313         'tar'  => array ('type'=>'application/x-tar', 'icon'=>'zip'),
1314         'tif'  => array ('type'=>'image/tiff', 'icon'=>'image'),
1315         'tiff' => array ('type'=>'image/tiff', 'icon'=>'image'),
1316         'tex'  => array ('type'=>'application/x-tex', 'icon'=>'text'),
1317         'texi' => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1318         'texinfo'  => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1319         'tsv'  => array ('type'=>'text/tab-separated-values', 'icon'=>'text'),
1320         'txt'  => array ('type'=>'text/plain', 'icon'=>'text'),
1321         'wav'  => array ('type'=>'audio/wav', 'icon'=>'audio'),
1322         'webm'  => array ('type'=>'video/webm', 'icon'=>'video'),
1323         'wmv'  => array ('type'=>'video/x-ms-wmv', 'icon'=>'avi'),
1324         'asf'  => array ('type'=>'video/x-ms-asf', 'icon'=>'avi'),
1325         'xdp'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1326         'xfd'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1327         'xfdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1329         'xls'  => array ('type'=>'application/vnd.ms-excel', 'icon'=>'excel'),
1330         'xlsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'icon'=>'xlsx'),
1331         'xlsm' => array ('type'=>'application/vnd.ms-excel.sheet.macroEnabled.12', 'icon'=>'xlsm'),
1332         'xltx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 'icon'=>'xltx'),
1333         'xltm' => array ('type'=>'application/vnd.ms-excel.template.macroEnabled.12', 'icon'=>'xltm'),
1334         'xlsb' => array ('type'=>'application/vnd.ms-excel.sheet.binary.macroEnabled.12', 'icon'=>'xlsb'),
1335         'xlam' => array ('type'=>'application/vnd.ms-excel.addin.macroEnabled.12', 'icon'=>'xlam'),
1337         'xml'  => array ('type'=>'application/xml', 'icon'=>'xml'),
1338         'xsl'  => array ('type'=>'text/xml', 'icon'=>'xml'),
1339         'zip'  => array ('type'=>'application/zip', 'icon'=>'zip')
1340     );
1341     return $mimearray;
1344 /**
1345  * Obtains information about a filetype based on its extension. Will
1346  * use a default if no information is present about that particular
1347  * extension.
1348  *
1349  * @param string $element Desired information (usually 'icon'
1350  *   for icon filename or 'type' for MIME type)
1351  * @param string $filename Filename we're looking up
1352  * @return string Requested piece of information from array
1353  */
1354 function mimeinfo($element, $filename) {
1355     global $CFG;
1356     $mimeinfo = get_mimetypes_array();
1358     if (preg_match('/\.([a-z0-9]+)$/i', $filename, $match)) {
1359         if (isset($mimeinfo[strtolower($match[1])][$element])) {
1360             return $mimeinfo[strtolower($match[1])][$element];
1361         } else {
1362             if ($element == 'icon32') {
1363                 if (isset($mimeinfo[strtolower($match[1])]['icon'])) {
1364                     $filename = $mimeinfo[strtolower($match[1])]['icon'];
1365                 } else {
1366                     $filename = 'unknown';
1367                 }
1368                 $filename .= '-32';
1369                 if (file_exists($CFG->dirroot.'/pix/f/'.$filename.'.png') or file_exists($CFG->dirroot.'/pix/f/'.$filename.'.gif')) {
1370                     return $filename;
1371                 } else {
1372                     return 'unknown-32';
1373                 }
1374             } else {
1375                 return $mimeinfo['xxx'][$element];   // By default
1376             }
1377         }
1378     } else {
1379         if ($element == 'icon32') {
1380             return 'unknown-32';
1381         }
1382         return $mimeinfo['xxx'][$element];   // By default
1383     }
1386 /**
1387  * Obtains information about a filetype based on the MIME type rather than
1388  * the other way around.
1389  *
1390  * @param string $element Desired information (usually 'icon')
1391  * @param string $mimetype MIME type we're looking up
1392  * @return string Requested piece of information from array
1393  */
1394 function mimeinfo_from_type($element, $mimetype) {
1395     $mimeinfo = get_mimetypes_array();
1397     foreach($mimeinfo as $values) {
1398         if ($values['type']==$mimetype) {
1399             if (isset($values[$element])) {
1400                 return $values[$element];
1401             }
1402             break;
1403         }
1404     }
1405     return $mimeinfo['xxx'][$element]; // Default
1408 /**
1409  * Get information about a filetype based on the icon file.
1410  *
1411  * @param string $element Desired information (usually 'icon')
1412  * @param string $icon Icon file name without extension
1413  * @param boolean $all return all matching entries (defaults to false - best (by ext)/last match)
1414  * @return string Requested piece of information from array
1415  */
1416 function mimeinfo_from_icon($element, $icon, $all=false) {
1417     $mimeinfo = get_mimetypes_array();
1419     if (preg_match("/\/(.*)/", $icon, $matches)) {
1420         $icon = $matches[1];
1421     }
1422     // Try to get the extension
1423     $extension = '';
1424     if (($cutat = strrpos($icon, '.')) !== false && $cutat < strlen($icon)-1) {
1425         $extension = substr($icon, $cutat + 1);
1426     }
1427     $info = array($mimeinfo['xxx'][$element]); // Default
1428     foreach($mimeinfo as $key => $values) {
1429         if ($values['icon']==$icon) {
1430             if (isset($values[$element])) {
1431                 $info[$key] = $values[$element];
1432             }
1433             //No break, for example for 'excel' we don't want 'csv'!
1434         }
1435     }
1436     if ($all) {
1437         if (count($info) > 1) {
1438             array_shift($info); // take off document/unknown if we have better options
1439         }
1440         return array_values($info); // Keep keys out when requesting all
1441     }
1443     // Requested only one, try to get the best by extension coincidence, else return the last
1444     if ($extension && isset($info[$extension])) {
1445         return $info[$extension];
1446     }
1448     return array_pop($info); // Return last match (mimicking behaviour/comment inside foreach loop)
1451 /**
1452  * Returns the relative icon path for a given mime type
1453  *
1454  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1455  * a return the full path to an icon.
1456  *
1457  * <code>
1458  * $mimetype = 'image/jpg';
1459  * $icon = $OUTPUT->pix_url(file_mimetype_icon($mimetype));
1460  * echo '<img src="'.$icon.'" alt="'.$mimetype.'" />';
1461  * </code>
1462  *
1463  * @todo When an $OUTPUT->icon method is available this function should be altered
1464  * to conform with that.
1465  *
1466  * @param string $mimetype The mimetype to fetch an icon for
1467  * @param int $size The size of the icon. Not yet implemented
1468  * @return string The relative path to the icon
1469  */
1470 function file_mimetype_icon($mimetype, $size = NULL) {
1471     global $CFG;
1473     $icon = mimeinfo_from_type('icon', $mimetype);
1474     if ($size) {
1475         if (file_exists("$CFG->dirroot/pix/f/$icon-$size.png") or file_exists("$CFG->dirroot/pix/f/$icon-$size.gif")) {
1476             $icon = "$icon-$size";
1477         }
1478     }
1479     return 'f/'.$icon;
1482 /**
1483  * Returns the relative icon path for a given file name
1484  *
1485  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1486  * a return the full path to an icon.
1487  *
1488  * <code>
1489  * $filename = 'jpg';
1490  * $icon = $OUTPUT->pix_url(file_extension_icon($filename));
1491  * echo '<img src="'.$icon.'" alt="blah" />';
1492  * </code>
1493  *
1494  * @todo When an $OUTPUT->icon method is available this function should be altered
1495  * to conform with that.
1496  * @todo Implement $size
1497  *
1498  * @param string filename The filename to get the icon for
1499  * @param int $size The size of the icon. Defaults to null can also be 32
1500  * @return string
1501  */
1502 function file_extension_icon($filename, $size = NULL) {
1503     global $CFG;
1505     $icon = mimeinfo('icon', $filename);
1506     if ($size) {
1507         if (file_exists("$CFG->dirroot/pix/f/$icon-$size.png") or file_exists("$CFG->dirroot/pix/f/$icon-$size.gif")) {
1508             $icon = "$icon-$size";
1509         }
1510     }
1511     return 'f/'.$icon;
1514 /**
1515  * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1516  * mimetypes.php language file.
1517  *
1518  * @param string $mimetype MIME type (can be obtained using the mimeinfo function)
1519  * @param bool $capitalise If true, capitalises first character of result
1520  * @return string Text description
1521  */
1522 function get_mimetype_description($mimetype, $capitalise=false) {
1523     if (get_string_manager()->string_exists($mimetype, 'mimetypes')) {
1524         $result = get_string($mimetype, 'mimetypes');
1525     } else {
1526         $result = get_string('document/unknown','mimetypes');
1527     }
1528     if ($capitalise) {
1529         $result=ucfirst($result);
1530     }
1531     return $result;
1534 /**
1535  * Requested file is not found or not accessible
1536  *
1537  * @return does not return, terminates script
1538  */
1539 function send_file_not_found() {
1540     global $CFG, $COURSE;
1541     header('HTTP/1.0 404 not found');
1542     print_error('filenotfound', 'error', $CFG->wwwroot.'/course/view.php?id='.$COURSE->id); //this is not displayed on IIS??
1545 /**
1546  * Check output buffering settings before sending file.
1547  * Please note you should not send any other headers after calling this function.
1548  *
1549  * @private to be called only from lib/filelib.php !
1550  * @return void
1551  */
1552 function prepare_file_content_sending() {
1553     // We needed to be able to send headers up until now
1554     if (headers_sent()) {
1555         throw new file_serving_exception('Headers already sent, can not serve file.');
1556     }
1558     $olddebug = error_reporting(0);
1560     // IE compatibility HACK - it does not like zlib compression much
1561     // there is also a problem with the length header in older PHP versions
1562     if (ini_get_bool('zlib.output_compression')) {
1563         ini_set('zlib.output_compression', 'Off');
1564     }
1566     // flush and close all buffers if possible
1567     while(ob_get_level()) {
1568         if (!ob_end_flush()) {
1569             // prevent infinite loop when buffer can not be closed
1570             break;
1571         }
1572     }
1574     error_reporting($olddebug);
1576     //NOTE: we can not reliable test headers_sent() here because
1577     //      the headers might be sent which trying to close the buffers,
1578     //      this happens especially if browser does not support gzip or deflate
1581 /**
1582  * Handles the sending of temporary file to user, download is forced.
1583  * File is deleted after abort or successful sending.
1584  *
1585  * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
1586  * @param string $filename proposed file name when saving file
1587  * @param bool $path is content of file
1588  * @return does not return, script terminated
1589  */
1590 function send_temp_file($path, $filename, $pathisstring=false) {
1591     global $CFG;
1593     // close session - not needed anymore
1594     @session_get_instance()->write_close();
1596     if (!$pathisstring) {
1597         if (!file_exists($path)) {
1598             header('HTTP/1.0 404 not found');
1599             print_error('filenotfound', 'error', $CFG->wwwroot.'/');
1600         }
1601         // executed after normal finish or abort
1602         @register_shutdown_function('send_temp_file_finished', $path);
1603     }
1605     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
1606     if (check_browser_version('MSIE')) {
1607         $filename = urlencode($filename);
1608     }
1610     $filesize = $pathisstring ? strlen($path) : filesize($path);
1612     header('Content-Disposition: attachment; filename='.$filename);
1613     header('Content-Length: '.$filesize);
1614     if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
1615         header('Cache-Control: max-age=10');
1616         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1617         header('Pragma: ');
1618     } else { //normal http - prevent caching at all cost
1619         header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
1620         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1621         header('Pragma: no-cache');
1622     }
1623     header('Accept-Ranges: none'); // Do not allow byteserving
1625     //flush the buffers - save memory and disable sid rewrite
1626     // this also disables zlib compression
1627     prepare_file_content_sending();
1629     // send the contents
1630     if ($pathisstring) {
1631         echo $path;
1632     } else {
1633         @readfile($path);
1634     }
1636     die; //no more chars to output
1639 /**
1640  * Internal callback function used by send_temp_file()
1641  */
1642 function send_temp_file_finished($path) {
1643     if (file_exists($path)) {
1644         @unlink($path);
1645     }
1648 /**
1649  * Handles the sending of file data to the user's browser, including support for
1650  * byteranges etc.
1651  *
1652  * @global object
1653  * @global object
1654  * @global object
1655  * @param string $path Path of file on disk (including real filename), or actual content of file as string
1656  * @param string $filename Filename to send
1657  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
1658  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
1659  * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname
1660  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
1661  * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
1662  * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
1663  *                        if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
1664  *                        you must detect this case when control is returned using connection_aborted. Please not that session is closed
1665  *                        and should not be reopened.
1666  * @return no return or void, script execution stopped unless $dontdie is true
1667  */
1668 function send_file($path, $filename, $lifetime = 'default' , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='', $dontdie=false) {
1669     global $CFG, $COURSE, $SESSION;
1671     if ($dontdie) {
1672         ignore_user_abort(true);
1673     }
1675     // MDL-11789, apply $CFG->filelifetime here
1676     if ($lifetime === 'default') {
1677         if (!empty($CFG->filelifetime)) {
1678             $lifetime = $CFG->filelifetime;
1679         } else {
1680             $lifetime = 86400;
1681         }
1682     }
1684     session_get_instance()->write_close(); // unlock session during fileserving
1686     // Use given MIME type if specified, otherwise guess it using mimeinfo.
1687     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
1688     // only Firefox saves all files locally before opening when content-disposition: attachment stated
1689     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
1690     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
1691                          ($mimetype ? $mimetype : mimeinfo('type', $filename));
1693     $lastmodified = $pathisstring ? time() : filemtime($path);
1694     $filesize     = $pathisstring ? strlen($path) : filesize($path);
1696 /* - MDL-13949
1697     //Adobe Acrobat Reader XSS prevention
1698     if ($mimetype=='application/pdf' or mimeinfo('type', $filename)=='application/pdf') {
1699         //please note that it prevents opening of pdfs in browser when http referer disabled
1700         //or file linked from another site; browser caching of pdfs is now disabled too
1701         if (!empty($_SERVER['HTTP_RANGE'])) {
1702             //already byteserving
1703             $lifetime = 1; // >0 needed for byteserving
1704         } else if (empty($_SERVER['HTTP_REFERER']) or strpos($_SERVER['HTTP_REFERER'], $CFG->wwwroot)!==0) {
1705             $mimetype = 'application/x-forcedownload';
1706             $forcedownload = true;
1707             $lifetime = 0;
1708         } else {
1709             $lifetime = 1; // >0 needed for byteserving
1710         }
1711     }
1712 */
1714     //try to disable automatic sid rewrite in cookieless mode
1715     @ini_set("session.use_trans_sid", "false");
1717     //do not put '@' before the next header to detect incorrect moodle configurations,
1718     //error should be better than "weird" empty lines for admins/users
1719     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1721     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
1722     if (check_browser_version('MSIE')) {
1723         $filename = rawurlencode($filename);
1724     }
1726     if ($forcedownload) {
1727         header('Content-Disposition: attachment; filename="'.$filename.'"');
1728     } else {
1729         header('Content-Disposition: inline; filename="'.$filename.'"');
1730     }
1732     if ($lifetime > 0) {
1733         header('Cache-Control: max-age='.$lifetime);
1734         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
1735         header('Pragma: ');
1737         if (empty($CFG->disablebyteserving) && !$pathisstring && $mimetype != 'text/plain' && $mimetype != 'text/html') {
1739             header('Accept-Ranges: bytes');
1741             if (!empty($_SERVER['HTTP_RANGE']) && strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
1742                 // byteserving stuff - for acrobat reader and download accelerators
1743                 // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
1744                 // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
1745                 $ranges = false;
1746                 if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
1747                     foreach ($ranges as $key=>$value) {
1748                         if ($ranges[$key][1] == '') {
1749                             //suffix case
1750                             $ranges[$key][1] = $filesize - $ranges[$key][2];
1751                             $ranges[$key][2] = $filesize - 1;
1752                         } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
1753                             //fix range length
1754                             $ranges[$key][2] = $filesize - 1;
1755                         }
1756                         if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
1757                             //invalid byte-range ==> ignore header
1758                             $ranges = false;
1759                             break;
1760                         }
1761                         //prepare multipart header
1762                         $ranges[$key][0] =  "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
1763                         $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
1764                     }
1765                 } else {
1766                     $ranges = false;
1767                 }
1768                 if ($ranges) {
1769                     $handle = fopen($path, 'rb');
1770                     byteserving_send_file($handle, $mimetype, $ranges, $filesize);
1771                 }
1772             }
1773         } else {
1774             /// Do not byteserve (disabled, strings, text and html files).
1775             header('Accept-Ranges: none');
1776         }
1777     } else { // Do not cache files in proxies and browsers
1778         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
1779             header('Cache-Control: max-age=10');
1780             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1781             header('Pragma: ');
1782         } else { //normal http - prevent caching at all cost
1783             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
1784             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1785             header('Pragma: no-cache');
1786         }
1787         header('Accept-Ranges: none'); // Do not allow byteserving when caching disabled
1788     }
1790     if (empty($filter)) {
1791         if ($mimetype == 'text/plain') {
1792             header('Content-Type: Text/plain; charset=utf-8'); //add encoding
1793         } else {
1794             header('Content-Type: '.$mimetype);
1795         }
1796         header('Content-Length: '.$filesize);
1798         //flush the buffers - save memory and disable sid rewrite
1799         //this also disables zlib compression
1800         prepare_file_content_sending();
1802         // send the contents
1803         if ($pathisstring) {
1804             echo $path;
1805         } else {
1806             @readfile($path);
1807         }
1809     } else {     // Try to put the file through filters
1810         if ($mimetype == 'text/html') {
1811             $options = new stdClass();
1812             $options->noclean = true;
1813             $options->nocache = true; // temporary workaround for MDL-5136
1814             $text = $pathisstring ? $path : implode('', file($path));
1816             $text = file_modify_html_header($text);
1817             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
1819             header('Content-Length: '.strlen($output));
1820             header('Content-Type: text/html');
1822             //flush the buffers - save memory and disable sid rewrite
1823             //this also disables zlib compression
1824             prepare_file_content_sending();
1826             // send the contents
1827             echo $output;
1828         // only filter text if filter all files is selected
1829         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
1830             $options = new stdClass();
1831             $options->newlines = false;
1832             $options->noclean = true;
1833             $text = htmlentities($pathisstring ? $path : implode('', file($path)));
1834             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
1836             header('Content-Length: '.strlen($output));
1837             header('Content-Type: text/html; charset=utf-8'); //add encoding
1839             //flush the buffers - save memory and disable sid rewrite
1840             //this also disables zlib compression
1841             prepare_file_content_sending();
1843             // send the contents
1844             echo $output;
1846         } else {    // Just send it out raw
1847             header('Content-Length: '.$filesize);
1848             header('Content-Type: '.$mimetype);
1850             //flush the buffers - save memory and disable sid rewrite
1851             //this also disables zlib compression
1852             prepare_file_content_sending();
1854             // send the contents
1855             if ($pathisstring) {
1856                 echo $path;
1857             }else {
1858                 @readfile($path);
1859             }
1860         }
1861     }
1862     if ($dontdie) {
1863         return;
1864     }
1865     die; //no more chars to output!!!
1868 /**
1869  * Handles the sending of file data to the user's browser, including support for
1870  * byteranges etc.
1871  *
1872  * @global object
1873  * @global object
1874  * @global object
1875  * @param object $stored_file local file object
1876  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
1877  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
1878  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
1879  * @param string $filename Override filename
1880  * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
1881  *                        if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
1882  *                        you must detect this case when control is returned using connection_aborted. Please not that session is closed
1883  *                        and should not be reopened.
1884  * @return void no return or void, script execution stopped unless $dontdie is true
1885  */
1886 function send_stored_file($stored_file, $lifetime=86400 , $filter=0, $forcedownload=false, $filename=null, $dontdie=false) {
1887     global $CFG, $COURSE, $SESSION;
1889     if (!$stored_file or $stored_file->is_directory()) {
1890         // nothing to serve
1891         if ($dontdie) {
1892             return;
1893         }
1894         die;
1895     }
1897     if ($dontdie) {
1898         ignore_user_abort(true);
1899     }
1901     session_get_instance()->write_close(); // unlock session during fileserving
1903     // Use given MIME type if specified, otherwise guess it using mimeinfo.
1904     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
1905     // only Firefox saves all files locally before opening when content-disposition: attachment stated
1906     $filename     = is_null($filename) ? $stored_file->get_filename() : $filename;
1907     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
1908     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
1909                          ($stored_file->get_mimetype() ? $stored_file->get_mimetype() : mimeinfo('type', $filename));
1911     $lastmodified = $stored_file->get_timemodified();
1912     $filesize     = $stored_file->get_filesize();
1914     //try to disable automatic sid rewrite in cookieless mode
1915     @ini_set("session.use_trans_sid", "false");
1917     //do not put '@' before the next header to detect incorrect moodle configurations,
1918     //error should be better than "weird" empty lines for admins/users
1919     //TODO: should we remove all those @ before the header()? Are all of the values supported on all servers?
1920     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1922     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
1923     if (check_browser_version('MSIE')) {
1924         $filename = rawurlencode($filename);
1925     }
1927     if ($forcedownload) {
1928         header('Content-Disposition: attachment; filename="'.$filename.'"');
1929     } else {
1930         header('Content-Disposition: inline; filename="'.$filename.'"');
1931     }
1933     if ($lifetime > 0) {
1934         header('Cache-Control: max-age='.$lifetime);
1935         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
1936         header('Pragma: ');
1938         if (empty($CFG->disablebyteserving) && $mimetype != 'text/plain' && $mimetype != 'text/html') {
1940             header('Accept-Ranges: bytes');
1942             if (!empty($_SERVER['HTTP_RANGE']) && strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
1943                 // byteserving stuff - for acrobat reader and download accelerators
1944                 // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
1945                 // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
1946                 $ranges = false;
1947                 if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
1948                     foreach ($ranges as $key=>$value) {
1949                         if ($ranges[$key][1] == '') {
1950                             //suffix case
1951                             $ranges[$key][1] = $filesize - $ranges[$key][2];
1952                             $ranges[$key][2] = $filesize - 1;
1953                         } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
1954                             //fix range length
1955                             $ranges[$key][2] = $filesize - 1;
1956                         }
1957                         if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
1958                             //invalid byte-range ==> ignore header
1959                             $ranges = false;
1960                             break;
1961                         }
1962                         //prepare multipart header
1963                         $ranges[$key][0] =  "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
1964                         $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
1965                     }
1966                 } else {
1967                     $ranges = false;
1968                 }
1969                 if ($ranges) {
1970                     byteserving_send_file($stored_file->get_content_file_handle(), $mimetype, $ranges, $filesize);
1971                 }
1972             }
1973         } else {
1974             /// Do not byteserve (disabled, strings, text and html files).
1975             header('Accept-Ranges: none');
1976         }
1977     } else { // Do not cache files in proxies and browsers
1978         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
1979             header('Cache-Control: max-age=10');
1980             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1981             header('Pragma: ');
1982         } else { //normal http - prevent caching at all cost
1983             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
1984             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1985             header('Pragma: no-cache');
1986         }
1987         header('Accept-Ranges: none'); // Do not allow byteserving when caching disabled
1988     }
1990     if (empty($filter)) {
1991         $filtered = false;
1992         if ($mimetype == 'text/plain') {
1993             header('Content-Type: Text/plain; charset=utf-8'); //add encoding
1994         } else {
1995             header('Content-Type: '.$mimetype);
1996         }
1997         header('Content-Length: '.$filesize);
1999         //flush the buffers - save memory and disable sid rewrite
2000         //this also disables zlib compression
2001         prepare_file_content_sending();
2003         // send the contents
2004         if ($filtered) {
2005             echo $text;
2006         } else {
2007             $stored_file->readfile();
2008         }
2010     } else {     // Try to put the file through filters
2011         if ($mimetype == 'text/html') {
2012             $options = new stdClass();
2013             $options->noclean = true;
2014             $options->nocache = true; // temporary workaround for MDL-5136
2015             $text = $stored_file->get_content();
2016             $text = file_modify_html_header($text);
2017             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2019             header('Content-Length: '.strlen($output));
2020             header('Content-Type: text/html');
2022             //flush the buffers - save memory and disable sid rewrite
2023             //this also disables zlib compression
2024             prepare_file_content_sending();
2026             // send the contents
2027             echo $output;
2029         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2030             // only filter text if filter all files is selected
2031             $options = new stdClass();
2032             $options->newlines = false;
2033             $options->noclean = true;
2034             $text = $stored_file->get_content();
2035             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2037             header('Content-Length: '.strlen($output));
2038             header('Content-Type: text/html; charset=utf-8'); //add encoding
2040             //flush the buffers - save memory and disable sid rewrite
2041             //this also disables zlib compression
2042             prepare_file_content_sending();
2044             // send the contents
2045             echo $output;
2047         } else {    // Just send it out raw
2048             header('Content-Length: '.$filesize);
2049             header('Content-Type: '.$mimetype);
2051             //flush the buffers - save memory and disable sid rewrite
2052             //this also disables zlib compression
2053             prepare_file_content_sending();
2055             // send the contents
2056             $stored_file->readfile();
2057         }
2058     }
2059     if ($dontdie) {
2060         return;
2061     }
2062     die; //no more chars to output!!!
2065 /**
2066  * Retrieves an array of records from a CSV file and places
2067  * them into a given table structure
2068  *
2069  * @global object
2070  * @global object
2071  * @param string $file The path to a CSV file
2072  * @param string $table The table to retrieve columns from
2073  * @return bool|array Returns an array of CSV records or false
2074  */
2075 function get_records_csv($file, $table) {
2076     global $CFG, $DB;
2078     if (!$metacolumns = $DB->get_columns($table)) {
2079         return false;
2080     }
2082     if(!($handle = @fopen($file, 'r'))) {
2083         print_error('get_records_csv failed to open '.$file);
2084     }
2086     $fieldnames = fgetcsv($handle, 4096);
2087     if(empty($fieldnames)) {
2088         fclose($handle);
2089         return false;
2090     }
2092     $columns = array();
2094     foreach($metacolumns as $metacolumn) {
2095         $ord = array_search($metacolumn->name, $fieldnames);
2096         if(is_int($ord)) {
2097             $columns[$metacolumn->name] = $ord;
2098         }
2099     }
2101     $rows = array();
2103     while (($data = fgetcsv($handle, 4096)) !== false) {
2104         $item = new stdClass;
2105         foreach($columns as $name => $ord) {
2106             $item->$name = $data[$ord];
2107         }
2108         $rows[] = $item;
2109     }
2111     fclose($handle);
2112     return $rows;
2115 /**
2116  *
2117  * @global object
2118  * @global object
2119  * @param string $file The file to put the CSV content into
2120  * @param array $records An array of records to write to a CSV file
2121  * @param string $table The table to get columns from
2122  * @return bool success
2123  */
2124 function put_records_csv($file, $records, $table = NULL) {
2125     global $CFG, $DB;
2127     if (empty($records)) {
2128         return true;
2129     }
2131     $metacolumns = NULL;
2132     if ($table !== NULL && !$metacolumns = $DB->get_columns($table)) {
2133         return false;
2134     }
2136     echo "x";
2138     if(!($fp = @fopen($CFG->dataroot.'/temp/'.$file, 'w'))) {
2139         print_error('put_records_csv failed to open '.$file);
2140     }
2142     $proto = reset($records);
2143     if(is_object($proto)) {
2144         $fields_records = array_keys(get_object_vars($proto));
2145     }
2146     else if(is_array($proto)) {
2147         $fields_records = array_keys($proto);
2148     }
2149     else {
2150         return false;
2151     }
2152     echo "x";
2154     if(!empty($metacolumns)) {
2155         $fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
2156         $fields = array_intersect($fields_records, $fields_table);
2157     }
2158     else {
2159         $fields = $fields_records;
2160     }
2162     fwrite($fp, implode(',', $fields));
2163     fwrite($fp, "\r\n");
2165     foreach($records as $record) {
2166         $array  = (array)$record;
2167         $values = array();
2168         foreach($fields as $field) {
2169             if(strpos($array[$field], ',')) {
2170                 $values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
2171             }
2172             else {
2173                 $values[] = $array[$field];
2174             }
2175         }
2176         fwrite($fp, implode(',', $values)."\r\n");
2177     }
2179     fclose($fp);
2180     return true;
2184 /**
2185  * Recursively delete the file or folder with path $location. That is,
2186  * if it is a file delete it. If it is a folder, delete all its content
2187  * then delete it. If $location does not exist to start, that is not
2188  * considered an error.
2189  *
2190  * @param string $location the path to remove.
2191  * @return bool
2192  */
2193 function fulldelete($location) {
2194     if (empty($location)) {
2195         // extra safety against wrong param
2196         return false;
2197     }
2198     if (is_dir($location)) {
2199         $currdir = opendir($location);
2200         while (false !== ($file = readdir($currdir))) {
2201             if ($file <> ".." && $file <> ".") {
2202                 $fullfile = $location."/".$file;
2203                 if (is_dir($fullfile)) {
2204                     if (!fulldelete($fullfile)) {
2205                         return false;
2206                     }
2207                 } else {
2208                     if (!unlink($fullfile)) {
2209                         return false;
2210                     }
2211                 }
2212             }
2213         }
2214         closedir($currdir);
2215         if (! rmdir($location)) {
2216             return false;
2217         }
2219     } else if (file_exists($location)) {
2220         if (!unlink($location)) {
2221             return false;
2222         }
2223     }
2224     return true;
2227 /**
2228  * Send requested byterange of file.
2229  *
2230  * @param object $handle A file handle
2231  * @param string $mimetype The mimetype for the output
2232  * @param array $ranges An array of ranges to send
2233  * @param string $filesize The size of the content if only one range is used
2234  */
2235 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2236     $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2237     if ($handle === false) {
2238         die;
2239     }
2240     if (count($ranges) == 1) { //only one range requested
2241         $length = $ranges[0][2] - $ranges[0][1] + 1;
2242         header('HTTP/1.1 206 Partial content');
2243         header('Content-Length: '.$length);
2244         header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2245         header('Content-Type: '.$mimetype);
2247         //flush the buffers - save memory and disable sid rewrite
2248         //this also disables zlib compression
2249         prepare_file_content_sending();
2251         $buffer = '';
2252         fseek($handle, $ranges[0][1]);
2253         while (!feof($handle) && $length > 0) {
2254             @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2255             $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2256             echo $buffer;
2257             flush();
2258             $length -= strlen($buffer);
2259         }
2260         fclose($handle);
2261         die;
2262     } else { // multiple ranges requested - not tested much
2263         $totallength = 0;
2264         foreach($ranges as $range) {
2265             $totallength += strlen($range[0]) + $range[2] - $range[1] + 1;
2266         }
2267         $totallength += strlen("\r\n--".BYTESERVING_BOUNDARY."--\r\n");
2268         header('HTTP/1.1 206 Partial content');
2269         header('Content-Length: '.$totallength);
2270         header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY);
2271         //TODO: check if "multipart/x-byteranges" is more compatible with current readers/browsers/servers
2273         //flush the buffers - save memory and disable sid rewrite
2274         //this also disables zlib compression
2275         prepare_file_content_sending();
2277         foreach($ranges as $range) {
2278             $length = $range[2] - $range[1] + 1;
2279             echo $range[0];
2280             $buffer = '';
2281             fseek($handle, $range[1]);
2282             while (!feof($handle) && $length > 0) {
2283                 @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2284                 $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2285                 echo $buffer;
2286                 flush();
2287                 $length -= strlen($buffer);
2288             }
2289         }
2290         echo "\r\n--".BYTESERVING_BOUNDARY."--\r\n";
2291         fclose($handle);
2292         die;
2293     }
2296 /**
2297  * add includes (js and css) into uploaded files
2298  * before returning them, useful for themes and utf.js includes
2299  *
2300  * @global object
2301  * @param string $text text to search and replace
2302  * @return string text with added head includes
2303  */
2304 function file_modify_html_header($text) {
2305     // first look for <head> tag
2306     global $CFG;
2308     $stylesheetshtml = '';
2309 /*    foreach ($CFG->stylesheets as $stylesheet) {
2310         //TODO: MDL-21120
2311         $stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
2312     }*/
2314     $ufo = '';
2315     if (filter_is_enabled('filter/mediaplugin')) {
2316         // this script is needed by most media filter plugins.
2317         $attributes = array('type'=>'text/javascript', 'src'=>$CFG->httpswwwroot . '/lib/ufo.js');
2318         $ufo = html_writer::tag('script', '', $attributes) . "\n";
2319     }
2321     preg_match('/\<head\>|\<HEAD\>/', $text, $matches);
2322     if ($matches) {
2323         $replacement = '<head>'.$ufo.$stylesheetshtml;
2324         $text = preg_replace('/\<head\>|\<HEAD\>/', $replacement, $text, 1);
2325         return $text;
2326     }
2328     // if not, look for <html> tag, and stick <head> right after
2329     preg_match('/\<html\>|\<HTML\>/', $text, $matches);
2330     if ($matches) {
2331         // replace <html> tag with <html><head>includes</head>
2332         $replacement = '<html>'."\n".'<head>'.$ufo.$stylesheetshtml.'</head>';
2333         $text = preg_replace('/\<html\>|\<HTML\>/', $replacement, $text, 1);
2334         return $text;
2335     }
2337     // if not, look for <body> tag, and stick <head> before body
2338     preg_match('/\<body\>|\<BODY\>/', $text, $matches);
2339     if ($matches) {
2340         $replacement = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".'<body>';
2341         $text = preg_replace('/\<body\>|\<BODY\>/', $replacement, $text, 1);
2342         return $text;
2343     }
2345     // if not, just stick a <head> tag at the beginning
2346     $text = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".$text;
2347     return $text;
2350 /**
2351  * RESTful cURL class
2352  *
2353  * This is a wrapper class for curl, it is quite easy to use:
2354  * <code>
2355  * $c = new curl;
2356  * // enable cache
2357  * $c = new curl(array('cache'=>true));
2358  * // enable cookie
2359  * $c = new curl(array('cookie'=>true));
2360  * // enable proxy
2361  * $c = new curl(array('proxy'=>true));
2362  *
2363  * // HTTP GET Method
2364  * $html = $c->get('http://example.com');
2365  * // HTTP POST Method
2366  * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2367  * // HTTP PUT Method
2368  * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2369  * </code>
2370  *
2371  * @package    core
2372  * @subpackage file
2373  * @author     Dongsheng Cai <dongsheng@cvs.moodle.org>
2374  * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
2375  */
2377 class curl {
2378     /** @var bool */
2379     public  $cache    = false;
2380     public  $proxy    = false;
2381     /** @var string */
2382     public  $version  = '0.4 dev';
2383     /** @var array */
2384     public  $response = array();
2385     public  $header   = array();
2386     /** @var string */
2387     public  $info;
2388     public  $error;
2390     /** @var array */
2391     private $options;
2392     /** @var string */
2393     private $proxy_host = '';
2394     private $proxy_auth = '';
2395     private $proxy_type = '';
2396     /** @var bool */
2397     private $debug    = false;
2398     private $cookie   = false;
2400     /**
2401      * @global object
2402      * @param array $options
2403      */
2404     public function __construct($options = array()){
2405         global $CFG;
2406         if (!function_exists('curl_init')) {
2407             $this->error = 'cURL module must be enabled!';
2408             trigger_error($this->error, E_USER_ERROR);
2409             return false;
2410         }
2411         // the options of curl should be init here.
2412         $this->resetopt();
2413         if (!empty($options['debug'])) {
2414             $this->debug = true;
2415         }
2416         if(!empty($options['cookie'])) {
2417             if($options['cookie'] === true) {
2418                 $this->cookie = $CFG->dataroot.'/curl_cookie.txt';
2419             } else {
2420                 $this->cookie = $options['cookie'];
2421             }
2422         }
2423         if (!empty($options['cache'])) {
2424             if (class_exists('curl_cache')) {
2425                 if (!empty($options['module_cache'])) {
2426                     $this->cache = new curl_cache($options['module_cache']);
2427                 } else {
2428                     $this->cache = new curl_cache('misc');
2429                 }
2430             }
2431         }
2432         if (!empty($CFG->proxyhost)) {
2433             if (empty($CFG->proxyport)) {
2434                 $this->proxy_host = $CFG->proxyhost;
2435             } else {
2436                 $this->proxy_host = $CFG->proxyhost.':'.$CFG->proxyport;
2437             }
2438             if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
2439                 $this->proxy_auth = $CFG->proxyuser.':'.$CFG->proxypassword;
2440                 $this->setopt(array(
2441                             'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM,
2442                             'proxyuserpwd'=>$this->proxy_auth));
2443             }
2444             if (!empty($CFG->proxytype)) {
2445                 if ($CFG->proxytype == 'SOCKS5') {
2446                     $this->proxy_type = CURLPROXY_SOCKS5;
2447                 } else {
2448                     $this->proxy_type = CURLPROXY_HTTP;
2449                     $this->setopt(array('httpproxytunnel'=>false));
2450                 }
2451                 $this->setopt(array('proxytype'=>$this->proxy_type));
2452             }
2453         }
2454         if (!empty($this->proxy_host)) {
2455             $this->proxy = array('proxy'=>$this->proxy_host);
2456         }
2457     }
2458     /**
2459      * Resets the CURL options that have already been set
2460      */
2461     public function resetopt(){
2462         $this->options = array();
2463         $this->options['CURLOPT_USERAGENT']         = 'MoodleBot/1.0';
2464         // True to include the header in the output
2465         $this->options['CURLOPT_HEADER']            = 0;
2466         // True to Exclude the body from the output
2467         $this->options['CURLOPT_NOBODY']            = 0;
2468         // TRUE to follow any "Location: " header that the server
2469         // sends as part of the HTTP header (note this is recursive,
2470         // PHP will follow as many "Location: " headers that it is sent,
2471         // unless CURLOPT_MAXREDIRS is set).
2472         //$this->options['CURLOPT_FOLLOWLOCATION']    = 1;
2473         $this->options['CURLOPT_MAXREDIRS']         = 10;
2474         $this->options['CURLOPT_ENCODING']          = '';
2475         // TRUE to return the transfer as a string of the return
2476         // value of curl_exec() instead of outputting it out directly.
2477         $this->options['CURLOPT_RETURNTRANSFER']    = 1;
2478         $this->options['CURLOPT_BINARYTRANSFER']    = 0;
2479         $this->options['CURLOPT_SSL_VERIFYPEER']    = 0;
2480         $this->options['CURLOPT_SSL_VERIFYHOST']    = 2;
2481         $this->options['CURLOPT_CONNECTTIMEOUT']    = 30;
2482     }
2484     /**
2485      * Reset Cookie
2486      */
2487     public function resetcookie() {
2488         if (!empty($this->cookie)) {
2489             if (is_file($this->cookie)) {
2490                 $fp = fopen($this->cookie, 'w');
2491                 if (!empty($fp)) {
2492                     fwrite($fp, '');
2493                     fclose($fp);
2494                 }
2495             }
2496         }
2497     }
2499     /**
2500      * Set curl options
2501      *
2502      * @param array $options If array is null, this function will
2503      * reset the options to default value.
2504      *
2505      */
2506     public function setopt($options = array()) {
2507         if (is_array($options)) {
2508             foreach($options as $name => $val){
2509                 if (stripos($name, 'CURLOPT_') === false) {
2510                     $name = strtoupper('CURLOPT_'.$name);
2511                 }
2512                 $this->options[$name] = $val;
2513             }
2514         }
2515     }
2516     /**
2517      * Reset http method
2518      *
2519      */
2520     public function cleanopt(){
2521         unset($this->options['CURLOPT_HTTPGET']);
2522         unset($this->options['CURLOPT_POST']);
2523         unset($this->options['CURLOPT_POSTFIELDS']);
2524         unset($this->options['CURLOPT_PUT']);
2525         unset($this->options['CURLOPT_INFILE']);
2526         unset($this->options['CURLOPT_INFILESIZE']);
2527         unset($this->options['CURLOPT_CUSTOMREQUEST']);
2528     }
2530     /**
2531      * Set HTTP Request Header
2532      *
2533      * @param array $headers
2534      *
2535      */
2536     public function setHeader($header) {
2537         if (is_array($header)){
2538             foreach ($header as $v) {
2539                 $this->setHeader($v);
2540             }
2541         } else {
2542             $this->header[] = $header;
2543         }
2544     }
2545     /**
2546      * Set HTTP Response Header
2547      *
2548      */
2549     public function getResponse(){
2550         return $this->response;
2551     }
2552     /**
2553      * private callback function
2554      * Formatting HTTP Response Header
2555      *
2556      * @param mixed $ch Apparently not used
2557      * @param string $header
2558      * @return int The strlen of the header
2559      */
2560     private function formatHeader($ch, $header)
2561     {
2562         $this->count++;
2563         if (strlen($header) > 2) {
2564             list($key, $value) = explode(" ", rtrim($header, "\r\n"), 2);
2565             $key = rtrim($key, ':');
2566             if (!empty($this->response[$key])) {
2567                 if (is_array($this->response[$key])){
2568                     $this->response[$key][] = $value;
2569                 } else {
2570                     $tmp = $this->response[$key];
2571                     $this->response[$key] = array();
2572                     $this->response[$key][] = $tmp;
2573                     $this->response[$key][] = $value;
2575                 }
2576             } else {
2577                 $this->response[$key] = $value;
2578             }
2579         }
2580         return strlen($header);
2581     }
2583     /**
2584      * Set options for individual curl instance
2585      *
2586      * @param object $curl A curl handle
2587      * @param array $options
2588      * @return object The curl handle
2589      */
2590     private function apply_opt($curl, $options) {
2591         // Clean up
2592         $this->cleanopt();
2593         // set cookie
2594         if (!empty($this->cookie) || !empty($options['cookie'])) {
2595             $this->setopt(array('cookiejar'=>$this->cookie,
2596                             'cookiefile'=>$this->cookie
2597                              ));
2598         }
2600         // set proxy
2601         if (!empty($this->proxy) || !empty($options['proxy'])) {
2602             $this->setopt($this->proxy);
2603         }
2604         $this->setopt($options);
2605         // reset before set options
2606         curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this,'formatHeader'));
2607         // set headers
2608         if (empty($this->header)){
2609             $this->setHeader(array(
2610                 'User-Agent: MoodleBot/1.0',
2611                 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
2612                 'Connection: keep-alive'
2613                 ));
2614         }
2615         curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
2617         if ($this->debug){
2618             echo '<h1>Options</h1>';
2619             var_dump($this->options);
2620             echo '<h1>Header</h1>';
2621             var_dump($this->header);
2622         }
2624         // set options
2625         foreach($this->options as $name => $val) {
2626             if (is_string($name)) {
2627                 $name = constant(strtoupper($name));
2628             }
2629             curl_setopt($curl, $name, $val);
2630         }
2631         return $curl;
2632     }
2633     /**
2634      * Download multiple files in parallel
2635      *
2636      * Calls {@link multi()} with specific download headers
2637      *
2638      * <code>
2639      * $c = new curl;
2640      * $c->download(array(
2641      *              array('url'=>'http://localhost/', 'file'=>fopen('a', 'wb')),
2642      *              array('url'=>'http://localhost/20/', 'file'=>fopen('b', 'wb'))
2643      *              ));
2644      * </code>
2645      *
2646      * @param array $requests An array of files to request
2647      * @param array $options An array of options to set
2648      * @return array An array of results
2649      */
2650     public function download($requests, $options = array()) {
2651         $options['CURLOPT_BINARYTRANSFER'] = 1;
2652         $options['RETURNTRANSFER'] = false;
2653         return $this->multi($requests, $options);
2654     }
2655     /*
2656      * Mulit HTTP Requests
2657      * This function could run multi-requests in parallel.
2658      *
2659      * @param array $requests An array of files to request
2660      * @param array $options An array of options to set
2661      * @return array An array of results
2662      */
2663     protected function multi($requests, $options = array()) {
2664         $count   = count($requests);
2665         $handles = array();
2666         $results = array();
2667         $main    = curl_multi_init();
2668         for ($i = 0; $i < $count; $i++) {
2669             $url = $requests[$i];
2670             foreach($url as $n=>$v){
2671                 $options[$n] = $url[$n];
2672             }
2673             $handles[$i] = curl_init($url['url']);
2674             $this->apply_opt($handles[$i], $options);
2675             curl_multi_add_handle($main, $handles[$i]);
2676         }
2677         $running = 0;
2678         do {
2679             curl_multi_exec($main, $running);
2680         } while($running > 0);
2681         for ($i = 0; $i < $count; $i++) {
2682             if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
2683                 $results[] = true;
2684             } else {
2685                 $results[] = curl_multi_getcontent($handles[$i]);
2686             }
2687             curl_multi_remove_handle($main, $handles[$i]);
2688         }
2689         curl_multi_close($main);
2690         return $results;
2691     }
2692     /**
2693      * Single HTTP Request
2694      *
2695      * @param string $url The URL to request
2696      * @param array $options
2697      * @return bool
2698      */
2699     protected function request($url, $options = array()){
2700         // create curl instance
2701         $curl = curl_init($url);
2702         $options['url'] = $url;
2703         $this->apply_opt($curl, $options);
2704         if ($this->cache && $ret = $this->cache->get($this->options)) {
2705             return $ret;
2706         } else {
2707             $ret = curl_exec($curl);
2708             if ($this->cache) {
2709                 $this->cache->set($this->options, $ret);
2710             }
2711         }
2713         $this->info  = curl_getinfo($curl);
2714         $this->error = curl_error($curl);
2716         if ($this->debug){
2717             echo '<h1>Return Data</h1>';
2718             var_dump($ret);
2719             echo '<h1>Info</h1>';
2720             var_dump($this->info);
2721             echo '<h1>Error</h1>';
2722             var_dump($this->error);
2723         }
2725         curl_close($curl);
2727         if (empty($this->error)){
2728             return $ret;
2729         } else {
2730             return $this->error;
2731             // exception is not ajax friendly
2732             //throw new moodle_exception($this->error, 'curl');
2733         }
2734     }
2736     /**
2737      * HTTP HEAD method
2738      *
2739      * @see request()
2740      *
2741      * @param string $url
2742      * @param array $options
2743      * @return bool
2744      */
2745     public function head($url, $options = array()){
2746         $options['CURLOPT_HTTPGET'] = 0;
2747         $options['CURLOPT_HEADER']  = 1;
2748         $options['CURLOPT_NOBODY']  = 1;
2749         return $this->request($url, $options);
2750     }
2752     /**
2753      * HTTP POST method
2754      *
2755      * @param string $url
2756      * @param array|string $params
2757      * @param array $options
2758      * @return bool
2759      */
2760     public function post($url, $params = '', $options = array()){
2761         $options['CURLOPT_POST']       = 1;
2762         if (is_array($params)) {
2763             $this->_tmp_file_post_params = array();
2764             foreach ($params as $key => $value) {
2765                 if ($value instanceof stored_file) {
2766                     $value->add_to_curl_request($this, $key);
2767                 } else {
2768                     $this->_tmp_file_post_params[$key] = $value;
2769                 }
2770             }
2771             $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
2772             unset($this->_tmp_file_post_params);
2773         } else {
2774             // $params is the raw post data
2775             $options['CURLOPT_POSTFIELDS'] = $params;
2776         }
2777         return $this->request($url, $options);
2778     }
2780     /**
2781      * HTTP GET method
2782      *
2783      * @param string $url
2784      * @param array $params
2785      * @param array $options
2786      * @return bool
2787      */
2788     public function get($url, $params = array(), $options = array()){
2789         $options['CURLOPT_HTTPGET'] = 1;
2791         if (!empty($params)){
2792             $url .= (stripos($url, '?') !== false) ? '&' : '?';
2793             $url .= http_build_query($params, '', '&');
2794         }
2795         return $this->request($url, $options);
2796     }
2798     /**
2799      * HTTP PUT method
2800      *
2801      * @param string $url
2802      * @param array $params
2803      * @param array $options
2804      * @return bool
2805      */
2806     public function put($url, $params = array(), $options = array()){
2807         $file = $params['file'];
2808         if (!is_file($file)){
2809             return null;
2810         }
2811         $fp   = fopen($file, 'r');
2812         $size = filesize($file);
2813         $options['CURLOPT_PUT']        = 1;
2814         $options['CURLOPT_INFILESIZE'] = $size;
2815         $options['CURLOPT_INFILE']     = $fp;
2816         if (!isset($this->options['CURLOPT_USERPWD'])){
2817             $this->setopt(array('CURLOPT_USERPWD'=>'anonymous: noreply@moodle.org'));
2818         }
2819         $ret = $this->request($url, $options);
2820         fclose($fp);
2821         return $ret;
2822     }
2824     /**
2825      * HTTP DELETE method
2826      *
2827      * @param string $url
2828      * @param array $params
2829      * @param array $options
2830      * @return bool
2831      */
2832     public function delete($url, $param = array(), $options = array()){
2833         $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
2834         if (!isset($options['CURLOPT_USERPWD'])) {
2835             $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
2836         }
2837         $ret = $this->request($url, $options);
2838         return $ret;
2839     }
2840     /**
2841      * HTTP TRACE method
2842      *
2843      * @param string $url
2844      * @param array $options
2845      * @return bool
2846      */
2847     public function trace($url, $options = array()){
2848         $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
2849         $ret = $this->request($url, $options);
2850         return $ret;
2851     }
2852     /**
2853      * HTTP OPTIONS method
2854      *
2855      * @param string $url
2856      * @param array $options
2857      * @return bool
2858      */
2859     public function options($url, $options = array()){
2860         $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
2861         $ret = $this->request($url, $options);
2862         return $ret;
2863     }
2864     public function get_info() {
2865         return $this->info;
2866     }
2869 /**
2870  * This class is used by cURL class, use case:
2871  *
2872  * <code>
2873  * $CFG->repositorycacheexpire = 120;
2874  * $CFG->curlcache = 120;
2875  *
2876  * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
2877  * $ret = $c->get('http://www.google.com');
2878  * </code>
2879  *
2880  * @package    core
2881  * @subpackage file
2882  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
2883  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2884  */
2885 class curl_cache {
2886     /** @var string */
2887     public $dir = '';
2888     /**
2889      *
2890      * @global object
2891      * @param string @module which module is using curl_cache
2892      *
2893      */
2894     function __construct($module = 'repository'){
2895         global $CFG;
2896         if (!empty($module)) {
2897             $this->dir = $CFG->dataroot.'/cache/'.$module.'/';
2898         } else {
2899             $this->dir = $CFG->dataroot.'/cache/misc/';
2900         }
2901         if (!file_exists($this->dir)) {
2902             mkdir($this->dir, $CFG->directorypermissions, true);
2903         }
2904         if ($module == 'repository') {
2905             if (empty($CFG->repositorycacheexpire)) {
2906                 $CFG->repositorycacheexpire = 120;
2907             }
2908             $this->ttl = $CFG->repositorycacheexpire;
2909         } else {
2910             if (empty($CFG->curlcache)) {
2911                 $CFG->curlcache = 120;
2912             }
2913             $this->ttl = $CFG->curlcache;
2914         }
2915     }
2917     /**
2918      * Get cached value
2919      *
2920      * @global object
2921      * @global object
2922      * @param mixed $param
2923      * @return bool|string
2924      */
2925     public function get($param){
2926         global $CFG, $USER;
2927         $this->cleanup($this->ttl);
2928         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
2929         if(file_exists($this->dir.$filename)) {
2930             $lasttime = filemtime($this->dir.$filename);
2931             if(time()-$lasttime > $this->ttl)
2932             {
2933                 return false;
2934             } else {
2935                 $fp = fopen($this->dir.$filename, 'r');
2936                 $size = filesize($this->dir.$filename);
2937                 $content = fread($fp, $size);
2938                 return unserialize($content);
2939             }
2940         }
2941         return false;
2942     }
2944     /**
2945      * Set cache value
2946      *
2947      * @global object $CFG
2948      * @global object $USER
2949      * @param mixed $param
2950      * @param mixed $val
2951      */
2952     public function set($param, $val){
2953         global $CFG, $USER;
2954         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
2955         $fp = fopen($this->dir.$filename, 'w');
2956         fwrite($fp, serialize($val));
2957         fclose($fp);
2958     }
2960     /**
2961      * Remove cache files
2962      *
2963      * @param int $expire The number os seconds before expiry
2964      */
2965     public function cleanup($expire){
2966         if($dir = opendir($this->dir)){
2967             while (false !== ($file = readdir($dir))) {
2968                 if(!is_dir($file) && $file != '.' && $file != '..') {
2969                     $lasttime = @filemtime($this->dir.$file);
2970                     if(time() - $lasttime > $expire){
2971                         @unlink($this->dir.$file);
2972                     }
2973                 }
2974             }
2975         }
2976     }
2977     /**
2978      * delete current user's cache file
2979      *
2980      * @global object $CFG
2981      * @global object $USER
2982      */
2983     public function refresh(){
2984         global $CFG, $USER;
2985         if($dir = opendir($this->dir)){
2986             while (false !== ($file = readdir($dir))) {
2987                 if(!is_dir($file) && $file != '.' && $file != '..') {
2988                     if(strpos($file, 'u'.$USER->id.'_')!==false){
2989                         @unlink($this->dir.$file);
2990                     }
2991                 }
2992             }
2993         }
2994     }
2997 /**
2998  * This class is used to parse lib/file/file_types.mm which help get file
2999  * extensions by file types.
3000  * The file_types.mm file can be edited by freemind in graphic environment.
3001  *
3002  * @package    core
3003  * @subpackage file
3004  * @copyright  2009 Dongsheng Cai <dongsheng@moodle.com>
3005  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3006  */
3007 class filetype_parser {
3008     /**
3009      * Check file_types.mm file, setup variables
3010      *
3011      * @global object $CFG
3012      * @param string $file
3013      */
3014     public function __construct($file = '') {
3015         global $CFG;
3016         if (empty($file)) {
3017             $this->file = $CFG->libdir.'/filestorage/file_types.mm';
3018         } else {
3019             $this->file = $file;
3020         }
3021         $this->tree = array();
3022         $this->result = array();
3023     }
3025     /**
3026      * A private function to browse xml nodes
3027      *
3028      * @param array $parent
3029      * @param array $types
3030      */
3031     private function _browse_nodes($parent, $types) {
3032         $key = (string)$parent['TEXT'];
3033         if(isset($parent->node)) {
3034             $this->tree[$key] = array();
3035             if (in_array((string)$parent['TEXT'], $types)) {
3036                 $this->_select_nodes($parent, $this->result);
3037             } else {
3038                 foreach($parent->node as $v){
3039                     $this->_browse_nodes($v, $types);
3040                 }
3041             }
3042         } else {
3043             $this->tree[] = $key;
3044         }
3045     }
3047     /**
3048      * A private function to select text nodes
3049      *
3050      * @param array $parent
3051      */
3052     private function _select_nodes($parent){
3053         if(isset($parent->node)) {
3054             foreach($parent->node as $v){
3055                 $this->_select_nodes($v, $this->result);
3056             }
3057         } else {
3058             $this->result[] = (string)$parent['TEXT'];
3059         }
3060     }
3063     /**
3064      * Get file extensions by file types names.
3065      *
3066      * @param array $types
3067      * @return mixed
3068      */
3069     public function get_extensions($types) {
3070         if (!is_array($types)) {
3071             $types = array($types);
3072         }
3073         $this->result = array();
3074         if ((is_array($types) && in_array('*', $types)) ||
3075             $types == '*' || empty($types)) {
3076             return array('*');
3077         }
3078         foreach ($types as $key=>$value){
3079             if (strpos($value, '.') !== false) {
3080                 $this->result[] = $value;
3081                 unset($types[$key]);
3082             }
3083         }
3084         if (file_exists($this->file)) {
3085             $xml = simplexml_load_file($this->file);
3086             foreach($xml->node->node as $v){
3087                 if (in_array((string)$v['TEXT'], $types)) {
3088                     $this->_select_nodes($v);
3089                 } else {
3090                     $this->_browse_nodes($v, $types);
3091                 }
3092             }
3093         } else {
3094             exit('Failed to open file lib/filestorage/file_types.mm');
3095         }
3096         return $this->result;
3097     }