Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * @package    mod_resource

 * @copyright  2009 Petr Skoda  {@link http://skodak.org}

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

defined('MOODLE_INTERNAL') || die;

/**

 * List of features supported in Resource module

 * @param string $feature FEATURE_xx constant for requested feature

 * @return mixed True if module supports feature, false if not, null if doesn't know or string for the module purpose.

 */

function resource_supports($feature) {

    switch($feature) {

        case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;

        case FEATURE_GROUPS:                  return false;

        case FEATURE_GROUPINGS:               return false;

        case FEATURE_MOD_INTRO:               return true;

        case FEATURE_COMPLETION_TRACKS_VIEWS: return true;

        case FEATURE_GRADE_HAS_GRADE:         return false;

        case FEATURE_GRADE_OUTCOMES:          return false;

        case FEATURE_BACKUP_MOODLE2:          return true;

        case FEATURE_SHOW_DESCRIPTION:        return true;

        case FEATURE_MOD_PURPOSE:             return MOD_PURPOSE_CONTENT;

        default: return null;

    }

}

/**

 * This function is used by the reset_course_userdata function in moodlelib.

 * @param $data the data submitted from the reset course.

 * @return array status array

 */

function resource_reset_userdata($data) {

    // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.

    // See MDL-9367.

    return array();

}

/**

 * List the actions that correspond to a view of this module.

 * This is used by the participation report.

 *

 * Note: This is not used by new logging system. Event with

 *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will

 *       be considered as view action.

 *

 * @return array

 */

function resource_get_view_actions() {

    return array('view','view all');

}

/**

 * List the actions that correspond to a post of this module.

 * This is used by the participation report.

 *

 * Note: This is not used by new logging system. Event with

 *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING

 *       will be considered as post action.

 *

 * @return array

 */

function resource_get_post_actions() {

    return array('update', 'add');

}

/**

 * Add resource instance.

 * @param object $data

 * @param object $mform

 * @return int new resource instance id

 */

function resource_add_instance($data, $mform) {

    global $CFG, $DB;

    require_once("$CFG->libdir/resourcelib.php");

    require_once("$CFG->dirroot/mod/resource/locallib.php");

    $cmid = $data->coursemodule;

    $data->timemodified = time();

    resource_set_display_options($data);

    $data->id = $DB->insert_record('resource', $data);

    // we need to use context now, so we need to make sure all needed info is already in db

    $DB->set_field('course_modules', 'instance', $data->id, array('id'=>$cmid));

    resource_set_mainfile($data);

    $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;

    \core_completion\api::update_completion_date_event($cmid, 'resource', $data->id, $completiontimeexpected);

    return $data->id;

}

/**

 * Update resource instance.

 * @param object $data

 * @param object $mform

 * @return bool true

 */

function resource_update_instance($data, $mform) {

    global $CFG, $DB;

    require_once("$CFG->libdir/resourcelib.php");

    $data->timemodified = time();

    $data->id           = $data->instance;

    $data->revision++;

    resource_set_display_options($data);

    $DB->update_record('resource', $data);

    resource_set_mainfile($data);

    $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;

    \core_completion\api::update_completion_date_event($data->coursemodule, 'resource', $data->id, $completiontimeexpected);

    return true;

}

/**

 * Updates display options based on form input.

 *

 * Shared code used by resource_add_instance and resource_update_instance.

 *

 * @param object $data Data object

 */

function resource_set_display_options($data) {

    $displayoptions = array();

    if ($data->display == RESOURCELIB_DISPLAY_POPUP) {

        $displayoptions['popupwidth']  = $data->popupwidth;

        $displayoptions['popupheight'] = $data->popupheight;

    }

    if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {

        $displayoptions['printintro']   = (int)!empty($data->printintro);

    }

    if (!empty($data->showsize)) {

        $displayoptions['showsize'] = 1;

    }

    if (!empty($data->showtype)) {

        $displayoptions['showtype'] = 1;

    }

    if (!empty($data->showdate)) {

        $displayoptions['showdate'] = 1;

    }

    $data->displayoptions = serialize($displayoptions);

}

/**

 * Delete resource instance.

 * @param int $id

 * @return bool true

 */

function resource_delete_instance($id) {

    global $DB;

    if (!$resource = $DB->get_record('resource', array('id'=>$id))) {

        return false;

    }

    $cm = get_coursemodule_from_instance('resource', $id);

    \core_completion\api::update_completion_date_event($cm->id, 'resource', $id, null);

    // note: all context files are deleted automatically

    $DB->delete_records('resource', array('id'=>$resource->id));

    return true;

}

/**

 * Given a course_module object, this function returns any

 * "extra" information that may be needed when printing

 * this activity in a course listing.

 *

 * See {@link course_modinfo::get_array_of_activities()}

 *

 * @param stdClass $coursemodule

 * @return cached_cm_info info

 */

function resource_get_coursemodule_info($coursemodule) {

    global $CFG, $DB;

    require_once("$CFG->libdir/filelib.php");

    require_once("$CFG->dirroot/mod/resource/locallib.php");

    require_once($CFG->libdir.'/completionlib.php');

    $context = context_module::instance($coursemodule->id);

    if (!$resource = $DB->get_record('resource', array('id'=>$coursemodule->instance),

            'id, name, display, displayoptions, tobemigrated, revision, intro, introformat')) {

        return NULL;

    }

    $info = new cached_cm_info();

    $info->name = $resource->name;

    if ($coursemodule->showdescription) {

        // Convert intro to html. Do not filter cached version, filters run at display time.

        $info->content = format_module_intro('resource', $resource, $coursemodule->id, false);

    }

    if ($resource->tobemigrated) {

        return $info;

    }

    // See if there is at least one file.

    $fs = get_file_storage();

    $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false, 0, 0, 1);

    if (count($files) >= 1) {

        $mainfile = reset($files);

        $resource->mainfile = $mainfile->get_filename();

        $info->icon = file_file_icon($mainfile);

        $info->customdata['filtericon'] = true;

    }

    $display = resource_get_final_display_type($resource);

    if ($display == RESOURCELIB_DISPLAY_POPUP) {

        $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&redirect=1";

        $options = empty($resource->displayoptions) ? [] : (array) unserialize_array($resource->displayoptions);

        $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];

        $height = empty($options['popupheight']) ? 450 : $options['popupheight'];

        $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";

        $info->onclick = "window.open('$fullurl', '', '$wh'); return false;";

    } else if ($display == RESOURCELIB_DISPLAY_NEW) {

        $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&redirect=1";

        $info->onclick = "window.open('$fullurl'); return false;";

    }

    // If any optional extra details are turned on, store in custom data,

    // add some file details as well to be used later by resource_get_optional_details() without retriving.

    // Do not store filedetails if this is a reference - they will still need to be retrieved every time.

    if (($filedetails = resource_get_file_details($resource, $coursemodule)) && empty($filedetails['isref'])) {

        $displayoptions = (array) unserialize_array($resource->displayoptions);

        $displayoptions['filedetails'] = $filedetails;

        $info->customdata['displayoptions'] = serialize($displayoptions);

    } else {

        $info->customdata['displayoptions'] = $resource->displayoptions;

    }

    $info->customdata['display'] = $display;

    return $info;

}

