MDL-29624 Media embedding system, part 3: resource module (and URL, lesson)
[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
22  * @subpackage url
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/url/lib.php");
33 /**
34  * This methods does weak url validation, we are looking for major problems only,
35  * no strict RFE validation.
36  *
37  * @param $url
38  * @return bool true is seems valid, false if definitely not valid URL
39  */
40 function url_appears_valid_url($url) {
41     if (preg_match('/^(\/|https?:|ftp:)/i', $url)) {
42         // note: this is not exact validation, we look for severely malformed URLs only
43         return (bool)preg_match('/^[a-z]+:\/\/([^:@\s]+:[^@\s]+@)?[a-z0-9_\.\-]+(:[0-9]+)?(\/[^#]*)?(#.*)?$/i', $url);
44     } else {
45         return (bool)preg_match('/^[a-z]+:\/\/...*$/i', $url);
46     }
47 }
49 /**
50  * Fix common URL problems that we want teachers to see fixed
51  * the next time they edit the resource.
52  *
53  * This function does not include any XSS protection.
54  *
55  * @param string $url
56  * @return string
57  */
58 function url_fix_submitted_url($url) {
59     // note: empty urls are prevented in form validation
60     $url = trim($url);
62     // remove encoded entities - we want the raw URI here
63     $url = html_entity_decode($url, ENT_QUOTES, 'UTF-8');
65     if (!preg_match('|^[a-z]+:|i', $url) and !preg_match('|^/|', $url)) {
66         // invalid URI, try to fix it by making it normal URL,
67         // please note relative urls are not allowed, /xx/yy links are ok
68         $url = 'http://'.$url;
69     }
71     return $url;
72 }
74 /**
75  * Return full url with all extra parameters
76  *
77  * This function does not include any XSS protection.
78  *
79  * @param string $url
80  * @param object $cm
81  * @param object $course
82  * @param object $config
83  * @return string url with & encoded as &amp;
84  */
85 function url_get_full_url($url, $cm, $course, $config=null) {
87     $parameters = empty($url->parameters) ? array() : unserialize($url->parameters);
89     // make sure there are no encoded entities, it is ok to do this twice
90     $fullurl = html_entity_decode($url->externalurl, ENT_QUOTES, 'UTF-8');
92     if (preg_match('/^(\/|https?:|ftp:)/i', $fullurl) or preg_match('|^/|', $fullurl)) {
93         // encode extra chars in URLs - this does not make it always valid, but it helps with some UTF-8 problems
94         $allowed = "a-zA-Z0-9".preg_quote(';/?:@=&$_.+!*(),-#%', '/');
95         $fullurl = preg_replace_callback("/[^$allowed]/", 'url_filter_callback', $fullurl);
96     } else {
97         // encode special chars only
98         $fullurl = str_replace('"', '%22', $fullurl);
99         $fullurl = str_replace('\'', '%27', $fullurl);
100         $fullurl = str_replace(' ', '%20', $fullurl);
101         $fullurl = str_replace('<', '%3C', $fullurl);
102         $fullurl = str_replace('>', '%3E', $fullurl);
103     }
105     // add variable url parameters
106     if (!empty($parameters)) {
107         if (!$config) {
108             $config = get_config('url');
109         }
110         $paramvalues = url_get_variable_values($url, $cm, $course, $config);
112         foreach ($parameters as $parse=>$parameter) {
113             if (isset($paramvalues[$parameter])) {
114                 $parameters[$parse] = rawurlencode($parse).'='.rawurlencode($paramvalues[$parameter]);
115             } else {
116                 unset($parameters[$parse]);
117             }
118         }
120         if (!empty($parameters)) {
121             if (stripos($fullurl, 'teamspeak://') === 0) {
122                 $fullurl = $fullurl.'?'.implode('?', $parameters);
123             } else {
124                 $join = (strpos($fullurl, '?') === false) ? '?' : '&';
125                 $fullurl = $fullurl.$join.implode('&', $parameters);
126             }
127         }
128     }
130     // encode all & to &amp; entity
131     $fullurl = str_replace('&', '&amp;', $fullurl);
133     return $fullurl;
136 /**
137  * Unicode encoding helper callback
138  * @internal
139  * @param array $matches
140  * @return string
141  */
142 function url_filter_callback($matches) {
143     return rawurlencode($matches[0]);
146 /**
147  * Print url header.
148  * @param object $url
149  * @param object $cm
150  * @param object $course
151  * @return void
152  */
153 function url_print_header($url, $cm, $course) {
154     global $PAGE, $OUTPUT;
156     $PAGE->set_title($course->shortname.': '.$url->name);
157     $PAGE->set_heading($course->fullname);
158     $PAGE->set_activity_record($url);
159     echo $OUTPUT->header();
162 /**
163  * Print url heading.
164  * @param object $url
165  * @param object $cm
166  * @param object $course
167  * @param bool $ignoresettings print even if not specified in modedit
168  * @return void
169  */
170 function url_print_heading($url, $cm, $course, $ignoresettings=false) {
171     global $OUTPUT;
173     $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
175     if ($ignoresettings or !empty($options['printheading'])) {
176         echo $OUTPUT->heading(format_string($url->name), 2, 'main', 'urlheading');
177     }
180 /**
181  * Print url introduction.
182  * @param object $url
183  * @param object $cm
184  * @param object $course
185  * @param bool $ignoresettings print even if not specified in modedit
186  * @return void
187  */
188 function url_print_intro($url, $cm, $course, $ignoresettings=false) {
189     global $OUTPUT;
191     $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
192     if ($ignoresettings or !empty($options['printintro'])) {
193         if (trim(strip_tags($url->intro))) {
194             echo $OUTPUT->box_start('mod_introbox', 'urlintro');
195             echo format_module_intro('url', $url, $cm->id);
196             echo $OUTPUT->box_end();
197         }
198     }
201 /**
202  * Display url frames.
203  * @param object $url
204  * @param object $cm
205  * @param object $course
206  * @return does not return
207  */
208 function url_display_frame($url, $cm, $course) {
209     global $PAGE, $OUTPUT, $CFG;
211     $frame = optional_param('frameset', 'main', PARAM_ALPHA);
213     if ($frame === 'top') {
214         $PAGE->set_pagelayout('frametop');
215         url_print_header($url, $cm, $course);
216         url_print_heading($url, $cm, $course);
217         url_print_intro($url, $cm, $course);
218         echo $OUTPUT->footer();
219         die;
221     } else {
222         $config = get_config('url');
223         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
224         $exteurl = url_get_full_url($url, $cm, $course, $config);
225         $navurl = "$CFG->wwwroot/mod/url/view.php?id=$cm->id&amp;frameset=top";
226         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
227         $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
228         $title = strip_tags($courseshortname.': '.format_string($url->name));
229         $framesize = $config->framesize;
230         $modulename = s(get_string('modulename','url'));
231         $contentframetitle = format_string($url->name);
232         $dir = get_string('thisdirection', 'langconfig');
234         $extframe = <<<EOF
235 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
236 <html dir="$dir">
237   <head>
238     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
239     <title>$title</title>
240   </head>
241   <frameset rows="$framesize,*">
242     <frame src="$navurl" title="$modulename"/>
243     <frame src="$exteurl" title="$contentframetitle"/>
244   </frameset>
245 </html>
246 EOF;
248         @header('Content-Type: text/html; charset=utf-8');
249         echo $extframe;
250         die;
251     }
254 /**
255  * Print url info and link.
256  * @param object $url
257  * @param object $cm
258  * @param object $course
259  * @return does not return
260  */
261 function url_print_workaround($url, $cm, $course) {
262     global $OUTPUT;
264     url_print_header($url, $cm, $course);
265     url_print_heading($url, $cm, $course, true);
266     url_print_intro($url, $cm, $course, true);
268     $fullurl = url_get_full_url($url, $cm, $course);
270     $display = url_get_final_display_type($url);
271     if ($display == RESOURCELIB_DISPLAY_POPUP) {
272         $jsfullurl = addslashes_js($fullurl);
273         $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
274         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
275         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
276         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
277         $extra = "onclick=\"window.open('$jsfullurl', '', '$wh'); return false;\"";
279     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
280         $extra = "onclick=\"this.target='_blank';\"";
282     } else {
283         $extra = '';
284     }
286     echo '<div class="urlworkaround">';
287     print_string('clicktoopen', 'url', "<a href=\"$fullurl\" $extra>$fullurl</a>");
288     echo '</div>';
290     echo $OUTPUT->footer();
291     die;
294 /**
295  * Display embedded url file.
296  * @param object $url
297  * @param object $cm
298  * @param object $course
299  * @return does not return
300  */
301 function url_display_embed($url, $cm, $course) {
302     global $CFG, $PAGE, $OUTPUT;
304     $mimetype = resourcelib_guess_url_mimetype($url->externalurl);
305     $fullurl  = url_get_full_url($url, $cm, $course);
306     $title    = $url->name;
308     $link = html_writer::tag('a', $fullurl, array('href'=>str_replace('&amp;', '&', $fullurl)));
309     $clicktoopen = get_string('clicktoopen', 'url', $link);
310     $moodleurl = new moodle_url($fullurl);
312     $extension = resourcelib_get_extension($url->externalurl);
314     $mediarenderer = $PAGE->get_renderer('core', 'media');
315     $embedoptions = array(
316         core_media::OPTION_TRUSTED => true,
317         core_media::OPTION_BLOCK => true
318     );
320     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
321         $code = resourcelib_embed_image($fullurl, $title);
323     } else if ($mediarenderer->can_embed_url($moodleurl, $embedoptions)) {
324         // Media (audio/video) file.
325         $code = $mediarenderer->embed_url($moodleurl, $title, 0, 0, $embedoptions);
327     } else {
328         // anything else - just try object tag enlarged as much as possible
329         $code = resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype);
330     }
332     url_print_header($url, $cm, $course);
333     url_print_heading($url, $cm, $course);
335     echo $code;
337     url_print_intro($url, $cm, $course);
339     echo $OUTPUT->footer();
340     die;
343 /**
344  * Decide the best display format.
345  * @param object $url
346  * @return int display type constant
347  */
348 function url_get_final_display_type($url) {
349     global $CFG;
351     if ($url->display != RESOURCELIB_DISPLAY_AUTO) {
352         return $url->display;
353     }
355     // detect links to local moodle pages
356     if (strpos($url->externalurl, $CFG->wwwroot) === 0) {
357         if (strpos($url->externalurl, 'file.php') === false and strpos($url->externalurl, '.php') !== false ) {
358             // most probably our moodle page with navigation
359             return RESOURCELIB_DISPLAY_OPEN;
360         }
361     }
363     static $download = array('application/zip', 'application/x-tar', 'application/g-zip',     // binary formats
364                              'application/pdf', 'text/html');  // these are known to cause trouble for external links, sorry
365     static $embed    = array('image/gif', 'image/jpeg', 'image/png', 'image/svg+xml',         // images
366                              'application/x-shockwave-flash', 'video/x-flv', 'video/x-ms-wm', // video formats
367                              'video/quicktime', 'video/mpeg', 'video/mp4',
368                              'audio/mp3', 'audio/x-realaudio-plugin', 'x-realaudio-plugin',   // audio formats,
369                             );
371     $mimetype = resourcelib_guess_url_mimetype($url->externalurl);
373     if (in_array($mimetype, $download)) {
374         return RESOURCELIB_DISPLAY_DOWNLOAD;
375     }
376     if (in_array($mimetype, $embed)) {
377         return RESOURCELIB_DISPLAY_EMBED;
378     }
380     // let the browser deal with it somehow
381     return RESOURCELIB_DISPLAY_OPEN;
384 /**
385  * Get the parameters that may be appended to URL
386  * @param object $config url module config options
387  * @return array array describing opt groups
388  */
389 function url_get_variable_options($config) {
390     global $CFG;
392     $options = array();
393     $options[''] = array('' => get_string('chooseavariable', 'url'));
395     $options[get_string('course')] = array(
396         'courseid'        => 'id',
397         'coursefullname'  => get_string('fullnamecourse'),
398         'courseshortname' => get_string('shortnamecourse'),
399         'courseidnumber'  => get_string('idnumbercourse'),
400         'coursesummary'   => get_string('summary'),
401         'courseformat'    => get_string('format'),
402     );
404     $options[get_string('modulename', 'url')] = array(
405         'urlinstance'     => 'id',
406         'urlcmid'         => 'cmid',
407         'urlname'         => get_string('name'),
408         'urlidnumber'     => get_string('idnumbermod'),
409     );
411     $options[get_string('miscellaneous')] = array(
412         'sitename'        => get_string('fullsitename'),
413         'serverurl'       => get_string('serverurl', 'url'),
414         'currenttime'     => get_string('time'),
415         'lang'            => get_string('language'),
416     );
417     if (!empty($config->secretphrase)) {
418         $options[get_string('miscellaneous')]['encryptedcode'] = get_string('encryptedcode');
419     }
421     $options[get_string('user')] = array(
422         'userid'          => 'id',
423         'userusername'    => get_string('username'),
424         'useridnumber'    => get_string('idnumber'),
425         'userfirstname'   => get_string('firstname'),
426         'userlastname'    => get_string('lastname'),
427         'userfullname'    => get_string('fullnameuser'),
428         'useremail'       => get_string('email'),
429         'usericq'         => get_string('icqnumber'),
430         'userphone1'      => get_string('phone').' 1',
431         'userphone2'      => get_string('phone2').' 2',
432         'userinstitution' => get_string('institution'),
433         'userdepartment'  => get_string('department'),
434         'useraddress'     => get_string('address'),
435         'usercity'        => get_string('city'),
436         'usertimezone'    => get_string('timezone'),
437         'userurl'         => get_string('webpage'),
438     );
440     if ($config->rolesinparams) {
441         $roles = get_all_roles();
442         $roleoptions = array();
443         foreach ($roles as $role) {
444             $roleoptions['course'.$role->shortname] = get_string('yourwordforx', '', $role->name);
445         }
446         $options[get_string('roles')] = $roleoptions;
447     }
449     return $options;
452 /**
453  * Get the parameter values that may be appended to URL
454  * @param object $url module instance
455  * @param object $cm
456  * @param object $course
457  * @param object $config module config options
458  * @return array of parameter values
459  */
460 function url_get_variable_values($url, $cm, $course, $config) {
461     global $USER, $CFG;
463     $site = get_site();
465     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
467     $values = array (
468         'courseid'        => $course->id,
469         'coursefullname'  => format_string($course->fullname),
470         'courseshortname' => format_string($course->shortname, true, array('context' => $coursecontext)),
471         'courseidnumber'  => $course->idnumber,
472         'coursesummary'   => $course->summary,
473         'courseformat'    => $course->format,
474         'lang'            => current_language(),
475         'sitename'        => format_string($site->fullname),
476         'serverurl'       => $CFG->wwwroot,
477         'currenttime'     => time(),
478         'urlinstance'     => $url->id,
479         'urlcmid'         => $cm->id,
480         'urlname'         => format_string($url->name),
481         'urlidnumber'     => $cm->idnumber,
482     );
484     if (isloggedin()) {
485         $values['userid']          = $USER->id;
486         $values['userusername']    = $USER->username;
487         $values['useridnumber']    = $USER->idnumber;
488         $values['userfirstname']   = $USER->firstname;
489         $values['userlastname']    = $USER->lastname;
490         $values['userfullname']    = fullname($USER);
491         $values['useremail']       = $USER->email;
492         $values['usericq']         = $USER->icq;
493         $values['userphone1']      = $USER->phone1;
494         $values['userphone2']      = $USER->phone2;
495         $values['userinstitution'] = $USER->institution;
496         $values['userdepartment']  = $USER->department;
497         $values['useraddress']     = $USER->address;
498         $values['usercity']        = $USER->city;
499         $values['usertimezone']    = get_user_timezone_offset();
500         $values['userurl']         = $USER->url;
501     }
503     // weak imitation of Single-Sign-On, for backwards compatibility only
504     // NOTE: login hack is not included in 2.0 any more, new contrib auth plugin
505     //       needs to be createed if somebody needs the old functionality!
506     if (!empty($config->secretphrase)) {
507         $values['encryptedcode'] = url_get_encrypted_parameter($url, $config);
508     }
510     //hmm, this is pretty fragile and slow, why do we need it here??
511     if ($config->rolesinparams) {
512         $roles = get_all_roles();
513         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
514         $roles = role_fix_names($roles, $coursecontext, ROLENAME_ALIAS);
515         foreach ($roles as $role) {
516             $values['course'.$role->shortname] = $role->localname;
517         }
518     }
520     return $values;
523 /**
524  * BC internal function
525  * @param object $url
526  * @param object $config
527  * @return string
528  */
529 function url_get_encrypted_parameter($url, $config) {
530     global $CFG;
532     if (file_exists("$CFG->dirroot/local/externserverfile.php")) {
533         require_once("$CFG->dirroot/local/externserverfile.php");
534         if (function_exists('extern_server_file')) {
535             return extern_server_file($url, $config);
536         }
537     }
538     return md5(getremoteaddr().$config->secretphrase);
541 /**
542  * Optimised mimetype detection from general URL
543  * @param $fullurl
544  * @return string mimetype
545  */
546 function url_guess_icon($fullurl) {
547     global $CFG;
548     require_once("$CFG->libdir/filelib.php");
550     if (substr_count($fullurl, '/') < 3 or substr($fullurl, -1) === '/') {
551         // most probably default directory - index.php, index.html, etc.
552         return 'f/web';
553     }
555     $icon = mimeinfo('icon', $fullurl);
556     $icon = 'f/'.str_replace(array('.gif', '.png'), '', $icon);
558     if ($icon === 'f/html' or $icon === 'f/unknown') {
559         $icon = 'f/web';
560     }
562     return $icon;