MDL-29624 Media embedding system, part 3: resource module (and URL, lesson)
[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
22  * @subpackage resource
23  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once("$CFG->libdir/filelib.php");
30 require_once("$CFG->libdir/resourcelib.php");
31 require_once("$CFG->dirroot/mod/resource/lib.php");
33 /**
34  * Redirected to migrated resource if needed,
35  * return if incorrect parameters specified
36  * @param int $oldid
37  * @param int $cmid
38  * @return void
39  */
40 function resource_redirect_if_migrated($oldid, $cmid) {
41     global $DB, $CFG;
43     if ($oldid) {
44         $old = $DB->get_record('resource_old', array('oldid'=>$oldid));
45     } else {
46         $old = $DB->get_record('resource_old', array('cmid'=>$cmid));
47     }
49     if (!$old) {
50         return;
51     }
53     redirect("$CFG->wwwroot/mod/$old->newmodule/view.php?id=".$old->cmid);
54 }
56 /**
57  * Display embedded resource file.
58  * @param object $resource
59  * @param object $cm
60  * @param object $course
61  * @param stored_file $file main file
62  * @return does not return
63  */
64 function resource_display_embed($resource, $cm, $course, $file) {
65     global $CFG, $PAGE, $OUTPUT;
67     $clicktoopen = resource_get_clicktoopen($file, $resource->revision);
69     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
70     $path = '/'.$context->id.'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
71     $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
72     $moodleurl = new moodle_url('/pluginfile.php' . $path);
74     $mimetype = $file->get_mimetype();
75     $title    = $resource->name;
77     $extension = resourcelib_get_extension($file->get_filename());
79     $mediarenderer = $PAGE->get_renderer('core', 'media');
80     $embedoptions = array(
81         core_media::OPTION_TRUSTED => true,
82         core_media::OPTION_BLOCK => true,
83     );
85     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
86         $code = resourcelib_embed_image($fullurl, $title);
88     } else if ($mimetype === 'application/pdf') {
89         // PDF document
90         $code = resourcelib_embed_pdf($fullurl, $title, $clicktoopen);
92     } else if ($mediarenderer->can_embed_url($moodleurl, $embedoptions)) {
93         // Media (audio/video) file.
94         $code = $mediarenderer->embed_url($moodleurl, $title, 0, 0, $embedoptions);
96     } else {
97         // anything else - just try object tag enlarged as much as possible
98         $code = resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype);
99     }
101     resource_print_header($resource, $cm, $course);
102     resource_print_heading($resource, $cm, $course);
104     echo $code;
106     resource_print_intro($resource, $cm, $course);
108     echo $OUTPUT->footer();
109     die;
112 /**
113  * Display resource frames.
114  * @param object $resource
115  * @param object $cm
116  * @param object $course
117  * @param stored_file $file main file
118  * @return does not return
119  */
120 function resource_display_frame($resource, $cm, $course, $file) {
121     global $PAGE, $OUTPUT, $CFG;
123     $frame = optional_param('frameset', 'main', PARAM_ALPHA);
125     if ($frame === 'top') {
126         $PAGE->set_pagelayout('frametop');
127         resource_print_header($resource, $cm, $course);
128         resource_print_heading($resource, $cm, $course);
129         resource_print_intro($resource, $cm, $course);
130         echo $OUTPUT->footer();
131         die;
133     } else {
134         $config = get_config('resource');
135         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
136         $path = '/'.$context->id.'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
137         $fileurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
138         $navurl = "$CFG->wwwroot/mod/resource/view.php?id=$cm->id&amp;frameset=top";
139         $title = strip_tags(format_string($course->shortname.': '.$resource->name));
140         $framesize = $config->framesize;
141         $contentframetitle = format_string($resource->name);
142         $modulename = s(get_string('modulename','resource'));
143         $dir = get_string('thisdirection', 'langconfig');
145         $file = <<<EOF
146 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
147 <html dir="$dir">
148   <head>
149     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
150     <title>$title</title>
151   </head>
152   <frameset rows="$framesize,*">
153     <frame src="$navurl" title="$modulename" />
154     <frame src="$fileurl" title="$contentframetitle" />
155   </frameset>
156 </html>
157 EOF;
159         @header('Content-Type: text/html; charset=utf-8');
160         echo $file;
161         die;
162     }
165 /**
166  * Internal function - create click to open text with link.
167  */
168 function resource_get_clicktoopen($file, $revision, $extra='') {
169     global $CFG;
171     $filename = $file->get_filename();
172     $path = '/'.$file->get_contextid().'/mod_resource/content/'.$revision.$file->get_filepath().$file->get_filename();
173     $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
175     $string = get_string('clicktoopen2', 'resource', "<a href=\"$fullurl\" $extra>$filename</a>");
177     return $string;
180 /**
181  * Internal function - create click to open text with link.
182  */
183 function resource_get_clicktodownload($file, $revision) {
184     global $CFG;
186     $filename = $file->get_filename();
187     $path = '/'.$file->get_contextid().'/mod_resource/content/'.$revision.$file->get_filepath().$file->get_filename();
188     $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, true);
190     $string = get_string('clicktodownload', 'resource', "<a href=\"$fullurl\">$filename</a>");
192     return $string;
195 /**
196  * Print resource info and workaround link when JS not available.
197  * @param object $resource
198  * @param object $cm
199  * @param object $course
200  * @param stored_file $file main file
201  * @return does not return
202  */
203 function resource_print_workaround($resource, $cm, $course, $file) {
204     global $CFG, $OUTPUT;
206     resource_print_header($resource, $cm, $course);
207     resource_print_heading($resource, $cm, $course, true);
208     resource_print_intro($resource, $cm, $course, true);
210     $resource->mainfile = $file->get_filename();
211     echo '<div class="resourceworkaround">';
212     switch (resource_get_final_display_type($resource)) {
213         case RESOURCELIB_DISPLAY_POPUP:
214             $path = '/'.$file->get_contextid().'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
215             $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
216             $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
217             $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
218             $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
219             $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
220             $extra = "onclick=\"window.open('$fullurl', '', '$wh'); return false;\"";
221             echo resource_get_clicktoopen($file, $resource->revision, $extra);
222             break;
224         case RESOURCELIB_DISPLAY_NEW:
225             $extra = 'onclick="this.target=\'_blank\'"';
226             echo resource_get_clicktoopen($file, $resource->revision, $extra);
227             break;
229         case RESOURCELIB_DISPLAY_DOWNLOAD:
230             echo resource_get_clicktodownload($file, $resource->revision);
231             break;
233         case RESOURCELIB_DISPLAY_OPEN:
234         default:
235             echo resource_get_clicktoopen($file, $resource->revision);
236             break;
237     }
238     echo '</div>';
240     echo $OUTPUT->footer();
241     die;
244 /**
245  * Print resource header.
246  * @param object $resource
247  * @param object $cm
248  * @param object $course
249  * @return void
250  */
251 function resource_print_header($resource, $cm, $course) {
252     global $PAGE, $OUTPUT;
254     $PAGE->set_title($course->shortname.': '.$resource->name);
255     $PAGE->set_heading($course->fullname);
256     $PAGE->set_activity_record($resource);
257     $PAGE->set_button(update_module_button($cm->id, '', get_string('modulename', '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 $ignoresettings print even if not specified in modedit
267  * @return void
268  */
269 function resource_print_heading($resource, $cm, $course, $ignoresettings=false) {
270     global $OUTPUT;
272     $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
273     if ($ignoresettings or !empty($options['printheading'])) {
274         echo $OUTPUT->heading(format_string($resource->name), 2, 'main', 'resourceheading');
275     }
278 /**
279  * Gets optional details for a resource, depending on resource settings.
280  *
281  * Result may include the file size and type if those settings are chosen,
282  * or blank if none.
283  *
284  * @param object $resource Resource table row
285  * @param object $cm Course-module table row
286  * @return string Size and type or empty string if show options are not enabled
287  */
288 function resource_get_optional_details($resource, $cm) {
289     global $DB;
291     $details = '';
293     $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
294     if (!empty($options['showsize']) || !empty($options['showtype'])) {
295         $context = context_module::instance($cm->id);
296         $size = '';
297         $type = '';
298         if (!empty($options['showsize'])) {
299             $size = display_size($DB->get_field_sql(
300                     'SELECT SUM(filesize) FROM {files} WHERE contextid=?', array($context->id)));
301         }
302         if (!empty($options['showtype'])) {
303             // For a typical file resource, the sortorder is 1 for the main file
304             // and 0 for all other files. This sort approach is used just in case
305             // there are situations where the file has a different sort order
306             $mimetype = $DB->get_field_sql(
307                     'SELECT mimetype FROM {files} WHERE contextid=? ORDER BY sortorder DESC',
308                     array($context->id), IGNORE_MULTIPLE);
309             // Only show type if it is not unknown
310             if ($mimetype && $mimetype !== 'document/unknown') {
311                 $type = get_mimetype_description($mimetype);
312                 // There are some known mimetypes which don't have descriptions
313                 if ($type === get_string('document/unknown','mimetypes')) {
314                     $type = '';
315                 }
316             }
317         }
319         if ($size && $type) {
320             // Depending on language it may be necessary to show both options in
321             // different order, so use a lang string
322             $details = get_string('resourcedetails_sizetype', 'resource',
323                     (object)array('size'=>$size, 'type'=>$type));
324         } else {
325             // Either size or type is set, but not both, so just append
326             $details = $size . $type;
327         }
328     }
330     return $details;
333 /**
334  * Print resource introduction.
335  * @param object $resource
336  * @param object $cm
337  * @param object $course
338  * @param bool $ignoresettings print even if not specified in modedit
339  * @return void
340  */
341 function resource_print_intro($resource, $cm, $course, $ignoresettings=false) {
342     global $OUTPUT;
344     $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
346     $extraintro = resource_get_optional_details($resource, $cm);
347     if ($extraintro) {
348         // Put a paragaph tag around the details
349         $extraintro = html_writer::tag('p', $extraintro, array('class' => 'resourcedetails'));
350     }
352     if ($ignoresettings || !empty($options['printintro']) || $extraintro) {
353         $gotintro = trim(strip_tags($resource->intro));
354         if ($gotintro || $extraintro) {
355             echo $OUTPUT->box_start('mod_introbox', 'resourceintro');
356             if ($gotintro) {
357                 echo format_module_intro('resource', $resource, $cm->id);
358             }
359             echo $extraintro;
360             echo $OUTPUT->box_end();
361         }
362     }
365 /**
366  * Print warning that instance not migrated yet.
367  * @param object $resource
368  * @param object $cm
369  * @param object $course
370  * @return void, does not return
371  */
372 function resource_print_tobemigrated($resource, $cm, $course) {
373     global $DB, $OUTPUT;
375     $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
376     resource_print_header($resource, $cm, $course);
377     resource_print_heading($resource, $cm, $course);
378     resource_print_intro($resource, $cm, $course);
379     echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
380     echo $OUTPUT->footer();
381     die;
384 /**
385  * Print warning that file can not be found.
386  * @param object $resource
387  * @param object $cm
388  * @param object $course
389  * @return void, does not return
390  */
391 function resource_print_filenotfound($resource, $cm, $course) {
392     global $DB, $OUTPUT;
394     $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
395     resource_print_header($resource, $cm, $course);
396     resource_print_heading($resource, $cm, $course);
397     resource_print_intro($resource, $cm, $course);
398     if ($resource_old) {
399         echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
400     } else {
401         echo $OUTPUT->notification(get_string('filenotfound', 'resource'));
402     }
403     echo $OUTPUT->footer();
404     die;
407 /**
408  * Decide the best diaply format.
409  * @param object $resource
410  * @return int display type constant
411  */
412 function resource_get_final_display_type($resource) {
413     global $CFG;
415     if ($resource->display != RESOURCELIB_DISPLAY_AUTO) {
416         return $resource->display;
417     }
419     static $download = array('application/zip', 'application/x-tar', 'application/g-zip');    // binary formats
420     static $embed    = array('image/gif', 'image/jpeg', 'image/png', 'image/svg+xml',         // images
421                              'application/x-shockwave-flash', 'video/x-flv', 'video/x-ms-wm', // video formats
422                              'video/quicktime', 'video/mpeg', 'video/mp4',
423                              'audio/mp3', 'audio/x-realaudio-plugin', 'x-realaudio-plugin',   // audio formats
424                              'application/pdf', 'text/html',
425                             );
427     if (empty($resource->mainfile)) {
428         return RESOURCELIB_DISPLAY_DOWNLOAD;
429     } else {
430         $mimetype = mimeinfo('type', $resource->mainfile);
431     }
433     if (in_array($mimetype, $download)) {
434         return RESOURCELIB_DISPLAY_DOWNLOAD;
435     }
436     if (in_array($mimetype, $embed)) {
437         return RESOURCELIB_DISPLAY_EMBED;
438     }
440     // let the browser deal with it somehow
441     return RESOURCELIB_DISPLAY_OPEN;
444 /**
445  * File browsing support class
446  */
447 class resource_content_file_info extends file_info_stored {
448     public function get_parent() {
449         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
450             return $this->browser->get_file_info($this->context);
451         }
452         return parent::get_parent();
453     }
454     public function get_visible_name() {
455         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
456             return $this->topvisiblename;
457         }
458         return parent::get_visible_name();
459     }
462 function resource_set_mainfile($data) {
463     global $DB;
464     $fs = get_file_storage();
465     $cmid = $data->coursemodule;
466     $draftitemid = $data->files;
468     $context = get_context_instance(CONTEXT_MODULE, $cmid);
469     if ($draftitemid) {
470         file_save_draft_area_files($draftitemid, $context->id, 'mod_resource', 'content', 0, array('subdirs'=>true));
471     }
472     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder', false);
473     if (count($files) == 1) {
474         // only one file attached, set it as main file automatically
475         $file = reset($files);
476         file_set_sortorder($context->id, 'mod_resource', 'content', 0, $file->get_filepath(), $file->get_filename(), 1);
477     }