/**

 * Called when viewing course page. Shows extra details after the link if

 * enabled.

 *

 * @param cm_info $cm Course module information

 */

function resource_cm_info_view(cm_info $cm) {

    global $CFG;

    require_once($CFG->dirroot . '/mod/resource/locallib.php');

    $customdata = $cm->customdata;

    if (is_array($customdata) && isset($customdata['displayoptions'])) {

        $resource = (object) ['displayoptions' => $customdata['displayoptions']];

        $details = resource_get_optional_details($resource, $cm, false);

        if ($details) {

            $cm->set_after_link(' ' . html_writer::tag('span', $details, ['class' => 'resourcelinkdetails']));

        }

    }

}

/**

 * Lists all browsable file areas

 *

 * @package  mod_resource

 * @category files

 * @param stdClass $course course object

 * @param stdClass $cm course module object

 * @param stdClass $context context object

 * @return array

 */

function resource_get_file_areas($course, $cm, $context) {

    $areas = array();

    $areas['content'] = get_string('resourcecontent', 'resource');

    return $areas;

}

/**

 * File browsing support for resource module content area.

 *

 * @package  mod_resource

 * @category files

 * @param file_browser $browser file browser instance

 * @param stdClass $areas file areas

 * @param stdClass $course course object

 * @param stdClass $cm course module object

 * @param stdClass $context context object

 * @param string $filearea file area

 * @param int $itemid item ID

 * @param string $filepath file path

 * @param string $filename file name

 * @return file_info instance or null if not found

 */

