mod/resource/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  * @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 get_array_of_activities()} in course/lib.php
 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     }
 231
 232     $display = resource_get_final_display_type($resource);
 233
 234     if ($display == RESOURCELIB_DISPLAY_POPUP) {
 235         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
 236         $options = empty($resource->displayoptions) ? [] : (array) unserialize_array($resource->displayoptions);
 237         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
 238         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
 239         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
 240         $info->onclick = "window.open('$fullurl', '', '$wh'); return false;";
 241
 242     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
 243         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
 244         $info->onclick = "window.open('$fullurl'); return false;";
 245
 246     }
 247
 248     // If any optional extra details are turned on, store in custom data,
 249     // add some file details as well to be used later by resource_get_optional_details() without retriving.
 250     // Do not store filedetails if this is a reference - they will still need to be retrieved every time.
 251     if (($filedetails = resource_get_file_details($resource, $coursemodule)) && empty($filedetails['isref'])) {
 252         $displayoptions = (array) unserialize_array($resource->displayoptions);
 253         $displayoptions['filedetails'] = $filedetails;
 254         $info->customdata['displayoptions'] = serialize($displayoptions);
 255     } else {
 256         $info->customdata['displayoptions'] = $resource->displayoptions;
 257     }
 258     $info->customdata['display'] = $display;
 259
 260     return $info;
 261 }
 262
 263 /**
 264  * Called when viewing course page. Shows extra details after the link if
 265  * enabled.
 266  *
 267  * @param cm_info $cm Course module information
 268  */
 269 function resource_cm_info_view(cm_info $cm) {
 270     global $CFG;
 271     require_once($CFG->dirroot . '/mod/resource/locallib.php');
 272
 273     $resource = (object) ['displayoptions' => $cm->customdata['displayoptions']];
 274     $details = resource_get_optional_details($resource, $cm);
 275     if ($details) {
 276         $cm->set_after_link(' ' . html_writer::tag('span', $details,
 277                 array('class' => 'resourcelinkdetails')));
 278     }
 279 }
 280
 281 /**
 282  * Lists all browsable file areas
 283  *
 284  * @package  mod_resource
 285  * @category files
 286  * @param stdClass $course course object
 287  * @param stdClass $cm course module object
 288  * @param stdClass $context context object
 289  * @return array
 290  */
 291 function resource_get_file_areas($course, $cm, $context) {
 292     $areas = array();
 293     $areas['content'] = get_string('resourcecontent', 'resource');
 294     return $areas;
 295 }
 296
 297 /**
 298  * File browsing support for resource module content area.
 299  *
 300  * @package  mod_resource
 301  * @category files
 302  * @param stdClass $browser file browser instance
 303  * @param stdClass $areas file areas
 304  * @param stdClass $course course object
 305  * @param stdClass $cm course module object
 306  * @param stdClass $context context object
 307  * @param string $filearea file area
 308  * @param int $itemid item ID
 309  * @param string $filepath file path
 310  * @param string $filename file name
 311  * @return file_info instance or null if not found
 312  */
 313 function resource_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
 314     global $CFG;
 315
 316     if (!has_capability('moodle/course:managefiles', $context)) {
 317         // students can not peak here!
 318         return null;
 319     }
 320
 321     $fs = get_file_storage();
 322
 323     if ($filearea === 'content') {
 324         $filepath = is_null($filepath) ? '/' : $filepath;
 325         $filename = is_null($filename) ? '.' : $filename;
 326
 327         $urlbase = $CFG->wwwroot.'/pluginfile.php';
 328         if (!$storedfile = $fs->get_file($context->id, 'mod_resource', 'content', 0, $filepath, $filename)) {
 329             if ($filepath === '/' and $filename === '.') {
 330                 $storedfile = new virtual_root_file($context->id, 'mod_resource', 'content', 0);
 331             } else {
 332                 // not found
 333                 return null;
 334             }
 335         }
 336         require_once("$CFG->dirroot/mod/resource/locallib.php");
 337         return new resource_content_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, true, false);
 338     }
 339
 340     // note: resource_intro handled in file_browser automatically
 341
 342     return null;
 343 }
 344
 345 /**
 346  * Serves the resource files.
 347  *
 348  * @package  mod_resource
 349  * @category files
 350  * @param stdClass $course course object
 351  * @param stdClass $cm course module object
 352  * @param stdClass $context context object
 353  * @param string $filearea file area
 354  * @param array $args extra arguments
 355  * @param bool $forcedownload whether or not force download
 356  * @param array $options additional options affecting the file serving
 357  * @return bool false if file not found, does not return if found - just send the file
 358  */
 359 function resource_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
 360     global $CFG, $DB;
 361     require_once("$CFG->libdir/resourcelib.php");
 362
 363     if ($context->contextlevel != CONTEXT_MODULE) {
 364         return false;
 365     }
 366
 367     require_course_login($course, true, $cm);
 368     if (!has_capability('mod/resource:view', $context)) {
 369         return false;
 370     }
 371
 372     if ($filearea !== 'content') {
 373         // intro is handled automatically in pluginfile.php
 374         return false;
 375     }
 376
 377     array_shift($args); // ignore revision - designed to prevent caching problems only
 378
 379     $fs = get_file_storage();
 380     $relativepath = implode('/', $args);
 381     $fullpath = rtrim("/$context->id/mod_resource/$filearea/0/$relativepath", '/');
 382     do {
 383         if (!$file = $fs->get_file_by_hash(sha1($fullpath))) {
 384             if ($fs->get_file_by_hash(sha1("$fullpath/."))) {
 385                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.htm"))) {
 386                     break;
 387                 }
 388                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.html"))) {
 389                     break;
 390                 }
 391                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/Default.htm"))) {
 392                     break;
 393                 }
 394             }
 395             $resource = $DB->get_record('resource', array('id'=>$cm->instance), 'id, legacyfiles', MUST_EXIST);
 396             if ($resource->legacyfiles != RESOURCELIB_LEGACYFILES_ACTIVE) {
 397                 return false;
 398             }
 399             if (!$file = resourcelib_try_file_migration('/'.$relativepath, $cm->id, $cm->course, 'mod_resource', 'content', 0)) {
 400                 return false;
 401             }
 402             // file migrate - update flag
 403             $resource->legacyfileslast = time();
 404             $DB->update_record('resource', $resource);
 405         }
 406     } while (false);
 407
 408     // should we apply filters?
 409     $mimetype = $file->get_mimetype();
 410     if ($mimetype === 'text/html' or $mimetype === 'text/plain' or $mimetype === 'application/xhtml+xml') {
 411         $filter = $DB->get_field('resource', 'filterfiles', array('id'=>$cm->instance));
 412         $CFG->embeddedsoforcelinktarget = true;
 413     } else {
 414         $filter = 0;
 415     }
 416
 417     // finally send the file
 418     send_stored_file($file, null, $filter, $forcedownload, $options);
 419 }
 420
 421 /**
 422  * Return a list of page types
 423  * @param string $pagetype current page type
 424  * @param stdClass $parentcontext Block's parent context
 425  * @param stdClass $currentcontext Current context of block
 426  */
 427 function resource_page_type_list($pagetype, $parentcontext, $currentcontext) {
 428     $module_pagetype = array('mod-resource-*'=>get_string('page-mod-resource-x', 'resource'));
 429     return $module_pagetype;
 430 }
 431
 432 /**
 433  * Export file resource contents
 434  *
 435  * @return array of file content
 436  */
 437 function resource_export_contents($cm, $baseurl) {
 438     global $CFG, $DB;
 439     $contents = array();
 440     $context = context_module::instance($cm->id);
 441     $resource = $DB->get_record('resource', array('id'=>$cm->instance), '*', MUST_EXIST);
 442
 443     $fs = get_file_storage();
 444     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false);
 445
 446     foreach ($files as $fileinfo) {
 447         $file = array();
 448         $file['type'] = 'file';
 449         $file['filename']     = $fileinfo->get_filename();
 450         $file['filepath']     = $fileinfo->get_filepath();
 451         $file['filesize']     = $fileinfo->get_filesize();
 452         $file['fileurl']      = file_encode_url("$CFG->wwwroot/" . $baseurl, '/'.$context->id.'/mod_resource/content/'.$resource->revision.$fileinfo->get_filepath().$fileinfo->get_filename(), true);
 453         $file['timecreated']  = $fileinfo->get_timecreated();
 454         $file['timemodified'] = $fileinfo->get_timemodified();
 455         $file['sortorder']    = $fileinfo->get_sortorder();
 456         $file['userid']       = $fileinfo->get_userid();
 457         $file['author']       = $fileinfo->get_author();
 458         $file['license']      = $fileinfo->get_license();
 459         $file['mimetype']     = $fileinfo->get_mimetype();
 460         $file['isexternalfile'] = $fileinfo->is_external_file();
 461         if ($file['isexternalfile']) {
 462             $file['repositorytype'] = $fileinfo->get_repository_type();
 463         }
 464         $contents[] = $file;
 465     }
 466
 467     return $contents;
 468 }
 469
 470 /**
 471  * Register the ability to handle drag and drop file uploads
 472  * @return array containing details of the files / types the mod can handle
 473  */
 474 function resource_dndupload_register() {
 475     return array('files' => array(
 476                      array('extension' => '*', 'message' => get_string('dnduploadresource', 'mod_resource'))
 477                  ));
 478 }
 479
 480 /**
 481  * Handle a file that has been uploaded
 482  * @param object $uploadinfo details of the file / content that has been uploaded
 483  * @return int instance id of the newly created mod
 484  */
 485 function resource_dndupload_handle($uploadinfo) {
 486     // Gather the required info.
 487     $data = new stdClass();
 488     $data->course = $uploadinfo->course->id;
 489     $data->name = $uploadinfo->displayname;
 490     $data->intro = '';
 491     $data->introformat = FORMAT_HTML;
 492     $data->coursemodule = $uploadinfo->coursemodule;
 493     $data->files = $uploadinfo->draftitemid;
 494
 495     // Set the display options to the site defaults.
 496     $config = get_config('resource');
 497     $data->display = $config->display;
 498     $data->popupheight = $config->popupheight;
 499     $data->popupwidth = $config->popupwidth;
 500     $data->printintro = $config->printintro;
 501     $data->showsize = (isset($config->showsize)) ? $config->showsize : 0;
 502     $data->showtype = (isset($config->showtype)) ? $config->showtype : 0;
 503     $data->showdate = (isset($config->showdate)) ? $config->showdate : 0;
 504     $data->filterfiles = $config->filterfiles;
 505
 506     return resource_add_instance($data, null);
 507 }
 508
 509 /**
 510  * Mark the activity completed (if required) and trigger the course_module_viewed event.
 511  *
 512  * @param  stdClass $resource   resource object
 513  * @param  stdClass $course     course object
 514  * @param  stdClass $cm         course module object
 515  * @param  stdClass $context    context object
 516  * @since Moodle 3.0
 517  */
 518 function resource_view($resource, $course, $cm, $context) {
 519
 520     // Trigger course_module_viewed event.
 521     $params = array(
 522         'context' => $context,
 523         'objectid' => $resource->id
 524     );
 525
 526     $event = \mod_resource\event\course_module_viewed::create($params);
 527     $event->add_record_snapshot('course_modules', $cm);
 528     $event->add_record_snapshot('course', $course);
 529     $event->add_record_snapshot('resource', $resource);
 530     $event->trigger();
 531
 532     // Completion.
 533     $completion = new completion_info($course);
 534     $completion->set_module_viewed($cm);
 535 }
 536
 537 /**
 538  * Check if the module has any update that affects the current user since a given time.
 539  *
 540  * @param  cm_info $cm course module data
 541  * @param  int $from the time to check updates from
 542  * @param  array $filter  if we need to check only specific updates
 543  * @return stdClass an object with the different type of areas indicating if they were updated or not
 544  * @since Moodle 3.2
 545  */
 546 function resource_check_updates_since(cm_info $cm, $from, $filter = array()) {
 547     $updates = course_check_module_updates_since($cm, $from, array('content'), $filter);
 548     return $updates;
 549 }
 550
 551 /**
 552  * This function receives a calendar event and returns the action associated with it, or null if there is none.
 553  *
 554  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
 555  * is not displayed on the block.
 556  *
 557  * @param calendar_event $event
 558  * @param \core_calendar\action_factory $factory
 559  * @return \core_calendar\local\event\entities\action_interface|null
 560  */
 561 function mod_resource_core_calendar_provide_event_action(calendar_event $event,
 562                                                       \core_calendar\action_factory $factory, $userid = 0) {
 563
 564     global $USER;
 565
 566     if (empty($userid)) {
 567         $userid = $USER->id;
 568     }
 569
 570     $cm = get_fast_modinfo($event->courseid, $userid)->instances['resource'][$event->instance];
 571
 572     $completion = new \completion_info($cm->get_course());
 573
 574     $completiondata = $completion->get_data($cm, false, $userid);
 575
 576     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
 577         return null;
 578     }
 579
 580     return $factory->create_instance(
 581         get_string('view'),
 582         new \moodle_url('/mod/resource/view.php', ['id' => $cm->id]),
 583         1,
 584         true
 585     );
 586 }
 587
 588
 589 /**
 590  * Given an array with a file path, it returns the itemid and the filepath for the defined filearea.
 591  *
 592  * @param  string $filearea The filearea.
 593  * @param  array  $args The path (the part after the filearea and before the filename).
 594  * @return array The itemid and the filepath inside the $args path, for the defined filearea.
 595  */
 596 function mod_resource_get_path_from_pluginfile(string $filearea, array $args) : array {
 597     // Resource never has an itemid (the number represents the revision but it's not stored in database).
 598     array_shift($args);
 599
 600     // Get the filepath.
 601     if (empty($args)) {
 602         $filepath = '/';
 603     } else {
 604         $filepath = '/' . implode('/', $args) . '/';
 605     }
 606
 607     return [
 608         'itemid' => 0,
 609         'filepath' => $filepath,
 610     ];
 611 }