MDL-33948 file_save_draft_area_files() validates if references are allowed and allows...
[moodle.git] / lib / filelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Functions for file handling.
19  *
20  * @package   core_files
21  * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * BYTESERVING_BOUNDARY - string unique string constant.
29  */
30 define('BYTESERVING_BOUNDARY', 's1k2o3d4a5k6s7');
32 require_once("$CFG->libdir/filestorage/file_exceptions.php");
33 require_once("$CFG->libdir/filestorage/file_storage.php");
34 require_once("$CFG->libdir/filestorage/zip_packer.php");
35 require_once("$CFG->libdir/filebrowser/file_browser.php");
37 /**
38  * Encodes file serving url
39  *
40  * @deprecated use moodle_url factory methods instead
41  *
42  * @todo MDL-31071 deprecate this function
43  * @global stdClass $CFG
44  * @param string $urlbase
45  * @param string $path /filearea/itemid/dir/dir/file.exe
46  * @param bool $forcedownload
47  * @param bool $https https url required
48  * @return string encoded file url
49  */
50 function file_encode_url($urlbase, $path, $forcedownload=false, $https=false) {
51     global $CFG;
53 //TODO: deprecate this
55     if ($CFG->slasharguments) {
56         $parts = explode('/', $path);
57         $parts = array_map('rawurlencode', $parts);
58         $path  = implode('/', $parts);
59         $return = $urlbase.$path;
60         if ($forcedownload) {
61             $return .= '?forcedownload=1';
62         }
63     } else {
64         $path = rawurlencode($path);
65         $return = $urlbase.'?file='.$path;
66         if ($forcedownload) {
67             $return .= '&amp;forcedownload=1';
68         }
69     }
71     if ($https) {
72         $return = str_replace('http://', 'https://', $return);
73     }
75     return $return;
76 }
78 /**
79  * Prepares 'editor' formslib element from data in database
80  *
81  * The passed $data record must contain field foobar, foobarformat and optionally foobartrust. This
82  * function then copies the embedded files into draft area (assigning itemids automatically),
83  * creates the form element foobar_editor and rewrites the URLs so the embedded images can be
84  * displayed.
85  * In your mform definition, you must have an 'editor' element called foobar_editor. Then you call
86  * your mform's set_data() supplying the object returned by this function.
87  *
88  * @category files
89  * @param stdClass $data database field that holds the html text with embedded media
90  * @param string $field the name of the database field that holds the html text with embedded media
91  * @param array $options editor options (like maxifiles, maxbytes etc.)
92  * @param stdClass $context context of the editor
93  * @param string $component
94  * @param string $filearea file area name
95  * @param int $itemid item id, required if item exists
96  * @return stdClass modified data object
97  */
98 function file_prepare_standard_editor($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
99     $options = (array)$options;
100     if (!isset($options['trusttext'])) {
101         $options['trusttext'] = false;
102     }
103     if (!isset($options['forcehttps'])) {
104         $options['forcehttps'] = false;
105     }
106     if (!isset($options['subdirs'])) {
107         $options['subdirs'] = false;
108     }
109     if (!isset($options['maxfiles'])) {
110         $options['maxfiles'] = 0; // no files by default
111     }
112     if (!isset($options['noclean'])) {
113         $options['noclean'] = false;
114     }
116     //sanity check for passed context. This function doesn't expect $option['context'] to be set
117     //But this function is called before creating editor hence, this is one of the best places to check
118     //if context is used properly. This check notify developer that they missed passing context to editor.
119     if (isset($context) && !isset($options['context'])) {
120         //if $context is not null then make sure $option['context'] is also set.
121         debugging('Context for editor is not set in editoroptions. Hence editor will not respect editor filters', DEBUG_DEVELOPER);
122     } else if (isset($options['context']) && isset($context)) {
123         //If both are passed then they should be equal.
124         if ($options['context']->id != $context->id) {
125             $exceptionmsg = 'Editor context ['.$options['context']->id.'] is not equal to passed context ['.$context->id.']';
126             throw new coding_exception($exceptionmsg);
127         }
128     }
130     if (is_null($itemid) or is_null($context)) {
131         $contextid = null;
132         $itemid = null;
133         if (!isset($data)) {
134             $data = new stdClass();
135         }
136         if (!isset($data->{$field})) {
137             $data->{$field} = '';
138         }
139         if (!isset($data->{$field.'format'})) {
140             $data->{$field.'format'} = editors_get_preferred_format();
141         }
142         if (!$options['noclean']) {
143             $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
144         }
146     } else {
147         if ($options['trusttext']) {
148             // noclean ignored if trusttext enabled
149             if (!isset($data->{$field.'trust'})) {
150                 $data->{$field.'trust'} = 0;
151             }
152             $data = trusttext_pre_edit($data, $field, $context);
153         } else {
154             if (!$options['noclean']) {
155                 $data->{$field} = clean_text($data->{$field}, $data->{$field.'format'});
156             }
157         }
158         $contextid = $context->id;
159     }
161     if ($options['maxfiles'] != 0) {
162         $draftid_editor = file_get_submitted_draft_itemid($field);
163         $currenttext = file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options, $data->{$field});
164         $data->{$field.'_editor'} = array('text'=>$currenttext, 'format'=>$data->{$field.'format'}, 'itemid'=>$draftid_editor);
165     } else {
166         $data->{$field.'_editor'} = array('text'=>$data->{$field}, 'format'=>$data->{$field.'format'}, 'itemid'=>0);
167     }
169     return $data;
172 /**
173  * Prepares the content of the 'editor' form element with embedded media files to be saved in database
174  *
175  * This function moves files from draft area to the destination area and
176  * encodes URLs to the draft files so they can be safely saved into DB. The
177  * form has to contain the 'editor' element named foobar_editor, where 'foobar'
178  * is the name of the database field to hold the wysiwyg editor content. The
179  * editor data comes as an array with text, format and itemid properties. This
180  * function automatically adds $data properties foobar, foobarformat and
181  * foobartrust, where foobar has URL to embedded files encoded.
182  *
183  * @category files
184  * @param stdClass $data raw data submitted by the form
185  * @param string $field name of the database field containing the html with embedded media files
186  * @param array $options editor options (trusttext, subdirs, maxfiles, maxbytes etc.)
187  * @param stdClass $context context, required for existing data
188  * @param string $component file component
189  * @param string $filearea file area name
190  * @param int $itemid item id, required if item exists
191  * @return stdClass modified data object
192  */
193 function file_postupdate_standard_editor($data, $field, array $options, $context, $component=null, $filearea=null, $itemid=null) {
194     $options = (array)$options;
195     if (!isset($options['trusttext'])) {
196         $options['trusttext'] = false;
197     }
198     if (!isset($options['forcehttps'])) {
199         $options['forcehttps'] = false;
200     }
201     if (!isset($options['subdirs'])) {
202         $options['subdirs'] = false;
203     }
204     if (!isset($options['maxfiles'])) {
205         $options['maxfiles'] = 0; // no files by default
206     }
207     if (!isset($options['maxbytes'])) {
208         $options['maxbytes'] = 0; // unlimited
209     }
211     if ($options['trusttext']) {
212         $data->{$field.'trust'} = trusttext_trusted($context);
213     } else {
214         $data->{$field.'trust'} = 0;
215     }
217     $editor = $data->{$field.'_editor'};
219     if ($options['maxfiles'] == 0 or is_null($filearea) or is_null($itemid) or empty($editor['itemid'])) {
220         $data->{$field} = $editor['text'];
221     } else {
222         $data->{$field} = file_save_draft_area_files($editor['itemid'], $context->id, $component, $filearea, $itemid, $options, $editor['text'], $options['forcehttps']);
223     }
224     $data->{$field.'format'} = $editor['format'];
226     return $data;
229 /**
230  * Saves text and files modified by Editor formslib element
231  *
232  * @category files
233  * @param stdClass $data $database entry field
234  * @param string $field name of data field
235  * @param array $options various options
236  * @param stdClass $context context - must already exist
237  * @param string $component
238  * @param string $filearea file area name
239  * @param int $itemid must already exist, usually means data is in db
240  * @return stdClass modified data obejct
241  */
242 function file_prepare_standard_filemanager($data, $field, array $options, $context=null, $component=null, $filearea=null, $itemid=null) {
243     $options = (array)$options;
244     if (!isset($options['subdirs'])) {
245         $options['subdirs'] = false;
246     }
247     if (is_null($itemid) or is_null($context)) {
248         $itemid = null;
249         $contextid = null;
250     } else {
251         $contextid = $context->id;
252     }
254     $draftid_editor = file_get_submitted_draft_itemid($field.'_filemanager');
255     file_prepare_draft_area($draftid_editor, $contextid, $component, $filearea, $itemid, $options);
256     $data->{$field.'_filemanager'} = $draftid_editor;
258     return $data;
261 /**
262  * Saves files modified by File manager formslib element
263  *
264  * @todo MDL-31073 review this function
265  * @category files
266  * @param stdClass $data $database entry field
267  * @param string $field name of data field
268  * @param array $options various options
269  * @param stdClass $context context - must already exist
270  * @param string $component
271  * @param string $filearea file area name
272  * @param int $itemid must already exist, usually means data is in db
273  * @return stdClass modified data obejct
274  */
275 function file_postupdate_standard_filemanager($data, $field, array $options, $context, $component, $filearea, $itemid) {
276     $options = (array)$options;
277     if (!isset($options['subdirs'])) {
278         $options['subdirs'] = false;
279     }
280     if (!isset($options['maxfiles'])) {
281         $options['maxfiles'] = -1; // unlimited
282     }
283     if (!isset($options['maxbytes'])) {
284         $options['maxbytes'] = 0; // unlimited
285     }
287     if (empty($data->{$field.'_filemanager'})) {
288         $data->$field = '';
290     } else {
291         file_save_draft_area_files($data->{$field.'_filemanager'}, $context->id, $component, $filearea, $itemid, $options);
292         $fs = get_file_storage();
294         if ($fs->get_area_files($context->id, $component, $filearea, $itemid)) {
295             $data->$field = '1'; // TODO: this is an ugly hack (skodak)
296         } else {
297             $data->$field = '';
298         }
299     }
301     return $data;
304 /**
305  * Generate a draft itemid
306  *
307  * @category files
308  * @global moodle_database $DB
309  * @global stdClass $USER
310  * @return int a random but available draft itemid that can be used to create a new draft
311  * file area.
312  */
313 function file_get_unused_draft_itemid() {
314     global $DB, $USER;
316     if (isguestuser() or !isloggedin()) {
317         // guests and not-logged-in users can not be allowed to upload anything!!!!!!
318         print_error('noguest');
319     }
321     $contextid = get_context_instance(CONTEXT_USER, $USER->id)->id;
323     $fs = get_file_storage();
324     $draftitemid = rand(1, 999999999);
325     while ($files = $fs->get_area_files($contextid, 'user', 'draft', $draftitemid)) {
326         $draftitemid = rand(1, 999999999);
327     }
329     return $draftitemid;
332 /**
333  * Initialise a draft file area from a real one by copying the files. A draft
334  * area will be created if one does not already exist. Normally you should
335  * get $draftitemid by calling file_get_submitted_draft_itemid('elementname');
336  *
337  * @category files
338  * @global stdClass $CFG
339  * @global stdClass $USER
340  * @param int $draftitemid the id of the draft area to use, or 0 to create a new one, in which case this parameter is updated.
341  * @param int $contextid This parameter and the next two identify the file area to copy files from.
342  * @param string $component
343  * @param string $filearea helps indentify the file area.
344  * @param int $itemid helps identify the file area. Can be null if there are no files yet.
345  * @param array $options text and file options ('subdirs'=>false, 'forcehttps'=>false)
346  * @param string $text some html content that needs to have embedded links rewritten to point to the draft area.
347  * @return string|null returns string if $text was passed in, the rewritten $text is returned. Otherwise NULL.
348  */
349 function file_prepare_draft_area(&$draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null) {
350     global $CFG, $USER, $CFG;
352     $options = (array)$options;
353     if (!isset($options['subdirs'])) {
354         $options['subdirs'] = false;
355     }
356     if (!isset($options['forcehttps'])) {
357         $options['forcehttps'] = false;
358     }
360     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
361     $fs = get_file_storage();
363     if (empty($draftitemid)) {
364         // create a new area and copy existing files into
365         $draftitemid = file_get_unused_draft_itemid();
366         $file_record = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft', 'itemid'=>$draftitemid);
367         if (!is_null($itemid) and $files = $fs->get_area_files($contextid, $component, $filearea, $itemid)) {
368             foreach ($files as $file) {
369                 if ($file->is_directory() and $file->get_filepath() === '/') {
370                     // we need a way to mark the age of each draft area,
371                     // by not copying the root dir we force it to be created automatically with current timestamp
372                     continue;
373                 }
374                 if (!$options['subdirs'] and ($file->is_directory() or $file->get_filepath() !== '/')) {
375                     continue;
376                 }
377                 $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 = get_context_instance(CONTEXT_USER, $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  * Get used space of files
486  * @global moodle_database $DB
487  * @global stdClass $USER
488  * @return int total bytes
489  */
490 function file_get_user_used_space() {
491     global $DB, $USER;
493     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
494     $sql = "SELECT SUM(files1.filesize) AS totalbytes FROM {files} files1
495             JOIN (SELECT contenthash, filename, MAX(id) AS id
496             FROM {files}
497             WHERE contextid = ? AND component = ? AND filearea != ?
498             GROUP BY contenthash, filename) files2 ON files1.id = files2.id";
499     $params = array('contextid'=>$usercontext->id, 'component'=>'user', 'filearea'=>'draft');
500     $record = $DB->get_record_sql($sql, $params);
501     return (int)$record->totalbytes;
504 /**
505  * Convert any string to a valid filepath
506  * @todo review this function
507  * @param string $str
508  * @return string path
509  */
510 function file_correct_filepath($str) { //TODO: what is this? (skodak)
511     if ($str == '/' or empty($str)) {
512         return '/';
513     } else {
514         return '/'.trim($str, './@#$ ').'/';
515     }
518 /**
519  * Generate a folder tree of draft area of current USER recursively
520  *
521  * @todo MDL-31073 use normal return value instead, this does not fit the rest of api here (skodak)
522  * @param int $draftitemid
523  * @param string $filepath
524  * @param mixed $data
525  */
526 function file_get_drafarea_folders($draftitemid, $filepath, &$data) {
527     global $USER, $OUTPUT, $CFG;
528     $data->children = array();
529     $context = get_context_instance(CONTEXT_USER, $USER->id);
530     $fs = get_file_storage();
531     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
532         foreach ($files as $file) {
533             if ($file->is_directory()) {
534                 $item = new stdClass();
535                 $item->sortorder = $file->get_sortorder();
536                 $item->filepath = $file->get_filepath();
538                 $foldername = explode('/', trim($item->filepath, '/'));
539                 $item->fullname = trim(array_pop($foldername), '/');
541                 $item->id = uniqid();
542                 file_get_drafarea_folders($draftitemid, $item->filepath, $item);
543                 $data->children[] = $item;
544             } else {
545                 continue;
546             }
547         }
548     }
551 /**
552  * Listing all files (including folders) in current path (draft area)
553  * used by file manager
554  * @param int $draftitemid
555  * @param string $filepath
556  * @return stdClass
557  */
558 function file_get_drafarea_files($draftitemid, $filepath = '/') {
559     global $USER, $OUTPUT, $CFG;
561     $context = get_context_instance(CONTEXT_USER, $USER->id);
562     $fs = get_file_storage();
564     $data = new stdClass();
565     $data->path = array();
566     $data->path[] = array('name'=>get_string('files'), 'path'=>'/');
568     // will be used to build breadcrumb
569     $trail = '/';
570     if ($filepath !== '/') {
571         $filepath = file_correct_filepath($filepath);
572         $parts = explode('/', $filepath);
573         foreach ($parts as $part) {
574             if ($part != '' && $part != null) {
575                 $trail .= ($part.'/');
576                 $data->path[] = array('name'=>$part, 'path'=>$trail);
577             }
578         }
579     }
581     $list = array();
582     $maxlength = 12;
583     if ($files = $fs->get_directory_files($context->id, 'user', 'draft', $draftitemid, $filepath, false)) {
584         foreach ($files as $file) {
585             $item = new stdClass();
586             $item->filename = $file->get_filename();
587             $item->filepath = $file->get_filepath();
588             $item->fullname = trim($item->filename, '/');
589             $filesize = $file->get_filesize();
590             $item->size = $filesize ? $filesize : null;
591             $item->filesize = $filesize ? display_size($filesize) : '';
593             $item->sortorder = $file->get_sortorder();
594             $item->author = $file->get_author();
595             $item->license = $file->get_license();
596             $item->datemodified = $file->get_timemodified();
597             $item->datecreated = $file->get_timecreated();
598             $item->isref = $file->is_external_file();
599             if ($item->isref && $file->get_status() == 666) {
600                 $item->originalmissing = true;
601             }
602             // find the file this draft file was created from and count all references in local
603             // system pointing to that file
604             $source = @unserialize($file->get_source());
605             if (isset($source->original)) {
606                 $item->refcount = $fs->search_references_count($source->original);
607             }
609             if ($file->is_directory()) {
610                 $item->filesize = 0;
611                 $item->icon = $OUTPUT->pix_url(file_folder_icon(24))->out(false);
612                 $item->type = 'folder';
613                 $foldername = explode('/', trim($item->filepath, '/'));
614                 $item->fullname = trim(array_pop($foldername), '/');
615                 $item->thumbnail = $OUTPUT->pix_url(file_folder_icon(90))->out(false);
616             } else {
617                 // do NOT use file browser here!
618                 $item->mimetype = get_mimetype_description($file);
619                 if (file_extension_in_typegroup($file->get_filename(), 'archive')) {
620                     $item->type = 'zip';
621                 } else {
622                     $item->type = 'file';
623                 }
624                 $itemurl = moodle_url::make_draftfile_url($draftitemid, $item->filepath, $item->filename);
625                 $item->url = $itemurl->out();
626                 $item->icon = $OUTPUT->pix_url(file_file_icon($file, 24))->out(false);
627                 $item->thumbnail = $OUTPUT->pix_url(file_file_icon($file, 90))->out(false);
628                 if ($imageinfo = $file->get_imageinfo()) {
629                     $item->realthumbnail = $itemurl->out(false, array('preview' => 'thumb', 'oid' => $file->get_timemodified()));
630                     $item->realicon = $itemurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
631                     $item->image_width = $imageinfo['width'];
632                     $item->image_height = $imageinfo['height'];
633                 }
634             }
635             $list[] = $item;
636         }
637     }
638     $data->itemid = $draftitemid;
639     $data->list = $list;
640     return $data;
643 /**
644  * Returns draft area itemid for a given element.
645  *
646  * @category files
647  * @param string $elname name of formlib editor element, or a hidden form field that stores the draft area item id, etc.
648  * @return int the itemid, or 0 if there is not one yet.
649  */
650 function file_get_submitted_draft_itemid($elname) {
651     // this is a nasty hack, ideally all new elements should use arrays here or there should be a new parameter
652     if (!isset($_REQUEST[$elname])) {
653         return 0;
654     }
655     if (is_array($_REQUEST[$elname])) {
656         $param = optional_param_array($elname, 0, PARAM_INT);
657         if (!empty($param['itemid'])) {
658             $param = $param['itemid'];
659         } else {
660             debugging('Missing itemid, maybe caused by unset maxfiles option', DEBUG_DEVELOPER);
661             return false;
662         }
664     } else {
665         $param = optional_param($elname, 0, PARAM_INT);
666     }
668     if ($param) {
669         require_sesskey();
670     }
672     return $param;
675 /**
676  * Restore the original source field from draft files
677  *
678  * @param stored_file $storedfile This only works with draft files
679  * @return stored_file
680  */
681 function file_restore_source_field_from_draft_file($storedfile) {
682     $source = @unserialize($storedfile->get_source());
683     if (!empty($source)) {
684         if (is_object($source)) {
685             $restoredsource = $source->source;
686             $storedfile->set_source($restoredsource);
687         } else {
688             throw new moodle_exception('invalidsourcefield', 'error');
689         }
690     }
691     return $storedfile;
693 /**
694  * Saves files from a draft file area to a real one (merging the list of files).
695  * Can rewrite URLs in some content at the same time if desired.
696  *
697  * @category files
698  * @global stdClass $USER
699  * @param int $draftitemid the id of the draft area to use. Normally obtained
700  *      from file_get_submitted_draft_itemid('elementname') or similar.
701  * @param int $contextid This parameter and the next two identify the file area to save to.
702  * @param string $component
703  * @param string $filearea indentifies the file area.
704  * @param int $itemid helps identifies the file area.
705  * @param array $options area options (subdirs=>false, maxfiles=-1, maxbytes=0)
706  * @param string $text some html content that needs to have embedded links rewritten
707  *      to the @@PLUGINFILE@@ form for saving in the database.
708  * @param bool $forcehttps force https urls.
709  * @return string|null if $text was passed in, the rewritten $text is returned. Otherwise NULL.
710  */
711 function file_save_draft_area_files($draftitemid, $contextid, $component, $filearea, $itemid, array $options=null, $text=null, $forcehttps=false) {
712     global $USER;
714     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
715     $fs = get_file_storage();
717     $options = (array)$options;
718     if (!isset($options['subdirs'])) {
719         $options['subdirs'] = false;
720     }
721     if (!isset($options['maxfiles'])) {
722         $options['maxfiles'] = -1; // unlimited
723     }
724     if (!isset($options['maxbytes']) || $options['maxbytes'] == USER_CAN_IGNORE_FILE_SIZE_LIMITS) {
725         $options['maxbytes'] = 0; // unlimited
726     }
727     $allowreferences = true;
728     if (isset($options['return_types']) && !($options['return_types'] & FILE_REFERENCE)) {
729         // we assume that if $options['return_types'] is NOT specified, we DO allow references.
730         // this is not exactly right. BUT there are many places in code where filemanager options
731         // are not passed to file_save_draft_area_files()
732         $allowreferences = false;
733     }
735     $draftfiles = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id');
736     $oldfiles   = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'id');
738     if (count($draftfiles) < 2) {
739         // means there are no files - one file means root dir only ;-)
740         $fs->delete_area_files($contextid, $component, $filearea, $itemid);
742     } else if (count($oldfiles) < 2) {
743         $filecount = 0;
744         // there were no files before - one file means root dir only ;-)
745         foreach ($draftfiles as $file) {
746             $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid);
747             if (!$options['subdirs']) {
748                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
749                     continue;
750                 }
751             }
752             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
753                 // oversized file - should not get here at all
754                 continue;
755             }
756             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
757                 // more files - should not get here at all
758                 break;
759             }
760             if (!$file->is_directory()) {
761                 $filecount++;
762             }
764             if ($file->is_external_file()) {
765                 if (!$allowreferences) {
766                     continue;
767                 }
768                 $repoid = $file->get_repository_id();
769                 if (!empty($repoid)) {
770                     $file_record['repositoryid'] = $repoid;
771                     $file_record['reference'] = $file->get_reference();
772                 }
773             }
774             file_restore_source_field_from_draft_file($file);
776             $fs->create_file_from_storedfile($file_record, $file);
777         }
779     } else {
780         // we have to merge old and new files - we want to keep file ids for files that were not changed
781         // we change time modified for all new and changed files, we keep time created as is
783         $newhashes = array();
784         foreach ($draftfiles as $file) {
785             $newhash = $fs->get_pathname_hash($contextid, $component, $filearea, $itemid, $file->get_filepath(), $file->get_filename());
786             file_restore_source_field_from_draft_file($file);
787             $newhashes[$newhash] = $file;
788         }
789         $filecount = 0;
790         foreach ($oldfiles as $oldfile) {
791             $oldhash = $oldfile->get_pathnamehash();
792             if (!isset($newhashes[$oldhash])) {
793                 // delete files not needed any more - deleted by user
794                 $oldfile->delete();
795                 continue;
796             }
798             $newfile = $newhashes[$oldhash];
799             // status changed, we delete old file, and create a new one
800             if ($oldfile->get_status() != $newfile->get_status()) {
801                 // file was changed, use updated with new timemodified data
802                 $oldfile->delete();
803                 // This file will be added later
804                 continue;
805             }
807             // Replaced file content
808             if ($oldfile->get_contenthash() != $newfile->get_contenthash()) {
809                 $oldfile->replace_content_with($newfile);
810             }
811             // Updated author
812             if ($oldfile->get_author() != $newfile->get_author()) {
813                 $oldfile->set_author($newfile->get_author());
814             }
815             // Updated license
816             if ($oldfile->get_license() != $newfile->get_license()) {
817                 $oldfile->set_license($newfile->get_license());
818             }
820             // Updated file source
821             if ($oldfile->get_source() != $newfile->get_source()) {
822                 $oldfile->set_source($newfile->get_source());
823             }
825             // Updated sort order
826             if ($oldfile->get_sortorder() != $newfile->get_sortorder()) {
827                 $oldfile->set_sortorder($newfile->get_sortorder());
828             }
830             // Update file size
831             if ($oldfile->get_filesize() != $newfile->get_filesize()) {
832                 $oldfile->set_filesize($newfile->get_filesize());
833             }
835             // Update file timemodified
836             if ($oldfile->get_timemodified() != $newfile->get_timemodified()) {
837                 $oldfile->set_timemodified($newfile->get_timemodified());
838             }
840             // unchanged file or directory - we keep it as is
841             unset($newhashes[$oldhash]);
842             if (!$oldfile->is_directory()) {
843                 $filecount++;
844             }
845         }
847         // Add fresh file or the file which has changed status
848         // the size and subdirectory tests are extra safety only, the UI should prevent it
849         foreach ($newhashes as $file) {
850             $file_record = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'timemodified'=>time());
851             if (!$options['subdirs']) {
852                 if ($file->get_filepath() !== '/' or $file->is_directory()) {
853                     continue;
854                 }
855             }
856             if ($options['maxbytes'] and $options['maxbytes'] < $file->get_filesize()) {
857                 // oversized file - should not get here at all
858                 continue;
859             }
860             if ($options['maxfiles'] != -1 and $options['maxfiles'] <= $filecount) {
861                 // more files - should not get here at all
862                 break;
863             }
864             if (!$file->is_directory()) {
865                 $filecount++;
866             }
868             if ($file->is_external_file()) {
869                 if (!$allowreferences) {
870                     continue;
871                 }
872                 $repoid = $file->get_repository_id();
873                 if (!empty($repoid)) {
874                     $file_record['repositoryid'] = $repoid;
875                     $file_record['reference'] = $file->get_reference();
876                 }
877             }
879             $fs->create_file_from_storedfile($file_record, $file);
880         }
881     }
883     // note: do not purge the draft area - we clean up areas later in cron,
884     //       the reason is that user might press submit twice and they would loose the files,
885     //       also sometimes we might want to use hacks that save files into two different areas
887     if (is_null($text)) {
888         return null;
889     } else {
890         return file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps);
891     }
894 /**
895  * Convert the draft file area URLs in some content to @@PLUGINFILE@@ tokens
896  * ready to be saved in the database. Normally, this is done automatically by
897  * {@link file_save_draft_area_files()}.
898  *
899  * @category files
900  * @param string $text the content to process.
901  * @param int $draftitemid the draft file area the content was using.
902  * @param bool $forcehttps whether the content contains https URLs. Default false.
903  * @return string the processed content.
904  */
905 function file_rewrite_urls_to_pluginfile($text, $draftitemid, $forcehttps = false) {
906     global $CFG, $USER;
908     $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
910     $wwwroot = $CFG->wwwroot;
911     if ($forcehttps) {
912         $wwwroot = str_replace('http://', 'https://', $wwwroot);
913     }
915     // relink embedded files if text submitted - no absolute links allowed in database!
916     $text = str_ireplace("$wwwroot/draftfile.php/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
918     if (strpos($text, 'draftfile.php?file=') !== false) {
919         $matches = array();
920         preg_match_all("!$wwwroot/draftfile.php\?file=%2F{$usercontext->id}%2Fuser%2Fdraft%2F{$draftitemid}%2F[^'\",&<>|`\s:\\\\]+!iu", $text, $matches);
921         if ($matches) {
922             foreach ($matches[0] as $match) {
923                 $replace = str_ireplace('%2F', '/', $match);
924                 $text = str_replace($match, $replace, $text);
925             }
926         }
927         $text = str_ireplace("$wwwroot/draftfile.php?file=/$usercontext->id/user/draft/$draftitemid/", '@@PLUGINFILE@@/', $text);
928     }
930     return $text;
933 /**
934  * Set file sort order
935  *
936  * @global moodle_database $DB
937  * @param int $contextid the context id
938  * @param string $component file component
939  * @param string $filearea file area.
940  * @param int $itemid itemid.
941  * @param string $filepath file path.
942  * @param string $filename file name.
943  * @param int $sortorder the sort order of file.
944  * @return bool
945  */
946 function file_set_sortorder($contextid, $component, $filearea, $itemid, $filepath, $filename, $sortorder) {
947     global $DB;
948     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea, 'itemid'=>$itemid, 'filepath'=>$filepath, 'filename'=>$filename);
949     if ($file_record = $DB->get_record('files', $conditions)) {
950         $sortorder = (int)$sortorder;
951         $file_record->sortorder = $sortorder;
952         $DB->update_record('files', $file_record);
953         return true;
954     }
955     return false;
958 /**
959  * reset file sort order number to 0
960  * @global moodle_database $DB
961  * @param int $contextid the context id
962  * @param string $component
963  * @param string $filearea file area.
964  * @param int|bool $itemid itemid.
965  * @return bool
966  */
967 function file_reset_sortorder($contextid, $component, $filearea, $itemid=false) {
968     global $DB;
970     $conditions = array('contextid'=>$contextid, 'component'=>$component, 'filearea'=>$filearea);
971     if ($itemid !== false) {
972         $conditions['itemid'] = $itemid;
973     }
975     $file_records = $DB->get_records('files', $conditions);
976     foreach ($file_records as $file_record) {
977         $file_record->sortorder = 0;
978         $DB->update_record('files', $file_record);
979     }
980     return true;
983 /**
984  * Returns description of upload error
985  *
986  * @param int $errorcode found in $_FILES['filename.ext']['error']
987  * @return string error description string, '' if ok
988  */
989 function file_get_upload_error($errorcode) {
991     switch ($errorcode) {
992     case 0: // UPLOAD_ERR_OK - no error
993         $errmessage = '';
994         break;
996     case 1: // UPLOAD_ERR_INI_SIZE
997         $errmessage = get_string('uploadserverlimit');
998         break;
1000     case 2: // UPLOAD_ERR_FORM_SIZE
1001         $errmessage = get_string('uploadformlimit');
1002         break;
1004     case 3: // UPLOAD_ERR_PARTIAL
1005         $errmessage = get_string('uploadpartialfile');
1006         break;
1008     case 4: // UPLOAD_ERR_NO_FILE
1009         $errmessage = get_string('uploadnofilefound');
1010         break;
1012     // Note: there is no error with a value of 5
1014     case 6: // UPLOAD_ERR_NO_TMP_DIR
1015         $errmessage = get_string('uploadnotempdir');
1016         break;
1018     case 7: // UPLOAD_ERR_CANT_WRITE
1019         $errmessage = get_string('uploadcantwrite');
1020         break;
1022     case 8: // UPLOAD_ERR_EXTENSION
1023         $errmessage = get_string('uploadextension');
1024         break;
1026     default:
1027         $errmessage = get_string('uploadproblem');
1028     }
1030     return $errmessage;
1033 /**
1034  * Recursive function formating an array in POST parameter
1035  * @param array $arraydata - the array that we are going to format and add into &$data array
1036  * @param string $currentdata - a row of the final postdata array at instant T
1037  *                when finish, it's assign to $data under this format: name[keyname][][]...[]='value'
1038  * @param array $data - the final data array containing all POST parameters : 1 row = 1 parameter
1039  */
1040 function format_array_postdata_for_curlcall($arraydata, $currentdata, &$data) {
1041         foreach ($arraydata as $k=>$v) {
1042             $newcurrentdata = $currentdata;
1043             if (is_array($v)) { //the value is an array, call the function recursively
1044                 $newcurrentdata = $newcurrentdata.'['.urlencode($k).']';
1045                 format_array_postdata_for_curlcall($v, $newcurrentdata, $data);
1046             }  else { //add the POST parameter to the $data array
1047                 $data[] = $newcurrentdata.'['.urlencode($k).']='.urlencode($v);
1048             }
1049         }
1052 /**
1053  * Transform a PHP array into POST parameter
1054  * (see the recursive function format_array_postdata_for_curlcall)
1055  * @param array $postdata
1056  * @return array containing all POST parameters  (1 row = 1 POST parameter)
1057  */
1058 function format_postdata_for_curlcall($postdata) {
1059         $data = array();
1060         foreach ($postdata as $k=>$v) {
1061             if (is_array($v)) {
1062                 $currentdata = urlencode($k);
1063                 format_array_postdata_for_curlcall($v, $currentdata, $data);
1064             }  else {
1065                 $data[] = urlencode($k).'='.urlencode($v);
1066             }
1067         }
1068         $convertedpostdata = implode('&', $data);
1069         return $convertedpostdata;
1072 /**
1073  * Fetches content of file from Internet (using proxy if defined). Uses cURL extension if present.
1074  * Due to security concerns only downloads from http(s) sources are supported.
1075  *
1076  * @todo MDL-31073 add version test for '7.10.5'
1077  * @category files
1078  * @param string $url file url starting with http(s)://
1079  * @param array $headers http headers, null if none. If set, should be an
1080  *   associative array of header name => value pairs.
1081  * @param array $postdata array means use POST request with given parameters
1082  * @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
1083  *   (if false, just returns content)
1084  * @param int $timeout timeout for complete download process including all file transfer
1085  *   (default 5 minutes)
1086  * @param int $connecttimeout timeout for connection to server; this is the timeout that
1087  *   usually happens if the remote server is completely down (default 20 seconds);
1088  *   may not work when using proxy
1089  * @param bool $skipcertverify If true, the peer's SSL certificate will not be checked.
1090  *   Only use this when already in a trusted location.
1091  * @param string $tofile store the downloaded content to file instead of returning it.
1092  * @param bool $calctimeout false by default, true enables an extra head request to try and determine
1093  *   filesize and appropriately larger timeout based on $CFG->curltimeoutkbitrate
1094  * @return mixed false if request failed or content of the file as string if ok. True if file downloaded into $tofile successfully.
1095  */
1096 function download_file_content($url, $headers=null, $postdata=null, $fullresponse=false, $timeout=300, $connecttimeout=20, $skipcertverify=false, $tofile=NULL, $calctimeout=false) {
1097     global $CFG;
1099     // some extra security
1100     $newlines = array("\r", "\n");
1101     if (is_array($headers) ) {
1102         foreach ($headers as $key => $value) {
1103             $headers[$key] = str_replace($newlines, '', $value);
1104         }
1105     }
1106     $url = str_replace($newlines, '', $url);
1107     if (!preg_match('|^https?://|i', $url)) {
1108         if ($fullresponse) {
1109             $response = new stdClass();
1110             $response->status        = 0;
1111             $response->headers       = array();
1112             $response->response_code = 'Invalid protocol specified in url';
1113             $response->results       = '';
1114             $response->error         = 'Invalid protocol specified in url';
1115             return $response;
1116         } else {
1117             return false;
1118         }
1119     }
1121     // check if proxy (if used) should be bypassed for this url
1122     $proxybypass = is_proxybypass($url);
1124     if (!$ch = curl_init($url)) {
1125         debugging('Can not init curl.');
1126         return false;
1127     }
1129     // set extra headers
1130     if (is_array($headers) ) {
1131         $headers2 = array();
1132         foreach ($headers as $key => $value) {
1133             $headers2[] = "$key: $value";
1134         }
1135         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers2);
1136     }
1138     if ($skipcertverify) {
1139         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
1140     }
1142     // use POST if requested
1143     if (is_array($postdata)) {
1144         $postdata = format_postdata_for_curlcall($postdata);
1145         curl_setopt($ch, CURLOPT_POST, true);
1146         curl_setopt($ch, CURLOPT_POSTFIELDS, $postdata);
1147     }
1149     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
1150     curl_setopt($ch, CURLOPT_HEADER, false);
1151     curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $connecttimeout);
1153     if (!ini_get('open_basedir') and !ini_get('safe_mode')) {
1154         // TODO: add version test for '7.10.5'
1155         curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
1156         curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
1157     }
1159     if (!empty($CFG->proxyhost) and !$proxybypass) {
1160         // SOCKS supported in PHP5 only
1161         if (!empty($CFG->proxytype) and ($CFG->proxytype == 'SOCKS5')) {
1162             if (defined('CURLPROXY_SOCKS5')) {
1163                 curl_setopt($ch, CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
1164             } else {
1165                 curl_close($ch);
1166                 if ($fullresponse) {
1167                     $response = new stdClass();
1168                     $response->status        = '0';
1169                     $response->headers       = array();
1170                     $response->response_code = 'SOCKS5 proxy is not supported in PHP4';
1171                     $response->results       = '';
1172                     $response->error         = 'SOCKS5 proxy is not supported in PHP4';
1173                     return $response;
1174                 } else {
1175                     debugging("SOCKS5 proxy is not supported in PHP4.", DEBUG_ALL);
1176                     return false;
1177                 }
1178             }
1179         }
1181         curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, false);
1183         if (empty($CFG->proxyport)) {
1184             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost);
1185         } else {
1186             curl_setopt($ch, CURLOPT_PROXY, $CFG->proxyhost.':'.$CFG->proxyport);
1187         }
1189         if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
1190             curl_setopt($ch, CURLOPT_PROXYUSERPWD, $CFG->proxyuser.':'.$CFG->proxypassword);
1191             if (defined('CURLOPT_PROXYAUTH')) {
1192                 // any proxy authentication if PHP 5.1
1193                 curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_BASIC | CURLAUTH_NTLM);
1194             }
1195         }
1196     }
1198     // set up header and content handlers
1199     $received = new stdClass();
1200     $received->headers = array(); // received headers array
1201     $received->tofile  = $tofile;
1202     $received->fh      = null;
1203     curl_setopt($ch, CURLOPT_HEADERFUNCTION, partial('download_file_content_header_handler', $received));
1204     if ($tofile) {
1205         curl_setopt($ch, CURLOPT_WRITEFUNCTION, partial('download_file_content_write_handler', $received));
1206     }
1208     if (!isset($CFG->curltimeoutkbitrate)) {
1209         //use very slow rate of 56kbps as a timeout speed when not set
1210         $bitrate = 56;
1211     } else {
1212         $bitrate = $CFG->curltimeoutkbitrate;
1213     }
1215     // try to calculate the proper amount for timeout from remote file size.
1216     // if disabled or zero, we won't do any checks nor head requests.
1217     if ($calctimeout && $bitrate > 0) {
1218         //setup header request only options
1219         curl_setopt_array ($ch, array(
1220             CURLOPT_RETURNTRANSFER => false,
1221             CURLOPT_NOBODY         => true)
1222         );
1224         curl_exec($ch);
1225         $info = curl_getinfo($ch);
1226         $err = curl_error($ch);
1228         if ($err === '' && $info['download_content_length'] > 0) { //no curl errors
1229             $timeout = max($timeout, ceil($info['download_content_length'] * 8 / ($bitrate * 1024))); //adjust for large files only - take max timeout.
1230         }
1231         //reinstate affected curl options
1232         curl_setopt_array ($ch, array(
1233             CURLOPT_RETURNTRANSFER => true,
1234             CURLOPT_NOBODY         => false)
1235         );
1236     }
1238     curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
1239     $result = curl_exec($ch);
1241     // try to detect encoding problems
1242     if ((curl_errno($ch) == 23 or curl_errno($ch) == 61) and defined('CURLOPT_ENCODING')) {
1243         curl_setopt($ch, CURLOPT_ENCODING, 'none');
1244         $result = curl_exec($ch);
1245     }
1247     if ($received->fh) {
1248         fclose($received->fh);
1249     }
1251     if (curl_errno($ch)) {
1252         $error    = curl_error($ch);
1253         $error_no = curl_errno($ch);
1254         curl_close($ch);
1256         if ($fullresponse) {
1257             $response = new stdClass();
1258             if ($error_no == 28) {
1259                 $response->status    = '-100'; // mimic snoopy
1260             } else {
1261                 $response->status    = '0';
1262             }
1263             $response->headers       = array();
1264             $response->response_code = $error;
1265             $response->results       = false;
1266             $response->error         = $error;
1267             return $response;
1268         } else {
1269             debugging("cURL request for \"$url\" failed with: $error ($error_no)", DEBUG_ALL);
1270             return false;
1271         }
1273     } else {
1274         $info = curl_getinfo($ch);
1275         curl_close($ch);
1277         if (empty($info['http_code'])) {
1278             // for security reasons we support only true http connections (Location: file:// exploit prevention)
1279             $response = new stdClass();
1280             $response->status        = '0';
1281             $response->headers       = array();
1282             $response->response_code = 'Unknown cURL error';
1283             $response->results       = false; // do NOT change this, we really want to ignore the result!
1284             $response->error         = 'Unknown cURL error';
1286         } else {
1287             $response = new stdClass();;
1288             $response->status        = (string)$info['http_code'];
1289             $response->headers       = $received->headers;
1290             $response->response_code = $received->headers[0];
1291             $response->results       = $result;
1292             $response->error         = '';
1293         }
1295         if ($fullresponse) {
1296             return $response;
1297         } else if ($info['http_code'] != 200) {
1298             debugging("cURL request for \"$url\" failed, HTTP response code: ".$response->response_code, DEBUG_ALL);
1299             return false;
1300         } else {
1301             return $response->results;
1302         }
1303     }
1306 /**
1307  * internal implementation
1308  * @param stdClass $received
1309  * @param resource $ch
1310  * @param mixed $header
1311  * @return int header length
1312  */
1313 function download_file_content_header_handler($received, $ch, $header) {
1314     $received->headers[] = $header;
1315     return strlen($header);
1318 /**
1319  * internal implementation
1320  * @param stdClass $received
1321  * @param resource $ch
1322  * @param mixed $data
1323  */
1324 function download_file_content_write_handler($received, $ch, $data) {
1325     if (!$received->fh) {
1326         $received->fh = fopen($received->tofile, 'w');
1327         if ($received->fh === false) {
1328             // bad luck, file creation or overriding failed
1329             return 0;
1330         }
1331     }
1332     if (fwrite($received->fh, $data) === false) {
1333         // bad luck, write failed, let's abort completely
1334         return 0;
1335     }
1336     return strlen($data);
1339 /**
1340  * Returns a list of information about file types based on extensions.
1341  *
1342  * The following elements expected in value array for each extension:
1343  * 'type' - mimetype
1344  * 'icon' - location of the icon file. If value is FILENAME, then either pix/f/FILENAME.gif
1345  *     or pix/f/FILENAME.png must be present in moodle and contain 16x16 filetype icon;
1346  *     also files with bigger sizes under names
1347  *     FILENAME-24, FILENAME-32, FILENAME-64, FILENAME-128, FILENAME-256 are recommended.
1348  * 'groups' (optional) - array of filetype groups this filetype extension is part of;
1349  *     commonly used in moodle the following groups:
1350  *       - web_image - image that can be included as <img> in HTML
1351  *       - image - image that we can parse using GD to find it's dimensions, also used for portfolio format
1352  *       - video - file that can be imported as video in text editor
1353  *       - audio - file that can be imported as audio in text editor
1354  *       - archive - we can extract files from this archive
1355  *       - spreadsheet - used for portfolio format
1356  *       - document - used for portfolio format
1357  *       - presentation - used for portfolio format
1358  * 'string' (optional) - the name of the string from lang/en/mimetypes.php that displays
1359  *     human-readable description for this filetype;
1360  *     Function {@link get_mimetype_description()} first looks at the presence of string for
1361  *     particular mimetype (value of 'type'), if not found looks for string specified in 'string'
1362  *     attribute, if not found returns the value of 'type';
1363  * 'defaulticon' (boolean, optional) - used by function {@link file_mimetype_icon()} to find
1364  *     an icon for mimetype. If an entry with 'defaulticon' is not found for a particular mimetype,
1365  *     this function will return first found icon; Especially usefull for types such as 'text/plain'
1366  *
1367  * @category files
1368  * @return array List of information about file types based on extensions.
1369  *   Associative array of extension (lower-case) to associative array
1370  *   from 'element name' to data. Current element names are 'type' and 'icon'.
1371  *   Unknown types should use the 'xxx' entry which includes defaults.
1372  */
1373 function &get_mimetypes_array() {
1374     static $mimearray = array (
1375         'xxx'  => array ('type'=>'document/unknown', 'icon'=>'unknown'),
1376         '3gp'  => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1377         'aac'  => array ('type'=>'audio/aac', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1378         'ai'   => array ('type'=>'application/postscript', 'icon'=>'eps', 'groups'=>array('image'), 'string'=>'image'),
1379         'aif'  => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1380         'aiff' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1381         'aifc' => array ('type'=>'audio/x-aiff', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1382         'applescript'  => array ('type'=>'text/plain', 'icon'=>'text'),
1383         'asc'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1384         'asm'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1385         'au'   => array ('type'=>'audio/au', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1386         'avi'  => array ('type'=>'video/x-ms-wm', 'icon'=>'avi', 'groups'=>array('video','web_video'), 'string'=>'video'),
1387         'bmp'  => array ('type'=>'image/bmp', 'icon'=>'bmp', 'groups'=>array('image'), 'string'=>'image'),
1388         'c'    => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1389         'cct'  => array ('type'=>'shockwave/director', 'icon'=>'flash'),
1390         'cpp'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1391         'cs'   => array ('type'=>'application/x-csh', 'icon'=>'sourcecode'),
1392         'css'  => array ('type'=>'text/css', 'icon'=>'text', 'groups'=>array('web_file')),
1393         'csv'  => array ('type'=>'text/csv', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1394         'dv'   => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1395         'dmg'  => array ('type'=>'application/octet-stream', 'icon'=>'unknown'),
1397         'doc'  => array ('type'=>'application/msword', 'icon'=>'document', 'groups'=>array('document')),
1398         'docx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'icon'=>'document', 'groups'=>array('document')),
1399         'docm' => array ('type'=>'application/vnd.ms-word.document.macroEnabled.12', 'icon'=>'document'),
1400         'dotx' => array ('type'=>'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 'icon'=>'document'),
1401         'dotm' => array ('type'=>'application/vnd.ms-word.template.macroEnabled.12', 'icon'=>'document'),
1403         'dcr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1404         'dif'  => array ('type'=>'video/x-dv', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1405         'dir'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1406         'dxr'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1407         'eps'  => array ('type'=>'application/postscript', 'icon'=>'eps'),
1408         'fdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1409         'flv'  => array ('type'=>'video/x-flv', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1410         'f4v'  => array ('type'=>'video/mp4', 'icon'=>'flash', 'groups'=>array('video','web_video'), 'string'=>'video'),
1411         'gif'  => array ('type'=>'image/gif', 'icon'=>'gif', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1412         'gtar' => array ('type'=>'application/x-gtar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1413         'tgz'  => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1414         'gz'   => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1415         'gzip' => array ('type'=>'application/g-zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1416         'h'    => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1417         'hpp'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1418         'hqx'  => array ('type'=>'application/mac-binhex40', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1419         'htc'  => array ('type'=>'text/x-component', 'icon'=>'markup'),
1420         'html' => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1421         'xhtml'=> array ('type'=>'application/xhtml+xml', 'icon'=>'markup', 'groups'=>array('web_file')),
1422         'htm'  => array ('type'=>'text/html', 'icon'=>'html', 'groups'=>array('web_file')),
1423         'ico'  => array ('type'=>'image/vnd.microsoft.icon', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1424         'ics'  => array ('type'=>'text/calendar', 'icon'=>'text'),
1425         'isf'  => array ('type'=>'application/inspiration', 'icon'=>'isf'),
1426         'ist'  => array ('type'=>'application/inspiration.template', 'icon'=>'isf'),
1427         'java' => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1428         'jcb'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1429         'jcl'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1430         'jcw'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1431         'jmt'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1432         'jmx'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1433         'jpe'  => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1434         'jpeg' => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1435         'jpg'  => array ('type'=>'image/jpeg', 'icon'=>'jpeg', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1436         'jqz'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1437         'js'   => array ('type'=>'application/x-javascript', 'icon'=>'text', 'groups'=>array('web_file')),
1438         'latex'=> array ('type'=>'application/x-latex', 'icon'=>'text'),
1439         'm'    => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1440         'mbz'  => array ('type'=>'application/vnd.moodle.backup', 'icon'=>'moodle'),
1441         'mov'  => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1442         'movie'=> array ('type'=>'video/x-sgi-movie', 'icon'=>'quicktime', 'groups'=>array('video'), 'string'=>'video'),
1443         'm3u'  => array ('type'=>'audio/x-mpegurl', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1444         'mp3'  => array ('type'=>'audio/mp3', 'icon'=>'mp3', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1445         'mp4'  => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1446         'm4v'  => array ('type'=>'video/mp4', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1447         'm4a'  => array ('type'=>'audio/mp4', 'icon'=>'mp3', 'groups'=>array('audio'), 'string'=>'audio'),
1448         'mpeg' => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1449         'mpe'  => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1450         'mpg'  => array ('type'=>'video/mpeg', 'icon'=>'mpeg', 'groups'=>array('video','web_video'), 'string'=>'video'),
1452         'odt'  => array ('type'=>'application/vnd.oasis.opendocument.text', 'icon'=>'writer', 'groups'=>array('document')),
1453         'ott'  => array ('type'=>'application/vnd.oasis.opendocument.text-template', 'icon'=>'writer', 'groups'=>array('document')),
1454         'oth'  => array ('type'=>'application/vnd.oasis.opendocument.text-web', 'icon'=>'oth', 'groups'=>array('document')),
1455         'odm'  => array ('type'=>'application/vnd.oasis.opendocument.text-master', 'icon'=>'writer'),
1456         'odg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics', 'icon'=>'draw'),
1457         'otg'  => array ('type'=>'application/vnd.oasis.opendocument.graphics-template', 'icon'=>'draw'),
1458         'odp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation', 'icon'=>'impress'),
1459         'otp'  => array ('type'=>'application/vnd.oasis.opendocument.presentation-template', 'icon'=>'impress'),
1460         'ods'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1461         'ots'  => array ('type'=>'application/vnd.oasis.opendocument.spreadsheet-template', 'icon'=>'calc', 'groups'=>array('spreadsheet')),
1462         'odc'  => array ('type'=>'application/vnd.oasis.opendocument.chart', 'icon'=>'chart'),
1463         'odf'  => array ('type'=>'application/vnd.oasis.opendocument.formula', 'icon'=>'math'),
1464         'odb'  => array ('type'=>'application/vnd.oasis.opendocument.database', 'icon'=>'base'),
1465         'odi'  => array ('type'=>'application/vnd.oasis.opendocument.image', 'icon'=>'draw'),
1466         'oga'  => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1467         'ogg'  => array ('type'=>'audio/ogg', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1468         'ogv'  => array ('type'=>'video/ogg', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1470         'pct'  => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1471         'pdf'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1472         'php'  => array ('type'=>'text/plain', 'icon'=>'sourcecode'),
1473         'pic'  => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1474         'pict' => array ('type'=>'image/pict', 'icon'=>'image', 'groups'=>array('image'), 'string'=>'image'),
1475         'png'  => array ('type'=>'image/png', 'icon'=>'png', 'groups'=>array('image', 'web_image'), 'string'=>'image'),
1477         'pps'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1478         'ppt'  => array ('type'=>'application/vnd.ms-powerpoint', 'icon'=>'powerpoint', 'groups'=>array('presentation')),
1479         'pptx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'icon'=>'powerpoint'),
1480         'pptm' => array ('type'=>'application/vnd.ms-powerpoint.presentation.macroEnabled.12', 'icon'=>'powerpoint'),
1481         'potx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.template', 'icon'=>'powerpoint'),
1482         'potm' => array ('type'=>'application/vnd.ms-powerpoint.template.macroEnabled.12', 'icon'=>'powerpoint'),
1483         'ppam' => array ('type'=>'application/vnd.ms-powerpoint.addin.macroEnabled.12', 'icon'=>'powerpoint'),
1484         'ppsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 'icon'=>'powerpoint'),
1485         'ppsm' => array ('type'=>'application/vnd.ms-powerpoint.slideshow.macroEnabled.12', 'icon'=>'powerpoint'),
1487         'ps'   => array ('type'=>'application/postscript', 'icon'=>'pdf'),
1488         'qt'   => array ('type'=>'video/quicktime', 'icon'=>'quicktime', 'groups'=>array('video','web_video'), 'string'=>'video'),
1489         'ra'   => array ('type'=>'audio/x-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio','web_audio'), 'string'=>'audio'),
1490         'ram'  => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1491         'rhb'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1492         'rm'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('audio'), 'string'=>'audio'),
1493         'rmvb' => array ('type'=>'application/vnd.rn-realmedia-vbr', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1494         'rtf'  => array ('type'=>'text/rtf', 'icon'=>'text', 'groups'=>array('document')),
1495         'rtx'  => array ('type'=>'text/richtext', 'icon'=>'text'),
1496         'rv'   => array ('type'=>'audio/x-pn-realaudio-plugin', 'icon'=>'audio', 'groups'=>array('video'), 'string'=>'video'),
1497         'sh'   => array ('type'=>'application/x-sh', 'icon'=>'sourcecode'),
1498         'sit'  => array ('type'=>'application/x-stuffit', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1499         'smi'  => array ('type'=>'application/smil', 'icon'=>'text'),
1500         'smil' => array ('type'=>'application/smil', 'icon'=>'text'),
1501         'sqt'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1502         'svg'  => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1503         'svgz' => array ('type'=>'image/svg+xml', 'icon'=>'image', 'groups'=>array('image','web_image'), 'string'=>'image'),
1504         'swa'  => array ('type'=>'application/x-director', 'icon'=>'flash'),
1505         'swf'  => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1506         'swfl' => array ('type'=>'application/x-shockwave-flash', 'icon'=>'flash', 'groups'=>array('video','web_video')),
1508         'sxw'  => array ('type'=>'application/vnd.sun.xml.writer', 'icon'=>'writer'),
1509         'stw'  => array ('type'=>'application/vnd.sun.xml.writer.template', 'icon'=>'writer'),
1510         'sxc'  => array ('type'=>'application/vnd.sun.xml.calc', 'icon'=>'calc'),
1511         'stc'  => array ('type'=>'application/vnd.sun.xml.calc.template', 'icon'=>'calc'),
1512         'sxd'  => array ('type'=>'application/vnd.sun.xml.draw', 'icon'=>'draw'),
1513         'std'  => array ('type'=>'application/vnd.sun.xml.draw.template', 'icon'=>'draw'),
1514         'sxi'  => array ('type'=>'application/vnd.sun.xml.impress', 'icon'=>'impress'),
1515         'sti'  => array ('type'=>'application/vnd.sun.xml.impress.template', 'icon'=>'impress'),
1516         'sxg'  => array ('type'=>'application/vnd.sun.xml.writer.global', 'icon'=>'writer'),
1517         'sxm'  => array ('type'=>'application/vnd.sun.xml.math', 'icon'=>'math'),
1519         'tar'  => array ('type'=>'application/x-tar', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive'),
1520         'tif'  => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1521         'tiff' => array ('type'=>'image/tiff', 'icon'=>'tiff', 'groups'=>array('image'), 'string'=>'image'),
1522         'tex'  => array ('type'=>'application/x-tex', 'icon'=>'text'),
1523         'texi' => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1524         'texinfo'  => array ('type'=>'application/x-texinfo', 'icon'=>'text'),
1525         'tsv'  => array ('type'=>'text/tab-separated-values', 'icon'=>'text'),
1526         'txt'  => array ('type'=>'text/plain', 'icon'=>'text', 'defaulticon'=>true),
1527         'wav'  => array ('type'=>'audio/wav', 'icon'=>'wav', 'groups'=>array('audio'), 'string'=>'audio'),
1528         'webm'  => array ('type'=>'video/webm', 'icon'=>'video', 'groups'=>array('video'), 'string'=>'video'),
1529         'wmv'  => array ('type'=>'video/x-ms-wmv', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1530         'asf'  => array ('type'=>'video/x-ms-asf', 'icon'=>'wmv', 'groups'=>array('video'), 'string'=>'video'),
1531         'xdp'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1532         'xfd'  => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1533         'xfdf' => array ('type'=>'application/pdf', 'icon'=>'pdf'),
1535         'xls'  => array ('type'=>'application/vnd.ms-excel', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1536         'xlsx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'icon'=>'spreadsheet'),
1537         'xlsm' => array ('type'=>'application/vnd.ms-excel.sheet.macroEnabled.12', 'icon'=>'spreadsheet', 'groups'=>array('spreadsheet')),
1538         'xltx' => array ('type'=>'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 'icon'=>'spreadsheet'),
1539         'xltm' => array ('type'=>'application/vnd.ms-excel.template.macroEnabled.12', 'icon'=>'spreadsheet'),
1540         'xlsb' => array ('type'=>'application/vnd.ms-excel.sheet.binary.macroEnabled.12', 'icon'=>'spreadsheet'),
1541         'xlam' => array ('type'=>'application/vnd.ms-excel.addin.macroEnabled.12', 'icon'=>'spreadsheet'),
1543         'xml'  => array ('type'=>'application/xml', 'icon'=>'markup'),
1544         'xsl'  => array ('type'=>'text/xml', 'icon'=>'markup'),
1545         'zip'  => array ('type'=>'application/zip', 'icon'=>'archive', 'groups'=>array('archive'), 'string'=>'archive')
1546     );
1547     return $mimearray;
1550 /**
1551  * Obtains information about a filetype based on its extension. Will
1552  * use a default if no information is present about that particular
1553  * extension.
1554  *
1555  * @category files
1556  * @param string $element Desired information (usually 'icon'
1557  *   for icon filename or 'type' for MIME type. Can also be
1558  *   'icon24', ...32, 48, 64, 72, 80, 96, 128, 256)
1559  * @param string $filename Filename we're looking up
1560  * @return string Requested piece of information from array
1561  */
1562 function mimeinfo($element, $filename) {
1563     global $CFG;
1564     $mimeinfo = & get_mimetypes_array();
1565     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1567     $filetype = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1568     if (empty($filetype)) {
1569         $filetype = 'xxx'; // file without extension
1570     }
1571     if (preg_match('/^icon(\d*)$/', $element, $iconsizematch)) {
1572         $iconsize = max(array(16, (int)$iconsizematch[1]));
1573         $filenames = array($mimeinfo['xxx']['icon']);
1574         if ($filetype != 'xxx' && isset($mimeinfo[$filetype]['icon'])) {
1575             array_unshift($filenames, $mimeinfo[$filetype]['icon']);
1576         }
1577         // find the file with the closest size, first search for specific icon then for default icon
1578         foreach ($filenames as $filename) {
1579             foreach ($iconpostfixes as $size => $postfix) {
1580                 $fullname = $CFG->dirroot.'/pix/f/'.$filename.$postfix;
1581                 if ($iconsize >= $size && (file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1582                     return $filename.$postfix;
1583                 }
1584             }
1585         }
1586     } else if (isset($mimeinfo[$filetype][$element])) {
1587         return $mimeinfo[$filetype][$element];
1588     } else if (isset($mimeinfo['xxx'][$element])) {
1589         return $mimeinfo['xxx'][$element];   // By default
1590     } else {
1591         return null;
1592     }
1595 /**
1596  * Obtains information about a filetype based on the MIME type rather than
1597  * the other way around.
1598  *
1599  * @category files
1600  * @param string $element Desired information ('extension', 'icon', 'icon-24', etc.)
1601  * @param string $mimetype MIME type we're looking up
1602  * @return string Requested piece of information from array
1603  */
1604 function mimeinfo_from_type($element, $mimetype) {
1605     /* array of cached mimetype->extension associations */
1606     static $cached = array();
1607     $mimeinfo = & get_mimetypes_array();
1609     if (!array_key_exists($mimetype, $cached)) {
1610         $cached[$mimetype] = null;
1611         foreach($mimeinfo as $filetype => $values) {
1612             if ($values['type'] == $mimetype) {
1613                 if ($cached[$mimetype] === null) {
1614                     $cached[$mimetype] = '.'.$filetype;
1615                 }
1616                 if (!empty($values['defaulticon'])) {
1617                     $cached[$mimetype] = '.'.$filetype;
1618                     break;
1619                 }
1620             }
1621         }
1622         if (empty($cached[$mimetype])) {
1623             $cached[$mimetype] = '.xxx';
1624         }
1625     }
1626     if ($element === 'extension') {
1627         return $cached[$mimetype];
1628     } else {
1629         return mimeinfo($element, $cached[$mimetype]);
1630     }
1633 /**
1634  * Return the relative icon path for a given file
1635  *
1636  * Usage:
1637  * <code>
1638  * // $file - instance of stored_file or file_info
1639  * $icon = $OUTPUT->pix_url(file_file_icon($file))->out();
1640  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($file)));
1641  * </code>
1642  * or
1643  * <code>
1644  * echo $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file));
1645  * </code>
1646  *
1647  * @param stored_file|file_info|stdClass|array $file (in case of object attributes $file->filename
1648  *     and $file->mimetype are expected)
1649  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1650  * @return string
1651  */
1652 function file_file_icon($file, $size = null) {
1653     if (!is_object($file)) {
1654         $file = (object)$file;
1655     }
1656     if (isset($file->filename)) {
1657         $filename = $file->filename;
1658     } else if (method_exists($file, 'get_filename')) {
1659         $filename = $file->get_filename();
1660     } else if (method_exists($file, 'get_visible_name')) {
1661         $filename = $file->get_visible_name();
1662     } else {
1663         $filename = '';
1664     }
1665     if (isset($file->mimetype)) {
1666         $mimetype = $file->mimetype;
1667     } else if (method_exists($file, 'get_mimetype')) {
1668         $mimetype = $file->get_mimetype();
1669     } else {
1670         $mimetype = '';
1671     }
1672     $mimetypes = &get_mimetypes_array();
1673     if ($filename) {
1674         $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1675         if ($extension && !empty($mimetypes[$extension])) {
1676             // if file name has known extension, return icon for this extension
1677             return file_extension_icon($filename, $size);
1678         }
1679     }
1680     return file_mimetype_icon($mimetype, $size);
1683 /**
1684  * Return the relative icon path for a folder image
1685  *
1686  * Usage:
1687  * <code>
1688  * $icon = $OUTPUT->pix_url(file_folder_icon())->out();
1689  * echo html_writer::empty_tag('img', array('src' => $icon));
1690  * </code>
1691  * or
1692  * <code>
1693  * echo $OUTPUT->pix_icon(file_folder_icon(32));
1694  * </code>
1695  *
1696  * @param int $iconsize The size of the icon. Defaults to 16 can also be 24, 32, 48, 64, 72, 80, 96, 128, 256
1697  * @return string
1698  */
1699 function file_folder_icon($iconsize = null) {
1700     global $CFG;
1701     static $iconpostfixes = array(256=>'-256', 128=>'-128', 96=>'-96', 80=>'-80', 72=>'-72', 64=>'-64', 48=>'-48', 32=>'-32', 24=>'-24', 16=>'');
1702     static $cached = array();
1703     $iconsize = max(array(16, (int)$iconsize));
1704     if (!array_key_exists($iconsize, $cached)) {
1705         foreach ($iconpostfixes as $size => $postfix) {
1706             $fullname = $CFG->dirroot.'/pix/f/folder'.$postfix;
1707             if ($iconsize >= $size && (file_exists($fullname.'.png') || file_exists($fullname.'.gif'))) {
1708                 $cached[$iconsize] = 'f/folder'.$postfix;
1709                 break;
1710             }
1711         }
1712     }
1713     return $cached[$iconsize];
1716 /**
1717  * Returns the relative icon path for a given mime type
1718  *
1719  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1720  * a return the full path to an icon.
1721  *
1722  * <code>
1723  * $mimetype = 'image/jpg';
1724  * $icon = $OUTPUT->pix_url(file_mimetype_icon($mimetype))->out();
1725  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => get_mimetype_description($mimetype)));
1726  * </code>
1727  *
1728  * @category files
1729  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1730  * to conform with that.
1731  * @param string $mimetype The mimetype to fetch an icon for
1732  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1733  * @return string The relative path to the icon
1734  */
1735 function file_mimetype_icon($mimetype, $size = NULL) {
1736     return 'f/'.mimeinfo_from_type('icon'.$size, $mimetype);
1739 /**
1740  * Returns the relative icon path for a given file name
1741  *
1742  * This function should be used in conjunction with $OUTPUT->pix_url to produce
1743  * a return the full path to an icon.
1744  *
1745  * <code>
1746  * $filename = '.jpg';
1747  * $icon = $OUTPUT->pix_url(file_extension_icon($filename))->out();
1748  * echo html_writer::empty_tag('img', array('src' => $icon, 'alt' => '...'));
1749  * </code>
1750  *
1751  * @todo MDL-31074 When an $OUTPUT->icon method is available this function should be altered
1752  * to conform with that.
1753  * @todo MDL-31074 Implement $size
1754  * @category files
1755  * @param string $filename The filename to get the icon for
1756  * @param int $size The size of the icon. Defaults to 16 can also be 24, 32, 64, 128, 256
1757  * @return string
1758  */
1759 function file_extension_icon($filename, $size = NULL) {
1760     return 'f/'.mimeinfo('icon'.$size, $filename);
1763 /**
1764  * Obtains descriptions for file types (e.g. 'Microsoft Word document') from the
1765  * mimetypes.php language file.
1766  *
1767  * @param mixed $obj - instance of stored_file or file_info or array/stdClass with field
1768  *   'filename' and 'mimetype', or just a string with mimetype (though it is recommended to
1769  *   have filename); In case of array/stdClass the field 'mimetype' is optional.
1770  * @param bool $capitalise If true, capitalises first character of result
1771  * @return string Text description
1772  */
1773 function get_mimetype_description($obj, $capitalise=false) {
1774     $filename = $mimetype = '';
1775     if (is_object($obj) && method_exists($obj, 'get_filename') && method_exists($obj, 'get_mimetype')) {
1776         // this is an instance of stored_file
1777         $mimetype = $obj->get_mimetype();
1778         $filename = $obj->get_filename();
1779     } else if (is_object($obj) && method_exists($obj, 'get_visible_name') && method_exists($obj, 'get_mimetype')) {
1780         // this is an instance of file_info
1781         $mimetype = $obj->get_mimetype();
1782         $filename = $obj->get_visible_name();
1783     } else if (is_array($obj) || is_object ($obj)) {
1784         $obj = (array)$obj;
1785         if (!empty($obj['filename'])) {
1786             $filename = $obj['filename'];
1787         }
1788         if (!empty($obj['mimetype'])) {
1789             $mimetype = $obj['mimetype'];
1790         }
1791     } else {
1792         $mimetype = $obj;
1793     }
1794     $mimetypefromext = mimeinfo('type', $filename);
1795     if (empty($mimetype) || $mimetypefromext !== 'document/unknown') {
1796         // if file has a known extension, overwrite the specified mimetype
1797         $mimetype = $mimetypefromext;
1798     }
1799     $extension = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
1800     if (empty($extension)) {
1801         $mimetypestr = mimeinfo_from_type('string', $mimetype);
1802         $extension = str_replace('.', '', mimeinfo_from_type('extension', $mimetype));
1803     } else {
1804         $mimetypestr = mimeinfo('string', $filename);
1805     }
1806     $chunks = explode('/', $mimetype, 2);
1807     $chunks[] = '';
1808     $attr = array(
1809         'mimetype' => $mimetype,
1810         'ext' => $extension,
1811         'mimetype1' => $chunks[0],
1812         'mimetype2' => $chunks[1],
1813     );
1814     $a = array();
1815     foreach ($attr as $key => $value) {
1816         $a[$key] = $value;
1817         $a[strtoupper($key)] = strtoupper($value);
1818         $a[ucfirst($key)] = ucfirst($value);
1819     }
1820     if (get_string_manager()->string_exists($mimetype, 'mimetypes')) {
1821         $result = get_string($mimetype, 'mimetypes', (object)$a);
1822     } else if (get_string_manager()->string_exists($mimetypestr, 'mimetypes')) {
1823         $result = get_string($mimetypestr, 'mimetypes', (object)$a);
1824     } else if (get_string_manager()->string_exists('default', 'mimetypes')) {
1825         $result = get_string('default', 'mimetypes', (object)$a);
1826     } else {
1827         $result = $mimetype;
1828     }
1829     if ($capitalise) {
1830         $result=ucfirst($result);
1831     }
1832     return $result;
1835 /**
1836  * Returns array of elements of type $element in type group(s)
1837  *
1838  * @param string $element name of the element we are interested in, usually 'type' or 'extension'
1839  * @param string|array $groups one group or array of groups/extensions/mimetypes
1840  * @return array
1841  */
1842 function file_get_typegroup($element, $groups) {
1843     static $cached = array();
1844     if (!is_array($groups)) {
1845         $groups = array($groups);
1846     }
1847     if (!array_key_exists($element, $cached)) {
1848         $cached[$element] = array();
1849     }
1850     $result = array();
1851     foreach ($groups as $group) {
1852         if (!array_key_exists($group, $cached[$element])) {
1853             // retrieive and cache all elements of type $element for group $group
1854             $mimeinfo = & get_mimetypes_array();
1855             $cached[$element][$group] = array();
1856             foreach ($mimeinfo as $extension => $value) {
1857                 $value['extension'] = '.'.$extension;
1858                 if (empty($value[$element])) {
1859                     continue;
1860                 }
1861                 if (($group === '.'.$extension || $group === $value['type'] ||
1862                         (!empty($value['groups']) && in_array($group, $value['groups']))) &&
1863                         !in_array($value[$element], $cached[$element][$group])) {
1864                     $cached[$element][$group][] = $value[$element];
1865                 }
1866             }
1867         }
1868         $result = array_merge($result, $cached[$element][$group]);
1869     }
1870     return array_unique($result);
1873 /**
1874  * Checks if file with name $filename has one of the extensions in groups $groups
1875  *
1876  * @see get_mimetypes_array()
1877  * @param string $filename name of the file to check
1878  * @param string|array $groups one group or array of groups to check
1879  * @param bool $checktype if true and extension check fails, find the mimetype and check if
1880  * file mimetype is in mimetypes in groups $groups
1881  * @return bool
1882  */
1883 function file_extension_in_typegroup($filename, $groups, $checktype = false) {
1884     $extension = pathinfo($filename, PATHINFO_EXTENSION);
1885     if (!empty($extension) && in_array('.'.strtolower($extension), file_get_typegroup('extension', $groups))) {
1886         return true;
1887     }
1888     return $checktype && file_mimetype_in_typegroup(mimeinfo('type', $filename), $groups);
1891 /**
1892  * Checks if mimetype $mimetype belongs to one of the groups $groups
1893  *
1894  * @see get_mimetypes_array()
1895  * @param string $mimetype
1896  * @param string|array $groups one group or array of groups to check
1897  * @return bool
1898  */
1899 function file_mimetype_in_typegroup($mimetype, $groups) {
1900     return !empty($mimetype) && in_array($mimetype, file_get_typegroup('type', $groups));
1903 /**
1904  * Requested file is not found or not accessible, does not return, terminates script
1905  *
1906  * @global stdClass $CFG
1907  * @global stdClass $COURSE
1908  */
1909 function send_file_not_found() {
1910     global $CFG, $COURSE;
1911     send_header_404();
1912     print_error('filenotfound', 'error', $CFG->wwwroot.'/course/view.php?id='.$COURSE->id); //this is not displayed on IIS??
1914 /**
1915  * Helper function to send correct 404 for server.
1916  */
1917 function send_header_404() {
1918     if (substr(php_sapi_name(), 0, 3) == 'cgi') {
1919         header("Status: 404 Not Found");
1920     } else {
1921         header('HTTP/1.0 404 not found');
1922     }
1925 /**
1926  * Enhanced readfile() with optional acceleration.
1927  * @param string|stored_file $file
1928  * @param string $mimetype
1929  * @param bool $accelerate
1930  * @return void
1931  */
1932 function readfile_accel($file, $mimetype, $accelerate) {
1933     global $CFG;
1935     if ($mimetype === 'text/plain') {
1936         // there is no encoding specified in text files, we need something consistent
1937         header('Content-Type: text/plain; charset=utf-8');
1938     } else {
1939         header('Content-Type: '.$mimetype);
1940     }
1942     $lastmodified = is_object($file) ? $file->get_timemodified() : filemtime($file);
1943     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1945     if (is_object($file)) {
1946         header('ETag: ' . $file->get_contenthash());
1947         if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and $_SERVER['HTTP_IF_NONE_MATCH'] === $file->get_contenthash()) {
1948             header('HTTP/1.1 304 Not Modified');
1949             return;
1950         }
1951     }
1953     // if etag present for stored file rely on it exclusively
1954     if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) and (empty($_SERVER['HTTP_IF_NONE_MATCH']) or !is_object($file))) {
1955         // get unixtime of request header; clip extra junk off first
1956         $since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
1957         if ($since && $since >= $lastmodified) {
1958             header('HTTP/1.1 304 Not Modified');
1959             return;
1960         }
1961     }
1963     if ($accelerate and !empty($CFG->xsendfile)) {
1964         if (empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1965             header('Accept-Ranges: bytes');
1966         } else {
1967             header('Accept-Ranges: none');
1968         }
1970         if (is_object($file)) {
1971             $fs = get_file_storage();
1972             if ($fs->xsendfile($file->get_contenthash())) {
1973                 return;
1974             }
1976         } else {
1977             require_once("$CFG->libdir/xsendfilelib.php");
1978             if (xsendfile($file)) {
1979                 return;
1980             }
1981         }
1982     }
1984     $filesize = is_object($file) ? $file->get_filesize() : filesize($file);
1986     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
1988     if ($accelerate and empty($CFG->disablebyteserving) and $mimetype !== 'text/plain') {
1989         header('Accept-Ranges: bytes');
1991         if (!empty($_SERVER['HTTP_RANGE']) and strpos($_SERVER['HTTP_RANGE'],'bytes=') !== FALSE) {
1992             // byteserving stuff - for acrobat reader and download accelerators
1993             // see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
1994             // inspired by: http://www.coneural.org/florian/papers/04_byteserving.php
1995             $ranges = false;
1996             if (preg_match_all('/(\d*)-(\d*)/', $_SERVER['HTTP_RANGE'], $ranges, PREG_SET_ORDER)) {
1997                 foreach ($ranges as $key=>$value) {
1998                     if ($ranges[$key][1] == '') {
1999                         //suffix case
2000                         $ranges[$key][1] = $filesize - $ranges[$key][2];
2001                         $ranges[$key][2] = $filesize - 1;
2002                     } else if ($ranges[$key][2] == '' || $ranges[$key][2] > $filesize - 1) {
2003                         //fix range length
2004                         $ranges[$key][2] = $filesize - 1;
2005                     }
2006                     if ($ranges[$key][2] != '' && $ranges[$key][2] < $ranges[$key][1]) {
2007                         //invalid byte-range ==> ignore header
2008                         $ranges = false;
2009                         break;
2010                     }
2011                     //prepare multipart header
2012                     $ranges[$key][0] =  "\r\n--".BYTESERVING_BOUNDARY."\r\nContent-Type: $mimetype\r\n";
2013                     $ranges[$key][0] .= "Content-Range: bytes {$ranges[$key][1]}-{$ranges[$key][2]}/$filesize\r\n\r\n";
2014                 }
2015             } else {
2016                 $ranges = false;
2017             }
2018             if ($ranges) {
2019                 if (is_object($file)) {
2020                     $handle = $file->get_content_file_handle();
2021                 } else {
2022                     $handle = fopen($file, 'rb');
2023                 }
2024                 byteserving_send_file($handle, $mimetype, $ranges, $filesize);
2025             }
2026         }
2027     } else {
2028         // Do not byteserve
2029         header('Accept-Ranges: none');
2030     }
2032     header('Content-Length: '.$filesize);
2034     if ($filesize > 10000000) {
2035         // for large files try to flush and close all buffers to conserve memory
2036         while(@ob_get_level()) {
2037             if (!@ob_end_flush()) {
2038                 break;
2039             }
2040         }
2041     }
2043     // send the whole file content
2044     if (is_object($file)) {
2045         $file->readfile();
2046     } else {
2047         readfile($file);
2048     }
2051 /**
2052  * Similar to readfile_accel() but designed for strings.
2053  * @param string $string
2054  * @param string $mimetype
2055  * @param bool $accelerate
2056  * @return void
2057  */
2058 function readstring_accel($string, $mimetype, $accelerate) {
2059     global $CFG;
2061     if ($mimetype === 'text/plain') {
2062         // there is no encoding specified in text files, we need something consistent
2063         header('Content-Type: text/plain; charset=utf-8');
2064     } else {
2065         header('Content-Type: '.$mimetype);
2066     }
2067     header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
2068     header('Accept-Ranges: none');
2070     if ($accelerate and !empty($CFG->xsendfile)) {
2071         $fs = get_file_storage();
2072         if ($fs->xsendfile(sha1($string))) {
2073             return;
2074         }
2075     }
2077     header('Content-Length: '.strlen($string));
2078     echo $string;
2081 /**
2082  * Handles the sending of temporary file to user, download is forced.
2083  * File is deleted after abort or successful sending, does not return, script terminated
2084  *
2085  * @param string $path path to file, preferably from moodledata/temp/something; or content of file itself
2086  * @param string $filename proposed file name when saving file
2087  * @param bool $pathisstring If the path is string
2088  */
2089 function send_temp_file($path, $filename, $pathisstring=false) {
2090     global $CFG;
2092     if (check_browser_version('Firefox', '1.5')) {
2093         // only FF is known to correctly save to disk before opening...
2094         $mimetype = mimeinfo('type', $filename);
2095     } else {
2096         $mimetype = 'application/x-forcedownload';
2097     }
2099     // close session - not needed anymore
2100     session_get_instance()->write_close();
2102     if (!$pathisstring) {
2103         if (!file_exists($path)) {
2104             send_header_404();
2105             print_error('filenotfound', 'error', $CFG->wwwroot.'/');
2106         }
2107         // executed after normal finish or abort
2108         @register_shutdown_function('send_temp_file_finished', $path);
2109     }
2111     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2112     if (check_browser_version('MSIE')) {
2113         $filename = urlencode($filename);
2114     }
2116     header('Content-Disposition: attachment; filename="'.$filename.'"');
2117     if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2118         header('Cache-Control: max-age=10');
2119         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2120         header('Pragma: ');
2121     } else { //normal http - prevent caching at all cost
2122         header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2123         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2124         header('Pragma: no-cache');
2125     }
2127     // send the contents - we can not accelerate this because the file will be deleted asap
2128     if ($pathisstring) {
2129         readstring_accel($path, $mimetype, false);
2130     } else {
2131         readfile_accel($path, $mimetype, false);
2132         @unlink($path);
2133     }
2135     die; //no more chars to output
2138 /**
2139  * Internal callback function used by send_temp_file()
2140  *
2141  * @param string $path
2142  */
2143 function send_temp_file_finished($path) {
2144     if (file_exists($path)) {
2145         @unlink($path);
2146     }
2149 /**
2150  * Handles the sending of file data to the user's browser, including support for
2151  * byteranges etc.
2152  *
2153  * @category files
2154  * @param string $path Path of file on disk (including real filename), or actual content of file as string
2155  * @param string $filename Filename to send
2156  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
2157  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2158  * @param bool $pathisstring If true (default false), $path is the content to send and not the pathname
2159  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2160  * @param string $mimetype Include to specify the MIME type; leave blank to have it guess the type from $filename
2161  * @param bool $dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2162  *                        if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2163  *                        you must detect this case when control is returned using connection_aborted. Please not that session is closed
2164  *                        and should not be reopened.
2165  * @return null script execution stopped unless $dontdie is true
2166  */
2167 function send_file($path, $filename, $lifetime = 'default' , $filter=0, $pathisstring=false, $forcedownload=false, $mimetype='', $dontdie=false) {
2168     global $CFG, $COURSE;
2170     if ($dontdie) {
2171         ignore_user_abort(true);
2172     }
2174     // MDL-11789, apply $CFG->filelifetime here
2175     if ($lifetime === 'default') {
2176         if (!empty($CFG->filelifetime)) {
2177             $lifetime = $CFG->filelifetime;
2178         } else {
2179             $lifetime = 86400;
2180         }
2181     }
2183     session_get_instance()->write_close(); // unlock session during fileserving
2185     // Use given MIME type if specified, otherwise guess it using mimeinfo.
2186     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2187     // only Firefox saves all files locally before opening when content-disposition: attachment stated
2188     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
2189     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
2190                          ($mimetype ? $mimetype : mimeinfo('type', $filename));
2192     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2193     if (check_browser_version('MSIE')) {
2194         $filename = rawurlencode($filename);
2195     }
2197     if ($forcedownload) {
2198         header('Content-Disposition: attachment; filename="'.$filename.'"');
2199     } else {
2200         header('Content-Disposition: inline; filename="'.$filename.'"');
2201     }
2203     if ($lifetime > 0) {
2204         $nobyteserving = false;
2205         header('Cache-Control: max-age='.$lifetime);
2206         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2207         header('Pragma: ');
2209     } else { // Do not cache files in proxies and browsers
2210         $nobyteserving = true;
2211         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2212             header('Cache-Control: max-age=10');
2213             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2214             header('Pragma: ');
2215         } else { //normal http - prevent caching at all cost
2216             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2217             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2218             header('Pragma: no-cache');
2219         }
2220     }
2222     if (empty($filter)) {
2223         // send the contents
2224         if ($pathisstring) {
2225             readstring_accel($path, $mimetype, !$dontdie);
2226         } else {
2227             readfile_accel($path, $mimetype, !$dontdie);
2228         }
2230     } else {
2231         // Try to put the file through filters
2232         if ($mimetype == 'text/html') {
2233             $options = new stdClass();
2234             $options->noclean = true;
2235             $options->nocache = true; // temporary workaround for MDL-5136
2236             $text = $pathisstring ? $path : implode('', file($path));
2238             $text = file_modify_html_header($text);
2239             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2241             readstring_accel($output, $mimetype, false);
2243         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2244             // only filter text if filter all files is selected
2245             $options = new stdClass();
2246             $options->newlines = false;
2247             $options->noclean = true;
2248             $text = htmlentities($pathisstring ? $path : implode('', file($path)));
2249             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2251             readstring_accel($output, $mimetype, false);
2253         } else {
2254             // send the contents
2255             if ($pathisstring) {
2256                 readstring_accel($path, $mimetype, !$dontdie);
2257             } else {
2258                 readfile_accel($path, $mimetype, !$dontdie);
2259             }
2260         }
2261     }
2262     if ($dontdie) {
2263         return;
2264     }
2265     die; //no more chars to output!!!
2268 /**
2269  * Handles the sending of file data to the user's browser, including support for
2270  * byteranges etc.
2271  *
2272  * The $options parameter supports the following keys:
2273  *  (string|null) preview - send the preview of the file (e.g. "thumb" for a thumbnail)
2274  *  (string|null) filename - overrides the implicit filename
2275  *  (bool) dontdie - return control to caller afterwards. this is not recommended and only used for cleanup tasks.
2276  *      if this is passed as true, ignore_user_abort is called.  if you don't want your processing to continue on cancel,
2277  *      you must detect this case when control is returned using connection_aborted. Please not that session is closed
2278  *      and should not be reopened.
2279  *
2280  * @category files
2281  * @param stored_file $stored_file local file object
2282  * @param int $lifetime Number of seconds before the file should expire from caches (default 24 hours)
2283  * @param int $filter 0 (default)=no filtering, 1=all files, 2=html files only
2284  * @param bool $forcedownload If true (default false), forces download of file rather than view in browser/plugin
2285  * @param array $options additional options affecting the file serving
2286  * @return null script execution stopped unless $options['dontdie'] is true
2287  */
2288 function send_stored_file($stored_file, $lifetime=86400 , $filter=0, $forcedownload=false, array $options=array()) {
2289     global $CFG, $COURSE;
2291     if (empty($options['filename'])) {
2292         $filename = null;
2293     } else {
2294         $filename = $options['filename'];
2295     }
2297     if (empty($options['dontdie'])) {
2298         $dontdie = false;
2299     } else {
2300         $dontdie = true;
2301     }
2303     if (!empty($options['preview'])) {
2304         // replace the file with its preview
2305         $fs = get_file_storage();
2306         $preview_file = $fs->get_file_preview($stored_file, $options['preview']);
2307         if (!$preview_file) {
2308             // unable to create a preview of the file, send its default mime icon instead
2309             if ($options['preview'] === 'tinyicon') {
2310                 $size = 24;
2311             } else if ($options['preview'] === 'thumb') {
2312                 $size = 90;
2313             } else {
2314                 $size = 256;
2315             }
2316             $fileicon = file_file_icon($stored_file, $size);
2317             send_file($CFG->dirroot.'/pix/'.$fileicon.'.png', basename($fileicon).'.png');
2318         } else {
2319             // preview images have fixed cache lifetime and they ignore forced download
2320             // (they are generated by GD and therefore they are considered reasonably safe).
2321             $stored_file = $preview_file;
2322             $lifetime = DAYSECS;
2323             $filter = 0;
2324             $forcedownload = false;
2325         }
2326     }
2328     // handle external resource
2329     if ($stored_file && $stored_file->is_external_file()) {
2330         $stored_file->send_file($lifetime, $filter, $forcedownload, $options);
2331         die;
2332     }
2334     if (!$stored_file or $stored_file->is_directory()) {
2335         // nothing to serve
2336         if ($dontdie) {
2337             return;
2338         }
2339         die;
2340     }
2342     if ($dontdie) {
2343         ignore_user_abort(true);
2344     }
2346     session_get_instance()->write_close(); // unlock session during fileserving
2348     // Use given MIME type if specified, otherwise guess it using mimeinfo.
2349     // IE, Konqueror and Opera open html file directly in browser from web even when directed to save it to disk :-O
2350     // only Firefox saves all files locally before opening when content-disposition: attachment stated
2351     $filename     = is_null($filename) ? $stored_file->get_filename() : $filename;
2352     $isFF         = check_browser_version('Firefox', '1.5'); // only FF > 1.5 properly tested
2353     $mimetype     = ($forcedownload and !$isFF) ? 'application/x-forcedownload' :
2354                          ($stored_file->get_mimetype() ? $stored_file->get_mimetype() : mimeinfo('type', $filename));
2356     // if user is using IE, urlencode the filename so that multibyte file name will show up correctly on popup
2357     if (check_browser_version('MSIE')) {
2358         $filename = rawurlencode($filename);
2359     }
2361     if ($forcedownload) {
2362         header('Content-Disposition: attachment; filename="'.$filename.'"');
2363     } else {
2364         header('Content-Disposition: inline; filename="'.$filename.'"');
2365     }
2367     if ($lifetime > 0) {
2368         header('Cache-Control: max-age='.$lifetime);
2369         header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
2370         header('Pragma: ');
2372     } else { // Do not cache files in proxies and browsers
2373         if (strpos($CFG->wwwroot, 'https://') === 0) { //https sites - watch out for IE! KB812935 and KB316431
2374             header('Cache-Control: max-age=10');
2375             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2376             header('Pragma: ');
2377         } else { //normal http - prevent caching at all cost
2378             header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
2379             header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
2380             header('Pragma: no-cache');
2381         }
2382     }
2384     if (empty($filter)) {
2385         // send the contents
2386         readfile_accel($stored_file, $mimetype, !$dontdie);
2388     } else {     // Try to put the file through filters
2389         if ($mimetype == 'text/html') {
2390             $options = new stdClass();
2391             $options->noclean = true;
2392             $options->nocache = true; // temporary workaround for MDL-5136
2393             $text = $stored_file->get_content();
2394             $text = file_modify_html_header($text);
2395             $output = format_text($text, FORMAT_HTML, $options, $COURSE->id);
2397             readstring_accel($output, $mimetype, false);
2399         } else if (($mimetype == 'text/plain') and ($filter == 1)) {
2400             // only filter text if filter all files is selected
2401             $options = new stdClass();
2402             $options->newlines = false;
2403             $options->noclean = true;
2404             $text = $stored_file->get_content();
2405             $output = '<pre>'. format_text($text, FORMAT_MOODLE, $options, $COURSE->id) .'</pre>';
2407             readstring_accel($output, $mimetype, false);
2409         } else {    // Just send it out raw
2410             readfile_accel($stored_file, $mimetype, !$dontdie);
2411         }
2412     }
2413     if ($dontdie) {
2414         return;
2415     }
2416     die; //no more chars to output!!!
2419 /**
2420  * Retrieves an array of records from a CSV file and places
2421  * them into a given table structure
2422  *
2423  * @global stdClass $CFG
2424  * @global moodle_database $DB
2425  * @param string $file The path to a CSV file
2426  * @param string $table The table to retrieve columns from
2427  * @return bool|array Returns an array of CSV records or false
2428  */
2429 function get_records_csv($file, $table) {
2430     global $CFG, $DB;
2432     if (!$metacolumns = $DB->get_columns($table)) {
2433         return false;
2434     }
2436     if(!($handle = @fopen($file, 'r'))) {
2437         print_error('get_records_csv failed to open '.$file);
2438     }
2440     $fieldnames = fgetcsv($handle, 4096);
2441     if(empty($fieldnames)) {
2442         fclose($handle);
2443         return false;
2444     }
2446     $columns = array();
2448     foreach($metacolumns as $metacolumn) {
2449         $ord = array_search($metacolumn->name, $fieldnames);
2450         if(is_int($ord)) {
2451             $columns[$metacolumn->name] = $ord;
2452         }
2453     }
2455     $rows = array();
2457     while (($data = fgetcsv($handle, 4096)) !== false) {
2458         $item = new stdClass;
2459         foreach($columns as $name => $ord) {
2460             $item->$name = $data[$ord];
2461         }
2462         $rows[] = $item;
2463     }
2465     fclose($handle);
2466     return $rows;
2469 /**
2470  * Create a file with CSV contents
2471  *
2472  * @global stdClass $CFG
2473  * @global moodle_database $DB
2474  * @param string $file The file to put the CSV content into
2475  * @param array $records An array of records to write to a CSV file
2476  * @param string $table The table to get columns from
2477  * @return bool success
2478  */
2479 function put_records_csv($file, $records, $table = NULL) {
2480     global $CFG, $DB;
2482     if (empty($records)) {
2483         return true;
2484     }
2486     $metacolumns = NULL;
2487     if ($table !== NULL && !$metacolumns = $DB->get_columns($table)) {
2488         return false;
2489     }
2491     echo "x";
2493     if(!($fp = @fopen($CFG->tempdir.'/'.$file, 'w'))) {
2494         print_error('put_records_csv failed to open '.$file);
2495     }
2497     $proto = reset($records);
2498     if(is_object($proto)) {
2499         $fields_records = array_keys(get_object_vars($proto));
2500     }
2501     else if(is_array($proto)) {
2502         $fields_records = array_keys($proto);
2503     }
2504     else {
2505         return false;
2506     }
2507     echo "x";
2509     if(!empty($metacolumns)) {
2510         $fields_table = array_map(create_function('$a', 'return $a->name;'), $metacolumns);
2511         $fields = array_intersect($fields_records, $fields_table);
2512     }
2513     else {
2514         $fields = $fields_records;
2515     }
2517     fwrite($fp, implode(',', $fields));
2518     fwrite($fp, "\r\n");
2520     foreach($records as $record) {
2521         $array  = (array)$record;
2522         $values = array();
2523         foreach($fields as $field) {
2524             if(strpos($array[$field], ',')) {
2525                 $values[] = '"'.str_replace('"', '\"', $array[$field]).'"';
2526             }
2527             else {
2528                 $values[] = $array[$field];
2529             }
2530         }
2531         fwrite($fp, implode(',', $values)."\r\n");
2532     }
2534     fclose($fp);
2535     return true;
2539 /**
2540  * Recursively delete the file or folder with path $location. That is,
2541  * if it is a file delete it. If it is a folder, delete all its content
2542  * then delete it. If $location does not exist to start, that is not
2543  * considered an error.
2544  *
2545  * @param string $location the path to remove.
2546  * @return bool
2547  */
2548 function fulldelete($location) {
2549     if (empty($location)) {
2550         // extra safety against wrong param
2551         return false;
2552     }
2553     if (is_dir($location)) {
2554         if (!$currdir = opendir($location)) {
2555             return false;
2556         }
2557         while (false !== ($file = readdir($currdir))) {
2558             if ($file <> ".." && $file <> ".") {
2559                 $fullfile = $location."/".$file;
2560                 if (is_dir($fullfile)) {
2561                     if (!fulldelete($fullfile)) {
2562                         return false;
2563                     }
2564                 } else {
2565                     if (!unlink($fullfile)) {
2566                         return false;
2567                     }
2568                 }
2569             }
2570         }
2571         closedir($currdir);
2572         if (! rmdir($location)) {
2573             return false;
2574         }
2576     } else if (file_exists($location)) {
2577         if (!unlink($location)) {
2578             return false;
2579         }
2580     }
2581     return true;
2584 /**
2585  * Send requested byterange of file.
2586  *
2587  * @param resource $handle A file handle
2588  * @param string $mimetype The mimetype for the output
2589  * @param array $ranges An array of ranges to send
2590  * @param string $filesize The size of the content if only one range is used
2591  */
2592 function byteserving_send_file($handle, $mimetype, $ranges, $filesize) {
2593     // better turn off any kind of compression and buffering
2594     @ini_set('zlib.output_compression', 'Off');
2596     $chunksize = 1*(1024*1024); // 1MB chunks - must be less than 2MB!
2597     if ($handle === false) {
2598         die;
2599     }
2600     if (count($ranges) == 1) { //only one range requested
2601         $length = $ranges[0][2] - $ranges[0][1] + 1;
2602         header('HTTP/1.1 206 Partial content');
2603         header('Content-Length: '.$length);
2604         header('Content-Range: bytes '.$ranges[0][1].'-'.$ranges[0][2].'/'.$filesize);
2605         header('Content-Type: '.$mimetype);
2607         while(@ob_get_level()) {
2608             if (!@ob_end_flush()) {
2609                 break;
2610             }
2611         }
2613         fseek($handle, $ranges[0][1]);
2614         while (!feof($handle) && $length > 0) {
2615             @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2616             $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2617             echo $buffer;
2618             flush();
2619             $length -= strlen($buffer);
2620         }
2621         fclose($handle);
2622         die;
2623     } else { // multiple ranges requested - not tested much
2624         $totallength = 0;
2625         foreach($ranges as $range) {
2626             $totallength += strlen($range[0]) + $range[2] - $range[1] + 1;
2627         }
2628         $totallength += strlen("\r\n--".BYTESERVING_BOUNDARY."--\r\n");
2629         header('HTTP/1.1 206 Partial content');
2630         header('Content-Length: '.$totallength);
2631         header('Content-Type: multipart/byteranges; boundary='.BYTESERVING_BOUNDARY);
2633         while(@ob_get_level()) {
2634             if (!@ob_end_flush()) {
2635                 break;
2636             }
2637         }
2639         foreach($ranges as $range) {
2640             $length = $range[2] - $range[1] + 1;
2641             echo $range[0];
2642             fseek($handle, $range[1]);
2643             while (!feof($handle) && $length > 0) {
2644                 @set_time_limit(60*60); //reset time limit to 60 min - should be enough for 1 MB chunk
2645                 $buffer = fread($handle, ($chunksize < $length ? $chunksize : $length));
2646                 echo $buffer;
2647                 flush();
2648                 $length -= strlen($buffer);
2649             }
2650         }
2651         echo "\r\n--".BYTESERVING_BOUNDARY."--\r\n";
2652         fclose($handle);
2653         die;
2654     }
2657 /**
2658  * add includes (js and css) into uploaded files
2659  * before returning them, useful for themes and utf.js includes
2660  *
2661  * @global stdClass $CFG
2662  * @param string $text text to search and replace
2663  * @return string text with added head includes
2664  * @todo MDL-21120
2665  */
2666 function file_modify_html_header($text) {
2667     // first look for <head> tag
2668     global $CFG;
2670     $stylesheetshtml = '';
2671 /*    foreach ($CFG->stylesheets as $stylesheet) {
2672         //TODO: MDL-21120
2673         $stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
2674     }*/
2676     $ufo = '';
2677     if (filter_is_enabled('filter/mediaplugin')) {
2678         // this script is needed by most media filter plugins.
2679         $attributes = array('type'=>'text/javascript', 'src'=>$CFG->httpswwwroot . '/lib/ufo.js');
2680         $ufo = html_writer::tag('script', '', $attributes) . "\n";
2681     }
2683     preg_match('/\<head\>|\<HEAD\>/', $text, $matches);
2684     if ($matches) {
2685         $replacement = '<head>'.$ufo.$stylesheetshtml;
2686         $text = preg_replace('/\<head\>|\<HEAD\>/', $replacement, $text, 1);
2687         return $text;
2688     }
2690     // if not, look for <html> tag, and stick <head> right after
2691     preg_match('/\<html\>|\<HTML\>/', $text, $matches);
2692     if ($matches) {
2693         // replace <html> tag with <html><head>includes</head>
2694         $replacement = '<html>'."\n".'<head>'.$ufo.$stylesheetshtml.'</head>';
2695         $text = preg_replace('/\<html\>|\<HTML\>/', $replacement, $text, 1);
2696         return $text;
2697     }
2699     // if not, look for <body> tag, and stick <head> before body
2700     preg_match('/\<body\>|\<BODY\>/', $text, $matches);
2701     if ($matches) {
2702         $replacement = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".'<body>';
2703         $text = preg_replace('/\<body\>|\<BODY\>/', $replacement, $text, 1);
2704         return $text;
2705     }
2707     // if not, just stick a <head> tag at the beginning
2708     $text = '<head>'.$ufo.$stylesheetshtml.'</head>'."\n".$text;
2709     return $text;
2712 /**
2713  * RESTful cURL class
2714  *
2715  * This is a wrapper class for curl, it is quite easy to use:
2716  * <code>
2717  * $c = new curl;
2718  * // enable cache
2719  * $c = new curl(array('cache'=>true));
2720  * // enable cookie
2721  * $c = new curl(array('cookie'=>true));
2722  * // enable proxy
2723  * $c = new curl(array('proxy'=>true));
2724  *
2725  * // HTTP GET Method
2726  * $html = $c->get('http://example.com');
2727  * // HTTP POST Method
2728  * $html = $c->post('http://example.com/', array('q'=>'words', 'name'=>'moodle'));
2729  * // HTTP PUT Method
2730  * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
2731  * </code>
2732  *
2733  * @package   core_files
2734  * @category files
2735  * @copyright Dongsheng Cai <dongsheng@moodle.com>
2736  * @license   http://www.gnu.org/copyleft/gpl.html GNU Public License
2737  */
2738 class curl {
2739     /** @var bool Caches http request contents */
2740     public  $cache    = false;
2741     /** @var bool Uses proxy */
2742     public  $proxy    = false;
2743     /** @var string library version */
2744     public  $version  = '0.4 dev';
2745     /** @var array http's response */
2746     public  $response = array();
2747     /** @var array http header */
2748     public  $header   = array();
2749     /** @var string cURL information */
2750     public  $info;
2751     /** @var string error */
2752     public  $error;
2754     /** @var array cURL options */
2755     private $options;
2756     /** @var string Proxy host */
2757     private $proxy_host = '';
2758     /** @var string Proxy auth */
2759     private $proxy_auth = '';
2760     /** @var string Proxy type */
2761     private $proxy_type = '';
2762     /** @var bool Debug mode on */
2763     private $debug    = false;
2764     /** @var bool|string Path to cookie file */
2765     private $cookie   = false;
2767     /**
2768      * Constructor
2769      *
2770      * @global stdClass $CFG
2771      * @param array $options
2772      */
2773     public function __construct($options = array()){
2774         global $CFG;
2775         if (!function_exists('curl_init')) {
2776             $this->error = 'cURL module must be enabled!';
2777             trigger_error($this->error, E_USER_ERROR);
2778             return false;
2779         }
2780         // the options of curl should be init here.
2781         $this->resetopt();
2782         if (!empty($options['debug'])) {
2783             $this->debug = true;
2784         }
2785         if(!empty($options['cookie'])) {
2786             if($options['cookie'] === true) {
2787                 $this->cookie = $CFG->dataroot.'/curl_cookie.txt';
2788             } else {
2789                 $this->cookie = $options['cookie'];
2790             }
2791         }
2792         if (!empty($options['cache'])) {
2793             if (class_exists('curl_cache')) {
2794                 if (!empty($options['module_cache'])) {
2795                     $this->cache = new curl_cache($options['module_cache']);
2796                 } else {
2797                     $this->cache = new curl_cache('misc');
2798                 }
2799             }
2800         }
2801         if (!empty($CFG->proxyhost)) {
2802             if (empty($CFG->proxyport)) {
2803                 $this->proxy_host = $CFG->proxyhost;
2804             } else {
2805                 $this->proxy_host = $CFG->proxyhost.':'.$CFG->proxyport;
2806             }
2807             if (!empty($CFG->proxyuser) and !empty($CFG->proxypassword)) {
2808                 $this->proxy_auth = $CFG->proxyuser.':'.$CFG->proxypassword;
2809                 $this->setopt(array(
2810                             'proxyauth'=> CURLAUTH_BASIC | CURLAUTH_NTLM,
2811                             'proxyuserpwd'=>$this->proxy_auth));
2812             }
2813             if (!empty($CFG->proxytype)) {
2814                 if ($CFG->proxytype == 'SOCKS5') {
2815                     $this->proxy_type = CURLPROXY_SOCKS5;
2816                 } else {
2817                     $this->proxy_type = CURLPROXY_HTTP;
2818                     $this->setopt(array('httpproxytunnel'=>false));
2819                 }
2820                 $this->setopt(array('proxytype'=>$this->proxy_type));
2821             }
2822         }
2823         if (!empty($this->proxy_host)) {
2824             $this->proxy = array('proxy'=>$this->proxy_host);
2825         }
2826     }
2827     /**
2828      * Resets the CURL options that have already been set
2829      */
2830     public function resetopt(){
2831         $this->options = array();
2832         $this->options['CURLOPT_USERAGENT']         = 'MoodleBot/1.0';
2833         // True to include the header in the output
2834         $this->options['CURLOPT_HEADER']            = 0;
2835         // True to Exclude the body from the output
2836         $this->options['CURLOPT_NOBODY']            = 0;
2837         // TRUE to follow any "Location: " header that the server
2838         // sends as part of the HTTP header (note this is recursive,
2839         // PHP will follow as many "Location: " headers that it is sent,
2840         // unless CURLOPT_MAXREDIRS is set).
2841         //$this->options['CURLOPT_FOLLOWLOCATION']    = 1;
2842         $this->options['CURLOPT_MAXREDIRS']         = 10;
2843         $this->options['CURLOPT_ENCODING']          = '';
2844         // TRUE to return the transfer as a string of the return
2845         // value of curl_exec() instead of outputting it out directly.
2846         $this->options['CURLOPT_RETURNTRANSFER']    = 1;
2847         $this->options['CURLOPT_BINARYTRANSFER']    = 0;
2848         $this->options['CURLOPT_SSL_VERIFYPEER']    = 0;
2849         $this->options['CURLOPT_SSL_VERIFYHOST']    = 2;
2850         $this->options['CURLOPT_CONNECTTIMEOUT']    = 30;
2851     }
2853     /**
2854      * Reset Cookie
2855      */
2856     public function resetcookie() {
2857         if (!empty($this->cookie)) {
2858             if (is_file($this->cookie)) {
2859                 $fp = fopen($this->cookie, 'w');
2860                 if (!empty($fp)) {
2861                     fwrite($fp, '');
2862                     fclose($fp);
2863                 }
2864             }
2865         }
2866     }
2868     /**
2869      * Set curl options
2870      *
2871      * @param array $options If array is null, this function will
2872      * reset the options to default value.
2873      */
2874     public function setopt($options = array()) {
2875         if (is_array($options)) {
2876             foreach($options as $name => $val){
2877                 if (stripos($name, 'CURLOPT_') === false) {
2878                     $name = strtoupper('CURLOPT_'.$name);
2879                 }
2880                 $this->options[$name] = $val;
2881             }
2882         }
2883     }
2885     /**
2886      * Reset http method
2887      */
2888     public function cleanopt(){
2889         unset($this->options['CURLOPT_HTTPGET']);
2890         unset($this->options['CURLOPT_POST']);
2891         unset($this->options['CURLOPT_POSTFIELDS']);
2892         unset($this->options['CURLOPT_PUT']);
2893         unset($this->options['CURLOPT_INFILE']);
2894         unset($this->options['CURLOPT_INFILESIZE']);
2895         unset($this->options['CURLOPT_CUSTOMREQUEST']);
2896     }
2898     /**
2899      * Set HTTP Request Header
2900      *
2901      * @param array $header
2902      */
2903     public function setHeader($header) {
2904         if (is_array($header)){
2905             foreach ($header as $v) {
2906                 $this->setHeader($v);
2907             }
2908         } else {
2909             $this->header[] = $header;
2910         }
2911     }
2913     /**
2914      * Set HTTP Response Header
2915      *
2916      */
2917     public function getResponse(){
2918         return $this->response;
2919     }
2921     /**
2922      * private callback function
2923      * Formatting HTTP Response Header
2924      *
2925      * @param resource $ch Apparently not used
2926      * @param string $header
2927      * @return int The strlen of the header
2928      */
2929     private function formatHeader($ch, $header)
2930     {
2931         $this->count++;
2932         if (strlen($header) > 2) {
2933             list($key, $value) = explode(" ", rtrim($header, "\r\n"), 2);
2934             $key = rtrim($key, ':');
2935             if (!empty($this->response[$key])) {
2936                 if (is_array($this->response[$key])){
2937                     $this->response[$key][] = $value;
2938                 } else {
2939                     $tmp = $this->response[$key];
2940                     $this->response[$key] = array();
2941                     $this->response[$key][] = $tmp;
2942                     $this->response[$key][] = $value;
2944                 }
2945             } else {
2946                 $this->response[$key] = $value;
2947             }
2948         }
2949         return strlen($header);
2950     }
2952     /**
2953      * Set options for individual curl instance
2954      *
2955      * @param resource $curl A curl handle
2956      * @param array $options
2957      * @return resource The curl handle
2958      */
2959     private function apply_opt($curl, $options) {
2960         // Clean up
2961         $this->cleanopt();
2962         // set cookie
2963         if (!empty($this->cookie) || !empty($options['cookie'])) {
2964             $this->setopt(array('cookiejar'=>$this->cookie,
2965                             'cookiefile'=>$this->cookie
2966                              ));
2967         }
2969         // set proxy
2970         if (!empty($this->proxy) || !empty($options['proxy'])) {
2971             $this->setopt($this->proxy);
2972         }
2973         $this->setopt($options);
2974         // reset before set options
2975         curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this,'formatHeader'));
2976         // set headers
2977         if (empty($this->header)){
2978             $this->setHeader(array(
2979                 'User-Agent: MoodleBot/1.0',
2980                 'Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7',
2981                 'Connection: keep-alive'
2982                 ));
2983         }
2984         curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header);
2986         if ($this->debug){
2987             echo '<h1>Options</h1>';
2988             var_dump($this->options);
2989             echo '<h1>Header</h1>';
2990             var_dump($this->header);
2991         }
2993         // set options
2994         foreach($this->options as $name => $val) {
2995             if (is_string($name)) {
2996                 $name = constant(strtoupper($name));
2997             }
2998             curl_setopt($curl, $name, $val);
2999         }
3000         return $curl;
3001     }
3003     /**
3004      * Download multiple files in parallel
3005      *
3006      * Calls {@link multi()} with specific download headers
3007      *
3008      * <code>
3009      * $c = new curl;
3010      * $c->download(array(
3011      *              array('url'=>'http://localhost/', 'file'=>fopen('a', 'wb')),
3012      *              array('url'=>'http://localhost/20/', 'file'=>fopen('b', 'wb'))
3013      *              ));
3014      * </code>
3015      *
3016      * @param array $requests An array of files to request
3017      * @param array $options An array of options to set
3018      * @return array An array of results
3019      */
3020     public function download($requests, $options = array()) {
3021         $options['CURLOPT_BINARYTRANSFER'] = 1;
3022         $options['RETURNTRANSFER'] = false;
3023         return $this->multi($requests, $options);
3024     }
3026     /**
3027      * Mulit HTTP Requests
3028      * This function could run multi-requests in parallel.
3029      *
3030      * @param array $requests An array of files to request
3031      * @param array $options An array of options to set
3032      * @return array An array of results
3033      */
3034     protected function multi($requests, $options = array()) {
3035         $count   = count($requests);
3036         $handles = array();
3037         $results = array();
3038         $main    = curl_multi_init();
3039         for ($i = 0; $i < $count; $i++) {
3040             $url = $requests[$i];
3041             foreach($url as $n=>$v){
3042                 $options[$n] = $url[$n];
3043             }
3044             $handles[$i] = curl_init($url['url']);
3045             $this->apply_opt($handles[$i], $options);
3046             curl_multi_add_handle($main, $handles[$i]);
3047         }
3048         $running = 0;
3049         do {
3050             curl_multi_exec($main, $running);
3051         } while($running > 0);
3052         for ($i = 0; $i < $count; $i++) {
3053             if (!empty($options['CURLOPT_RETURNTRANSFER'])) {
3054                 $results[] = true;
3055             } else {
3056                 $results[] = curl_multi_getcontent($handles[$i]);
3057             }
3058             curl_multi_remove_handle($main, $handles[$i]);
3059         }
3060         curl_multi_close($main);
3061         return $results;
3062     }
3064     /**
3065      * Single HTTP Request
3066      *
3067      * @param string $url The URL to request
3068      * @param array $options
3069      * @return bool
3070      */
3071     protected function request($url, $options = array()){
3072         // create curl instance
3073         $curl = curl_init($url);
3074         $options['url'] = $url;
3075         $this->apply_opt($curl, $options);
3076         if ($this->cache && $ret = $this->cache->get($this->options)) {
3077             return $ret;
3078         } else {
3079             $ret = curl_exec($curl);
3080             if ($this->cache) {
3081                 $this->cache->set($this->options, $ret);
3082             }
3083         }
3085         $this->info  = curl_getinfo($curl);
3086         $this->error = curl_error($curl);
3088         if ($this->debug){
3089             echo '<h1>Return Data</h1>';
3090             var_dump($ret);
3091             echo '<h1>Info</h1>';
3092             var_dump($this->info);
3093             echo '<h1>Error</h1>';
3094             var_dump($this->error);
3095         }
3097         curl_close($curl);
3099         if (empty($this->error)){
3100             return $ret;
3101         } else {
3102             return $this->error;
3103             // exception is not ajax friendly
3104             //throw new moodle_exception($this->error, 'curl');
3105         }
3106     }
3108     /**
3109      * HTTP HEAD method
3110      *
3111      * @see request()
3112      *
3113      * @param string $url
3114      * @param array $options
3115      * @return bool
3116      */
3117     public function head($url, $options = array()){
3118         $options['CURLOPT_HTTPGET'] = 0;
3119         $options['CURLOPT_HEADER']  = 1;
3120         $options['CURLOPT_NOBODY']  = 1;
3121         return $this->request($url, $options);
3122     }
3124     /**
3125      * HTTP POST method
3126      *
3127      * @param string $url
3128      * @param array|string $params
3129      * @param array $options
3130      * @return bool
3131      */
3132     public function post($url, $params = '', $options = array()){
3133         $options['CURLOPT_POST']       = 1;
3134         if (is_array($params)) {
3135             $this->_tmp_file_post_params = array();
3136             foreach ($params as $key => $value) {
3137                 if ($value instanceof stored_file) {
3138                     $value->add_to_curl_request($this, $key);
3139                 } else {
3140                     $this->_tmp_file_post_params[$key] = $value;
3141                 }
3142             }
3143             $options['CURLOPT_POSTFIELDS'] = $this->_tmp_file_post_params;
3144             unset($this->_tmp_file_post_params);
3145         } else {
3146             // $params is the raw post data
3147             $options['CURLOPT_POSTFIELDS'] = $params;
3148         }
3149         return $this->request($url, $options);
3150     }
3152     /**
3153      * HTTP GET method
3154      *
3155      * @param string $url
3156      * @param array $params
3157      * @param array $options
3158      * @return bool
3159      */
3160     public function get($url, $params = array(), $options = array()){
3161         $options['CURLOPT_HTTPGET'] = 1;
3163         if (!empty($params)){
3164             $url .= (stripos($url, '?') !== false) ? '&' : '?';
3165             $url .= http_build_query($params, '', '&');
3166         }
3167         return $this->request($url, $options);
3168     }
3170     /**
3171      * HTTP PUT method
3172      *
3173      * @param string $url
3174      * @param array $params
3175      * @param array $options
3176      * @return bool
3177      */
3178     public function put($url, $params = array(), $options = array()){
3179         $file = $params['file'];
3180         if (!is_file($file)){
3181             return null;
3182         }
3183         $fp   = fopen($file, 'r');
3184         $size = filesize($file);
3185         $options['CURLOPT_PUT']        = 1;
3186         $options['CURLOPT_INFILESIZE'] = $size;
3187         $options['CURLOPT_INFILE']     = $fp;
3188         if (!isset($this->options['CURLOPT_USERPWD'])){
3189             $this->setopt(array('CURLOPT_USERPWD'=>'anonymous: noreply@moodle.org'));
3190         }
3191         $ret = $this->request($url, $options);
3192         fclose($fp);
3193         return $ret;
3194     }
3196     /**
3197      * HTTP DELETE method
3198      *
3199      * @param string $url
3200      * @param array $param
3201      * @param array $options
3202      * @return bool
3203      */
3204     public function delete($url, $param = array(), $options = array()){
3205         $options['CURLOPT_CUSTOMREQUEST'] = 'DELETE';
3206         if (!isset($options['CURLOPT_USERPWD'])) {
3207             $options['CURLOPT_USERPWD'] = 'anonymous: noreply@moodle.org';
3208         }
3209         $ret = $this->request($url, $options);
3210         return $ret;
3211     }
3213     /**
3214      * HTTP TRACE method
3215      *
3216      * @param string $url
3217      * @param array $options
3218      * @return bool
3219      */
3220     public function trace($url, $options = array()){
3221         $options['CURLOPT_CUSTOMREQUEST'] = 'TRACE';
3222         $ret = $this->request($url, $options);
3223         return $ret;
3224     }
3226     /**
3227      * HTTP OPTIONS method
3228      *
3229      * @param string $url
3230      * @param array $options
3231      * @return bool
3232      */
3233     public function options($url, $options = array()){
3234         $options['CURLOPT_CUSTOMREQUEST'] = 'OPTIONS';
3235         $ret = $this->request($url, $options);
3236         return $ret;
3237     }
3239     /**
3240      * Get curl information
3241      *
3242      * @return string
3243      */
3244     public function get_info() {
3245         return $this->info;
3246     }
3249 /**
3250  * This class is used by cURL class, use case:
3251  *
3252  * <code>
3253  * $CFG->repositorycacheexpire = 120;
3254  * $CFG->curlcache = 120;
3255  *
3256  * $c = new curl(array('cache'=>true), 'module_cache'=>'repository');
3257  * $ret = $c->get('http://www.google.com');
3258  * </code>
3259  *
3260  * @package   core_files
3261  * @copyright Dongsheng Cai <dongsheng@moodle.com>
3262  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3263  */
3264 class curl_cache {
3265     /** @var string Path to cache directory */
3266     public $dir = '';
3268     /**
3269      * Constructor
3270      *
3271      * @global stdClass $CFG
3272      * @param string $module which module is using curl_cache
3273      */
3274     public function __construct($module = 'repository') {
3275         global $CFG;
3276         if (!empty($module)) {
3277             $this->dir = $CFG->cachedir.'/'.$module.'/';
3278         } else {
3279             $this->dir = $CFG->cachedir.'/misc/';
3280         }
3281         if (!file_exists($this->dir)) {
3282             mkdir($this->dir, $CFG->directorypermissions, true);
3283         }
3284         if ($module == 'repository') {
3285             if (empty($CFG->repositorycacheexpire)) {
3286                 $CFG->repositorycacheexpire = 120;
3287             }
3288             $this->ttl = $CFG->repositorycacheexpire;
3289         } else {
3290             if (empty($CFG->curlcache)) {
3291                 $CFG->curlcache = 120;
3292             }
3293             $this->ttl = $CFG->curlcache;
3294         }
3295     }
3297     /**
3298      * Get cached value
3299      *
3300      * @global stdClass $CFG
3301      * @global stdClass $USER
3302      * @param mixed $param
3303      * @return bool|string
3304      */
3305     public function get($param) {
3306         global $CFG, $USER;
3307         $this->cleanup($this->ttl);
3308         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3309         if(file_exists($this->dir.$filename)) {
3310             $lasttime = filemtime($this->dir.$filename);
3311             if (time()-$lasttime > $this->ttl) {
3312                 return false;
3313             } else {
3314                 $fp = fopen($this->dir.$filename, 'r');
3315                 $size = filesize($this->dir.$filename);
3316                 $content = fread($fp, $size);
3317                 return unserialize($content);
3318             }
3319         }
3320         return false;
3321     }
3323     /**
3324      * Set cache value
3325      *
3326      * @global object $CFG
3327      * @global object $USER
3328      * @param mixed $param
3329      * @param mixed $val
3330      */
3331     public function set($param, $val) {
3332         global $CFG, $USER;
3333         $filename = 'u'.$USER->id.'_'.md5(serialize($param));
3334         $fp = fopen($this->dir.$filename, 'w');
3335         fwrite($fp, serialize($val));
3336         fclose($fp);
3337     }
3339     /**
3340      * Remove cache files
3341      *
3342      * @param int $expire The number of seconds before expiry
3343      */
3344     public function cleanup($expire) {
3345         if ($dir = opendir($this->dir)) {
3346             while (false !== ($file = readdir($dir))) {
3347                 if(!is_dir($file) && $file != '.' && $file != '..') {
3348                     $lasttime = @filemtime($this->dir.$file);
3349                     if (time() - $lasttime > $expire) {
3350                         @unlink($this->dir.$file);
3351                     }
3352                 }
3353             }
3354             closedir($dir);
3355         }
3356     }
3357     /**
3358      * delete current user's cache file
3359      *
3360      * @global object $CFG
3361      * @global object $USER
3362      */
3363     public function refresh() {
3364         global $CFG, $USER;
3365         if ($dir = opendir($this->dir)) {
3366             while (false !== ($file = readdir($dir))) {
3367                 if (!is_dir($file) && $file != '.' && $file != '..') {
3368                     if (strpos($file, 'u'.$USER->id.'_') !== false) {
3369                         @unlink($this->dir.$file);
3370                     }
3371                 }
3372             }
3373         }
3374     }
3377 /**
3378  * This function delegates file serving to individual plugins
3379  *
3380  * @param string $relativepath
3381  * @param bool $forcedownload
3382  * @param null|string $preview the preview mode, defaults to serving the original file
3383  * @todo MDL-31088 file serving improments
3384  */
3385 function file_pluginfile($relativepath, $forcedownload, $preview = null) {
3386     global $DB, $CFG, $USER;
3387     // relative path must start with '/'
3388     if (!$relativepath) {
3389         print_error('invalidargorconf');
3390     } else if ($relativepath[0] != '/') {
3391         print_error('pathdoesnotstartslash');
3392     }
3394     // extract relative path components
3395     $args = explode('/', ltrim($relativepath, '/'));
3397     if (count($args) < 3) { // always at least context, component and filearea
3398         print_error('invalidarguments');
3399     }
3401     $contextid = (int)array_shift($args);
3402     $component = clean_param(array_shift($args), PARAM_COMPONENT);
3403     $filearea  = clean_param(array_shift($args), PARAM_AREA);
3405     list($context, $course, $cm) = get_context_info_array($contextid);
3407     $fs = get_file_storage();
3409     // ========================================================================================================================
3410     if ($component === 'blog') {
3411         // Blog file serving
3412         if ($context->contextlevel != CONTEXT_SYSTEM) {
3413             send_file_not_found();
3414         }
3415         if ($filearea !== 'attachment' and $filearea !== 'post') {
3416             send_file_not_found();
3417         }
3419         if (empty($CFG->bloglevel)) {
3420             print_error('siteblogdisable', 'blog');
3421         }
3423         $entryid = (int)array_shift($args);
3424         if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
3425             send_file_not_found();
3426         }
3427         if ($CFG->bloglevel < BLOG_GLOBAL_LEVEL) {
3428             require_login();
3429             if (isguestuser()) {
3430                 print_error('noguest');
3431             }
3432             if ($CFG->bloglevel == BLOG_USER_LEVEL) {
3433                 if ($USER->id != $entry->userid) {
3434                     send_file_not_found();
3435                 }
3436             }
3437         }
3439         if ('publishstate' === 'public') {
3440             if ($CFG->forcelogin) {
3441                 require_login();
3442             }
3444         } else if ('publishstate' === 'site') {
3445             require_login();
3446             //ok
3447         } else if ('publishstate' === 'draft') {
3448             require_login();
3449             if ($USER->id != $entry->userid) {
3450                 send_file_not_found();
3451             }
3452         }
3454         $filename = array_pop($args);
3455         $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3457         if (!$file = $fs->get_file($context->id, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
3458             send_file_not_found();
3459         }
3461         send_stored_file($file, 10*60, 0, true, array('preview' => $preview)); // download MUST be forced - security!
3463     // ========================================================================================================================
3464     } else if ($component === 'grade') {
3465         if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel == CONTEXT_SYSTEM) {
3466             // Global gradebook files
3467             if ($CFG->forcelogin) {
3468                 require_login();
3469             }
3471             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3473             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3474                 send_file_not_found();
3475             }
3477             session_get_instance()->write_close(); // unlock session during fileserving
3478             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3480         } else if ($filearea === 'feedback' and $context->contextlevel == CONTEXT_COURSE) {
3481             //TODO: nobody implemented this yet in grade edit form!!
3482             send_file_not_found();
3484             if ($CFG->forcelogin || $course->id != SITEID) {
3485                 require_login($course);
3486             }
3488             $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
3490             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3491                 send_file_not_found();
3492             }
3494             session_get_instance()->write_close(); // unlock session during fileserving
3495             send_stored_file($file, 60*60, 0, $forcedownload, array('preview' => $preview));
3496         } else {
3497             send_file_not_found();
3498         }
3500     // ========================================================================================================================
3501     } else if ($component === 'tag') {
3502         if ($filearea === 'description' and $context->contextlevel == CONTEXT_SYSTEM) {
3504             // All tag descriptions are going to be public but we still need to respect forcelogin
3505             if ($CFG->forcelogin) {
3506                 require_login();
3507             }
3509             $fullpath = "/$context->id/tag/description/".implode('/', $args);
3511             if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3512                 send_file_not_found();
3513             }
3515             session_get_instance()->write_close(); // unlock session during fileserving
3516             send_stored_file($file, 60*60, 0, true, array('preview' => $preview));
3518         } else {
3519             send_file_not_found();
3520         }
3522     // ========================================================================================================================
3523     } else if ($component === 'calendar') {
3524         if ($filearea === 'event_description'  and $context->contextlevel == CONTEXT_SYSTEM) {
3526             // All events here are public the one requirement is that we respect forcelogin
3527             if ($CFG->forcelogin) {
3528                 require_login();
3529             }
3531             // Get the event if from the args array
3532             $eventid = array_shift($args);
3534             // Load the event from the database
3535             if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'eventtype'=>'site'))) {
3536                 send_file_not_found();
3537             }
3538             // Check that we got an event and that it's userid is that of the user
3540             // Get the file and serve if successful
3541             $filename = array_pop($args);
3542             $filepath = $args ? '/'.implode('/', $args).'/' : '/';
3543             if (!$file = $fs->get_file($context->id, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
3544                 send_file_not_found();