function resource_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {

    global $CFG;

    if (!has_capability('moodle/course:managefiles', $context)) {

        // students can not peak here!

        return null;

    }

    $fs = get_file_storage();

    if ($filearea === 'content') {

        $filepath = is_null($filepath) ? '/' : $filepath;

        $filename = is_null($filename) ? '.' : $filename;

        $urlbase = $CFG->wwwroot.'/pluginfile.php';

        if (!$storedfile = $fs->get_file($context->id, 'mod_resource', 'content', 0, $filepath, $filename)) {

            if ($filepath === '/' and $filename === '.') {

                $storedfile = new virtual_root_file($context->id, 'mod_resource', 'content', 0);

            } else {

                // not found

                return null;

            }

        }

        require_once("$CFG->dirroot/mod/resource/locallib.php");

        return new resource_content_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, true, false);

    }

    // note: resource_intro handled in file_browser automatically

    return null;

}

/**

 * Serves the resource files.

 *

 * @package  mod_resource

 * @category files

 * @param stdClass $course course object

 * @param stdClass $cm course module object

 * @param stdClass $context context object

 * @param string $filearea file area

 * @param array $args extra arguments

 * @param bool $forcedownload whether or not force download

 * @param array $options additional options affecting the file serving

 * @return bool false if file not found, does not return if found - just send the file

 */

function resource_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {

    global $CFG, $DB;

    require_once("$CFG->libdir/resourcelib.php");

    if ($context->contextlevel != CONTEXT_MODULE) {

        return false;

    }

    require_course_login($course, true, $cm);

    if (!has_capability('mod/resource:view', $context)) {

        return false;

    }

    if ($filearea !== 'content') {

        // intro is handled automatically in pluginfile.php

        return false;

    }

    array_shift($args); // ignore revision - designed to prevent caching problems only

    $fs = get_file_storage();

    $relativepath = implode('/', $args);

    $fullpath = rtrim("/$context->id/mod_resource/$filearea/0/$relativepath", '/');

    do {

        if (!$file = $fs->get_file_by_hash(sha1($fullpath))) {

            if ($fs->get_file_by_hash(sha1("$fullpath/."))) {

                if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.htm"))) {

                    break;

                }

                if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.html"))) {

                    break;

                }

                if ($file = $fs->get_file_by_hash(sha1("$fullpath/Default.htm"))) {

                    break;

                }

            }

            $resource = $DB->get_record('resource', array('id'=>$cm->instance), 'id, legacyfiles', MUST_EXIST);

            if ($resource->legacyfiles != RESOURCELIB_LEGACYFILES_ACTIVE) {

                return false;

            }

            if (!$file = resourcelib_try_file_migration('/'.$relativepath, $cm->id, $cm->course, 'mod_resource', 'content', 0)) {

                return false;

            }

            // file migrate - update flag

            $resource->legacyfileslast = time();

            $DB->update_record('resource', $resource);

        }

    } while (false);

    // should we apply filters?

    $mimetype = $file->get_mimetype();

    if ($mimetype === 'text/html' or $mimetype === 'text/plain' or $mimetype === 'application/xhtml+xml') {

        $filter = $DB->get_field('resource', 'filterfiles', array('id'=>$cm->instance));

        $CFG->embeddedsoforcelinktarget = true;

    } else {

        $filter = 0;

    }

    // finally send the file

    send_stored_file($file, null, $filter, $forcedownload, $options);

}

/**

 * Return a list of page types

 * @param string $pagetype current page type

 * @param stdClass $parentcontext Block's parent context

 * @param stdClass $currentcontext Current context of block

 */

function resource_page_type_list($pagetype, $parentcontext, $currentcontext) {

    $module_pagetype = array('mod-resource-*'=>get_string('page-mod-resource-x', 'resource'));

    return $module_pagetype;

}

/**

 * Export file resource contents

 *

 * @return array of file content

 */

function resource_export_contents($cm, $baseurl) {

    global $CFG, $DB;

    $contents = array();

    $context = context_module::instance($cm->id);

    $resource = $DB->get_record('resource', array('id'=>$cm->instance), '*', MUST_EXIST);

    $fs = get_file_storage();

    $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false);

    foreach ($files as $fileinfo) {

        $file = array();

        $file['type'] = 'file';

        $file['filename']     = $fileinfo->get_filename();

        $file['filepath']     = $fileinfo->get_filepath();

        $file['filesize']     = $fileinfo->get_filesize();

        $file['fileurl']      = file_encode_url("$CFG->wwwroot/" . $baseurl, '/'.$context->id.'/mod_resource/content/'.$resource->revision.$fileinfo->get_filepath().$fileinfo->get_filename(), true);

        $file['timecreated']  = $fileinfo->get_timecreated();

        $file['timemodified'] = $fileinfo->get_timemodified();

        $file['sortorder']    = $fileinfo->get_sortorder();

        $file['userid']       = $fileinfo->get_userid();

        $file['author']       = $fileinfo->get_author();

        $file['license']      = $fileinfo->get_license();

        $file['mimetype']     = $fileinfo->get_mimetype();

        $file['isexternalfile'] = $fileinfo->is_external_file();

        if ($file['isexternalfile']) {

            $file['repositorytype'] = $fileinfo->get_repository_type();

        }

        $contents[] = $file;

    }

    return $contents;

}

