df2b0b638f267bda1d5e27c06455641d170873a6
[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);
73     $mimetype = $file->get_mimetype();
74     $title    = $resource->name;
76     $extension = resourcelib_get_extension($file->get_filename());
78     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
79         $code = resourcelib_embed_image($fullurl, $title);
81     } else if ($mimetype === 'application/pdf') {
82         // PDF document
83         $code = resourcelib_embed_pdf($fullurl, $title, $clicktoopen);
85     } else if ($mimetype === 'audio/mp3') {
86         // MP3 audio file
87         $code = resourcelib_embed_mp3($fullurl, $title, $clicktoopen);
89     } else if ($mimetype === 'video/x-flv' or $extension === 'f4v') {
90         // Flash video file
91         $code = resourcelib_embed_flashvideo($fullurl, $title, $clicktoopen);
93     } else if ($mimetype === 'application/x-shockwave-flash') {
94         // Flash file
95         $code = resourcelib_embed_flash($fullurl, $title, $clicktoopen);
97     } else if (substr($mimetype, 0, 10) === 'video/x-ms') {
98         // Windows Media Player file
99         $code = resourcelib_embed_mediaplayer($fullurl, $title, $clicktoopen);
101     } else if ($mimetype === 'video/quicktime') {
102         // Quicktime file
103         $code = resourcelib_embed_quicktime($fullurl, $title, $clicktoopen);
105     } else if ($mimetype === 'video/mpeg') {
106         // Mpeg file
107         $code = resourcelib_embed_mpeg($fullurl, $title, $clicktoopen);
109     } else if ($mimetype === 'audio/x-pn-realaudio') {
110         // RealMedia file
111         $code = resourcelib_embed_real($fullurl, $title, $clicktoopen);
113     } else {
114         // anything else - just try object tag enlarged as much as possible
115         $code = resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype);
116     }
118     resource_print_header($resource, $cm, $course);
119     resource_print_heading($resource, $cm, $course);
121     echo $code;
123     resource_print_intro($resource, $cm, $course);
125     echo $OUTPUT->footer();
126     die;
129 /**
130  * Display resource frames.
131  * @param object $resource
132  * @param object $cm
133  * @param object $course
134  * @param stored_file $file main file
135  * @return does not return
136  */
137 function resource_display_frame($resource, $cm, $course, $file) {
138     global $PAGE, $OUTPUT, $CFG;
140     $frame = optional_param('frameset', 'main', PARAM_ALPHA);
142     if ($frame === 'top') {
143         $PAGE->set_pagelayout('frametop');
144         resource_print_header($resource, $cm, $course);
145         resource_print_heading($resource, $cm, $course);
146         resource_print_intro($resource, $cm, $course);
147         echo $OUTPUT->footer();
148         die;
150     } else {
151         $config = get_config('resource');
152         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
153         $path = '/'.$context->id.'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
154         $fileurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
155         $navurl = "$CFG->wwwroot/mod/resource/view.php?id=$cm->id&amp;frameset=top";
156         $title = strip_tags(format_string($course->shortname.': '.$resource->name));
157         $framesize = $config->framesize;
158         $contentframetitle = format_string($resource->name);
159         $modulename = s(get_string('modulename','resource'));
160         $dir = get_string('thisdirection', 'langconfig');
162         $file = <<<EOF
163 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
164 <html dir="$dir">
165   <head>
166     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
167     <title>$title</title>
168   </head>
169   <frameset rows="$framesize,*">
170     <frame src="$navurl" title="$modulename" />
171     <frame src="$fileurl" title="$contentframetitle" />
172   </frameset>
173 </html>
174 EOF;
176         @header('Content-Type: text/html; charset=utf-8');
177         echo $file;
178         die;
179     }
182 /**
183  * Internal function - create click to open text with link.
184  */
185 function resource_get_clicktoopen($file, $revision, $extra='') {
186     global $CFG;
188     $filename = $file->get_filename();
189     $path = '/'.$file->get_contextid().'/mod_resource/content/'.$revision.$file->get_filepath().$file->get_filename();
190     $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
192     $string = get_string('clicktoopen2', 'resource', "<a href=\"$fullurl\" $extra>$filename</a>");
194     return $string;
197 /**
198  * Internal function - create click to open text with link.
199  */
200 function resource_get_clicktodownload($file, $revision) {
201     global $CFG;
203     $filename = $file->get_filename();
204     $path = '/'.$file->get_contextid().'/mod_resource/content/'.$revision.$file->get_filepath().$file->get_filename();
205     $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, true);
207     $string = get_string('clicktodownload', 'resource', "<a href=\"$fullurl\">$filename</a>");
209     return $string;
212 /**
213  * Print resource info and workaround link when JS not available.
214  * @param object $resource
215  * @param object $cm
216  * @param object $course
217  * @param stored_file $file main file
218  * @return does not return
219  */
220 function resource_print_workaround($resource, $cm, $course, $file) {
221     global $CFG, $OUTPUT;
223     resource_print_header($resource, $cm, $course);
224     resource_print_heading($resource, $cm, $course, true);
225     resource_print_intro($resource, $cm, $course, true);
227     $resource->mainfile = $file->get_filename();
228     echo '<div class="resourceworkaround">';
229     switch (resource_get_final_display_type($resource)) {
230         case RESOURCELIB_DISPLAY_POPUP:
231             $path = '/'.$file->get_contextid().'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
232             $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
233             $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
234             $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
235             $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
236             $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
237             $extra = "onclick=\"window.open('$fullurl', '', '$wh'); return false;\"";
238             echo resource_get_clicktoopen($file, $resource->revision, $extra);
239             break;
241         case RESOURCELIB_DISPLAY_NEW:
242             $extra = 'onclick="this.target=\'_blank\'"';
243             echo resource_get_clicktoopen($file, $resource->revision, $extra);
244             break;
246         case RESOURCELIB_DISPLAY_DOWNLOAD:
247             echo resource_get_clicktodownload($file, $resource->revision);
248             break;
250         case RESOURCELIB_DISPLAY_OPEN:
251         default:
252             echo resource_get_clicktoopen($file, $resource->revision);
253             break;
254     }
255     echo '</div>';
257     echo $OUTPUT->footer();
258     die;
261 /**
262  * Print resource header.
263  * @param object $resource
264  * @param object $cm
265  * @param object $course
266  * @return void
267  */
268 function resource_print_header($resource, $cm, $course) {
269     global $PAGE, $OUTPUT;
271     $PAGE->set_title($course->shortname.': '.$resource->name);
272     $PAGE->set_heading($course->fullname);
273     $PAGE->set_activity_record($resource);
274     $PAGE->set_button(update_module_button($cm->id, '', get_string('modulename', 'resource')));
275     echo $OUTPUT->header();
278 /**
279  * Print resource heading.
280  * @param object $resource
281  * @param object $cm
282  * @param object $course
283  * @param bool $ignoresettings print even if not specified in modedit
284  * @return void
285  */
286 function resource_print_heading($resource, $cm, $course, $ignoresettings=false) {
287     global $OUTPUT;
289     $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
290     if ($ignoresettings or !empty($options['printheading'])) {
291         echo $OUTPUT->heading(format_string($resource->name), 2, 'main', 'resourceheading');
292     }
295 /**
296  * Gets optional details for a resource, depending on resource settings.
297  *
298  * Result may include the file size and type if those settings are chosen,
299  * or blank if none.
300  *
301  * @param object $resource Resource table row
302  * @param object $cm Course-module table row
303  * @return string Size and type or empty string if show options are not enabled
304  */
305 function resource_get_optional_details($resource, $cm) {
306     global $DB;
308     $details = '';
310     $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
311     if (!empty($options['showsize']) || !empty($options['showtype'])) {
312         $context = context_module::instance($cm->id);
313         $size = '';
314         $type = '';
315         if (!empty($options['showsize'])) {
316             $size = display_size($DB->get_field_sql(
317                     'SELECT SUM(filesize) FROM {files} WHERE contextid=?', array($context->id)));
318         }
319         if (!empty($options['showtype'])) {
320             // For a typical file resource, the sortorder is 1 for the main file
321             // and 0 for all other files. This sort approach is used just in case
322             // there are situations where the file has a different sort order
323             $mimetype = $DB->get_field_sql(
324                     'SELECT mimetype FROM {files} WHERE contextid=? ORDER BY sortorder DESC',
325                     array($context->id), IGNORE_MULTIPLE);
326             // Only show type if it is not unknown
327             if ($mimetype && $mimetype !== 'document/unknown') {
328                 $type = get_mimetype_description($mimetype);
329                 // There are some known mimetypes which don't have descriptions
330                 if ($type === get_string('document/unknown','mimetypes')) {
331                     $type = '';
332                 }
333             }
334         }
336         if ($size && $type) {
337             // Depending on language it may be necessary to show both options in
338             // different order, so use a lang string
339             $details = get_string('resourcedetails_sizetype', 'resource',
340                     (object)array('size'=>$size, 'type'=>$type));
341         } else {
342             // Either size or type is set, but not both, so just append
343             $details = $size . $type;
344         }
345     }
347     return $details;
350 /**
351  * Print resource introduction.
352  * @param object $resource
353  * @param object $cm
354  * @param object $course
355  * @param bool $ignoresettings print even if not specified in modedit
356  * @return void
357  */
358 function resource_print_intro($resource, $cm, $course, $ignoresettings=false) {
359     global $OUTPUT;
361     $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
363     $extraintro = resource_get_optional_details($resource, $cm);
364     if ($extraintro) {
365         // Put a paragaph tag around the details
366         $extraintro = html_writer::tag('p', $extraintro, array('class' => 'resourcedetails'));
367     }
369     if ($ignoresettings || !empty($options['printintro']) || $extraintro) {
370         $gotintro = trim(strip_tags($resource->intro));
371         if ($gotintro || $extraintro) {
372             echo $OUTPUT->box_start('mod_introbox', 'resourceintro');
373             if ($gotintro) {
374                 echo format_module_intro('resource', $resource, $cm->id);
375             }
376             echo $extraintro;
377             echo $OUTPUT->box_end();
378         }
379     }
382 /**
383  * Print warning that instance not migrated yet.
384  * @param object $resource
385  * @param object $cm
386  * @param object $course
387  * @return void, does not return
388  */
389 function resource_print_tobemigrated($resource, $cm, $course) {
390     global $DB, $OUTPUT;
392     $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
393     resource_print_header($resource, $cm, $course);
394     resource_print_heading($resource, $cm, $course);
395     resource_print_intro($resource, $cm, $course);
396     echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
397     echo $OUTPUT->footer();
398     die;
401 /**
402  * Print warning that file can not be found.
403  * @param object $resource
404  * @param object $cm
405  * @param object $course
406  * @return void, does not return
407  */
408 function resource_print_filenotfound($resource, $cm, $course) {
409     global $DB, $OUTPUT;
411     $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
412     resource_print_header($resource, $cm, $course);
413     resource_print_heading($resource, $cm, $course);
414     resource_print_intro($resource, $cm, $course);
415     if ($resource_old) {
416         echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
417     } else {
418         echo $OUTPUT->notification(get_string('filenotfound', 'resource'));
419     }
420     echo $OUTPUT->footer();
421     die;
424 /**
425  * Decide the best diaply format.
426  * @param object $resource
427  * @return int display type constant
428  */
429 function resource_get_final_display_type($resource) {
430     global $CFG;
432     if ($resource->display != RESOURCELIB_DISPLAY_AUTO) {
433         return $resource->display;
434     }
436     static $download = array('application/zip', 'application/x-tar', 'application/g-zip');    // binary formats
437     static $embed    = array('image/gif', 'image/jpeg', 'image/png', 'image/svg+xml',         // images
438                              'application/x-shockwave-flash', 'video/x-flv', 'video/x-ms-wm', // video formats
439                              'video/quicktime', 'video/mpeg', 'video/mp4',
440                              'audio/mp3', 'audio/x-realaudio-plugin', 'x-realaudio-plugin',   // audio formats
441                              'application/pdf', 'text/html',
442                             );
444     if (empty($resource->mainfile)) {
445         return RESOURCELIB_DISPLAY_DOWNLOAD;
446     } else {
447         $mimetype = mimeinfo('type', $resource->mainfile);
448     }
450     if (in_array($mimetype, $download)) {
451         return RESOURCELIB_DISPLAY_DOWNLOAD;
452     }
453     if (in_array($mimetype, $embed)) {
454         return RESOURCELIB_DISPLAY_EMBED;
455     }
457     // let the browser deal with it somehow
458     return RESOURCELIB_DISPLAY_OPEN;
461 /**
462  * File browsing support class
463  */
464 class resource_content_file_info extends file_info_stored {
465     public function get_parent() {
466         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
467             return $this->browser->get_file_info($this->context);
468         }
469         return parent::get_parent();
470     }
471     public function get_visible_name() {
472         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
473             return $this->topvisiblename;
474         }
475         return parent::get_visible_name();
476     }
479 function resource_set_mainfile($data) {
480     global $DB;
481     $fs = get_file_storage();
482     $cmid = $data->coursemodule;
483     $draftitemid = $data->files;
485     $context = get_context_instance(CONTEXT_MODULE, $cmid);
486     if ($draftitemid) {
487         file_save_draft_area_files($draftitemid, $context->id, 'mod_resource', 'content', 0, array('subdirs'=>true));
488     }
489     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder', false);
490     if (count($files) == 1) {
491         // only one file attached, set it as main file automatically
492         $file = reset($files);
493         file_set_sortorder($context->id, 'mod_resource', 'content', 0, $file->get_filepath(), $file->get_filename(), 1);
494     }