lib.php

<?php

/**
 * *************************************************************************
 * *                         OOHOO - Tab Display                          **
 * *************************************************************************
 * @package     mod                                                       **
 * @subpackage  tab                                                       **
 * @name        tab                                                       **
 * @copyright   oohoo.biz                                                 **
 * @link        http://oohoo.biz                                          **
 * @author      Patrick Thibaudeau                                        **
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later  **
 * *************************************************************************
 * ************************************************************************ */
defined('MOODLE_INTERNAL') || die;

/**
 * List of features supported in Tab display
 * @param string $feature FEATURE_xx constant for requested feature
 * @return bool|null True if module supports feature, false if not, null if doesn't know
 * @uses FEATURE_IDNUMBER
 * @uses FEATURE_GROUPS
 * @uses FEATURE_GROUPINGS
 * @uses FEATURE_GROUPMEMBERSONLY
 * @uses FEATURE_MOD_INTRO
 * @uses FEATURE_COMPLETION_TRACKS_VIEWS
 * @uses FEATURE_GRADE_HAS_GRADE
 * @uses FEATURE_GRADE_OUTCOMES
 */
function tab_supports($feature) {
    switch ($feature) {
        case FEATURE_IDNUMBER:
            return false;
        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_MOD_ARCHETYPE:
            return MOD_ARCHETYPE_RESOURCE;
        case FEATURE_BACKUP_MOODLE2:
            return true;

        default:
            return null;
    }
}

/**
 * Returns all other caps used in module
 * @return array
 */
function tab_get_extra_capabilities() {
    return array('moodle/site:accessallgroups');
}

/**
 * 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 tab_reset_userdata($tab) {
    return array();
}

/**
 * List of view style log actions
 * @return array
 */
function tab_get_view_actions() {
    return array('view', 'view all');
}

/**
 * List of update style log actions
 * @return array
 */
function tab_get_post_actions() {
    return array('update', 'add');
}

/**
 * Add tab display instance.
 * @param object $data
 * @param object $mform
 * @return int new page instance id
 */
function tab_add_instance($tab) {
    global $CFG, $DB;

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

    $cmid = $tab->coursemodule;
    $tab->timemodified = time();


    //insert tabs and content
    if ($tab->id = $DB->insert_record("tab", $tab)) {

        // 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', $tab->id, array('id' => $cmid));
        $context = context_module::instance($cmid);
        $editoroptions = array('subdirs' => 1, 'maxbytes' => $CFG->maxbytes, 'maxfiles' => -1, 'changeformat' => 1, 'context' => $context, 'noclean' => 1, 'trusttext' => true);

        foreach ($tab->tabname as $key => $value) {
            $value = trim($value);
            if (isset($value) && $value <> '') {
                $option = new stdClass();
                $option->tabname = $value;
                $option->tabid = $tab->id;

                if (isset($tab->content[$key]['format'])) {
                    $option->contentformat = $tab->content[$key]['format'];
                }

                if (isset($tab->tabcontentorder[$key])) {
                    $option->tabcontentorder = $tab->tabcontentorder[$key];
                }

                if (isset($tab->content[$key]['externalurl'])) {
                    $option->externalurl = $tab->content[$key]['externalurl'];
                }
                $option->timemodified = time();
                //Must get id number from inserted record to update the editor field (tabcontent)
                $newtab_content_id = $DB->insert_record("tab_content", $option);

                //tab content is now an array due to the new editor
                //In order to enter file information from the editor
                //We must now update the record once it has been created

                if (isset($tab->content[$key]['text'])) {
                    $draftitemid = $tab->content[$key]['itemid'];
                    if ($draftitemid) {
                        $tabcontentupdate = new stdClass();
                        $tabcontentupdate->id = $newtab_content_id;
                        $tabcontentupdate->tabcontent = file_save_draft_area_files($draftitemid, $context->id, 'mod_tab', 'content', $newtab_content_id, $editoroptions, $tab->content[$key]['text']);
                        $DB->update_record('tab_content', $tabcontentupdate);
                    }
                }
            }
        }
    }
    return $tab->id;
}

