mod/url/locallib.php

   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 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  */
  26
  27 defined('MOODLE_INTERNAL') || die;
  28
  29 require_once("$CFG->libdir/filelib.php");
  30 require_once("$CFG->libdir/resourcelib.php");
  31 require_once("$CFG->dirroot/mod/url/lib.php");
  32
  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) {
  41
  42     $parameters = empty($url->parameters) ? array() : unserialize($url->parameters);
  43
  44     if (empty($parameters)) {
  45         // easy - no params
  46         return $url->externalurl;
  47     }
  48
  49     if (!$config) {
  50         $config = get_config('url');
  51     }
  52     $paramvalues = url_get_variable_values($url, $cm, $course, $config);
  53
  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     }
  61
  62     if (empty($parameters)) {
  63         // easy - no params available
  64         return $url->externalurl;
  65     }
  66
  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 }
  74
  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;
  84
  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 }
  90
  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;
 101
 102     $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
 103
 104     if ($ignoresettings or !empty($options['printheading'])) {
 105         echo $OUTPUT->heading(format_string($url->name), 2, 'main', 'urlheading');
 106     }
 107 }
 108
 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;
 119
 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     }
 128 }
 129
 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;
 139
 140     $frame = optional_param('frameset', 'main', PARAM_ALPHA);
 141
 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;
 149
 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         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
 156         $courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
 157         $title = strip_tags($courseshortname.': '.format_string($url->name));
 158         $framesize = $config->framesize;
 159         $modulename = s(get_string('modulename','url'));
 160         $dir = get_string('thisdirection', 'langconfig');
 161
 162         $extframe = <<<EOF
 163 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
 164 <html dir="$dir">
 165   <head>
 166     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
 167     <title>$title</title>
 168   </head>
 169   <frameset rows="$framesize,*">
 170     <frame src="$navurl" title="$modulename"/>
 171     <frame src="$exteurl" title="$modulename"/>
 172   </frameset>
 173 </html>
 174 EOF;
 175
 176         @header('Content-Type: text/html; charset=utf-8');
 177         echo $extframe;
 178         die;
 179     }
 180 }
 181
 182 /**
 183  * Print url info and link.
 184  * @param object $url
 185  * @param object $cm
 186  * @param object $course
 187  * @return does not return
 188  */
 189 function url_print_workaround($url, $cm, $course) {
 190     global $OUTPUT;
 191
 192     url_print_header($url, $cm, $course);
 193     url_print_heading($url, $cm, $course, true);
 194     url_print_intro($url, $cm, $course, true);
 195
 196     $fullurl = url_get_full_url($url, $cm, $course);
 197
 198     $display = url_get_final_display_type($url);
 199     if ($display == RESOURCELIB_DISPLAY_POPUP) {
 200         $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
 201         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
 202         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
 203         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
 204         $extra = "onclick=\"window.open('$fullurl', '', '$wh'); return false;\"";
 205
 206     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
 207         $extra = "onclick=\"this.target='_blank';\"";
 208
 209     } else {
 210         $extra = '';
 211     }
 212
 213     echo '<div class="urlworkaround">';
 214     print_string('clicktoopen', 'url', "<a href=\"$fullurl\" $extra>$fullurl</a>");
 215     echo '</div>';
 216
 217     echo $OUTPUT->footer();
 218     die;
 219 }
 220
 221 /**
 222  * Display embedded url file.
 223  * @param object $url
 224  * @param object $cm
 225  * @param object $course
 226  * @param stored_file $file main file
 227  * @return does not return
 228  */
 229 function url_display_embed($url, $cm, $course) {
 230     global $CFG, $PAGE, $OUTPUT;
 231
 232     $mimetype = resourcelib_guess_url_mimetype($url->externalurl);
 233     $fullurl  = url_get_full_url($url, $cm, $course);
 234     $title    = $url->name;
 235
 236     $link = html_writer::tag('a', $fullurl, array('href'=>str_replace('&amp;', '&', $fullurl)));
 237     $clicktoopen = get_string('clicktoopen', 'url', $link);
 238
 239     $extension = resourcelib_get_extension($url->externalurl);
 240
 241     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
 242         $code = resourcelib_embed_image($fullurl, $title);
 243
 244     } else if ($mimetype == 'audio/mp3') {
 245         // MP3 audio file
 246         $code = resourcelib_embed_mp3($fullurl, $title, $clicktoopen);
 247
 248     } else if ($mimetype == 'video/x-flv' or $extension === 'f4v') {
 249         // Flash video file
 250         $code = resourcelib_embed_flashvideo($fullurl, $title, $clicktoopen);
 251
 252     } else if ($mimetype == 'application/x-shockwave-flash') {
 253         // Flash file
 254         $code = resourcelib_embed_flash($fullurl, $title, $clicktoopen);
 255
 256     } else if (substr($mimetype, 0, 10) == 'video/x-ms') {
 257         // Windows Media Player file
 258         $code = resourcelib_embed_mediaplayer($fullurl, $title, $clicktoopen);
 259
 260     } else if ($mimetype == 'video/quicktime') {
 261         // Quicktime file
 262         $code = resourcelib_embed_quicktime($fullurl, $title, $clicktoopen);
 263
 264     } else if ($mimetype == 'video/mpeg') {
 265         // Mpeg file
 266         $code = resourcelib_embed_mpeg($fullurl, $title, $clicktoopen);
 267
 268     } else if ($mimetype == 'audio/x-pn-realaudio-plugin') {
 269         // RealMedia file
 270         $code = resourcelib_embed_real($fullurl, $title, $clicktoopen);
 271
 272     } else {
 273         // anything else - just try object tag enlarged as much as possible
 274         $code = resourcelib_embed_general($fullurl, $title, $clicktoopen, $mimetype);
 275     }
 276
 277     url_print_header($url, $cm, $course);
 278     url_print_heading($url, $cm, $course);
 279
 280     echo $code;
 281
 282     url_print_intro($url, $cm, $course);
 283
 284     echo $OUTPUT->footer();
 285     die;
 286 }
 287
 288 /**
 289  * Decide the best diaply format.
 290  * @param object $url
 291  * @return int display type constant
 292  */
 293 function url_get_final_display_type($url) {
 294     global $CFG;
 295
 296     if ($url->display != RESOURCELIB_DISPLAY_AUTO) {
 297         return $url->display;
 298     }
 299
 300     // detect links to local moodle pages
 301     if (strpos($url->externalurl, $CFG->wwwroot) === 0) {
 302         if (strpos($url->externalurl, 'file.php') === false and strpos($url->externalurl, '.php') !== false ) {
 303             // most probably our moodle page with navigation
 304             return RESOURCELIB_DISPLAY_OPEN;
 305         }
 306     }
 307
 308     static $download = array('application/zip', 'application/x-tar', 'application/g-zip',     // binary formats
 309                              'application/pdf', 'text/html');  // these are known to cause trouble for external links, sorry
 310     static $embed    = array('image/gif', 'image/jpeg', 'image/png', 'image/svg+xml',         // images
 311                              'application/x-shockwave-flash', 'video/x-flv', 'video/x-ms-wm', // video formats
 312                              'video/quicktime', 'video/mpeg', 'video/mp4',
 313                              'audio/mp3', 'audio/x-realaudio-plugin', 'x-realaudio-plugin',   // audio formats,
 314                             );
 315
 316     $mimetype = resourcelib_guess_url_mimetype($url->externalurl);
 317
 318     if (in_array($mimetype, $download)) {
 319         return RESOURCELIB_DISPLAY_DOWNLOAD;
 320     }
 321     if (in_array($mimetype, $embed)) {
 322         return RESOURCELIB_DISPLAY_EMBED;
 323     }
 324
 325     // let the browser deal with it somehow
 326     return RESOURCELIB_DISPLAY_OPEN;
 327 }
 328
 329 /**
 330  * Get the parameters that may be appended to URL
 331  * @param object $config url module config options
 332  * @return array array describing opt groups
 333  */
 334 function url_get_variable_options($config) {
 335     global $CFG;
 336
 337     $options = array();
 338     $options[''] = array('' => get_string('chooseavariable', 'url'));
 339
 340     $options[get_string('course')] = array(
 341         'courseid'        => 'id',
 342         'coursefullname'  => get_string('fullnamecourse'),
 343         'courseshortname' => get_string('shortnamecourse'),
 344         'courseidnumber'  => get_string('idnumbercourse'),
 345         'coursesummary'   => get_string('summary'),
 346         'courseformat'    => get_string('format'),
 347     );
 348
 349     $options[get_string('modulename', 'url')] = array(
 350         'urlinstance'     => 'id',
 351         'urlcmid'         => 'cmid',
 352         'urlname'         => get_string('name'),
 353         'urlidnumber'     => get_string('idnumbermod'),
 354     );
 355
 356     $options[get_string('miscellaneous')] = array(
 357         'sitename'        => get_string('fullsitename'),
 358         'serverurl'       => get_string('serverurl', 'url'),
 359         'currenttime'     => get_string('time'),
 360         'lang'            => get_string('language'),
 361     );
 362     if (!empty($config->secretphrase)) {
 363         $options[get_string('miscellaneous')]['encryptedcode'] = get_string('encryptedcode');
 364     }
 365
 366     $options[get_string('user')] = array(
 367         'userid'          => 'id',
 368         'userusername'    => get_string('username'),
 369         'useridnumber'    => get_string('idnumber'),
 370         'userfirstname'   => get_string('firstname'),
 371         'userlastname'    => get_string('lastname'),
 372         'userfullname'    => get_string('fullnameuser'),
 373         'useremail'       => get_string('email'),
 374         'usericq'         => get_string('icqnumber'),
 375         'userphone1'      => get_string('phone').' 1',
 376         'userphone2'      => get_string('phone2').' 2',
 377         'userinstitution' => get_string('institution'),
 378         'userdepartment'  => get_string('department'),
 379         'useraddress'     => get_string('address'),
 380         'usercity'        => get_string('city'),
 381         'usertimezone'    => get_string('timezone'),
 382         'userurl'         => get_string('webpage'),
 383     );
 384
 385     if ($config->rolesinparams) {
 386         $roles = get_all_roles();
 387         $roleoptions = array();
 388         foreach ($roles as $role) {
 389             $roleoptions['course'.$role->shortname] = get_string('yourwordforx', '', $role->name);
 390         }
 391         $options[get_string('roles')] = $roleoptions;
 392     }
 393
 394     return $options;
 395 }
 396
 397 /**
 398  * Get the parameter values that may be appended to URL
 399  * @param object $url module instance
 400  * @param object $cm
 401  * @param object $course
 402  * @param object $config module config options
 403  * @return array of parameter values
 404  */
 405 function url_get_variable_values($url, $cm, $course, $config) {
 406     global $USER, $CFG;
 407
 408     $site = get_site();
 409
 410     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
 411
 412     $values = array (
 413         'courseid'        => $course->id,
 414         'coursefullname'  => format_string($course->fullname),
 415         'courseshortname' => format_string($course->shortname, true, array('context' => $coursecontext)),
 416         'courseidnumber'  => $course->idnumber,
 417         'coursesummary'   => $course->summary,
 418         'courseformat'    => $course->format,
 419         'lang'            => current_language(),
 420         'sitename'        => format_string($site->fullname),
 421         'serverurl'       => $CFG->wwwroot,
 422         'currenttime'     => time(),
 423         'urlinstance'     => $url->id,
 424         'urlcmid'         => $cm->id,
 425         'urlname'         => format_string($url->name),
 426         'urlidnumber'     => $cm->idnumber,
 427     );
 428
 429     if (isloggedin()) {
 430         $values['userid']          = $USER->id;
 431         $values['userusername']    = $USER->username;
 432         $values['useridnumber']    = $USER->idnumber;
 433         $values['userfirstname']   = $USER->firstname;
 434         $values['userlastname']    = $USER->lastname;
 435         $values['userfullname']    = fullname($USER);
 436         $values['useremail']       = $USER->email;
 437         $values['usericq']         = $USER->icq;
 438         $values['userphone1']      = $USER->phone1;
 439         $values['userphone2']      = $USER->phone2;
 440         $values['userinstitution'] = $USER->institution;
 441         $values['userdepartment']  = $USER->department;
 442         $values['useraddress']     = $USER->address;
 443         $values['usercity']        = $USER->city;
 444         $values['usertimezone']    = get_user_timezone_offset();
 445         $values['userurl']         = $USER->url;
 446     }
 447
 448     // weak imitation of Single-Sign-On, for backwards compatibility only
 449     // NOTE: login hack is not included in 2.0 any more, new contrib auth plugin
 450     //       needs to be createed if somebody needs the old functionality!
 451     if (!empty($config->secretphrase)) {
 452         $values['encryptedcode'] = url_get_encrypted_parameter($url, $config);
 453     }
 454
 455     //hmm, this is pretty fragile and slow, why do we need it here??
 456     if ($config->rolesinparams) {
 457         $roles = get_all_roles();
 458         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
 459         $roles = role_fix_names($roles, $coursecontext, ROLENAME_ALIAS);
 460         foreach ($roles as $role) {
 461             $values['course'.$role->shortname] = $role->localname;
 462         }
 463     }
 464
 465     return $values;
 466 }
 467
 468 /**
 469  * BC internal function
 470  * @param object $url
 471  * @param object $config
 472  * @return string
 473  */
 474 function url_get_encrypted_parameter($url, $config) {
 475     global $CFG;
 476
 477     if (file_exists("$CFG->dirroot/local/externserverfile.php")) {
 478         require_once("$CFG->dirroot/local/externserverfile.php");
 479         if (function_exists('extern_server_file')) {
 480             return extern_server_file($url, $config);
 481         }
 482     }
 483     return md5(getremoteaddr().$config->secretphrase);
 484 }
 485
 486 /**
 487  * Optimised mimetype detection from general URL
 488  * @param $fullurl
 489  * @return string mimetype
 490  */
 491 function url_guess_icon($fullurl) {
 492     global $CFG;
 493     require_once("$CFG->libdir/filelib.php");
 494
 495     if (substr_count($fullurl, '/') < 3 or substr($fullurl, -1) === '/') {
 496         // most probably default directory - index.php, index.html, etc.
 497         return 'f/web';
 498     }
 499
 500     $icon = mimeinfo('icon', $fullurl);
 501     $icon = 'f/'.str_replace(array('.gif', '.png'), '', $icon);
 502
 503     if ($icon === 'f/html' or $icon === 'f/unknown') {
 504         $icon = 'f/web';
 505     }
 506
 507     return $icon;
 508 }