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