[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]

   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   * @package    mod_resource
  20   * @copyright  2009 Petr Skoda  {@link http://skodak.org}
  21   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22   */
  23  
  24  defined('MOODLE_INTERNAL') || die;
  25  
  26  /**
  27   * List of features supported in Resource module
  28   * @param string $feature FEATURE_xx constant for requested feature
  29   * @return mixed True if module supports feature, false if not, null if doesn't know or string for the module purpose.
  30   */
  31  function resource_supports($feature) {
  32      switch($feature) {
  33          case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
  34          case FEATURE_GROUPS:                  return false;
  35          case FEATURE_GROUPINGS:               return false;
  36          case FEATURE_MOD_INTRO:               return true;
  37          case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
  38          case FEATURE_GRADE_HAS_GRADE:         return false;
  39          case FEATURE_GRADE_OUTCOMES:          return false;
  40          case FEATURE_BACKUP_MOODLE2:          return true;
  41          case FEATURE_SHOW_DESCRIPTION:        return true;
  42          case FEATURE_MOD_PURPOSE:             return MOD_PURPOSE_CONTENT;
  43  
  44          default: return null;
  45      }
  46  }
  47  
  48  /**
  49   * This function is used by the reset_course_userdata function in moodlelib.
  50   * @param $data the data submitted from the reset course.
  51   * @return array status array
  52   */
  53  function resource_reset_userdata($data) {
  54  
  55      // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
  56      // See MDL-9367.
  57  
  58      return array();
  59  }
  60  
  61  /**
  62   * List the actions that correspond to a view of this module.
  63   * This is used by the participation report.
  64   *
  65   * Note: This is not used by new logging system. Event with
  66   *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
  67   *       be considered as view action.
  68   *
  69   * @return array
  70   */
  71  function resource_get_view_actions() {
  72      return array('view','view all');
  73  }
  74  
  75  /**
  76   * List the actions that correspond to a post of this module.
  77   * This is used by the participation report.
  78   *
  79   * Note: This is not used by new logging system. Event with
  80   *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
  81   *       will be considered as post action.
  82   *
  83   * @return array
  84   */
  85  function resource_get_post_actions() {
  86      return array('update', 'add');
  87  }
  88  
  89  /**
  90   * Add resource instance.
  91   * @param object $data
  92   * @param object $mform
  93   * @return int new resource instance id
  94   */
  95  function resource_add_instance($data, $mform) {
  96      global $CFG, $DB;
  97      require_once("$CFG->libdir/resourcelib.php");
  98      require_once("$CFG->dirroot/mod/resource/locallib.php");
  99      $cmid = $data->coursemodule;
 100      $data->timemodified = time();
 101  
 102      resource_set_display_options($data);
 103  
 104      $data->id = $DB->insert_record('resource', $data);
 105  
 106      // we need to use context now, so we need to make sure all needed info is already in db
 107      $DB->set_field('course_modules', 'instance', $data->id, array('id'=>$cmid));
 108      resource_set_mainfile($data);
 109  
 110      $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
 111      \core_completion\api::update_completion_date_event($cmid, 'resource', $data->id, $completiontimeexpected);
 112  
 113      return $data->id;
 114  }
 115  
 116  /**
 117   * Update resource instance.
 118   * @param object $data
 119   * @param object $mform
 120   * @return bool true
 121   */
 122  function resource_update_instance($data, $mform) {
 123      global $CFG, $DB;
 124      require_once("$CFG->libdir/resourcelib.php");
 125      $data->timemodified = time();
 126      $data->id           = $data->instance;
 127      $data->revision++;
 128  
 129      resource_set_display_options($data);
 130  
 131      $DB->update_record('resource', $data);
 132      resource_set_mainfile($data);
 133  
 134      $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
 135      \core_completion\api::update_completion_date_event($data->coursemodule, 'resource', $data->id, $completiontimeexpected);
 136  
 137      return true;
 138  }
 139  
 140  /**
 141   * Updates display options based on form input.
 142   *
 143   * Shared code used by resource_add_instance and resource_update_instance.
 144   *
 145   * @param object $data Data object
 146   */
 147  function resource_set_display_options($data) {
 148      $displayoptions = array();
 149      if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
 150          $displayoptions['popupwidth']  = $data->popupwidth;
 151          $displayoptions['popupheight'] = $data->popupheight;
 152      }
 153      if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
 154          $displayoptions['printintro']   = (int)!empty($data->printintro);
 155      }
 156      if (!empty($data->showsize)) {
 157          $displayoptions['showsize'] = 1;
 158      }
 159      if (!empty($data->showtype)) {
 160          $displayoptions['showtype'] = 1;
 161      }
 162      if (!empty($data->showdate)) {
 163          $displayoptions['showdate'] = 1;
 164      }
 165      $data->displayoptions = serialize($displayoptions);
 166  }
 167  
 168  /**
 169   * Delete resource instance.
 170   * @param int $id
 171   * @return bool true
 172   */
 173  function resource_delete_instance($id) {
 174      global $DB;
 175  
 176      if (!$resource = $DB->get_record('resource', array('id'=>$id))) {
 177          return false;
 178      }
 179  
 180      $cm = get_coursemodule_from_instance('resource', $id);
 181      \core_completion\api::update_completion_date_event($cm->id, 'resource', $id, null);
 182  
 183      // note: all context files are deleted automatically
 184  
 185      $DB->delete_records('resource', array('id'=>$resource->id));
 186  
 187      return true;
 188  }
 189  
 190  /**
 191   * Given a course_module object, this function returns any
 192   * "extra" information that may be needed when printing
 193   * this activity in a course listing.
 194   *
 195   * See {@link course_modinfo::get_array_of_activities()}
 196   *
 197   * @param stdClass $coursemodule
 198   * @return cached_cm_info info
 199   */
 200  function resource_get_coursemodule_info($coursemodule) {
 201      global $CFG, $DB;
 202      require_once("$CFG->libdir/filelib.php");
 203      require_once("$CFG->dirroot/mod/resource/locallib.php");
 204      require_once($CFG->libdir.'/completionlib.php');
 205  
 206      $context = context_module::instance($coursemodule->id);
 207  
 208      if (!$resource = $DB->get_record('resource', array('id'=>$coursemodule->instance),
 209              'id, name, display, displayoptions, tobemigrated, revision, intro, introformat')) {
 210          return NULL;
 211      }
 212  
 213      $info = new cached_cm_info();
 214      $info->name = $resource->name;
 215      if ($coursemodule->showdescription) {
 216          // Convert intro to html. Do not filter cached version, filters run at display time.
 217          $info->content = format_module_intro('resource', $resource, $coursemodule->id, false);
 218      }
 219  
 220      if ($resource->tobemigrated) {
 221          return $info;
 222      }
 223  
 224      // See if there is at least one file.
 225      $fs = get_file_storage();
 226      $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false, 0, 0, 1);
 227      if (count($files) >= 1) {
 228          $mainfile = reset($files);
 229          $resource->mainfile = $mainfile->get_filename();
 230          $info->icon = file_file_icon($mainfile, 24);
 231      }
 232  
 233      $display = resource_get_final_display_type($resource);
 234  
 235      if ($display == RESOURCELIB_DISPLAY_POPUP) {
 236          $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
 237          $options = empty($resource->displayoptions) ? [] : (array) unserialize_array($resource->displayoptions);
 238          $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
 239          $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
 240          $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
 241          $info->onclick = "window.open('$fullurl', '', '$wh'); return false;";
 242  
 243      } else if ($display == RESOURCELIB_DISPLAY_NEW) {
 244          $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
 245          $info->onclick = "window.open('$fullurl'); return false;";
 246  
 247      }
 248  
 249      // If any optional extra details are turned on, store in custom data,
 250      // add some file details as well to be used later by resource_get_optional_details() without retriving.
 251      // Do not store filedetails if this is a reference - they will still need to be retrieved every time.
 252      if (($filedetails = resource_get_file_details($resource, $coursemodule)) && empty($filedetails['isref'])) {
 253          $displayoptions = (array) unserialize_array($resource->displayoptions);
 254          $displayoptions['filedetails'] = $filedetails;
 255          $info->customdata['displayoptions'] = serialize($displayoptions);
 256      } else {
 257          $info->customdata['displayoptions'] = $resource->displayoptions;
 258      }
 259      $info->customdata['display'] = $display;
 260  
 261      return $info;
 262  }
 263  
 264  /**
 265   * Called when viewing course page. Shows extra details after the link if
 266   * enabled.
 267   *
 268   * @param cm_info $cm Course module information
 269   */
 270  function resource_cm_info_view(cm_info $cm) {
 271      global $CFG;
 272      require_once($CFG->dirroot . '/mod/resource/locallib.php');
 273      $customdata = $cm->customdata;
 274      if (is_array($customdata) && isset($customdata['displayoptions'])) {
 275          $resource = (object) ['displayoptions' => $customdata['displayoptions']];
 276          $details = resource_get_optional_details($resource, $cm);
 277          if ($details) {
 278              $cm->set_after_link(' ' . html_writer::tag('span', $details, ['class' => 'resourcelinkdetails']));
 279          }
 280      }
 281  }
 282  
 283  /**
 284   * Lists all browsable file areas
 285   *
 286   * @package  mod_resource
 287   * @category files
 288   * @param stdClass $course course object
 289   * @param stdClass $cm course module object
 290   * @param stdClass $context context object
 291   * @return array
 292   */
 293  function resource_get_file_areas($course, $cm, $context) {
 294      $areas = array();
 295      $areas['content'] = get_string('resourcecontent', 'resource');
 296      return $areas;
 297  }
 298  
 299  /**
 300   * File browsing support for resource module content area.
 301   *
 302   * @package  mod_resource
 303   * @category files
 304   * @param stdClass $browser file browser instance
 305   * @param stdClass $areas file areas
 306   * @param stdClass $course course object
 307   * @param stdClass $cm course module object
 308   * @param stdClass $context context object
 309   * @param string $filearea file area
 310   * @param int $itemid item ID
 311   * @param string $filepath file path
 312   * @param string $filename file name
 313   * @return file_info instance or null if not found
 314   */
 315  function resource_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
 316      global $CFG;
 317  
 318      if (!has_capability('moodle/course:managefiles', $context)) {
 319          // students can not peak here!
 320          return null;
 321      }
 322  
 323      $fs = get_file_storage();
 324  
 325      if ($filearea === 'content') {
 326          $filepath = is_null($filepath) ? '/' : $filepath;
 327          $filename = is_null($filename) ? '.' : $filename;
 328  
 329          $urlbase = $CFG->wwwroot.'/pluginfile.php';
 330          if (!$storedfile = $fs->get_file($context->id, 'mod_resource', 'content', 0, $filepath, $filename)) {
 331              if ($filepath === '/' and $filename === '.') {
 332                  $storedfile = new virtual_root_file($context->id, 'mod_resource', 'content', 0);
 333              } else {
 334                  // not found
 335                  return null;
 336              }
 337          }
 338          require_once("$CFG->dirroot/mod/resource/locallib.php");
 339          return new resource_content_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, true, false);
 340      }
 341  
 342      // note: resource_intro handled in file_browser automatically
 343  
 344      return null;
 345  }
 346  
 347  /**
 348   * Serves the resource files.
 349   *
 350   * @package  mod_resource
 351   * @category files
 352   * @param stdClass $course course object
 353   * @param stdClass $cm course module object
 354   * @param stdClass $context context object
 355   * @param string $filearea file area
 356   * @param array $args extra arguments
 357   * @param bool $forcedownload whether or not force download
 358   * @param array $options additional options affecting the file serving
 359   * @return bool false if file not found, does not return if found - just send the file
 360   */
 361  function resource_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
 362      global $CFG, $DB;
 363      require_once("$CFG->libdir/resourcelib.php");
 364  
 365      if ($context->contextlevel != CONTEXT_MODULE) {
 366          return false;
 367      }
 368  
 369      require_course_login($course, true, $cm);
 370      if (!has_capability('mod/resource:view', $context)) {
 371          return false;
 372      }
 373  
 374      if ($filearea !== 'content') {
 375          // intro is handled automatically in pluginfile.php
 376          return false;
 377      }
 378  
 379      array_shift($args); // ignore revision - designed to prevent caching problems only
 380  
 381      $fs = get_file_storage();
 382      $relativepath = implode('/', $args);
 383      $fullpath = rtrim("/$context->id/mod_resource/$filearea/0/$relativepath", '/');
 384      do {
 385          if (!$file = $fs->get_file_by_hash(sha1($fullpath))) {
 386              if ($fs->get_file_by_hash(sha1("$fullpath/."))) {
 387                  if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.htm"))) {
 388                      break;
 389                  }
 390                  if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.html"))) {
 391                      break;
 392                  }
 393                  if ($file = $fs->get_file_by_hash(sha1("$fullpath/Default.htm"))) {
 394                      break;
 395                  }
 396              }
 397              $resource = $DB->get_record('resource', array('id'=>$cm->instance), 'id, legacyfiles', MUST_EXIST);
 398              if ($resource->legacyfiles != RESOURCELIB_LEGACYFILES_ACTIVE) {
 399                  return false;
 400              }
 401              if (!$file = resourcelib_try_file_migration('/'.$relativepath, $cm->id, $cm->course, 'mod_resource', 'content', 0)) {
 402                  return false;
 403              }
 404              // file migrate - update flag
 405              $resource->legacyfileslast = time();
 406              $DB->update_record('resource', $resource);
 407          }
 408      } while (false);
 409  
 410      // should we apply filters?
 411      $mimetype = $file->get_mimetype();
 412      if ($mimetype === 'text/html' or $mimetype === 'text/plain' or $mimetype === 'application/xhtml+xml') {
 413          $filter = $DB->get_field('resource', 'filterfiles', array('id'=>$cm->instance));
 414          $CFG->embeddedsoforcelinktarget = true;
 415      } else {
 416          $filter = 0;
 417      }
 418  
 419      // finally send the file
 420      send_stored_file($file, null, $filter, $forcedownload, $options);
 421  }
 422  
 423  /**
 424   * Return a list of page types
 425   * @param string $pagetype current page type
 426   * @param stdClass $parentcontext Block's parent context
 427   * @param stdClass $currentcontext Current context of block
 428   */
 429  function resource_page_type_list($pagetype, $parentcontext, $currentcontext) {
 430      $module_pagetype = array('mod-resource-*'=>get_string('page-mod-resource-x', 'resource'));
 431      return $module_pagetype;
 432  }
 433  
 434  /**
 435   * Export file resource contents
 436   *
 437   * @return array of file content
 438   */
 439  function resource_export_contents($cm, $baseurl) {
 440      global $CFG, $DB;
 441      $contents = array();
 442      $context = context_module::instance($cm->id);
 443      $resource = $DB->get_record('resource', array('id'=>$cm->instance), '*', MUST_EXIST);
 444  
 445      $fs = get_file_storage();
 446      $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false);
 447  
 448      foreach ($files as $fileinfo) {
 449          $file = array();
 450          $file['type'] = 'file';
 451          $file['filename']     = $fileinfo->get_filename();
 452          $file['filepath']     = $fileinfo->get_filepath();
 453          $file['filesize']     = $fileinfo->get_filesize();
 454          $file['fileurl']      = file_encode_url("$CFG->wwwroot/" . $baseurl, '/'.$context->id.'/mod_resource/content/'.$resource->revision.$fileinfo->get_filepath().$fileinfo->get_filename(), true);
 455          $file['timecreated']  = $fileinfo->get_timecreated();
 456          $file['timemodified'] = $fileinfo->get_timemodified();
 457          $file['sortorder']    = $fileinfo->get_sortorder();
 458          $file['userid']       = $fileinfo->get_userid();
 459          $file['author']       = $fileinfo->get_author();
 460          $file['license']      = $fileinfo->get_license();
 461          $file['mimetype']     = $fileinfo->get_mimetype();
 462          $file['isexternalfile'] = $fileinfo->is_external_file();
 463          if ($file['isexternalfile']) {
 464              $file['repositorytype'] = $fileinfo->get_repository_type();
 465          }
 466          $contents[] = $file;
 467      }
 468  
 469      return $contents;
 470  }
 471  
 472  /**
 473   * Register the ability to handle drag and drop file uploads
 474   * @return array containing details of the files / types the mod can handle
 475   */
 476  function resource_dndupload_register() {
 477      return array('files' => array(
 478                       array('extension' => '*', 'message' => get_string('dnduploadresource', 'mod_resource'))
 479                   ));
 480  }
 481  
 482  /**
 483   * Handle a file that has been uploaded
 484   * @param object $uploadinfo details of the file / content that has been uploaded
 485   * @return int instance id of the newly created mod
 486   */
 487  function resource_dndupload_handle($uploadinfo) {
 488      // Gather the required info.
 489      $data = new stdClass();
 490      $data->course = $uploadinfo->course->id;
 491      $data->name = $uploadinfo->displayname;
 492      $data->intro = '';
 493      $data->introformat = FORMAT_HTML;
 494      $data->coursemodule = $uploadinfo->coursemodule;
 495      $data->files = $uploadinfo->draftitemid;
 496  
 497      // Set the display options to the site defaults.
 498      $config = get_config('resource');
 499      $data->display = $config->display;
 500      $data->popupheight = $config->popupheight;
 501      $data->popupwidth = $config->popupwidth;
 502      $data->printintro = $config->printintro;
 503      $data->showsize = (isset($config->showsize)) ? $config->showsize : 0;
 504      $data->showtype = (isset($config->showtype)) ? $config->showtype : 0;
 505      $data->showdate = (isset($config->showdate)) ? $config->showdate : 0;
 506      $data->filterfiles = $config->filterfiles;
 507  
 508      return resource_add_instance($data, null);
 509  }
 510  
 511  /**
 512   * Mark the activity completed (if required) and trigger the course_module_viewed event.
 513   *
 514   * @param  stdClass $resource   resource object
 515   * @param  stdClass $course     course object
 516   * @param  stdClass $cm         course module object
 517   * @param  stdClass $context    context object
 518   * @since Moodle 3.0
 519   */
 520  function resource_view($resource, $course, $cm, $context) {
 521  
 522      // Trigger course_module_viewed event.
 523      $params = array(
 524          'context' => $context,
 525          'objectid' => $resource->id
 526      );
 527  
 528      $event = \mod_resource\event\course_module_viewed::create($params);
 529      $event->add_record_snapshot('course_modules', $cm);
 530      $event->add_record_snapshot('course', $course);
 531      $event->add_record_snapshot('resource', $resource);
 532      $event->trigger();
 533  
 534      // Completion.
 535      $completion = new completion_info($course);
 536      $completion->set_module_viewed($cm);
 537  }
 538  
 539  /**
 540   * Check if the module has any update that affects the current user since a given time.
 541   *
 542   * @param  cm_info $cm course module data
 543   * @param  int $from the time to check updates from
 544   * @param  array $filter  if we need to check only specific updates
 545   * @return stdClass an object with the different type of areas indicating if they were updated or not
 546   * @since Moodle 3.2
 547   */
 548  function resource_check_updates_since(cm_info $cm, $from, $filter = array()) {
 549      $updates = course_check_module_updates_since($cm, $from, array('content'), $filter);
 550      return $updates;
 551  }
 552  
 553  /**
 554   * This function receives a calendar event and returns the action associated with it, or null if there is none.
 555   *
 556   * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
 557   * is not displayed on the block.
 558   *
 559   * @param calendar_event $event
 560   * @param \core_calendar\action_factory $factory
 561   * @return \core_calendar\local\event\entities\action_interface|null
 562   */
 563  function mod_resource_core_calendar_provide_event_action(calendar_event $event,
 564                                                        \core_calendar\action_factory $factory, $userid = 0) {
 565  
 566      global $USER;
 567  
 568      if (empty($userid)) {
 569          $userid = $USER->id;
 570      }
 571  
 572      $cm = get_fast_modinfo($event->courseid, $userid)->instances['resource'][$event->instance];
 573  
 574      $completion = new \completion_info($cm->get_course());
 575  
 576      $completiondata = $completion->get_data($cm, false, $userid);
 577  
 578      if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
 579          return null;
 580      }
 581  
 582      return $factory->create_instance(
 583          get_string('view'),
 584          new \moodle_url('/mod/resource/view.php', ['id' => $cm->id]),
 585          1,
 586          true
 587      );
 588  }
 589  
 590  
 591  /**
 592   * Given an array with a file path, it returns the itemid and the filepath for the defined filearea.
 593   *
 594   * @param  string $filearea The filearea.
 595   * @param  array  $args The path (the part after the filearea and before the filename).
 596   * @return array The itemid and the filepath inside the $args path, for the defined filearea.
 597   */
 598  function mod_resource_get_path_from_pluginfile(string $filearea, array $args) : array {
 599      // Resource never has an itemid (the number represents the revision but it's not stored in database).
 600      array_shift($args);
 601  
 602      // Get the filepath.
 603      if (empty($args)) {
 604          $filepath = '/';
 605      } else {
 606          $filepath = '/' . implode('/', $args) . '/';
 607      }
 608  
 609      return [
 610          'itemid' => 0,
 611          'filepath' => $filepath,
 612      ];
 613  }