Merge branch 'MDL-64201-master' of https://github.com/lucaboesch/moodle
[moodle.git] / mod / resource / locallib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Private resource module utility functions
20  *
21  * @package    mod_resource
22  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die;
28 require_once("$CFG->libdir/filelib.php");
29 require_once("$CFG->libdir/resourcelib.php");
30 require_once("$CFG->dirroot/mod/resource/lib.php");
32 /**
33  * Redirected to migrated resource if needed,
34  * return if incorrect parameters specified
35  * @param int $oldid
36  * @param int $cmid
37  * @return void
38  */
39 function resource_redirect_if_migrated($oldid, $cmid) {
40     global $DB, $CFG;
42     if ($oldid) {
43         $old = $DB->get_record('resource_old', array('oldid'=>$oldid));
44     } else {
45         $old = $DB->get_record('resource_old', array('cmid'=>$cmid));
46     }
48     if (!$old) {
49         return;
50     }
52     redirect("$CFG->wwwroot/mod/$old->newmodule/view.php?id=".$old->cmid);
53 }
55 /**
56  * Display embedded resource file.
57  * @param object $resource
58  * @param object $cm
59  * @param object $course
60  * @param stored_file $file main file
61  * @return does not return
62  */
63 function resource_display_embed($resource, $cm, $course, $file) {
64     global $CFG, $PAGE, $OUTPUT;
66     $clicktoopen = resource_get_clicktoopen($file, $resource->revision);
68     $context = context_module::instance($cm->id);
69     $moodleurl = moodle_url::make_pluginfile_url($context->id, 'mod_resource', 'content', $resource->revision,
70             $file->get_filepath(), $file->get_filename());
72     $mimetype = $file->get_mimetype();
73     $title    = $resource->name;
75     $extension = resourcelib_get_extension($file->get_filename());
77     $mediamanager = core_media_manager::instance($PAGE);
78     $embedoptions = array(
79         core_media_manager::OPTION_TRUSTED => true,
80         core_media_manager::OPTION_BLOCK => true,
81     );
83     if (file_mimetype_in_typegroup($mimetype, 'web_image')) {  // It's an image
84         $code = resourcelib_embed_image($moodleurl->out(), $title);
86     } else if ($mimetype === 'application/pdf') {
87         // PDF document
88         $code = resourcelib_embed_pdf($moodleurl->out(), $title, $clicktoopen);
90     } else if ($mediamanager->can_embed_url($moodleurl, $embedoptions)) {
91         // Media (audio/video) file.
92         $code = $mediamanager->embed_url($moodleurl, $title, 0, 0, $embedoptions);
94     } else {
95         // We need a way to discover if we are loading remote docs inside an iframe.
96         $moodleurl->param('embed', 1);
98         // anything else - just try object tag enlarged as much as possible
99         $code = resourcelib_embed_general($moodleurl, $title, $clicktoopen, $mimetype);
100     }
102     resource_print_header($resource, $cm, $course);
103     resource_print_heading($resource, $cm, $course);
105     echo $code;
107     resource_print_intro($resource, $cm, $course);
109     echo $OUTPUT->footer();
110     die;
113 /**
114  * Display resource frames.
115  * @param object $resource
116  * @param object $cm
117  * @param object $course
118  * @param stored_file $file main file
119  * @return does not return
120  */
121 function resource_display_frame($resource, $cm, $course, $file) {
122     global $PAGE, $OUTPUT, $CFG;
124     $frame = optional_param('frameset', 'main', PARAM_ALPHA);
126     if ($frame === 'top') {
127         $PAGE->set_pagelayout('frametop');
128         resource_print_header($resource, $cm, $course);
129         resource_print_heading($resource, $cm, $course);
130         resource_print_intro($resource, $cm, $course);
131         echo $OUTPUT->footer();
132         die;
134     } else {
135         $config = get_config('resource');
136         $context = context_module::instance($cm->id);
137         $path = '/'.$context->id.'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
138         $fileurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
139         $navurl = "$CFG->wwwroot/mod/resource/view.php?id=$cm->id&amp;frameset=top";
140         $title = strip_tags(format_string($course->shortname.': '.$resource->name));
141         $framesize = $config->framesize;
142         $contentframetitle = s(format_string($resource->name));
143         $modulename = s(get_string('modulename','resource'));
144         $dir = get_string('thisdirection', 'langconfig');
146         $file = <<<EOF
147 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
148 <html dir="$dir">
149   <head>
150     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
151     <title>$title</title>
152   </head>
153   <frameset rows="$framesize,*">
154     <frame src="$navurl" title="$modulename" />
155     <frame src="$fileurl" title="$contentframetitle" />
156   </frameset>
157 </html>
158 EOF;
160         @header('Content-Type: text/html; charset=utf-8');
161         echo $file;
162         die;
163     }
166 /**
167  * Internal function - create click to open text with link.
168  */
169 function resource_get_clicktoopen($file, $revision, $extra='') {
170     global $CFG;
172     $filename = $file->get_filename();
173     $path = '/'.$file->get_contextid().'/mod_resource/content/'.$revision.$file->get_filepath().$file->get_filename();
174     $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
176     $string = get_string('clicktoopen2', 'resource', "<a href=\"$fullurl\" $extra>$filename</a>");
178     return $string;
181 /**
182  * Internal function - create click to open text with link.
183  */
184 function resource_get_clicktodownload($file, $revision) {
185     global $CFG;
187     $filename = $file->get_filename();
188     $path = '/'.$file->get_contextid().'/mod_resource/content/'.$revision.$file->get_filepath().$file->get_filename();
189     $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, true);
191     $string = get_string('clicktodownload', 'resource', "<a href=\"$fullurl\">$filename</a>");
193     return $string;
196 /**
197  * Print resource info and workaround link when JS not available.
198  * @param object $resource
199  * @param object $cm
200  * @param object $course
201  * @param stored_file $file main file
202  * @return does not return
203  */
204 function resource_print_workaround($resource, $cm, $course, $file) {
205     global $CFG, $OUTPUT;
207     resource_print_header($resource, $cm, $course);
208     resource_print_heading($resource, $cm, $course, true);
209     resource_print_intro($resource, $cm, $course, true);
211     $resource->mainfile = $file->get_filename();
212     echo '<div class="resourceworkaround">';
213     switch (resource_get_final_display_type($resource)) {
214         case RESOURCELIB_DISPLAY_POPUP:
215             $path = '/'.$file->get_contextid().'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
216             $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
217             $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
218             $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
219             $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
220             $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
221             $extra = "onclick=\"window.open('$fullurl', '', '$wh'); return false;\"";
222             echo resource_get_clicktoopen($file, $resource->revision, $extra);
223             break;
225         case RESOURCELIB_DISPLAY_NEW:
226             $extra = 'onclick="this.target=\'_blank\'"';
227             echo resource_get_clicktoopen($file, $resource->revision, $extra);
228             break;
230         case RESOURCELIB_DISPLAY_DOWNLOAD:
231             echo resource_get_clicktodownload($file, $resource->revision);
232             break;
234         case RESOURCELIB_DISPLAY_OPEN:
235         default:
236             echo resource_get_clicktoopen($file, $resource->revision);
237             break;
238     }
239     echo '</div>';
241     echo $OUTPUT->footer();
242     die;
245 /**
246  * Print resource header.
247  * @param object $resource
248  * @param object $cm
249  * @param object $course
250  * @return void
251  */
252 function resource_print_header($resource, $cm, $course) {
253     global $PAGE, $OUTPUT;
255     $PAGE->set_title($course->shortname.': '.$resource->name);
256     $PAGE->set_heading($course->fullname);
257     $PAGE->set_activity_record($resource);
258     echo $OUTPUT->header();
261 /**
262  * Print resource heading.
263  * @param object $resource
264  * @param object $cm
265  * @param object $course
266  * @param bool $notused This variable is no longer used
267  * @return void
268  */
269 function resource_print_heading($resource, $cm, $course, $notused = false) {
270     global $OUTPUT;
271     echo $OUTPUT->heading(format_string($resource->name), 2);
275 /**
276  * Gets details of the file to cache in course cache to be displayed using {@link resource_get_optional_details()}
277  *
278  * @param object $resource Resource table row (only property 'displayoptions' is used here)
279  * @param object $cm Course-module table row
280  * @return string Size and type or empty string if show options are not enabled
281  */
282 function resource_get_file_details($resource, $cm) {
283     $options = empty($resource->displayoptions) ? array() : @unserialize($resource->displayoptions);
284     $filedetails = array();
285     if (!empty($options['showsize']) || !empty($options['showtype']) || !empty($options['showdate'])) {
286         $context = context_module::instance($cm->id);
287         $fs = get_file_storage();
288         $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false);
289         // For a typical file resource, the sortorder is 1 for the main file
290         // and 0 for all other files. This sort approach is used just in case
291         // there are situations where the file has a different sort order.
292         $mainfile = $files ? reset($files) : null;
293         if (!empty($options['showsize'])) {
294             $filedetails['size'] = 0;
295             foreach ($files as $file) {
296                 // This will also synchronize the file size for external files if needed.
297                 $filedetails['size'] += $file->get_filesize();
298                 if ($file->get_repository_id()) {
299                     // If file is a reference the 'size' attribute can not be cached.
300                     $filedetails['isref'] = true;
301                 }
302             }
303         }
304         if (!empty($options['showtype'])) {
305             if ($mainfile) {
306                 $filedetails['type'] = get_mimetype_description($mainfile);
307                 // Only show type if it is not unknown.
308                 if ($filedetails['type'] === get_mimetype_description('document/unknown')) {
309                     $filedetails['type'] = '';
310                 }
311             } else {
312                 $filedetails['type'] = '';
313             }
314         }
315         if (!empty($options['showdate'])) {
316             if ($mainfile) {
317                 // Modified date may be up to several minutes later than uploaded date just because
318                 // teacher did not submit the form promptly. Give teacher up to 5 minutes to do it.
319                 if ($mainfile->get_timemodified() > $mainfile->get_timecreated() + 5 * MINSECS) {
320                     $filedetails['modifieddate'] = $mainfile->get_timemodified();
321                 } else {
322                     $filedetails['uploadeddate'] = $mainfile->get_timecreated();
323                 }
324                 if ($mainfile->get_repository_id()) {
325                     // If main file is a reference the 'date' attribute can not be cached.
326                     $filedetails['isref'] = true;
327                 }
328             } else {
329                 $filedetails['uploadeddate'] = '';
330             }
331         }
332     }
333     return $filedetails;
336 /**
337  * Gets optional details for a resource, depending on resource settings.
338  *
339  * Result may include the file size and type if those settings are chosen,
340  * or blank if none.
341  *
342  * @param object $resource Resource table row (only property 'displayoptions' is used here)
343  * @param object $cm Course-module table row
344  * @return string Size and type or empty string if show options are not enabled
345  */
346 function resource_get_optional_details($resource, $cm) {
347     global $DB;
349     $details = '';
351     $options = empty($resource->displayoptions) ? array() : @unserialize($resource->displayoptions);
352     if (!empty($options['showsize']) || !empty($options['showtype']) || !empty($options['showdate'])) {
353         if (!array_key_exists('filedetails', $options)) {
354             $filedetails = resource_get_file_details($resource, $cm);
355         } else {
356             $filedetails = $options['filedetails'];
357         }
358         $size = '';
359         $type = '';
360         $date = '';
361         $langstring = '';
362         $infodisplayed = 0;
363         if (!empty($options['showsize'])) {
364             if (!empty($filedetails['size'])) {
365                 $size = display_size($filedetails['size']);
366                 $langstring .= 'size';
367                 $infodisplayed += 1;
368             }
369         }
370         if (!empty($options['showtype'])) {
371             if (!empty($filedetails['type'])) {
372                 $type = $filedetails['type'];
373                 $langstring .= 'type';
374                 $infodisplayed += 1;
375             }
376         }
377         if (!empty($options['showdate']) && (!empty($filedetails['modifieddate']) || !empty($filedetails['uploadeddate']))) {
378             if (!empty($filedetails['modifieddate'])) {
379                 $date = get_string('modifieddate', 'mod_resource', userdate($filedetails['modifieddate'],
380                     get_string('strftimedatetimeshort', 'langconfig')));
381             } else if (!empty($filedetails['uploadeddate'])) {
382                 $date = get_string('uploadeddate', 'mod_resource', userdate($filedetails['uploadeddate'],
383                     get_string('strftimedatetimeshort', 'langconfig')));
384             }
385             $langstring .= 'date';
386             $infodisplayed += 1;
387         }
389         if ($infodisplayed > 1) {
390             $details = get_string("resourcedetails_{$langstring}", 'resource',
391                     (object)array('size' => $size, 'type' => $type, 'date' => $date));
392         } else {
393             // Only one of size, type and date is set, so just append.
394             $details = $size . $type . $date;
395         }
396     }
398     return $details;
401 /**
402  * Print resource introduction.
403  * @param object $resource
404  * @param object $cm
405  * @param object $course
406  * @param bool $ignoresettings print even if not specified in modedit
407  * @return void
408  */
409 function resource_print_intro($resource, $cm, $course, $ignoresettings=false) {
410     global $OUTPUT;
412     $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
414     $extraintro = resource_get_optional_details($resource, $cm);
415     if ($extraintro) {
416         // Put a paragaph tag around the details
417         $extraintro = html_writer::tag('p', $extraintro, array('class' => 'resourcedetails'));
418     }
420     if ($ignoresettings || !empty($options['printintro']) || $extraintro) {
421         $gotintro = trim(strip_tags($resource->intro));
422         if ($gotintro || $extraintro) {
423             echo $OUTPUT->box_start('mod_introbox', 'resourceintro');
424             if ($gotintro) {
425                 echo format_module_intro('resource', $resource, $cm->id);
426             }
427             echo $extraintro;
428             echo $OUTPUT->box_end();
429         }
430     }
433 /**
434  * Print warning that instance not migrated yet.
435  * @param object $resource
436  * @param object $cm
437  * @param object $course
438  * @return void, does not return
439  */
440 function resource_print_tobemigrated($resource, $cm, $course) {
441     global $DB, $OUTPUT;
443     $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
444     resource_print_header($resource, $cm, $course);
445     resource_print_heading($resource, $cm, $course);
446     resource_print_intro($resource, $cm, $course);
447     echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
448     echo $OUTPUT->footer();
449     die;
452 /**
453  * Print warning that file can not be found.
454  * @param object $resource
455  * @param object $cm
456  * @param object $course
457  * @return void, does not return
458  */
459 function resource_print_filenotfound($resource, $cm, $course) {
460     global $DB, $OUTPUT;
462     $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
463     resource_print_header($resource, $cm, $course);
464     resource_print_heading($resource, $cm, $course);
465     resource_print_intro($resource, $cm, $course);
466     if ($resource_old) {
467         echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
468     } else {
469         echo $OUTPUT->notification(get_string('filenotfound', 'resource'));
470     }
471     echo $OUTPUT->footer();
472     die;
475 /**
476  * Decide the best display format.
477  * @param object $resource
478  * @return int display type constant
479  */
480 function resource_get_final_display_type($resource) {
481     global $CFG, $PAGE;
483     if ($resource->display != RESOURCELIB_DISPLAY_AUTO) {
484         return $resource->display;
485     }
487     if (empty($resource->mainfile)) {
488         return RESOURCELIB_DISPLAY_DOWNLOAD;
489     } else {
490         $mimetype = mimeinfo('type', $resource->mainfile);
491     }
493     if (file_mimetype_in_typegroup($mimetype, 'archive')) {
494         return RESOURCELIB_DISPLAY_DOWNLOAD;
495     }
496     if (file_mimetype_in_typegroup($mimetype, array('web_image', '.htm', 'web_video', 'web_audio'))) {
497         return RESOURCELIB_DISPLAY_EMBED;
498     }
500     // let the browser deal with it somehow
501     return RESOURCELIB_DISPLAY_OPEN;
504 /**
505  * File browsing support class
506  */
507 class resource_content_file_info extends file_info_stored {
508     public function get_parent() {
509         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
510             return $this->browser->get_file_info($this->context);
511         }
512         return parent::get_parent();
513     }
514     public function get_visible_name() {
515         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
516             return $this->topvisiblename;
517         }
518         return parent::get_visible_name();
519     }
522 function resource_set_mainfile($data) {
523     global $DB;
524     $fs = get_file_storage();
525     $cmid = $data->coursemodule;
526     $draftitemid = $data->files;
528     $context = context_module::instance($cmid);
529     if ($draftitemid) {
530         $options = array('subdirs' => true, 'embed' => false);
531         if ($data->display == RESOURCELIB_DISPLAY_EMBED) {
532             $options['embed'] = true;
533         }
534         file_save_draft_area_files($draftitemid, $context->id, 'mod_resource', 'content', 0, $options);
535     }
536     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder', false);
537     if (count($files) == 1) {
538         // only one file attached, set it as main file automatically
539         $file = reset($files);
540         file_set_sortorder($context->id, 'mod_resource', 'content', 0, $file->get_filepath(), $file->get_filename(), 1);
541     }