on-demand release 3.0beta+
[moodle.git] / mod / resource / locallib.php
CommitLineData
aa54ed7b 1<?php
2
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/>.
17
18/**
19 * Private resource module utility functions
20 *
11e41f1a 21 * @package mod_resource
702ab58c
PS
22 * @copyright 2009 Petr Skoda {@link http://skodak.org}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
aa54ed7b 24 */
25
702ab58c
PS
26defined('MOODLE_INTERNAL') || die;
27
aa54ed7b 28require_once("$CFG->libdir/filelib.php");
29require_once("$CFG->libdir/resourcelib.php");
30require_once("$CFG->dirroot/mod/resource/lib.php");
31
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 */
39function resource_redirect_if_migrated($oldid, $cmid) {
40 global $DB, $CFG;
41
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 }
47
48 if (!$old) {
49 return;
50 }
51
52 redirect("$CFG->wwwroot/mod/$old->newmodule/view.php?id=".$old->cmid);
53}
54
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 */
63function resource_display_embed($resource, $cm, $course, $file) {
64 global $CFG, $PAGE, $OUTPUT;
65
66 $clicktoopen = resource_get_clicktoopen($file, $resource->revision);
67
bf0f06b1 68 $context = context_module::instance($cm->id);
64f93798 69 $path = '/'.$context->id.'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
aa54ed7b 70 $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
8b7d95b6 71 $moodleurl = new moodle_url('/pluginfile.php' . $path);
aa54ed7b 72
73 $mimetype = $file->get_mimetype();
74 $title = $resource->name;
75
fcd2cbaf
PS
76 $extension = resourcelib_get_extension($file->get_filename());
77
8b7d95b6 78 $mediarenderer = $PAGE->get_renderer('core', 'media');
79 $embedoptions = array(
80 core_media::OPTION_TRUSTED => true,
81 core_media::OPTION_BLOCK => true,
82 );
83
ae7f35b9 84 if (file_mimetype_in_typegroup($mimetype, 'web_image')) { // It's an image
aa54ed7b 85 $code = resourcelib_embed_image($fullurl, $title);
86
fcd2cbaf 87 } else if ($mimetype === 'application/pdf') {
b8037d73
MD
88 // PDF document
89 $code = resourcelib_embed_pdf($fullurl, $title, $clicktoopen);
90
8b7d95b6 91 } else if ($mediarenderer->can_embed_url($moodleurl, $embedoptions)) {
92 // Media (audio/video) file.
93 $code = $mediarenderer->embed_url($moodleurl, $title, 0, 0, $embedoptions);
aa54ed7b 94
95 } else {
96 // anything else - just try object tag enlarged as much as possible
97 $code = resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype);
aa54ed7b 98 }
99
100 resource_print_header($resource, $cm, $course);
101 resource_print_heading($resource, $cm, $course);
102
103 echo $code;
104
105 resource_print_intro($resource, $cm, $course);
106
107 echo $OUTPUT->footer();
108 die;
109}
110
111/**
112 * Display resource frames.
113 * @param object $resource
114 * @param object $cm
115 * @param object $course
116 * @param stored_file $file main file
117 * @return does not return
118 */
119function resource_display_frame($resource, $cm, $course, $file) {
120 global $PAGE, $OUTPUT, $CFG;
121
122 $frame = optional_param('frameset', 'main', PARAM_ALPHA);
123
124 if ($frame === 'top') {
78946b9b 125 $PAGE->set_pagelayout('frametop');
aa54ed7b 126 resource_print_header($resource, $cm, $course);
127 resource_print_heading($resource, $cm, $course);
128 resource_print_intro($resource, $cm, $course);
129 echo $OUTPUT->footer();
130 die;
131
132 } else {
133 $config = get_config('resource');
bf0f06b1 134 $context = context_module::instance($cm->id);
64f93798 135 $path = '/'.$context->id.'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
aa54ed7b 136 $fileurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
137 $navurl = "$CFG->wwwroot/mod/resource/view.php?id=$cm->id&amp;frameset=top";
138 $title = strip_tags(format_string($course->shortname.': '.$resource->name));
139 $framesize = $config->framesize;
c9b44599 140 $contentframetitle = s(format_string($resource->name));
aa54ed7b 141 $modulename = s(get_string('modulename','resource'));
e372f4c7 142 $dir = get_string('thisdirection', 'langconfig');
aa54ed7b 143
144 $file = <<<EOF
145<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
146<html dir="$dir">
147 <head>
148 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
149 <title>$title</title>
150 </head>
151 <frameset rows="$framesize,*">
152 <frame src="$navurl" title="$modulename" />
4d7e89d7 153 <frame src="$fileurl" title="$contentframetitle" />
aa54ed7b 154 </frameset>
155</html>
156EOF;
157
158 @header('Content-Type: text/html; charset=utf-8');
159 echo $file;
160 die;
161 }
162}
163
164/**
165 * Internal function - create click to open text with link.
166 */
167function resource_get_clicktoopen($file, $revision, $extra='') {
168 global $CFG;
169
170 $filename = $file->get_filename();
64f93798 171 $path = '/'.$file->get_contextid().'/mod_resource/content/'.$revision.$file->get_filepath().$file->get_filename();
aa54ed7b 172 $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
173
174 $string = get_string('clicktoopen2', 'resource', "<a href=\"$fullurl\" $extra>$filename</a>");
175
176 return $string;
177}
178
179/**
180 * Internal function - create click to open text with link.
181 */
182function resource_get_clicktodownload($file, $revision) {
183 global $CFG;
184
185 $filename = $file->get_filename();
64f93798 186 $path = '/'.$file->get_contextid().'/mod_resource/content/'.$revision.$file->get_filepath().$file->get_filename();
aa54ed7b 187 $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, true);
188
189 $string = get_string('clicktodownload', 'resource', "<a href=\"$fullurl\">$filename</a>");
190
191 return $string;
192}
193
194/**
195 * Print resource info and workaround link when JS not available.
196 * @param object $resource
197 * @param object $cm
198 * @param object $course
199 * @param stored_file $file main file
200 * @return does not return
201 */
202function resource_print_workaround($resource, $cm, $course, $file) {
203 global $CFG, $OUTPUT;
204
205 resource_print_header($resource, $cm, $course);
206 resource_print_heading($resource, $cm, $course, true);
207 resource_print_intro($resource, $cm, $course, true);
208
f79321f1 209 $resource->mainfile = $file->get_filename();
aa54ed7b 210 echo '<div class="resourceworkaround">';
211 switch (resource_get_final_display_type($resource)) {
212 case RESOURCELIB_DISPLAY_POPUP:
64f93798 213 $path = '/'.$file->get_contextid().'/mod_resource/content/'.$resource->revision.$file->get_filepath().$file->get_filename();
aa54ed7b 214 $fullurl = file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, false);
215 $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
216 $width = empty($options['popupwidth']) ? 620 : $options['popupwidth'];
217 $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
218 $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
219 $extra = "onclick=\"window.open('$fullurl', '', '$wh'); return false;\"";
220 echo resource_get_clicktoopen($file, $resource->revision, $extra);
221 break;
222
223 case RESOURCELIB_DISPLAY_NEW:
224 $extra = 'onclick="this.target=\'_blank\'"';
225 echo resource_get_clicktoopen($file, $resource->revision, $extra);
226 break;
227
228 case RESOURCELIB_DISPLAY_DOWNLOAD:
229 echo resource_get_clicktodownload($file, $resource->revision);
230 break;
231
232 case RESOURCELIB_DISPLAY_OPEN:
233 default:
234 echo resource_get_clicktoopen($file, $resource->revision);
235 break;
236 }
237 echo '</div>';
238
239 echo $OUTPUT->footer();
240 die;
241}
242
243/**
244 * Print resource header.
245 * @param object $resource
246 * @param object $cm
247 * @param object $course
248 * @return void
249 */
250function resource_print_header($resource, $cm, $course) {
251 global $PAGE, $OUTPUT;
252
253 $PAGE->set_title($course->shortname.': '.$resource->name);
254 $PAGE->set_heading($course->fullname);
255 $PAGE->set_activity_record($resource);
256 $PAGE->set_button(update_module_button($cm->id, '', get_string('modulename', 'resource')));
ef8869c7 257 echo $OUTPUT->header();
aa54ed7b 258}
259
260/**
261 * Print resource heading.
262 * @param object $resource
263 * @param object $cm
264 * @param object $course
b25e7d85 265 * @param bool $notused This variable is no longer used
aa54ed7b 266 * @return void
267 */
b25e7d85 268function resource_print_heading($resource, $cm, $course, $notused = false) {
aa54ed7b 269 global $OUTPUT;
b25e7d85 270 echo $OUTPUT->heading(format_string($resource->name), 2);
aa54ed7b 271}
272
a2c57666 273/**
274 * Gets optional details for a resource, depending on resource settings.
275 *
276 * Result may include the file size and type if those settings are chosen,
277 * or blank if none.
278 *
279 * @param object $resource Resource table row
280 * @param object $cm Course-module table row
281 * @return string Size and type or empty string if show options are not enabled
282 */
283function resource_get_optional_details($resource, $cm) {
284 global $DB;
285
286 $details = '';
287
288 $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
ba8b641d 289 if (!empty($options['showsize']) || !empty($options['showtype']) || !empty($options['showdate'])) {
a2c57666 290 $context = context_module::instance($cm->id);
291 $size = '';
292 $type = '';
ba8b641d
AH
293 $date = '';
294 $langstring = '';
295 $infodisplayed = 0;
0b2bfbd1
MG
296 $fs = get_file_storage();
297 $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false);
298 if (!empty($options['showsize']) && count($files)) {
299 $sizebytes = 0;
300 foreach ($files as $file) {
301 // this will also synchronize the file size for external files if needed
302 $sizebytes += $file->get_filesize();
303 }
304 if ($sizebytes) {
305 $size = display_size($sizebytes);
306 }
ba8b641d
AH
307 $langstring .= 'size';
308 $infodisplayed += 1;
a2c57666 309 }
0b2bfbd1 310 if (!empty($options['showtype']) && count($files)) {
a2c57666 311 // For a typical file resource, the sortorder is 1 for the main file
312 // and 0 for all other files. This sort approach is used just in case
313 // there are situations where the file has a different sort order
0b2bfbd1
MG
314 $mainfile = reset($files);
315 $type = get_mimetype_description($mainfile);
a2c57666 316 // Only show type if it is not unknown
0b2bfbd1
MG
317 if ($type === get_mimetype_description('document/unknown')) {
318 $type = '';
a2c57666 319 }
ba8b641d
AH
320 $langstring .= 'type';
321 $infodisplayed += 1;
322 }
323 if (!empty($options['showdate'])) {
324 $mainfile = reset($files);
325 $uploaddate = $mainfile->get_timecreated();
326 $modifieddate = $mainfile->get_timemodified();
327
328 if ($modifieddate > $uploaddate) {
329 $date = get_string('modifieddate', 'mod_resource', userdate($modifieddate));
330 } else {
331 $date = get_string('uploadeddate', 'mod_resource', userdate($uploaddate));
332 }
333 $langstring .= 'date';
334 $infodisplayed += 1;
a2c57666 335 }
336
ba8b641d
AH
337 if ($infodisplayed > 1) {
338 $details = get_string("resourcedetails_{$langstring}", 'resource',
339 (object)array('size' => $size, 'type' => $type, 'date' => $date));
a2c57666 340 } else {
ba8b641d
AH
341 // Only one of size, type and date is set, so just append.
342 $details = $size . $type . $date;
a2c57666 343 }
344 }
345
346 return $details;
347}
348
aa54ed7b 349/**
350 * Print resource introduction.
351 * @param object $resource
352 * @param object $cm
353 * @param object $course
354 * @param bool $ignoresettings print even if not specified in modedit
355 * @return void
356 */
357function resource_print_intro($resource, $cm, $course, $ignoresettings=false) {
358 global $OUTPUT;
359
360 $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
a2c57666 361
362 $extraintro = resource_get_optional_details($resource, $cm);
363 if ($extraintro) {
364 // Put a paragaph tag around the details
365 $extraintro = html_writer::tag('p', $extraintro, array('class' => 'resourcedetails'));
366 }
367
368 if ($ignoresettings || !empty($options['printintro']) || $extraintro) {
369 $gotintro = trim(strip_tags($resource->intro));
370 if ($gotintro || $extraintro) {
aa54ed7b 371 echo $OUTPUT->box_start('mod_introbox', 'resourceintro');
a2c57666 372 if ($gotintro) {
373 echo format_module_intro('resource', $resource, $cm->id);
374 }
375 echo $extraintro;
aa54ed7b 376 echo $OUTPUT->box_end();
377 }
378 }
379}
380
381/**
382 * Print warning that instance not migrated yet.
383 * @param object $resource
384 * @param object $cm
385 * @param object $course
386 * @return void, does not return
387 */
388function resource_print_tobemigrated($resource, $cm, $course) {
389 global $DB, $OUTPUT;
390
c6c9a3bc 391 $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
aa54ed7b 392 resource_print_header($resource, $cm, $course);
393 resource_print_heading($resource, $cm, $course);
394 resource_print_intro($resource, $cm, $course);
c6c9a3bc 395 echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
aa54ed7b 396 echo $OUTPUT->footer();
397 die;
398}
399
400/**
401 * Print warning that file can not be found.
402 * @param object $resource
403 * @param object $cm
404 * @param object $course
405 * @return void, does not return
406 */
407function resource_print_filenotfound($resource, $cm, $course) {
408 global $DB, $OUTPUT;
409
c6c9a3bc 410 $resource_old = $DB->get_record('resource_old', array('oldid'=>$resource->id));
aa54ed7b 411 resource_print_header($resource, $cm, $course);
412 resource_print_heading($resource, $cm, $course);
413 resource_print_intro($resource, $cm, $course);
498c722d
DM
414 if ($resource_old) {
415 echo $OUTPUT->notification(get_string('notmigrated', 'resource', $resource_old->type));
416 } else {
417 echo $OUTPUT->notification(get_string('filenotfound', 'resource'));
418 }
aa54ed7b 419 echo $OUTPUT->footer();
420 die;
421}
422
423/**
df0671f0 424 * Decide the best display format.
aa54ed7b 425 * @param object $resource
426 * @return int display type constant
427 */
428function resource_get_final_display_type($resource) {
ae7f35b9 429 global $CFG, $PAGE;
aa54ed7b 430
431 if ($resource->display != RESOURCELIB_DISPLAY_AUTO) {
432 return $resource->display;
433 }
434
f79321f1
DC
435 if (empty($resource->mainfile)) {
436 return RESOURCELIB_DISPLAY_DOWNLOAD;
437 } else {
438 $mimetype = mimeinfo('type', $resource->mainfile);
439 }
aa54ed7b 440
ae7f35b9 441 if (file_mimetype_in_typegroup($mimetype, 'archive')) {
aa54ed7b 442 return RESOURCELIB_DISPLAY_DOWNLOAD;
443 }
df0671f0 444 if (file_mimetype_in_typegroup($mimetype, array('web_image', '.htm', 'web_video', 'web_audio'))) {
aa54ed7b 445 return RESOURCELIB_DISPLAY_EMBED;
446 }
447
448 // let the browser deal with it somehow
449 return RESOURCELIB_DISPLAY_OPEN;
450}
451
452/**
453 * File browsing support class
454 */
455class resource_content_file_info extends file_info_stored {
456 public function get_parent() {
457 if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
458 return $this->browser->get_file_info($this->context);
459 }
460 return parent::get_parent();
461 }
462 public function get_visible_name() {
463 if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
464 return $this->topvisiblename;
465 }
466 return parent::get_visible_name();
467 }
468}
f79321f1
DC
469
470function resource_set_mainfile($data) {
471 global $DB;
472 $fs = get_file_storage();
473 $cmid = $data->coursemodule;
474 $draftitemid = $data->files;
475
bf0f06b1 476 $context = context_module::instance($cmid);
f79321f1 477 if ($draftitemid) {
64f93798 478 file_save_draft_area_files($draftitemid, $context->id, 'mod_resource', 'content', 0, array('subdirs'=>true));
f79321f1 479 }
64f93798 480 $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder', false);
f79321f1
DC
481 if (count($files) == 1) {
482 // only one file attached, set it as main file automatically
483 $file = reset($files);
64f93798 484 file_set_sortorder($context->id, 'mod_resource', 'content', 0, $file->get_filepath(), $file->get_filename(), 1);
f79321f1
DC
485 }
486}