/**
 * Given an object containing all the necessary data,
 * (defined by the form in mod.html) this function
 * will update an existing instance with new data.
 *
 * @param object $instance An object from the form in mod.html
 * @return boolean Success/Fail
 * *@global stdClass $CFG
 * @global moodle_database $DB
 */
function tab_update_instance($tab) {
    global $CFG, $DB;

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

    $cmid = $tab->coursemodule;

    $tab->timemodified = time();
    $tab->id = $tab->instance;

    foreach ($tab->tabname as $key => $value) {

        // 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', $tab->id, array('id' => $cmid));
        $context = context_module::instance($cmid);
        $editoroptions = array('subdirs' => 1, 'maxbytes' => $CFG->maxbytes, 'maxfiles' => -1, 'changeformat' => 1, 'context' => $context, 'noclean' => 1, 'trusttext' => true);


        $value = trim($value);
        $option = new stdClass();
        $option->tabname = $value;
        $option->tabcontentorder = $tab->tabcontentorder[$key];
        $option->externalurl = $tab->externalurl[$key];
        //tab content is now an array due to the new editor
        $draftitemid = $tab->content[$key]['itemid'];

        if ($draftitemid) {
            $option->tabcontent = file_save_draft_area_files($draftitemid, $context->id, 'mod_tab', 'content', $tab->optionid[$key], $editoroptions, $tab->content[$key]['text']);
        }
        $option->contentformat = $tab->content[$key]['format'];
        $option->tabid = $tab->id;
        $option->timemodified = time();

        if (isset($tab->optionid[$key]) && !empty($tab->optionid[$key])) {//existing tab record
            $option->id = $tab->optionid[$key];
            if (isset($value) && $value <> '') {
                $DB->update_record("tab_content", $option);
            } else { //empty old option - needs to be deleted.
                $DB->delete_records("tab_content", array("id" => $option->id));
            }
        } else {
            if (isset($value) && $value <> '') {
                $newtab_content_id = $DB->insert_record("tab_content", $option);
                //tab content is now an array due to the new editor
                //In order to enter file information from the editor
                //We must now update the record once it has been created

                if (isset($tab->content[$key]['text'])) {
                    $draftitemid = $tab->content[$key]['itemid'];
                    if ($draftitemid) {
                        $tabcontentupdate = new stdClass();
                        $tabcontentupdate->id = $newtab_content_id;
                        $tabcontentupdate->tabcontent = file_save_draft_area_files($draftitemid, $context->id, 'mod_tab', 'content', $newtab_content_id, $editoroptions, $tab->content[$key]['text']);
                        $DB->update_record('tab_content', $tabcontentupdate);
                    }
                }
            }
        }
    }
    return $DB->update_record("tab", $tab);
}

/**
 * Given an ID of an instance of this module,
 * this function will permanently delete the instance
 * and any data that depends on it.
 *
 * @param int $id Id of the module instance
 * @return boolean Success/Failure
 * *@global moodle_database $DB
 */
function tab_delete_instance($id) {
    global $DB;

    if (!$tab = $DB->get_record("tab", array("id" => "$id"))) {
        return false;
    }

    $result = true;

    # Delete any dependent records here #

    if (!$DB->delete_records("tab", array("id" => "$tab->id"))) {
        $result = false;
    }
    if (!$DB->delete_records("tab_content", array("tabid" => "$tab->id"))) {
        $result = false;
    }

    return $result;
}

/**
 * Lists all browsable file areas
 *
 * @param stdClass $course course object
 * @param stdClass $cm course module object
 * @param stdClass $context context object
 * @return array
 * @package  mod_tab
 * @category files
 */
function tab_get_file_areas($course, $cm, $context) {
    $areas = array();
    $areas['content'] = get_string('content', 'tab');
    return $areas;
}

/**
 * File browsing support for languagelab module content area.
 *
 * @param stdClass $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
 * @package  mod_tab
 * @category files
 */
function tab_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_tab', 'content', $itemid, $filepath, $filename)) {
            if ($filepath === '/' and $filename === '.') {
                $storedfile = new virtual_root_file($context->id, 'mod_tab', 'content', $itemid);
            } else {
                // not found
                return null;
            }
        }
        require_once("$CFG->dirroot/mod/tab/locallib.php");
        return new tab_content_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, true, false);
    }

    // note: page_intro handled in file_browser automatically

    return null;
}

