43bc8ddd24263fa7d7e2d92f64955b132a915930
[moodle.git] / lib / filelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Functions for file handling.
19  *
20  * @package   core_files
21  * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * BYTESERVING_BOUNDARY - string unique string constant.
29  */
30 define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7');
32 require_once("$CFG->libdir/filestorage/file_exceptions.php");
33 require_once("$CFG->libdir/filestorage/file_storage.php");
34 require_once("$CFG->libdir/filestorage/zip_packer.php");
35 require_once("$CFG->libdir/filebrowser/file_browser.php");
37 /**
38  * Encodes file serving url
39  *
40  * @deprecated use moodle_url factory methods instead
41  *
42  * @todo MDL-31071 deprecate this function
43  * @global stdClass $CFG
44  * @param string $urlbase
45  * @param string $path /filearea/itemid/dir/dir/file.exe
46  * @param bool $forcedownload
47  * @param bool $https https url required
48  * @return string encoded file url
49  */
50 function file_encode_url($urlbase, $path, $forcedownload=false, $https=false) {
51     global $CFG;
53 //TODO: deprecate this
55     if ($CFG->slasharguments) {
56         $parts = explode('/', $path);
57         $parts = array_map('rawurlencode', $parts);
58         $path  = implode('/', $parts);
59         $return = $urlbase.$path;
60         if ($forcedownload) {
61             $return .= '?forcedownload=1';
62         }
63     } else {
64         $path = rawurlencode($path);
65         $return = $urlbase.'?file='.$path;
66         if ($forcedownload) {
67             $return .= '&amp;forcedownload=1';
68         }
69     }
71     if ($https) {
72         $return = str_replace('http://', 'https://', $return);
73     }
75     return $return;
76 }
78 /**
79  * Prepares 'editor' formslib element from data in database
80  *
81  * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
82  * function then copies the embedded files into draft area (assigning itemids automatically),
83  * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
84  * displayed.
85  * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
86  * your mform's set_data() supplying the object returned by this function.
87  *
88  * @category files
89  * @param stdClass $data database field that holds the html text with embedded media
90  * @param string $field the name of the database field that holds the html text with embedded media
91  * @param array $options editor options (like maxifiles, maxbytes etc.)
92  * @param stdClass $context context of the editor
93  * @param string $component
94  * @param string $filearea file area name
95  * @param int $itemid item id, required if item exists
96  * @return stdClass modified data object
97  */
98 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
99     $options = (array)$options;
100     if (!isset($options['trusttext'])) {
101         $options['trusttext'] = false;
102     }
103     if (!isset($options['forcehttps'])) {
104         $options['forcehttps'] = false;
105     }
106     if (!isset($options['subdirs'])) {
107         $options['subdirs'] = false;
108     }
109     if (!isset($options['maxfiles'])) {
110         $options['maxfiles'] = 0; // no files by default
111     }
112     if (!isset($options['noclean'])) {
113         $options['noclean'] = false;
114     }
116     //sanity check for passed context. This function doesn't expect $option['context'] to be set
117     //But this function is called before creating editor hence, this is one of the best places to check
118     //if context is used properly. This check notify developer that they missed passing context to editor.
119     if (isset($context) && !isset($options['context'])) {
120         //if $context is not null then make sure $option['context'] is also set.
121         debugging('Context for editor is not set in editoroptions. Hence editor will not respect editor filters', DEBUG_DEVELOPER);
122     } else if (isset($options['context']) && isset($context)) {
123         //If both are passed then they should be equal.
124         if ($options['context']->id != $context->id) {
125             $exceptionmsg = 'Editor context ['.$options['context']->id.'] is not equal to passed context ['.$context->id.']';
126             throw new coding_exception($exceptionmsg);
127         }
128     }
130     if (is_null($itemid) or is_null($context)) {
131         $contextid = null;
132         $itemid = null;
133         if (!isset($data)) {
134             $data = new stdClass();
135         }
136         if (!isset($data->{$field})) {
137             $data->{$field} = '';
138         }
139         if (!isset($data->{$field.'format'})) {
140             $data->{$field.'format'} = editors_get_preferred_format();
141         }
142         if (!$options['noclean']) {
143             $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
144         }
146     } else {
147         if ($options['trusttext']) {
148             // noclean ignored if trusttext enabled
149             if (!isset($data->{$field.'trust'})) {
150                 $data->{$field.'trust'} = 0;
151             }
152             $data = trusttext_pre_edit($data, $field, $context);
153         } else {
154             if (!$options['noclean']) {
155                 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
156             }
157         }
158         $contextid = $context->id;
159     }
161     if ($options['maxfiles'] != 0) {
162         $draftid_editor = file_get_submitted_draft_itemid($field);
163         $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
164         $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
165     } else {
166         $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
167     }
169     return $data;
172 /**
173  * Prepares the content of the 'editor' form element with embedded media files to be saved in database
174  *
175  * This function moves files from draft area to the destination area and
176  * encodes URLs to the draft files so they can be safely saved into DB. The
177  * form has to contain the 'editor' element named foobar_editor, where 'foobar'
178  * is the name of the database field to hold the wysiwyg editor content. The
179  * editor data comes as an array with text, format and itemid properties. This
180  * function automatically adds $data properties foobar, foobarformat and
181  * foobartrust, where foobar has URL to embedded files encoded.
182  *
183  * @category files
184  * @param stdClass $data raw data submitted by the form
185  * @param string $field name of the database field containing the html with embedded media files
186  * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
187  * @param stdClass $context context, required for existing data
188  * @param string $component file component
189  * @param string $filearea file area name
190  * @param int $itemid item id, required if item exists
191  * @return stdClass modified data object
192  */
193 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
194     $options = (array)$options;
195     if (!isset($options['trusttext'])) {
196         $options['trusttext'] = false;
197     }
198     if (!isset($options['forcehttps'])) {
199         $options['forcehttps'] = false;
200     }
201     if (!isset($options['subdirs'])) {
202         $options['subdirs'] = false;
203     }
204     if (!isset($options['maxfiles'])) {
205         $options['maxfiles'] = 0; // no files by default
206     }
207     if (!isset($options['maxbytes'])) {
208         $options['maxbytes'] = 0; // unlimited
209     }
211     if ($options['trusttext']) {
212         $data->{$field.'trust'} = trusttext_trusted($context);
213     } else {
214         $data->{$field.'trust'} = 0;
215     }
217     $editor = $data->{$field.'_editor'};
219     if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
220         $data->{$field} = $editor['text'];
221     } else {
222         $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
223     }
224     $data->{$field.'format'} = $editor['format'];
226     return $data;
229 /**
230  * Saves text and files modified by Editor formslib element
231  *
232  * @category files
233  * @param stdClass $data $database entry field
234  * @param string $field name of data field
235  * @param array $options various options
236  * @param stdClass $context context - must already exist
237  * @param string $component
238  * @param string $filearea file area name
239  * @param int $itemid must already exist, usually means data is in db
240  * @return stdClass modified data obejct
241  */
242 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
243     $options = (array)$options;
244     if (!isset($options['subdirs'])) {
245         $options['subdirs'] = false;
246     }
247     if (is_null($itemid) or is_null($context)) {
248         $itemid = null;
249         $contextid = null;
250     } else {
251         $contextid = $context->id;
252     }
254     $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
255     file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
256     $data->{$field.'_filemanager'} = $draftid_editor;
258     return $data;
261 /**
262  * Saves files modified by File manager formslib element
263  *
264  * @todo MDL-31073 review this function
265  * @category files
266  * @param stdClass $data $database entry field
267  * @param string $field name of data field
268  * @param array $options various options
269  * @param stdClass $context context - must already exist
270  * @param string $component
271  * @param string $filearea file area name
272  * @param int $itemid must already exist, usually means data is in db
273  * @return stdClass modified data obejct
274  */
275 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
276     $options = (array)$options;
277     if (!isset($options['subdirs'])) {
278         $options['subdirs'] = false;
279     }
280     if (!isset($options['maxfiles'])) {
281         $options['maxfiles'] = -1; // unlimited
282     }
283     if (!isset($options['maxbytes'])) {
284         $options['maxbytes'] = 0; // unlimited
285     }
287     if (empty($data->{$field.'_filemanager'})) {
288         $data->$field = '';
290     } else {
291         file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id, $component, $filearea, $itemid, $options);
292         $fs = get_file_storage();
294         if ($fs->get_area_files($context->id, $component, $filearea, $itemid)) {
295             $data->$field = '1'; // TODO: this is an ugly hack (skodak)
296         } else {
297             $data->$field = '';
298         }
299     }
301     return $data;
304 /**
305  * Generate a draft itemid
306  *
307  * @category files
308  * @global moodle_database $DB
309  * @global stdClass $USER
310  * @return int a random but available draft itemid that can be used to create a new draft
311  * file area.
312  */
313 function file_get_unused_draft_itemid() {
314     global $DB, $USER;
316     if (isguestuser() or !isloggedin()) {
317         // guests and not-logged-in users can not be allowed to upload anything!!!!!!
318         print_error('noguest');
319     }
321     $contextid = get_context_instance(CONTEXT_USER, $USER->id)->id;
323     $fs = get_file_storage();
324     $draftitemid = rand(1, 999999999);
325     while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
326         $draftitemid = rand(1, 999999999);
327     }
329     return $draftitemid;
332 /**
333  * Initialise a draft file area from a real one by copying the files. A draft
334  * area will be created if one does not already exist. Normally you should
335  * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
336  *
337  * @category files
338  * @global stdClass $CFG
339  * @global stdClass $USER
340  * @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.
341  * @param int $contextid This parameter and the next two identify the file area to copy files from.
342  * @param string $component
343  * @param string $filearea helps indentify the file area.
344  * @param int $itemid helps identify the file area. Can be null if there are no files yet.
345  * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
346  * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
347  * @return string|null returns string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
348  */
349 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
350     global $CFG, $USER, $CFG;
352     $options = (array)$options;
353     if (!isset($options['subdirs'])) {
354         $options['subdirs'] = false;
355     }
356     if (!isset($options['forcehttps'])) {
357         $options['forcehttps'] = false;
358     }
360     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
361     $fs = get_file_storage();
363     if (empty($draftitemid)) {
364         // create a new area and copy existing files into
365         $draftitemid = file_get_unused_draft_itemid();
366         $file_record = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
367         if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
368             foreach ($files as $file) {
369                 if ($file->is_directory() and $file->get_filepath() === '/') {
370                     // we need a way to mark the age of each draft area,
371                     // by not copying the root dir we force it to be created automatically with current timestamp
372                     continue;
373                 }
374                 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
375                     continue;
376                 }
377                 $fs->create_file_from_storedfile($file_record, $file);
378             }
379         }
380         if (!is_null($text)) {
381             // at this point there should not be any draftfile links yet,
382             // because this is a new text from database that should still contain the @@pluginfile@@ links
383             // this happens when developers forget to post process the text
384             $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
385         }
386     } else {
387         // nothing to do
388     }
390     if (is_null($text)) {
391         return null;
392     }
394     // relink embedded files - editor can not handle @@PLUGINFILE@@ !
395     return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id, 'user', 'draft', $draftitemid, $options);
398 /**
399  * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
400  *
401  * @category files
402  * @global stdClass $CFG
403  * @param string $text The content that may contain ULRs in need of rewriting.
404  * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
405  * @param int $contextid This parameter and the next two identify the file area to use.
406  * @param string $component
407  * @param string $filearea helps identify the file area.
408  * @param int $itemid helps identify the file area.
409  * @param array $options text and file options ('forcehttps'=>false)
410  * @return string the processed text.
411  */
412 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
413     global $CFG;
415     $options = (array)$options;
416     if (!isset($options['forcehttps'])) {
417         $options['forcehttps'] = false;
418     }
420     if (!$CFG->slasharguments) {
421         $file = $file . '?file=';
422     }
424     $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
426     if ($itemid !== null) {
427         $baseurl .= "$itemid/";
428     }
430     if ($options['forcehttps']) {
431         $baseurl = str_replace('http://', 'https://', $baseurl);
432     }
434     return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
437 /**
438  * Returns information about files in a draft area.
439  *
440  * @global stdClass $CFG
441  * @global stdClass $USER
442  * @param int $draftitemid the draft area item id.
443  * @return array with the following entries:
444  *      'filecount' => number of files in the draft area.
445  * (more information will be added as needed).
446  */
447 function file_get_draft_area_info($draftitemid) {
448     global $CFG, $USER;
450     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
451     $fs = get_file_storage();
453     $results = array();
455     // The number of files
456     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id', false);
457     $results['filecount'] = count($draftfiles);
458     $results['filesize'] = 0;
459     foreach ($draftfiles as $file) {
460         $results['filesize'] += $file->get_filesize();
461     }
463     return $results;
466 /**
467  * Get used space of files
468  * @global moodle_database $DB
469  * @global stdClass $USER
470  * @return int total bytes
471  */
472 function file_get_user_used_space() {
473     global $DB, $USER;
475     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
476     $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
477             JOIN (SELECT contenthash, filename, MAX(id) AS id
478             FROM {files}
479             WHERE contextid = ? AND component = ? AND filearea != ?
480             GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
481     $params = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft');
482     $record = $DB->get_record_sql($sql, $params);
483     return (int)$record->totalbytes;
486 /**
487  * Convert any string to a valid filepath
488  * @todo review this function
489  * @param string $str
490  * @return string path
491  */
492 function file_correct_filepath($str) { //TODO: what is this? (skodak)
493     if ($str == '/' or empty($str)) {
494         return '/';
495     } else {
496         return '/'.trim($str, './@#$ ').'/';
497     }
500 /**
501  * Generate a folder tree of draft area of current USER recursively
502  *
503  * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
504  * @param int $draftitemid
505  * @param string $filepath
506  * @param mixed $data
507  */
508 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
509     global $USER, $OUTPUT, $CFG;
510     $data->children = array();
511     $context = get_context_instance(CONTEXT_USER, $USER->id);
512     $fs = get_file_storage();
513     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
514         foreach ($files as $file) {
515             if ($file->is_directory()) {
516                 $item = new stdClass();
517                 $item->sortorder = $file->get_sortorder();
518                 $item->filepath = $file->get_filepath();
520                 $foldername = explode('/', trim($item->filepath, '/'));
521                 $item->fullname = trim(array_pop($foldername), '/');
523                 $item->id = uniqid();
524                 file_get_drafarea_folders($draftitemid, $item->filepath, $item);
525                 $data->children[] = $item;
526             } else {
527                 continue;
528             }
529         }
530     }
533 /**
534  * Listing all files (including folders) in current path (draft area)
535  * used by file manager
536  * @param int $draftitemid
537  * @param string $filepath
538  * @return stdClass
539  */
540 function file_get_drafarea_files($draftitemid, $filepath = '/') {
541     global $USER, $OUTPUT, $CFG;
543     $context = get_context_instance(CONTEXT_USER, $USER->id);
544     $fs = get_file_storage();
546     $data = new stdClass();
547     $data->path = array();
548     $data->path[] = array('name'=>get_string('files'), 'path'=>'/');
550     // will be used to build breadcrumb
551     $trail = '';
552     if ($filepath !== '/') {
553         $filepath = file_correct_filepath($filepath);
554         $parts = explode('/', $filepath);
555         foreach ($parts as $part) {
556             if ($part != '' && $part != null) {
557                 $trail .= ('/'.$part.'/');
558                 $data->path[] = array('name'=>$part, 'path'=>$trail);
559             }
560         }
561     }
563     $list = array();
564     $maxlength = 12;
565     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
566         foreach ($files as $file) {
567             $item = new stdClass();
568             $item->filename = $file->get_filename();
569             $item->filepath = $file->get_filepath();
570             $item->fullname = trim($item->filename, '/');
571             $filesize = $file->get_filesize();
572             $item->filesize = $filesize ? display_size($filesize) : '';
574             $icon = mimeinfo_from_type('icon', $file->get_mimetype());
575             $item->icon = $OUTPUT->pix_url('f/' . $icon)->out();
576             $item->sortorder = $file->get_sortorder();
578             if ($icon == 'zip') {
579                 $item->type = 'zip';
580             } else {
581                 $item->type = 'file';
582             }
584             if ($file->is_directory()) {
585                 $item->filesize = 0;
586                 $item->icon = $OUTPUT->pix_url('f/folder')->out();
587                 $item->type = 'folder';
588                 $foldername = explode('/', trim($item->filepath, '/'));
589                 $item->fullname = trim(array_pop($foldername), '/');
590             } else {
591                 // do NOT use file browser here!
592                 $item->url = moodle_url::make_draftfile_url($draftitemid, $item->filepath, $item->filename)->out();
593             }
594             $list[] = $item;
595         }
596     }
597     $data->itemid = $draftitemid;
598     $data->list = $list;
599     return $data;
602 /**
603  * Returns draft area itemid for a given element.
604  *
605  * @category files
606  * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
607  * @return int the itemid, or 0 if there is not one yet.
608  */
609 function file_get_submitted_draft_itemid($elname) {
610     // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
611     if (!isset($_REQUEST[$elname])) {
612         return 0;
613     }
614     if (is_array($_REQUEST[$elname])) {
615         $param = optional_param_array($elname, 0, PARAM_INT);
616         if (!empty($param['itemid'])) {
617             $param = $param['itemid'];
618         } else {
619             debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER);
620             return false;
621         }
623     } else {
624         $param = optional_param($elname, 0, PARAM_INT);
625     }
627     if ($param) {
628         require_sesskey();
629     }
631     return $param;
634 /**
635  * Saves files from a draft file area to a real one (merging the list of files).
636  * Can rewrite URLs in some content at the same time if desired.
637  *
638  * @category files
639  * @global stdClass $USER
640  * @param int $draftitemid the id of the draft area to use. Normally obtained
641  *      from file_get_submitted_draft_itemid('elementname') or similar.
642  * @param int $contextid This parameter and the next two identify the file area to save to.
643  * @param string $component
644  * @param string $filearea indentifies the file area.
645  * @param int $itemid helps identifies the file area.
646  * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
647  * @param string $text some html content that needs to have embedded links rewritten
648  *      to the @@PLUGINFILE@@ form for saving in the database.
649  * @param bool $forcehttps force https urls.
650  * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
651  */
652 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
653     global $USER;
655     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
656     $fs = get_file_storage();
658     $options = (array)$options;
659     if (!isset($options['subdirs'])) {
660         $options['subdirs'] = false;
661     }
662     if (!isset($options['maxfiles'])) {
663         $options['maxfiles'] = -1; // unlimited
664     }
665     if (!isset($options['maxbytes'])) {
666         $options['maxbytes'] = 0; // unlimited
667     }
669     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
670     $oldfiles   = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
672     if (count($draftfiles) < 2) {
673         // means there are no files - one file means root dir only ;-)
674         $fs->delete_area_files($contextid, $component, $filearea, $itemid);
676     } else if (count($oldfiles) < 2) {
677         $filecount = 0;
678         // there were no files before - one file means root dir only ;-)
679         $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
680         foreach ($draftfiles as $file) {
681             if (!$options['subdirs']) {
682                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
683                     continue;
684                 }
685             }
686             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
687                 // oversized file - should not get here at all
688                 continue;
689             }
690             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
691                 // more files - should not get here at all
692                 break;
693             }
694             if (!$file->is_directory()) {
695                 $filecount++;
696             }
697             $fs->create_file_from_storedfile($file_record, $file);
698         }
700     } else {
701         // we have to merge old and new files - we want to keep file ids for files that were not changed
702         // we change time modified for all new and changed files, we keep time created as is
703         $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
705         $newhashes = array();
706         foreach ($draftfiles as $file) {
707             $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
708             $newhashes[$newhash] = $file;
709         }
710         $filecount = 0;
711         foreach ($oldfiles as $oldfile) {
712             $oldhash = $oldfile->get_pathnamehash();
713             if (!isset($newhashes[$oldhash])) {
714                 // delete files not needed any more - deleted by user
715                 $oldfile->delete();
716                 continue;
717             }
718             $newfile = $newhashes[$oldhash];
719             if ($oldfile->get_contenthash() != $newfile->get_contenthash() or $oldfile->get_sortorder() != $newfile->get_sortorder()
720                 or $oldfile->get_status() != $newfile->get_status() or $oldfile->get_license() != $newfile->get_license()
721                 or $oldfile->get_author() != $newfile->get_author() or $oldfile->get_source() != $newfile->get_source()) {
722                 // file was changed, use updated with new timemodified data
723                 $oldfile->delete();
724                 continue;
725             }
726             // unchanged file or directory - we keep it as is
727             unset($newhashes[$oldhash]);
728             if (!$oldfile->is_directory()) {
729                 $filecount++;
730             }
731         }
733         // now add new/changed files
734         // the size and subdirectory tests are extra safety only, the UI should prevent it
735         foreach ($newhashes as $file) {
736             if (!$options['subdirs']) {
737                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
738                     continue;
739                 }
740             }
741             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
742                 // oversized file - should not get here at all
743                 continue;
744             }
745             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
746                 // more files - should not get here at all
747                 break;
748             }
749             if (!$file->is_directory()) {
750                 $filecount++;
751             }
752             $fs->create_file_from_storedfile($file_record, $file);
753         }
754     }
756     // note: do not purge the draft area - we clean up areas later in cron,
757     //       the reason is that user might press submit twice and they would loose the files,
758     //       also sometimes we might want to use hacks that save files into two different areas
760     if (is_null($text)) {
761         return null;
762     } else {
763         return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
764     }
767 /**
768  * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
769  * ready to be saved in the database. Normally, this is done automatically by
770  * {@link file_save_draft_area_files()}.
771  *
772  * @category files
773  * @param string $text the content to process.
774  * @param int $draftitemid the draft file area the content was using.
775  * @param bool $forcehttps whether the content contains https URLs. Default false.
776  * @return string the processed content.
777  */
778 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
779     global $CFG, $USER;
781     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
783     $wwwroot = $CFG->wwwroot;
784     if ($forcehttps) {
785         $wwwroot = str_replace('http://', 'https://', $wwwroot);
786     }
788     // relink embedded files if text submitted - no absolute links allowed in database!
789     $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
791     if (strpos($text, 'draftfile.php?file=') !== false) {
792         $matches = array();
793         preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
794         if ($matches) {
795             foreach ($matches[0] as $match) {
796                 $replace = str_ireplace('%2F', '/', $match);
797                 $text = str_replace($match, $replace, $text);
798             }
799         }
800         $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
801     }
803     return $text;
806 /**
807  * Set file sort order
808  *
809  * @global moodle_database $DB
810  * @param int $contextid the context id
811  * @param string $component file component
812  * @param string $filearea file area.
813  * @param int $itemid itemid.
814  * @param string $filepath file path.
815  * @param string $filename file name.
816  * @param int $sortorder the sort order of file.
817  * @return bool
818  */
819 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
820     global $DB;
821     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
822     if ($file_record = $DB->get_record('files', $conditions)) {
823         $sortorder = (int)$sortorder;
824         $file_record->sortorder = $sortorder;
825         $DB->update_record('files', $file_record);
826         return true;
827     }
828     return false;
831 /**
832  * reset file sort order number to 0
833  * @global moodle_database $DB
834  * @param int $contextid the context id
835  * @param string $component
836  * @param string $filearea file area.
837  * @param int|bool $itemid itemid.
838  * @return bool
839  */
840 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
841     global $DB;
843     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
844     if ($itemid !== false) {
845         $conditions['itemid'] = $itemid;
846     }
848     $file_records = $DB->get_records('files', $conditions);
849     foreach ($file_records as $file_record) {
850         $file_record->sortorder = 0;
851         $DB->update_record('files', $file_record);
852     }
853     return true;
856 /**
857  * Returns description of upload error
858  *
859  * @param int $errorcode found in $_FILES['filename.ext']['error']
860  * @return string error description string, '' if ok
861  */
862 function file_get_upload_error($errorcode) {
864     switch ($errorcode) {
865     case 0: // UPLOAD_ERR_OK - no error
866         $errmessage = '';
867         break;
869     case 1: // UPLOAD_ERR_INI_SIZE
870         $errmessage = get_string('uploadserverlimit');
871         break;
873     case 2: // UPLOAD_ERR_FORM_SIZE
874         $errmessage = get_string('uploadformlimit');
875         break;
877     case 3: // UPLOAD_ERR_PARTIAL
878         $errmessage = get_string('uploadpartialfile');
879         break;
881     case 4: // UPLOAD_ERR_NO_FILE
882         $errmessage = get_string('uploadnofilefound');
883         break;
885     // Note: there is no error with a value of 5
887     case 6: // UPLOAD_ERR_NO_TMP_DIR
888         $errmessage = get_string('uploadnotempdir');
889         break;
891     case 7: // UPLOAD_ERR_CANT_WRITE
892         $errmessage = get_string('uploadcantwrite');
893         break;
895     case 8: // UPLOAD_ERR_EXTENSION
896         $errmessage = get_string('uploadextension');
897         break;
899     default:
900         $errmessage = get_string('uploadproblem');
901     }
903     return $errmessage;
906 /**
907  * Recursive function formating an array in POST parameter
908  * @param array $arraydata - the array that we are going to format and add into &$data array
909  * @param string $currentdata - a row of the final postdata array at instant T
910  *                when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
911  * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
912  */
913 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
914         foreach ($arraydata as $k=>$v) {
915             $newcurrentdata = $currentdata;
916             if (is_array($v)) { //the value is an array, call the function recursively
917                 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
918                 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
919             }  else { //add the POST parameter to the $data array
920                 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
921             }
922         }
925 /**
926  * Transform a PHP array into POST parameter
927  * (see the recursive function format_array_postdata_for_curlcall)
928  * @param array $postdata
929  * @return array containing all POST parameters  (1 row = 1 POST parameter)
930  */
931 function format_postdata_for_curlcall($postdata) {
932         $data = array();
933         foreach ($postdata as $k=>$v) {
934             if (is_array($v)) {
935                 $currentdata = urlencode($k);
936                 format_array_postdata_for_curlcall($v, $currentdata, $data);
937             }  else {
938                 $data[] = urlencode($k).'='.urlencode($v);
939             }
940         }
941         $convertedpostdata = implode('&', $data);
942         return $convertedpostdata;
945 /**
946  * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
947  * Due to security concerns only downloads from http(s) sources are supported.
948  *
949  * @todo MDL-31073 add version test for '7.10.5'
950  * @category files
951  * @param string $url file url starting with http(s)://
952  * @param array $headers http headers, null if none. If set, should be an
953  *   associative array of header name => value pairs.
954  * @param array $postdata array means use POST request with given parameters
955  * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
956  *   (if false, just returns content)
957  * @param int $timeout timeout for complete download process including all file transfer
958  *   (default 5 minutes)
959  * @param int $connecttimeout timeout for connection to server; this is the timeout that
960  *   usually happens if the remote server is completely down (default 20 seconds);
961  *   may not work when using proxy
962  * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
963  *   Only use this when already in a trusted location.
964  * @param string $tofile store the downloaded content to file instead of returning it.
965  * @param bool $calctimeout false by default, true enables an extra head request to try and determine
966  *   filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
967  * @return mixed false if request failed or content of the file as string if ok. True if file downloaded into $tofile successfully.
968  */
969 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
970     global $CFG;
972     // some extra security
973     $newlines = array("\r", "\n");
974     if (is_array($headers) ) {
975         foreach ($headers as $key => $value) {
976             $headers[$key] = str_replace($newlines, '', $value);
977         }
978     }
979     $url = str_replace($newlines, '', $url);
980     if (!preg_match('|^https?://|i', $url)) {
981         if ($fullresponse) {
982             $response = new stdClass();
983             $response->status        = 0;
984             $response->headers       = array();
985             $response->response_code = 'Invalid protocol specified in url';
986             $response->results       = '';
987             $response->error         = 'Invalid protocol specified in url';
988             return $response;
989         } else {
990             return false;
991         }
992     }
994     // check if proxy (if used) should be bypassed for this url
995     $proxybypass = is_proxybypass($url);
997     if (!$ch = curl_init($url)) {
998         debugging('Can not init curl.');
999         return false;
1000     }
1002     // set extra headers
1003     if (is_array($headers) ) {
1004         $headers2 = array();
1005         foreach ($headers as $key => $value) {
1006             $headers2[] = "$key: $value";
1007         }
1008         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers2);
1009     }
1011     if ($skipcertverify) {
1012         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
1013     }
1015     // use POST if requested
1016     if (is_array($postdata)) {
1017         $postdata = format_postdata_for_curlcall($postdata);
1018         curl_setopt($ch, CURLOPT_POST, true);
1019         curl_setopt($ch, CURLOPT_POSTFIELDS, $postdata);
1020     }
1022     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
1023     curl_setopt($ch, CURLOPT_HEADER, false);
1024     curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connecttimeout);
1026     if (!ini_get('open_basedir') and !ini_get('safe_mode')) {
1027         // TODO: add version test for '7.10.5'
1028         curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
1029         curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
1030     }
1032     if (!empty($CFG->proxyhost) and !$proxybypass) {
1033         // SOCKS supported in PHP5 only
1034         if (!empty($CFG->proxytype) and ($CFG->proxytype == 'SOCKS5')) {
1035             if (defined('CURLPROXY_SOCKS5')) {
1036                 curl_setopt($ch, CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
1037             } else {
1038                 curl_close($ch);
1039                 if ($fullresponse) {
1040                     $response = new stdClass();
1041                     $response->status        = '0';
1042                     $response->headers       = array();
1043                     $response->response_code = 'SOCKS5 proxy is not supported in PHP4';
1044                     $response->results       = '';
1045                     $response->error         = 'SOCKS5 proxy is not supported in PHP4';
1046                     return $response;
1047                 } else {
1048                     debugging("SOCKS5 proxy is not supported in PHP4.", DEBUG_ALL);
1049                     return false;
1050                 }
1051             }
1052         }
1054         curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, false);
1056         if (empty($CFG->proxyport)) {
1057             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost);
1058         } else {
1059             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost.':'.$CFG->proxyport);
1060         }
1062         if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
1063             curl_setopt($ch, CURLOPT_PROXYUSERPWD, $CFG->proxyuser.':'.$CFG->proxypassword);
1064             if (defined('CURLOPT_PROXYAUTH')) {
1065                 // any proxy authentication if PHP 5.1
1066                 curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_BASIC | CURLAUTH_NTLM);
1067             }
1068         }
1069     }
1071     // set up header and content handlers
1072     $received = new stdClass();
1073     $received->headers = array(); // received headers array
1074     $received->tofile  = $tofile;
1075     $received->fh      = null;
1076     curl_setopt($ch, CURLOPT_HEADERFUNCTION, partial('download_file_content_header_handler', $received));
1077     if ($tofile) {
1078         curl_setopt($ch, CURLOPT_WRITEFUNCTION, partial('download_file_content_write_handler', $received));
1079     }
1081     if (!isset($CFG->curltimeoutkbitrate)) {
1082         //use very slow rate of 56kbps as a timeout speed when not set
1083         $bitrate = 56;
1084     } else {
1085         $bitrate = $CFG->curltimeoutkbitrate;
1086     }
1088     // try to calculate the proper amount for timeout from remote file size.
1089     // if disabled or zero, we won't do any checks nor head requests.
1090     if ($calctimeout && $bitrate > 0) {
1091         //setup header request only options
1092         curl_setopt_array ($ch, array(
1093             CURLOPT_RETURNTRANSFER => false,
1094             CURLOPT_NOBODY         => true)
1095         );
1097         curl_exec($ch);
1098         $info = curl_getinfo($ch);
1099         $err = curl_error($ch);
1101         if ($err === '' && $info['download_content_length'] > 0) { //no curl errors
1102             $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024))); //adjust for large files only - take max timeout.
1103         }
1104         //reinstate affected curl options
1105         curl_setopt_array ($ch, array(
1106             CURLOPT_RETURNTRANSFER => true,
1107             CURLOPT_NOBODY         => false)
1108         );
1109     }
1111     curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
1112     $result = curl_exec($ch);
1114     // try to detect encoding problems
1115     if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1116         curl_setopt($ch, CURLOPT_ENCODING, 'none');
1117         $result = curl_exec($ch);
1118     }
1120     if ($received->fh) {
1121         fclose($received->fh);
1122     }
1124     if (curl_errno($ch)) {
1125         $error    = curl_error($ch);
1126         $error_no = curl_errno($ch);
1127         curl_close($ch);
1129         if ($fullresponse) {
1130             $response = new stdClass();
1131             if ($error_no == 28) {
1132                 $response->status    = '-100'; // mimic snoopy
1133             } else {
1134                 $response->status    = '0';
1135             }
1136             $response->headers       = array();
1137             $response->response_code = $error;
1138             $response->results       = false;
1139             $response->error         = $error;
1140             return $response;
1141         } else {
1142             debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL);
1143             return false;
1144         }
1146     } else {
1147         $info = curl_getinfo($ch);
1148         curl_close($ch);
1150         if (empty($info['http_code'])) {
1151             // for security reasons we support only true http connections (Location: file:// exploit prevention)
1152             $response = new stdClass();
1153             $response->status        = '0';
1154             $response->headers       = array();
1155             $response->response_code = 'Unknown cURL error';
1156             $response->results       = false; // do NOT change this, we really want to ignore the result!
1157             $response->error         = 'Unknown cURL error';
1159         } else {
1160             $response = new stdClass();;
1161             $response->status        = (string)$info['http_code'];
1162             $response->headers       = $received->headers;
1163             $response->response_code = $received->headers[0];
1164             $response->results       = $result;
1165             $response->error         = '';
1166         }
1168         if ($fullresponse) {
1169             return $response;
1170         } else if ($info['http_code'] != 200) {
1171             debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code, DEBUG_ALL);
1172             return false;
1173         } else {
1174             return $response->results;
1175         }
1176     }
1179 /**
1180  * internal implementation
1181  * @param stdClass $received
1182  * @param resource $ch
1183  * @param mixed $header
1184  * @return int header length
1185  */
1186 function download_file_content_header_handler($received, $ch, $header) {
1187     $received->headers[] = $header;
1188     return strlen($header);
1191 /**
1192  * internal implementation
1193  * @param stdClass $received
1194  * @param resource $ch
1195  * @param mixed $data
1196  */
1197 function download_file_content_write_handler($received, $ch, $data) {
1198     if (!$received->fh) {
1199         $received->fh = fopen($received->tofile, 'w');
1200         if ($received->fh === false) {
1201             // bad luck, file creation or overriding failed
1202             return 0;
1203         }
1204     }
1205     if (fwrite($received->fh, $data) === false) {
1206         // bad luck, write failed, let's abort completely
1207         return 0;
1208     }
1209     return strlen($data);
1212 /**
1213  * Returns a list of information about file t ypes based on extensions
1214  *
1215  * @category files
1216  * @return array List of information about file types based on extensions.
1217  *   Associative array of extension (lower-case) to associative array
1218  *   from 'element name' to data. Current element names are 'type' and 'icon'.
1219  *   Unknown types should use the 'xxx' entry which includes defaults.
1220  */
1221 function get_mimetypes_array() {
1222     static $mimearray = array (
1223         'xxx'  => array ('type'=>'document/unknown', 'icon'=>'unknown'),
1224         '3gp'  => array ('type'=>'video/quicktime', 'icon'=>'video'),
1225         'aac'  => array ('type'=>'audio/aac', 'icon'=>'audio'),
1226         'ai'   => array ('type'=>'application/postscript', 'icon'=>'image'),
1227         'aif'  => array ('type'=>'audio/x-aiff', 'icon'=>'audio'),
1228         'aiff' => array ('type'=>'audio/x-aiff', 'icon'=>'audio'),
1229         'aifc' => array ('type'=>'audio/x-aiff', 'icon'=>'audio'),
1230         'applescript'  => array ('type'=>'text/plain', 'icon'=>'text'),
1231         'asc'  => array ('type'=>'text/plain', 'icon'=>'text'),
1232         'asm'  => array ('type'=>'text/plain', 'icon'=>'text'),
1233         'au'   => array ('type'=>'audio/au', 'icon'=>'audio'),
1234         'avi'  => array ('type'=>'video/x-ms-wm', 'icon'=>'avi'),
1235         'bmp'  => array ('type'=>'image/bmp', 'icon'=>'image'),
1236         'c'    => array ('type'=>'text/plain', 'icon'=>'text'),
1237         'cct'  => array ('type'=>'shockwave/director', 'icon'=>'flash'),
1238         'cpp'  => array ('type'=>'text/plain', 'icon'=>'text'),
1239         'cs'   => array ('type'=>'application/x-csh', 'icon'=>'text'),
1240         'css'  => array ('type'=>'text/css', 'icon'=>'text'),
1241         'csv'  => array ('type'=>'text/csv', 'icon'=>'excel'),
1242         'dv'   => array ('type'=>'video/x-dv', 'icon'=>'video'),
1243         'dmg'  => array ('type'=>'application/octet-stream', 'icon'=>'dmg'),
1245         'doc'  => array ('type'=>'application/msword', 'icon'=>'word'),
1246         'docx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'icon'=>'docx'),
1247         'docm' => array ('type'=>'application/vnd.ms-word.document.macroEnabled.12', 'icon'=>'docm'),
1248         'dotx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 'icon'=>'dotx'),
1249         'dotm' => array ('type'=>'application/vnd.ms-word.template.macroEnabled.12', 'icon'=>'dotm'),
1251         'dcr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1252         'dif'  => array ('type'=>'video/x-dv', 'icon'=>'video'),
1253         'dir'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1254         'dxr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1255         'eps'  => array ('type'=>'application/postscript', 'icon'=>'pdf'),
1256         'fdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1257         'flv'  => array ('type'=>'video/x-flv', 'icon'=>'video'),
1258         'f4v'  => array ('type'=>'video/mp4', 'icon'=>'video'),
1259         'gif'  => array ('type'=>'image/gif', 'icon'=>'image'),
1260         'gtar' => array ('type'=>'application/x-gtar', 'icon'=>'zip'),
1261         'tgz'  => array ('type'=>'application/g-zip', 'icon'=>'zip'),
1262         'gz'   => array ('type'=>'application/g-zip', 'icon'=>'zip'),
1263         'gzip' => array ('type'=>'application/g-zip', 'icon'=>'zip'),
1264         'h'    => array ('type'=>'text/plain', 'icon'=>'text'),
1265         'hpp'  => array ('type'=>'text/plain', 'icon'=>'text'),
1266         'hqx'  => array ('type'=>'application/mac-binhex40', 'icon'=>'zip'),
1267         'htc'  => array ('type'=>'text/x-component', 'icon'=>'text'),
1268         'html' => array ('type'=>'text/html', 'icon'=>'html'),
1269         'xhtml'=> array ('type'=>'application/xhtml+xml', 'icon'=>'html'),
1270         'htm'  => array ('type'=>'text/html', 'icon'=>'html'),
1271         'ico'  => array ('type'=>'image/vnd.microsoft.icon', 'icon'=>'image'),
1272         'ics'  => array ('type'=>'text/calendar', 'icon'=>'text'),
1273         'isf'  => array ('type'=>'application/inspiration', 'icon'=>'isf'),
1274         'ist'  => array ('type'=>'application/inspiration.template', 'icon'=>'isf'),
1275         'java' => array ('type'=>'text/plain', 'icon'=>'text'),
1276         'jcb'  => array ('type'=>'text/xml', 'icon'=>'jcb'),
1277         'jcl'  => array ('type'=>'text/xml', 'icon'=>'jcl'),
1278         'jcw'  => array ('type'=>'text/xml', 'icon'=>'jcw'),
1279         'jmt'  => array ('type'=>'text/xml', 'icon'=>'jmt'),
1280         'jmx'  => array ('type'=>'text/xml', 'icon'=>'jmx'),
1281         'jpe'  => array ('type'=>'image/jpeg', 'icon'=>'image'),
1282         'jpeg' => array ('type'=>'image/jpeg', 'icon'=>'image'),
1283         'jpg'  => array ('type'=>'image/jpeg', 'icon'=>'image'),
1284         'jqz'  => array ('type'=>'text/xml', 'icon'=>'jqz'),
1285         'js'   => array ('type'=>'application/x-javascript', 'icon'=>'text'),
1286         'latex'=> array ('type'=>'application/x-latex', 'icon'=>'text'),
1287         'm'    => array ('type'=>'text/plain', 'icon'=>'text'),
1288         'mbz'  => array ('type'=>'application/vnd.moodle.backup', 'icon'=>'moodle'),
1289         'mov'  => array ('type'=>'video/quicktime', 'icon'=>'video'),
1290         'movie'=> array ('type'=>'video/x-sgi-movie', 'icon'=>'video'),
1291         'm3u'  => array ('type'=>'audio/x-mpegurl', 'icon'=>'audio'),
1292         'mp3'  => array ('type'=>'audio/mp3', 'icon'=>'audio'),
1293         'mp4'  => array ('type'=>'video/mp4', 'icon'=>'video'),
1294         'm4v'  => array ('type'=>'video/mp4', 'icon'=>'video'),
1295         'm4a'  => array ('type'=>'audio/mp4', 'icon'=>'audio'),
1296         'mpeg' => array ('type'=>'video/mpeg', 'icon'=>'video'),
1297         'mpe'  => array ('type'=>'video/mpeg', 'icon'=>'video'),
1298         'mpg'  => array ('type'=>'video/mpeg', 'icon'=>'video'),
1300         'odt'  => array ('type'=>'application/vnd.oasis.opendocument.text', 'icon'=>'odt'),
1301         'ott'  => array ('type'=>'application/vnd.oasis.opendocument.text-template', 'icon'=>'odt'),
1302         'oth'  => array ('type'=>'application/vnd.oasis.opendocument.text-web', 'icon'=>'odt'),
1303         'odm'  => array ('type'=>'application/vnd.oasis.opendocument.text-master', 'icon'=>'odm'),
1304         'odg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics', 'icon'=>'odg'),
1305         'otg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics-template', 'icon'=>'odg'),
1306         'odp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation', 'icon'=>'odp'),
1307         'otp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation-template', 'icon'=>'odp'),
1308         'ods'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet', 'icon'=>'ods'),
1309         'ots'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet-template', 'icon'=>'ods'),
1310         'odc'  => array ('type'=>'application/vnd.oasis.opendocument.chart', 'icon'=>'odc'),
1311         'odf'  => array ('type'=>'application/vnd.oasis.opendocument.formula', 'icon'=>'odf'),
1312         'odb'  => array ('type'=>'application/vnd.oasis.opendocument.database', 'icon'=>'odb'),
1313         'odi'  => array ('type'=>'application/vnd.oasis.opendocument.image', 'icon'=>'odi'),
1314         'oga'  => array ('type'=>'audio/ogg', 'icon'=>'audio'),
1315         'ogg'  => array ('type'=>'audio/ogg', 'icon'=>'audio'),
1316         'ogv'  => array ('type'=>'video/ogg', 'icon'=>'video'),
1318         'pct'  => array ('type'=>'image/pict', 'icon'=>'image'),
1319         'pdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1320         'php'  => array ('type'=>'text/plain', 'icon'=>'text'),
1321         'pic'  => array ('type'=>'image/pict', 'icon'=>'image'),
1322         'pict' => array ('type'=>'image/pict', 'icon'=>'image'),
1323         'png'  => array ('type'=>'image/png', 'icon'=>'image'),
1325         'pps'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint'),
1326         'ppt'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint'),
1327         'pptx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'icon'=>'pptx'),
1328         'pptm' => array ('type'=>'application/vnd.ms-powerpoint.presentation.macroEnabled.12', 'icon'=>'pptm'),
1329         'potx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.template', 'icon'=>'potx'),
1330         'potm' => array ('type'=>'application/vnd.ms-powerpoint.template.macroEnabled.12', 'icon'=>'potm'),
1331         'ppam' => array ('type'=>'application/vnd.ms-powerpoint.addin.macroEnabled.12', 'icon'=>'ppam'),
1332         'ppsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 'icon'=>'ppsx'),
1333         'ppsm' => array ('type'=>'application/vnd.ms-powerpoint.slideshow.macroEnabled.12', 'icon'=>'ppsm'),
1335         'ps'   => array ('type'=>'application/postscript', 'icon'=>'pdf'),
1336         'qt'   => array ('type'=>'video/quicktime', 'icon'=>'video'),
1337         'ra'   => array ('type'=>'audio/x-realaudio-plugin', 'icon'=>'audio'),
1338         'ram'  => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio'),
1339         'rhb'  => array ('type'=>'text/xml', 'icon'=>'xml'),
1340         'rm'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio'),
1341         'rmvb' => array ('type'=>'application/vnd.rn-realmedia-vbr', 'icon'=>'video'),
1342         'rtf'  => array ('type'=>'text/rtf', 'icon'=>'text'),
1343         'rtx'  => array ('type'=>'text/richtext', 'icon'=>'text'),
1344         'rv'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'video'),
1345         'sh'   => array ('type'=>'application/x-sh', 'icon'=>'text'),
1346         'sit'  => array ('type'=>'application/x-stuffit', 'icon'=>'zip'),
1347         'smi'  => array ('type'=>'application/smil', 'icon'=>'text'),
1348         'smil' => array ('type'=>'application/smil', 'icon'=>'text'),
1349         'sqt'  => array ('type'=>'text/xml', 'icon'=>'xml'),
1350         'svg'  => array ('type'=>'image/svg+xml', 'icon'=>'image'),
1351         'svgz' => array ('type'=>'image/svg+xml', 'icon'=>'image'),
1352         'swa'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1353         'swf'  => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash'),
1354         'swfl' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash'),
1356         'sxw'  => array ('type'=>'application/vnd.sun.xml.writer', 'icon'=>'odt'),
1357         'stw'  => array ('type'=>'application/vnd.sun.xml.writer.template', 'icon'=>'odt'),
1358         'sxc'  => array ('type'=>'application/vnd.sun.xml.calc', 'icon'=>'odt'),
1359         'stc'  => array ('type'=>'application/vnd.sun.xml.calc.template', 'icon'=>'odt'),
1360         'sxd'  => array ('type'=>'application/vnd.sun.xml.draw', 'icon'=>'odt'),
1361         'std'  => array ('type'=>'application/vnd.sun.xml.draw.template', 'icon'=>'odt'),
1362         'sxi'  => array ('type'=>'application/vnd.sun.xml.impress', 'icon'=>'odt'),
1363         'sti'  => array ('type'=>'application/vnd.sun.xml.impress.template', 'icon'=>'odt'),
1364         'sxg'  => array ('type'=>'application/vnd.sun.xml.writer.global', 'icon'=>'odt'),
1365         'sxm'  => array ('type'=>'application/vnd.sun.xml.math', 'icon'=>'odt'),
1367         'tar'  => array ('type'=>'application/x-tar', 'icon'=>'zip'),
1368         'tif'  => array ('type'=>'image/tiff', 'icon'=>'image'),
1369         'tiff' => array ('type'=>'image/tiff', 'icon'=>'image'),
1370         'tex'  => array ('type'=>'application/x-tex', 'icon'=>'text'),
1371         'texi' => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1372         'texinfo'  => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1373         'tsv'  => array ('type'=>'text/tab-separated-values', 'icon'=>'text'),
1374         'txt'  => array ('type'=>'text/plain', 'icon'=>'text'),
1375         'wav'  => array ('type'=>'audio/wav', 'icon'=>'audio'),
1376         'webm'  => array ('type'=>'video/webm', 'icon'=>'video'),
1377         'wmv'  => array ('type'=>'video/x-ms-wmv', 'icon'=>'avi'),
1378         'asf'  => array ('type'=>'video/x-ms-asf', 'icon'=>'avi'),
1379         'xdp'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1380         'xfd'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1381         'xfdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1383         'xls'  => array ('type'=>'application/vnd.ms-excel', 'icon'=>'excel'),
1384         'xlsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'icon'=>'xlsx'),
1385         'xlsm' => array ('type'=>'application/vnd.ms-excel.sheet.macroEnabled.12', 'icon'=>'xlsm'),
1386         'xltx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 'icon'=>'xltx'),
1387         'xltm' => array ('type'=>'application/vnd.ms-excel.template.macroEnabled.12', 'icon'=>'xltm'),
1388         'xlsb' => array ('type'=>'application/vnd.ms-excel.sheet.binary.macroEnabled.12', 'icon'=>'xlsb'),
1389         'xlam' => array ('type'=>'application/vnd.ms-excel.addin.macroEnabled.12', 'icon'=>'xlam'),
1391         'xml'  => array ('type'=>'application/xml', 'icon'=>'xml'),
1392         'xsl'  => array ('type'=>'text/xml', 'icon'=>'xml'),
1393         'zip'  => array ('type'=>'application/zip', 'icon'=>'zip')
1394     );
1395     return $mimearray;
1398 /**
1399  * Obtains information about a filetype based on its extension. Will
1400  * use a default if no information is present about that particular
1401  * extension.
1402  *
1403  * @category files
1404  * @param string $element Desired information (usually 'icon'
1405  *   for icon filename or 'type' for MIME type)
1406  * @param string $filename Filename we're looking up
1407  * @return string Requested piece of information from array
1408  */
1409 function mimeinfo($element, $filename) {
1410     global $CFG;
1411     $mimeinfo = get_mimetypes_array();
1413     if (preg_match('/\.([a-z0-9]+)$/i', $filename, $match)) {
1414         if (isset($mimeinfo[strtolower($match[1])][$element])) {
1415             return $mimeinfo[strtolower($match[1])][$element];
1416         } else {
1417             if ($element == 'icon32') {
1418                 if (isset($mimeinfo[strtolower($match[1])]['icon'])) {
1419                     $filename = $mimeinfo[strtolower($match[1])]['icon'];
1420                 } else {
1421                     $filename = 'unknown';
1422                 }
1423                 $filename .= '-32';
1424                 if (file_exists($CFG->dirroot.'/pix/f/'.$filename.'.png') or file_exists($CFG->dirroot.'/pix/f/'.$filename.'.gif')) {
1425                     return $filename;
1426                 } else {
1427                     return 'unknown-32';
1428                 }
1429             } else {
1430                 return $mimeinfo['xxx'][$element];   // By default
1431             }
1432         }
1433     } else {
1434         if ($element == 'icon32') {
1435             return 'unknown-32';
1436         }
1437         return $mimeinfo['xxx'][$element];   // By default
1438     }
1441 /**
1442  * Obtains information about a filetype based on the MIME type rather than
1443  * the other way around.
1444  *
1445  * @category files
1446  * @param string $element Desired information (usually 'icon')
1447  * @param string $mimetype MIME type we're looking up
1448  * @return string Requested piece of information from array
1449  */
1450 function mimeinfo_from_type($element, $mimetype) {
1451     $mimeinfo = get_mimetypes_array();
1453     foreach($mimeinfo as $values) {
1454         if ($values['type']==$mimetype) {
1455             if (isset($values[$element])) {
1456                 return $values[$element];
1457             }
1458             break;
1459         }
1460     }
1461     return $mimeinfo['xxx'][$element]; // Default
1464 /**
1465  * Get information about a filetype based on the icon file.
1466  *
1467  * @category files
1468  * @param string $element Desired information (usually 'icon')
1469  * @param string $icon Icon file name without extension
1470  * @param bool $all return all matching entries (defaults to false - best (by ext)/last match)
1471  * @return string Requested piece of information from array
1472  */
1473 function mimeinfo_from_icon($element, $icon, $all=false) {
1474     $mimeinfo = get_mimetypes_array();
1476     if (preg_match("/\/(.*)/", $icon, $matches)) {
1477         $icon = $matches[1];
1478     }
1479     // Try to get the extension
1480     $extension = '';
1481     if (($cutat = strrpos($icon, '.')) !== false && $cutat < strlen($icon)-1) {
1482         $extension = substr($icon, $cutat + 1);
1483     }
1484     $info = array($mimeinfo['xxx'][$element]); // Default
1485     foreach($mimeinfo as $key => $values) {
1486         if ($values['icon']==$icon) {
1487             if (isset($values[$element])) {
1488                 $info[$key] = $values[$element];
1489             }
1490             //No break, for example for 'excel' we don't want 'csv'!
1491         }
1492     }
1493     if ($all) {
1494         if (count($info) > 1) {
1495             array_shift($info); // take off document/unknown if we have better options
1496         }
1497         return array_values($info); // Keep keys out when requesting all
1498     }
1500     // Requested only one, try to get the best by extension coincidence, else return the last
1501     if ($extension && isset($info[$extension])) {
1502         return $info[$extension];
1503     }
1505     return array_pop($info); // Return last match (mimicking behaviour/comment inside foreach loop)
1508 /**
1509  * Returns the relative icon path for a given mime type
1510  *
1511  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1512  * a return the full path to an icon.
1513  *
1514  * <code>
1515  * $mimetype = 'image/jpg';
1516  * $icon = $OUTPUT->pix_url(file_mimetype_icon($mimetype));
1517  * echo '<img src="'.$icon.'" alt="'.$mimetype.'" />';
1518  * </code>
1519  *
1520  * @category files
1521  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1522  * to conform with that.
1523  * @param string $mimetype The mimetype to fetch an icon for
1524  * @param int $size The size of the icon. Not yet implemented
1525  * @return string The relative path to the icon
1526  */
1527 function file_mimetype_icon($mimetype, $size = NULL) {
1528     global $CFG;
1530     $icon = mimeinfo_from_type('icon', $mimetype);
1531     if ($size) {
1532         if (file_exists("$CFG->dirroot/pix/f/$icon-$size.png") or file_exists("$CFG->dirroot/pix/f/$icon-$size.gif")) {
1533             $icon = "$icon-$size";
1534         }
1535     }
1536     return 'f/'.$icon;
1539 /**
1540  * Returns the relative icon path for a given file name
1541  *
1542  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1543  * a return the full path to an icon.
1544  *
1545  * <code>
1546  * $filename = 'jpg';
1547  * $icon = $OUTPUT->pix_url(file_extension_icon($filename));
1548  * echo '<img src="'.$icon.'" alt="blah" />';
1549  * </code>
1550  *
1551  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1552  * to conform with that.
1553  * @todo MDL-31074 Implement $size
1554  * @category files
1555  * @param string $filename The filename to get the icon for
1556  * @param int $size The size of the icon. Defaults to null can also be 32
1557  * @return string
1558  */
1559 function file_extension_icon($filename, $size = NULL) {
1560     global $CFG;
1562     $icon = mimeinfo('icon', $filename);
1563     if ($size) {
1564         if (file_exists("$CFG->dirroot/pix/f/$icon-$size.png") or file_exists("$CFG->dirroot/pix/f/$icon-$size.gif")) {
1565             $icon = "$icon-$size";
1566         }
1567     }
1568     return 'f/'.$icon;
1571 /**
1572  * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1573  * mimetypes.php language file.
1574  *
1575  * @param string $mimetype MIME type (can be obtained using the mimeinfo function)
1576  * @param bool $capitalise If true, capitalises first character of result
1577  * @return string Text description
1578  */
1579 function get_mimetype_description($mimetype, $capitalise=false) {
1580     if (get_string_manager()->string_exists($mimetype, 'mimetypes')) {
1581         $result = get_string($mimetype, 'mimetypes');
1582     } else {
1583         $result = get_string('document/unknown','mimetypes');
1584     }
1585     if ($capitalise) {
1586         $result=ucfirst($result);
1587     }
1588     return $result;
1591 /**
1592  * Requested file is not found or not accessible, does not return, terminates script
1593  *
1594  * @global stdClass $CFG
1595  * @global stdClass $COURSE
1596  */
1597 function send_file_not_found() {
1598     global $CFG, $COURSE;
1599     header('HTTP/1.0 404 not found');
1600     print_error('filenotfound', 'error', $CFG->wwwroot.'/course/view.php?id='.$COURSE->id); //this is not displayed on IIS??
1603 /**
1604  * Check output buffering settings before sending file.
1605  * Please note you should not send any other headers after calling this function.
1606  *
1607  * To be called only from lib/filelib.php !
1608  */
1609 function prepare_file_content_sending() {
1610     // We needed to be able to send headers up until now
1611     if (headers_sent()) {
1612         throw new file_serving_exception('Headers already sent, can not serve file.');
1613     }
1615     $olddebug = error_reporting(0);
1617     // IE compatibility HACK - it does not like zlib compression much
1618     // there is also a problem with the length header in older PHP versions
1619     if (ini_get_bool('zlib.output_compression')) {
1620         ini_set('zlib.output_compression', 'Off');
1621     }
1623     // flush and close all buffers if possible
1624     while(ob_get_level()) {
1625         if (!ob_end_flush()) {
1626             // prevent infinite loop when buffer can not be closed
1627             break;
1628         }
1629     }
1631     error_reporting($olddebug);
1633     //NOTE: we can not reliable test headers_sent() here because
1634     //      the headers might be sent which trying to close the buffers,
1635     //      this happens especially if browser does not support gzip or deflate
1638 /**
1639  * Handles the sending of temporary file to user, download is forced.
1640  * File is deleted after abort or successful sending, does not return, script terminated
1641  *
1642  * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
1643  * @param string $filename proposed file name when saving file
1644  * @param bool $pathisstring If the path is string
1645  */
1646 function send_temp_file($path, $filename, $pathisstring=false) {
1647     global $CFG;
1649     // close session - not needed anymore
1650     @session_get_instance()->write_close();
1652     if (!$pathisstring) {
1653         if (!file_exists($path)) {
1654             header('HTTP/1.0 404 not found');
1655             print_error('filenotfound', 'error', $CFG->wwwroot.'/');
1656         }
1657         // executed after normal finish or abort
1658         @register_shutdown_function('send_temp_file_finished', $path);
1659     }
1661     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
1662     if (check_browser_version('MSIE')) {
1663         $filename = urlencode($filename);
1664     }
1666     $filesize = $pathisstring ? strlen($path) : filesize($path);
1668     header('Content-Disposition: attachment; filename='.$filename);
1669     header('Content-Length: '.$filesize);
1670     if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
1671         header('Cache-Control: max-age=10');
1672         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1673         header('Pragma: ');
1674     } else { //normal http - prevent caching at all cost
1675         header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
1676         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1677         header('Pragma: no-cache');
1678     }
1679     header('Accept-Ranges: none'); // Do not allow byteserving
1681     //flush the buffers - save memory and disable sid rewrite
1682     // this also disables zlib compression
1683     prepare_file_content_sending();
1685     // send the contents
1686     if ($pathisstring) {
1687         echo $path;
1688     } else {
1689         @readfile($path);
1690     }
1692     die; //no more chars to output
1695 /**
1696  * Internal callback function used by send_temp_file()
1697  *
1698  * @param string $path
1699  */
1700 function send_temp_file_finished($path) {
1701     if (file_exists($path)) {
1702         @unlink($path);
1703     }
1706 /**
1707  * Handles the sending of file data to the user's browser, including support for
1708  * byteranges etc.
1709  *
1710  * @category files
1711  * @global stdClass $CFG
1712  * @global stdClass $COURSE
1713  * @global moodle_session $SESSION
1714  * @param string $path Path of file on disk (including real filename), or actual content of file as string
1715  * @param string $filename Filename to send
1716  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
1717  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
1718  * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname
1719  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
1720  * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
1721  * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
1722  *                        if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
1723  *                        you must detect this case when control is returned using connection_aborted. Please not that session is closed
1724  *                        and should not be reopened.
1725  * @return null script execution stopped unless $dontdie is true
1726  */
1727 function send_file($path, $filename, $lifetime = 'default' , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='', $dontdie=false) {
1728     global $CFG, $COURSE, $SESSION;
1730     if ($dontdie) {
1731         ignore_user_abort(true);
1732     }
1734     // MDL-11789, apply $CFG->filelifetime here
1735     if ($lifetime === 'default') {
1736         if (!empty($CFG->filelifetime)) {
1737             $lifetime = $CFG->filelifetime;
1738         } else {
1739             $lifetime = 86400;
1740         }
1741     }
1743     session_get_instance()->write_close(); // unlock session during fileserving
1745     // Use given MIME type if specified, otherwise guess it using mimeinfo.
1746     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
1747     // only Firefox saves all files locally before opening when content-disposition: attachment stated
1748     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
1749     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
1750                          ($mimetype ? $mimetype : mimeinfo('type', $filename));
1752     $lastmodified = $pathisstring ? time() : filemtime($path);
1753     $filesize     = $pathisstring ? strlen($path) : filesize($path);
1755 /* - MDL-13949
1756     //Adobe Acrobat Reader XSS prevention
1757     if ($mimetype=='application/pdf' or mimeinfo('type', $filename)=='application/pdf') {
1758         //please note that it prevents opening of pdfs in browser when http referer disabled
1759         //or file linked from another site; browser caching of pdfs is now disabled too
1760         if (!empty($_SERVER['HTTP_RANGE'])) {
1761             //already byteserving
1762             $lifetime = 1; // >0 needed for byteserving
1763         } else if (empty($_SERVER['HTTP_REFERER']) or strpos($_SERVER['HTTP_REFERER'], $CFG->wwwroot)!==0) {
1764             $mimetype = 'application/x-forcedownload';
1765             $forcedownload = true;
1766             $lifetime = 0;
1767         } else {
1768             $lifetime = 1; // >0 needed for byteserving
1769         }
1770     }
1771 */
1773     if ($lifetime > 0 && !empty($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
1774         // get unixtime of request header; clip extra junk off first
1775         $since = strtotime(preg_replace('/;.*$/','',$_SERVER["HTTP_IF_MODIFIED_SINCE"]));
1776         if ($since && $since >= $lastmodified) {
1777             header('HTTP/1.1 304 Not Modified');
1778             header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
1779             header('Cache-Control: max-age='.$lifetime);
1780             header('Content-Type: '.$mimetype);
1781             if ($dontdie) {
1782                 return;
1783             }
1784             die;
1785         }
1786     }
1788     //do not put '@' before the next header to detect incorrect moodle configurations,
1789     //error should be better than "weird" empty lines for admins/users
1790     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1792     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
1793     if (check_browser_version('MSIE')) {
1794         $filename = rawurlencode($filename);
1795     }
1797     if ($forcedownload) {
1798         header('Content-Disposition: attachment; filename="'.$filename.'"');
1799     } else {
1800         header('Content-Disposition: inline; filename="'.$filename.'"');
1801     }
1803     if ($lifetime > 0) {
1804         header('Cache-Control: max-age='.$lifetime);
1805         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
1806         header('Pragma: ');
1808         if (empty($CFG->disablebyteserving) && !$pathisstring && $mimetype != 'text/plain' && $mimetype != 'text/html') {
1810             header('Accept-Ranges: bytes');
1812             if (!empty($_SERVER['HTTP_RANGE']) && strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
1813                 // byteserving stuff - for acrobat reader and download accelerators
1814                 // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
1815                 // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
1816                 $ranges = false;
1817                 if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
1818                     foreach ($ranges as $key=>$value) {
1819                         if ($ranges[$key][1] == '') {
1820                             //suffix case
1821                             $ranges[$key][1] = $filesize - $ranges[$key][2];
1822                             $ranges[$key][2] = $filesize - 1;
1823                         } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
1824                             //fix range length
1825                             $ranges[$key][2] = $filesize - 1;
1826                         }
1827                         if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
1828                             //invalid byte-range ==> ignore header
1829                             $ranges = false;
1830                             break;
1831                         }
1832                         //prepare multipart header
1833                         $ranges[$key][0] =  "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
1834                         $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
1835                     }
1836                 } else {
1837                     $ranges = false;
1838                 }
1839                 if ($ranges) {
1840                     $handle = fopen($path, 'rb');
1841                     byteserving_send_file($handle, $mimetype, $ranges, $filesize);
1842                 }
1843             }
1844         } else {
1845             /// Do not byteserve (disabled, strings, text and html files).
1846             header('Accept-Ranges: none');
1847         }
1848     } else { // Do not cache files in proxies and browsers
1849         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
1850             header('Cache-Control: max-age=10');
1851             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1852             header('Pragma: ');
1853         } else { //normal http - prevent caching at all cost
1854             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
1855             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
1856             header('Pragma: no-cache');
1857         }
1858         header('Accept-Ranges: none'); // Do not allow byteserving when caching disabled
1859     }
1861     if (empty($filter)) {
1862         if ($mimetype == 'text/plain') {
1863             header('Content-Type: Text/plain; charset=utf-8'); //add encoding
1864         } else {
1865             header('Content-Type: '.$mimetype);
1866         }
1867         header('Content-Length: '.$filesize);
1869         //flush the buffers - save memory and disable sid rewrite
1870         //this also disables zlib compression
1871         prepare_file_content_sending();
1873         // send the contents
1874         if ($pathisstring) {
1875             echo $path;
1876         } else {
1877             @readfile($path);
1878         }
1880     } else {     // Try to put the file through filters
1881         if ($mimetype == 'text/html') {
1882             $options = new stdClass();
1883             $options->noclean = true;
1884             $options->nocache = true; // temporary workaround for MDL-5136
1885             $text = $pathisstring ? $path : implode('', file($path));
1887             $text = file_modify_html_header($text);
1888             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
1890             header('Content-Length: '.strlen($output));
1891             header('Content-Type: text/html');
1893             //flush the buffers - save memory and disable sid rewrite
1894             //this also disables zlib compression
1895             prepare_file_content_sending();
1897             // send the contents
1898             echo $output;
1899         // only filter text if filter all files is selected
1900         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
1901             $options = new stdClass();
1902             $options->newlines = false;
1903             $options->noclean = true;
1904             $text = htmlentities($pathisstring ? $path : implode('', file($path)));
1905             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
1907             header('Content-Length: '.strlen($output));
1908             header('Content-Type: text/html; charset=utf-8'); //add encoding
1910             //flush the buffers - save memory and disable sid rewrite
1911             //this also disables zlib compression
1912             prepare_file_content_sending();
1914             // send the contents
1915             echo $output;
1917         } else {    // Just send it out raw
1918             header('Content-Length: '.$filesize);
1919             header('Content-Type: '.$mimetype);
1921             //flush the buffers - save memory and disable sid rewrite
1922             //this also disables zlib compression
1923             prepare_file_content_sending();
1925             // send the contents
1926             if ($pathisstring) {
1927                 echo $path;
1928             }else {
1929                 @readfile($path);
1930             }
1931         }
1932     }
1933     if ($dontdie) {
1934         return;
1935     }
1936     die; //no more chars to output!!!
1939 /**
1940  * Handles the sending of file data to the user's browser, including support for
1941  * byteranges etc.
1942  *
1943  * @category files
1944  * @global stdClass $CFG
1945  * @global stdClass $COURSE
1946  * @global moodle_session $SESSION
1947  * @param stored_file $stored_file local file object
1948  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
1949  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
1950  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
1951  * @param string $filename Override filename
1952  * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
1953  *                        if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
1954  *                        you must detect this case when control is returned using connection_aborted. Please not that session is closed
1955  *                        and should not be reopened.
1956  * @return null script execution stopped unless $dontdie is true
1957  */
1958 function send_stored_file($stored_file, $lifetime=86400 , $filter=0, $forcedownload=false, $filename=null, $dontdie=false) {
1959     global $CFG, $COURSE, $SESSION;
1961     if (!$stored_file or $stored_file->is_directory()) {
1962         // nothing to serve
1963         if ($dontdie) {
1964             return;
1965         }
1966         die;
1967     }
1969     if ($dontdie) {
1970         ignore_user_abort(true);
1971     }
1973     session_get_instance()->write_close(); // unlock session during fileserving
1975     // Use given MIME type if specified, otherwise guess it using mimeinfo.
1976     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
1977     // only Firefox saves all files locally before opening when content-disposition: attachment stated
1978     $filename     = is_null($filename) ? $stored_file->get_filename() : $filename;
1979     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
1980     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
1981                          ($stored_file->get_mimetype() ? $stored_file->get_mimetype() : mimeinfo('type', $filename));
1983     $lastmodified = $stored_file->get_timemodified();
1984     $filesize     = $stored_file->get_filesize();
1986     if ($lifetime > 0 && !empty($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
1987         // get unixtime of request header; clip extra junk off first
1988         $since = strtotime(preg_replace('/;.*$/','',$_SERVER["HTTP_IF_MODIFIED_SINCE"]));
1989         if ($since && $since >= $lastmodified) {
1990             header('HTTP/1.1 304 Not Modified');
1991             header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
1992             header('Cache-Control: max-age='.$lifetime);
1993             header('Content-Type: '.$mimetype);
1994             if ($dontdie) {
1995                 return;
1996             }
1997             die;
1998         }
1999     }
2001     //do not put '@' before the next header to detect incorrect moodle configurations,
2002     //error should be better than "weird" empty lines for admins/users
2003     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
2005     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2006     if (check_browser_version('MSIE')) {
2007         $filename = rawurlencode($filename);
2008     }
2010     if ($forcedownload) {
2011         header('Content-Disposition: attachment; filename="'.$filename.'"');
2012     } else {
2013         header('Content-Disposition: inline; filename="'.$filename.'"');
2014     }
2016     if ($lifetime > 0) {
2017         header('Cache-Control: max-age='.$lifetime);
2018         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2019         header('Pragma: ');
2021         if (empty($CFG->disablebyteserving) && $mimetype != 'text/plain' && $mimetype != 'text/html') {
2023             header('Accept-Ranges: bytes');
2025             if (!empty($_SERVER['HTTP_RANGE']) && strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
2026                 // byteserving stuff - for acrobat reader and download accelerators
2027                 // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
2028                 // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
2029                 $ranges = false;
2030                 if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
2031                     foreach ($ranges as $key=>$value) {
2032                         if ($ranges[$key][1] == '') {
2033                             //suffix case
2034                             $ranges[$key][1] = $filesize - $ranges[$key][2];
2035                             $ranges[$key][2] = $filesize - 1;
2036                         } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
2037                             //fix range length
2038                             $ranges[$key][2] = $filesize - 1;
2039                         }
2040                         if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
2041                             //invalid byte-range ==> ignore header
2042                             $ranges = false;
2043                             break;
2044                         }
2045                         //prepare multipart header
2046                         $ranges[$key][0] =  "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
2047                         $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
2048                     }
2049                 } else {
2050                     $ranges = false;
2051                 }
2052                 if ($ranges) {
2053                     byteserving_send_file($stored_file->get_content_file_handle(), $mimetype, $ranges, $filesize);
2054                 }
2055             }
2056         } else {
2057             /// Do not byteserve (disabled, strings, text and html files).
2058             header('Accept-Ranges: none');
2059         }
2060     } else { // Do not cache files in proxies and browsers
2061         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2062             header('Cache-Control: max-age=10');
2063             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2064             header('Pragma: ');
2065         } else { //normal http - prevent caching at all cost
2066             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2067             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2068             header('Pragma: no-cache');
2069         }
2070         header('Accept-Ranges: none'); // Do not allow byteserving when caching disabled
2071     }
2073     if (empty($filter)) {
2074         if ($mimetype == 'text/plain') {
2075             header('Content-Type: Text/plain; charset=utf-8'); //add encoding
2076         } else {
2077             header('Content-Type: '.$mimetype);
2078         }
2079         header('Content-Length: '.$filesize);
2081         //flush the buffers - save memory and disable sid rewrite
2082         //this also disables zlib compression
2083         prepare_file_content_sending();
2085         // send the contents
2086         $stored_file->readfile();
2088     } else {     // Try to put the file through filters
2089         if ($mimetype == 'text/html') {
2090             $options = new stdClass();
2091             $options->noclean = true;
2092             $options->nocache = true; // temporary workaround for MDL-5136
2093             $text = $stored_file->get_content();
2094             $text = file_modify_html_header($text);
2095             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2097             header('Content-Length: '.strlen($output));
2098             header('Content-Type: text/html');
2100             //flush the buffers - save memory and disable sid rewrite
2101             //this also disables zlib compression
2102             prepare_file_content_sending();
2104             // send the contents
2105             echo $output;
2107         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2108             // only filter text if filter all files is selected
2109             $options = new stdClass();
2110             $options->newlines = false;
2111             $options->noclean = true;
2112             $text = $stored_file->get_content();
2113             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2115             header('Content-Length: '.strlen($output));
2116             header('Content-Type: text/html; charset=utf-8'); //add encoding
2118             //flush the buffers - save memory and disable sid rewrite
2119             //this also disables zlib compression
2120             prepare_file_content_sending();
2122             // send the contents
2123             echo $output;
2125         } else {    // Just send it out raw
2126             header('Content-Length: '.$filesize);
2127             header('Content-Type: '.$mimetype);
2129             //flush the buffers - save memory and disable sid rewrite
2130             //this also disables zlib compression
2131             prepare_file_content_sending();
2133             // send the contents
2134             $stored_file->readfile();
2135         }
2136     }
2137     if ($dontdie) {
2138         return;
2139     }
2140     die; //no more chars to output!!!
2143 /**
2144  * Retrieves an array of records from a CSV file and places
2145  * them into a given table structure
2146  *
2147  * @global stdClass $CFG
2148  * @global moodle_database $DB
2149  * @param string $file The path to a CSV file
2150  * @param string $table The table to retrieve columns from
2151  * @return bool|array Returns an array of CSV records or false
2152  */
2153 function get_records_csv($file, $table) {
2154     global $CFG, $DB;
2156     if (!$metacolumns = $DB->get_columns($table)) {
2157         return false;
2158     }
2160     if(!($handle = @fopen($file, 'r'))) {
2161         print_error('get_records_csv failed to open '.$file);
2162     }
2164     $fieldnames = fgetcsv($handle, 4096);
2165     if(empty($fieldnames)) {
2166         fclose($handle);
2167         return false;
2168     }
2170     $columns = array();
2172     foreach($metacolumns as $metacolumn) {
2173         $ord = array_search($metacolumn->name, $fieldnames);
2174         if(is_int($ord)) {
2175             $columns[$metacolumn->name] = $ord;
2176         }
2177     }
2179     $rows = array();
2181     while (($data = fgetcsv($handle, 4096)) !== false) {
2182         $item = new stdClass;
2183         foreach($columns as $name => $ord) {
2184             $item->$name = $data[$ord];
2185         }
2186         $rows[] = $item;
2187     }
2189     fclose($handle);
2190     return $rows;
2193 /**
2194  * Create a file with CSV contents
2195  *
2196  * @global stdClass $CFG
2197  * @global moodle_database $DB
2198  * @param string $file The file to put the CSV content into
2199  * @param array $records An array of records to write to a CSV file
2200  * @param string $table The table to get columns from
2201  * @return bool success
2202  */
2203 function put_records_csv($file, $records, $table = NULL) {
2204     global $CFG, $DB;
2206     if (empty($records)) {
2207         return true;
2208     }
2210     $metacolumns = NULL;
2211     if ($table !== NULL && !$metacolumns = $DB->get_columns($table)) {
2212         return false;
2213     }
2215     echo "x";
2217     if(!($fp = @fopen($CFG->tempdir.'/'.$file, 'w'))) {
2218         print_error('put_records_csv failed to open '.$file);
2219     }
2221     $proto = reset($records);
2222     if(is_object($proto)) {
2223         $fields_records = array_keys(get_object_vars($proto));
2224     }
2225     else if(is_array($proto)) {
2226         $fields_records = array_keys($proto);
2227     }
2228     else {
2229         return false;
2230     }
2231     echo "x";
2233     if(!empty($metacolumns)) {
2234         $fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
2235         $fields = array_intersect($fields_records, $fields_table);
2236     }
2237     else {
2238         $fields = $fields_records;
2239     }
2241     fwrite($fp, implode(',', $fields));
2242     fwrite($fp, "\r\n");
2244     foreach($records as $record) {
2245         $array  = (array)$record;
2246         $values = array();
2247         foreach($fields as $field) {
2248             if(strpos($array[$field], ',')) {
2249                 $values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
2250             }
2251             else {
2252                 $values[] = $array[$field];
2253             }
2254         }
2255         fwrite($fp, implode(',', $values)."\r\n");
2256     }
2258     fclose($fp);
2259     return true;
2263 /**
2264  * Recursively delete the file or folder with path $location. That is,
2265  * if it is a file delete it. If it is a folder, delete all its content
2266  * then delete it. If $location does not exist to start, that is not
2267  * considered an error.
2268  *
2269  * @param string $location the path to remove.
2270  * @return bool
2271  */
2272 function fulldelete($location) {
2273     if (empty($location)) {
2274         // extra safety against wrong param
2275         return false;
2276     }
2277     if (is_dir($location)) {
2278         $currdir = opendir($location);
2279         while (false !== ($file = readdir($currdir))) {
2280             if ($file <> ".." && $file <> ".") {
2281                 $fullfile = $location."/".$file;
2282                 if (is_dir($fullfile)) {
2283                     if (!fulldelete($fullfile)) {
2284                         return false;
2285                     }
2286                 } else {
2287                     if (!unlink($fullfile)) {
2288                         return false;
2289                     }
2290                 }
2291             }
2292         }
2293         closedir($currdir);
2294         if (! rmdir($location)) {
2295             return false;
2296         }
2298     } else if (file_exists($location)) {
2299         if (!unlink($location)) {
2300             return false;
2301         }
2302     }
2303     return true;
2306 /**
2307  * Send requested byterange of file.
2308  *
2309  * @param resource $handle A file handle
2310  * @param string $mimetype The mimetype for the output
2311  * @param array $ranges An array of ranges to send
2312  * @param string $filesize The size of the content if only one range is used
2313  * @todo MDL-31088 check if "multipart/x-byteranges" is more compatible with current readers/browsers/servers
2314  */
2315 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2316     $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2317     if ($handle === false) {
2318         die;
2319     }
2320     if (count($ranges) == 1) { //only one range requested
2321         $length = $ranges[0][2] - $ranges[0][1] + 1;
2322         header('HTTP/1.1 206 Partial content');
2323         header('Content-Length: '.$length);
2324         header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2325         header('Content-Type: '.$mimetype);
2327         //flush the buffers - save memory and disable sid rewrite
2328         //this also disables zlib compression
2329         prepare_file_content_sending();
2331         $buffer = '';
2332         fseek($handle, $ranges[0][1]);
2333         while (!feof($handle) && $length > 0) {
2334             @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2335             $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2336             echo $buffer;
2337             flush();
2338             $length -= strlen($buffer);
2339         }
2340         fclose($handle);
2341         die;
2342     } else { // multiple ranges requested - not tested much
2343         $totallength = 0;
2344         foreach($ranges as $range) {
2345             $totallength += strlen($range[0]) + $range[2] - $range[1] + 1;
2346         }
2347         $totallength += strlen("\r\n--".BYTESERVING_BOUNDARY."--\r\n");
2348         header('HTTP/1.1 206 Partial content');
2349         header('Content-Length: '.$totallength);
2350         header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY);
2351         //TODO: check if "multipart/x-byteranges" is more compatible with current readers/browsers/servers
2353         //flush the buffers - save memory and disable sid rewrite
2354         //this also disables zlib compression
2355         prepare_file_content_sending();
2357         foreach($ranges as $range) {
2358             $length = $range[2] - $range[1] + 1;
2359             echo $range[0];
2360             $buffer = '';
2361             fseek($handle, $range[1]);
2362             while (!feof($handle) && $length > 0) {
2363                 @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2364                 $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2365                 echo $buffer;
2366                 flush();
2367                 $length -= strlen($buffer);
2368             }
2369         }
2370         echo "\r\n--".BYTESERVING_BOUNDARY."--\r\n";
2371         fclose($handle);
2372         die;
2373     }
2376 /**
2377  * add includes (js and css) into uploaded files
2378  * before returning them, useful for themes and utf.js includes
2379  *
2380  * @global stdClass $CFG
2381  * @param string $text text to search and replace
2382  * @return string text with added head includes
2383  * @todo MDL-21120
2384  */
2385 function file_modify_html_header($text) {
2386     // first look for <head> tag
2387     global $CFG;
2389     $stylesheetshtml = '';
2390 /*    foreach ($CFG->stylesheets as $stylesheet) {
2391         //TODO: MDL-21120
2392         $stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
2393     }*/
2395     $ufo = '';
2396     if (filter_is_enabled('filter/mediaplugin')) {
2397         // this script is needed by most media filter plugins.
2398         $attributes = array('type'=>'text/javascript', 'src'=>$CFG->httpswwwroot . '/lib/ufo.js');
2399         $ufo = html_writer::tag('script', '', $attributes) . "\n";
2400     }
2402     preg_match('/\<head\>|\<HEAD\>/', $text, $matches);
2403     if ($matches) {
2404         $replacement = '<head>'.$ufo.$stylesheetshtml;
2405         $text = preg_replace('/\<head\>|\<HEAD\>/', $replacement, $text, 1);
2406         return $text;
2407     }
2409     // if not, look for <html> tag, and stick <head> right after
2410     preg_match('/\<html\>|\<HTML\>/', $text, $matches);
2411     if ($matches) {
2412         // replace <html> tag with <html><head>includes</head>
2413         $replacement = '<html>'."\n".'<head>'.$ufo.$stylesheetshtml.'</head>';
2414         $text = preg_replace('/\<html\>|\<HTML\>/', $replacement, $text, 1);
2415         return $text;
2416     }
2418     // if not, look for <body> tag, and stick <head> before body
2419     preg_match('/\<body\>|\<BODY\>/', $text, $matches);
2420     if ($matches) {
2421         $replacement = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".'<body>';
2422         $text = preg_replace('/\<body\>|\<BODY\>/', $replacement, $text, 1);
2423         return $text;
2424     }
2426     // if not, just stick a <head> tag at the beginning
2427     $text = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".$text;
2428     return $text;
2431 /**
2432  * RESTful cURL class
2433  *
2434  * This is a wrapper class for curl, it is quite easy to use:
2435  * <code>
2436  * $c = new curl;
2437  * // enable cache
2438  * $c = new curl(array('cache'=>true));
2439  * // enable cookie
2440  * $c = new curl(array('cookie'=>true));
2441  * // enable proxy
2442  * $c = new curl(array('proxy'=>true));
2443  *
2444  * // HTTP GET Method
2445  * $html = $c->get('http://example.com');
2446  * // HTTP POST Method
2447  * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2448  * // HTTP PUT Method
2449  * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2450  * </code>
2451  *
2452  * @package   core_files
2453  * @category files
2454  * @copyright Dongsheng Cai <dongsheng@moodle.com>
2455  * @license   http://www.gnu.org/copyleft/gpl.html GNU Public License
2456  */
2457 class curl {
2458     /** @var bool Caches http request contents */
2459     public  $cache    = false;
2460     /** @var bool Uses proxy */
2461     public  $proxy    = false;
2462     /** @var string library version */
2463     public  $version  = '0.4 dev';
2464     /** @var array http's response */
2465     public  $response = array();
2466     /** @var array http header */
2467     public  $header   = array();
2468     /** @var string cURL information */
2469     public  $info;
2470     /** @var string error */
2471     public  $error;
2473     /** @var array cURL options */
2474     private $options;
2475     /** @var string Proxy host */
2476     private $proxy_host = '';
2477     /** @var string Proxy auth */
2478     private $proxy_auth = '';
2479     /** @var string Proxy type */
2480     private $proxy_type = '';
2481     /** @var bool Debug mode on */
2482     private $debug    = false;
2483     /** @var bool|string Path to cookie file */
2484     private $cookie   = false;
2486     /**
2487      * Constructor
2488      *
2489      * @global stdClass $CFG
2490      * @param array $options
2491      */
2492     public function __construct($options = array()){
2493         global $CFG;
2494         if (!function_exists('curl_init')) {
2495             $this->error = 'cURL module must be enabled!';
2496             trigger_error($this->error, E_USER_ERROR);
2497             return false;
2498         }
2499         // the options of curl should be init here.
2500         $this->resetopt();
2501         if (!empty($options['debug'])) {
2502             $this->debug = true;
2503         }
2504         if(!empty($options['cookie'])) {
2505             if($options['cookie'] === true) {
2506                 $this->cookie = $CFG->dataroot.'/curl_cookie.txt';
2507             } else {
2508                 $this->cookie = $options['cookie'];
2509             }
2510         }
2511         if (!empty($options['cache'])) {
2512             if (class_exists('curl_cache')) {
2513                 if (!empty($options['module_cache'])) {
2514                     $this->cache = new curl_cache($options['module_cache']);
2515                 } else {
2516                     $this->cache = new curl_cache('misc');
2517                 }
2518             }
2519         }
2520         if (!empty($CFG->proxyhost)) {
2521             if (empty($CFG->proxyport)) {
2522                 $this->proxy_host = $CFG->proxyhost;
2523             } else {
2524                 $this->proxy_host = $CFG->proxyhost.':'.$CFG->proxyport;
2525             }
2526             if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
2527                 $this->proxy_auth = $CFG->proxyuser.':'.$CFG->proxypassword;
2528                 $this->setopt(array(
2529                             'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM,
2530                             'proxyuserpwd'=>$this->proxy_auth));
2531             }
2532             if (!empty($CFG->proxytype)) {
2533                 if ($CFG->proxytype == 'SOCKS5') {
2534                     $this->proxy_type = CURLPROXY_SOCKS5;
2535                 } else {
2536                     $this->proxy_type = CURLPROXY_HTTP;
2537                     $this->setopt(array('httpproxytunnel'=>false));
2538                 }
2539                 $this->setopt(array('proxytype'=>$this->proxy_type));
2540             }
2541         }
2542         if (!empty($this->proxy_host)) {
2543             $this->proxy = array('proxy'=>$this->proxy_host);
2544         }
2545     }
2546     /**
2547      * Resets the CURL options that have already been set
2548      */
2549     public function resetopt(){
2550         $this->options = array();
2551         $this->options['CURLOPT_USERAGENT']         = 'MoodleBot/1.0';
2552         // True to include the header in the output
2553         $this->options['CURLOPT_HEADER']            = 0;
2554         // True to Exclude the body from the output
2555         $this->options['CURLOPT_NOBODY']            = 0;
2556         // TRUE to follow any "Location: " header that the server
2557         // sends as part of the HTTP header (note this is recursive,
2558         // PHP will follow as many "Location: " headers that it is sent,
2559         // unless CURLOPT_MAXREDIRS is set).
2560         //$this->options['CURLOPT_FOLLOWLOCATION']    = 1;
2561         $this->options['CURLOPT_MAXREDIRS']         = 10;
2562         $this->options['CURLOPT_ENCODING']          = '';
2563         // TRUE to return the transfer as a string of the return
2564         // value of curl_exec() instead of outputting it out directly.
2565         $this->options['CURLOPT_RETURNTRANSFER']    = 1;
2566         $this->options['CURLOPT_BINARYTRANSFER']    = 0;
2567         $this->options['CURLOPT_SSL_VERIFYPEER']    = 0;
2568         $this->options['CURLOPT_SSL_VERIFYHOST']    = 2;
2569         $this->options['CURLOPT_CONNECTTIMEOUT']    = 30;
2570     }
2572     /**
2573      * Reset Cookie
2574      */
2575     public function resetcookie() {
2576         if (!empty($this->cookie)) {
2577             if (is_file($this->cookie)) {
2578                 $fp = fopen($this->cookie, 'w');
2579                 if (!empty($fp)) {
2580                     fwrite($fp, '');
2581                     fclose($fp);
2582                 }
2583             }
2584         }
2585     }
2587     /**
2588      * Set curl options
2589      *
2590      * @param array $options If array is null, this function will
2591      * reset the options to default value.
2592      */
2593     public function setopt($options = array()) {
2594         if (is_array($options)) {
2595             foreach($options as $name => $val){
2596                 if (stripos($name, 'CURLOPT_') === false) {
2597                     $name = strtoupper('CURLOPT_'.$name);
2598                 }
2599                 $this->options[$name] = $val;
2600             }
2601         }
2602     }
2604     /**
2605      * Reset http method
2606      */
2607     public function cleanopt(){
2608         unset($this->options['CURLOPT_HTTPGET']);
2609         unset($this->options['CURLOPT_POST']);
2610         unset($this->options['CURLOPT_POSTFIELDS']);
2611         unset($this->options['CURLOPT_PUT']);
2612         unset($this->options['CURLOPT_INFILE']);
2613         unset($this->options['CURLOPT_INFILESIZE']);
2614         unset($this->options['CURLOPT_CUSTOMREQUEST']);
2615     }
2617     /**
2618      * Set HTTP Request Header
2619      *
2620      * @param array $header
2621      */
2622     public function setHeader($header) {
2623         if (is_array($header)){
2624             foreach ($header as $v) {
2625                 $this->setHeader($v);
2626             }
2627         } else {
2628             $this->header[] = $header;
2629         }
2630     }
2632     /**
2633      * Set HTTP Response Header
2634      *
2635      */
2636     public function getResponse(){
2637         return $this->response;
2638     }
2640     /**
2641      * private callback function
2642      * Formatting HTTP Response Header
2643      *
2644      * @param resource $ch Apparently not used
2645      * @param string $header
2646      * @return int The strlen of the header
2647      */
2648     private function formatHeader($ch, $header)
2649     {
2650         $this->count++;
2651         if (strlen($header) > 2) {
2652             list($key, $value) = explode(" ", rtrim($header, "\r\n"), 2);
2653             $key = rtrim($key, ':');
2654             if (!empty($this->response[$key])) {
2655                 if (is_array($this->response[$key])){
2656                     $this->response[$key][] = $value;
2657                 } else {
2658                     $tmp = $this->response[$key];
2659                     $this->response[$key] = array();
2660                     $this->response[$key][] = $tmp;
2661                     $this->response[$key][] = $value;
2663                 }
2664             } else {
2665                 $this->response[$key] = $value;
2666             }
2667         }
2668         return strlen($header);
2669     }
2671     /**
2672      * Set options for individual curl instance
2673      *
2674      * @param resource $curl A curl handle
2675      * @param array $options
2676      * @return resource The curl handle
2677      */
2678     private function apply_opt($curl, $options) {
2679         // Clean up
2680         $this->cleanopt();
2681         // set cookie
2682         if (!empty($this->cookie) || !empty($options['cookie'])) {
2683             $this->setopt(array('cookiejar'=>$this->cookie,
2684                             'cookiefile'=>$this->cookie
2685                              ));
2686         }
2688         // set proxy
2689         if (!empty($this->proxy) || !empty($options['proxy'])) {
2690             $this->setopt($this->proxy);
2691         }
2692         $this->setopt($options);
2693         // reset before set options
2694         curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this,'formatHeader'));
2695         // set headers
2696         if (empty($this->header)){
2697             $this->setHeader(array(
2698                 'User-Agent: MoodleBot/1.0',
2699                 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
2700                 'Connection: keep-alive'
2701                 ));
2702         }
2703         curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
2705         if ($this->debug){
2706             echo '<h1>Options</h1>';
2707             var_dump($this->options);
2708             echo '<h1>Header</h1>';
2709             var_dump($this->header);
2710         }
2712         // set options
2713         foreach($this->options as $name => $val) {
2714             if (is_string($name)) {
2715                 $name = constant(strtoupper($name));
2716             }
2717             curl_setopt($curl, $name, $val);
2718         }
2719         return $curl;
2720     }
2722     /**
2723      * Download multiple files in parallel
2724      *
2725      * Calls {@link multi()} with specific download headers
2726      *
2727      * <code>
2728      * $c = new curl;
2729      * $c->download(array(
2730      *              array('url'=>'http://localhost/', 'file'=>fopen('a', 'wb')),
2731      *              array('url'=>'http://localhost/20/', 'file'=>fopen('b', 'wb'))
2732      *              ));
2733      * </code>
2734      *
2735      * @param array $requests An array of files to request
2736      * @param array $options An array of options to set
2737      * @return array An array of results
2738      */
2739     public function download($requests, $options = array()) {
2740         $options['CURLOPT_BINARYTRANSFER'] = 1;
2741         $options['RETURNTRANSFER'] = false;
2742         return $this->multi($requests, $options);
2743     }
2745     /**
2746      * Mulit HTTP Requests
2747      * This function could run multi-requests in parallel.
2748      *
2749      * @param array $requests An array of files to request
2750      * @param array $options An array of options to set
2751      * @return array An array of results
2752      */
2753     protected function multi($requests, $options = array()) {
2754         $count   = count($requests);
2755         $handles = array();
2756         $results = array();
2757         $main    = curl_multi_init();
2758         for ($i = 0; $i < $count; $i++) {
2759             $url = $requests[$i];
2760             foreach($url as $n=>$v){
2761                 $options[$n] = $url[$n];
2762             }
2763             $handles[$i] = curl_init($url['url']);
2764             $this->apply_opt($handles[$i], $options);
2765             curl_multi_add_handle($main, $handles[$i]);
2766         }
2767         $running = 0;
2768         do {
2769             curl_multi_exec($main, $running);
2770         } while($running > 0);
2771         for ($i = 0; $i < $count; $i++) {
2772             if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
2773                 $results[] = true;
2774             } else {
2775                 $results[] = curl_multi_getcontent($handles[$i]);
2776             }
2777             curl_multi_remove_handle($main, $handles[$i]);
2778         }
2779         curl_multi_close($main);
2780         return $results;
2781     }
2783     /**
2784      * Single HTTP Request
2785      *
2786      * @param string $url The URL to request
2787      * @param array $options
2788      * @return bool
2789      */
2790     protected function request($url, $options = array()){
2791         // create curl instance
2792         $curl = curl_init($url);
2793         $options['url'] = $url;
2794         $this->apply_opt($curl, $options);
2795         if ($this->cache && $ret = $this->cache->get($this->options)) {
2796             return $ret;
2797         } else {
2798             $ret = curl_exec($curl);
2799             if ($this->cache) {
2800                 $this->cache->set($this->options, $ret);
2801             }
2802         }
2804         $this->info  = curl_getinfo($curl);
2805         $this->error = curl_error($curl);
2807         if ($this->debug){
2808             echo '<h1>Return Data</h1>';
2809             var_dump($ret);
2810             echo '<h1>Info</h1>';
2811             var_dump($this->info);
2812             echo '<h1>Error</h1>';
2813             var_dump($this->error);
2814         }
2816         curl_close($curl);
2818         if (empty($this->error)){
2819             return $ret;
2820         } else {
2821             return $this->error;
2822             // exception is not ajax friendly
2823             //throw new moodle_exception($this->error, 'curl');
2824         }
2825     }
2827     /**
2828      * HTTP HEAD method
2829      *
2830      * @see request()
2831      *
2832      * @param string $url
2833      * @param array $options
2834      * @return bool
2835      */
2836     public function head($url, $options = array()){
2837         $options['CURLOPT_HTTPGET'] = 0;
2838         $options['CURLOPT_HEADER']  = 1;
2839         $options['CURLOPT_NOBODY']  = 1;
2840         return $this->request($url, $options);
2841     }
2843     /**
2844      * HTTP POST method
2845      *
2846      * @param string $url
2847      * @param array|string $params
2848      * @param array $options
2849      * @return bool
2850      */
2851     public function post($url, $params = '', $options = array()){
2852         $options['CURLOPT_POST']       = 1;
2853         if (is_array($params)) {
2854             $this->_tmp_file_post_params = array();
2855             foreach ($params as $key => $value) {
2856                 if ($value instanceof stored_file) {
2857                     $value->add_to_curl_request($this, $key);
2858                 } else {
2859                     $this->_tmp_file_post_params[$key] = $value;
2860                 }
2861             }
2862             $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
2863             unset($this->_tmp_file_post_params);
2864         } else {
2865             // $params is the raw post data
2866             $options['CURLOPT_POSTFIELDS'] = $params;
2867         }
2868         return $this->request($url, $options);
2869     }
2871     /**
2872      * HTTP GET method
2873      *
2874      * @param string $url
2875      * @param array $params
2876      * @param array $options
2877      * @return bool
2878      */
2879     public function get($url, $params = array(), $options = array()){
2880         $options['CURLOPT_HTTPGET'] = 1;
2882         if (!empty($params)){
2883             $url .= (stripos($url, '?') !== false) ? '&' : '?';
2884             $url .= http_build_query($params, '', '&');
2885         }
2886         return $this->request($url, $options);
2887     }
2889     /**
2890      * HTTP PUT method
2891      *
2892      * @param string $url
2893      * @param array $params
2894      * @param array $options
2895      * @return bool
2896      */
2897     public function put($url, $params = array(), $options = array()){
2898         $file = $params['file'];
2899         if (!is_file($file)){
2900             return null;
2901         }
2902         $fp   = fopen($file, 'r');
2903         $size = filesize($file);
2904         $options['CURLOPT_PUT']        = 1;
2905         $options['CURLOPT_INFILESIZE'] = $size;
2906         $options['CURLOPT_INFILE']     = $fp;
2907         if (!isset($this->options['CURLOPT_USERPWD'])){
2908             $this->setopt(array('CURLOPT_USERPWD'=>'anonymous: noreply@moodle.org'));
2909         }
2910         $ret = $this->request($url, $options);
2911         fclose($fp);
2912         return $ret;
2913     }
2915     /**
2916      * HTTP DELETE method
2917      *
2918      * @param string $url
2919      * @param array $param
2920      * @param array $options
2921      * @return bool
2922      */
2923     public function delete($url, $param = array(), $options = array()){
2924         $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
2925         if (!isset($options['CURLOPT_USERPWD'])) {
2926             $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
2927         }
2928         $ret = $this->request($url, $options);
2929         return $ret;
2930     }
2932     /**
2933      * HTTP TRACE method
2934      *
2935      * @param string $url
2936      * @param array $options
2937      * @return bool
2938      */
2939     public function trace($url, $options = array()){
2940         $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
2941         $ret = $this->request($url, $options);
2942         return $ret;
2943     }
2945     /**
2946      * HTTP OPTIONS method
2947      *
2948      * @param string $url
2949      * @param array $options
2950      * @return bool
2951      */
2952     public function options($url, $options = array()){
2953         $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
2954         $ret = $this->request($url, $options);
2955         return $ret;
2956     }
2958     /**
2959      * Get curl information
2960      *
2961      * @return string
2962      */
2963     public function get_info() {
2964         return $this->info;
2965     }
2968 /**
2969  * This class is used by cURL class, use case:
2970  *
2971  * <code>
2972  * $CFG->repositorycacheexpire = 120;
2973  * $CFG->curlcache = 120;
2974  *
2975  * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
2976  * $ret = $c->get('http://www.google.com');
2977  * </code>
2978  *
2979  * @package   core_files
2980  * @copyright Dongsheng Cai <dongsheng@moodle.com>
2981  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2982  */
2983 class curl_cache {
2984     /** @var string Path to cache directory */
2985     public $dir = '';
2987     /**
2988      * Constructor
2989      *
2990      * @global stdClass $CFG
2991      * @param string $module which module is using curl_cache
2992      */
2993     function __construct($module = 'repository'){
2994         global $CFG;
2995         if (!empty($module)) {
2996             $this->dir = $CFG->cachedir.'/'.$module.'/';
2997         } else {
2998             $this->dir = $CFG->cachedir.'/misc/';
2999         }
3000         if (!file_exists($this->dir)) {
3001             mkdir($this->dir, $CFG->directorypermissions, true);
3002         }
3003         if ($module == 'repository') {
3004             if (empty($CFG->repositorycacheexpire)) {
3005                 $CFG->repositorycacheexpire = 120;
3006             }
3007             $this->ttl = $CFG->repositorycacheexpire;
3008         } else {
3009             if (empty($CFG->curlcache)) {
3010                 $CFG->curlcache = 120;
3011             }
3012             $this->ttl = $CFG->curlcache;
3013         }
3014     }
3016     /**
3017      * Get cached value
3018      *
3019      * @global stdClass $CFG
3020      * @global stdClass $USER
3021      * @param mixed $param
3022      * @return bool|string
3023      */
3024     public function get($param){
3025         global $CFG, $USER;
3026         $this->cleanup($this->ttl);
3027         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3028         if(file_exists($this->dir.$filename)) {
3029             $lasttime = filemtime($this->dir.$filename);
3030             if(time()-$lasttime > $this->ttl)
3031             {
3032                 return false;
3033             } else {
3034                 $fp = fopen($this->dir.$filename, 'r');
3035                 $size = filesize($this->dir.$filename);
3036                 $content = fread($fp, $size);
3037                 return unserialize($content);
3038             }
3039         }
3040         return false;
3041     }
3043     /**
3044      * Set cache value
3045      *
3046      * @global object $CFG
3047      * @global object $USER
3048      * @param mixed $param
3049      * @param mixed $val
3050      */
3051     public function set($param, $val){
3052         global $CFG, $USER;
3053         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3054         $fp = fopen($this->dir.$filename, 'w');
3055         fwrite($fp, serialize($val));
3056         fclose($fp);
3057     }
3059     /**
3060      * Remove cache files
3061      *
3062      * @param int $expire The number os seconds before expiry
3063      */
3064     public function cleanup($expire){
3065         if($dir = opendir($this->dir)){
3066             while (false !== ($file = readdir($dir))) {
3067                 if(!is_dir($file) && $file != '.' && $file != '..') {
3068                     $lasttime = @filemtime($this->dir.$file);
3069                     if(time() - $lasttime > $expire){
3070                         @unlink($this->dir.$file);
3071                     }
3072                 }
3073             }
3074         }
3075     }
3076     /**
3077      * delete current user's cache file
3078      *
3079      * @global object $CFG
3080      * @global object $USER
3081      */
3082     public function refresh(){
3083         global $CFG, $USER;
3084         if($dir = opendir($this->dir)){
3085             while (false !== ($file = readdir($dir))) {
3086                 if(!is_dir($file) && $file != '.' && $file != '..') {
3087                     if(strpos($file, 'u'.$USER->id.'_')!==false){
3088                         @unlink($this->dir.$file);
3089                     }
3090                 }
3091             }
3092         }
3093     }
3096 /**
3097  * This class is used to parse lib/file/file_types.mm which help get file extensions by file types.
3098  *
3099  * The file_types.mm file can be edited by freemind in graphic environment.
3100  *
3101  * @package   core_files
3102  * @category  files
3103  * @copyright 2009 Dongsheng Cai <dongsheng@moodle.com>
3104  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3105  */
3106 class filetype_parser {
3107     /**
3108      * Check file_types.mm file, setup variables
3109      *
3110      * @global stdClass $CFG
3111      * @param string $file
3112      */
3113     public function __construct($file = '') {
3114         global $CFG;
3115         if (empty($file)) {
3116             $this->file = $CFG->libdir.'/filestorage/file_types.mm';
3117         } else {
3118             $this->file = $file;
3119         }
3120         $this->tree = array();
3121         $this->result = array();
3122     }
3124     /**
3125      * A private function to browse xml nodes
3126      *
3127      * @param array $parent
3128      * @param array $types
3129      */
3130     private function _browse_nodes($parent, $types) {
3131         $key = (string)$parent['TEXT'];
3132         if(isset($parent->node)) {
3133             $this->tree[$key] = array();
3134             if (in_array((string)$parent['TEXT'], $types)) {
3135                 $this->_select_nodes($parent, $this->result);
3136             } else {
3137                 foreach($parent->node as $v){
3138                     $this->_browse_nodes($v, $types);
3139                 }
3140             }
3141         } else {
3142             $this->tree[] = $key;
3143         }
3144     }
3146     /**
3147      * A private function to select text nodes
3148      *
3149      * @param array $parent
3150      */
3151     private function _select_nodes($parent){
3152         if(isset($parent->node)) {
3153             foreach($parent->node as $v){
3154                 $this->_select_nodes($v, $this->result);
3155             }
3156         } else {
3157             $this->result[] = (string)$parent['TEXT'];
3158         }
3159     }
3162     /**
3163      * Get file extensions by file types names.
3164      *
3165      * @param array $types
3166      * @return mixed
3167      */
3168     public function get_extensions($types) {
3169         if (!is_array($types)) {
3170             $types = array($types);
3171         }
3172         $this->result = array();
3173         if ((is_array($types) && in_array('*', $types)) ||
3174             $types == '*' || empty($types)) {
3175             return array('*');
3176         }
3177         foreach ($types as $key=>$value){
3178             if (strpos($value, '.') !== false) {
3179                 $this->result[] = $value;
3180                 unset($types[$key]);
3181             }
3182         }
3183         if (file_exists($this->file)) {
3184             $xml = simplexml_load_file($this->file);
3185             foreach($xml->node->node as $v){
3186                 if (in_array((string)$v['TEXT'], $types)) {
3187                     $this->_select_nodes($v);
3188                 } else {
3189                     $this->_browse_nodes($v, $types);
3190                 }
3191             }
3192         } else {
3193             exit('Failed to open file lib/filestorage/file_types.mm');
3194         }
3195         return $this->result;
3196     }
3199 /**
3200  * This function delegates file serving to individual plugins
3201  *
3202  * @param string $relativepath
3203  * @param bool $forcedownload
3204  * @todo MDL-31088 file serving improments
3205  */
3206 function file_pluginfile($relativepath, $forcedownload) {
3207     global $DB, $CFG, $USER;
3208     // relative path must start with '/'
3209     if (!$relativepath) {
3210         print_error('invalidargorconf');
3211     } else if ($relativepath[0] != '/') {
3212         print_error('pathdoesnotstartslash');
3213     }
3215     // extract relative path components
3216     $args = explode('/', ltrim($relativepath, '/'));
3218     if (count($args) < 3) { // always at least context, component and filearea
3219         print_error('invalidarguments');
3220     }
3222     $contextid = (int)array_shift($args);
3223     $component = clean_param(array_shift($args), PARAM_COMPONENT);
3224     $filearea  = clean_param(array_shift($args), PARAM_AREA);
3226     list($context, $course, $cm) = get_context_info_array($contextid);
3228     $fs = get_file_storage();
3230     // ========================================================================================================================
3231     if ($component === 'blog') {
3232         // Blog file serving
3233         if ($context->contextlevel != CONTEXT_SYSTEM) {
3234             send_file_not_found();
3235         }
3236         if ($filearea !== 'attachment' and $filearea !== 'post') {
3237             send_file_not_found();
3238         }
3240         if (empty($CFG->bloglevel)) {
3241             print_error('siteblogdisable', 'blog');
3242         }
3244         $entryid = (int)array_shift($args);
3245         if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
3246             send_file_not_found();
3247         }
3248         if ($CFG->bloglevel < BLOG_GLOBAL_LEVEL) {
3249             require_login();
3250             if (isguestuser()) {
3251                 print_error('noguest');
3252             }
3253             if ($CFG->bloglevel == BLOG_USER_LEVEL) {
3254                 if ($USER->id != $entry->userid) {
3255                     send_file_not_found();
3256                 }
3257             }
3258         }
3260         if ('publishstate' === 'public') {
3261             if ($CFG->forcelogin) {
3262                 require_login();
3263             }
3265         } else if ('publishstate' === 'site') {
3266             require_login();
3267             //ok
3268         } else if ('publishstate' === 'draft') {
3269             require_login();
3270             if ($USER->id != $entry->userid) {
3271                 send_file_not_found();
3272             }
3273         }
3275         $filename = array_pop($args);
3276         $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3278         if (!$file = $fs->get_file($context->id, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
3279             send_file_not_found();
3280         }
3282         send_stored_file($file, 10*60, 0, true); // download MUST be forced - security!
3284     // ========================================================================================================================
3285     } else if ($component === 'grade') {
3286         if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel == CONTEXT_SYSTEM) {
3287             // Global gradebook files
3288             if ($CFG->forcelogin) {
3289                 require_login();
3290             }
3292             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3294             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3295                 send_file_not_found();
3296             }
3298             session_get_instance()->write_close(); // unlock session during fileserving
3299             send_stored_file($file, 60*60, 0, $forcedownload);
3301         } else if ($filearea === 'feedback' and $context->contextlevel == CONTEXT_COURSE) {
3302             //TODO: nobody implemented this yet in grade edit form!!
3303             send_file_not_found();
3305             if ($CFG->forcelogin || $course->id != SITEID) {
3306                 require_login($course);
3307             }
3309             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3311             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3312                 send_file_not_found();
3313             }
3315             session_get_instance()->write_close(); // unlock session during fileserving
3316             send_stored_file($file, 60*60, 0, $forcedownload);
3317         } else {
3318             send_file_not_found();
3319         }
3321     // ========================================================================================================================
3322     } else if ($component === 'tag') {
3323         if ($filearea === 'description' and $context->contextlevel == CONTEXT_SYSTEM) {
3325             // All tag descriptions are going to be public but we still need to respect forcelogin
3326             if ($CFG->forcelogin) {
3327                 require_login();
3328             }
3330             $fullpath = "/$context->id/tag/description/".implode('/', $args);
3332             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3333                 send_file_not_found();
3334             }
3336             session_get_instance()->write_close(); // unlock session during fileserving
3337             send_stored_file($file, 60*60, 0, true);
3339         } else {
3340             send_file_not_found();
3341         }
3343     // ========================================================================================================================
3344     } else if ($component === 'calendar') {
3345         if ($filearea === 'event_description'  and $context->contextlevel == CONTEXT_SYSTEM) {
3347             // All events here are public the one requirement is that we respect forcelogin
3348             if ($CFG->forcelogin) {
3349                 require_login();
3350             }
3352             // Get the event if from the args array
3353             $eventid = array_shift($args);
3355             // Load the event from the database
3356             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'eventtype'=>'site'))) {
3357                 send_file_not_found();
3358             }
3359             // Check that we got an event and that it's userid is that of the user
3361             // Get the file and serve if successful
3362             $filename = array_pop($args);
3363             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3364             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3365                 send_file_not_found();
3366             }
3368             session_get_instance()->write_close(); // unlock session during fileserving
3369             send_stored_file($file, 60*60, 0, $forcedownload);
3371         } else if ($filearea === 'event_description' and $context->contextlevel == CONTEXT_USER) {
3373             // Must be logged in, if they are not then they obviously can't be this user
3374             require_login();
3376             // Don't want guests here, potentially saves a DB call
3377             if (isguestuser()) {
3378                 send_file_not_found();
3379             }
3381             // Get the event if from the args array
3382             $eventid = array_shift($args);
3384             // Load the event from the database - user id must match
3385             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'userid'=>$USER->id, 'eventtype'=>'user'))) {
3386                 send_file_not_found();
3387             }
3389             // Get the file and serve if successful
3390             $filename = array_pop($args);
3391             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3392             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3393                 send_file_not_found();
3394             }
3396             session_get_instance()->write_close(); // unlock session during fileserving
3397             send_stored_file($file, 60*60, 0, $forcedownload);
3399         } else if ($filearea === 'event_description' and $context->contextlevel == CONTEXT_COURSE) {
3401             // Respect forcelogin and require login unless this is the site.... it probably
3402             // should NEVER be the site
3403             if ($CFG->forcelogin || $course->id != SITEID) {
3404                 require_login($course);
3405             }
3407             // Must be able to at least view the course
3408             if (!is_enrolled($context) and !is_viewing($context)) {
3409                 //TODO: hmm, do we really want to block guests here?
3410                 send_file_not_found();
3411             }
3413             // Get the event id
3414             $eventid = array_shift($args);
3416             // Load the event from the database we need to check whether it is
3417             // a) valid course event
3418             // b) a group event
3419             // Group events use the course context (there is no group context)
3420             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'courseid'=>$course->id))) {
3421                 send_file_not_found();
3422             }
3424             // If its a group event require either membership of view all groups capability
3425             if ($event->eventtype === 'group') {
3426                 if (!has_capability('moodle/site:accessallgroups', $context) && !groups_is_member($event->groupid, $USER->id)) {
3427                     send_file_not_found();
3428                 }
3429             } else if ($event->eventtype === 'course') {
3430                 //ok
3431             } else {
3432                 // some other type
3433                 send_file_not_found();
3434             }
3436             // If we get this far we can serve the file
3437             $filename = array_pop($args);
3438             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3439             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3440                 send_file_not_found();
3441             }
3443             session_get_instance()->write_close(); // unlock session during fileserving
3444             send_stored_file($file, 60*60, 0, $forcedownload);
3446         } else {
3447             send_file_not_found();
3448         }
3450     // ========================================================================================================================
3451     } else if ($component === 'user') {
3452         if ($filearea === 'icon' and $context->contextlevel == CONTEXT_USER) {
3453             $redirect = false;
3454             if (count($args) == 1) {
3455                 $themename = theme_config::DEFAULT_THEME;
3456                 $filename = array_shift($args);
3457             } else {
3458                 $themename = array_shift($args);
3459                 $filename = array_shift($args);
3460             }
3461             if ((!empty($CFG->forcelogin) and !isloggedin()) ||
3462                     (!empty($CFG->forceloginforprofileimage) && (!isloggedin() || isguestuser()))) {
3463                 // protect images if login required and not logged in;
3464                 // also if login is required for profile images and is not logged in or guest
3465                 // do not use require_login() because it is expensive and not suitable here anyway
3466                 $redirect = true;
3467             }
3468             if (!$redirect and ($filename !== 'f1' and $filename !== 'f2')) {
3469                 $filename = 'f1';
3470                 $redirect = true;
3471             }
3472             if (!$redirect && !$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', $filename.'/.png')) {
3473                 if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', $filename.'/.jpg')) {
3474                     $redirect = true;
3475                 }
3476             }
3477             if ($redirect) {
3478                 $theme = theme_config::load($themename);
3479                 redirect($theme->pix_url('u/'.$filename, 'moodle'));
3480             }
3481             send_stored_file($file, 60*60*24); // enable long caching, there are many images on each page
3483         } else if ($filearea === 'private' and $context->contextlevel == CONTEXT_USER) {
3484             require_login();
3486             if (isguestuser()) {
3487                 send_file_not_found();
3488             }
3490             if ($USER->id !== $context->instanceid) {
3491                 send_file_not_found();
3492             }
3494             $filename = array_pop($args);
3495             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3496             if (!$file = $fs->get_file($context->id, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
3497                 send_file_not_found();
3498             }
3500             session_get_instance()->write_close(); // unlock session during fileserving
3501             send_stored_file($file, 0, 0, true); // must force download - security!
3503         } else if ($filearea === 'profile' and $context->contextlevel == CONTEXT_USER) {
3505             if ($CFG->forcelogin) {
3506                 require_login();
3507             }
3509             $userid = $context->instanceid;
3511             if ($USER->id == $userid) {
3512                 // always can access own
3514             } else if (!empty($CFG->forceloginforprofiles)) {
3515                 require_login();
3517                 if (isguestuser()) {
3518                     send_file_not_found();
3519                 }
3521                 // we allow access to site profile of all course contacts (usually teachers)
3522                 if (!has_coursecontact_role($userid) && !has_capability('moodle/user:viewdetails', $context)) {
3523                     send_file_not_found();
3524                 }
3526                 $canview = false;
3527                 if (has_capability('moodle/user:viewdetails', $context)) {
3528                     $canview = true;
3529                 } else {
3530                     $courses = enrol_get_my_courses();
3531                 }
3533                 while (!$canview && count($courses) > 0) {
3534                     $course = array_shift($courses);
3535                     if (has_capability('moodle/user:viewdetails', get_context_instance(CONTEXT_COURSE, $course->id))) {
3536                         $canview = true;
3537                     }
3538                 }
3539             }
3541             $filename = array_pop($args);
3542             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3543             if (!$file = $fs->get_file($context->id, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
3544                 send_file_not_found();
3545             }
3547             session_get_instance()->write_close(); // unlock session during fileserving
3548             send_stored_file($file, 0, 0, true); // must force download - security!
3550         } else if ($filearea === 'profile' and $context->contextlevel == CONTEXT_COURSE) {
3551             $userid = (int)array_shift($args);
3552             $usercontext = get_context_instance(CONTEXT_USER, $userid);
3554             if ($CFG->forcelogin) {
3555                 require_login();
3556             }
3558             if (!empty($CFG->forceloginforprofiles)) {
3559                 require_login();
3560                 if (isguestuser()) {
3561                     print_error('noguest');
3562                 }
3564                 //TODO: review this logic of user profile access prevention
3565                 if (!has_coursecontact_role($userid) and !has_capability('moodle/user:viewdetails', $usercontext)) {
3566                     print_error('usernotavailable');
3567                 }
3568                 if (!has_capability('moodle/user:viewdetails', $context) && !has_capability('moodle/user:viewdetails', $usercontext)) {
3569                     print_error('cannotviewprofile');
3570                 }
3571                 if (!is_enrolled($context, $userid)) {
3572                     print_error('notenrolledprofile');
3573                 }
3574                 if (groups_get_course_groupmode($course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3575                     print_error('groupnotamember');
3576                 }
3577             }
3579             $filename = array_pop($args);
3580             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3581             if (!$file = $fs->get_file($usercontext->id, 'user', 'profile', 0, $filepath, $filename) or $file->is_directory()) {
3582                 send_file_not_found();
3583             }
3585             session_get_instance()->write_close(); // unlock session during fileserving
3586             send_stored_file($file, 0, 0, true); // must force download - security!
3588         } else if ($filearea === 'backup' and $context->contextlevel == CONTEXT_USER) {
3589             require_login();
3591             if (isguestuser()) {
3592                 send_file_not_found();
3593             }
3594             $userid = $context->instanceid;
3596             if ($USER->id != $userid) {
3597                 send_file_not_found();
3598             }
3600             $filename = array_pop($args);
3601             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3602             if (!$file = $fs->get_file($context->id, 'user', 'backup', 0, $filepath, $filename) or $file->is_directory()) {
3603                 send_file_not_found();
3604             }
3606             session_get_instance()->write_close(); // unlock session during fileserving
3607             send_stored_file($file, 0, 0, true); // must force download - security!
3609         } else {
3610             send_file_not_found();
3611         }
3613     // ========================================================================================================================
3614     } else if ($component === 'coursecat') {
3615         if ($context->contextlevel != CONTEXT_COURSECAT) {
3616             send_file_not_found();
3617         }
3619         if ($filearea === 'description') {
3620             if ($CFG->forcelogin) {
3621                 // no login necessary - unless login forced everywhere
3622                 require_login();
3623             }
3625             $filename = array_pop($args);
3626             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3627             if (!$file = $fs->get_file($context->id, 'coursecat', 'description', 0, $filepath, $filename) or $file->is_directory()) {
3628                 send_file_not_found();
3629             }
3631             session_get_instance()->write_close(); // unlock session during fileserving
3632             send_stored_file($file, 60*60, 0, $forcedownload);
3633         } else {
3634             send_file_not_found();
3635         }
3637     // ========================================================================================================================
3638     } else if ($component === 'course') {
3639         if ($context->contextlevel != CONTEXT_COURSE) {
3640             send_file_not_found();
3641         }
3643         if ($filearea === 'summary') {
3644             if ($CFG->forcelogin) {
3645                 require_login();
3646             }
3648             $filename = array_pop($args);
3649             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3650             if (!$file = $fs->get_file($context->id, 'course', 'summary', 0, $filepath, $filename) or $file->is_directory()) {
3651                 send_file_not_found();
3652             }
3654             session_get_instance()->write_close(); // unlock session during fileserving
3655             send_stored_file($file, 60*60, 0, $forcedownload);
3657         } else if ($filearea === 'section') {
3658             if ($CFG->forcelogin) {
3659                 require_login($course);
3660             } else if ($course->id != SITEID) {
3661                 require_login($course);
3662             }
3664             $sectionid = (int)array_shift($args);
3666             if (!$section = $DB->get_record('course_sections', array('id'=>$sectionid, 'course'=>$course->id))) {
3667                 send_file_not_found();
3668             }
3670             if ($course->numsections < $section->section) {
3671                 if (!has_capability('moodle/course:update', $context)) {
3672                     // block access to unavailable sections if can not edit course
3673                     send_file_not_found();
3674                 }
3675             }
3677             $filename = array_pop($args);
3678             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3679             if (!$file = $fs->get_file($context->id, 'course', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
3680                 send_file_not_found();
3681             }
3683             session_get_instance()->write_close(); // unlock session during fileserving
3684             send_stored_file($file, 60*60, 0, $forcedownload);
3686         } else {
3687             send_file_not_found();
3688         }
3690     } else if ($component === 'group') {
3691         if ($context->contextlevel != CONTEXT_COURSE) {
3692             send_file_not_found();
3693         }
3695         require_course_login($course, true, null, false);
3697         $groupid = (int)array_shift($args);
3699         $group = $DB->get_record('groups', array('id'=>$groupid, 'courseid'=>$course->id), '*', MUST_EXIST);
3700         if (($course->groupmodeforce and $course->groupmode == SEPARATEGROUPS) and !has_capability('moodle/site:accessallgroups', $context) and !groups_is_member($group->id, $USER->id)) {
3701             // do not allow access to separate group info if not member or teacher
3702             send_file_not_found();
3703         }
3705         if ($filearea === 'description') {
3707             require_login($course);
3709             $filename = array_pop($args);
3710             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3711             if (!$file = $fs->get_file($context->id, 'group', 'description', $group->id, $filepath, $filename) or $file->is_directory()) {
3712                 send_file_not_found();
3713             }
3715             session_get_instance()->write_close(); // unlock session during fileserving
3716             send_stored_file($file, 60*60, 0, $forcedownload);
3718         } else if ($filearea === 'icon') {
3719             $filename = array_pop($args);
3721             if ($filename !== 'f1' and $filename !== 'f2') {
3722                 send_file_not_found();
3723             }
3724             if (!$file = $fs->get_file($context->id, 'group', 'icon', $group->id, '/', $filename.'.png')) {
3725                 if (!$file = $fs->get_file($context->id, 'group', 'icon', $group->id, '/', $filename.'.jpg')) {
3726                     send_file_not_found();
3727                 }
3728             }
3730             session_get_instance()->write_close(); // unlock session during fileserving
3731             send_stored_file($file, 60*60);
3733         } else {
3734             send_file_not_found();
3735         }
3737     } else if ($component === 'grouping') {
3738         if ($context->contextlevel != CONTEXT_COURSE) {
3739             send_file_not_found();
3740         }
3742         require_login($course);
3744         $groupingid = (int)array_shift($args);
3746         // note: everybody has access to grouping desc images for now
3747         if ($filearea === 'description') {
3749             $filename = array_pop($args);
3750             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3751             if (!$file = $fs->get_file($context->id, 'grouping', 'description', $groupingid, $filepath, $filename) or $file->is_directory()) {
3752                 send_file_not_found();
3753             }
3755             session_get_instance()->write_close(); // unlock session during fileserving
3756             send_stored_file($file, 60*60, 0, $forcedownload);
3758         } else {
3759             send_file_not_found();
3760         }
3762     // ========================================================================================================================
3763     } else if ($component === 'backup') {
3764         if ($filearea === 'course' and $context->contextlevel == CONTEXT_COURSE) {
3765             require_login($course);
3766             require_capability('moodle/backup:downloadfile', $context);
3768             $filename = array_pop($args);
3769             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3770             if (!$file = $fs->get_file($context->id, 'backup', 'course', 0, $filepath, $filename) or $file->is_directory()) {
3771                 send_file_not_found();
3772             }
3774             session_get_instance()->write_close(); // unlock session during fileserving
3775             send_stored_file($file, 0, 0, $forcedownload);
3777         } else if ($filearea === 'section' and $context->contextlevel == CONTEXT_COURSE) {
3778             require_login($course);
3779             require_capability('moodle/backup:downloadfile', $context);
3781             $sectionid = (int)array_shift($args);
3783             $filename = array_pop($args);
3784             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3785             if (!$file = $fs->get_file($context->id, 'backup', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
3786                 send_file_not_found();
3787             }
3789             session_get_instance()->write_close();
3790             send_stored_file($file, 60*60, 0, $forcedownload);
3792         } else if ($filearea === 'activity' and $context->contextlevel == CONTEXT_MODULE) {
3793             require_login($course, false, $cm);
3794             require_capability('moodle/backup:downloadfile', $context);
3796             $filename = array_pop($args);
3797             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3798             if (!$file = $fs->get_file($context->id, 'backup', 'activity', 0, $filepath, $filename) or $file->is_directory()) {
3799                 send_file_not_found();
3800             }
3802             session_get_instance()->write_close();
3803             send_stored_file($file, 60*60, 0, $forcedownload);
3805         } else if ($filearea === 'automated' and $context->contextlevel == CONTEXT_COURSE) {
3806             // Backup files that were generated by the automated backup systems.
3808             require_login($course);
3809             require_capability('moodle/site:config', $context);
3811             $filename = array_pop($args);
3812             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3813             if (!$file = $fs->get_file($context->id, 'backup', 'automated', 0, $filepath, $filename) or $file->is_directory()) {
3814                 send_file_not_found();
3815             }
3817             session_get_instance()->write_close(); // unlock session during fileserving
3818             send_stored_file($file, 0, 0, $forcedownload);
3820         } else {
3821             send_file_not_found();
3822         }
3824     // ========================================================================================================================
3825     } else if ($component === 'question') {
3826         require_once($CFG->libdir . '/questionlib.php');
3827         question_pluginfile($course, $context, 'question', $filearea, $args, $forcedownload);
3828         send_file_not_found();
3830     // ========================================================================================================================
3831     } else if ($component === 'grading') {
3832         if ($filearea === 'description') {
3833             // files embedded into the form definition description
3835             if ($context->contextlevel == CONTEXT_SYSTEM) {
3836                 require_login();
3838             } else if ($context->contextlevel >= CONTEXT_COURSE) {
3839                 require_login($course, false, $cm);
3841             } else {
3842                 send_file_not_found();
3843             }
3845             $formid = (int)array_shift($args);
3847             $sql = "SELECT ga.id
3848                 FROM {grading_areas} ga
3849                 JOIN {grading_definitions} gd ON (gd.areaid = ga.id)
3850                 WHERE gd.id = ? AND ga.contextid = ?";
3851             $areaid = $DB->get_field_sql($sql, array($formid, $context->id), IGNORE_MISSING);
3853             if (!$areaid) {
3854                 send_file_not_found();
3855             }
3857             $fullpath = "/$context->id/$component/$filearea/$formid/".implode('/', $args);
3859             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3860                 send_file_not_found();
3861             }
3863             session_get_instance()->write_close(); // unlock session during fileserving
3864             send_stored_file($file, 60*60, 0, $forcedownload);
3865         }
3867         // ========================================================================================================================
3868     } else if (strpos($component, 'mod_') === 0) {
3869         $modname = substr($component, 4);
3870         if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
3871             send_file_not_found();
3872         }
3873         require_once("$CFG->dirroot/mod/$modname/lib.php");
3875         if ($context->contextlevel == CONTEXT_MODULE) {
3876             if ($cm->modname !== $modname) {
3877                 // somebody tries to gain illegal access, cm type must match the component!
3878                 send_file_not_found();
3879             }
3880         }
3882         if ($filearea === 'intro') {
3883             if (!plugin_supports('mod', $modname, FEATURE_MOD_INTRO, true)) {
3884                 send_file_not_found();
3885             }
3886             require_course_login($course, true, $cm);
3888             // all users may access it
3889             $filename = array_pop($args);
3890             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3891             if (!$file = $fs->get_file($context->id, 'mod_'.$modname, 'intro', 0, $filepath, $filename) or $file->is_directory()) {
3892                 send_file_not_found();
3893             }
3895             $lifetime = isset($CFG->filelifetime) ? $CFG->filelifetime : 86400;
3897             // finally send the file
3898             send_stored_file($file, $lifetime, 0);
3899         }
3901         $filefunction = $component.'_pluginfile';
3902         $filefunctionold = $modname.'_pluginfile';
3903         if (function_exists($filefunction)) {
3904             // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
3905             $filefunction($course, $cm, $context, $filearea, $args, $forcedownload);
3906         } else if (function_exists($filefunctionold)) {
3907             // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
3908             $filefunctionold($course, $cm, $context, $filearea, $args, $forcedownload);
3909         }
3911         send_file_not_found();
3913     // ========================================================================================================================
3914     } else if (strpos($component, 'block_') === 0) {
3915         $blockname = substr($component, 6);
3916         // note: no more class methods in blocks please, that is ....
3917         if (!file_exists("$CFG->dirroot/blocks/$blockname/lib.php")) {
3918             send_file_not_found();
3919         }
3920         require_once("$CFG->dirroot/blocks/$blockname/lib.php");
3922         if ($context->contextlevel == CONTEXT_BLOCK) {
3923             $birecord = $DB->get_record('block_instances', array('id'=>$context->instanceid), '*',MUST_EXIST);
3924             if ($birecord->blockname !== $blockname) {
3925                 // somebody tries to gain illegal access, cm type must match the component!
3926                 send_file_not_found();
3927             }
3928         } else {
3929             $birecord = null;
3930         }
3932         $filefunction = $component.'_pluginfile';
3933         if (function_exists($filefunction)) {
3934             // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
3935             $filefunction($course, $birecord, $context, $filearea, $args, $forcedownload);
3936         }
3938         send_file_not_found();
3940     } else if (strpos($component, '_') === false) {
3941         // all core subsystems have to be specified above, no more guessing here!
3942         send_file_not_found();
3944     } else {
3945         // try to serve general plugin file in arbitrary context
3946         $dir = get_component_directory($component);
3947         if (!file_exists("$dir/lib.php")) {
3948             send_file_not_found();
3949         }
3950         include_once("$dir/lib.php");
3952         $filefunction = $component.'_pluginfile';
3953         if (function_exists($filefunction)) {
3954             // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
3955             $filefunction($course, $cm, $context, $filearea, $args, $forcedownload);
3956         }
3958         send_file_not_found();
3959     }