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 or string for the module purpose.
  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         case FEATURE_MOD_PURPOSE:             return MOD_PURPOSE_CONTENT;
  45
  46         default: return null;
  47     }
  48 }
  49
  50 /**
  51  * This function is used by the reset_course_userdata function in moodlelib.
  52  * @param $data the data submitted from the reset course.
  53  * @return array status array
  54  */
  55 function url_reset_userdata($data) {
  56
  57     // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
  58     // See MDL-9367.
  59
  60     return array();
  61 }
  62
  63 /**
  64  * List the actions that correspond to a view of this module.
  65  * This is used by the participation report.
  66  *
  67  * Note: This is not used by new logging system. Event with
  68  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
  69  *       be considered as view action.
  70  *
  71  * @return array
  72  */
  73 function url_get_view_actions() {
  74     return array('view', 'view all');
  75 }
  76
  77 /**
  78  * List the actions that correspond to a post of this module.
  79  * This is used by the participation report.
  80  *
  81  * Note: This is not used by new logging system. Event with
  82  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
  83  *       will be considered as post action.
  84  *
  85  * @return array
  86  */
  87 function url_get_post_actions() {
  88     return array('update', 'add');
  89 }
  90
  91 /**
  92  * Add url instance.
  93  * @param object $data
  94  * @param object $mform
  95  * @return int new url instance id
  96  */
  97 function url_add_instance($data, $mform) {
  98     global $CFG, $DB;
  99
 100     require_once($CFG->dirroot.'/mod/url/locallib.php');
 101
 102     $parameters = array();
 103     for ($i=0; $i < 100; $i++) {
 104         $parameter = "parameter_$i";
 105         $variable  = "variable_$i";
 106         if (empty($data->$parameter) or empty($data->$variable)) {
 107             continue;
 108         }
 109         $parameters[$data->$parameter] = $data->$variable;
 110     }
 111     $data->parameters = serialize($parameters);
 112
 113     $displayoptions = array();
 114     if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
 115         $displayoptions['popupwidth']  = $data->popupwidth;
 116         $displayoptions['popupheight'] = $data->popupheight;
 117     }
 118     if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
 119         $displayoptions['printintro']   = (int)!empty($data->printintro);
 120     }
 121     $data->displayoptions = serialize($displayoptions);
 122
 123     $data->externalurl = url_fix_submitted_url($data->externalurl);
 124
 125     $data->timemodified = time();
 126     $data->id = $DB->insert_record('url', $data);
 127
 128     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
 129     \core_completion\api::update_completion_date_event($data->coursemodule, 'url', $data->id, $completiontimeexpected);
 130
 131     return $data->id;
 132 }
 133
 134 /**
 135  * Update url instance.
 136  * @param object $data
 137  * @param object $mform
 138  * @return bool true
 139  */
 140 function url_update_instance($data, $mform) {
 141     global $CFG, $DB;
 142
 143     require_once($CFG->dirroot.'/mod/url/locallib.php');
 144
 145     $parameters = array();
 146     for ($i=0; $i < 100; $i++) {
 147         $parameter = "parameter_$i";
 148         $variable  = "variable_$i";
 149         if (empty($data->$parameter) or empty($data->$variable)) {
 150             continue;
 151         }
 152         $parameters[$data->$parameter] = $data->$variable;
 153     }
 154     $data->parameters = serialize($parameters);
 155
 156     $displayoptions = array();
 157     if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
 158         $displayoptions['popupwidth']  = $data->popupwidth;
 159         $displayoptions['popupheight'] = $data->popupheight;
 160     }
 161     if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
 162         $displayoptions['printintro']   = (int)!empty($data->printintro);
 163     }
 164     $data->displayoptions = serialize($displayoptions);
 165
 166     $data->externalurl = url_fix_submitted_url($data->externalurl);
 167
 168     $data->timemodified = time();
 169     $data->id           = $data->instance;
 170
 171     $DB->update_record('url', $data);
 172
 173     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
 174     \core_completion\api::update_completion_date_event($data->coursemodule, 'url', $data->id, $completiontimeexpected);
 175
 176     return true;
 177 }
 178
 179 /**
 180  * Delete url instance.
 181  * @param int $id
 182  * @return bool true
 183  */
 184 function url_delete_instance($id) {
 185     global $DB;
 186
 187     if (!$url = $DB->get_record('url', array('id'=>$id))) {
 188         return false;
 189     }
 190
 191     $cm = get_coursemodule_from_instance('url', $id);
 192     \core_completion\api::update_completion_date_event($cm->id, 'url', $id, null);
 193
 194     // note: all context files are deleted automatically
 195
 196     $DB->delete_records('url', array('id'=>$url->id));
 197
 198     return true;
 199 }
 200
 201 /**
 202  * Given a course_module object, this function returns any
 203  * "extra" information that may be needed when printing
 204  * this activity in a course listing.
 205  *
 206  * See {@link course_modinfo::get_array_of_activities()}
 207  *
 208  * @param object $coursemodule
 209  * @return cached_cm_info info
 210  */
 211 function url_get_coursemodule_info($coursemodule) {
 212     global $CFG, $DB;
 213     require_once("$CFG->dirroot/mod/url/locallib.php");
 214
 215     if (!$url = $DB->get_record('url', array('id'=>$coursemodule->instance),
 216             'id, name, display, displayoptions, externalurl, parameters, intro, introformat')) {
 217         return NULL;
 218     }
 219
 220     $info = new cached_cm_info();
 221     $info->name = $url->name;
 222
 223     //note: there should be a way to differentiate links from normal resources
 224     $info->icon = url_guess_icon($url->externalurl, 24);
 225
 226     $display = url_get_final_display_type($url);
 227
 228     if ($display == RESOURCELIB_DISPLAY_POPUP) {
 229         $fullurl = "$CFG->wwwroot/mod/url/view.php?id=$coursemodule->id&amp;redirect=1";
 230         $options = empty($url->displayoptions) ? [] : (array) unserialize_array($url->displayoptions);
 231         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
 232         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
 233         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
 234         $info->onclick = "window.open('$fullurl', '', '$wh'); return false;";
 235
 236     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
 237         $fullurl = "$CFG->wwwroot/mod/url/view.php?id=$coursemodule->id&amp;redirect=1";
 238         $info->onclick = "window.open('$fullurl'); return false;";
 239
 240     }
 241
 242     if ($coursemodule->showdescription) {
 243         // Convert intro to html. Do not filter cached version, filters run at display time.
 244         $info->content = format_module_intro('url', $url, $coursemodule->id, false);
 245     }
 246
 247     $info->customdata['display'] = $display;
 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 [];
 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     $data->coursemodule = $uploadinfo->coursemodule;
 325
 326     // Set the display options to the site defaults.
 327     $config = get_config('url');
 328     $data->display = $config->display;
 329     $data->popupwidth = $config->popupwidth;
 330     $data->popupheight = $config->popupheight;
 331     $data->printintro = $config->printintro;
 332
 333     return url_add_instance($data, null);
 334 }
 335
 336 /**
 337  * Mark the activity completed (if required) and trigger the course_module_viewed event.
 338  *
 339  * @param  stdClass $url        url object
 340  * @param  stdClass $course     course object
 341  * @param  stdClass $cm         course module object
 342  * @param  stdClass $context    context object
 343  * @since Moodle 3.0
 344  */
 345 function url_view($url, $course, $cm, $context) {
 346
 347     // Trigger course_module_viewed event.
 348     $params = array(
 349         'context' => $context,
 350         'objectid' => $url->id
 351     );
 352
 353     $event = \mod_url\event\course_module_viewed::create($params);
 354     $event->add_record_snapshot('course_modules', $cm);
 355     $event->add_record_snapshot('course', $course);
 356     $event->add_record_snapshot('url', $url);
 357     $event->trigger();
 358
 359     // Completion.
 360     $completion = new completion_info($course);
 361     $completion->set_module_viewed($cm);
 362 }
 363
 364 /**
 365  * Check if the module has any update that affects the current user since a given time.
 366  *
 367  * @param  cm_info $cm course module data
 368  * @param  int $from the time to check updates from
 369  * @param  array $filter  if we need to check only specific updates
 370  * @return stdClass an object with the different type of areas indicating if they were updated or not
 371  * @since Moodle 3.2
 372  */
 373 function url_check_updates_since(cm_info $cm, $from, $filter = array()) {
 374     $updates = course_check_module_updates_since($cm, $from, array('content'), $filter);
 375     return $updates;
 376 }
 377
 378 /**
 379  * This function receives a calendar event and returns the action associated with it, or null if there is none.
 380  *
 381  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
 382  * is not displayed on the block.
 383  *
 384  * @param calendar_event $event
 385  * @param \core_calendar\action_factory $factory
 386  * @param int $userid ID override for calendar events
 387  * @return \core_calendar\local\event\entities\action_interface|null
 388  */
 389 function mod_url_core_calendar_provide_event_action(calendar_event $event,
 390                                                        \core_calendar\action_factory $factory, $userid = 0) {
 391
 392     global $USER;
 393     if (empty($userid)) {
 394         $userid = $USER->id;
 395     }
 396
 397     $cm = get_fast_modinfo($event->courseid, $userid)->instances['url'][$event->instance];
 398
 399     $completion = new \completion_info($cm->get_course());
 400
 401     $completiondata = $completion->get_data($cm, false, $userid);
 402
 403     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
 404         return null;
 405     }
 406
 407     return $factory->create_instance(
 408         get_string('view'),
 409         new \moodle_url('/mod/url/view.php', ['id' => $cm->id]),
 410         1,
 411         true
 412     );
 413 }