/**
 * Serves the tab images or files. Implements needed access control ;-)
 *
 * @param object $course
 * @param object $cm
 * @param object $context
 * @param string $filearea
 * @param array $args
 * @param bool $forcedownload
 * @return bool false if file not found, does not return if found - justsend the file
 * @global moodle_database $DB
 * @global stdClass $CFG
 */
function tab_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
    global $CFG, $DB;

    //The following code is for security
    require_course_login($course, true, $cm);

    if ($context->contextlevel != CONTEXT_MODULE) {
        return false;
    }

    $fileareas = array('mod_tab', 'content');
    if (!in_array($filearea, $fileareas)) {
        return false;
    }
    //id of the content row
    $tabcontentid = (int)array_shift($args);

    //Security - Check if exists
    if (!$tabcontent = $DB->get_record('tab_content', array('id' => $tabcontentid))) {
        return false;
    }

    if (!$tab = $DB->get_record('tab', array('id' => $cm->instance))) {
        return false;
    }

    //Now gather file information
    $fs = get_file_storage();
    $relativepath = implode('/', $args);
    $fullpath = "/$context->id/mod_tab/$filearea/$tabcontentid/$relativepath";

    if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
        return false;
    }

    // finally send the file
    send_stored_file($file, 0, 0, $forcedownload);
}

/**
 * Return a small object with summary information about what a
 * user has done with a given particular instance of this module
 * Used for user activity reports.
 * $return->time = the time they did it
 * $return->info = a short text description
 *
 * @return null
 * @global moodle_database $DB
 * @todo Finish documenting this function
 * */
function tab_user_outline($course, $user, $mod, $tab) {
    global $DB;

    if ($logs = $DB->get_records('log', array('userid' => $user->id, 'module' => 'tab',
        'action' => 'view', 'info' => $tab->id . ' - ' . $tab->name), 'time ASC')) {

        $numviews = count($logs);
        $lastlog = array_pop($logs);

        $result = new stdClass();
        $result->info = get_string('numviews', '', $numviews);
        $result->time = $lastlog->time;

        return $result;
    }
    return NULL;
}

/**
 * Print a detailed representation of what a user has done with
 * a given particular instance of this module, for user activity reports.
 *
 * @return boolean
 * @global moodle_database $DB
 * @global stdClass $CFG
 * @todo Finish documenting this function
 * */
function tab_user_complete($course, $user, $mod, $tab) {
    global $CFG, $DB;

    if ($logs = $DB->get_records('log', array('userid' => $user->id, 'module' => 'tab',
        'action' => 'view', 'info' => $tab->id . ' - ' . $tab->name), 'time ASC')) {
        $numviews = count($logs);
        $lastlog = array_pop($logs);

        $strmostrecently = get_string('mostrecently');
        $strnumviews = get_string('numviews', '', $numviews);

        echo "$strnumviews - $strmostrecently " . userdate($lastlog->time);
    } else {
        print_string('neverseen', 'tab');
    }
}

/**
 * Given a course and a time, this module should find recent activity
 * that has occurred in tab activities and print it out.
 * Return true if there was output, or false is there was none.
 *
 * @return boolean
 * @global $CFG
 * @todo Finish documenting this function
 * */
function tab_print_recent_activity($course, $viewfullnames, $timestart) {
    global $CFG;

    return false;  //  True if anything was printed, otherwise false
}

/**
 * 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 get_array_of_activities()} in course/lib.php
 *
 * @param object $coursemodule
 * @return object info
 * @global stdClass $CFG
 * @global moodle_database $DB
 */
function tab_get_coursemodule_info($coursemodule) {
    global $CFG, $DB;
    require_once("$CFG->libdir/resourcelib.php");

    if (!$tab = $DB->get_record('tab', array('id' => $coursemodule->instance), 'id, name')) {
        return NULL;
    }

    $info = new stdClass();
    $info->name = $tab->name;

    return $info;
}