7690c2c8e2f37775fd90035e27644ca795021d4c
[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         $modulename = s(get_string('modulename','resource'));
159         $dir = get_string('thisdirection', 'langconfig');
161         $file = <<<EOF
162 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
163 <html dir="$dir">
164   <head>
165     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
166     <title>$title</title>
167   </head>
168   <frameset rows="$framesize,*">
169     <frame src="$navurl" title="$modulename" />
170     <frame src="$fileurl" title="$modulename" />
171   </frameset>
172 </html>
173 EOF;
175         @header('Content-Type: text/html; charset=utf-8');
176         echo $file;
177         die;
178     }
181 /**
182  * Internal function - create click to open text with link.
183  */
184 function resource_get_clicktoopen($file, $revision, $extra='') {
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, false);
191     $string = get_string('clicktoopen2', 'resource', "<a href=\"$fullurl\" $extra>$filename</a>");
193     return $string;
196 /**
197  * Internal function - create click to open text with link.
198  */
199 function resource_get_clicktodownload($file, $revision) {
200     global $CFG;
202     $filename = $file->get_filename();
203     $path = '/'.$file->get_contextid().'/mod_resource/content/'.$revision.$file->get_filepath().$file->get_filename();
204     $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, true);
206     $string = get_string('clicktodownload', 'resource', "<a href=\"$fullurl\">$filename</a>");
208     return $string;
211 /**
212  * Print resource info and workaround link when JS not available.
213  * @param object $resource
214  * @param object $cm
215  * @param object $course
216  * @param stored_file $file main file
217  * @return does not return
218  */
219 function resource_print_workaround($resource, $cm, $course, $file) {
220     global $CFG, $OUTPUT;
222     resource_print_header($resource, $cm, $course);
223     resource_print_heading($resource, $cm, $course, true);
224     resource_print_intro($resource, $cm, $course, true);
226     $resource->mainfile = $file->get_filename();
227     echo '<div class="resourceworkaround">';
228     switch (resource_get_final_display_type($resource)) {
229         case RESOURCELIB_DISPLAY_POPUP:
230             $path = '/'.$file->get_contextid().'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
231             $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
232             $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
233             $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
234             $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
235             $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
236             $extra = "onclick=\"window.open('$fullurl', '', '$wh'); return false;\"";
237             echo resource_get_clicktoopen($file, $resource->revision, $extra);
238             break;
240         case RESOURCELIB_DISPLAY_NEW:
241             $extra = 'onclick="this.target=\'_blank\'"';
242             echo resource_get_clicktoopen($file, $resource->revision, $extra);
243             break;
245         case RESOURCELIB_DISPLAY_DOWNLOAD:
246             echo resource_get_clicktodownload($file, $resource->revision);
247             break;
249         case RESOURCELIB_DISPLAY_OPEN:
250         default:
251             echo resource_get_clicktoopen($file, $resource->revision);
252             break;
253     }
254     echo '</div>';
256     echo $OUTPUT->footer();
257     die;
260 /**
261  * Print resource header.
262  * @param object $resource
263  * @param object $cm
264  * @param object $course
265  * @return void
266  */
267 function resource_print_header($resource, $cm, $course) {
268     global $PAGE, $OUTPUT;
270     $PAGE->set_title($course->shortname.': '.$resource->name);
271     $PAGE->set_heading($course->fullname);
272     $PAGE->set_activity_record($resource);
273     $PAGE->set_button(update_module_button($cm->id, '', get_string('modulename', 'resource')));
274     echo $OUTPUT->header();
277 /**
278  * Print resource heading.
279  * @param object $resource
280  * @param object $cm
281  * @param object $course
282  * @param bool $ignoresettings print even if not specified in modedit
283  * @return void
284  */
285 function resource_print_heading($resource, $cm, $course, $ignoresettings=false) {
286     global $OUTPUT;
288     $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
289     if ($ignoresettings or !empty($options['printheading'])) {
290         echo $OUTPUT->heading(format_string($resource->name), 2, 'main', 'resourceheading');
291     }
294 /**
295  * Print resource introduction.
296  * @param object $resource
297  * @param object $cm
298  * @param object $course
299  * @param bool $ignoresettings print even if not specified in modedit
300  * @return void
301  */
302 function resource_print_intro($resource, $cm, $course, $ignoresettings=false) {
303     global $OUTPUT;
305     $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
306     if ($ignoresettings or !empty($options['printintro'])) {
307         if (trim(strip_tags($resource->intro))) {
308             echo $OUTPUT->box_start('mod_introbox', 'resourceintro');
309             echo format_module_intro('resource', $resource, $cm->id);
310             echo $OUTPUT->box_end();
311         }
312     }
315 /**
316  * Print warning that instance not migrated yet.
317  * @param object $resource
318  * @param object $cm
319  * @param object $course
320  * @return void, does not return
321  */
322 function resource_print_tobemigrated($resource, $cm, $course) {
323     global $DB, $OUTPUT;
325     $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
326     resource_print_header($resource, $cm, $course);
327     resource_print_heading($resource, $cm, $course);
328     resource_print_intro($resource, $cm, $course);
329     echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
330     echo $OUTPUT->footer();
331     die;
334 /**
335  * Print warning that file can not be found.
336  * @param object $resource
337  * @param object $cm
338  * @param object $course
339  * @return void, does not return
340  */
341 function resource_print_filenotfound($resource, $cm, $course) {
342     global $DB, $OUTPUT;
344     $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
345     resource_print_header($resource, $cm, $course);
346     resource_print_heading($resource, $cm, $course);
347     resource_print_intro($resource, $cm, $course);
348     echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
349     echo $OUTPUT->footer();
350     die;
353 /**
354  * Decide the best diaply format.
355  * @param object $resource
356  * @return int display type constant
357  */
358 function resource_get_final_display_type($resource) {
359     global $CFG;
361     if ($resource->display != RESOURCELIB_DISPLAY_AUTO) {
362         return $resource->display;
363     }
365     static $download = array('application/zip', 'application/x-tar', 'application/g-zip');    // binary formats
366     static $embed    = array('image/gif', 'image/jpeg', 'image/png', 'image/svg+xml',         // images
367                              'application/x-shockwave-flash', 'video/x-flv', 'video/x-ms-wm', // video formats
368                              'video/quicktime', 'video/mpeg', 'video/mp4',
369                              'audio/mp3', 'audio/x-realaudio-plugin', 'x-realaudio-plugin',   // audio formats
370                              'application/pdf', 'text/html',
371                             );
373     if (empty($resource->mainfile)) {
374         return RESOURCELIB_DISPLAY_DOWNLOAD;
375     } else {
376         $mimetype = mimeinfo('type', $resource->mainfile);
377     }
379     if (in_array($mimetype, $download)) {
380         return RESOURCELIB_DISPLAY_DOWNLOAD;
381     }
382     if (in_array($mimetype, $embed)) {
383         return RESOURCELIB_DISPLAY_EMBED;
384     }
386     // let the browser deal with it somehow
387     return RESOURCELIB_DISPLAY_OPEN;
390 /**
391  * File browsing support class
392  */
393 class resource_content_file_info extends file_info_stored {
394     public function get_parent() {
395         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
396             return $this->browser->get_file_info($this->context);
397         }
398         return parent::get_parent();
399     }
400     public function get_visible_name() {
401         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
402             return $this->topvisiblename;
403         }
404         return parent::get_visible_name();
405     }
408 function resource_set_mainfile($data) {
409     global $DB;
410     $fs = get_file_storage();
411     $cmid = $data->coursemodule;
412     $draftitemid = $data->files;
414     $context = get_context_instance(CONTEXT_MODULE, $cmid);
415     if ($draftitemid) {
416         file_save_draft_area_files($draftitemid, $context->id, 'mod_resource', 'content', 0, array('subdirs'=>true));
417     }
418     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder', false);
419     if (count($files) == 1) {
420         // only one file attached, set it as main file automatically
421         $file = reset($files);
422         file_set_sortorder($context->id, 'mod_resource', 'content', 0, $file->get_filepath(), $file->get_filename(), 1);
423     }