MDL-20069 new URL module, includes migrate from old mod/resource; remaining issues...
[moodle.git] / mod / url / 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 url module utility functions
20  *
21  * @package   mod-url
22  * @copyright 2009 Petr Skoda (http://skodak.org)
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require_once("$CFG->libdir/file/file_browser.php");
27 require_once("$CFG->libdir/filelib.php");
28 require_once("$CFG->libdir/resourcelib.php");
29 require_once("$CFG->dirroot/mod/url/lib.php");
31 /**
32  * Return full url with all extra parameters
33  * @param string $url
34  * @param object $cm
35  * @param object $course
36  * @return string url
37  */
38 function url_get_full_url($url, $cm, $course, $config=null) {
40     $parameters = empty($url->parameters) ? array() : unserialize($url->parameters);
42     if (empty($parameters)) {
43         // easy - no params
44         return $url->externalurl;
45     }
47     if (!$config) {
48         $config = get_config('url');
49     }
50     $paramvalues = url_get_variable_values($url, $cm, $course, $config);
52     foreach ($parameters as $parse=>$parameter) {
53         if (isset($paramvalues[$parameter])) {
54             $parameters[$parse] = urlencode($parse).'='.urlencode($paramvalues[$parameter]);
55         } else {
56             unset($parameters[$parse]);
57         }
58     }
60     if (empty($parameters)) {
61         // easy - no params available
62         return $url->externalurl;
63     }
65     if (stripos($url->externalurl, 'teamspeak://') === 0) {
66         return $url->externalurl.'?'.implode('?', $parameters);
67     } else {
68         $join = (strpos($url->externalurl, '?') === false) ? '?' : '&amp;';
69         return $url->externalurl.$join.implode('&amp;', $parameters);
70     }
71 }
73 /**
74  * Print url header.
75  * @param object $url
76  * @param object $cm
77  * @param object $course
78  * @return void
79  */
80 function url_print_header($url, $cm, $course) {
81     global $PAGE, $OUTPUT;
83     $PAGE->set_title($course->shortname.': '.$url->name);
84     $PAGE->set_heading($course->fullname);
85     $PAGE->set_activity_record($url);
86     $PAGE->set_button(update_module_button($cm->id, '', get_string('modulename', 'url')));
87     echo $OUTPUT->header(build_navigation('', $cm), navmenu($course, $cm));
88 }
90 /**
91  * Print url heading.
92  * @param object $url
93  * @param object $cm
94  * @param object $course
95  * @param bool $ignoresettings print even if not specified in modedit
96  * @return void
97  */
98 function url_print_heading($url, $cm, $course, $ignoresettings=false) {
99     global $OUTPUT;
101     $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
103     if ($ignoresettings or !empty($options['printheading'])) {
104         echo $OUTPUT->heading(format_string($url->name), 2, 'main', 'urlheading');
105     }
108 /**
109  * Print url introduction.
110  * @param object $url
111  * @param object $cm
112  * @param object $course
113  * @param bool $ignoresettings print even if not specified in modedit
114  * @return void
115  */
116 function url_print_intro($url, $cm, $course, $ignoresettings=false) {
117     global $OUTPUT;
119     $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
120     if ($ignoresettings or !empty($options['printintro'])) {
121         if (trim(strip_tags($url->intro))) {
122             echo $OUTPUT->box_start('mod_introbox', 'urlintro');
123             echo format_module_intro('url', $url, $cm->id);
124             echo $OUTPUT->box_end();
125         }
126     }
129 /**
130  * Display url frames.
131  * @param object $url
132  * @param object $cm
133  * @param object $course
134  * @return does not return
135  */
136 function url_display_frame($url, $cm, $course) {
137     global $PAGE, $OUTPUT, $CFG;
139     $frame = optional_param('frameset', 'main', PARAM_ALPHA);
141     if ($frame === 'top') {
142         $PAGE->set_generaltype('topframe');
143         url_print_header($url, $cm, $course);
144         url_print_heading($url, $cm, $course);
145         url_print_intro($url, $cm, $course);
146         echo $OUTPUT->footer();
147         die;
149     } else {
150         $config = get_config('url');
151         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
152         $exteurl = s(url_get_full_url($url, $cm, $course, $config));
153         $navurl = "$CFG->wwwroot/mod/url/view.php?id=$cm->id&amp;frameset=top";
154         $title = strip_tags(format_string($course->shortname.': '.$url->name));
155         $framesize = $config->framesize;
156         $modulename = s(get_string('modulename','url'));
157         $dir = get_string('thisdirection');
159         $extframe = <<<EOF
160 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
161 <html dir="$dir">
162   <head>
163     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
164     <title>$title</title>
165   </head>
166   <frameset rows="$framesize,*">
167     <frame src="$navurl" title="$modulename"/>
168     <frame src="$exteurl" title="$modulename"/>
169   </frameset>
170 </html>
171 EOF;
173         @header('Content-Type: text/html; charset=utf-8');
174         echo $extframe;
175         die;
176     }
179 /**
180  * Print url info and link.
181  * @param object $url
182  * @param object $cm
183  * @param object $course
184  * @return does not return
185  */
186 function url_print_workaround($url, $cm, $course) {
187     global $OUTPUT;
189     url_print_header($url, $cm, $course);
190     url_print_heading($url, $cm, $course, true);
191     url_print_intro($url, $cm, $course, true);
193     $fullurl = url_get_full_url($url, $cm, $course);
195     $display = url_get_final_display_type($url);
196     if ($display == RESOURCELIB_DISPLAY_POPUP) {
197         $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
198         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
199         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
200         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
201         $extra = "onclick=\"window.open('$fullurl', '', '$wh'); return false;\"";
203     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
204         $extra = "onclick=\"this.target='_blank';\"";
206     } else {
207         $extra = '';
208     }
210     echo '<div class="urlworkaround">';
211     print_string('clicktoopen', 'url', "<a href=\"$fullurl\" $extra>$fullurl</a>");
212     echo '</div>';
214     echo $OUTPUT->footer();
215     die;
218 /**
219  * Display embedded url file.
220  * @param object $url
221  * @param object $cm
222  * @param object $course
223  * @param stored_file $file main file
224  * @return does not return
225  */
226 function url_display_embed($url, $cm, $course) {
227     global $CFG, $PAGE;
229     $clicktoopen = get_string('clicktoopen', 'url', $url->externalurl);
231     $mimetype = resourcelib_guess_url_mimetype($url->externalurl);
232     $fullurl  = url_get_full_url($url, $cm, $course);
233     $title    = $url->name;
235     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
236         $code = resourcelib_embed_image($fullurl, $title);
238     } else if ($mimetype == 'audio/mp3') {
239         // MP3 audio file
240         $code = resourcelib_embed_mp3($fullurl, $title, $clicktoopen);
242     } else if ($mimetype == 'video/x-flv') {
243         // Flash video file
244         $code = resourcelib_embed_flashvideo($fullurl, $title, $clicktoopen);
246     } else if ($mimetype == 'application/x-shockwave-flash') {
247         // Flash file
248         $code = resourcelib_embed_flash($fullurl, $title, $clicktoopen);
250     } else if (substr($mimetype, 0, 10) == 'video/x-ms') {
251         // Windows Media Player file
252         $code = resourcelib_embed_mediaplayer($fullurl, $title, $clicktoopen);
254     } else if ($mimetype == 'video/quicktime') {
255         // Quicktime file
256         $code = resourcelib_embed_quicktime($fullurl, $title, $clicktoopen);
258     } else if ($mimetype == 'video/mpeg') {
259         // Mpeg file
260         $code = resourcelib_embed_mpeg($fullurl, $title, $clicktoopen);
262     } else if ($mimetype == 'audio/x-pn-realaudio') {
263         // RealMedia file
264         $code = resourcelib_embed_real($fullurl, $title, $clicktoopen);
266     } else {
267         // anything else - just try object tag enlarged as much as possible
268         $code = resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype);
269         $PAGE->requires->yui_lib('dom')->in_head();
270         $PAGE->requires->js('mod/url/functions.js')->in_head();
271         $PAGE->requires->js_function_call('url_init_object');
272     }
274     url_print_header($url, $cm, $course);
275     url_print_heading($url, $cm, $course);
277     echo $code;
279     url_print_intro($url, $cm, $course);
281     print_footer();
282     die;
285 /**
286  * Decide the best diaply format.
287  * @param object $url
288  * @return int display type constant
289  */
290 function url_get_final_display_type($url) {
291     global $CFG;
293     if ($url->display != RESOURCELIB_DISPLAY_AUTO) {
294         return $url->display;
295     }
297     // detect links to local moodle pages
298     if (strpos($url->externalurl, $CFG->wwwroot) === 0) {
299         if (strpos($url->externalurl, 'file.php') === false and strpos($url->externalurl, '.php') !== false ) {
300             // most probably our moodle page with navigation
301             return RESOURCELIB_DISPLAY_OPEN;
302         }
303     }
305     static $download = array('application/zip', 'application/x-tar', 'application/g-zip',     // binary formats
306                              'application/pdf', 'text/html');  // these are known to cause trouble for external links, sorry
307     static $embed    = array('image/gif', 'image/jpeg', 'image/png', 'image/svg+xml',         // images
308                              'application/x-shockwave-flash', 'video/x-flv', 'video/x-ms-wm', // video formats
309                              'video/quicktime', 'video/mpeg',
310                              'audio/mp3', 'audio/x-realaudio-plugin', 'x-realaudio-plugin',   // audio formats,
311                             );
313     $mimetype = mimeinfo('type', $url->externalurl);
315     if (in_array($mimetype, $download)) {
316         return RESOURCELIB_DISPLAY_DOWNLOAD;
317     }
318     if (in_array($mimetype, $embed)) {
319         return RESOURCELIB_DISPLAY_EMBED;
320     }
322     // let the browser deal with it somehow
323     return RESOURCELIB_DISPLAY_OPEN;
326 /**
327  * Get the parameters that may be appended to URL
328  * @param object $config url module config options
329  * @return array array describing opt groups
330  */
331 function url_get_variable_options($config) {
332     global $CFG;
334     $options = array();
335     $options[''] = array('' => get_string('chooseavariable', 'url'));
337     $options[get_string('course')] = array(
338         'courseid'        => 'id',
339         'coursefullname'  => get_string('fullnamecourse'),
340         'courseshortname' => get_string('shortnamecourse'),
341         'courseidnumber'  => get_string('idnumbercourse'),
342         'coursesummary'   => get_string('summary'),
343         'courseformat'    => get_string('format'),
344     );
346     $options[get_string('modulename', 'url')] = array(
347         'urlinstance'     => 'id',
348         'urlcmid'         => 'cmid',
349         'urlname'         => get_string('name'),
350         'urlidnumber'     => get_string('idnumbermod'),
351     );
353     $options[get_string('miscellaneous')] = array(
354         'sitename'        => get_string('fullsitename'),
355         'serverurl'       => get_string('serverurl', 'resource', (object)array('wwwroot'=>$CFG->wwwroot)),
356         'currenttime'     => get_string('time'),
357         'lang'            => get_string('language'),
358     );
359     if (!empty($config->secretphrase)) {
360         $options[get_string('miscellaneous')]['encryptedcode'] = get_string('encryptedcode');
361     }
363     $options[get_string('user')] = array(
364         'userid'          => 'id',
365         'userusername'    => get_string('username'),
366         'useridnumber'    => get_string('idnumber'),
367         'userfirstname'   => get_string('firstname'),
368         'userlastname'    => get_string('lastname'),
369         'userfullname'    => get_string('fullnameuser'),
370         'useremail'       => get_string('email'),
371         'usericq'         => get_string('icqnumber'),
372         'userphone1'      => get_string('phone').' 1',
373         'userphone2'      => get_string('phone2').' 2',
374         'userinstitution' => get_string('institution'),
375         'userdepartment'  => get_string('department'),
376         'useraddress'     => get_string('address'),
377         'usercity'        => get_string('city'),
378         'usertimezone'    => get_string('timezone'),
379         'userurl'         => get_string('webpage'),
380     );
382     if ($config->rolesinparams) {
383         $roles = get_all_roles();
384         $roleoptions = array();
385         foreach ($roles as $role) {
386             $roleoptions['course'.$role->shortname] = get_string('yourwordforx', '', $role->name);
387         }
388         $options[get_string('roles')] = $roleoptions;
389     }
391     return $options;
394 /**
395  * Get the parameter values that may be appended to URL
396  * @param object $url module instance
397  * @param object $cm
398  * @param object $course
399  * @param object $config module config options
400  * @return array of parameter values
401  */
402 function url_get_variable_values($url, $cm, $course, $config) {
403     global $USER, $CFG;
405     $site = get_site();
407     $values = array (
408         'courseid'        => $course->id,
409         'coursefullname'  => format_string($course->fullname),
410         'courseshortname' => $course->shortname,
411         'courseidnumber'  => $course->idnumber,
412         'coursesummary'   => $course->summary,
413         'courseformat'    => $course->format,
414         'lang'            => current_language(),
415         'sitename'        => format_string($site->fullname),
416         'serverurl'       => $CFG->wwwroot,
417         'currenttime'     => time(),
418         'urlinstance'     => $url->id,
419         'urlcmid'         => $cm->id,
420         'urlname'         => format_string($url->name),
421         'urlidnumber'     => $cm->idnumber,
422     );
424     if (!empty($USER->id)) {
425         $values['userid']          = $USER->id;
426         $values['userusername']    = $USER->username;
427         $values['useridnumber']    = $USER->idnumber;
428         $values['userfirstname']   = $USER->firstname;
429         $values['userlastname']    = $USER->lastname;
430         $values['userfullname']    = fullname($USER);
431         $values['useremail']       = $USER->email;
432         $values['usericq']         = $USER->icq;
433         $values['userphone1']      = $USER->phone1;
434         $values['userphone2']      = $USER->phone2;
435         $values['userinstitution'] = $USER->institution;
436         $values['userdepartment']  = $USER->department;
437         $values['useraddress']     = $USER->address;
438         $values['usercity']        = $USER->city;
439         $values['usertimezone']    = get_user_timezone_offset();
440         $values['userurl']         = $USER->url;
441     }
443     // weak imitation of Single-Sign-On, for backwards compatibility only
444     // NOTE: login hack is not included in 2.0 any more, new contrib auth plugin
445     //       needs to be createed if somebody needs the old functionality!
446     if (!empty($config->secretphrase)) {
447         $values['encryptedcode'] = url_get_encrypted_parameter($url, $config);
448     }
450     //hmm, this is pretty fragile and slow, why do we need it here??
451     if ($config->rolesinparams) {
452         $roles = get_all_roles();
453         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
454         $roles = role_fix_names($roles, $coursecontext, ROLENAME_ALIAS);
455         foreach ($roles as $role) {
456             $values['course'.$role->shortname] = $role->localname;
457         }
458     }
460     return $values;
463 /**
464  * BC internal function
465  * @param object $url
466  * @param object $config
467  * @return string
468  */
469 function url_get_encrypted_parameter($url, $config) {
470     global $CFG;
472     if (file_exists("$CFG->dirroot/local/externserverfile.php")) {
473         require_once("$CFG->dirroot/local/externserverfile.php");
474         if (function_exists('extern_server_file')) {
475             return extern_server_file($url, $config);
476         }
477     }
478     return md5(getremoteaddr().$config->secretphrase);
481 /**
482  * Optimised mimetype detection from general URL
483  * @param $fullurl
484  * @return string mimetype
485  */
486 function url_guess_icon($fullurl) {
487     global $CFG;
488     require_once("$CFG->libdir/filelib.php");
490     if (substr_count($fullurl, '/') < 3 or substr($fullurl, -1) === '/') {
491         // most probably default directory - index.php, index.html, etc.
492         return 'f/web';
493     }
495     $icon = mimeinfo('icon', $fullurl);
496     $icon = 'f/'.str_replace(array('.gif', '.png'), '', $icon);
498     if ($icon === 'f/html' or $icon === 'f/unknown') {
499         $icon = 'f/web';
500     }
502     return $icon;