/**

 * Register the ability to handle drag and drop file uploads

 * @return array containing details of the files / types the mod can handle

 */

function resource_dndupload_register() {

    return array('files' => array(

                     array('extension' => '*', 'message' => get_string('dnduploadresource', 'mod_resource'))

                 ));

}

/**

 * Handle a file that has been uploaded

 * @param object $uploadinfo details of the file / content that has been uploaded

 * @return int instance id of the newly created mod

 */

function resource_dndupload_handle($uploadinfo) {

    // Gather the required info.

    $data = new stdClass();

    $data->course = $uploadinfo->course->id;

    $data->name = $uploadinfo->displayname;

    $data->intro = '';

    $data->introformat = FORMAT_HTML;

    $data->coursemodule = $uploadinfo->coursemodule;

    $data->files = $uploadinfo->draftitemid;

    // Set the display options to the site defaults.

    $config = get_config('resource');

    $data->display = $config->display;

    $data->popupheight = $config->popupheight;

    $data->popupwidth = $config->popupwidth;

    $data->printintro = $config->printintro;

    $data->showsize = (isset($config->showsize)) ? $config->showsize : 0;

    $data->showtype = (isset($config->showtype)) ? $config->showtype : 0;

    $data->showdate = (isset($config->showdate)) ? $config->showdate : 0;

    $data->filterfiles = $config->filterfiles;

    return resource_add_instance($data, null);

}

/**

 * Mark the activity completed (if required) and trigger the course_module_viewed event.

 *

 * @param  stdClass $resource   resource object

 * @param  stdClass $course     course object

 * @param  stdClass $cm         course module object

 * @param  stdClass $context    context object

 * @since Moodle 3.0

 */

function resource_view($resource, $course, $cm, $context) {

    // Trigger course_module_viewed event.

    $params = array(

        'context' => $context,

        'objectid' => $resource->id

    );

    $event = \mod_resource\event\course_module_viewed::create($params);

    $event->add_record_snapshot('course_modules', $cm);

    $event->add_record_snapshot('course', $course);

    $event->add_record_snapshot('resource', $resource);

    $event->trigger();

    // Completion.

    $completion = new completion_info($course);

    $completion->set_module_viewed($cm);

}

/**

 * Check if the module has any update that affects the current user since a given time.

 *

 * @param  cm_info $cm course module data

 * @param  int $from the time to check updates from

 * @param  array $filter  if we need to check only specific updates

 * @return stdClass an object with the different type of areas indicating if they were updated or not

 * @since Moodle 3.2

 */

function resource_check_updates_since(cm_info $cm, $from, $filter = array()) {

    $updates = course_check_module_updates_since($cm, $from, array('content'), $filter);

    return $updates;

}

/**

 * This function receives a calendar event and returns the action associated with it, or null if there is none.

 *

 * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event

 * is not displayed on the block.

 *

 * @param calendar_event $event

 * @param \core_calendar\action_factory $factory

 * @return \core_calendar\local\event\entities\action_interface|null

 */

function mod_resource_core_calendar_provide_event_action(calendar_event $event,

                                                      \core_calendar\action_factory $factory, $userid = 0) {

    global $USER;

    if (empty($userid)) {

        $userid = $USER->id;

    }

    $cm = get_fast_modinfo($event->courseid, $userid)->instances['resource'][$event->instance];

    $completion = new \completion_info($cm->get_course());

    $completiondata = $completion->get_data($cm, false, $userid);

    if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {

        return null;

    }

    return $factory->create_instance(

        get_string('view'),

        new \moodle_url('/mod/resource/view.php', ['id' => $cm->id]),

        1,

        true

    );

}

/**

 * Given an array with a file path, it returns the itemid and the filepath for the defined filearea.

 *

 * @param  string $filearea The filearea.

 * @param  array  $args The path (the part after the filearea and before the filename).

 * @return array The itemid and the filepath inside the $args path, for the defined filearea.

 */

function mod_resource_get_path_from_pluginfile(string $filearea, array $args): array {

    // Resource never has an itemid (the number represents the revision but it's not stored in database).

    array_shift($args);

    // Get the filepath.

    if (empty($args)) {

        $filepath = '/';

    } else {

        $filepath = '/' . implode('/', $args) . '/';

    }

    return [

        'itemid' => 0,

        'filepath' => $filepath,

    ];

}