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