mod/url/lib.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  * Mandatory public API of url module
  20  *
  21  * @package    mod_url
  22  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die;
  27
  28 /**
  29  * List of features supported in URL module
  30  * @param string $feature FEATURE_xx constant for requested feature
  31  * @return mixed True if module supports feature, false if not, null if doesn't know
  32  */
  33 function url_supports($feature) {
  34     switch($feature) {
  35         case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
  36         case FEATURE_GROUPS:                  return false;
  37         case FEATURE_GROUPINGS:               return false;
  38         case FEATURE_MOD_INTRO:               return true;
  39         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
  40         case FEATURE_GRADE_HAS_GRADE:         return false;
  41         case FEATURE_GRADE_OUTCOMES:          return false;
  42         case FEATURE_BACKUP_MOODLE2:          return true;
  43         case FEATURE_SHOW_DESCRIPTION:        return true;
  44
  45         default: return null;
  46     }
  47 }
  48
  49 /**
  50  * This function is used by the reset_course_userdata function in moodlelib.
  51  * @param $data the data submitted from the reset course.
  52  * @return array status array
  53  */
  54 function url_reset_userdata($data) {
  55
  56     // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
  57     // See MDL-9367.
  58
  59     return array();
  60 }
  61
  62 /**
  63  * List the actions that correspond to a view of this module.
  64  * This is used by the participation report.
  65  *
  66  * Note: This is not used by new logging system. Event with
  67  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
  68  *       be considered as view action.
  69  *
  70  * @return array
  71  */
  72 function url_get_view_actions() {
  73     return array('view', 'view all');
  74 }
  75
  76 /**
  77  * List the actions that correspond to a post of this module.
  78  * This is used by the participation report.
  79  *
  80  * Note: This is not used by new logging system. Event with
  81  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
  82  *       will be considered as post action.
  83  *
  84  * @return array
  85  */
  86 function url_get_post_actions() {
  87     return array('update', 'add');
  88 }
  89
  90 /**
  91  * Add url instance.
  92  * @param object $data
  93  * @param object $mform
  94  * @return int new url instance id
  95  */
  96 function url_add_instance($data, $mform) {
  97     global $CFG, $DB;
  98
  99     require_once($CFG->dirroot.'/mod/url/locallib.php');
 100
 101     $parameters = array();
 102     for ($i=0; $i < 100; $i++) {
 103         $parameter = "parameter_$i";
 104         $variable  = "variable_$i";
 105         if (empty($data->$parameter) or empty($data->$variable)) {
 106             continue;
 107         }
 108         $parameters[$data->$parameter] = $data->$variable;
 109     }
 110     $data->parameters = serialize($parameters);
 111
 112     $displayoptions = array();
 113     if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
 114         $displayoptions['popupwidth']  = $data->popupwidth;
 115         $displayoptions['popupheight'] = $data->popupheight;
 116     }
 117     if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
 118         $displayoptions['printintro']   = (int)!empty($data->printintro);
 119     }
 120     $data->displayoptions = serialize($displayoptions);
 121
 122     $data->externalurl = url_fix_submitted_url($data->externalurl);
 123
 124     $data->timemodified = time();
 125     $data->id = $DB->insert_record('url', $data);
 126
 127     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
 128     \core_completion\api::update_completion_date_event($data->coursemodule, 'url', $data->id, $completiontimeexpected);
 129
 130     return $data->id;
 131 }
 132
 133 /**
 134  * Update url instance.
 135  * @param object $data
 136  * @param object $mform
 137  * @return bool true
 138  */
 139 function url_update_instance($data, $mform) {
 140     global $CFG, $DB;
 141
 142     require_once($CFG->dirroot.'/mod/url/locallib.php');
 143
 144     $parameters = array();
 145     for ($i=0; $i < 100; $i++) {
 146         $parameter = "parameter_$i";
 147         $variable  = "variable_$i";
 148         if (empty($data->$parameter) or empty($data->$variable)) {
 149             continue;
 150         }
 151         $parameters[$data->$parameter] = $data->$variable;
 152     }
 153     $data->parameters = serialize($parameters);
 154
 155     $displayoptions = array();
 156     if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
 157         $displayoptions['popupwidth']  = $data->popupwidth;
 158         $displayoptions['popupheight'] = $data->popupheight;
 159     }
 160     if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
 161         $displayoptions['printintro']   = (int)!empty($data->printintro);
 162     }
 163     $data->displayoptions = serialize($displayoptions);
 164
 165     $data->externalurl = url_fix_submitted_url($data->externalurl);
 166
 167     $data->timemodified = time();
 168     $data->id           = $data->instance;
 169
 170     $DB->update_record('url', $data);
 171
 172     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
 173     \core_completion\api::update_completion_date_event($data->coursemodule, 'url', $data->id, $completiontimeexpected);
 174
 175     return true;
 176 }
 177
 178 /**
 179  * Delete url instance.
 180  * @param int $id
 181  * @return bool true
 182  */
 183 function url_delete_instance($id) {
 184     global $DB;
 185
 186     if (!$url = $DB->get_record('url', array('id'=>$id))) {
 187         return false;
 188     }
 189
 190     $cm = get_coursemodule_from_instance('url', $id);
 191     \core_completion\api::update_completion_date_event($cm->id, 'url', $id, null);
 192
 193     // note: all context files are deleted automatically
 194
 195     $DB->delete_records('url', array('id'=>$url->id));
 196
 197     return true;
 198 }
 199
 200 /**
 201  * Given a course_module object, this function returns any
 202  * "extra" information that may be needed when printing
 203  * this activity in a course listing.
 204  *
 205  * See {@link get_array_of_activities()} in course/lib.php
 206  *
 207  * @param object $coursemodule
 208  * @return cached_cm_info info
 209  */
 210 function url_get_coursemodule_info($coursemodule) {
 211     global $CFG, $DB;
 212     require_once("$CFG->dirroot/mod/url/locallib.php");
 213
 214     if (!$url = $DB->get_record('url', array('id'=>$coursemodule->instance),
 215             'id, name, course, display, displayoptions, externalurl, parameters, intro, introformat')) {
 216         return NULL;
 217     }
 218
 219     $info = new cached_cm_info();
 220     $info->name = $url->name;
 221
 222     //note: there should be a way to differentiate links from normal resources
 223     $info->icon = url_guess_icon($url->externalurl, 24);
 224
 225     $display = url_get_final_display_type($url);
 226
 227     if ($display == RESOURCELIB_DISPLAY_POPUP) {
 228         $fullurl = "$CFG->wwwroot/mod/url/view.php?id=$coursemodule->id&amp;redirect=1";
 229         $options = empty($url->displayoptions) ? array() : unserialize($url->displayoptions);
 230         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
 231         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
 232         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
 233         $info->onclick = "window.open('$fullurl', '', '$wh'); return false;";
 234
 235     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
 236         $fullurl = "$CFG->wwwroot/mod/url/view.php?id=$coursemodule->id&amp;redirect=1";
 237         $info->onclick = "window.open('$fullurl'); return false;";
 238
 239     }
 240
 241     if ($coursemodule->showdescription) {
 242         // Convert intro to html. Do not filter cached version, filters run at display time.
 243         $info->content = format_module_intro('url', $url, $coursemodule->id, false);
 244     }
 245
 246     $course = get_course($url->course); // Get cached course.
 247     $info->customdata = array('fullurl' => str_replace('&amp;', '&', url_get_full_url($url, $coursemodule, $course)));
 248
 249     return $info;
 250 }
 251
 252 /**
 253  * Return a list of page types
 254  * @param string $pagetype current page type
 255  * @param stdClass $parentcontext Block's parent context
 256  * @param stdClass $currentcontext Current context of block
 257  */
 258 function url_page_type_list($pagetype, $parentcontext, $currentcontext) {
 259     $module_pagetype = array('mod-url-*'=>get_string('page-mod-url-x', 'url'));
 260     return $module_pagetype;
 261 }
 262
 263 /**
 264  * Export URL resource contents
 265  *
 266  * @return array of file content
 267  */
 268 function url_export_contents($cm, $baseurl) {
 269     global $CFG, $DB;
 270     require_once("$CFG->dirroot/mod/url/locallib.php");
 271     $contents = array();
 272     $context = context_module::instance($cm->id);
 273
 274     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
 275     $urlrecord = $DB->get_record('url', array('id'=>$cm->instance), '*', MUST_EXIST);
 276
 277     $fullurl = str_replace('&amp;', '&', url_get_full_url($urlrecord, $cm, $course));
 278     $isurl = clean_param($fullurl, PARAM_URL);
 279     if (empty($isurl)) {
 280         return null;
 281     }
 282
 283     $url = array();
 284     $url['type'] = 'url';
 285     $url['filename']     = clean_param(format_string($urlrecord->name), PARAM_FILE);
 286     $url['filepath']     = null;
 287     $url['filesize']     = 0;
 288     $url['fileurl']      = $fullurl;
 289     $url['timecreated']  = null;
 290     $url['timemodified'] = $urlrecord->timemodified;
 291     $url['sortorder']    = null;
 292     $url['userid']       = null;
 293     $url['author']       = null;
 294     $url['license']      = null;
 295     $contents[] = $url;
 296
 297     return $contents;
 298 }
 299
 300 /**
 301  * Register the ability to handle drag and drop file uploads
 302  * @return array containing details of the files / types the mod can handle
 303  */
 304 function url_dndupload_register() {
 305     return array('types' => array(
 306                      array('identifier' => 'url', 'message' => get_string('createurl', 'url'))
 307                  ));
 308 }
 309
 310 /**
 311  * Handle a file that has been uploaded
 312  * @param object $uploadinfo details of the file / content that has been uploaded
 313  * @return int instance id of the newly created mod
 314  */
 315 function url_dndupload_handle($uploadinfo) {
 316     // Gather all the required data.
 317     $data = new stdClass();
 318     $data->course = $uploadinfo->course->id;
 319     $data->name = $uploadinfo->displayname;
 320     $data->intro = '<p>'.$uploadinfo->displayname.'</p>';
 321     $data->introformat = FORMAT_HTML;
 322     $data->externalurl = clean_param($uploadinfo->content, PARAM_URL);
 323     $data->timemodified = time();
 324
 325     // Set the display options to the site defaults.
 326     $config = get_config('url');
 327     $data->display = $config->display;
 328     $data->popupwidth = $config->popupwidth;
 329     $data->popupheight = $config->popupheight;
 330     $data->printintro = $config->printintro;
 331
 332     return url_add_instance($data, null);
 333 }
 334
 335 /**
 336  * Mark the activity completed (if required) and trigger the course_module_viewed event.
 337  *
 338  * @param  stdClass $url        url object
 339  * @param  stdClass $course     course object
 340  * @param  stdClass $cm         course module object
 341  * @param  stdClass $context    context object
 342  * @since Moodle 3.0
 343  */
 344 function url_view($url, $course, $cm, $context) {
 345
 346     // Trigger course_module_viewed event.
 347     $params = array(
 348         'context' => $context,
 349         'objectid' => $url->id
 350     );
 351
 352     $event = \mod_url\event\course_module_viewed::create($params);
 353     $event->add_record_snapshot('course_modules', $cm);
 354     $event->add_record_snapshot('course', $course);
 355     $event->add_record_snapshot('url', $url);
 356     $event->trigger();
 357
 358     // Completion.
 359     $completion = new completion_info($course);
 360     $completion->set_module_viewed($cm);
 361 }
 362
 363 /**
 364  * Check if the module has any update that affects the current user since a given time.
 365  *
 366  * @param  cm_info $cm course module data
 367  * @param  int $from the time to check updates from
 368  * @param  array $filter  if we need to check only specific updates
 369  * @return stdClass an object with the different type of areas indicating if they were updated or not
 370  * @since Moodle 3.2
 371  */
 372 function url_check_updates_since(cm_info $cm, $from, $filter = array()) {
 373     $updates = course_check_module_updates_since($cm, $from, array('content'), $filter);
 374     return $updates;
 375 }
 376
 377 /**
 378  * This function receives a calendar event and returns the action associated with it, or null if there is none.
 379  *
 380  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
 381  * is not displayed on the block.
 382  *
 383  * @param calendar_event $event
 384  * @param \core_calendar\action_factory $factory
 385  * @param int $userid ID override for calendar events
 386  * @return \core_calendar\local\event\entities\action_interface|null
 387  */
 388 function mod_url_core_calendar_provide_event_action(calendar_event $event,
 389                                                        \core_calendar\action_factory $factory, $userid = 0) {
 390
 391     global $USER;
 392     if (empty($userid)) {
 393         $userid = $USER->id;
 394     }
 395
 396     $cm = get_fast_modinfo($event->courseid, $userid)->instances['url'][$event->instance];
 397
 398     $completion = new \completion_info($cm->get_course());
 399
 400     $completiondata = $completion->get_data($cm, false, $userid);
 401
 402     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
 403         return null;
 404     }
 405
 406     return $factory->create_instance(
 407         get_string('view'),
 408         new \moodle_url('/mod/url/view.php', ['id' => $cm->id]),
 409         1,
 410         true
 411     );
 412 }