bf9d9cf87016d4d282b4ecd275defc6cb2f6f0bc
[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 = context_user::instance($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 = context_user::instance($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                 $draftfile = $fs->create_file_from_storedfile($file_record, $file);
378                 // XXX: This is a hack for file manager (MDL-28666)
379                 // File manager needs to know the original file information before copying
380                 // to draft area, so we append these information in mdl_files.source field
381                 // {@link file_storage::search_references()}
382                 // {@link file_storage::search_references_count()}
383                 $sourcefield = $file->get_source();
384                 $newsourcefield = new stdClass;
385                 $newsourcefield->source = $sourcefield;
386                 $original = new stdClass;
387                 $original->contextid = $contextid;
388                 $original->component = $component;
389                 $original->filearea  = $filearea;
390                 $original->itemid    = $itemid;
391                 $original->filename  = $file->get_filename();
392                 $original->filepath  = $file->get_filepath();
393                 $newsourcefield->original = file_storage::pack_reference($original);
394                 $draftfile->set_source(serialize($newsourcefield));
395                 // End of file manager hack
396             }
397         }
398         if (!is_null($text)) {
399             // at this point there should not be any draftfile links yet,
400             // because this is a new text from database that should still contain the @@pluginfile@@ links
401             // this happens when developers forget to post process the text
402             $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
403         }
404     } else {
405         // nothing to do
406     }
408     if (is_null($text)) {
409         return null;
410     }
412     // relink embedded files - editor can not handle @@PLUGINFILE@@ !
413     return file_rewrite_pluginfile_urls($text, 'draftfile.php', $usercontext->id, 'user', 'draft', $draftitemid, $options);
416 /**
417  * Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
418  *
419  * @category files
420  * @global stdClass $CFG
421  * @param string $text The content that may contain ULRs in need of rewriting.
422  * @param string $file The script that should be used to serve these files. pluginfile.php, draftfile.php, etc.
423  * @param int $contextid This parameter and the next two identify the file area to use.
424  * @param string $component
425  * @param string $filearea helps identify the file area.
426  * @param int $itemid helps identify the file area.
427  * @param array $options text and file options ('forcehttps'=>false)
428  * @return string the processed text.
429  */
430 function file_rewrite_pluginfile_urls($text, $file, $contextid, $component, $filearea, $itemid, array $options=null) {
431     global $CFG;
433     $options = (array)$options;
434     if (!isset($options['forcehttps'])) {
435         $options['forcehttps'] = false;
436     }
438     if (!$CFG->slasharguments) {
439         $file = $file . '?file=';
440     }
442     $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
444     if ($itemid !== null) {
445         $baseurl .= "$itemid/";
446     }
448     if ($options['forcehttps']) {
449         $baseurl = str_replace('http://', 'https://', $baseurl);
450     }
452     return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
455 /**
456  * Returns information about files in a draft area.
457  *
458  * @global stdClass $CFG
459  * @global stdClass $USER
460  * @param int $draftitemid the draft area item id.
461  * @return array with the following entries:
462  *      'filecount' => number of files in the draft area.
463  * (more information will be added as needed).
464  */
465 function file_get_draft_area_info($draftitemid) {
466     global $CFG, $USER;
468     $usercontext = context_user::instance($USER->id);
469     $fs = get_file_storage();
471     $results = array();
473     // The number of files
474     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id', false);
475     $results['filecount'] = count($draftfiles);
476     $results['filesize'] = 0;
477     foreach ($draftfiles as $file) {
478         $results['filesize'] += $file->get_filesize();
479     }
481     return $results;
484 /**
485  * Returns whether a draft area has exceeded/will exceed its size limit.
486  *
487  * @param int $draftitemid the draft area item id.
488  * @param int $areamaxbytes the maximum size allowed in this draft area.
489  * @param int $newfilesize the size that would be added to the current area.
490  * @return bool true if the area will/has exceeded its limit.
491  * @since 2.4
492  */
493 function file_is_draft_area_limit_reached($draftitemid, $areamaxbytes, $newfilesize = 0) {
494     if ($areamaxbytes != -1) {
495         $draftinfo = file_get_draft_area_info($draftitemid);
496         if ($draftinfo['filesize'] + $newfilesize > $areamaxbytes) {
497             return true;
498         }
499     }
500     return false;
503 /**
504  * Get used space of files
505  * @global moodle_database $DB
506  * @global stdClass $USER
507  * @return int total bytes
508  */
509 function file_get_user_used_space() {
510     global $DB, $USER;
512     $usercontext = context_user::instance($USER->id);
513     $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
514             JOIN (SELECT contenthash, filename, MAX(id) AS id
515             FROM {files}
516             WHERE contextid = ? AND component = ? AND filearea != ?
517             GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
518     $params = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft');
519     $record = $DB->get_record_sql($sql, $params);
520     return (int)$record->totalbytes;
523 /**
524  * Convert any string to a valid filepath
525  * @todo review this function
526  * @param string $str
527  * @return string path
528  */
529 function file_correct_filepath($str) { //TODO: what is this? (skodak)
530     if ($str == '/' or empty($str)) {
531         return '/';
532     } else {
533         return '/'.trim($str, './@#$ ').'/';
534     }
537 /**
538  * Generate a folder tree of draft area of current USER recursively
539  *
540  * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
541  * @param int $draftitemid
542  * @param string $filepath
543  * @param mixed $data
544  */
545 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
546     global $USER, $OUTPUT, $CFG;
547     $data->children = array();
548     $context = context_user::instance($USER->id);
549     $fs = get_file_storage();
550     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
551         foreach ($files as $file) {
552             if ($file->is_directory()) {
553                 $item = new stdClass();
554                 $item->sortorder = $file->get_sortorder();
555                 $item->filepath = $file->get_filepath();
557                 $foldername = explode('/', trim($item->filepath, '/'));
558                 $item->fullname = trim(array_pop($foldername), '/');
560                 $item->id = uniqid();
561                 file_get_drafarea_folders($draftitemid, $item->filepath, $item);
562                 $data->children[] = $item;
563             } else {
564                 continue;
565             }
566         }
567     }
570 /**
571  * Listing all files (including folders) in current path (draft area)
572  * used by file manager
573  * @param int $draftitemid
574  * @param string $filepath
575  * @return stdClass
576  */
577 function file_get_drafarea_files($draftitemid, $filepath = '/') {
578     global $USER, $OUTPUT, $CFG;
580     $context = context_user::instance($USER->id);
581     $fs = get_file_storage();
583     $data = new stdClass();
584     $data->path = array();
585     $data->path[] = array('name'=>get_string('files'), 'path'=>'/');
587     // will be used to build breadcrumb
588     $trail = '/';
589     if ($filepath !== '/') {
590         $filepath = file_correct_filepath($filepath);
591         $parts = explode('/', $filepath);
592         foreach ($parts as $part) {
593             if ($part != '' && $part != null) {
594                 $trail .= ($part.'/');
595                 $data->path[] = array('name'=>$part, 'path'=>$trail);
596             }
597         }
598     }
600     $list = array();
601     $maxlength = 12;
602     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
603         foreach ($files as $file) {
604             $item = new stdClass();
605             $item->filename = $file->get_filename();
606             $item->filepath = $file->get_filepath();
607             $item->fullname = trim($item->filename, '/');
608             $filesize = $file->get_filesize();
609             $item->size = $filesize ? $filesize : null;
610             $item->filesize = $filesize ? display_size($filesize) : '';
612             $item->sortorder = $file->get_sortorder();
613             $item->author = $file->get_author();
614             $item->license = $file->get_license();
615             $item->datemodified = $file->get_timemodified();
616             $item->datecreated = $file->get_timecreated();
617             $item->isref = $file->is_external_file();
618             if ($item->isref && $file->get_status() == 666) {
619                 $item->originalmissing = true;
620             }
621             // find the file this draft file was created from and count all references in local
622             // system pointing to that file
623             $source = @unserialize($file->get_source());
624             if (isset($source->original)) {
625                 $item->refcount = $fs->search_references_count($source->original);
626             }
628             if ($file->is_directory()) {
629                 $item->filesize = 0;
630                 $item->icon = $OUTPUT->pix_url(file_folder_icon(24))->out(false);
631                 $item->type = 'folder';
632                 $foldername = explode('/', trim($item->filepath, '/'));
633                 $item->fullname = trim(array_pop($foldername), '/');
634                 $item->thumbnail = $OUTPUT->pix_url(file_folder_icon(90))->out(false);
635             } else {
636                 // do NOT use file browser here!
637                 $item->mimetype = get_mimetype_description($file);
638                 if (file_extension_in_typegroup($file->get_filename(), 'archive')) {
639                     $item->type = 'zip';
640                 } else {
641                     $item->type = 'file';
642                 }
643                 $itemurl = moodle_url::make_draftfile_url($draftitemid, $item->filepath, $item->filename);
644                 $item->url = $itemurl->out();
645                 $item->icon = $OUTPUT->pix_url(file_file_icon($file, 24))->out(false);
646                 $item->thumbnail = $OUTPUT->pix_url(file_file_icon($file, 90))->out(false);
647                 if ($imageinfo = $file->get_imageinfo()) {
648                     $item->realthumbnail = $itemurl->out(false, array('preview' => 'thumb', 'oid' => $file->get_timemodified()));
649                     $item->realicon = $itemurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
650                     $item->image_width = $imageinfo['width'];
651                     $item->image_height = $imageinfo['height'];
652                 }
653             }
654             $list[] = $item;
655         }
656     }
657     $data->itemid = $draftitemid;
658     $data->list = $list;
659     return $data;
662 /**
663  * Returns draft area itemid for a given element.
664  *
665  * @category files
666  * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
667  * @return int the itemid, or 0 if there is not one yet.
668  */
669 function file_get_submitted_draft_itemid($elname) {
670     // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
671     if (!isset($_REQUEST[$elname])) {
672         return 0;
673     }
674     if (is_array($_REQUEST[$elname])) {
675         $param = optional_param_array($elname, 0, PARAM_INT);
676         if (!empty($param['itemid'])) {
677             $param = $param['itemid'];
678         } else {
679             debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER);
680             return false;
681         }
683     } else {
684         $param = optional_param($elname, 0, PARAM_INT);
685     }
687     if ($param) {
688         require_sesskey();
689     }
691     return $param;
694 /**
695  * Restore the original source field from draft files
696  *
697  * @param stored_file $storedfile This only works with draft files
698  * @return stored_file
699  */
700 function file_restore_source_field_from_draft_file($storedfile) {
701     $source = @unserialize($storedfile->get_source());
702     if (!empty($source)) {
703         if (is_object($source)) {
704             $restoredsource = $source->source;
705             $storedfile->set_source($restoredsource);
706         } else {
707             throw new moodle_exception('invalidsourcefield', 'error');
708         }
709     }
710     return $storedfile;
712 /**
713  * Saves files from a draft file area to a real one (merging the list of files).
714  * Can rewrite URLs in some content at the same time if desired.
715  *
716  * @category files
717  * @global stdClass $USER
718  * @param int $draftitemid the id of the draft area to use. Normally obtained
719  *      from file_get_submitted_draft_itemid('elementname') or similar.
720  * @param int $contextid This parameter and the next two identify the file area to save to.
721  * @param string $component
722  * @param string $filearea indentifies the file area.
723  * @param int $itemid helps identifies the file area.
724  * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
725  * @param string $text some html content that needs to have embedded links rewritten
726  *      to the @@PLUGINFILE@@ form for saving in the database.
727  * @param bool $forcehttps force https urls.
728  * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
729  */
730 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
731     global $USER;
733     $usercontext = context_user::instance($USER->id);
734     $fs = get_file_storage();
736     $options = (array)$options;
737     if (!isset($options['subdirs'])) {
738         $options['subdirs'] = false;
739     }
740     if (!isset($options['maxfiles'])) {
741         $options['maxfiles'] = -1; // unlimited
742     }
743     if (!isset($options['maxbytes']) || $options['maxbytes'] == USER_CAN_IGNORE_FILE_SIZE_LIMITS) {
744         $options['maxbytes'] = 0; // unlimited
745     }
746     $allowreferences = true;
747     if (isset($options['return_types']) && !($options['return_types'] & FILE_REFERENCE)) {
748         // we assume that if $options['return_types'] is NOT specified, we DO allow references.
749         // this is not exactly right. BUT there are many places in code where filemanager options
750         // are not passed to file_save_draft_area_files()
751         $allowreferences = false;
752     }
754     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
755     $oldfiles   = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
757     if (count($draftfiles) < 2) {
758         // means there are no files - one file means root dir only ;-)
759         $fs->delete_area_files($contextid, $component, $filearea, $itemid);
761     } else if (count($oldfiles) < 2) {
762         $filecount = 0;
763         // there were no files before - one file means root dir only ;-)
764         foreach ($draftfiles as $file) {
765             $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
766             if (!$options['subdirs']) {
767                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
768                     continue;
769                 }
770             }
771             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
772                 // oversized file - should not get here at all
773                 continue;
774             }
775             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
776                 // more files - should not get here at all
777                 break;
778             }
779             if (!$file->is_directory()) {
780                 $filecount++;
781             }
783             if ($file->is_external_file()) {
784                 if (!$allowreferences) {
785                     continue;
786                 }
787                 $repoid = $file->get_repository_id();
788                 if (!empty($repoid)) {
789                     $file_record['repositoryid'] = $repoid;
790                     $file_record['reference'] = $file->get_reference();
791                 }
792             }
793             file_restore_source_field_from_draft_file($file);
795             $fs->create_file_from_storedfile($file_record, $file);
796         }
798     } else {
799         // we have to merge old and new files - we want to keep file ids for files that were not changed
800         // we change time modified for all new and changed files, we keep time created as is
802         $newhashes = array();
803         foreach ($draftfiles as $file) {
804             $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
805             file_restore_source_field_from_draft_file($file);
806             $newhashes[$newhash] = $file;
807         }
808         $filecount = 0;
809         foreach ($oldfiles as $oldfile) {
810             $oldhash = $oldfile->get_pathnamehash();
811             if (!isset($newhashes[$oldhash])) {
812                 // delete files not needed any more - deleted by user
813                 $oldfile->delete();
814                 continue;
815             }
817             $newfile = $newhashes[$oldhash];
818             // status changed, we delete old file, and create a new one
819             if ($oldfile->get_status() != $newfile->get_status()) {
820                 // file was changed, use updated with new timemodified data
821                 $oldfile->delete();
822                 // This file will be added later
823                 continue;
824             }
826             // Updated author
827             if ($oldfile->get_author() != $newfile->get_author()) {
828                 $oldfile->set_author($newfile->get_author());
829             }
830             // Updated license
831             if ($oldfile->get_license() != $newfile->get_license()) {
832                 $oldfile->set_license($newfile->get_license());
833             }
835             // Updated file source
836             if ($oldfile->get_source() != $newfile->get_source()) {
837                 $oldfile->set_source($newfile->get_source());
838             }
840             // Updated sort order
841             if ($oldfile->get_sortorder() != $newfile->get_sortorder()) {
842                 $oldfile->set_sortorder($newfile->get_sortorder());
843             }
845             // Update file timemodified
846             if ($oldfile->get_timemodified() != $newfile->get_timemodified()) {
847                 $oldfile->set_timemodified($newfile->get_timemodified());
848             }
850             // Replaced file content
851             if ($oldfile->get_contenthash() != $newfile->get_contenthash() || $oldfile->get_filesize() != $newfile->get_filesize()) {
852                 $oldfile->replace_content_with($newfile);
853                 // push changes to all local files that are referencing this file
854                 $fs->update_references_to_storedfile($oldfile);
855             }
857             // unchanged file or directory - we keep it as is
858             unset($newhashes[$oldhash]);
859             if (!$oldfile->is_directory()) {
860                 $filecount++;
861             }
862         }
864         // Add fresh file or the file which has changed status
865         // the size and subdirectory tests are extra safety only, the UI should prevent it
866         foreach ($newhashes as $file) {
867             $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
868             if (!$options['subdirs']) {
869                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
870                     continue;
871                 }
872             }
873             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
874                 // oversized file - should not get here at all
875                 continue;
876             }
877             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
878                 // more files - should not get here at all
879                 break;
880             }
881             if (!$file->is_directory()) {
882                 $filecount++;
883             }
885             if ($file->is_external_file()) {
886                 if (!$allowreferences) {
887                     continue;
888                 }
889                 $repoid = $file->get_repository_id();
890                 if (!empty($repoid)) {
891                     $file_record['repositoryid'] = $repoid;
892                     $file_record['reference'] = $file->get_reference();
893                 }
894             }
896             $fs->create_file_from_storedfile($file_record, $file);
897         }
898     }
900     // note: do not purge the draft area - we clean up areas later in cron,
901     //       the reason is that user might press submit twice and they would loose the files,
902     //       also sometimes we might want to use hacks that save files into two different areas
904     if (is_null($text)) {
905         return null;
906     } else {
907         return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
908     }
911 /**
912  * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
913  * ready to be saved in the database. Normally, this is done automatically by
914  * {@link file_save_draft_area_files()}.
915  *
916  * @category files
917  * @param string $text the content to process.
918  * @param int $draftitemid the draft file area the content was using.
919  * @param bool $forcehttps whether the content contains https URLs. Default false.
920  * @return string the processed content.
921  */
922 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
923     global $CFG, $USER;
925     $usercontext = context_user::instance($USER->id);
927     $wwwroot = $CFG->wwwroot;
928     if ($forcehttps) {
929         $wwwroot = str_replace('http://', 'https://', $wwwroot);
930     }
932     // relink embedded files if text submitted - no absolute links allowed in database!
933     $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
935     if (strpos($text, 'draftfile.php?file=') !== false) {
936         $matches = array();
937         preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
938         if ($matches) {
939             foreach ($matches[0] as $match) {
940                 $replace = str_ireplace('%2F', '/', $match);
941                 $text = str_replace($match, $replace, $text);
942             }
943         }
944         $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
945     }
947     return $text;
950 /**
951  * Set file sort order
952  *
953  * @global moodle_database $DB
954  * @param int $contextid the context id
955  * @param string $component file component
956  * @param string $filearea file area.
957  * @param int $itemid itemid.
958  * @param string $filepath file path.
959  * @param string $filename file name.
960  * @param int $sortorder the sort order of file.
961  * @return bool
962  */
963 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
964     global $DB;
965     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
966     if ($file_record = $DB->get_record('files', $conditions)) {
967         $sortorder = (int)$sortorder;
968         $file_record->sortorder = $sortorder;
969         $DB->update_record('files', $file_record);
970         return true;
971     }
972     return false;
975 /**
976  * reset file sort order number to 0
977  * @global moodle_database $DB
978  * @param int $contextid the context id
979  * @param string $component
980  * @param string $filearea file area.
981  * @param int|bool $itemid itemid.
982  * @return bool
983  */
984 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
985     global $DB;
987     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
988     if ($itemid !== false) {
989         $conditions['itemid'] = $itemid;
990     }
992     $file_records = $DB->get_records('files', $conditions);
993     foreach ($file_records as $file_record) {
994         $file_record->sortorder = 0;
995         $DB->update_record('files', $file_record);
996     }
997     return true;
1000 /**
1001  * Returns description of upload error
1002  *
1003  * @param int $errorcode found in $_FILES['filename.ext']['error']
1004  * @return string error description string, '' if ok
1005  */
1006 function file_get_upload_error($errorcode) {
1008     switch ($errorcode) {
1009     case 0: // UPLOAD_ERR_OK - no error
1010         $errmessage = '';
1011         break;
1013     case 1: // UPLOAD_ERR_INI_SIZE
1014         $errmessage = get_string('uploadserverlimit');
1015         break;
1017     case 2: // UPLOAD_ERR_FORM_SIZE
1018         $errmessage = get_string('uploadformlimit');
1019         break;
1021     case 3: // UPLOAD_ERR_PARTIAL
1022         $errmessage = get_string('uploadpartialfile');
1023         break;
1025     case 4: // UPLOAD_ERR_NO_FILE
1026         $errmessage = get_string('uploadnofilefound');
1027         break;
1029     // Note: there is no error with a value of 5
1031     case 6: // UPLOAD_ERR_NO_TMP_DIR
1032         $errmessage = get_string('uploadnotempdir');
1033         break;
1035     case 7: // UPLOAD_ERR_CANT_WRITE
1036         $errmessage = get_string('uploadcantwrite');
1037         break;
1039     case 8: // UPLOAD_ERR_EXTENSION
1040         $errmessage = get_string('uploadextension');
1041         break;
1043     default:
1044         $errmessage = get_string('uploadproblem');
1045     }
1047     return $errmessage;
1050 /**
1051  * Recursive function formating an array in POST parameter
1052  * @param array $arraydata - the array that we are going to format and add into &$data array
1053  * @param string $currentdata - a row of the final postdata array at instant T
1054  *                when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
1055  * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
1056  */
1057 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
1058         foreach ($arraydata as $k=>$v) {
1059             $newcurrentdata = $currentdata;
1060             if (is_array($v)) { //the value is an array, call the function recursively
1061                 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
1062                 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
1063             }  else { //add the POST parameter to the $data array
1064                 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
1065             }
1066         }
1069 /**
1070  * Transform a PHP array into POST parameter
1071  * (see the recursive function format_array_postdata_for_curlcall)
1072  * @param array $postdata
1073  * @return array containing all POST parameters  (1 row = 1 POST parameter)
1074  */
1075 function format_postdata_for_curlcall($postdata) {
1076         $data = array();
1077         foreach ($postdata as $k=>$v) {
1078             if (is_array($v)) {
1079                 $currentdata = urlencode($k);
1080                 format_array_postdata_for_curlcall($v, $currentdata, $data);
1081             }  else {
1082                 $data[] = urlencode($k).'='.urlencode($v);
1083             }
1084         }
1085         $convertedpostdata = implode('&', $data);
1086         return $convertedpostdata;
1089 /**
1090  * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
1091  * Due to security concerns only downloads from http(s) sources are supported.
1092  *
1093  * @todo MDL-31073 add version test for '7.10.5'
1094  * @category files
1095  * @param string $url file url starting with http(s)://
1096  * @param array $headers http headers, null if none. If set, should be an
1097  *   associative array of header name => value pairs.
1098  * @param array $postdata array means use POST request with given parameters
1099  * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
1100  *   (if false, just returns content)
1101  * @param int $timeout timeout for complete download process including all file transfer
1102  *   (default 5 minutes)
1103  * @param int $connecttimeout timeout for connection to server; this is the timeout that
1104  *   usually happens if the remote server is completely down (default 20 seconds);
1105  *   may not work when using proxy
1106  * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
1107  *   Only use this when already in a trusted location.
1108  * @param string $tofile store the downloaded content to file instead of returning it.
1109  * @param bool $calctimeout false by default, true enables an extra head request to try and determine
1110  *   filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
1111  * @return mixed false if request failed or content of the file as string if ok. True if file downloaded into $tofile successfully.
1112  */
1113 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
1114     global $CFG;
1116     // some extra security
1117     $newlines = array("\r", "\n");
1118     if (is_array($headers) ) {
1119         foreach ($headers as $key => $value) {
1120             $headers[$key] = str_replace($newlines, '', $value);
1121         }
1122     }
1123     $url = str_replace($newlines, '', $url);
1124     if (!preg_match('|^https?://|i', $url)) {
1125         if ($fullresponse) {
1126             $response = new stdClass();
1127             $response->status        = 0;
1128             $response->headers       = array();
1129             $response->response_code = 'Invalid protocol specified in url';
1130             $response->results       = '';
1131             $response->error         = 'Invalid protocol specified in url';
1132             return $response;
1133         } else {
1134             return false;
1135         }
1136     }
1138     // check if proxy (if used) should be bypassed for this url
1139     $proxybypass = is_proxybypass($url);
1141     if (!$ch = curl_init($url)) {
1142         debugging('Can not init curl.');
1143         return false;
1144     }
1146     // set extra headers
1147     if (is_array($headers) ) {
1148         $headers2 = array();
1149         foreach ($headers as $key => $value) {
1150             $headers2[] = "$key: $value";
1151         }
1152         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers2);
1153     }
1155     if ($skipcertverify) {
1156         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
1157     }
1159     // use POST if requested
1160     if (is_array($postdata)) {
1161         $postdata = format_postdata_for_curlcall($postdata);
1162         curl_setopt($ch, CURLOPT_POST, true);
1163         curl_setopt($ch, CURLOPT_POSTFIELDS, $postdata);
1164     }
1166     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
1167     curl_setopt($ch, CURLOPT_HEADER, false);
1168     curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connecttimeout);
1170     if (!ini_get('open_basedir') and !ini_get('safe_mode')) {
1171         // TODO: add version test for '7.10.5'
1172         curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
1173         curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
1174     }
1176     if (!empty($CFG->proxyhost) and !$proxybypass) {
1177         // SOCKS supported in PHP5 only
1178         if (!empty($CFG->proxytype) and ($CFG->proxytype == 'SOCKS5')) {
1179             if (defined('CURLPROXY_SOCKS5')) {
1180                 curl_setopt($ch, CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
1181             } else {
1182                 curl_close($ch);
1183                 if ($fullresponse) {
1184                     $response = new stdClass();
1185                     $response->status        = '0';
1186                     $response->headers       = array();
1187                     $response->response_code = 'SOCKS5 proxy is not supported in PHP4';
1188                     $response->results       = '';
1189                     $response->error         = 'SOCKS5 proxy is not supported in PHP4';
1190                     return $response;
1191                 } else {
1192                     debugging("SOCKS5 proxy is not supported in PHP4.", DEBUG_ALL);
1193                     return false;
1194                 }
1195             }
1196         }
1198         curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, false);
1200         if (empty($CFG->proxyport)) {
1201             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost);
1202         } else {
1203             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost.':'.$CFG->proxyport);
1204         }
1206         if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
1207             curl_setopt($ch, CURLOPT_PROXYUSERPWD, $CFG->proxyuser.':'.$CFG->proxypassword);
1208             if (defined('CURLOPT_PROXYAUTH')) {
1209                 // any proxy authentication if PHP 5.1
1210                 curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_BASIC | CURLAUTH_NTLM);
1211             }
1212         }
1213     }
1215     // set up header and content handlers
1216     $received = new stdClass();
1217     $received->headers = array(); // received headers array
1218     $received->tofile  = $tofile;
1219     $received->fh      = null;
1220     curl_setopt($ch, CURLOPT_HEADERFUNCTION, partial('download_file_content_header_handler', $received));
1221     if ($tofile) {
1222         curl_setopt($ch, CURLOPT_WRITEFUNCTION, partial('download_file_content_write_handler', $received));
1223     }
1225     if (!isset($CFG->curltimeoutkbitrate)) {
1226         //use very slow rate of 56kbps as a timeout speed when not set
1227         $bitrate = 56;
1228     } else {
1229         $bitrate = $CFG->curltimeoutkbitrate;
1230     }
1232     // try to calculate the proper amount for timeout from remote file size.
1233     // if disabled or zero, we won't do any checks nor head requests.
1234     if ($calctimeout && $bitrate > 0) {
1235         //setup header request only options
1236         curl_setopt_array ($ch, array(
1237             CURLOPT_RETURNTRANSFER => false,
1238             CURLOPT_NOBODY         => true)
1239         );
1241         curl_exec($ch);
1242         $info = curl_getinfo($ch);
1243         $err = curl_error($ch);
1245         if ($err === '' && $info['download_content_length'] > 0) { //no curl errors
1246             $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024))); //adjust for large files only - take max timeout.
1247         }
1248         //reinstate affected curl options
1249         curl_setopt_array ($ch, array(
1250             CURLOPT_RETURNTRANSFER => true,
1251             CURLOPT_NOBODY         => false)
1252         );
1253     }
1255     curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
1256     $result = curl_exec($ch);
1258     // try to detect encoding problems
1259     if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1260         curl_setopt($ch, CURLOPT_ENCODING, 'none');
1261         $result = curl_exec($ch);
1262     }
1264     if ($received->fh) {
1265         fclose($received->fh);
1266     }
1268     if (curl_errno($ch)) {
1269         $error    = curl_error($ch);
1270         $error_no = curl_errno($ch);
1271         curl_close($ch);
1273         if ($fullresponse) {
1274             $response = new stdClass();
1275             if ($error_no == 28) {
1276                 $response->status    = '-100'; // mimic snoopy
1277             } else {
1278                 $response->status    = '0';
1279             }
1280             $response->headers       = array();
1281             $response->response_code = $error;
1282             $response->results       = false;
1283             $response->error         = $error;
1284             return $response;
1285         } else {
1286             debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL);
1287             return false;
1288         }
1290     } else {
1291         $info = curl_getinfo($ch);
1292         curl_close($ch);
1294         if (empty($info['http_code'])) {
1295             // for security reasons we support only true http connections (Location: file:// exploit prevention)
1296             $response = new stdClass();
1297             $response->status        = '0';
1298             $response->headers       = array();
1299             $response->response_code = 'Unknown cURL error';
1300             $response->results       = false; // do NOT change this, we really want to ignore the result!
1301             $response->error         = 'Unknown cURL error';
1303         } else {
1304             $response = new stdClass();;
1305             $response->status        = (string)$info['http_code'];
1306             $response->headers       = $received->headers;
1307             $response->response_code = $received->headers[0];
1308             $response->results       = $result;
1309             $response->error         = '';
1310         }
1312         if ($fullresponse) {
1313             return $response;
1314         } else if ($info['http_code'] != 200) {
1315             debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code, DEBUG_ALL);
1316             return false;
1317         } else {
1318             return $response->results;
1319         }
1320     }
1323 /**
1324  * internal implementation
1325  * @param stdClass $received
1326  * @param resource $ch
1327  * @param mixed $header
1328  * @return int header length
1329  */
1330 function download_file_content_header_handler($received, $ch, $header) {
1331     $received->headers[] = $header;
1332     return strlen($header);
1335 /**
1336  * internal implementation
1337  * @param stdClass $received
1338  * @param resource $ch
1339  * @param mixed $data
1340  */
1341 function download_file_content_write_handler($received, $ch, $data) {
1342     if (!$received->fh) {
1343         $received->fh = fopen($received->tofile, 'w');
1344         if ($received->fh === false) {
1345             // bad luck, file creation or overriding failed
1346             return 0;
1347         }
1348     }
1349     if (fwrite($received->fh, $data) === false) {
1350         // bad luck, write failed, let's abort completely
1351         return 0;
1352     }
1353     return strlen($data);
1356 /**
1357  * Returns a list of information about file types based on extensions.
1358  *
1359  * The following elements expected in value array for each extension:
1360  * 'type' - mimetype
1361  * 'icon' - location of the icon file. If value is FILENAME, then either pix/f/FILENAME.gif
1362  *     or pix/f/FILENAME.png must be present in moodle and contain 16x16 filetype icon;
1363  *     also files with bigger sizes under names
1364  *     FILENAME-24, FILENAME-32, FILENAME-64, FILENAME-128, FILENAME-256 are recommended.
1365  * 'groups' (optional) - array of filetype groups this filetype extension is part of;
1366  *     commonly used in moodle the following groups:
1367  *       - web_image - image that can be included as <img> in HTML
1368  *       - image - image that we can parse using GD to find it's dimensions, also used for portfolio format
1369  *       - video - file that can be imported as video in text editor
1370  *       - audio - file that can be imported as audio in text editor
1371  *       - archive - we can extract files from this archive
1372  *       - spreadsheet - used for portfolio format
1373  *       - document - used for portfolio format
1374  *       - presentation - used for portfolio format
1375  * 'string' (optional) - the name of the string from lang/en/mimetypes.php that displays
1376  *     human-readable description for this filetype;
1377  *     Function {@link get_mimetype_description()} first looks at the presence of string for
1378  *     particular mimetype (value of 'type'), if not found looks for string specified in 'string'
1379  *     attribute, if not found returns the value of 'type';
1380  * 'defaulticon' (boolean, optional) - used by function {@link file_mimetype_icon()} to find
1381  *     an icon for mimetype. If an entry with 'defaulticon' is not found for a particular mimetype,
1382  *     this function will return first found icon; Especially usefull for types such as 'text/plain'
1383  *
1384  * @category files
1385  * @return array List of information about file types based on extensions.
1386  *   Associative array of extension (lower-case) to associative array
1387  *   from 'element name' to data. Current element names are 'type' and 'icon'.
1388  *   Unknown types should use the 'xxx' entry which includes defaults.
1389  */
1390 function &get_mimetypes_array() {
1391     static $mimearray = array (
1392         'xxx'  => array ('type'=>'document/unknown', 'icon'=>'unknown'),
1393         '3gp'  => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1394         'aac'  => array ('type'=>'audio/aac', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1395         'accdb'  => array ('type'=>'application/msaccess', 'icon'=>'base'),
1396         'ai'   => array ('type'=>'application/postscript', 'icon'=>'eps', 'groups'=>array('image'), 'string'=>'image'),
1397         'aif'  => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1398         'aiff' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1399         'aifc' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1400         'applescript'  => array ('type'=>'text/plain', 'icon'=>'text'),
1401         'asc'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1402         'asm'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1403         'au'   => array ('type'=>'audio/au', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1404         'avi'  => array ('type'=>'video/x-ms-wm', 'icon'=>'avi', 'groups'=>array('video','web_video'), 'string'=>'video'),
1405         'bmp'  => array ('type'=>'image/bmp', 'icon'=>'bmp', 'groups'=>array('image'), 'string'=>'image'),
1406         'c'    => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1407         'cct'  => array ('type'=>'shockwave/director', 'icon'=>'flash'),
1408         'cpp'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1409         'cs'   => array ('type'=>'application/x-csh', 'icon'=>'sourcecode'),
1410         'css'  => array ('type'=>'text/css', 'icon'=>'text', 'groups'=>array('web_file')),
1411         'csv'  => array ('type'=>'text/csv', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1412         'dv'   => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1413         'dmg'  => array ('type'=>'application/octet-stream', 'icon'=>'unknown'),
1415         'doc'  => array ('type'=>'application/msword', 'icon'=>'document', 'groups'=>array('document')),
1416         'docx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'icon'=>'document', 'groups'=>array('document')),
1417         'docm' => array ('type'=>'application/vnd.ms-word.document.macroEnabled.12', 'icon'=>'document'),
1418         'dotx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 'icon'=>'document'),
1419         'dotm' => array ('type'=>'application/vnd.ms-word.template.macroEnabled.12', 'icon'=>'document'),
1421         'dcr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1422         'dif'  => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1423         'dir'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1424         'dxr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1425         'eps'  => array ('type'=>'application/postscript', 'icon'=>'eps'),
1426         'epub' => array ('type'=>'application/epub+zip', 'icon'=>'epub', 'groups'=>array('document')),
1427         'fdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1428         'flv'  => array ('type'=>'video/x-flv', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1429         'f4v'  => array ('type'=>'video/mp4', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1430         'gif'  => array ('type'=>'image/gif', 'icon'=>'gif', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1431         'gtar' => array ('type'=>'application/x-gtar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1432         'tgz'  => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1433         'gz'   => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1434         'gzip' => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1435         'h'    => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1436         'hpp'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1437         'hqx'  => array ('type'=>'application/mac-binhex40', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1438         'htc'  => array ('type'=>'text/x-component', 'icon'=>'markup'),
1439         'html' => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1440         'xhtml'=> array ('type'=>'application/xhtml+xml', 'icon'=>'html', 'groups'=>array('web_file')),
1441         'htm'  => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1442         'ico'  => array ('type'=>'image/vnd.microsoft.icon', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1443         'ics'  => array ('type'=>'text/calendar', 'icon'=>'text'),
1444         'isf'  => array ('type'=>'application/inspiration', 'icon'=>'isf'),
1445         'ist'  => array ('type'=>'application/inspiration.template', 'icon'=>'isf'),
1446         'java' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1447         'jcb'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1448         'jcl'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1449         'jcw'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1450         'jmt'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1451         'jmx'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1452         'jpe'  => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1453         'jpeg' => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1454         'jpg'  => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1455         'jqz'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1456         'js'   => array ('type'=>'application/x-javascript', 'icon'=>'text', 'groups'=>array('web_file')),
1457         'latex'=> array ('type'=>'application/x-latex', 'icon'=>'text'),
1458         'm'    => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1459         'mbz'  => array ('type'=>'application/vnd.moodle.backup', 'icon'=>'moodle'),
1460         'mdb'  => array ('type'=>'application/x-msaccess', 'icon'=>'base'),
1461         'mov'  => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1462         'movie'=> array ('type'=>'video/x-sgi-movie', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1463         'm3u'  => array ('type'=>'audio/x-mpegurl', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1464         'mp3'  => array ('type'=>'audio/mp3', 'icon'=>'mp3', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1465         'mp4'  => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1466         'm4v'  => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1467         'm4a'  => array ('type'=>'audio/mp4', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1468         'mpeg' => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1469         'mpe'  => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1470         'mpg'  => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1472         'odt'  => array ('type'=>'application/vnd.oasis.opendocument.text', 'icon'=>'writer', 'groups'=>array('document')),
1473         'ott'  => array ('type'=>'application/vnd.oasis.opendocument.text-template', 'icon'=>'writer', 'groups'=>array('document')),
1474         'oth'  => array ('type'=>'application/vnd.oasis.opendocument.text-web', 'icon'=>'oth', 'groups'=>array('document')),
1475         'odm'  => array ('type'=>'application/vnd.oasis.opendocument.text-master', 'icon'=>'writer'),
1476         'odg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics', 'icon'=>'draw'),
1477         'otg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics-template', 'icon'=>'draw'),
1478         'odp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation', 'icon'=>'impress'),
1479         'otp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation-template', 'icon'=>'impress'),
1480         'ods'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1481         'ots'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet-template', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1482         'odc'  => array ('type'=>'application/vnd.oasis.opendocument.chart', 'icon'=>'chart'),
1483         'odf'  => array ('type'=>'application/vnd.oasis.opendocument.formula', 'icon'=>'math'),
1484         'odb'  => array ('type'=>'application/vnd.oasis.opendocument.database', 'icon'=>'base'),
1485         'odi'  => array ('type'=>'application/vnd.oasis.opendocument.image', 'icon'=>'draw'),
1486         'oga'  => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1487         'ogg'  => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1488         'ogv'  => array ('type'=>'video/ogg', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1490         'pct'  => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1491         'pdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1492         'php'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1493         'pic'  => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1494         'pict' => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1495         'png'  => array ('type'=>'image/png', 'icon'=>'png', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1497         'pps'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1498         'ppt'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1499         'pptx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'icon'=>'powerpoint'),
1500         'pptm' => array ('type'=>'application/vnd.ms-powerpoint.presentation.macroEnabled.12', 'icon'=>'powerpoint'),
1501         'potx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.template', 'icon'=>'powerpoint'),
1502         'potm' => array ('type'=>'application/vnd.ms-powerpoint.template.macroEnabled.12', 'icon'=>'powerpoint'),
1503         'ppam' => array ('type'=>'application/vnd.ms-powerpoint.addin.macroEnabled.12', 'icon'=>'powerpoint'),
1504         'ppsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 'icon'=>'powerpoint'),
1505         'ppsm' => array ('type'=>'application/vnd.ms-powerpoint.slideshow.macroEnabled.12', 'icon'=>'powerpoint'),
1507         'ps'   => array ('type'=>'application/postscript', 'icon'=>'pdf'),
1508         'qt'   => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1509         'ra'   => array ('type'=>'audio/x-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1510         'ram'  => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1511         'rhb'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1512         'rm'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1513         'rmvb' => array ('type'=>'application/vnd.rn-realmedia-vbr', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1514         'rtf'  => array ('type'=>'text/rtf', 'icon'=>'text', 'groups'=>array('document')),
1515         'rtx'  => array ('type'=>'text/richtext', 'icon'=>'text'),
1516         'rv'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('video'), 'string'=>'video'),
1517         'sh'   => array ('type'=>'application/x-sh', 'icon'=>'sourcecode'),
1518         'sit'  => array ('type'=>'application/x-stuffit', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1519         'smi'  => array ('type'=>'application/smil', 'icon'=>'text'),
1520         'smil' => array ('type'=>'application/smil', 'icon'=>'text'),
1521         'sqt'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1522         'svg'  => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1523         'svgz' => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1524         'swa'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1525         'swf'  => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1526         'swfl' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1528         'sxw'  => array ('type'=>'application/vnd.sun.xml.writer', 'icon'=>'writer'),
1529         'stw'  => array ('type'=>'application/vnd.sun.xml.writer.template', 'icon'=>'writer'),
1530         'sxc'  => array ('type'=>'application/vnd.sun.xml.calc', 'icon'=>'calc'),
1531         'stc'  => array ('type'=>'application/vnd.sun.xml.calc.template', 'icon'=>'calc'),
1532         'sxd'  => array ('type'=>'application/vnd.sun.xml.draw', 'icon'=>'draw'),
1533         'std'  => array ('type'=>'application/vnd.sun.xml.draw.template', 'icon'=>'draw'),
1534         'sxi'  => array ('type'=>'application/vnd.sun.xml.impress', 'icon'=>'impress'),
1535         'sti'  => array ('type'=>'application/vnd.sun.xml.impress.template', 'icon'=>'impress'),
1536         'sxg'  => array ('type'=>'application/vnd.sun.xml.writer.global', 'icon'=>'writer'),
1537         'sxm'  => array ('type'=>'application/vnd.sun.xml.math', 'icon'=>'math'),
1539         'tar'  => array ('type'=>'application/x-tar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1540         'tif'  => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1541         'tiff' => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1542         'tex'  => array ('type'=>'application/x-tex', 'icon'=>'text'),
1543         'texi' => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1544         'texinfo'  => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1545         'tsv'  => array ('type'=>'text/tab-separated-values', 'icon'=>'text'),
1546         'txt'  => array ('type'=>'text/plain', 'icon'=>'text', 'defaulticon'=>true),
1547         'wav'  => array ('type'=>'audio/wav', 'icon'=>'wav', 'groups'=>array('audio'), 'string'=>'audio'),
1548         'webm'  => array ('type'=>'video/webm', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1549         'wmv'  => array ('type'=>'video/x-ms-wmv', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1550         'asf'  => array ('type'=>'video/x-ms-asf', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1551         'xdp'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1552         'xfd'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1553         'xfdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1555         'xls'  => array ('type'=>'application/vnd.ms-excel', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1556         'xlsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'icon'=>'spreadsheet'),
1557         'xlsm' => array ('type'=>'application/vnd.ms-excel.sheet.macroEnabled.12', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1558         'xltx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 'icon'=>'spreadsheet'),
1559         'xltm' => array ('type'=>'application/vnd.ms-excel.template.macroEnabled.12', 'icon'=>'spreadsheet'),
1560         'xlsb' => array ('type'=>'application/vnd.ms-excel.sheet.binary.macroEnabled.12', 'icon'=>'spreadsheet'),
1561         'xlam' => array ('type'=>'application/vnd.ms-excel.addin.macroEnabled.12', 'icon'=>'spreadsheet'),
1563         'xml'  => array ('type'=>'application/xml', 'icon'=>'markup'),
1564         'xsl'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1565         'zip'  => array ('type'=>'application/zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive')
1566     );
1567     return $mimearray;
1570 /**
1571  * Obtains information about a filetype based on its extension. Will
1572  * use a default if no information is present about that particular
1573  * extension.
1574  *
1575  * @category files
1576  * @param string $element Desired information (usually 'icon'
1577  *   for icon filename or 'type' for MIME type. Can also be
1578  *   'icon24', ...32, 48, 64, 72, 80, 96, 128, 256)
1579  * @param string $filename Filename we're looking up
1580  * @return string Requested piece of information from array
1581  */
1582 function mimeinfo($element, $filename) {
1583     global $CFG;
1584     $mimeinfo = & get_mimetypes_array();
1585     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1587     $filetype = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1588     if (empty($filetype)) {
1589         $filetype = 'xxx'; // file without extension
1590     }
1591     if (preg_match('/^icon(\d*)$/', $element, $iconsizematch)) {
1592         $iconsize = max(array(16, (int)$iconsizematch[1]));
1593         $filenames = array($mimeinfo['xxx']['icon']);
1594         if ($filetype != 'xxx' && isset($mimeinfo[$filetype]['icon'])) {
1595             array_unshift($filenames, $mimeinfo[$filetype]['icon']);
1596         }
1597         // find the file with the closest size, first search for specific icon then for default icon
1598         foreach ($filenames as $filename) {
1599             foreach ($iconpostfixes as $size => $postfix) {
1600                 $fullname = $CFG->dirroot.'/pix/f/'.$filename.$postfix;
1601                 if ($iconsize >= $size && (file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1602                     return $filename.$postfix;
1603                 }
1604             }
1605         }
1606     } else if (isset($mimeinfo[$filetype][$element])) {
1607         return $mimeinfo[$filetype][$element];
1608     } else if (isset($mimeinfo['xxx'][$element])) {
1609         return $mimeinfo['xxx'][$element];   // By default
1610     } else {
1611         return null;
1612     }
1615 /**
1616  * Obtains information about a filetype based on the MIME type rather than
1617  * the other way around.
1618  *
1619  * @category files
1620  * @param string $element Desired information ('extension', 'icon', 'icon-24', etc.)
1621  * @param string $mimetype MIME type we're looking up
1622  * @return string Requested piece of information from array
1623  */
1624 function mimeinfo_from_type($element, $mimetype) {
1625     /* array of cached mimetype->extension associations */
1626     static $cached = array();
1627     $mimeinfo = & get_mimetypes_array();
1629     if (!array_key_exists($mimetype, $cached)) {
1630         $cached[$mimetype] = null;
1631         foreach($mimeinfo as $filetype => $values) {
1632             if ($values['type'] == $mimetype) {
1633                 if ($cached[$mimetype] === null) {
1634                     $cached[$mimetype] = '.'.$filetype;
1635                 }
1636                 if (!empty($values['defaulticon'])) {
1637                     $cached[$mimetype] = '.'.$filetype;
1638                     break;
1639                 }
1640             }
1641         }
1642         if (empty($cached[$mimetype])) {
1643             $cached[$mimetype] = '.xxx';
1644         }
1645     }
1646     if ($element === 'extension') {
1647         return $cached[$mimetype];
1648     } else {
1649         return mimeinfo($element, $cached[$mimetype]);
1650     }
1653 /**
1654  * Return the relative icon path for a given file
1655  *
1656  * Usage:
1657  * <code>
1658  * // $file - instance of stored_file or file_info
1659  * $icon = $OUTPUT->pix_url(file_file_icon($file))->out();
1660  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($file)));
1661  * </code>
1662  * or
1663  * <code>
1664  * echo $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file));
1665  * </code>
1666  *
1667  * @param stored_file|file_info|stdClass|array $file (in case of object attributes $file->filename
1668  *     and $file->mimetype are expected)
1669  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1670  * @return string
1671  */
1672 function file_file_icon($file, $size = null) {
1673     if (!is_object($file)) {
1674         $file = (object)$file;
1675     }
1676     if (isset($file->filename)) {
1677         $filename = $file->filename;
1678     } else if (method_exists($file, 'get_filename')) {
1679         $filename = $file->get_filename();
1680     } else if (method_exists($file, 'get_visible_name')) {
1681         $filename = $file->get_visible_name();
1682     } else {
1683         $filename = '';
1684     }
1685     if (isset($file->mimetype)) {
1686         $mimetype = $file->mimetype;
1687     } else if (method_exists($file, 'get_mimetype')) {
1688         $mimetype = $file->get_mimetype();
1689     } else {
1690         $mimetype = '';
1691     }
1692     $mimetypes = &get_mimetypes_array();
1693     if ($filename) {
1694         $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1695         if ($extension && !empty($mimetypes[$extension])) {
1696             // if file name has known extension, return icon for this extension
1697             return file_extension_icon($filename, $size);
1698         }
1699     }
1700     return file_mimetype_icon($mimetype, $size);
1703 /**
1704  * Return the relative icon path for a folder image
1705  *
1706  * Usage:
1707  * <code>
1708  * $icon = $OUTPUT->pix_url(file_folder_icon())->out();
1709  * echo html_writer::empty_tag('img', array('src' => $icon));
1710  * </code>
1711  * or
1712  * <code>
1713  * echo $OUTPUT->pix_icon(file_folder_icon(32));
1714  * </code>
1715  *
1716  * @param int $iconsize The size of the icon. Defaults to 16 can also be 24, 32, 48, 64, 72, 80, 96, 128, 256
1717  * @return string
1718  */
1719 function file_folder_icon($iconsize = null) {
1720     global $CFG;
1721     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1722     static $cached = array();
1723     $iconsize = max(array(16, (int)$iconsize));
1724     if (!array_key_exists($iconsize, $cached)) {
1725         foreach ($iconpostfixes as $size => $postfix) {
1726             $fullname = $CFG->dirroot.'/pix/f/folder'.$postfix;
1727             if ($iconsize >= $size && (file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1728                 $cached[$iconsize] = 'f/folder'.$postfix;
1729                 break;
1730             }
1731         }
1732     }
1733     return $cached[$iconsize];
1736 /**
1737  * Returns the relative icon path for a given mime type
1738  *
1739  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1740  * a return the full path to an icon.
1741  *
1742  * <code>
1743  * $mimetype = 'image/jpg';
1744  * $icon = $OUTPUT->pix_url(file_mimetype_icon($mimetype))->out();
1745  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($mimetype)));
1746  * </code>
1747  *
1748  * @category files
1749  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1750  * to conform with that.
1751  * @param string $mimetype The mimetype to fetch an icon for
1752  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1753  * @return string The relative path to the icon
1754  */
1755 function file_mimetype_icon($mimetype, $size = NULL) {
1756     return 'f/'.mimeinfo_from_type('icon'.$size, $mimetype);
1759 /**
1760  * Returns the relative icon path for a given file name
1761  *
1762  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1763  * a return the full path to an icon.
1764  *
1765  * <code>
1766  * $filename = '.jpg';
1767  * $icon = $OUTPUT->pix_url(file_extension_icon($filename))->out();
1768  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => '...'));
1769  * </code>
1770  *
1771  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1772  * to conform with that.
1773  * @todo MDL-31074 Implement $size
1774  * @category files
1775  * @param string $filename The filename to get the icon for
1776  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1777  * @return string
1778  */
1779 function file_extension_icon($filename, $size = NULL) {
1780     return 'f/'.mimeinfo('icon'.$size, $filename);
1783 /**
1784  * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1785  * mimetypes.php language file.
1786  *
1787  * @param mixed $obj - instance of stored_file or file_info or array/stdClass with field
1788  *   'filename' and 'mimetype', or just a string with mimetype (though it is recommended to
1789  *   have filename); In case of array/stdClass the field 'mimetype' is optional.
1790  * @param bool $capitalise If true, capitalises first character of result
1791  * @return string Text description
1792  */
1793 function get_mimetype_description($obj, $capitalise=false) {
1794     $filename = $mimetype = '';
1795     if (is_object($obj) && method_exists($obj, 'get_filename') && method_exists($obj, 'get_mimetype')) {
1796         // this is an instance of stored_file
1797         $mimetype = $obj->get_mimetype();
1798         $filename = $obj->get_filename();
1799     } else if (is_object($obj) && method_exists($obj, 'get_visible_name') && method_exists($obj, 'get_mimetype')) {
1800         // this is an instance of file_info
1801         $mimetype = $obj->get_mimetype();
1802         $filename = $obj->get_visible_name();
1803     } else if (is_array($obj) || is_object ($obj)) {
1804         $obj = (array)$obj;
1805         if (!empty($obj['filename'])) {
1806             $filename = $obj['filename'];
1807         }
1808         if (!empty($obj['mimetype'])) {
1809             $mimetype = $obj['mimetype'];
1810         }
1811     } else {
1812         $mimetype = $obj;
1813     }
1814     $mimetypefromext = mimeinfo('type', $filename);
1815     if (empty($mimetype) || $mimetypefromext !== 'document/unknown') {
1816         // if file has a known extension, overwrite the specified mimetype
1817         $mimetype = $mimetypefromext;
1818     }
1819     $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1820     if (empty($extension)) {
1821         $mimetypestr = mimeinfo_from_type('string', $mimetype);
1822         $extension = str_replace('.', '', mimeinfo_from_type('extension', $mimetype));
1823     } else {
1824         $mimetypestr = mimeinfo('string', $filename);
1825     }
1826     $chunks = explode('/', $mimetype, 2);
1827     $chunks[] = '';
1828     $attr = array(
1829         'mimetype' => $mimetype,
1830         'ext' => $extension,
1831         'mimetype1' => $chunks[0],
1832         'mimetype2' => $chunks[1],
1833     );
1834     $a = array();
1835     foreach ($attr as $key => $value) {
1836         $a[$key] = $value;
1837         $a[strtoupper($key)] = strtoupper($value);
1838         $a[ucfirst($key)] = ucfirst($value);
1839     }
1841     // MIME types may include + symbol but this is not permitted in string ids.
1842     $safemimetype = str_replace('+', '_', $mimetype);
1843     $safemimetypestr = str_replace('+', '_', $mimetypestr);
1844     if (get_string_manager()->string_exists($safemimetype, 'mimetypes')) {
1845         $result = get_string($safemimetype, 'mimetypes', (object)$a);
1846     } else if (get_string_manager()->string_exists($safemimetypestr, 'mimetypes')) {
1847         $result = get_string($safemimetypestr, 'mimetypes', (object)$a);
1848     } else if (get_string_manager()->string_exists('default', 'mimetypes')) {
1849         $result = get_string('default', 'mimetypes', (object)$a);
1850     } else {
1851         $result = $mimetype;
1852     }
1853     if ($capitalise) {
1854         $result=ucfirst($result);
1855     }
1856     return $result;
1859 /**
1860  * Returns array of elements of type $element in type group(s)
1861  *
1862  * @param string $element name of the element we are interested in, usually 'type' or 'extension'
1863  * @param string|array $groups one group or array of groups/extensions/mimetypes
1864  * @return array
1865  */
1866 function file_get_typegroup($element, $groups) {
1867     static $cached = array();
1868     if (!is_array($groups)) {
1869         $groups = array($groups);
1870     }
1871     if (!array_key_exists($element, $cached)) {
1872         $cached[$element] = array();
1873     }
1874     $result = array();
1875     foreach ($groups as $group) {
1876         if (!array_key_exists($group, $cached[$element])) {
1877             // retrieive and cache all elements of type $element for group $group
1878             $mimeinfo = & get_mimetypes_array();
1879             $cached[$element][$group] = array();
1880             foreach ($mimeinfo as $extension => $value) {
1881                 $value['extension'] = '.'.$extension;
1882                 if (empty($value[$element])) {
1883                     continue;
1884                 }
1885                 if (($group === '.'.$extension || $group === $value['type'] ||
1886                         (!empty($value['groups']) && in_array($group, $value['groups']))) &&
1887                         !in_array($value[$element], $cached[$element][$group])) {
1888                     $cached[$element][$group][] = $value[$element];
1889                 }
1890             }
1891         }
1892         $result = array_merge($result, $cached[$element][$group]);
1893     }
1894     return array_unique($result);
1897 /**
1898  * Checks if file with name $filename has one of the extensions in groups $groups
1899  *
1900  * @see get_mimetypes_array()
1901  * @param string $filename name of the file to check
1902  * @param string|array $groups one group or array of groups to check
1903  * @param bool $checktype if true and extension check fails, find the mimetype and check if
1904  * file mimetype is in mimetypes in groups $groups
1905  * @return bool
1906  */
1907 function file_extension_in_typegroup($filename, $groups, $checktype = false) {
1908     $extension = pathinfo($filename, PATHINFO_EXTENSION);
1909     if (!empty($extension) && in_array('.'.strtolower($extension), file_get_typegroup('extension', $groups))) {
1910         return true;
1911     }
1912     return $checktype && file_mimetype_in_typegroup(mimeinfo('type', $filename), $groups);
1915 /**
1916  * Checks if mimetype $mimetype belongs to one of the groups $groups
1917  *
1918  * @see get_mimetypes_array()
1919  * @param string $mimetype
1920  * @param string|array $groups one group or array of groups to check
1921  * @return bool
1922  */
1923 function file_mimetype_in_typegroup($mimetype, $groups) {
1924     return !empty($mimetype) && in_array($mimetype, file_get_typegroup('type', $groups));
1927 /**
1928  * Requested file is not found or not accessible, does not return, terminates script
1929  *
1930  * @global stdClass $CFG
1931  * @global stdClass $COURSE
1932  */
1933 function send_file_not_found() {
1934     global $CFG, $COURSE;
1935     send_header_404();
1936     print_error('filenotfound', 'error', $CFG->wwwroot.'/course/view.php?id='.$COURSE->id); //this is not displayed on IIS??
1938 /**
1939  * Helper function to send correct 404 for server.
1940  */
1941 function send_header_404() {
1942     if (substr(php_sapi_name(), 0, 3) == 'cgi') {
1943         header("Status: 404 Not Found");
1944     } else {
1945         header('HTTP/1.0 404 not found');
1946     }
1949 /**
1950  * Enhanced readfile() with optional acceleration.
1951  * @param string|stored_file $file
1952  * @param string $mimetype
1953  * @param bool $accelerate
1954  * @return void
1955  */
1956 function readfile_accel($file, $mimetype, $accelerate) {
1957     global $CFG;
1959     if ($mimetype === 'text/plain') {
1960         // there is no encoding specified in text files, we need something consistent
1961         header('Content-Type: text/plain; charset=utf-8');
1962     } else {
1963         header('Content-Type: '.$mimetype);
1964     }
1966     $lastmodified = is_object($file) ? $file->get_timemodified() : filemtime($file);
1967     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1969     if (is_object($file)) {
1970         header('ETag: ' . $file->get_contenthash());
1971         if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and $_SERVER['HTTP_IF_NONE_MATCH'] === $file->get_contenthash()) {
1972             header('HTTP/1.1 304 Not Modified');
1973             return;
1974         }
1975     }
1977     // if etag present for stored file rely on it exclusively
1978     if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) and (empty($_SERVER['HTTP_IF_NONE_MATCH']) or !is_object($file))) {
1979         // get unixtime of request header; clip extra junk off first
1980         $since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
1981         if ($since && $since >= $lastmodified) {
1982             header('HTTP/1.1 304 Not Modified');
1983             return;
1984         }
1985     }
1987     if ($accelerate and !empty($CFG->xsendfile)) {
1988         if (empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1989             header('Accept-Ranges: bytes');
1990         } else {
1991             header('Accept-Ranges: none');
1992         }
1994         if (is_object($file)) {
1995             $fs = get_file_storage();
1996             if ($fs->xsendfile($file->get_contenthash())) {
1997                 return;
1998             }
2000         } else {
2001             require_once("$CFG->libdir/xsendfilelib.php");
2002             if (xsendfile($file)) {
2003                 return;
2004             }
2005         }
2006     }
2008     $filesize = is_object($file) ? $file->get_filesize() : filesize($file);
2010     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
2012     if ($accelerate and empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
2013         header('Accept-Ranges: bytes');
2015         if (!empty($_SERVER['HTTP_RANGE']) and strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
2016             // byteserving stuff - for acrobat reader and download accelerators
2017             // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
2018             // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
2019             $ranges = false;
2020             if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
2021                 foreach ($ranges as $key=>$value) {
2022                     if ($ranges[$key][1] == '') {
2023                         //suffix case
2024                         $ranges[$key][1] = $filesize - $ranges[$key][2];
2025                         $ranges[$key][2] = $filesize - 1;
2026                     } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
2027                         //fix range length
2028                         $ranges[$key][2] = $filesize - 1;
2029                     }
2030                     if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
2031                         //invalid byte-range ==> ignore header
2032                         $ranges = false;
2033                         break;
2034                     }
2035                     //prepare multipart header
2036                     $ranges[$key][0] =  "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
2037                     $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
2038                 }
2039             } else {
2040                 $ranges = false;
2041             }
2042             if ($ranges) {
2043                 if (is_object($file)) {
2044                     $handle = $file->get_content_file_handle();
2045                 } else {
2046                     $handle = fopen($file, 'rb');
2047                 }
2048                 byteserving_send_file($handle, $mimetype, $ranges, $filesize);
2049             }
2050         }
2051     } else {
2052         // Do not byteserve
2053         header('Accept-Ranges: none');
2054     }
2056     header('Content-Length: '.$filesize);
2058     if ($filesize > 10000000) {
2059         // for large files try to flush and close all buffers to conserve memory
2060         while(@ob_get_level()) {
2061             if (!@ob_end_flush()) {
2062                 break;
2063             }
2064         }
2065     }
2067     // send the whole file content
2068     if (is_object($file)) {
2069         $file->readfile();
2070     } else {
2071         readfile($file);
2072     }
2075 /**
2076  * Similar to readfile_accel() but designed for strings.
2077  * @param string $string
2078  * @param string $mimetype
2079  * @param bool $accelerate
2080  * @return void
2081  */
2082 function readstring_accel($string, $mimetype, $accelerate) {
2083     global $CFG;
2085     if ($mimetype === 'text/plain') {
2086         // there is no encoding specified in text files, we need something consistent
2087         header('Content-Type: text/plain; charset=utf-8');
2088     } else {
2089         header('Content-Type: '.$mimetype);
2090     }
2091     header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
2092     header('Accept-Ranges: none');
2094     if ($accelerate and !empty($CFG->xsendfile)) {
2095         $fs = get_file_storage();
2096         if ($fs->xsendfile(sha1($string))) {
2097             return;
2098         }
2099     }
2101     header('Content-Length: '.strlen($string));
2102     echo $string;
2105 /**
2106  * Handles the sending of temporary file to user, download is forced.
2107  * File is deleted after abort or successful sending, does not return, script terminated
2108  *
2109  * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
2110  * @param string $filename proposed file name when saving file
2111  * @param bool $pathisstring If the path is string
2112  */
2113 function send_temp_file($path, $filename, $pathisstring=false) {
2114     global $CFG;
2116     if (check_browser_version('Firefox', '1.5')) {
2117         // only FF is known to correctly save to disk before opening...
2118         $mimetype = mimeinfo('type', $filename);
2119     } else {
2120         $mimetype = 'application/x-forcedownload';
2121     }
2123     // close session - not needed anymore
2124     session_get_instance()->write_close();
2126     if (!$pathisstring) {
2127         if (!file_exists($path)) {
2128             send_header_404();
2129             print_error('filenotfound', 'error', $CFG->wwwroot.'/');
2130         }
2131         // executed after normal finish or abort
2132         @register_shutdown_function('send_temp_file_finished', $path);
2133     }
2135     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2136     if (check_browser_version('MSIE')) {
2137         $filename = urlencode($filename);
2138     }
2140     header('Content-Disposition: attachment; filename="'.$filename.'"');
2141     if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2142         header('Cache-Control: max-age=10');
2143         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2144         header('Pragma: ');
2145     } else { //normal http - prevent caching at all cost
2146         header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2147         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2148         header('Pragma: no-cache');
2149     }
2151     // send the contents - we can not accelerate this because the file will be deleted asap
2152     if ($pathisstring) {
2153         readstring_accel($path, $mimetype, false);
2154     } else {
2155         readfile_accel($path, $mimetype, false);
2156         @unlink($path);
2157     }
2159     die; //no more chars to output
2162 /**
2163  * Internal callback function used by send_temp_file()
2164  *
2165  * @param string $path
2166  */
2167 function send_temp_file_finished($path) {
2168     if (file_exists($path)) {
2169         @unlink($path);
2170     }
2173 /**
2174  * Handles the sending of file data to the user's browser, including support for
2175  * byteranges etc.
2176  *
2177  * @category files
2178  * @param string $path Path of file on disk (including real filename), or actual content of file as string
2179  * @param string $filename Filename to send
2180  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
2181  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2182  * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname
2183  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2184  * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
2185  * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2186  *                        if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2187  *                        you must detect this case when control is returned using connection_aborted. Please not that session is closed
2188  *                        and should not be reopened.
2189  * @return null script execution stopped unless $dontdie is true
2190  */
2191 function send_file($path, $filename, $lifetime = 'default' , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='', $dontdie=false) {
2192     global $CFG, $COURSE;
2194     if ($dontdie) {
2195         ignore_user_abort(true);
2196     }
2198     // MDL-11789, apply $CFG->filelifetime here
2199     if ($lifetime === 'default') {
2200         if (!empty($CFG->filelifetime)) {
2201             $lifetime = $CFG->filelifetime;
2202         } else {
2203             $lifetime = 86400;
2204         }
2205     }
2207     session_get_instance()->write_close(); // unlock session during fileserving
2209     // Use given MIME type if specified, otherwise guess it using mimeinfo.
2210     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2211     // only Firefox saves all files locally before opening when content-disposition: attachment stated
2212     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
2213     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
2214                          ($mimetype ? $mimetype : mimeinfo('type', $filename));
2216     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2217     if (check_browser_version('MSIE')) {
2218         $filename = rawurlencode($filename);
2219     }
2221     if ($forcedownload) {
2222         header('Content-Disposition: attachment; filename="'.$filename.'"');
2223     } else {
2224         header('Content-Disposition: inline; filename="'.$filename.'"');
2225     }
2227     if ($lifetime > 0) {
2228         $nobyteserving = false;
2229         header('Cache-Control: max-age='.$lifetime);
2230         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2231         header('Pragma: ');
2233     } else { // Do not cache files in proxies and browsers
2234         $nobyteserving = true;
2235         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2236             header('Cache-Control: max-age=10');
2237             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2238             header('Pragma: ');
2239         } else { //normal http - prevent caching at all cost
2240             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2241             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2242             header('Pragma: no-cache');
2243         }
2244     }
2246     if (empty($filter)) {
2247         // send the contents
2248         if ($pathisstring) {
2249             readstring_accel($path, $mimetype, !$dontdie);
2250         } else {
2251             readfile_accel($path, $mimetype, !$dontdie);
2252         }
2254     } else {
2255         // Try to put the file through filters
2256         if ($mimetype == 'text/html') {
2257             $options = new stdClass();
2258             $options->noclean = true;
2259             $options->nocache = true; // temporary workaround for MDL-5136
2260             $text = $pathisstring ? $path : implode('', file($path));
2262             $text = file_modify_html_header($text);
2263             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2265             readstring_accel($output, $mimetype, false);
2267         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2268             // only filter text if filter all files is selected
2269             $options = new stdClass();
2270             $options->newlines = false;
2271             $options->noclean = true;
2272             $text = htmlentities($pathisstring ? $path : implode('', file($path)));
2273             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2275             readstring_accel($output, $mimetype, false);
2277         } else {
2278             // send the contents
2279             if ($pathisstring) {
2280                 readstring_accel($path, $mimetype, !$dontdie);
2281             } else {
2282                 readfile_accel($path, $mimetype, !$dontdie);
2283             }
2284         }
2285     }
2286     if ($dontdie) {
2287         return;
2288     }
2289     die; //no more chars to output!!!
2292 /**
2293  * Handles the sending of file data to the user's browser, including support for
2294  * byteranges etc.
2295  *
2296  * The $options parameter supports the following keys:
2297  *  (string|null) preview - send the preview of the file (e.g. "thumb" for a thumbnail)
2298  *  (string|null) filename - overrides the implicit filename
2299  *  (bool) dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2300  *      if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2301  *      you must detect this case when control is returned using connection_aborted. Please not that session is closed
2302  *      and should not be reopened.
2303  *
2304  * @category files
2305  * @param stored_file $stored_file local file object
2306  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
2307  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2308  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2309  * @param array $options additional options affecting the file serving
2310  * @return null script execution stopped unless $options['dontdie'] is true
2311  */
2312 function send_stored_file($stored_file, $lifetime=86400 , $filter=0, $forcedownload=false, array $options=array()) {
2313     global $CFG, $COURSE;
2315     if (empty($options['filename'])) {
2316         $filename = null;
2317     } else {
2318         $filename = $options['filename'];
2319     }
2321     if (empty($options['dontdie'])) {
2322         $dontdie = false;
2323     } else {
2324         $dontdie = true;
2325     }
2327     if (!empty($options['preview'])) {
2328         // replace the file with its preview
2329         $fs = get_file_storage();
2330         $preview_file = $fs->get_file_preview($stored_file, $options['preview']);
2331         if (!$preview_file) {
2332             // unable to create a preview of the file, send its default mime icon instead
2333             if ($options['preview'] === 'tinyicon') {
2334                 $size = 24;
2335             } else if ($options['preview'] === 'thumb') {
2336                 $size = 90;
2337             } else {
2338                 $size = 256;
2339             }
2340             $fileicon = file_file_icon($stored_file, $size);
2341             send_file($CFG->dirroot.'/pix/'.$fileicon.'.png', basename($fileicon).'.png');
2342         } else {
2343             // preview images have fixed cache lifetime and they ignore forced download
2344             // (they are generated by GD and therefore they are considered reasonably safe).
2345             $stored_file = $preview_file;
2346             $lifetime = DAYSECS;
2347             $filter = 0;
2348             $forcedownload = false;
2349         }
2350     }
2352     // handle external resource
2353     if ($stored_file && $stored_file->is_external_file() && !isset($options['sendcachedexternalfile'])) {
2354         $stored_file->send_file($lifetime, $filter, $forcedownload, $options);
2355         die;
2356     }
2358     if (!$stored_file or $stored_file->is_directory()) {
2359         // nothing to serve
2360         if ($dontdie) {
2361             return;
2362         }
2363         die;
2364     }
2366     if ($dontdie) {
2367         ignore_user_abort(true);
2368     }
2370     session_get_instance()->write_close(); // unlock session during fileserving
2372     // Use given MIME type if specified, otherwise guess it using mimeinfo.
2373     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2374     // only Firefox saves all files locally before opening when content-disposition: attachment stated
2375     $filename     = is_null($filename) ? $stored_file->get_filename() : $filename;
2376     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
2377     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
2378                          ($stored_file->get_mimetype() ? $stored_file->get_mimetype() : mimeinfo('type', $filename));
2380     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2381     if (check_browser_version('MSIE')) {
2382         $filename = rawurlencode($filename);
2383     }
2385     if ($forcedownload) {
2386         header('Content-Disposition: attachment; filename="'.$filename.'"');
2387     } else {
2388         header('Content-Disposition: inline; filename="'.$filename.'"');
2389     }
2391     if ($lifetime > 0) {
2392         header('Cache-Control: max-age='.$lifetime);
2393         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2394         header('Pragma: ');
2396     } else { // Do not cache files in proxies and browsers
2397         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2398             header('Cache-Control: max-age=10');
2399             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2400             header('Pragma: ');
2401         } else { //normal http - prevent caching at all cost
2402             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2403             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2404             header('Pragma: no-cache');
2405         }
2406     }
2408     if (empty($filter)) {
2409         // send the contents
2410         readfile_accel($stored_file, $mimetype, !$dontdie);
2412     } else {     // Try to put the file through filters
2413         if ($mimetype == 'text/html') {
2414             $options = new stdClass();
2415             $options->noclean = true;
2416             $options->nocache = true; // temporary workaround for MDL-5136
2417             $text = $stored_file->get_content();
2418             $text = file_modify_html_header($text);
2419             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2421             readstring_accel($output, $mimetype, false);
2423         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2424             // only filter text if filter all files is selected
2425             $options = new stdClass();
2426             $options->newlines = false;
2427             $options->noclean = true;
2428             $text = $stored_file->get_content();
2429             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2431             readstring_accel($output, $mimetype, false);
2433         } else {    // Just send it out raw
2434             readfile_accel($stored_file, $mimetype, !$dontdie);
2435         }
2436     }
2437     if ($dontdie) {
2438         return;
2439     }
2440     die; //no more chars to output!!!
2443 /**
2444  * Retrieves an array of records from a CSV file and places
2445  * them into a given table structure
2446  *
2447  * @global stdClass $CFG
2448  * @global moodle_database $DB
2449  * @param string $file The path to a CSV file
2450  * @param string $table The table to retrieve columns from
2451  * @return bool|array Returns an array of CSV records or false
2452  */
2453 function get_records_csv($file, $table) {
2454     global $CFG, $DB;
2456     if (!$metacolumns = $DB->get_columns($table)) {
2457         return false;
2458     }
2460     if(!($handle = @fopen($file, 'r'))) {
2461         print_error('get_records_csv failed to open '.$file);
2462     }
2464     $fieldnames = fgetcsv($handle, 4096);
2465     if(empty($fieldnames)) {
2466         fclose($handle);
2467         return false;
2468     }
2470     $columns = array();
2472     foreach($metacolumns as $metacolumn) {
2473         $ord = array_search($metacolumn->name, $fieldnames);
2474         if(is_int($ord)) {
2475             $columns[$metacolumn->name] = $ord;
2476         }
2477     }
2479     $rows = array();
2481     while (($data = fgetcsv($handle, 4096)) !== false) {
2482         $item = new stdClass;
2483         foreach($columns as $name => $ord) {
2484             $item->$name = $data[$ord];
2485         }
2486         $rows[] = $item;
2487     }
2489     fclose($handle);
2490     return $rows;
2493 /**
2494  * Create a file with CSV contents
2495  *
2496  * @global stdClass $CFG
2497  * @global moodle_database $DB
2498  * @param string $file The file to put the CSV content into
2499  * @param array $records An array of records to write to a CSV file
2500  * @param string $table The table to get columns from
2501  * @return bool success
2502  */
2503 function put_records_csv($file, $records, $table = NULL) {
2504     global $CFG, $DB;
2506     if (empty($records)) {
2507         return true;
2508     }
2510     $metacolumns = NULL;
2511     if ($table !== NULL && !$metacolumns = $DB->get_columns($table)) {
2512         return false;
2513     }
2515     echo "x";
2517     if(!($fp = @fopen($CFG->tempdir.'/'.$file, 'w'))) {
2518         print_error('put_records_csv failed to open '.$file);
2519     }
2521     $proto = reset($records);
2522     if(is_object($proto)) {
2523         $fields_records = array_keys(get_object_vars($proto));
2524     }
2525     else if(is_array($proto)) {
2526         $fields_records = array_keys($proto);
2527     }
2528     else {
2529         return false;
2530     }
2531     echo "x";
2533     if(!empty($metacolumns)) {
2534         $fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
2535         $fields = array_intersect($fields_records, $fields_table);
2536     }
2537     else {
2538         $fields = $fields_records;
2539     }
2541     fwrite($fp, implode(',', $fields));
2542     fwrite($fp, "\r\n");
2544     foreach($records as $record) {
2545         $array  = (array)$record;
2546         $values = array();
2547         foreach($fields as $field) {
2548             if(strpos($array[$field], ',')) {
2549                 $values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
2550             }
2551             else {
2552                 $values[] = $array[$field];
2553             }
2554         }
2555         fwrite($fp, implode(',', $values)."\r\n");
2556     }
2558     fclose($fp);
2559     return true;
2563 /**
2564  * Recursively delete the file or folder with path $location. That is,
2565  * if it is a file delete it. If it is a folder, delete all its content
2566  * then delete it. If $location does not exist to start, that is not
2567  * considered an error.
2568  *
2569  * @param string $location the path to remove.
2570  * @return bool
2571  */
2572 function fulldelete($location) {
2573     if (empty($location)) {
2574         // extra safety against wrong param
2575         return false;
2576     }
2577     if (is_dir($location)) {
2578         if (!$currdir = opendir($location)) {
2579             return false;
2580         }
2581         while (false !== ($file = readdir($currdir))) {
2582             if ($file <> ".." && $file <> ".") {
2583                 $fullfile = $location."/".$file;
2584                 if (is_dir($fullfile)) {
2585                     if (!fulldelete($fullfile)) {
2586                         return false;
2587                     }
2588                 } else {
2589                     if (!unlink($fullfile)) {
2590                         return false;
2591                     }
2592                 }
2593             }
2594         }
2595         closedir($currdir);
2596         if (! rmdir($location)) {
2597             return false;
2598         }
2600     } else if (file_exists($location)) {
2601         if (!unlink($location)) {
2602             return false;
2603         }
2604     }
2605     return true;
2608 /**
2609  * Send requested byterange of file.
2610  *
2611  * @param resource $handle A file handle
2612  * @param string $mimetype The mimetype for the output
2613  * @param array $ranges An array of ranges to send
2614  * @param string $filesize The size of the content if only one range is used
2615  */
2616 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2617     // better turn off any kind of compression and buffering
2618     @ini_set('zlib.output_compression', 'Off');
2620     $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2621     if ($handle === false) {
2622         die;
2623     }
2624     if (count($ranges) == 1) { //only one range requested
2625         $length = $ranges[0][2] - $ranges[0][1] + 1;
2626         header('HTTP/1.1 206 Partial content');
2627         header('Content-Length: '.$length);
2628         header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2629         header('Content-Type: '.$mimetype);
2631         while(@ob_get_level()) {
2632             if (!@ob_end_flush()) {
2633                 break;
2634             }
2635         }
2637         fseek($handle, $ranges[0][1]);
2638         while (!feof($handle) && $length > 0) {
2639             @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2640             $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2641             echo $buffer;
2642             flush();
2643             $length -= strlen($buffer);
2644         }
2645         fclose($handle);
2646         die;
2647     } else { // multiple ranges requested - not tested much
2648         $totallength = 0;
2649         foreach($ranges as $range) {
2650             $totallength += strlen($range[0]) + $range[2] - $range[1] + 1;
2651         }
2652         $totallength += strlen("\r\n--".BYTESERVING_BOUNDARY."--\r\n");
2653         header('HTTP/1.1 206 Partial content');
2654         header('Content-Length: '.$totallength);
2655         header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY);
2657         while(@ob_get_level()) {
2658             if (!@ob_end_flush()) {
2659                 break;
2660             }
2661         }
2663         foreach($ranges as $range) {
2664             $length = $range[2] - $range[1] + 1;
2665             echo $range[0];
2666             fseek($handle, $range[1]);
2667             while (!feof($handle) && $length > 0) {
2668                 @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2669                 $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2670                 echo $buffer;
2671                 flush();
2672                 $length -= strlen($buffer);
2673             }
2674         }
2675         echo "\r\n--".BYTESERVING_BOUNDARY."--\r\n";
2676         fclose($handle);
2677         die;
2678     }
2681 /**
2682  * add includes (js and css) into uploaded files
2683  * before returning them, useful for themes and utf.js includes
2684  *
2685  * @global stdClass $CFG
2686  * @param string $text text to search and replace
2687  * @return string text with added head includes
2688  * @todo MDL-21120
2689  */
2690 function file_modify_html_header($text) {
2691     // first look for <head> tag
2692     global $CFG;
2694     $stylesheetshtml = '';
2695 /*    foreach ($CFG->stylesheets as $stylesheet) {
2696         //TODO: MDL-21120
2697         $stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
2698     }*/
2700     $ufo = '';
2701     if (filter_is_enabled('filter/mediaplugin')) {
2702         // this script is needed by most media filter plugins.
2703         $attributes = array('type'=>'text/javascript', 'src'=>$CFG->httpswwwroot . '/lib/ufo.js');
2704         $ufo = html_writer::tag('script', '', $attributes) . "\n";
2705     }
2707     preg_match('/\<head\>|\<HEAD\>/', $text, $matches);
2708     if ($matches) {
2709         $replacement = '<head>'.$ufo.$stylesheetshtml;
2710         $text = preg_replace('/\<head\>|\<HEAD\>/', $replacement, $text, 1);
2711         return $text;
2712     }
2714     // if not, look for <html> tag, and stick <head> right after
2715     preg_match('/\<html\>|\<HTML\>/', $text, $matches);
2716     if ($matches) {
2717         // replace <html> tag with <html><head>includes</head>
2718         $replacement = '<html>'."\n".'<head>'.$ufo.$stylesheetshtml.'</head>';
2719         $text = preg_replace('/\<html\>|\<HTML\>/', $replacement, $text, 1);
2720         return $text;
2721     }
2723     // if not, look for <body> tag, and stick <head> before body
2724     preg_match('/\<body\>|\<BODY\>/', $text, $matches);
2725     if ($matches) {
2726         $replacement = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".'<body>';
2727         $text = preg_replace('/\<body\>|\<BODY\>/', $replacement, $text, 1);
2728         return $text;
2729     }
2731     // if not, just stick a <head> tag at the beginning
2732     $text = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".$text;
2733     return $text;
2736 /**
2737  * RESTful cURL class
2738  *
2739  * This is a wrapper class for curl, it is quite easy to use:
2740  * <code>
2741  * $c = new curl;
2742  * // enable cache
2743  * $c = new curl(array('cache'=>true));
2744  * // enable cookie
2745  * $c = new curl(array('cookie'=>true));
2746  * // enable proxy
2747  * $c = new curl(array('proxy'=>true));
2748  *
2749  * // HTTP GET Method
2750  * $html = $c->get('http://example.com');
2751  * // HTTP POST Method
2752  * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2753  * // HTTP PUT Method
2754  * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2755  * </code>
2756  *
2757  * @package   core_files
2758  * @category files
2759  * @copyright Dongsheng Cai <dongsheng@moodle.com>
2760  * @license   http://www.gnu.org/copyleft/gpl.html GNU Public License
2761  */
2762 class curl {
2763     /** @var bool Caches http request contents */
2764     public  $cache    = false;
2765     /** @var bool Uses proxy */
2766     public  $proxy    = false;
2767     /** @var string library version */
2768     public  $version  = '0.4 dev';
2769     /** @var array http's response */
2770     public  $response = array();
2771     /** @var array http header */
2772     public  $header   = array();
2773     /** @var string cURL information */
2774     public  $info;
2775     /** @var string error */
2776     public  $error;
2777     /** @var int error code */
2778     public  $errno;
2780     /** @var array cURL options */
2781     private $options;
2782     /** @var string Proxy host */
2783     private $proxy_host = '';
2784     /** @var string Proxy auth */
2785     private $proxy_auth = '';
2786     /** @var string Proxy type */
2787     private $proxy_type = '';
2788     /** @var bool Debug mode on */
2789     private $debug    = false;
2790     /** @var bool|string Path to cookie file */
2791     private $cookie   = false;
2793     /**
2794      * Constructor
2795      *
2796      * @global stdClass $CFG
2797      * @param array $options
2798      */
2799     public function __construct($options = array()){
2800         global $CFG;
2801         if (!function_exists('curl_init')) {
2802             $this->error = 'cURL module must be enabled!';
2803             trigger_error($this->error, E_USER_ERROR);
2804             return false;
2805         }
2806         // the options of curl should be init here.
2807         $this->resetopt();
2808         if (!empty($options['debug'])) {
2809             $this->debug = true;
2810         }
2811         if(!empty($options['cookie'])) {
2812             if($options['cookie'] === true) {
2813                 $this->cookie = $CFG->dataroot.'/curl_cookie.txt';
2814             } else {
2815                 $this->cookie = $options['cookie'];
2816             }
2817         }
2818         if (!empty($options['cache'])) {
2819             if (class_exists('curl_cache')) {
2820                 if (!empty($options['module_cache'])) {
2821                     $this->cache = new curl_cache($options['module_cache']);
2822                 } else {
2823                     $this->cache = new curl_cache('misc');
2824                 }
2825             }
2826         }
2827         if (!empty($CFG->proxyhost)) {
2828             if (empty($CFG->proxyport)) {
2829                 $this->proxy_host = $CFG->proxyhost;
2830             } else {
2831                 $this->proxy_host = $CFG->proxyhost.':'.$CFG->proxyport;
2832             }
2833             if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
2834                 $this->proxy_auth = $CFG->proxyuser.':'.$CFG->proxypassword;
2835                 $this->setopt(array(
2836                             'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM,
2837                             'proxyuserpwd'=>$this->proxy_auth));
2838             }
2839             if (!empty($CFG->proxytype)) {
2840                 if ($CFG->proxytype == 'SOCKS5') {
2841                     $this->proxy_type = CURLPROXY_SOCKS5;
2842                 } else {
2843                     $this->proxy_type = CURLPROXY_HTTP;
2844                     $this->setopt(array('httpproxytunnel'=>false));
2845                 }
2846                 $this->setopt(array('proxytype'=>$this->proxy_type));
2847             }
2848         }
2849         if (!empty($this->proxy_host)) {
2850             $this->proxy = array('proxy'=>$this->proxy_host);
2851         }
2852     }
2853     /**
2854      * Resets the CURL options that have already been set
2855      */
2856     public function resetopt(){
2857         $this->options = array();
2858         $this->options['CURLOPT_USERAGENT']         = 'MoodleBot/1.0';
2859         // True to include the header in the output
2860         $this->options['CURLOPT_HEADER']            = 0;
2861         // True to Exclude the body from the output
2862         $this->options['CURLOPT_NOBODY']            = 0;
2863         // TRUE to follow any "Location: " header that the server
2864         // sends as part of the HTTP header (note this is recursive,
2865         // PHP will follow as many "Location: " headers that it is sent,
2866         // unless CURLOPT_MAXREDIRS is set).
2867         //$this->options['CURLOPT_FOLLOWLOCATION']    = 1;
2868         $this->options['CURLOPT_MAXREDIRS']         = 10;
2869         $this->options['CURLOPT_ENCODING']          = '';
2870         // TRUE to return the transfer as a string of the return
2871         // value of curl_exec() instead of outputting it out directly.
2872         $this->options['CURLOPT_RETURNTRANSFER']    = 1;
2873         $this->options['CURLOPT_BINARYTRANSFER']    = 0;
2874         $this->options['CURLOPT_SSL_VERIFYPEER']    = 0;
2875         $this->options['CURLOPT_SSL_VERIFYHOST']    = 2;
2876         $this->options['CURLOPT_CONNECTTIMEOUT']    = 30;
2877     }
2879     /**
2880      * Reset Cookie
2881      */
2882     public function resetcookie() {
2883         if (!empty($this->cookie)) {
2884             if (is_file($this->cookie)) {
2885                 $fp = fopen($this->cookie, 'w');
2886                 if (!empty($fp)) {
2887                     fwrite($fp, '');
2888                     fclose($fp);
2889                 }
2890             }
2891         }
2892     }
2894     /**
2895      * Set curl options
2896      *
2897      * @param array $options If array is null, this function will
2898      * reset the options to default value.
2899      */
2900     public function setopt($options = array()) {
2901         if (is_array($options)) {
2902             foreach($options as $name => $val){
2903                 if (stripos($name, 'CURLOPT_') === false) {
2904                     $name = strtoupper('CURLOPT_'.$name);
2905                 }
2906                 $this->options[$name] = $val;
2907             }
2908         }
2909     }
2911     /**
2912      * Reset http method
2913      */
2914     public function cleanopt(){
2915         unset($this->options['CURLOPT_HTTPGET']);
2916         unset($this->options['CURLOPT_POST']);
2917         unset($this->options['CURLOPT_POSTFIELDS']);
2918         unset($this->options['CURLOPT_PUT']);
2919         unset($this->options['CURLOPT_INFILE']);
2920         unset($this->options['CURLOPT_INFILESIZE']);
2921         unset($this->options['CURLOPT_CUSTOMREQUEST']);
2922         unset($this->options['CURLOPT_FILE']);
2923     }
2925     /**
2926      * Resets the HTTP Request headers (to prepare for the new request)
2927      */
2928     public function resetHeader() {
2929         $this->header = array();
2930     }
2932     /**
2933      * Set HTTP Request Header
2934      *
2935      * @param array $header
2936      */
2937     public function setHeader($header) {
2938         if (is_array($header)){
2939             foreach ($header as $v) {
2940                 $this->setHeader($v);
2941             }
2942         } else {
2943             $this->header[] = $header;
2944         }
2945     }
2947     /**
2948      * Set HTTP Response Header
2949      *
2950      */
2951     public function getResponse(){
2952         return $this->response;
2953     }
2955     /**
2956      * private callback function
2957      * Formatting HTTP Response Header
2958      *
2959      * @param resource $ch Apparently not used
2960      * @param string $header
2961      * @return int The strlen of the header
2962      */
2963     private function formatHeader($ch, $header)
2964     {
2965         $this->count++;
2966         if (strlen($header) > 2) {
2967             list($key, $value) = explode(" ", rtrim($header, "\r\n"), 2);
2968             $key = rtrim($key, ':');
2969             if (!empty($this->response[$key])) {
2970                 if (is_array($this->response[$key])){
2971                     $this->response[$key][] = $value;
2972                 } else {
2973                     $tmp = $this->response[$key];
2974                     $this->response[$key] = array();
2975                     $this->response[$key][] = $tmp;
2976                     $this->response[$key][] = $value;
2978                 }
2979             } else {
2980                 $this->response[$key] = $value;
2981             }
2982         }
2983         return strlen($header);
2984     }
2986     /**
2987      * Set options for individual curl instance
2988      *
2989      * @param resource $curl A curl handle
2990      * @param array $options
2991      * @return resource The curl handle
2992      */
2993     private function apply_opt($curl, $options) {
2994         // Clean up
2995         $this->cleanopt();
2996         // set cookie
2997         if (!empty($this->cookie) || !empty($options['cookie'])) {
2998             $this->setopt(array('cookiejar'=>$this->cookie,
2999                             'cookiefile'=>$this->cookie
3000                              ));
3001         }
3003         // set proxy
3004         if (!empty($this->proxy) || !empty($options['proxy'])) {
3005             $this->setopt($this->proxy);
3006         }
3007         $this->setopt($options);
3008         // reset before set options
3009         curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this,'formatHeader'));
3010         // set headers
3011         if (empty($this->header)){
3012             $this->setHeader(array(
3013                 'User-Agent: MoodleBot/1.0',
3014                 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
3015                 'Connection: keep-alive'
3016                 ));
3017         }
3018         curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
3020         if ($this->debug){
3021             echo '<h1>Options</h1>';
3022             var_dump($this->options);
3023             echo '<h1>Header</h1>';
3024             var_dump($this->header);
3025         }
3027         // set options
3028         foreach($this->options as $name => $val) {
3029             if (is_string($name)) {
3030                 $name = constant(strtoupper($name));
3031             }
3032             curl_setopt($curl, $name, $val);
3033         }
3034         return $curl;
3035     }
3037     /**
3038      * Download multiple files in parallel
3039      *
3040      * Calls {@link multi()} with specific download headers
3041      *
3042      * <code>
3043      * $c = new curl();
3044      * $file1 = fopen('a', 'wb');
3045      * $file2 = fopen('b', 'wb');
3046      * $c->download(array(
3047      *     array('url'=>'http://localhost/', 'file'=>$file1),
3048      *     array('url'=>'http://localhost/20/', 'file'=>$file2)
3049      * ));
3050      * fclose($file1);
3051      * fclose($file2);
3052      * </code>
3053      *
3054      * or
3055      *
3056      * <code>
3057      * $c = new curl();
3058      * $c->download(array(
3059      *              array('url'=>'http://localhost/', 'filepath'=>'/tmp/file1.tmp'),
3060      *              array('url'=>'http://localhost/20/', 'filepath'=>'/tmp/file2.tmp')
3061      *              ));
3062      * </code>
3063      *
3064      * @param array $requests An array of files to request {
3065      *                  url => url to download the file [required]
3066      *                  file => file handler, or
3067      *                  filepath => file path
3068      * }
3069      * If 'file' and 'filepath' parameters are both specified in one request, the
3070      * open file handle in the 'file' parameter will take precedence and 'filepath'
3071      * will be ignored.
3072      *
3073      * @param array $options An array of options to set
3074      * @return array An array of results
3075      */
3076     public function download($requests, $options = array()) {
3077         $options['CURLOPT_BINARYTRANSFER'] = 1;
3078         $options['RETURNTRANSFER'] = false;
3079         return $this->multi($requests, $options);
3080     }
3082     /**
3083      * Mulit HTTP Requests
3084      * This function could run multi-requests in parallel.
3085      *
3086      * @param array $requests An array of files to request
3087      * @param array $options An array of options to set
3088      * @return array An array of results
3089      */
3090     protected function multi($requests, $options = array()) {
3091         $count   = count($requests);
3092         $handles = array();
3093         $results = array();
3094         $main    = curl_multi_init();
3095         for ($i = 0; $i < $count; $i++) {
3096             if (!empty($requests[$i]['filepath']) and empty($requests[$i]['file'])) {
3097                 // open file
3098                 $requests[$i]['file'] = fopen($requests[$i]['filepath'], 'w');
3099                 $requests[$i]['auto-handle'] = true;
3100             }
3101             foreach($requests[$i] as $n=>$v){
3102                 $options[$n] = $v;
3103             }
3104             $handles[$i] = curl_init($requests[$i]['url']);
3105             $this->apply_opt($handles[$i], $options);
3106             curl_multi_add_handle($main, $handles[$i]);
3107         }
3108         $running = 0;
3109         do {
3110             curl_multi_exec($main, $running);
3111         } while($running > 0);
3112         for ($i = 0; $i < $count; $i++) {
3113             if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
3114                 $results[] = true;
3115             } else {
3116                 $results[] = curl_multi_getcontent($handles[$i]);
3117             }
3118             curl_multi_remove_handle($main, $handles[$i]);
3119         }
3120         curl_multi_close($main);
3122         for ($i = 0; $i < $count; $i++) {
3123             if (!empty($requests[$i]['filepath']) and !empty($requests[$i]['auto-handle'])) {
3124                 // close file handler if file is opened in this function
3125                 fclose($requests[$i]['file']);
3126             }
3127         }
3128         return $results;
3129     }
3131     /**
3132      * Single HTTP Request
3133      *
3134      * @param string $url The URL to request
3135      * @param array $options
3136      * @return bool
3137      */
3138     protected function request($url, $options = array()){
3139         // create curl instance
3140         $curl = curl_init($url);
3141         $options['url'] = $url;
3142         $this->apply_opt($curl, $options);
3143         if ($this->cache && $ret = $this->cache->get($this->options)) {
3144             return $ret;
3145         } else {
3146             $ret = curl_exec($curl);
3147             if ($this->cache) {
3148                 $this->cache->set($this->options, $ret);
3149             }
3150         }
3152         $this->info  = curl_getinfo($curl);
3153         $this->error = curl_error($curl);
3154         $this->errno = curl_errno($curl);
3156         if ($this->debug){
3157             echo '<h1>Return Data</h1>';
3158             var_dump($ret);
3159             echo '<h1>Info</h1>';
3160             var_dump($this->info);
3161             echo '<h1>Error</h1>';
3162             var_dump($this->error);
3163         }
3165         curl_close($curl);
3167         if (empty($this->error)){
3168             return $ret;
3169         } else {
3170             return $this->error;
3171             // exception is not ajax friendly
3172             //throw new moodle_exception($this->error, 'curl');
3173         }
3174     }
3176     /**
3177      * HTTP HEAD method
3178      *
3179      * @see request()
3180      *
3181      * @param string $url
3182      * @param array $options
3183      * @return bool
3184      */
3185     public function head($url, $options = array()){
3186         $options['CURLOPT_HTTPGET'] = 0;
3187         $options['CURLOPT_HEADER']  = 1;
3188         $options['CURLOPT_NOBODY']  = 1;
3189         return $this->request($url, $options);
3190     }
3192     /**
3193      * HTTP POST method
3194      *
3195      * @param string $url
3196      * @param array|string $params
3197      * @param array $options
3198      * @return bool
3199      */
3200     public function post($url, $params = '', $options = array()){
3201         $options['CURLOPT_POST']       = 1;
3202         if (is_array($params)) {
3203             $this->_tmp_file_post_params = array();
3204             foreach ($params as $key => $value) {
3205                 if ($value instanceof stored_file) {
3206                     $value->add_to_curl_request($this, $key);
3207                 } else {
3208                     $this->_tmp_file_post_params[$key] = $value;
3209                 }
3210             }
3211             $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
3212             unset($this->_tmp_file_post_params);
3213         } else {
3214             // $params is the raw post data
3215             $options['CURLOPT_POSTFIELDS'] = $params;
3216         }
3217         return $this->request($url, $options);
3218     }
3220     /**
3221      * HTTP GET method
3222      *
3223      * @param string $url
3224      * @param array $params
3225      * @param array $options
3226      * @return bool
3227      */
3228     public function get($url, $params = array(), $options = array()){
3229         $options['CURLOPT_HTTPGET'] = 1;
3231         if (!empty($params)){
3232             $url .= (stripos($url, '?') !== false) ? '&' : '?';
3233             $url .= http_build_query($params, '', '&');
3234         }
3235         return $this->request($url, $options);
3236     }
3238     /**
3239      * Downloads one file and writes it to the specified file handler
3240      *
3241      * <code>
3242      * $c = new curl();
3243      * $file = fopen('savepath', 'w');
3244      * $result = $c->download_one('http://localhost/', null,
3245      *   array('file' => $file, 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3246      * fclose($file);
3247      * $download_info = $c->get_info();
3248      * if ($result === true) {
3249      *   // file downloaded successfully
3250      * } else {
3251      *   $error_text = $result;
3252      *   $error_code = $c->get_errno();
3253      * }
3254      * </code>
3255      *
3256      * <code>
3257      * $c = new curl();
3258      * $result = $c->download_one('http://localhost/', null,
3259      *   array('filepath' => 'savepath', 'timeout' => 5, 'followlocation' => true, 'maxredirs' => 3));
3260      * // ... see above, no need to close handle and remove file if unsuccessful
3261      * </code>
3262      *
3263      * @param string $url
3264      * @param array|null $params key-value pairs to be added to $url as query string
3265      * @param array $options request options. Must include either 'file' or 'filepath'
3266      * @return bool|string true on success or error string on failure
3267      */
3268     public function download_one($url, $params, $options = array()) {
3269         $options['CURLOPT_HTTPGET'] = 1;
3270         $options['CURLOPT_BINARYTRANSFER'] = true;
3271         if (!empty($params)){
3272             $url .= (stripos($url, '?') !== false) ? '&' : '?';
3273             $url .= http_build_query($params, '', '&');
3274         }
3275         if (!empty($options['filepath']) && empty($options['file'])) {
3276             // open file
3277             if (!($options['file'] = fopen($options['filepath'], 'w'))) {
3278                 $this->errno = 100;
3279                 return get_string('cannotwritefile', 'error', $options['filepath']);
3280             }
3281             $filepath = $options['filepath'];
3282         }
3283         unset($options['filepath']);
3284         $result = $this->request($url, $options);
3285         if (isset($filepath)) {
3286             fclose($options['file']);
3287             if ($result !== true) {
3288                 unlink($filepath);
3289             }
3290         }
3291         return $result;
3292     }
3294     /**
3295      * HTTP PUT method
3296      *
3297      * @param string $url
3298      * @param array $params
3299      * @param array $options
3300      * @return bool
3301      */
3302     public function put($url, $params = array(), $options = array()){
3303         $file = $params['file'];
3304         if (!is_file($file)){
3305             return null;
3306         }
3307         $fp   = fopen($file, 'r');
3308         $size = filesize($file);
3309         $options['CURLOPT_PUT']        = 1;
3310         $options['CURLOPT_INFILESIZE'] = $size;
3311         $options['CURLOPT_INFILE']     = $fp;
3312         if (!isset($this->options['CURLOPT_USERPWD'])){
3313             $this->setopt(array('CURLOPT_USERPWD'=>'anonymous: noreply@moodle.org'));
3314         }
3315         $ret = $this->request($url, $options);
3316         fclose($fp);
3317         return $ret;
3318     }
3320     /**
3321      * HTTP DELETE method
3322      *
3323      * @param string $url
3324      * @param array $param
3325      * @param array $options
3326      * @return bool
3327      */
3328     public function delete($url, $param = array(), $options = array()){
3329         $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
3330         if (!isset($options['CURLOPT_USERPWD'])) {
3331             $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
3332         }
3333         $ret = $this->request($url, $options);
3334         return $ret;
3335     }
3337     /**
3338      * HTTP TRACE method
3339      *
3340      * @param string $url
3341      * @param array $options
3342      * @return bool
3343      */
3344     public function trace($url, $options = array()){
3345         $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
3346         $ret = $this->request($url, $options);
3347         return $ret;
3348     }
3350     /**
3351      * HTTP OPTIONS method
3352      *
3353      * @param string $url
3354      * @param array $options
3355      * @return bool
3356      */
3357     public function options($url, $options = array()){
3358         $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
3359         $ret = $this->request($url, $options);
3360         return $ret;
3361     }
3363     /**
3364      * Get curl information
3365      *
3366      * @return string
3367      */
3368     public function get_info() {
3369         return $this->info;
3370     }
3372     /**
3373      * Get curl error code
3374      *
3375      * @return int
3376      */
3377     public function get_errno() {
3378         return $this->errno;
3379     }
3382 /**
3383  * This class is used by cURL class, use case:
3384  *
3385  * <code>
3386  * $CFG->repositorycacheexpire = 120;
3387  * $CFG->curlcache = 120;
3388  *
3389  * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
3390  * $ret = $c->get('http://www.google.com');
3391  * </code>
3392  *
3393  * @package   core_files
3394  * @copyright Dongsheng Cai <dongsheng@moodle.com>
3395  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3396  */
3397 class curl_cache {
3398     /** @var string Path to cache directory */
3399     public $dir = '';
3401     /**
3402      * Constructor
3403      *
3404      * @global stdClass $CFG
3405      * @param string $module which module is using curl_cache
3406      */
3407     public function __construct($module = 'repository') {
3408         global $CFG;
3409         if (!empty($module)) {
3410             $this->dir = $CFG->cachedir.'/'.$module.'/';
3411         } else {
3412             $this->dir = $CFG->cachedir.'/misc/';
3413         }
3414         if (!file_exists($this->dir)) {
3415             mkdir($this->dir, $CFG->directorypermissions, true);
3416         }
3417         if ($module == 'repository') {
3418             if (empty($CFG->repositorycacheexpire)) {
3419                 $CFG->repositorycacheexpire = 120;
3420             }
3421             $this->ttl = $CFG->repositorycacheexpire;
3422         } else {
3423             if (empty($CFG->curlcache)) {
3424                 $CFG->curlcache = 120;
3425             }
3426             $this->ttl = $CFG->curlcache;
3427         }
3428     }
3430     /**
3431      * Get cached value
3432      *
3433      * @global stdClass $CFG
3434      * @global stdClass $USER
3435      * @param mixed $param
3436      * @return bool|string
3437      */
3438     public function get($param) {
3439         global $CFG, $USER;
3440         $this->cleanup($this->ttl);
3441         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3442         if(file_exists($this->dir.$filename)) {
3443             $lasttime = filemtime($this->dir.$filename);
3444             if (time()-$lasttime > $this->ttl) {
3445                 return false;
3446             } else {
3447                 $fp = fopen($this->dir.$filename, 'r');
3448                 $size = filesize($this->dir.$filename);
3449                 $content = fread($fp, $size);
3450                 return unserialize($content);
3451             }
3452         }
3453         return false;
3454     }
3456     /**
3457      * Set cache value
3458      *
3459      * @global object $CFG
3460      * @global object $USER
3461      * @param mixed $param
3462      * @param mixed $val
3463      */
3464     public function set($param, $val) {
3465         global $CFG, $USER;
3466         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3467         $fp = fopen($this->dir.$filename, 'w');
3468         fwrite($fp, serialize($val));
3469         fclose($fp);
3470     }
3472     /**
3473      * Remove cache files
3474      *
3475      * @param int $expire The number of seconds before expiry
3476      */
3477     public function cleanup($expire) {
3478         if ($dir = opendir($this->dir)) {
3479             while (false !== ($file = readdir($dir))) {
3480                 if(!is_dir($file) && $file != '.' && $file != '..') {
3481                     $lasttime = @filemtime($this->dir.$file);
3482                     if (time() - $lasttime > $expire) {
3483                         @unlink($this->dir.$file);
3484                     }
3485                 }
3486             }
3487             closedir($dir);
3488         }
3489     }
3490     /**
3491      * delete current user's cache file
3492      *
3493      * @global object $CFG
3494      * @global object $USER
3495      */
3496     public function refresh() {
3497         global $CFG, $USER;
3498         if ($dir = opendir($this->dir)) {
3499             while (false !== ($file = readdir($dir))) {
3500                 if (!is_dir($file) && $file != '.' && $file != '..') {
3501                     if (strpos($file, 'u'.$USER->id.'_') !== false) {
3502                         @unlink($this->dir.$file);
3503                     }
3504                 }
3505             }
3506         }
3507     }
3510 /**
3511  * This function delegates file serving to individual plugins
3512  *
3513  * @param string $relativepath
3514  * @param bool $forcedownload
3515  * @param null|string $preview the preview mode, defaults to serving the original file
3516  * @todo MDL-31088 file serving improments
3517  */
3518 function file_pluginfile($relativepath, $forcedownload, $preview = null) {
3519     global $DB, $CFG, $USER;
3520     // relative path must start with '/'
3521     if (!$relativepath) {
3522         print_error('invalidargorconf');
3523     } else if ($relativepath[0] != '/') {
3524         print_error('pathdoesnotstartslash');
3525     }
3527     // extract relative path components
3528     $args = explode('/', ltrim($relativepath, '/'));
3530     if (count($args) < 3) { // always at least context, component and filearea
3531         print_error('invalidarguments');
3532     }
3534     $contextid = (int)array_shift($args);
3535     $component = clean_param(array_shift($args), PARAM_COMPONENT);
3536     $filearea  = clean_param(array_shift($args), PARAM_AREA);
3538     list($context, $course, $cm) = get_context_info_array($contextid);
3540     $fs = get_file_storage();
3542     // ========================================================================================================================
3543     if ($component === 'blog') {
3544         // Blog file serving
3545         if ($context->contextlevel != CONTEXT_SYSTEM) {
3546             send_file_not_found();
3547         }
3548         if ($filearea !== 'attachment' and $filearea !== 'post') {
3549             send_file_not_found();
3550         }
3552         if (empty($CFG->enableblogs)) {
3553             print_error('siteblogdisable', 'blog');
3554         }
3556         $entryid = (int)array_shift($args);
3557         if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
3558             send_file_not_found();
3559         }
3560         if ($CFG->bloglevel < BLOG_GLOBAL_LEVEL) {
3561             require_login();
3562             if (isguestuser()) {
3563                 print_error('noguest');
3564             }
3565             if ($CFG->bloglevel == BLOG_USER_LEVEL) {
3566                 if ($USER->id != $entry->userid) {
3567                     send_file_not_found();
3568                 }
3569             }
3570         }
3572         if ($entry->publishstate === 'public') {
3573             if ($CFG->forcelogin) {
3574                 require_login();
3575             }
3577         } else if ($entry->publishstate === 'site') {
3578             require_login();
3579             //ok
3580         } else if ($entry->publishstate === 'draft') {
3581             require_login();
3582             if ($USER->id != $entry->userid) {
3583                 send_file_not_found();
3584             }
3585         }
3587         $filename = array_pop($args);
3588         $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3590         if (!$file = $fs->get_file($context->id, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
3591             send_file_not_found();
3592         }
3594         send_stored_file($file, 10*60, 0, true, array('preview' => $preview)); // download MUST be forced - security!
3596     // ========================================================================================================================
3597     } else if ($component === 'grade') {
3598         if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel == CONTEXT_SYSTEM) {
3599             // Global gradebook files
3600             if ($CFG->forcelogin) {
3601                 require_login();
3602             }
3604             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3606             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3607                 send_file_not_found();
3608             }
3610             session_get_instance()->write_close(); // unlock session during fileserving
3611             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3613         } else if ($filearea === 'feedback' and $context->contextlevel == CONTEXT_COURSE) {
3614             //TODO: nobody implemented this yet in grade edit form!!
3615             send_file_not_found();
3617             if ($CFG->forcelogin || $course->id != SITEID) {
3618                 require_login($course);
3619             }
3621             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3623             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3624                 send_file_not_found();
3625             }
3627             session_get_instance()->write_close(); // unlock session during fileserving
3628             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3629         } else {
3630             send_file_not_found();
3631         }
3633     // ========================================================================================================================
3634     } else if ($component === 'tag') {
3635         if ($filearea === 'description' and $context->contextlevel == CONTEXT_SYSTEM) {
3637             // All tag descriptions are going to be public but we still need to respect forcelogin
3638             if ($CFG->forcelogin) {
3639                 require_login();
3640             }
3642             $fullpath = "/$context->id/tag/description/".implode('/', $args);
3644             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3645                 send_file_not_found();
3646             }
3648             session_get_instance()->write_close(); // unlock session during fileserving
3649             send_stored_file($file, 60*60, 0, true, array('preview' => $preview));
3651         } else {
3652             send_file_not_found();
3653         }
3655     // ========================================================================================================================
3656     } else if ($component === 'calendar') {
3657         if ($filearea === 'event_description'  and $context->contextlevel == CONTEXT_SYSTEM) {
3659             // All events here are public the one requirement is that we respect forcelogin
3660             if ($CFG->forcelogin) {
3661                 require_login();
3662             }
3664             // Get the event if from the args array
3665             $eventid = array_shift($args);
3667             // Load the event from the database
3668             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'eventtype'=>'site'))) {
3669                 send_file_not_found();
3670             }
3671             // Check that we got an event and that it's userid is that of the user
3673             // Get the file and serve if successful
3674             $filename = array_pop($args);
3675             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3676             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3677                 send_file_not_found();
3678             }
3680             session_get_instance()->write_close(); // unlock session during fileserving
3681             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3683         } else if ($filearea === 'event_description' and $context->contextlevel == CONTEXT_USER) {
3685             // Must be logged in, if they are not then they obviously can't be this user
3686             require_login();
3688             // Don't want guests here, potentially saves a DB call
3689             if (isguestuser()) {
3690                 send_file_not_found();
3691             }
3693             // Get the event if from the args array
3694             $eventid = array_shift($args);
3696             // Load the event from the database - user id must match
3697             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'userid'=>$USER->id, 'eventtype'=>'user'))) {
3698                 send_file_not_found();
3699             }
3701             // Get the file and serve if successful
3702             $filename = array_pop($args);
3703             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3704             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3705                 send_file_not_found();
3706             }
3708             session_get_instance()->write_close(); // unlock session during fileserving
3709             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3711         } else if ($filearea === 'event_description' and $context->contextlevel == CONTEXT_COURSE) {
3713             // Respect forcelogin and require login unless this is the site.... it probably
3714             // should NEVER be the site
3715             if ($CFG->forcelogin || $course->id != SITEID) {
3716                 require_login($course);
3717             }
3719             // Must be able to at least view the course
3720             if (!is_enrolled($context) and !is_viewing($context)) {
3721                 //TODO: hmm, do we really want to block guests here?
3722                 send_file_not_found();
3723             }
3725             // Get the event id
3726             $eventid = array_shift($args);
3728             // Load the event from the database we need to check whether it is
3729             // a) valid course event
3730             // b) a group event
3731             // Group events use the course context (there is no group context)
3732             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'courseid'=>$course->id))) {
3733                 send_file_not_found();
3734             }
3736             // If its a group event require either membership of view all groups capability
3737             if ($event->eventtype === 'group') {
3738                 if (!has_capability('moodle/site:accessallgroups', $context) && !groups_is_member($event->groupid, $USER->id)) {
3739                     send_file_not_found();
3740                 }
3741             } else if ($event->eventtype === 'course') {
3742                 //ok
3743             } else {
3744                 // some other type
3745                 send_file_not_found();
3746             }
3748             // If we get this far we can serve the file
3749             $filename = array_pop($args);
3750             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3751             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $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, array('preview' => $preview));
3758         } else {
3759             send_file_not_found();
3760         }
3762     // ========================================================================================================================
3763     } else if ($component === 'user') {
3764         if ($filearea === 'icon' and $context->contextlevel == CONTEXT_USER) {
3765             if (count($args) == 1) {
3766                 $themename = theme_config::DEFAULT_THEME;
3767                 $filename = array_shift($args);
3768             } else {
3769                 $themename = array_shift($args);
3770                 $filename = array_shift($args);
3771             }
3773             // fix file name automatically
3774             if ($filename !== 'f1' and $filename !== 'f2' and $filename !== 'f3') {
3775                 $filename = 'f1';
3776             }
3778             if ((!empty($CFG->forcelogin) and !isloggedin()) ||
3779                     (!empty($CFG->forceloginforprofileimage) && (!isloggedin() || isguestuser()))) {
3780                 // protect images if login required and not logged in;
3781                 // also if login is required for profile images and is not logged in or guest
3782                 // do not use require_login() because it is expensive and not suitable here anyway
3783                 $theme = theme_config::load($themename);
3784                 redirect($theme->pix_url('u/'.$filename, 'moodle')); // intentionally not cached
3785             }
3787             if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', $filename.'.png')) {
3788                 if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', $filename.'.jpg')) {
3789                     if ($filename === 'f3') {
3790                         // f3 512x512px was introduced in 2.3, there might be only the smaller version.
3791                         if (!$file = $fs->get_file($context->id, 'user', 'icon', 0, '/', 'f1.png')) {
3792                             $file = $fs->get_file($context->id, 'user', 'icon', 0, '/', 'f1.jpg');
3793                         }
3794                     }
3795                 }
3796             }
3797             if (!$file) {
3798                 // bad reference - try to prevent future retries as hard as possible!
3799                 if ($user = $DB->get_record('user', array('id'=>$context->instanceid), 'id, picture')) {
3800                     if ($user->picture > 0) {
3801                         $DB->set_field('user', 'picture', 0, array('id'=>$user->id));
3802                     }
3803                 }
3804                 // no redirect here because it is not cached
3805                 $theme = theme_config::load($themename);
3806                 $imagefile = $theme->resolve_image_location('u/'.$filename, 'moodle', null);
3807                 send_file($imagefile, basename($imagefile), 60*60*24*14);
3808             }
3810             send_stored_file($file, 60*60*24*365, 0, false, array('preview' => $preview)); // enable long caching, there are many images on each page
3812         } else if ($filearea === 'private' and $context->contextlevel == CONTEXT_USER) {
3813             require_login();
3815             if (isguestuser()) {
3816                 send_file_not_found();
3817             }
3819             if ($USER->id !== $context->instanceid) {
3820                 send_file_not_found();
3821             }
3823             $filename = array_pop($args);
3824             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3825             if (!$file = $fs->get_file($context->id, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
3826                 send_file_not_found();
3827             }
3829             session_get_instance()->write_close(); // unlock session during fileserving
3830             send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
3832         } else if ($filearea === 'profile' and $context->contextlevel == CONTEXT_USER) {
3834             if ($CFG->forcelogin) {
3835                 require_login();
3836             }
3838             $userid = $context->instanceid;
3840             if ($USER->id == $userid) {
3841                 // always can access own
3843             } else if (!empty($CFG->forceloginforprofiles)) {
3844                 require_login();
3846                 if (isguestuser()) {
3847                     send_file_not_found();
3848                 }
3850                 // we allow access to site profile of all course contacts (usually teachers)
3851                 if (!has_coursecontact_role($userid) && !has_capability('moodle/user:viewdetails', $context)) {
3852                     send_file_not_found();
3853                 }
3855                 $canview = false;
3856                 if (has_capability('moodle/user:viewdetails', $context)) {
3857                     $canview = true;
3858                 } else {
3859                     $courses = enrol_get_my_courses();
3860                 }
3862                 while (!$canview && count($courses) > 0) {
3863                     $course = array_shift($courses);
3864                     if (has_capability('moodle/user:viewdetails', context_course::instance($course->id))) {
3865                         $canview = true;
3866                     }
3867                 }
3868             }
3870             $filename = array_pop($args);
3871             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3872             if (!$file = $fs->get_file($context->id, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
3873                 send_file_not_found();
3874             }
3876             session_get_instance()->write_close(); // unlock session during fileserving
3877             send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
3879         } else if ($filearea === 'profile' and $context->contextlevel == CONTEXT_COURSE) {
3880             $userid = (int)array_shift($args);
3881             $usercontext = context_user::instance($userid);
3883             if ($CFG->forcelogin) {
3884                 require_login();
3885             }
3887             if (!empty($CFG->forceloginforprofiles)) {
3888                 require_login();
3889                 if (isguestuser()) {
3890                     print_error('noguest');
3891                 }
3893                 //TODO: review this logic of user profile access prevention
3894                 if (!has_coursecontact_role($userid) and !has_capability('moodle/user:viewdetails', $usercontext)) {
3895                     print_error('usernotavailable');
3896                 }
3897                 if (!has_capability('moodle/user:viewdetails', $context) && !has_capability('moodle/user:viewdetails', $usercontext)) {
3898                     print_error('cannotviewprofile');
3899                 }
3900                 if (!is_enrolled($context, $userid)) {
3901                     print_error('notenrolledprofile');
3902                 }
3903                 if (groups_get_course_groupmode($course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3904                     print_error('groupnotamember');
3905                 }
3906             }
3908             $filename = array_pop($args);
3909             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3910             if (!$file = $fs->get_file($usercontext->id, 'user', 'profile', 0, $filepath, $filename) or $file->is_directory()) {
3911                 send_file_not_found();
3912             }
3914             session_get_instance()->write_close(); // unlock session during fileserving
3915             send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
3917         } else if ($filearea === 'backup' and $context->contextlevel == CONTEXT_USER) {
3918             require_login();
3920             if (isguestuser()) {
3921                 send_file_not_found();
3922             }
3923             $userid = $context->instanceid;
3925             if ($USER->id != $userid) {
3926                 send_file_not_found();
3927             }
3929             $filename = array_pop($args);
3930             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3931             if (!$file = $fs->get_file($context->id, 'user', 'backup', 0, $filepath, $filename) or $file->is_directory()) {
3932                 send_file_not_found();
3933             }
3935             session_get_instance()->write_close(); // unlock session during fileserving
3936             send_stored_file($file, 0, 0, true, array('preview' => $preview)); // must force download - security!
3938         } else {
3939             send_file_not_found();
3940         }
3942     // ========================================================================================================================
3943     } else if ($component === 'coursecat') {
3944         if ($context->contextlevel != CONTEXT_COURSECAT) {
3945             send_file_not_found();
3946         }
3948         if ($filearea === 'description') {
3949             if ($CFG->forcelogin) {
3950                 // no login necessary - unless login forced everywhere
3951                 require_login();
3952             }
3954             $filename = array_pop($args);
3955             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3956             if (!$file = $fs->get_file($context->id, 'coursecat', 'description', 0, $filepath, $filename) or $file->is_directory()) {
3957                 send_file_not_found();
3958             }
3960             session_get_instance()->write_close(); // unlock session during fileserving
3961             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3962         } else {
3963             send_file_not_found();
3964         }
3966     // ========================================================================================================================
3967     } else if ($component === 'course') {
3968         if ($context->contextlevel != CONTEXT_COURSE) {
3969             send_file_not_found();
3970         }
3972         if ($filearea === 'summary') {
3973             if ($CFG->forcelogin) {
3974                 require_login();
3975             }
3977             $filename = array_pop($args);
3978             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3979             if (!$file = $fs->get_file($context->id, 'course', 'summary', 0, $filepath, $filename) or $file->is_directory()) {
3980                 send_file_not_found();
3981             }
3983             session_get_instance()->write_close(); // unlock session during fileserving
3984             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3986         } else if ($filearea === 'section') {
3987             if ($CFG->forcelogin) {
3988                 require_login($course);
3989             } else if ($course->id != SITEID) {
3990                 require_login($course);
3991             }
3993             $sectionid = (int)array_shift($args);
3995             if (!$section = $DB->get_record('course_sections', array('id'=>$sectionid, 'course'=>$course->id))) {
3996                 send_file_not_found();
3997             }
3999             if ($course->numsections < $section->section) {
4000                 if (!has_capability('moodle/course:update', $context)) {
4001                     // block access to unavailable sections if can not edit course
4002                     send_file_not_found();
4003                 }
4004             }
4006             $filename = array_pop($args);
4007             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4008             if (!$file = $fs->get_file($context->id, 'course', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4009                 send_file_not_found();
4010             }
4012             session_get_instance()->write_close(); // unlock session during fileserving
4013             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4015         } else {
4016             send_file_not_found();
4017         }
4019     } else if ($component === 'group') {
4020         if ($context->contextlevel != CONTEXT_COURSE) {
4021             send_file_not_found();
4022         }
4024         require_course_login($course, true, null, false);
4026         $groupid = (int)array_shift($args);
4028         $group = $DB->get_record('groups', array('id'=>$groupid, 'courseid'=>$course->id), '*', MUST_EXIST);
4029         if (($course->groupmodeforce and $course->groupmode == SEPARATEGROUPS) and !has_capability('moodle/site:accessallgroups', $context) and !groups_is_member($group->id, $USER->id)) {
4030             // do not allow access to separate group info if not member or teacher
4031             send_file_not_found();
4032         }
4034         if ($filearea === 'description') {
4036             require_login($course);
4038             $filename = array_pop($args);
4039             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4040             if (!$file = $fs->get_file($context->id, 'group', 'description', $group->id, $filepath, $filename) or $file->is_directory()) {
4041                 send_file_not_found();
4042             }
4044             session_get_instance()->write_close(); // unlock session during fileserving
4045             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4047         } else if ($filearea === 'icon') {
4048             $filename = array_pop($args);
4050             if ($filename !== 'f1' and $filename !== 'f2') {
4051                 send_file_not_found();
4052             }
4053             if (!$file = $fs->get_file($context->id, 'group', 'icon', $group->id, '/', $filename.'.png')) {
4054                 if (!$file = $fs->get_file($context->id, 'group', 'icon', $group->id, '/', $filename.'.jpg')) {
4055                     send_file_not_found();
4056                 }
4057             }
4059             session_get_instance()->write_close(); // unlock session during fileserving
4060             send_stored_file($file, 60*60, 0, false, array('preview' => $preview));
4062         } else {
4063             send_file_not_found();
4064         }
4066     } else if ($component === 'grouping') {
4067         if ($context->contextlevel != CONTEXT_COURSE) {
4068             send_file_not_found();
4069         }
4071         require_login($course);
4073         $groupingid = (int)array_shift($args);
4075         // note: everybody has access to grouping desc images for now
4076         if ($filearea === 'description') {
4078             $filename = array_pop($args);
4079             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4080             if (!$file = $fs->get_file($context->id, 'grouping', 'description', $groupingid, $filepath, $filename) or $file->is_directory()) {
4081                 send_file_not_found();
4082             }
4084             session_get_instance()->write_close(); // unlock session during fileserving
4085             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4087         } else {
4088             send_file_not_found();
4089         }
4091     // ========================================================================================================================
4092     } else if ($component === 'backup') {
4093         if ($filearea === 'course' and $context->contextlevel == CONTEXT_COURSE) {
4094             require_login($course);
4095             require_capability('moodle/backup:downloadfile', $context);
4097             $filename = array_pop($args);
4098             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4099             if (!$file = $fs->get_file($context->id, 'backup', 'course', 0, $filepath, $filename) or $file->is_directory()) {
4100                 send_file_not_found();
4101             }
4103             session_get_instance()->write_close(); // unlock session during fileserving
4104             send_stored_file($file, 0, 0, $forcedownload, array('preview' => $preview));
4106         } else if ($filearea === 'section' and $context->contextlevel == CONTEXT_COURSE) {
4107             require_login($course);
4108             require_capability('moodle/backup:downloadfile', $context);
4110             $sectionid = (int)array_shift($args);
4112             $filename = array_pop($args);
4113             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4114             if (!$file = $fs->get_file($context->id, 'backup', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
4115                 send_file_not_found();
4116             }
4118             session_get_instance()->write_close();
4119             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
4121         } else if ($filearea === 'activity' and $context->contextlevel == CONTEXT_MODULE) {
4122             require_login($course, false, $cm);
4123             require_capability('moodle/backup:downloadfile', $context);
4125             $filename = array_pop($args);
4126             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
4127             if (!$file = $fs->get_file($context->id, 'backup', 'activity', 0, $filepath, $filename) or $file->is_directory()) {
4128                 send_file_not_found();
4129             }
4131             session_get_instance()->write_close();
4132         &nb