mod/imscp/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 imscp module
  20  *
  21  * @package    mod
  22  * @subpackage imscp
  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 /**
  30  * List of features supported in IMS CP module
  31  * @param string $feature FEATURE_xx constant for requested feature
  32  * @return mixed True if module supports feature, false if not, null if doesn't know
  33  */
  34 function imscp_supports($feature) {
  35     switch($feature) {
  36         case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
  37         case FEATURE_GROUPS:                  return false;
  38         case FEATURE_GROUPINGS:               return false;
  39         case FEATURE_GROUPMEMBERSONLY:        return true;
  40         case FEATURE_MOD_INTRO:               return true;
  41         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
  42         case FEATURE_GRADE_HAS_GRADE:         return false;
  43         case FEATURE_GRADE_OUTCOMES:          return false;
  44         case FEATURE_BACKUP_MOODLE2:          return true;
  45         case FEATURE_SHOW_DESCRIPTION:        return true;
  46
  47         default: return null;
  48     }
  49 }
  50
  51 /**
  52  * Returns all other caps used in module
  53  * @return array
  54  */
  55 function imscp_get_extra_capabilities() {
  56     return array('moodle/site:accessallgroups');
  57 }
  58
  59 /**
  60  * This function is used by the reset_course_userdata function in moodlelib.
  61  * @param $data the data submitted from the reset course.
  62  * @return array status array
  63  */
  64 function imscp_reset_userdata($data) {
  65     return array();
  66 }
  67
  68 /**
  69  * List of view style log actions
  70  * @return array
  71  */
  72 function imscp_get_view_actions() {
  73     return array('view', 'view all');
  74 }
  75
  76 /**
  77  * List of update style log actions
  78  * @return array
  79  */
  80 function imscp_get_post_actions() {
  81     return array('update', 'add');
  82 }
  83
  84 /**
  85  * Add imscp instance.
  86  * @param object $data
  87  * @param object $mform
  88  * @return int new imscp instance id
  89  */
  90 function imscp_add_instance($data, $mform) {
  91     global $CFG, $DB;
  92     require_once("$CFG->dirroot/mod/imscp/locallib.php");
  93
  94     $cmid = $data->coursemodule;
  95
  96     $data->timemodified = time();
  97     $data->revision     = 1;
  98     $data->structure    = null;
  99
 100     $data->id = $DB->insert_record('imscp', $data);
 101
 102     // we need to use context now, so we need to make sure all needed info is already in db
 103     $DB->set_field('course_modules', 'instance', $data->id, array('id'=>$cmid));
 104     $context = context_module::instance($cmid);
 105     $imscp = $DB->get_record('imscp', array('id'=>$data->id), '*', MUST_EXIST);
 106
 107     if ($filename = $mform->get_new_filename('package')) {
 108         if ($package = $mform->save_stored_file('package', $context->id, 'mod_imscp', 'backup', 1, '/', $filename)) {
 109             // extract package content
 110             $packer = get_file_packer('application/zip');
 111             $package->extract_to_storage($packer, $context->id, 'mod_imscp', 'content', 1, '/');
 112             $structure = imscp_parse_structure($imscp, $context);
 113             $imscp->structure = is_array($structure) ? serialize($structure) : null;
 114             $DB->update_record('imscp', $imscp);
 115         }
 116     }
 117
 118     return $data->id;
 119 }
 120
 121 /**
 122  * Update imscp instance.
 123  * @param object $data
 124  * @param object $mform
 125  * @return bool true
 126  */
 127 function imscp_update_instance($data, $mform) {
 128     global $CFG, $DB;
 129     require_once("$CFG->dirroot/mod/imscp/locallib.php");
 130
 131     $cmid = $data->coursemodule;
 132
 133     $data->timemodified = time();
 134     $data->id           = $data->instance;
 135     $data->structure   = null; // better reparse structure after each update
 136
 137     $DB->update_record('imscp', $data);
 138
 139     $context = context_module::instance($cmid);
 140     $imscp = $DB->get_record('imscp', array('id'=>$data->id), '*', MUST_EXIST);
 141
 142     if ($filename = $mform->get_new_filename('package')) {
 143         $fs = get_file_storage();
 144
 145         $imscp->revision++;
 146         $DB->update_record('imscp', $imscp);
 147
 148         // get a list of existing packages before adding new package
 149         if ($imscp->keepold > -1) {
 150             $packages = $fs->get_area_files($context->id, 'mod_imscp', 'backup', false, "itemid ASC", false);
 151         } else {
 152             $packages = array();
 153         }
 154
 155         $package = $mform->save_stored_file('package', $context->id, 'mod_imscp', 'backup', $imscp->revision, '/', $filename);
 156
 157         // purge all extracted content
 158         $fs->delete_area_files($context->id, 'mod_imscp', 'content');
 159
 160         // extract package content
 161         if ($package) {
 162             $packer = get_file_packer('application/zip');
 163             $package->extract_to_storage($packer, $context->id, 'mod_imscp', 'content', $imscp->revision, '/');
 164         }
 165
 166         // cleanup old package files, keep current + keepold
 167         while ($packages and (count($packages) > $imscp->keepold)) {
 168             $package = array_shift($packages);
 169             $fs->delete_area_files($context->id, 'mod_imscp', 'backup', $package->get_itemid());
 170         }
 171     }
 172
 173     $structure = imscp_parse_structure($imscp, $context);
 174     $imscp->structure = is_array($structure) ? serialize($structure) : null;
 175     $DB->update_record('imscp', $imscp);
 176
 177     return true;
 178 }
 179
 180 /**
 181  * Delete imscp instance.
 182  * @param int $id
 183  * @return bool true
 184  */
 185 function imscp_delete_instance($id) {
 186     global $DB;
 187
 188     if (!$imscp = $DB->get_record('imscp', array('id'=>$id))) {
 189         return false;
 190     }
 191
 192     // note: all context files are deleted automatically
 193
 194     $DB->delete_records('imscp', array('id'=>$imscp->id));
 195
 196     return true;
 197 }
 198
 199 /**
 200  * Return use outline
 201  * @param object $course
 202  * @param object $user
 203  * @param object $mod
 204  * @param object $imscp
 205  * @return object|null
 206  */
 207 function imscp_user_outline($course, $user, $mod, $imscp) {
 208     global $DB;
 209
 210     if ($logs = $DB->get_records('log', array('userid'=>$user->id, 'module'=>'imscp',
 211                                               'action'=>'view', 'info'=>$imscp->id), 'time ASC')) {
 212
 213         $numviews = count($logs);
 214         $lastlog = array_pop($logs);
 215
 216         $result = new stdClass();
 217         $result->info = get_string('numviews', '', $numviews);
 218         $result->time = $lastlog->time;
 219
 220         return $result;
 221     }
 222     return NULL;
 223 }
 224
 225 /**
 226  * Return use complete
 227  * @param object $course
 228  * @param object $user
 229  * @param object $mod
 230  * @param object $imscp
 231  */
 232 function imscp_user_complete($course, $user, $mod, $imscp) {
 233     global $CFG, $DB;
 234
 235     if ($logs = $DB->get_records('log', array('userid'=>$user->id, 'module'=>'imscp',
 236                                               'action'=>'view', 'info'=>$imscp->id), 'time ASC')) {
 237         $numviews = count($logs);
 238         $lastlog = array_pop($logs);
 239
 240         $strmostrecently = get_string('mostrecently');
 241         $strnumviews = get_string('numviews', '', $numviews);
 242
 243         echo "$strnumviews - $strmostrecently ".userdate($lastlog->time);
 244
 245     } else {
 246         print_string('neverseen', 'imscp');
 247     }
 248 }
 249
 250 /**
 251  * Lists all browsable file areas
 252  *
 253  * @package  mod_imscp
 254  * @category files
 255  * @param stdClass $course course object
 256  * @param stdClass $cm course module object
 257  * @param stdClass $context context object
 258  * @return array
 259  */
 260 function imscp_get_file_areas($course, $cm, $context) {
 261     $areas = array();
 262
 263     $areas['content'] = get_string('areacontent', 'imscp');
 264     $areas['backup']  = get_string('areabackup', 'imscp');
 265
 266     return $areas;
 267 }
 268
 269 /**
 270  * File browsing support for imscp module ontent area.
 271  *
 272  * @package  mod_imscp
 273  * @category files
 274  * @param stdClass $browser file browser
 275  * @param stdClass $areas file areas
 276  * @param stdClass $course course object
 277  * @param stdClass $cm course module object
 278  * @param stdClass $context context object
 279  * @param string $filearea file area
 280  * @param int $itemid item ID
 281  * @param string $filepath file path
 282  * @param string $filename file name
 283  * @return file_info instance or null if not found
 284  */
 285 function imscp_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
 286     global $CFG, $DB;
 287
 288     // note: imscp_intro handled in file_browser automatically
 289
 290     if (!has_capability('moodle/course:managefiles', $context)) {
 291         // no peaking here for students!!
 292         return null;
 293     }
 294
 295     if ($filearea !== 'content' and $filearea !== 'backup') {
 296         return null;
 297     }
 298
 299     require_once("$CFG->dirroot/mod/imscp/locallib.php");
 300
 301     if (is_null($itemid)) {
 302         return new imscp_file_info($browser, $course, $cm, $context, $areas, $filearea, $itemid);
 303     }
 304
 305     $fs = get_file_storage();
 306     $filepath = is_null($filepath) ? '/' : $filepath;
 307     $filename = is_null($filename) ? '.' : $filename;
 308     if (!$storedfile = $fs->get_file($context->id, 'mod_imscp', $filearea, $itemid, $filepath, $filename)) {
 309         return null;
 310     }
 311
 312     // do not allow manual modification of any files!
 313     $urlbase = $CFG->wwwroot.'/pluginfile.php';
 314     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false); //no writing here!
 315 }
 316
 317 /**
 318  * Serves the imscp files.
 319  *
 320  * @package  mod_imscp
 321  * @category files
 322  * @param stdClass $course course object
 323  * @param stdClass $cm course module object
 324  * @param stdClass $context context object
 325  * @param string $filearea file area
 326  * @param array $args extra arguments
 327  * @param bool $forcedownload whether or not force download
 328  * @param array $options additional options affecting the file serving
 329  * @return bool false if file not found, does not return if found - justsend the file
 330  */
 331 function imscp_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
 332     global $CFG, $DB;
 333
 334     if ($context->contextlevel != CONTEXT_MODULE) {
 335         return false;
 336     }
 337
 338     require_login($course, true, $cm);
 339
 340     if ($filearea === 'content') {
 341         if (!has_capability('mod/imscp:view', $context)) {
 342             return false;
 343         }
 344         $revision = array_shift($args);
 345         $fs = get_file_storage();
 346         $relativepath = implode('/', $args);
 347         if ($relativepath === 'imsmanifest.xml') {
 348             if (!has_capability('moodle/course:managefiles', $context)) {
 349                 // no stealing of detailed package info ;-)
 350                 return false;
 351             }
 352         }
 353         $fullpath = "/$context->id/mod_imscp/$filearea/$revision/$relativepath";
 354         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
 355             return false;
 356         }
 357
 358         // finally send the file
 359         send_stored_file($file, 86400, 0, $forcedownload, $options);
 360
 361     } else if ($filearea === 'backup') {
 362         if (!has_capability('moodle/course:managefiles', $context)) {
 363             // no stealing of package backups
 364             return false;
 365         }
 366         $revision = array_shift($args);
 367         $fs = get_file_storage();
 368         $relativepath = implode('/', $args);
 369         $fullpath = "/$context->id/mod_imscp/$filearea/$revision/$relativepath";
 370         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
 371             return false;
 372         }
 373
 374         // finally send the file
 375         send_stored_file($file, 86400, 0, $forcedownload, $options);
 376
 377     } else {
 378         return false;
 379     }
 380 }
 381
 382 /**
 383  * Return a list of page types
 384  * @param string $pagetype current page type
 385  * @param stdClass $parentcontext Block's parent context
 386  * @param stdClass $currentcontext Current context of block
 387  */
 388 function imscp_page_type_list($pagetype, $parentcontext, $currentcontext) {
 389     $module_pagetype = array('mod-imscp-*'=>get_string('page-mod-imscp-x', 'imscp'));
 390     return $module_pagetype;
 391 }