MDL-27253 add default swf size and allow #d=100x50 URL resizing in mod/url
[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  * Return full url with all extra parameters
35  * @param string $url
36  * @param object $cm
37  * @param object $course
38  * @return string url
39  */
40 function url_get_full_url($url, $cm, $course, $config=null) {
42     $parameters = empty($url->parameters) ? array() : unserialize($url->parameters);
44     if (empty($parameters)) {
45         // easy - no params
46         return $url->externalurl;
47     }
49     if (!$config) {
50         $config = get_config('url');
51     }
52     $paramvalues = url_get_variable_values($url, $cm, $course, $config);
54     foreach ($parameters as $parse=>$parameter) {
55         if (isset($paramvalues[$parameter])) {
56             $parameters[$parse] = urlencode($parse).'='.urlencode($paramvalues[$parameter]);
57         } else {
58             unset($parameters[$parse]);
59         }
60     }
62     if (empty($parameters)) {
63         // easy - no params available
64         return $url->externalurl;
65     }
67     if (stripos($url->externalurl, 'teamspeak://') === 0) {
68         return $url->externalurl.'?'.implode('?', $parameters);
69     } else {
70         $join = (strpos($url->externalurl, '?') === false) ? '?' : '&amp;';
71         return $url->externalurl.$join.implode('&amp;', $parameters);
72     }
73 }
75 /**
76  * Print url header.
77  * @param object $url
78  * @param object $cm
79  * @param object $course
80  * @return void
81  */
82 function url_print_header($url, $cm, $course) {
83     global $PAGE, $OUTPUT;
85     $PAGE->set_title($course->shortname.': '.$url->name);
86     $PAGE->set_heading($course->fullname);
87     $PAGE->set_activity_record($url);
88     echo $OUTPUT->header();
89 }
91 /**
92  * Print url heading.
93  * @param object $url
94  * @param object $cm
95  * @param object $course
96  * @param bool $ignoresettings print even if not specified in modedit
97  * @return void
98  */
99 function url_print_heading($url, $cm, $course, $ignoresettings=false) {
100     global $OUTPUT;
102     $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
104     if ($ignoresettings or !empty($options['printheading'])) {
105         echo $OUTPUT->heading(format_string($url->name), 2, 'main', 'urlheading');
106     }
109 /**
110  * Print url introduction.
111  * @param object $url
112  * @param object $cm
113  * @param object $course
114  * @param bool $ignoresettings print even if not specified in modedit
115  * @return void
116  */
117 function url_print_intro($url, $cm, $course, $ignoresettings=false) {
118     global $OUTPUT;
120     $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
121     if ($ignoresettings or !empty($options['printintro'])) {
122         if (trim(strip_tags($url->intro))) {
123             echo $OUTPUT->box_start('mod_introbox', 'urlintro');
124             echo format_module_intro('url', $url, $cm->id);
125             echo $OUTPUT->box_end();
126         }
127     }
130 /**
131  * Display url frames.
132  * @param object $url
133  * @param object $cm
134  * @param object $course
135  * @return does not return
136  */
137 function url_display_frame($url, $cm, $course) {
138     global $PAGE, $OUTPUT, $CFG;
140     $frame = optional_param('frameset', 'main', PARAM_ALPHA);
142     if ($frame === 'top') {
143         $PAGE->set_pagelayout('frametop');
144         url_print_header($url, $cm, $course);
145         url_print_heading($url, $cm, $course);
146         url_print_intro($url, $cm, $course);
147         echo $OUTPUT->footer();
148         die;
150     } else {
151         $config = get_config('url');
152         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
153         $exteurl = url_get_full_url($url, $cm, $course, $config);
154         $navurl = "$CFG->wwwroot/mod/url/view.php?id=$cm->id&amp;frameset=top";
155         $title = strip_tags(format_string($course->shortname.': '.$url->name));
156         $framesize = $config->framesize;
157         $modulename = s(get_string('modulename','url'));
158         $dir = get_string('thisdirection', 'langconfig');
160         $extframe = <<<EOF
161 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
162 <html dir="$dir">
163   <head>
164     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
165     <title>$title</title>
166   </head>
167   <frameset rows="$framesize,*">
168     <frame src="$navurl" title="$modulename"/>
169     <frame src="$exteurl" title="$modulename"/>
170   </frameset>
171 </html>
172 EOF;
174         @header('Content-Type: text/html; charset=utf-8');
175         echo $extframe;
176         die;
177     }
180 /**
181  * Print url info and link.
182  * @param object $url
183  * @param object $cm
184  * @param object $course
185  * @return does not return
186  */
187 function url_print_workaround($url, $cm, $course) {
188     global $OUTPUT;
190     url_print_header($url, $cm, $course);
191     url_print_heading($url, $cm, $course, true);
192     url_print_intro($url, $cm, $course, true);
194     $fullurl = url_get_full_url($url, $cm, $course);
196     $display = url_get_final_display_type($url);
197     if ($display == RESOURCELIB_DISPLAY_POPUP) {
198         $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
199         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
200         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
201         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
202         $extra = "onclick=\"window.open('$fullurl', '', '$wh'); return false;\"";
204     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
205         $extra = "onclick=\"this.target='_blank';\"";
207     } else {
208         $extra = '';
209     }
211     echo '<div class="urlworkaround">';
212     print_string('clicktoopen', 'url', "<a href=\"$fullurl\" $extra>$fullurl</a>");
213     echo '</div>';
215     echo $OUTPUT->footer();
216     die;
219 /**
220  * Display embedded url file.
221  * @param object $url
222  * @param object $cm
223  * @param object $course
224  * @param stored_file $file main file
225  * @return does not return
226  */
227 function url_display_embed($url, $cm, $course) {
228     global $CFG, $PAGE, $OUTPUT;
230     $mimetype = resourcelib_guess_url_mimetype($url->externalurl);
231     $fullurl  = url_get_full_url($url, $cm, $course);
232     $title    = $url->name;
234     $link = html_writer::tag('a', $fullurl, array('href'=>str_replace('&amp;', '&', $fullurl)));
235     $clicktoopen = get_string('clicktoopen', 'url', $link);
237     $extension = resourcelib_get_extension($url->externalurl);
239     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
240         $code = resourcelib_embed_image($fullurl, $title);
242     } else if ($mimetype == 'audio/mp3') {
243         // MP3 audio file
244         $code = resourcelib_embed_mp3($fullurl, $title, $clicktoopen);
246     } else if ($mimetype == 'video/x-flv' or $extension === 'f4v') {
247         // Flash video file
248         $code = resourcelib_embed_flashvideo($fullurl, $title, $clicktoopen);
250     } else if ($mimetype == 'application/x-shockwave-flash') {
251         // Flash file
252         $code = resourcelib_embed_flash($fullurl, $title, $clicktoopen);
254     } else if (substr($mimetype, 0, 10) == 'video/x-ms') {
255         // Windows Media Player file
256         $code = resourcelib_embed_mediaplayer($fullurl, $title, $clicktoopen);
258     } else if ($mimetype == 'video/quicktime') {
259         // Quicktime file
260         $code = resourcelib_embed_quicktime($fullurl, $title, $clicktoopen);
262     } else if ($mimetype == 'video/mpeg') {
263         // Mpeg file
264         $code = resourcelib_embed_mpeg($fullurl, $title, $clicktoopen);
266     } else if ($mimetype == 'audio/x-pn-realaudio-plugin') {
267         // RealMedia file
268         $code = resourcelib_embed_real($fullurl, $title, $clicktoopen);
270     } else {
271         // anything else - just try object tag enlarged as much as possible
272         $code = resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype);
273     }
275     url_print_header($url, $cm, $course);
276     url_print_heading($url, $cm, $course);
278     echo $code;
280     url_print_intro($url, $cm, $course);
282     echo $OUTPUT->footer();
283     die;
286 /**
287  * Decide the best diaply format.
288  * @param object $url
289  * @return int display type constant
290  */
291 function url_get_final_display_type($url) {
292     global $CFG;
294     if ($url->display != RESOURCELIB_DISPLAY_AUTO) {
295         return $url->display;
296     }
298     // detect links to local moodle pages
299     if (strpos($url->externalurl, $CFG->wwwroot) === 0) {
300         if (strpos($url->externalurl, 'file.php') === false and strpos($url->externalurl, '.php') !== false ) {
301             // most probably our moodle page with navigation
302             return RESOURCELIB_DISPLAY_OPEN;
303         }
304     }
306     static $download = array('application/zip', 'application/x-tar', 'application/g-zip',     // binary formats
307                              'application/pdf', 'text/html');  // these are known to cause trouble for external links, sorry
308     static $embed    = array('image/gif', 'image/jpeg', 'image/png', 'image/svg+xml',         // images
309                              'application/x-shockwave-flash', 'video/x-flv', 'video/x-ms-wm', // video formats
310                              'video/quicktime', 'video/mpeg', 'video/mp4',
311                              'audio/mp3', 'audio/x-realaudio-plugin', 'x-realaudio-plugin',   // audio formats,
312                             );
314     $mimetype = resourcelib_guess_url_mimetype($url->externalurl);
316     if (in_array($mimetype, $download)) {
317         return RESOURCELIB_DISPLAY_DOWNLOAD;
318     }
319     if (in_array($mimetype, $embed)) {
320         return RESOURCELIB_DISPLAY_EMBED;
321     }
323     // let the browser deal with it somehow
324     return RESOURCELIB_DISPLAY_OPEN;
327 /**
328  * Get the parameters that may be appended to URL
329  * @param object $config url module config options
330  * @return array array describing opt groups
331  */
332 function url_get_variable_options($config) {
333     global $CFG;
335     $options = array();
336     $options[''] = array('' => get_string('chooseavariable', 'url'));
338     $options[get_string('course')] = array(
339         'courseid'        => 'id',
340         'coursefullname'  => get_string('fullnamecourse'),
341         'courseshortname' => get_string('shortnamecourse'),
342         'courseidnumber'  => get_string('idnumbercourse'),
343         'coursesummary'   => get_string('summary'),
344         'courseformat'    => get_string('format'),
345     );
347     $options[get_string('modulename', 'url')] = array(
348         'urlinstance'     => 'id',
349         'urlcmid'         => 'cmid',
350         'urlname'         => get_string('name'),
351         'urlidnumber'     => get_string('idnumbermod'),
352     );
354     $options[get_string('miscellaneous')] = array(
355         'sitename'        => get_string('fullsitename'),
356         'serverurl'       => get_string('serverurl', 'url'),
357         'currenttime'     => get_string('time'),
358         'lang'            => get_string('language'),
359     );
360     if (!empty($config->secretphrase)) {
361         $options[get_string('miscellaneous')]['encryptedcode'] = get_string('encryptedcode');
362     }
364     $options[get_string('user')] = array(
365         'userid'          => 'id',
366         'userusername'    => get_string('username'),
367         'useridnumber'    => get_string('idnumber'),
368         'userfirstname'   => get_string('firstname'),
369         'userlastname'    => get_string('lastname'),
370         'userfullname'    => get_string('fullnameuser'),
371         'useremail'       => get_string('email'),
372         'usericq'         => get_string('icqnumber'),
373         'userphone1'      => get_string('phone').' 1',
374         'userphone2'      => get_string('phone2').' 2',
375         'userinstitution' => get_string('institution'),
376         'userdepartment'  => get_string('department'),
377         'useraddress'     => get_string('address'),
378         'usercity'        => get_string('city'),
379         'usertimezone'    => get_string('timezone'),
380         'userurl'         => get_string('webpage'),
381     );
383     if ($config->rolesinparams) {
384         $roles = get_all_roles();
385         $roleoptions = array();
386         foreach ($roles as $role) {
387             $roleoptions['course'.$role->shortname] = get_string('yourwordforx', '', $role->name);
388         }
389         $options[get_string('roles')] = $roleoptions;
390     }
392     return $options;
395 /**
396  * Get the parameter values that may be appended to URL
397  * @param object $url module instance
398  * @param object $cm
399  * @param object $course
400  * @param object $config module config options
401  * @return array of parameter values
402  */
403 function url_get_variable_values($url, $cm, $course, $config) {
404     global $USER, $CFG;
406     $site = get_site();
408     $values = array (
409         'courseid'        => $course->id,
410         'coursefullname'  => format_string($course->fullname),
411         'courseshortname' => $course->shortname,
412         'courseidnumber'  => $course->idnumber,
413         'coursesummary'   => $course->summary,
414         'courseformat'    => $course->format,
415         'lang'            => current_language(),
416         'sitename'        => format_string($site->fullname),
417         'serverurl'       => $CFG->wwwroot,
418         'currenttime'     => time(),
419         'urlinstance'     => $url->id,
420         'urlcmid'         => $cm->id,
421         'urlname'         => format_string($url->name),
422         'urlidnumber'     => $cm->idnumber,
423     );
425     if (isloggedin()) {
426         $values['userid']          = $USER->id;
427         $values['userusername']    = $USER->username;
428         $values['useridnumber']    = $USER->idnumber;
429         $values['userfirstname']   = $USER->firstname;
430         $values['userlastname']    = $USER->lastname;
431         $values['userfullname']    = fullname($USER);
432         $values['useremail']       = $USER->email;
433         $values['usericq']         = $USER->icq;
434         $values['userphone1']      = $USER->phone1;
435         $values['userphone2']      = $USER->phone2;
436         $values['userinstitution'] = $USER->institution;
437         $values['userdepartment']  = $USER->department;
438         $values['useraddress']     = $USER->address;
439         $values['usercity']        = $USER->city;
440         $values['usertimezone']    = get_user_timezone_offset();
441         $values['userurl']         = $USER->url;
442     }
444     // weak imitation of Single-Sign-On, for backwards compatibility only
445     // NOTE: login hack is not included in 2.0 any more, new contrib auth plugin
446     //       needs to be createed if somebody needs the old functionality!
447     if (!empty($config->secretphrase)) {
448         $values['encryptedcode'] = url_get_encrypted_parameter($url, $config);
449     }
451     //hmm, this is pretty fragile and slow, why do we need it here??
452     if ($config->rolesinparams) {
453         $roles = get_all_roles();
454         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
455         $roles = role_fix_names($roles, $coursecontext, ROLENAME_ALIAS);
456         foreach ($roles as $role) {
457             $values['course'.$role->shortname] = $role->localname;
458         }
459     }
461     return $values;
464 /**
465  * BC internal function
466  * @param object $url
467  * @param object $config
468  * @return string
469  */
470 function url_get_encrypted_parameter($url, $config) {
471     global $CFG;
473     if (file_exists("$CFG->dirroot/local/externserverfile.php")) {
474         require_once("$CFG->dirroot/local/externserverfile.php");
475         if (function_exists('extern_server_file')) {
476             return extern_server_file($url, $config);
477         }
478     }
479     return md5(getremoteaddr().$config->secretphrase);
482 /**
483  * Optimised mimetype detection from general URL
484  * @param $fullurl
485  * @return string mimetype
486  */
487 function url_guess_icon($fullurl) {
488     global $CFG;
489     require_once("$CFG->libdir/filelib.php");
491     if (substr_count($fullurl, '/') < 3 or substr($fullurl, -1) === '/') {
492         // most probably default directory - index.php, index.html, etc.
493         return 'f/web';
494     }
496     $icon = mimeinfo('icon', $fullurl);
497     $icon = 'f/'.str_replace(array('.gif', '.png'), '', $icon);
499     if ($icon === 'f/html' or $icon === 'f/unknown') {
500         $icon = 'f/web';
501     }
503     return $icon;