Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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/>.

/**
 * Library of functions and constants for module glossary
 * (replace glossary with the name of your module and delete this line)
 *
 * @package   mod_glossary
 * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
require_once($CFG->libdir . '/completionlib.php');

define("GLOSSARY_SHOW_ALL_CATEGORIES", 0);
define("GLOSSARY_SHOW_NOT_CATEGORISED", -1);

define("GLOSSARY_NO_VIEW", -1);
define("GLOSSARY_STANDARD_VIEW", 0);
define("GLOSSARY_CATEGORY_VIEW", 1);
define("GLOSSARY_DATE_VIEW", 2);
define("GLOSSARY_AUTHOR_VIEW", 3);
define("GLOSSARY_ADDENTRY_VIEW", 4);
define("GLOSSARY_IMPORT_VIEW", 5);
define("GLOSSARY_EXPORT_VIEW", 6);
define("GLOSSARY_APPROVAL_VIEW", 7);

// Glossary tabs.
define('GLOSSARY_STANDARD', 'standard');
define('GLOSSARY_AUTHOR', 'author');
define('GLOSSARY_CATEGORY', 'category');
define('GLOSSARY_DATE', 'date');

// Glossary displayformats.
define('GLOSSARY_CONTINUOUS', 'continuous');
define('GLOSSARY_DICTIONARY', 'dictionary');
define('GLOSSARY_FULLWITHOUTAUTHOR', 'fullwithoutauthor');

require_once(__DIR__ . '/deprecatedlib.php');

/// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
/**
 * @global object
 * @param object $glossary
 * @return int
 */
function glossary_add_instance($glossary) {
    global $DB;
/// Given an object containing all the necessary data,
/// (defined by the form in mod_form.php) this function
/// will create a new instance and return the id number
/// of the new instance.

    if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
        $glossary->assesstimestart  = 0;
        $glossary->assesstimefinish = 0;
    }

    if (empty($glossary->globalglossary) ) {
        $glossary->globalglossary = 0;
    }

    if (!has_capability('mod/glossary:manageentries', context_system::instance())) {
        $glossary->globalglossary = 0;
    }

    $glossary->timecreated  = time();
    $glossary->timemodified = $glossary->timecreated;

    //Check displayformat is a valid one
    $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
    if (!in_array($glossary->displayformat, $formats)) {
< print_error('unknowformat', '', '', $glossary->displayformat);
> throw new \moodle_exception('unknowformat', '', '', $glossary->displayformat);
} $returnid = $DB->insert_record("glossary", $glossary); $glossary->id = $returnid; glossary_grade_item_update($glossary); $completiontimeexpected = !empty($glossary->completionexpected) ? $glossary->completionexpected : null; \core_completion\api::update_completion_date_event($glossary->coursemodule, 'glossary', $glossary->id, $completiontimeexpected); return $returnid; } /** * Given an object containing all the necessary data, * (defined by the form in mod_form.php) this function * will update an existing instance with new data. * * @global object * @global object * @param object $glossary * @return bool */ function glossary_update_instance($glossary) { global $CFG, $DB; if (empty($glossary->globalglossary)) { $glossary->globalglossary = 0; } if (!has_capability('mod/glossary:manageentries', context_system::instance())) { // keep previous unset($glossary->globalglossary); } $glossary->timemodified = time(); $glossary->id = $glossary->instance; if (empty($glossary->ratingtime) or empty($glossary->assessed)) { $glossary->assesstimestart = 0; $glossary->assesstimefinish = 0; } //Check displayformat is a valid one $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE'); if (!in_array($glossary->displayformat, $formats)) {
< print_error('unknowformat', '', '', $glossary->displayformat);
> throw new \moodle_exception('unknowformat', '', '', $glossary->displayformat);
} $DB->update_record("glossary", $glossary); if ($glossary->defaultapproval) { $DB->execute("UPDATE {glossary_entries} SET approved = 1 where approved <> 1 and glossaryid = ?", array($glossary->id)); } glossary_grade_item_update($glossary); $completiontimeexpected = !empty($glossary->completionexpected) ? $glossary->completionexpected : null; \core_completion\api::update_completion_date_event($glossary->coursemodule, 'glossary', $glossary->id, $completiontimeexpected); return true; } /** * Given an ID of an instance of this module, * this function will permanently delete the instance * and any data that depends on it. * * @global object * @param int $id glossary id * @return bool success */ function glossary_delete_instance($id) { global $DB, $CFG; if (!$glossary = $DB->get_record('glossary', array('id'=>$id))) { return false; } if (!$cm = get_coursemodule_from_instance('glossary', $id)) { return false; } if (!$context = context_module::instance($cm->id, IGNORE_MISSING)) { return false; } $fs = get_file_storage(); if ($glossary->mainglossary) { // unexport entries $sql = "SELECT ge.id, ge.sourceglossaryid, cm.id AS sourcecmid FROM {glossary_entries} ge JOIN {modules} m ON m.name = 'glossary' JOIN {course_modules} cm ON (cm.module = m.id AND cm.instance = ge.sourceglossaryid) WHERE ge.glossaryid = ? AND ge.sourceglossaryid > 0"; if ($exported = $DB->get_records_sql($sql, array($id))) { foreach ($exported as $entry) { $entry->glossaryid = $entry->sourceglossaryid; $entry->sourceglossaryid = 0; $newcontext = context_module::instance($entry->sourcecmid); if ($oldfiles = $fs->get_area_files($context->id, 'mod_glossary', 'attachment', $entry->id)) { foreach ($oldfiles as $oldfile) { $file_record = new stdClass(); $file_record->contextid = $newcontext->id; $fs->create_file_from_storedfile($file_record, $oldfile); } $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id); $entry->attachment = '1'; } else { $entry->attachment = '0'; } $DB->update_record('glossary_entries', $entry); } } } else { // move exported entries to main glossary $sql = "UPDATE {glossary_entries} SET sourceglossaryid = 0 WHERE sourceglossaryid = ?"; $DB->execute($sql, array($id)); } // Delete any dependent records $entry_select = "SELECT id FROM {glossary_entries} WHERE glossaryid = ?"; $DB->delete_records_select('comments', "contextid=? AND commentarea=? AND itemid IN ($entry_select)", array($id, 'glossary_entry', $context->id)); $DB->delete_records_select('glossary_alias', "entryid IN ($entry_select)", array($id)); $category_select = "SELECT id FROM {glossary_categories} WHERE glossaryid = ?"; $DB->delete_records_select('glossary_entries_categories', "categoryid IN ($category_select)", array($id)); $DB->delete_records('glossary_categories', array('glossaryid'=>$id)); $DB->delete_records('glossary_entries', array('glossaryid'=>$id)); // delete all files $fs->delete_area_files($context->id); glossary_grade_item_delete($glossary); \core_completion\api::update_completion_date_event($cm->id, 'glossary', $glossary->id, null); $DB->delete_records('glossary', array('id'=>$id)); // Reset caches. \mod_glossary\local\concept_cache::reset_glossary($glossary); return true; } /** * 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 * * @param object $course * @param object $user * @param object $mod * @param object $glossary * @return object|null */ function glossary_user_outline($course, $user, $mod, $glossary) { global $CFG; require_once("$CFG->libdir/gradelib.php"); $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id); if (empty($grades->items[0]->grades)) { $grade = false; } else { $grade = reset($grades->items[0]->grades); } if ($entries = glossary_get_user_entries($glossary->id, $user->id)) { $result = new stdClass(); $result->info = count($entries) . ' ' . get_string("entries", "glossary"); $lastentry = array_pop($entries); $result->time = $lastentry->timemodified; if ($grade) { if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) { $result->info .= ', ' . get_string('gradenoun') . ': ' . $grade->str_long_grade; } else { $result->info = get_string('gradenoun') . ': ' . get_string('hidden', 'grades'); } } return $result; } else if ($grade) { $result = (object) [ 'time' => grade_get_date_for_user_grade($grade, $user), ]; if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) { $result->info = get_string('gradenoun') . ': ' . $grade->str_long_grade; } else { $result->info = get_string('gradenoun') . ': ' . get_string('hidden', 'grades'); } return $result; } return NULL; } /** * @global object * @param int $glossaryid * @param int $userid * @return array */ function glossary_get_user_entries($glossaryid, $userid) { /// Get all the entries for a user in a glossary global $DB; return $DB->get_records_sql("SELECT e.*, u.firstname, u.lastname, u.email, u.picture FROM {glossary} g, {glossary_entries} e, {user} u WHERE g.id = ? AND e.glossaryid = g.id AND e.userid = ? AND e.userid = u.id ORDER BY e.timemodified ASC", array($glossaryid, $userid)); } /** * Print a detailed representation of what a user has done with * a given particular instance of this module, for user activity reports. * * @global object * @param object $course * @param object $user * @param object $mod * @param object $glossary */ function glossary_user_complete($course, $user, $mod, $glossary) { global $CFG, $OUTPUT; require_once("$CFG->libdir/gradelib.php"); $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id); if (!empty($grades->items[0]->grades)) { $grade = reset($grades->items[0]->grades); if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) { echo $OUTPUT->container(get_string('gradenoun') . ': ' . $grade->str_long_grade); if ($grade->str_feedback) { echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback); } } else { echo $OUTPUT->container(get_string('gradenoun') . ': ' . get_string('hidden', 'grades')); } } if ($entries = glossary_get_user_entries($glossary->id, $user->id)) { echo '<table width="95%" border="0"><tr><td>'; foreach ($entries as $entry) { $cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id); glossary_print_entry($course, $cm, $glossary, $entry,"","",0); echo '<p>'; } echo '</td></tr></table>'; } } /** * Returns all glossary entries since a given time for specified glossary * * @param array $activities sequentially indexed array of objects * @param int $index * @param int $timestart * @param int $courseid * @param int $cmid * @param int $userid defaults to 0 * @param int $groupid defaults to 0 * @return void adds items into $activities and increases $index */ function glossary_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid = 0, $groupid = 0) { global $COURSE, $USER, $DB; if ($COURSE->id == $courseid) { $course = $COURSE; } else { $course = $DB->get_record('course', array('id' => $courseid)); } $modinfo = get_fast_modinfo($course); $cm = $modinfo->cms[$cmid]; $context = context_module::instance($cm->id); if (!$cm->uservisible) { return; } $viewfullnames = has_capability('moodle/site:viewfullnames', $context); // Groups are not yet supported for glossary. See MDL-10728 . /* $accessallgroups = has_capability('moodle/site:accessallgroups', $context); $groupmode = groups_get_activity_groupmode($cm, $course); */ $params['timestart'] = $timestart; if ($userid) { $userselect = "AND u.id = :userid"; $params['userid'] = $userid; } else { $userselect = ''; } if ($groupid) { $groupselect = 'AND gm.groupid = :groupid'; $groupjoin = 'JOIN {groups_members} gm ON gm.userid=u.id'; $params['groupid'] = $groupid; } else { $groupselect = ''; $groupjoin = ''; } $approvedselect = ""; if (!has_capability('mod/glossary:approve', $context)) { $approvedselect = " AND ge.approved = 1 "; } $params['timestart'] = $timestart; $params['glossaryid'] = $cm->instance; $userfieldsapi = \core_user\fields::for_userpic(); $ufields = $userfieldsapi->get_sql('u', false, '', 'userid', false)->selects; $entries = $DB->get_records_sql(" SELECT ge.id AS entryid, ge.glossaryid, ge.concept, ge.definition, ge.approved, ge.timemodified, $ufields FROM {glossary_entries} ge JOIN {user} u ON u.id = ge.userid $groupjoin WHERE ge.timemodified > :timestart AND ge.glossaryid = :glossaryid $approvedselect $userselect $groupselect ORDER BY ge.timemodified ASC", $params); if (!$entries) { return; } foreach ($entries as $entry) { // Groups are not yet supported for glossary. See MDL-10728 . /* $usersgroups = null; if ($entry->userid != $USER->id) { if ($groupmode == SEPARATEGROUPS and !$accessallgroups) { if (is_null($usersgroups)) { $usersgroups = groups_get_all_groups($course->id, $entry->userid, $cm->groupingid); if (is_array($usersgroups)) { $usersgroups = array_keys($usersgroups); } else { $usersgroups = array(); } } if (!array_intersect($usersgroups, $modinfo->get_groups($cm->groupingid))) { continue; } } } */ $tmpactivity = new stdClass(); $tmpactivity->user = user_picture::unalias($entry, null, 'userid'); $tmpactivity->user->fullname = fullname($tmpactivity->user, $viewfullnames); $tmpactivity->type = 'glossary'; $tmpactivity->cmid = $cm->id; $tmpactivity->glossaryid = $entry->glossaryid; $tmpactivity->name = format_string($cm->name, true); $tmpactivity->sectionnum = $cm->sectionnum; $tmpactivity->timestamp = $entry->timemodified; $tmpactivity->content = new stdClass(); $tmpactivity->content->entryid = $entry->entryid; $tmpactivity->content->concept = $entry->concept; $tmpactivity->content->definition = $entry->definition; $tmpactivity->content->approved = $entry->approved; $activities[$index++] = $tmpactivity; } return true; } /** * Outputs the glossary entry indicated by $activity * * @param object $activity the activity object the glossary resides in * @param int $courseid the id of the course the glossary resides in * @param bool $detail not used, but required for compatibilty with other modules * @param int $modnames not used, but required for compatibilty with other modules * @param bool $viewfullnames not used, but required for compatibilty with other modules * @return void */ function glossary_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) { global $OUTPUT; echo html_writer::start_tag('div', array('class'=>'glossary-activity clearfix')); if (!empty($activity->user)) { echo html_writer::tag('div', $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid)), array('class' => 'glossary-activity-picture')); } echo html_writer::start_tag('div', array('class'=>'glossary-activity-content')); echo html_writer::start_tag('div', array('class'=>'glossary-activity-entry')); if (isset($activity->content->approved) && !$activity->content->approved) { $urlparams = array('g' => $activity->glossaryid, 'mode' => 'approval', 'hook' => $activity->content->concept); $class = array('class' => 'dimmed_text'); } else { $urlparams = array('g' => $activity->glossaryid, 'mode' => 'entry', 'hook' => $activity->content->entryid); $class = array(); } echo html_writer::link(new moodle_url('/mod/glossary/view.php', $urlparams), strip_tags($activity->content->concept), $class); echo html_writer::end_tag('div'); $url = new moodle_url('/user/view.php', array('course'=>$courseid, 'id'=>$activity->user->id)); $name = $activity->user->fullname; $link = html_writer::link($url, $name, $class); echo html_writer::start_tag('div', array('class'=>'user')); echo $link .' - '. userdate($activity->timestamp); echo html_writer::end_tag('div'); echo html_writer::end_tag('div'); echo html_writer::end_tag('div'); return; } /** * Given a course and a time, this module should find recent activity * that has occurred in glossary activities and print it out. * Return true if there was output, or false is there was none. * * @global object * @global object * @global object * @param object $course * @param object $viewfullnames * @param int $timestart * @return bool */ function glossary_print_recent_activity($course, $viewfullnames, $timestart) { global $CFG, $USER, $DB, $OUTPUT, $PAGE; //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0 if (!defined('GLOSSARY_RECENT_ACTIVITY_LIMIT')) { define('GLOSSARY_RECENT_ACTIVITY_LIMIT', 50); } $modinfo = get_fast_modinfo($course); $ids = array(); foreach ($modinfo->cms as $cm) { if ($cm->modname != 'glossary') { continue; } if (!$cm->uservisible) { continue; } $ids[$cm->instance] = $cm->id; } if (!$ids) { return false; } // generate list of approval capabilities for all glossaries in the course. $approvals = array(); foreach ($ids as $glinstanceid => $glcmid) { $context = context_module::instance($glcmid); if (has_capability('mod/glossary:view', $context)) { // get records glossary entries that are approved if user has no capability to approve entries. if (has_capability('mod/glossary:approve', $context)) { $approvals[] = ' ge.glossaryid = :glsid'.$glinstanceid.' '; } else { $approvals[] = ' (ge.approved = 1 AND ge.glossaryid = :glsid'.$glinstanceid.') '; } $params['glsid'.$glinstanceid] = $glinstanceid; } } if (count($approvals) == 0) { return false; } $userfieldsapi = \core_user\fields::for_userpic(); $userfields = $userfieldsapi->get_sql('u', false, '', 'userid', false)->selects; $selectsql = 'SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid, ' . $userfields; $countsql = 'SELECT COUNT(*)'; $joins = array(' FROM {glossary_entries} ge '); $joins[] = 'JOIN {user} u ON u.id = ge.userid '; $fromsql = implode("\n", $joins); $params['timestart'] = $timestart; $clausesql = ' WHERE ge.timemodified > :timestart '; if (count($approvals) > 0) { $approvalsql = 'AND ('. implode(' OR ', $approvals) .') '; } else { $approvalsql = ''; } $ordersql = 'ORDER BY ge.timemodified ASC'; $entries = $DB->get_records_sql($selectsql.$fromsql.$clausesql.$approvalsql.$ordersql, $params, 0, (GLOSSARY_RECENT_ACTIVITY_LIMIT+1)); if (empty($entries)) { return false; } echo $OUTPUT->heading(get_string('newentries', 'glossary') . ':', 6); $strftimerecent = get_string('strftimerecent'); $entrycount = 0; foreach ($entries as $entry) { if ($entrycount < GLOSSARY_RECENT_ACTIVITY_LIMIT) { if ($entry->approved) { $dimmed = ''; $urlparams = array('g' => $entry->glossaryid, 'mode' => 'entry', 'hook' => $entry->id); } else { $dimmed = ' dimmed_text'; $urlparams = array('id' => $ids[$entry->glossaryid], 'mode' => 'approval', 'hook' => format_text($entry->concept, true)); } $link = new moodle_url($CFG->wwwroot.'/mod/glossary/view.php' , $urlparams); echo '<div class="head'.$dimmed.'">'; echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>'; echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>'; echo '</div>'; echo '<div class="info"><a href="'.$link.'">'.format_string($entry->concept, true).'</a></div>'; $entrycount += 1; } else { $numnewentries = $DB->count_records_sql($countsql.$joins[0].$clausesql.$approvalsql, $params); echo '<div class="head"><div class="activityhead">'.get_string('andmorenewentries', 'glossary', $numnewentries - GLOSSARY_RECENT_ACTIVITY_LIMIT).'</div></div>'; break; } } return true; } /** * @global object * @param object $log */ function glossary_log_info($log) { global $DB; return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname FROM {glossary_entries} e, {user} u WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid)); } /** * Function to be run periodically according to the moodle cron * This function searches for things that need to be done, such * as sending out mail, toggling flags etc ... * @return bool */ function glossary_cron () { return true; } /** * Return grade for given user or all users. * * @param stdClass $glossary A glossary instance * @param int $userid Optional user id, 0 means all users * @return array An array of grades, false if none */ function glossary_get_user_grades($glossary, $userid=0) { global $CFG; require_once($CFG->dirroot.'/rating/lib.php'); $ratingoptions = new stdClass; //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance? $ratingoptions->modulename = 'glossary'; $ratingoptions->moduleid = $glossary->id; $ratingoptions->component = 'mod_glossary'; $ratingoptions->ratingarea = 'entry'; $ratingoptions->userid = $userid; $ratingoptions->aggregationmethod = $glossary->assessed; $ratingoptions->scaleid = $glossary->scale; $ratingoptions->itemtable = 'glossary_entries'; $ratingoptions->itemtableusercolumn = 'userid'; $rm = new rating_manager(); return $rm->get_user_grades($ratingoptions); } /** * Return rating related permissions * * @param int $contextid the context id * @param string $component The component we want to get permissions for * @param string $ratingarea The ratingarea that we want to get permissions for * @return array an associative array of the user's rating permissions */ function glossary_rating_permissions($contextid, $component, $ratingarea) { if ($component != 'mod_glossary' || $ratingarea != 'entry') { // We don't know about this component/ratingarea so just return null to get the // default restrictive permissions. return null; } $context = context::instance_by_id($contextid); return array( 'view' => has_capability('mod/glossary:viewrating', $context), 'viewany' => has_capability('mod/glossary:viewanyrating', $context), 'viewall' => has_capability('mod/glossary:viewallratings', $context), 'rate' => has_capability('mod/glossary:rate', $context) ); } /** * Validates a submitted rating * @param array $params submitted data * context => object the context in which the rated items exists [required] * component => The component for this module - should always be mod_forum [required] * ratingarea => object the context in which the rated items exists [required] * itemid => int the ID of the object being rated [required] * scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required] * rating => int the submitted rating * rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required] * aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [optional] * @return boolean true if the rating is valid. Will throw rating_exception if not */ function glossary_rating_validate($params) { global $DB, $USER; // Check the component is mod_forum if ($params['component'] != 'mod_glossary') { throw new rating_exception('invalidcomponent'); } // Check the ratingarea is post (the only rating area in forum) if ($params['ratingarea'] != 'entry') { throw new rating_exception('invalidratingarea'); } // Check the rateduserid is not the current user .. you can't rate your own posts if ($params['rateduserid'] == $USER->id) { throw new rating_exception('nopermissiontorate'); } $glossarysql = "SELECT g.id as glossaryid, g.scale, g.course, e.userid as userid, e.approved, e.timecreated, g.assesstimestart, g.assesstimefinish FROM {glossary_entries} e JOIN {glossary} g ON e.glossaryid = g.id WHERE e.id = :itemid"; $glossaryparams = array('itemid' => $params['itemid']); $info = $DB->get_record_sql($glossarysql, $glossaryparams); if (!$info) { //item doesn't exist throw new rating_exception('invaliditemid'); } if ($info->scale != $params['scaleid']) { //the scale being submitted doesnt match the one in the database throw new rating_exception('invalidscaleid'); } //check that the submitted rating is valid for the scale // lower limit if ($params['rating'] < 0 && $params['rating'] != RATING_UNSET_RATING) { throw new rating_exception('invalidnum'); } // upper limit if ($info->scale < 0) { //its a custom scale $scalerecord = $DB->get_record('scale', array('id' => -$info->scale)); if ($scalerecord) { $scalearray = explode(',', $scalerecord->scale); if ($params['rating'] > count($scalearray)) { throw new rating_exception('invalidnum'); } } else { throw new rating_exception('invalidscaleid'); } } else if ($params['rating'] > $info->scale) { //if its numeric and submitted rating is above maximum throw new rating_exception('invalidnum'); } //check the item we're rating was created in the assessable time window if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) { if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) { throw new rating_exception('notavailable'); } } $cm = get_coursemodule_from_instance('glossary', $info->glossaryid, $info->course, false, MUST_EXIST); $context = context_module::instance($cm->id, MUST_EXIST); // if the supplied context doesnt match the item's context if ($context->id != $params['context']->id) { throw new rating_exception('invalidcontext'); } return true; } /** * Update activity grades * * @category grade * @param stdClass $glossary Null means all glossaries (with extra cmidnumber property) * @param int $userid specific user only, 0 means all * @param bool $nullifnone If true and the user has no grade then a grade item with rawgrade == null will be inserted */ function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) { global $CFG, $DB; require_once($CFG->libdir.'/gradelib.php'); if (!$glossary->assessed) { glossary_grade_item_update($glossary); } else if ($grades = glossary_get_user_grades($glossary, $userid)) { glossary_grade_item_update($glossary, $grades); } else if ($userid and $nullifnone) { $grade = new stdClass(); $grade->userid = $userid; $grade->rawgrade = NULL; glossary_grade_item_update($glossary, $grade); } else { glossary_grade_item_update($glossary); } } /** * Create/update grade item for given glossary * * @category grade * @param stdClass $glossary object with extra cmidnumber * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook * @return int, 0 if ok, error code otherwise */ function glossary_grade_item_update($glossary, $grades=NULL) { global $CFG; require_once($CFG->libdir.'/gradelib.php'); $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber); if (!$glossary->assessed or $glossary->scale == 0) { $params['gradetype'] = GRADE_TYPE_NONE; } else if ($glossary->scale > 0) { $params['gradetype'] = GRADE_TYPE_VALUE; $params['grademax'] = $glossary->scale; $params['grademin'] = 0; } else if ($glossary->scale < 0) { $params['gradetype'] = GRADE_TYPE_SCALE; $params['scaleid'] = -$glossary->scale; } if ($grades === 'reset') { $params['reset'] = true; $grades = NULL; } return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params); } /** * Delete grade item for given glossary * * @category grade * @param object $glossary object */ function glossary_grade_item_delete($glossary) { global $CFG; require_once($CFG->libdir.'/gradelib.php'); return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1)); } /** * @deprecated since Moodle 3.8 */ function glossary_scale_used() { throw new coding_exception('glossary_scale_used() can not be used anymore. Plugins can implement ' . '<modname>_scale_used_anywhere, all implementations of <modname>_scale_used are now ignored'); } /** * Checks if scale is being used by any instance of glossary * * This is used to find out if scale used anywhere * * @global object * @param int $scaleid * @return boolean True if the scale is used by any glossary */ function glossary_scale_used_anywhere($scaleid) { global $DB; if ($scaleid and $DB->record_exists_select('glossary', "scale = ? and assessed > 0", [-$scaleid])) { return true; } else { return false; } } ////////////////////////////////////////////////////////////////////////////////////// /// Any other glossary functions go here. Each of them must have a name that /// starts with glossary_ /** * This function return an array of valid glossary_formats records * Everytime it's called, every existing format is checked, new formats * are included if detected and old formats are deleted and any glossary * using an invalid format is updated to the default (dictionary). * * @global object * @global object * @return array */ function glossary_get_available_formats() { global $CFG, $DB; // Get available formats (plugin) and insert them (if necessary) into glossary_formats. $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE'); $pluginformats = array(); $formatrecords = $DB->get_records("glossary_formats"); foreach ($formats as $format) { // If the format file exists. if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) { include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php'); //If the function exists if (function_exists('glossary_show_entry_'.$format)) { // Acummulate it as a valid format. $pluginformats[] = $format; // Check if the format exists in the table. $rec = null; foreach ($formatrecords as $record) { if ($record->name == $format) { $rec = $record; break; } } if (!$rec) { // Insert the record in glossary_formats. $gf = new stdClass(); $gf->name = $format; $gf->popupformatname = $format; $gf->visible = 1; $id = $DB->insert_record('glossary_formats', $gf); $rec = $DB->get_record('glossary_formats', array('id' => $id)); array_push($formatrecords, $rec); } if (empty($rec->showtabs)) { glossary_set_default_visible_tabs($rec); } } } } // Delete non_existent formats from glossary_formats table. foreach ($formatrecords as $record) { $todelete = false; // If the format in DB isn't a valid previously detected format then delete the record. if (!in_array($record->name, $pluginformats)) { $todelete = true; } if ($todelete) { // Delete the format. $DB->delete_records('glossary_formats', array('id' => $record->id)); unset($formatrecords[$record->id]); // Reassign existing glossaries to default (dictionary) format. if ($glossaries = $DB->get_records('glossary', array('displayformat' => $record->name))) { foreach($glossaries as $glossary) { $DB->set_field('glossary', 'displayformat', 'dictionary', array('id' => $glossary->id)); } } } } return $formatrecords; } /** * @param bool $debug * @param string $text * @param int $br */ function glossary_debug($debug,$text,$br=1) { if ( $debug ) { echo '<font color="red">' . $text . '</font>'; if ( $br ) { echo '<br />'; } } } /** * * @global object * @param int $glossaryid * @param string $entrylist * @param string $pivot * @return array */ function glossary_get_entries($glossaryid, $entrylist, $pivot = "") { global $DB; if ($pivot) { $pivot .= ","; } return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format FROM {glossary_entries} WHERE glossaryid = ? AND id IN ($entrylist)", array($glossaryid)); } /** * @global object * @global object * @param object $concept * @param string $courseid * @return array */ function glossary_get_entries_search($concept, $courseid) { global $DB; //Check if the user is an admin $bypassadmin = 1; //This means NO (by default) if (has_capability('moodle/course:viewhiddenactivities', context_system::instance())) { $bypassadmin = 0; //This means YES } //Check if the user is a teacher $bypassteacher = 1; //This means NO (by default) if (has_capability('mod/glossary:manageentries', context_course::instance($courseid))) { $bypassteacher = 0; //This means YES } $conceptlower = core_text::strtolower(trim($concept)); $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept); $sensitiveconceptsql = $DB->sql_equal('concept', ':concept'); return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid FROM {glossary_entries} e, {glossary} g, {course_modules} cm, {modules} m WHERE m.name = 'glossary' AND cm.module = m.id AND (cm.visible = 1 OR cm.visible = $bypassadmin OR (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND g.id = cm.instance AND e.glossaryid = g.id AND ( (e.casesensitive != 1 AND LOWER(concept) = :conceptlower) OR (e.casesensitive = 1 and $sensitiveconceptsql)) AND (g.course = :courseid2 OR g.globalglossary = 1) AND e.usedynalink != 0 AND g.usedynalink != 0", $params); } /** * @global object * @global object * @param object $course * @param object $course * @param object $glossary * @param object $entry * @param string $mode * @param string $hook * @param int $printicons * @param int $displayformat * @param bool $printview * @return mixed */ function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat = -1, $printview = false) { global $USER, $CFG; $return = false; if ( $displayformat < 0 ) { $displayformat = $glossary->displayformat; } if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) { $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php'; if ($printview) { $functionname = 'glossary_print_entry_'.$displayformat; } else { $functionname = 'glossary_show_entry_'.$displayformat; } if (file_exists($formatfile)) { include_once($formatfile); if (function_exists($functionname)) { $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons); } else if ($printview) { //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format $return = glossary_print_entry_default($entry, $glossary, $cm); } } } return $return; } /** * Default (old) print format used if custom function doesn't exist in format * * @param object $entry * @param object $glossary * @param object $cm * @return void Output is echo'd */ function glossary_print_entry_default ($entry, $glossary, $cm) { global $CFG; require_once($CFG->libdir . '/filelib.php'); echo $OUTPUT->heading(strip_tags($entry->concept), 4); $definition = $entry->definition; $definition = '<span class="nolink">' . strip_tags($definition) . '</span>'; $context = context_module::instance($cm->id); $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id); $options = new stdClass(); $options->para = false; $options->trusted = $entry->definitiontrust; $options->context = $context; $options->overflowdiv = true; $definition = format_text($definition, $entry->definitionformat, $options); echo ($definition); echo '<br /><br />'; } /** * Print glossary concept/term as a heading &lt;h4> * @param object $entry */ function glossary_print_entry_concept($entry, $return=false) { global $OUTPUT; $text = $OUTPUT->heading(format_string($entry->concept), 4); if (!empty($entry->highlight)) { $text = highlight($entry->highlight, $text); } if ($return) { return $text; } else { echo $text; } } /** * * @global moodle_database DB * @param object $entry * @param object $glossary * @param object $cm */ function glossary_print_entry_definition($entry, $glossary, $cm) { global $GLOSSARY_EXCLUDEENTRY; $definition = $entry->definition; // Do not link self. $GLOSSARY_EXCLUDEENTRY = $entry->id; $context = context_module::instance($cm->id); $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id); $options = new stdClass(); $options->para = false; $options->trusted = $entry->definitiontrust; $options->context = $context; $options->overflowdiv = true; $text = format_text($definition, $entry->definitionformat, $options); // Stop excluding concepts from autolinking unset($GLOSSARY_EXCLUDEENTRY); if (!empty($entry->highlight)) { $text = highlight($entry->highlight, $text); } if (isset($entry->footer)) { // Unparsed footer info $text .= $entry->footer; } echo $text; } /** * * @global object * @param object $course * @param object $cm * @param object $glossary * @param object $entry * @param string $mode * @param string $hook * @param string $type * @return string|void */ function glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') { global $DB; $return = ''; if ($aliases = $DB->get_fieldset_select('glossary_alias', 'alias', 'entryid = :entryid', ['entryid' => $entry->id])) { $id = "keyword-{$entry->id}"; $return = html_writer::select($aliases, $id, '', false, ['id' => $id]); } if ($type == 'print') { echo $return; } else { return $return; } } /** * * @global object * @global object * @global object * @param object $course * @param object $cm * @param object $glossary * @param object $entry * @param string $mode * @param string $hook * @param string $type * @return string|void */ function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') { global $USER, $CFG, $DB, $OUTPUT; $context = context_module::instance($cm->id); $output = false; // To decide if we must really return text in "return". Activate when needed only! $importedentry = ($entry->sourceglossaryid == $glossary->id); $ismainglossary = $glossary->mainglossary; $return = '<span class="commands">'; // Differentiate links for each entry. $altsuffix = strip_tags(format_text($entry->concept)); if (!$entry->approved) { $output = true; $return .= html_writer::tag('span', get_string('entryishidden','glossary'), array('class' => 'glossary-hidden-note')); } if ($entry->approved || has_capability('mod/glossary:approve', $context)) { $output = true; $return .= \html_writer::link( new \moodle_url('/mod/glossary/showentry.php', ['eid' => $entry->id]), $OUTPUT->pix_icon('fp/link', get_string('entrylink', 'glossary', $altsuffix), 'theme'), ['title' => get_string('entrylink', 'glossary', $altsuffix), 'class' => 'icon'] ); } if (has_capability('mod/glossary:approve', $context) && !$glossary->defaultapproval && $entry->approved) { $output = true; $return .= '<a class="icon" title="' . get_string('disapprove', 'glossary'). '" href="approve.php?newstate=0&amp;eid='.$entry->id.'&amp;mode='.$mode. '&amp;hook='.urlencode($hook).'&amp;sesskey='.sesskey(). '">' . $OUTPUT->pix_icon('t/block', get_string('disapprove', 'glossary')) . '</a>'; } $iscurrentuser = ($entry->userid == $USER->id); if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $iscurrentuser)) { // only teachers can export entries so check it out if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) { $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id)); if ( $mainglossary ) { // if there is a main glossary defined, allow to export the current entry $output = true; $return .= '<a class="icon" title="'.get_string('exporttomainglossary','glossary') . '" ' . 'href="exportentry.php?id='.$entry->id.'&amp;prevmode='.$mode.'&amp;hook='.urlencode($hook).'">' . $OUTPUT->pix_icon('export', get_string('exporttomainglossary', 'glossary'), 'glossary') . '</a>'; } } $icon = 't/delete'; $iconcomponent = 'moodle'; if ( $entry->sourceglossaryid ) { $icon = 'minus'; // graphical metaphor (minus) for deleting an imported entry $iconcomponent = 'glossary'; } //Decide if an entry is editable: // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and // -The user is teacher or he is a student with time permissions (edit period or editalways defined). $ineditperiod = ((time() - $entry->timecreated < $CFG->maxeditingtime) || $glossary->editalways); if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) { $output = true; $url = "deleteentry.php?id=$cm->id&amp;mode=delete&amp;entry=$entry->id&amp;prevmode=$mode&amp;hook=".urlencode($hook); $return .= "<a class='icon' title=\"" . get_string("delete") . "\" " . "href=\"$url\">" . $OUTPUT->pix_icon($icon, get_string('deleteentrya', 'mod_glossary', $altsuffix), $iconcomponent) . '</a>'; $url = "edit.php?cmid=$cm->id&amp;id=$entry->id&amp;mode=$mode&amp;hook=".urlencode($hook); $return .= "<a class='icon' title=\"" . get_string("edit") . "\" href=\"$url\">" . $OUTPUT->pix_icon('t/edit', get_string('editentrya', 'mod_glossary', $altsuffix)) . '</a>'; } elseif ( $importedentry ) { $return .= "<font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>"; } } if (!empty($CFG->enableportfolios) && (has_capability('mod/glossary:exportentry', $context) || ($iscurrentuser && has_capability('mod/glossary:exportownentry', $context)))) { require_once($CFG->libdir . '/portfoliolib.php'); $button = new portfolio_add_button(); $button->set_callback_options('glossary_entry_portfolio_caller', array('id' => $cm->id, 'entryid' => $entry->id), 'mod_glossary'); $filecontext = $context; if ($entry->sourceglossaryid == $cm->instance) { if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) { $filecontext = context_module::instance($maincm->id); } } $fs = get_file_storage(); if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false) || $files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'entry', $entry->id, "timemodified", false)) { $button->set_formats(PORTFOLIO_FORMAT_RICHHTML); } else { $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML); } $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK); } $return .= '</span>'; if (!empty($CFG->usecomments) && has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) { require_once($CFG->dirroot . '/comment/lib.php'); $cmt = new stdClass(); $cmt->component = 'mod_glossary'; $cmt->context = $context; $cmt->course = $course; $cmt->cm = $cm; $cmt->area = 'glossary_entry'; $cmt->itemid = $entry->id; $cmt->showcount = true; $comment = new comment($cmt); $return .= '<div>'.$comment->output(true).'</div>'; $output = true; } //If we haven't calculated any REAL thing, delete result ($return) if (!$output) { $return = ''; } //Print or get if ($type == 'print') { echo $return; } else { return $return; } } /** * @param object $course * @param object $cm * @param object $glossary * @param object $entry * @param string $mode * @param object $hook * @param bool $printicons * @param bool $aliases * @param bool $printseparator Whether to print a thematic break (separator) at the end of the lower section. * @return void */ function glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases = true, $printseparator = true) { if ($aliases) { $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html'); } $icons = ''; if ($printicons) { $icons = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html'); } if ($aliases || $icons || !empty($entry->rating)) { echo '<table>'; if ( $aliases ) { $id = "keyword-{$entry->id}"; echo '<tr valign="top"><td class="aliases">' . '<label for="' . $id . '">' . get_string('aliases', 'glossary') . ': </label>' . $aliases . '</td></tr>'; } if ($icons) { echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>'; } if (!empty($entry->rating)) { echo '<tr valign="top"><td class="ratings pt-3">'; glossary_print_entry_ratings($course, $entry); echo '</td></tr>'; } echo '</table>'; if ($printseparator) { echo "<hr>\n"; } } } /** * Print the list of attachments for this glossary entry * * @param object $entry * @param object $cm The coursemodule * @param string $format The format for this view (html, or text) * @param string $unused1 This parameter is no longer used * @param string $unused2 This parameter is no longer used */ function glossary_print_entry_attachment($entry, $cm, $format = null, $unused1 = null, $unused2 = null) { // Valid format values: html: The HTML link for the attachment is an icon; and // text: The HTML link for the attachment is text. if ($entry->attachment) { echo '<div class="attachments">'; echo glossary_print_attachments($entry, $cm, $format); echo '</div>'; } if ($unused1) { debugging('The align parameter is deprecated, please use appropriate CSS instead', DEBUG_DEVELOPER); } if ($unused2 !== null) { debugging('The insidetable parameter is deprecated, please use appropriate CSS instead', DEBUG_DEVELOPER); } } /** * @global object * @param object $cm * @param object $entry * @param string $mode * @param string $align * @param bool $insidetable */ function glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) { global $CFG, $OUTPUT; if ($mode == 'approval' and !$entry->approved) { if ($insidetable) { echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">'; } echo $OUTPUT->action_icon( new moodle_url('approve.php', array('eid' => $entry->id, 'mode' => $mode, 'sesskey' => sesskey())), new pix_icon('t/approve', get_string('approve','glossary'), '', array('class' => 'iconsmall', 'align' => $align)) ); if ($insidetable) { echo '</td></tr></table>'; } } } /** * It returns all entries from all glossaries that matches the specified criteria * within a given $course. It performs an $extended search if necessary. * It restrict the search to only one $glossary if the $glossary parameter is set. * * @global object * @global object * @param object $course * @param array $searchterms * @param int $extended * @param object $glossary * @return array */ function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) { global $CFG, $DB; if ( !$glossary ) { if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) { $glos = ""; foreach ( $glossaries as $glossary ) { $glos .= "$glossary->id,"; } $glos = substr($glos,0,-1); } } else { $glos = $glossary->id; } if (!has_capability('mod/glossary:manageentries', context_course::instance($glossary->course))) { $glossarymodule = $DB->get_record("modules", array("name"=>"glossary")); $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id"; $onlyvisibletable = ", {course_modules} cm"; } else { $onlyvisible = ""; $onlyvisibletable = ""; } if ($DB->sql_regex_supported()) { $REGEXP = $DB->sql_regex(true); $NOTREGEXP = $DB->sql_regex(false); } $searchcond = array(); $params = array(); $i = 0; $concat = $DB->sql_concat('e.concept', "' '", 'e.definition'); foreach ($searchterms as $searchterm) { $i++; $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle /// will use it to simulate the "-" operator with LIKE clause /// Under Oracle and MSSQL, trim the + and - operators and perform /// simpler LIKE (or NOT LIKE) queries if (!$DB->sql_regex_supported()) { if (substr($searchterm, 0, 1) == '-') { $NOT = true; } $searchterm = trim($searchterm, '+-'); } // TODO: +- may not work for non latin languages if (substr($searchterm,0,1) == '+') { $searchterm = trim($searchterm, '+-'); $searchterm = preg_quote($searchterm, '|'); $searchcond[] = "$concat $REGEXP :ss$i"; $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)"; } else if (substr($searchterm,0,1) == "-") { $searchterm = trim($searchterm, '+-'); $searchterm = preg_quote($searchterm, '|'); $searchcond[] = "$concat $NOTREGEXP :ss$i"; $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)"; } else { $searchcond[] = $DB->sql_like($concat, ":ss$i", false, true, $NOT); $params['ss'.$i] = "%$searchterm%"; } } if (empty($searchcond)) { $totalcount = 0; return array(); } $searchcond = implode(" AND ", $searchcond); $sql = "SELECT e.* FROM {glossary_entries} e, {glossary} g $onlyvisibletable WHERE $searchcond AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible AND g.id IN ($glos) AND e.approved <> 0"; return $DB->get_records_sql($sql, $params); } /** * @global object * @param array $searchterms * @param object $glossary * @param bool $extended * @return array */ function glossary_search_entries($searchterms, $glossary, $extended) { global $DB; $course = $DB->get_record("course", array("id"=>$glossary->course)); return glossary_search($course,$searchterms,$extended,$glossary); } /** * if return=html, then return a html string. * if return=text, then return a text-only string. * otherwise, print HTML for non-images, and return image HTML * if attachment is an image, $align set its aligment. * * @global object * @global object * @param object $entry * @param object $cm * @param string $type html, txt, empty * @param string $unused This parameter is no longer used * @return string image string or nothing depending on $type param */ function glossary_print_attachments($entry, $cm, $type=NULL, $unused = null) { global $CFG, $DB, $OUTPUT; if (!$context = context_module::instance($cm->id, IGNORE_MISSING)) { return ''; } if ($entry->sourceglossaryid == $cm->instance) { if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) { return ''; } $filecontext = context_module::instance($maincm->id); } else { $filecontext = $context; } $strattachment = get_string('attachment', 'glossary'); $fs = get_file_storage(); $imagereturn = ''; $output = ''; if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) { foreach ($files as $file) { $filename = $file->get_filename(); $mimetype = $file->get_mimetype(); $iconimage = $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file), 'moodle', array('class' => 'icon')); $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename); if ($type == 'html') { $output .= "<a href=\"$path\">$iconimage</a> "; $output .= "<a href=\"$path\">".s($filename)."</a>"; $output .= "<br />"; } else if ($type == 'text') { $output .= "$strattachment ".s($filename).":\n$path\n"; } else { if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) { // Image attachments don't get printed as links $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />"; } else { $output .= "<a href=\"$path\">$iconimage</a> "; $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context)); $output .= '<br />'; } } } } if ($type) { return $output; } else { echo $output; return $imagereturn; } } //////////////////////////////////////////////////////////////////////////////// // File API // //////////////////////////////////////////////////////////////////////////////// /** * Lists all browsable file areas * * @package mod_glossary * @category files * @param stdClass $course course object * @param stdClass $cm course module object * @param stdClass $context context object * @return array */ function glossary_get_file_areas($course, $cm, $context) { return array( 'attachment' => get_string('areaattachment', 'mod_glossary'), 'entry' => get_string('areaentry', 'mod_glossary'), ); } /** * File browsing support for glossary module. * * @param file_browser $browser * @param array $areas * @param stdClass $course * @param cm_info $cm * @param context $context * @param string $filearea * @param int $itemid * @param string $filepath * @param string $filename * @return file_info_stored file_info_stored instance or null if not found */ function glossary_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) { global $CFG, $DB, $USER; if ($context->contextlevel != CONTEXT_MODULE) { return null; } if (!isset($areas[$filearea])) { return null; } if (is_null($itemid)) { require_once($CFG->dirroot.'/mod/glossary/locallib.php'); return new glossary_file_info_container($browser, $course, $cm, $context, $areas, $filearea); } if (!$entry = $DB->get_record('glossary_entries', array('id' => $itemid))) { return null; } if (!$glossary = $DB->get_record('glossary', array('id' => $cm->instance))) { return null; } if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) { return null; } // this trickery here is because we need to support source glossary access if ($entry->glossaryid == $cm->instance) { $filecontext = $context; } else if ($entry->sourceglossaryid == $cm->instance) { if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) { return null; } $filecontext = context_module::instance($maincm->id); } else { return null; } $fs = get_file_storage(); $filepath = is_null($filepath) ? '/' : $filepath; $filename = is_null($filename) ? '.' : $filename; if (!($storedfile = $fs->get_file($filecontext->id, 'mod_glossary', $filearea, $itemid, $filepath, $filename))) { return null; } // Checks to see if the user can manage files or is the owner. // TODO MDL-33805 - Do not use userid here and move the capability check above. if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) { return null; } $urlbase = $CFG->wwwroot.'/pluginfile.php'; return new file_info_stored($browser, $filecontext, $storedfile, $urlbase, s($entry->concept), true, true, false, false); } /** * Serves the glossary attachments. Implements needed access control ;-) * * @package mod_glossary * @category files * @param stdClass $course course object * @param stdClass $cm course module object * @param stdClsss $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 - justsend the file */ function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) { global $CFG, $DB; if ($context->contextlevel != CONTEXT_MODULE) { return false; } require_course_login($course, true, $cm); if ($filearea === 'attachment' or $filearea === 'entry') { $entryid = (int)array_shift($args); require_course_login($course, true, $cm); if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) { return false; } if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) { return false; } if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) { return false; } // this trickery here is because we need to support source glossary access if ($entry->glossaryid == $cm->instance) { $filecontext = $context; } else if ($entry->sourceglossaryid == $cm->instance) { if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) { return false; } $filecontext = context_module::instance($maincm->id); } else { return false; } $relativepath = implode('/', $args); $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath"; $fs = get_file_storage(); 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, true, $options); // download MUST be forced - security! } else if ($filearea === 'export') { require_login($course, false, $cm); require_capability('mod/glossary:export', $context); if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) { return false; } $cat = array_shift($args); $cat = clean_param($cat, PARAM_ALPHANUM); $filename = clean_filename(strip_tags(format_string($glossary->name)).'.xml'); $content = glossary_generate_export_file($glossary, NULL, $cat); send_file($content, $filename, 0, 0, true, true); } return false; } /** * */ function glossary_print_tabbed_table_end() { echo "</div></div>"; } /** * @param object $cm * @param object $glossary * @param string $mode * @param string $hook * @param string $sortkey * @param string $sortorder */ function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') { if ($glossary->showalphabet) { echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />'; } glossary_print_special_links($cm, $glossary, $mode, $hook); glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder); glossary_print_all_links($cm, $glossary, $mode, $hook); glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc'); } /** * @param object $cm * @param object $glossary * @param string $hook * @param string $sortkey * @param string $sortorder */ function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') { echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>'; } /** * @param object $cm * @param object $glossary * @param string $hook * @param string $sortkey * @param string $sortorder */ function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') { echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>'; } /** * @param object $cm * @param object $glossary * @param string $hook * @param string $sortkey * @param string $sortorder */ function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') { if ( $mode != 'date' ) { if ($glossary->showalphabet) { echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />'; } glossary_print_special_links($cm, $glossary, $mode, $hook); glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder); glossary_print_all_links($cm, $glossary, $mode, $hook); } else { glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder); } } /** * @param object $cm * @param object $glossary * @param string $hook * @param string $sortkey * @param string $sortorder */ function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') { if ($glossary->showalphabet) { echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />'; } glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder); glossary_print_all_links($cm, $glossary, $mode, $hook); glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder); } /** * @global object * @global object * @param object $cm * @param object $glossary * @param string $hook * @param object $category */ function glossary_print_categories_menu($cm, $glossary, $hook, $category) { global $CFG, $DB, $OUTPUT; $context = context_module::instance($cm->id); // Prepare format_string/text options $fmtoptions = array( 'context' => $context); echo '<table border="0" width="100%">'; echo '<tr>'; echo '<td align="center" style="width:20%">'; if (has_capability('mod/glossary:managecategories', $context)) { $options['id'] = $cm->id; $options['mode'] = 'cat'; $options['hook'] = $hook; echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get"); } echo '</td>'; echo '<td align="center" style="width:60%">'; echo '<b>'; $menu = array(); $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary"); $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary"); $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC"); $selected = ''; if ( $categories ) { foreach ($categories as $currentcategory) { $url = $currentcategory->id; if ( $category ) { if ($currentcategory->id == $category->id) { $selected = $url; } } $menu[$url] = format_string($currentcategory->name, true, $fmtoptions); } } if ( !$selected ) { $selected = GLOSSARY_SHOW_NOT_CATEGORISED; } if ( $category ) { echo format_string($category->name, true, $fmtoptions); } else { if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) { echo get_string("entrieswithoutcategory","glossary"); $selected = GLOSSARY_SHOW_NOT_CATEGORISED; } else if ( empty($hook) ) { echo get_string("allcategories","glossary"); $selected = GLOSSARY_SHOW_ALL_CATEGORIES; } } echo '</b></td>'; echo '<td align="center" style="width:20%">'; $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu"); $select->set_label(get_string('categories', 'glossary'), array('class' => 'accesshide')); echo $OUTPUT->render($select); echo '</td>'; echo '</tr>'; echo '</table>'; } /** * @global object * @param object $cm * @param object $glossary * @param string $mode * @param string $hook */ function glossary_print_all_links($cm, $glossary, $mode, $hook) { global $CFG; if ( $glossary->showall) { $strallentries = get_string("allentries", "glossary"); if ( $hook == 'ALL' ) { echo "<b>$strallentries</b>"; } else { $strexplainall = strip_tags(get_string("explainall","glossary")); echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>"; } } } /** * @global object * @param object $cm * @param object $glossary * @param string $mode * @param string $hook */ function glossary_print_special_links($cm, $glossary, $mode, $hook) { global $CFG; if ( $glossary->showspecial) { $strspecial = get_string("special", "glossary"); if ( $hook == 'SPECIAL' ) { echo "<b>$strspecial</b> | "; } else { $strexplainspecial = strip_tags(get_string("explainspecial","glossary")); echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | "; } } } /** * @global object * @param object $glossary * @param string $mode * @param string $hook * @param string $sortkey * @param string $sortorder */ function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) { global $CFG; if ( $glossary->showalphabet) { $alphabet = explode(",", get_string('alphabet', 'langconfig')); for ($i = 0; $i < count($alphabet); $i++) { if ( $hook == $alphabet[$i] and $hook) { echo "<b>$alphabet[$i]</b>"; } else { echo "<a href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=".urlencode($alphabet[$i])."&amp;sortkey=$sortkey&amp;sortorder=$sortorder\">$alphabet[$i]</a>"; } echo ' | '; } } } /** * @global object * @param object $cm * @param string $mode * @param string $sortkey * @param string $sortorder */ function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') { global $CFG, $OUTPUT; $asc = get_string("ascending","glossary"); $desc = get_string("descending","glossary"); $bopen = '<b>'; $bclose = '</b>'; $neworder = ''; $currentorder = ''; $currentsort = ''; if ( $sortorder ) { if ( $sortorder == 'asc' ) { $currentorder = $asc; $neworder = '&amp;sortorder=desc'; $newordertitle = get_string('changeto', 'glossary', $desc); } else { $currentorder = $desc; $neworder = '&amp;sortorder=asc'; $newordertitle = get_string('changeto', 'glossary', $asc); } $icon = " " . $OUTPUT->pix_icon($sortorder, $newordertitle, 'glossary'); } else { if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) { $icon = ""; $newordertitle = $asc; } else { $newordertitle = $desc; $neworder = '&amp;sortorder=desc'; $icon = " " . $OUTPUT->pix_icon('asc', $newordertitle, 'glossary'); } } $ficon = ''; $fneworder = ''; $fbtag = ''; $fendbtag = ''; $sicon = ''; $sneworder = ''; $sbtag = ''; $fbtag = ''; $fendbtag = ''; $sendbtag = ''; $sendbtag = ''; if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) { $ficon = $icon; $fneworder = $neworder; $fordertitle = $newordertitle; $sordertitle = $asc; $fbtag = $bopen; $fendbtag = $bclose; } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') { $sicon = $icon; $sneworder = $neworder; $fordertitle = $asc; $sordertitle = $newordertitle; $sbtag = $bopen; $sendbtag = $bclose; } else { $fordertitle = $asc; $sordertitle = $asc; } if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) { $forder = 'CREATION'; $sorder = 'UPDATE'; $fsort = get_string("sortbycreation", "glossary"); $ssort = get_string("sortbylastupdate", "glossary"); $currentsort = $fsort; if ($sortkey == 'UPDATE') { $currentsort = $ssort; } $sort = get_string("sortchronogically", "glossary"); } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') { $forder = 'FIRSTNAME'; $sorder = 'LASTNAME'; $fsort = get_string("firstname"); $ssort = get_string("lastname"); $currentsort = $fsort; if ($sortkey == 'LASTNAME') { $currentsort = $ssort; } $sort = get_string("sortby", "glossary"); } $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>'; echo "<br />$current $sort: $sbtag<a title=\"$ssort $sordertitle\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;sortkey=$sorder$sneworder&amp;mode=$mode\">$ssort$sicon</a>$sendbtag | ". "$fbtag<a title=\"$fsort $fordertitle\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;sortkey=$forder$fneworder&amp;mode=$mode\">$fsort$ficon</a>$fendbtag<br />"; } /** * * @param object $entry0 * @param object $entry1 * @return int [-1 | 0 | 1] */ function glossary_sort_entries ( $entry0, $entry1 ) { if ( core_text::strtolower(ltrim($entry0->concept)) < core_text::strtolower(ltrim($entry1->concept)) ) { return -1; } elseif ( core_text::strtolower(ltrim($entry0->concept)) > core_text::strtolower(ltrim($entry1->concept)) ) { return 1; } else { return 0; } } /** * @global object * @global object * @global object * @param object $course * @param object $entry * @return bool */ function glossary_print_entry_ratings($course, $entry) { global $OUTPUT; if( !empty($entry->rating) ){ echo $OUTPUT->render($entry->rating); } } /** * * @global object * @global object * @global object * @param int $courseid * @param array $entries * @param int $displayformat */ function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) { global $USER, $CFG, $DB; echo '<div class="boxaligncenter">'; echo '<table class="glossarypopup" cellspacing="0"><tr>'; echo '<td>'; if ( $entries ) { foreach ( $entries as $entry ) { if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
< print_error('invalidid', 'glossary');
> throw new \moodle_exception('invalidid', 'glossary');
} if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
< print_error('coursemisconf');
> throw new \moodle_exception('coursemisconf');
} if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
< print_error('invalidid', 'glossary');
> throw new \moodle_exception('invalidid', 'glossary');
} //If displayformat is present, override glossary->displayformat if ($displayformat < 0) { $dp = $glossary->displayformat; } else { $dp = $displayformat; } //Get popupformatname $format = $DB->get_record('glossary_formats', array('name'=>$dp)); $displayformat = $format->popupformatname; //Check displayformat variable and set to default if necessary if (!$displayformat) { $displayformat = 'dictionary'; } $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php'; $functionname = 'glossary_show_entry_'.$displayformat; if (file_exists($formatfile)) { include_once($formatfile); if (function_exists($functionname)) { $functionname($course, $cm, $glossary, $entry,'','','',''); } } } } echo '</td>'; echo '</tr></table></div>'; } /** * * @global object * @param array $entries * @param array $aliases * @param array $categories * @return string */ function glossary_generate_export_csv($entries, $aliases, $categories) { global $CFG; $csv = ''; $delimiter = ''; require_once($CFG->libdir . '/csvlib.class.php'); $delimiter = csv_import_reader::get_delimiter('comma'); $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary'))); $csvaliases = array(0 => array()); $csvcategories = array(0 => array()); $aliascount = 0; $categorycount = 0; foreach ($entries as $entry) { $thisaliasesentry = array(); $thiscategoriesentry = array(); $thiscsventry = array($entry->concept, nl2br($entry->definition)); if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) { $thiscount = count($aliases[$entry->id]); if ($thiscount > $aliascount) { $aliascount = $thiscount; } foreach ($aliases[$entry->id] as $alias) { $thisaliasesentry[] = trim($alias); } } if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) { $thiscount = count($categories[$entry->id]); if ($thiscount > $categorycount) { $categorycount = $thiscount; } foreach ($categories[$entry->id] as $catentry) { $thiscategoriesentry[] = trim($catentry); } } $csventries[$entry->id] = $thiscsventry; $csvaliases[$entry->id] = $thisaliasesentry; $csvcategories[$entry->id] = $thiscategoriesentry; } $returnstr = ''; foreach ($csventries as $id => $row) { $aliasstr = ''; $categorystr = ''; if ($id == 0) { $aliasstr = get_string('alias', 'glossary'); $categorystr = get_string('category', 'glossary'); } $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr)); $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n"; } return $returnstr; } /** * * @param object $glossary * @param string $ignored invalid parameter * @param int|string $hook * @return string */ function glossary_generate_export_file($glossary, $ignored = "", $hook = 0) { global $CFG, $DB; // Large exports are likely to take their time and memory. core_php_time_limit::raise(); raise_memory_limit(MEMORY_EXTRA); $cm = get_coursemodule_from_instance('glossary', $glossary->id, $glossary->course); $context = context_module::instance($cm->id); $co = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"; $co .= glossary_start_tag("GLOSSARY",0,true); $co .= glossary_start_tag("INFO",1,true); $co .= glossary_full_tag("NAME",2,false,$glossary->name); $co .= glossary_full_tag("INTRO",2,false,$glossary->intro); $co .= glossary_full_tag("INTROFORMAT",2,false,$glossary->introformat); $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries); $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat); $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial); $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet); $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall); $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments); $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink); $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval); $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary); $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage); $co .= glossary_xml_export_files('INTROFILES', 2, $context->id, 'intro', 0); if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) { $co .= glossary_start_tag("ENTRIES",2,true); foreach ($entries as $entry) { $permissiongranted = 1; if ( $hook ) { switch ( $hook ) { case "ALL": case "SPECIAL": break; default: $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook); break; } } if ( $hook ) { switch ( $hook ) { case GLOSSARY_SHOW_ALL_CATEGORIES: break; case GLOSSARY_SHOW_NOT_CATEGORISED: $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id)); break; default: $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook)); break; } } if ( $entry->approved and $permissiongranted ) { $co .= glossary_start_tag("ENTRY",3,true); $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept)); $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition); $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat); // note: use old name for BC reasons $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink); $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive); $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch); $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry); if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) { $co .= glossary_start_tag("ALIASES",4,true); foreach ($aliases as $alias) { $co .= glossary_start_tag("ALIAS",5,true); $co .= glossary_full_tag("NAME",6,false,trim($alias->alias)); $co .= glossary_end_tag("ALIAS",5,true); } $co .= glossary_end_tag("ALIASES",4,true); } if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) { $co .= glossary_start_tag("CATEGORIES",4,true); foreach ($catentries as $catentry) { $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid)); $co .= glossary_start_tag("CATEGORY",5,true); $co .= glossary_full_tag("NAME",6,false,$category->name); $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink); $co .= glossary_end_tag("CATEGORY",5,true); } $co .= glossary_end_tag("CATEGORIES",4,true); } // Export files embedded in entries. $co .= glossary_xml_export_files('ENTRYFILES', 4, $context->id, 'entry', $entry->id); // Export attachments. $co .= glossary_xml_export_files('ATTACHMENTFILES', 4, $context->id, 'attachment', $entry->id); // Export tags. $tags = core_tag_tag::get_item_tags_array('mod_glossary', 'glossary_entries', $entry->id); if (count($tags)) { $co .= glossary_start_tag("TAGS", 4, true); foreach ($tags as $tag) { $co .= glossary_full_tag("TAG", 5, false, $tag); } $co .= glossary_end_tag("TAGS", 4, true); } $co .= glossary_end_tag("ENTRY",3,true); } } $co .= glossary_end_tag("ENTRIES",2,true); } $co .= glossary_end_tag("INFO",1,true); $co .= glossary_end_tag("GLOSSARY",0,true); return $co; } /// Functions designed by Eloy Lafuente /// Functions to create, open and write header of the xml file /** * Read import file and convert to current charset * * @global object * @param string $file * @return string */ function glossary_read_imported_file($file_content) { global $CFG; require_once "../../lib/xmlize.php"; return xmlize($file_content, 0); } /** * Return the xml start tag * * @param string $tag * @param int $level * @param bool $endline * @return string */ function glossary_start_tag($tag,$level=0,$endline=false) { if ($endline) { $endchar = "\n"; } else { $endchar = ""; } return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar; } /** * Return the xml end tag * @param string $tag * @param int $level * @param bool $endline * @return string */ function glossary_end_tag($tag,$level=0,$endline=true) { if ($endline) { $endchar = "\n"; } else { $endchar = ""; } return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar; } /** * Return the start tag, the contents and the end tag * * @global object * @param string $tag * @param int $level * @param bool $endline * @param string $content * @return string */ function glossary_full_tag($tag, $level, $endline, $content) { global $CFG; $st = glossary_start_tag($tag,$level,$endline); $co = preg_replace("/\r\n|\r/", "\n", s($content)); $et = glossary_end_tag($tag,0,true); return $st.$co.$et; } /** * Prepares file area to export as part of XML export * * @param string $tag XML tag to use for the group * @param int $taglevel * @param int $contextid * @param string $filearea * @param int $itemid * @return string */ function glossary_xml_export_files($tag, $taglevel, $contextid, $filearea, $itemid) { $co = ''; $fs = get_file_storage(); if ($files = $fs->get_area_files( $contextid, 'mod_glossary', $filearea, $itemid, 'itemid,filepath,filename', false)) { $co .= glossary_start_tag($tag, $taglevel, true); foreach ($files as $file) { $co .= glossary_start_tag('FILE', $taglevel + 1, true); $co .= glossary_full_tag('FILENAME', $taglevel + 2, false, $file->get_filename()); $co .= glossary_full_tag('FILEPATH', $taglevel + 2, false, $file->get_filepath()); $co .= glossary_full_tag('CONTENTS', $taglevel + 2, false, base64_encode($file->get_content())); $co .= glossary_full_tag('FILEAUTHOR', $taglevel + 2, false, $file->get_author()); $co .= glossary_full_tag('FILELICENSE', $taglevel + 2, false, $file->get_license()); $co .= glossary_end_tag('FILE', $taglevel + 1); } $co .= glossary_end_tag($tag, $taglevel); } return $co; } /** * Parses files from XML import and inserts them into file system * * @param array $xmlparent parent element in parsed XML tree * @param string $tag * @param int $contextid * @param string $filearea * @param int $itemid * @return int */ function glossary_xml_import_files($xmlparent, $tag, $contextid, $filearea, $itemid) { global $USER, $CFG; $count = 0; if (isset($xmlparent[$tag][0]['#']['FILE'])) { $fs = get_file_storage(); $files = $xmlparent[$tag][0]['#']['FILE']; foreach ($files as $file) { $filerecord = array( 'contextid' => $contextid, 'component' => 'mod_glossary', 'filearea' => $filearea, 'itemid' => $itemid, 'filepath' => $file['#']['FILEPATH'][0]['#'], 'filename' => $file['#']['FILENAME'][0]['#'], 'userid' => $USER->id ); if (array_key_exists('FILEAUTHOR', $file['#'])) { $filerecord['author'] = $file['#']['FILEAUTHOR'][0]['#']; } if (array_key_exists('FILELICENSE', $file['#'])) { $license = $file['#']['FILELICENSE'][0]['#']; require_once($CFG->libdir . "/licenselib.php"); if (license_manager::get_license_by_shortname($license)) { $filerecord['license'] = $license; } } $content = $file['#']['CONTENTS'][0]['#']; $fs->create_file_from_string($filerecord, base64_decode($content)); $count++; } } return $count; } /** * How many unrated entries are in the given glossary for a given user? * * @global moodle_database $DB * @param int $glossaryid * @param int $userid * @return int */ function glossary_count_unrated_entries($glossaryid, $userid) { global $DB; $sql = "SELECT COUNT('x') as num FROM {glossary_entries} WHERE glossaryid = :glossaryid AND userid <> :userid"; $params = array('glossaryid' => $glossaryid, 'userid' => $userid); $entries = $DB->count_records_sql($sql, $params); if ($entries) { // We need to get the contextid for the glossaryid we have been given. $sql = "SELECT ctx.id FROM {context} ctx JOIN {course_modules} cm ON cm.id = ctx.instanceid JOIN {modules} m ON m.id = cm.module JOIN {glossary} g ON g.id = cm.instance WHERE ctx.contextlevel = :contextlevel AND m.name = 'glossary' AND g.id = :glossaryid"; $contextid = $DB->get_field_sql($sql, array('glossaryid' => $glossaryid, 'contextlevel' => CONTEXT_MODULE)); // Now we need to count the ratings that this user has made $sql = "SELECT COUNT('x') AS num FROM {glossary_entries} e JOIN {rating} r ON r.itemid = e.id WHERE e.glossaryid = :glossaryid AND r.userid = :userid AND r.component = 'mod_glossary' AND r.ratingarea = 'entry' AND r.contextid = :contextid"; $params = array('glossaryid' => $glossaryid, 'userid' => $userid, 'contextid' => $contextid); $rated = $DB->count_records_sql($sql, $params); if ($rated) { // The number or enties minus the number or rated entries equals the number of unrated // entries if ($entries > $rated) { return $entries - $rated; } else { return 0; // Just in case there was a counting error } } else { return (int)$entries; } } else { return 0; } } /** * * Returns the html code to represent any pagging bar. Paramenters are: * * The function dinamically show the first and last pages, and "scroll" over pages. * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this * could replace the general one. ;-) * * @param int $totalcount total number of records to be displayed * @param int $page page currently selected (0 based) * @param int $perpage number of records per page * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically. * * @param int $maxpageallowed Optional maximum number of page allowed. * @param int $maxdisplay Optional maximum number of page links to show in the bar * @param string $separator Optional string to be used between pages in the bar * @param string $specialtext Optional string to be showed as an special link * @param string $specialvalue Optional value (page) to be used in the special link * @param bool $previousandnext Optional to decide if we want the previous and next links * @return string */ function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) { $code = ''; $showspecial = false; $specialselected = false; //Check if we have to show the special link if (!empty($specialtext)) { $showspecial = true; } //Check if we are with the special link selected if ($showspecial && $page == $specialvalue) { $specialselected = true; } //If there are results (more than 1 page) if ($totalcount > $perpage) { $code .= "<div style=\"text-align:center\">"; $code .= "<p>".get_string("page").":"; $maxpage = (int)(($totalcount-1)/$perpage); //Lower and upper limit of page if ($page < 0) { $page = 0; } if ($page > $maxpageallowed) { $page = $maxpageallowed; } if ($page > $maxpage) { $page = $maxpage; } //Calculate the window of pages $pagefrom = $page - ((int)($maxdisplay / 2)); if ($pagefrom < 0) { $pagefrom = 0; } $pageto = $pagefrom + $maxdisplay - 1; if ($pageto > $maxpageallowed) { $pageto = $maxpageallowed; } if ($pageto > $maxpage) { $pageto = $maxpage; } //Some movements can be necessary if don't see enought pages if ($pageto - $pagefrom < $maxdisplay - 1) { if ($pageto - $maxdisplay + 1 > 0) { $pagefrom = $pageto - $maxdisplay + 1; } } //Calculate first and last if necessary $firstpagecode = ''; $lastpagecode = ''; if ($pagefrom > 0) { $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>"; if ($pagefrom > 1) { $firstpagecode .= "$separator..."; } } if ($pageto < $maxpage) { if ($pageto < $maxpage -1) { $lastpagecode = "$separator..."; } $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>"; } //Previous if ($page > 0 && $previousandnext) { $pagenum = $page - 1; $code .= "&nbsp;(<a href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;"; } //Add first $code .= $firstpagecode; $pagenum = $pagefrom; //List of maxdisplay pages while ($pagenum <= $pageto) { $pagetoshow = $pagenum +1; if ($pagenum == $page && !$specialselected) { $code .= "$separator<b>$pagetoshow</b>"; } else { $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>"; } $pagenum++; } //Add last $code .= $lastpagecode; //Next if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) { $pagenum = $page + 1; $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)"; } //Add special if ($showspecial) { $code .= '<br />'; if ($specialselected) { $code .= "$separator<b>$specialtext</b>"; } else { $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>"; } } //End html $code .= "</p>"; $code .= "</div>"; } return $code; } /** * 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 glossary_get_view_actions() { return array('view','view all','view entry'); } /** * 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 glossary_get_post_actions() { return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry'); } /** * Implementation of the function for printing the form elements that control * whether the course reset functionality affects the glossary. * @param object $mform form passed by reference */ function glossary_reset_course_form_definition(&$mform) { $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary')); $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary')); $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'), array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple')); $mform->setAdvanced('reset_glossary_types'); $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked'); $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary')); $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked'); $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings')); $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked'); $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments')); $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked'); $mform->addElement('checkbox', 'reset_glossary_tags', get_string('removeallglossarytags', 'glossary')); $mform->disabledIf('reset_glossary_tags', 'reset_glossary_all', 'checked'); } /** * Course reset form defaults. * @return array */ function glossary_reset_course_form_defaults($course) { return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0); } /** * Removes all grades from gradebook * * @param int $courseid The ID of the course to reset * @param string $type The optional type of glossary. 'main', 'secondary' or '' */ function glossary_reset_gradebook($courseid, $type='') { global $DB; switch ($type) { case 'main' : $type = "AND g.mainglossary=1"; break; case 'secondary' : $type = "AND g.mainglossary=0"; break; default : $type = ""; //all } $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid FROM {glossary} g, {course_modules} cm, {modules} m WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type"; if ($glossarys = $DB->get_records_sql($sql, array($courseid))) { foreach ($glossarys as $glossary) { glossary_grade_item_update($glossary, 'reset'); } } } /** * Actual implementation of the reset course functionality, delete all the * glossary responses for course $data->courseid. * * @global object * @param $data the data submitted from the reset course. * @return array status array */ function glossary_reset_userdata($data) { global $CFG, $DB; require_once($CFG->dirroot.'/rating/lib.php'); $componentstr = get_string('modulenameplural', 'glossary'); $status = array(); $allentriessql = "SELECT e.id FROM {glossary_entries} e JOIN {glossary} g ON e.glossaryid = g.id WHERE g.course = ?"; $allglossariessql = "SELECT g.id FROM {glossary} g WHERE g.course = ?"; $params = array($data->courseid); $fs = get_file_storage(); $rm = new rating_manager(); $ratingdeloptions = new stdClass; $ratingdeloptions->component = 'mod_glossary'; $ratingdeloptions->ratingarea = 'entry'; // delete entries if requested if (!empty($data->reset_glossary_all) or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) { $params[] = 'glossary_entry'; $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea=?", $params); $DB->delete_records_select('glossary_alias', "entryid IN ($allentriessql)", $params); $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params); // now get rid of all attachments if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) { foreach ($glossaries as $glossaryid=>$unused) { if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) { continue; } $context = context_module::instance($cm->id); $fs->delete_area_files($context->id, 'mod_glossary', 'attachment'); //delete ratings $ratingdeloptions->contextid = $context->id; $rm->delete_ratings($ratingdeloptions); core_tag_tag::delete_instances('mod_glossary', null, $context->id); } } // remove all grades from gradebook if (empty($data->reset_gradebook_grades)) { glossary_reset_gradebook($data->courseid); } $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false); } else if (!empty($data->reset_glossary_types)) { $mainentriessql = "$allentriessql AND g.mainglossary=1"; $secondaryentriessql = "$allentriessql AND g.mainglossary=0"; $mainglossariessql = "$allglossariessql AND g.mainglossary=1"; $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0"; if (in_array('main', $data->reset_glossary_types)) { $params[] = 'glossary_entry'; $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params); $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params); if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) { foreach ($glossaries as $glossaryid=>$unused) { if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) { continue; } $context = context_module::instance($cm->id); $fs->delete_area_files($context->id, 'mod_glossary', 'attachment'); //delete ratings $ratingdeloptions->contextid = $context->id; $rm->delete_ratings($ratingdeloptions); core_tag_tag::delete_instances('mod_glossary', null, $context->id); } } // remove all grades from gradebook if (empty($data->reset_gradebook_grades)) { glossary_reset_gradebook($data->courseid, 'main'); } $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('mainglossary', 'glossary'), 'error'=>false); } else if (in_array('secondary', $data->reset_glossary_types)) { $params[] = 'glossary_entry'; $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params); $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params); // remove exported source flag from entries in main glossary $DB->execute("UPDATE {glossary_entries} SET sourceglossaryid=0 WHERE glossaryid IN ($mainglossariessql)", $params); if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) { foreach ($glossaries as $glossaryid=>$unused) { if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) { continue; } $context = context_module::instance($cm->id); $fs->delete_area_files($context->id, 'mod_glossary', 'attachment'); //delete ratings $ratingdeloptions->contextid = $context->id; $rm->delete_ratings($ratingdeloptions); core_tag_tag::delete_instances('mod_glossary', null, $context->id); } } // remove all grades from gradebook if (empty($data->reset_gradebook_grades)) { glossary_reset_gradebook($data->courseid, 'secondary'); } $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false); } } // remove entries by users not enrolled into course if (!empty($data->reset_glossary_notenrolled)) { $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted FROM {glossary_entries} e JOIN {glossary} g ON e.glossaryid = g.id LEFT JOIN {user} u ON e.userid = u.id WHERE g.course = ? AND e.userid > 0"; $course_context = context_course::instance($data->courseid); $notenrolled = array(); $rs = $DB->get_recordset_sql($entriessql, $params); if ($rs->valid()) { foreach ($rs as $entry) { if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted or !is_enrolled($course_context , $entry->userid)) { $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id)); $DB->delete_records('glossary_entries', array('id'=>$entry->id)); if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) { $context = context_module::instance($cm->id); $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id); //delete ratings $ratingdeloptions->contextid = $context->id; $rm->delete_ratings($ratingdeloptions); } } } $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false); } $rs->close(); } // remove all ratings if (!empty($data->reset_glossary_ratings)) { //remove ratings if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) { foreach ($glossaries as $glossaryid=>$unused) { if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) { continue; } $context = context_module::instance($cm->id); //delete ratings $ratingdeloptions->contextid = $context->id; $rm->delete_ratings($ratingdeloptions); } } // remove all grades from gradebook if (empty($data->reset_gradebook_grades)) { glossary_reset_gradebook($data->courseid); } $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false); } // remove comments if (!empty($data->reset_glossary_comments)) { $params[] = 'glossary_entry'; $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params); $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false); } // Remove all the tags. if (!empty($data->reset_glossary_tags)) { if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) { foreach ($glossaries as $glossaryid => $unused) { if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) { continue; } $context = context_module::instance($cm->id); core_tag_tag::delete_instances('mod_glossary', null, $context->id); } } $status[] = array('component' => $componentstr, 'item' => get_string('tagsdeleted', 'glossary'), 'error' => false); } /// updating dates - shift may be negative too if ($data->timeshift) { // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset. // See MDL-9367. shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid); $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false); } return $status; } /** * Returns all other caps used in module * @return array */ function glossary_get_extra_capabilities() { return ['moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate', 'moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete']; } /** * @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 glossary_supports($feature) { switch($feature) { 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_COMPLETION_HAS_RULES: return true; case FEATURE_GRADE_HAS_GRADE: return true; case FEATURE_GRADE_OUTCOMES: return true; case FEATURE_RATE: return true; case FEATURE_BACKUP_MOODLE2: return true; case FEATURE_SHOW_DESCRIPTION: return true; case FEATURE_COMMENT: return true; case FEATURE_MOD_PURPOSE: return MOD_PURPOSE_COLLABORATION; default: return null; } } function glossary_extend_navigation($navigation, $course, $module, $cm) { global $CFG, $DB; $displayformat = $DB->get_record('glossary_formats', array('name' => $module->displayformat)); // Get visible tabs for the format and check if the menu needs to be displayed. $showtabs = glossary_get_visible_tabs($displayformat); foreach ($showtabs as $showtabkey => $showtabvalue) { switch($showtabvalue) { case GLOSSARY_STANDARD : $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id' => $cm->id, 'mode' => 'letter'))); break; case GLOSSARY_CATEGORY : $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id' => $cm->id, 'mode' => 'cat'))); break; case GLOSSARY_DATE : $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id' => $cm->id, 'mode' => 'date'))); break; case GLOSSARY_AUTHOR : $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id' => $cm->id, 'mode' => 'author'))); break; } } } /** * Adds module specific settings to the settings block * * @param settings_navigation $settings The settings navigation object * @param navigation_node $glossarynode The node to add module settings to */ function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) { global $DB, $CFG, $USER; $mode = optional_param('mode', '', PARAM_ALPHA); $hook = optional_param('hook', 'ALL', PARAM_CLEAN); if (has_capability('mod/glossary:import', $settings->get_page()->cm->context)) { $node = $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', ['id' => $settings->get_page()->cm->id])); $node->set_show_in_secondary_navigation(false); } if (has_capability('mod/glossary:export', $settings->get_page()->cm->context)) { $node = $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', ['id' => $settings->get_page()->cm->id, 'mode' => $mode, 'hook' => $hook])); $node->set_show_in_secondary_navigation(false); } $glossary = $DB->get_record('glossary', array("id" => $settings->get_page()->cm->instance)); $hiddenentries = $DB->count_records('glossary_entries', ['glossaryid' => $settings->get_page()->cm->instance, 'approved' => 0]); // Safe guard check - Ideally, there shouldn't be any hidden entries if the glossary has 'defaultapproval'. if (has_capability('mod/glossary:approve', $settings->get_page()->cm->context) && (!$glossary->defaultapproval || $hiddenentries)) { $glossarynode->add(get_string('pendingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', ['id' => $settings->get_page()->cm->id, 'mode' => 'approval']), navigation_node::TYPE_CUSTOM, null, 'pendingapproval'); } if (has_capability('mod/glossary:write', $settings->get_page()->cm->context)) { $node = $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', ['cmid' => $settings->get_page()->cm->id])); $node->set_show_in_secondary_navigation(false); } if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles && has_capability('mod/glossary:view', $settings->get_page()->cm->context)) { require_once("$CFG->libdir/rsslib.php"); $string = get_string('rsstype', 'glossary'); $url = new moodle_url(rss_get_url($settings->get_page()->cm->context->id, $USER->id, 'mod_glossary', $glossary->id)); $node = $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', '')); $node->set_show_in_secondary_navigation(false); } } /** * Running addtional permission check on plugin, for example, plugins * may have switch to turn on/off comments option, this callback will * affect UI display, not like pluginname_comment_validate only throw * exceptions. * Capability check has been done in comment->check_permissions(), we * don't need to do it again here. * * @package mod_glossary * @category comment * * @param stdClass $comment_param { * context => context the context object * courseid => int course id * cm => stdClass course module object * commentarea => string comment area * itemid => int itemid * } * @return array */ function glossary_comment_permissions($comment_param) { return array('post'=>true, 'view'=>true); } /** * Validate comment parameter before perform other comments actions * * @package mod_glossary * @category comment * * @param stdClass $comment_param { * context => context the context object * courseid => int course id * cm => stdClass course module object * commentarea => string comment area * itemid => int itemid * } * @return boolean */ function glossary_comment_validate($comment_param) { global $DB; // validate comment area if ($comment_param->commentarea != 'glossary_entry') { throw new comment_exception('invalidcommentarea'); } if (!$record = $DB->get_record('glossary_entries', array('id'=>$comment_param->itemid))) { throw new comment_exception('invalidcommentitemid'); } if ($record->sourceglossaryid && $record->sourceglossaryid == $comment_param->cm->instance) { $glossary = $DB->get_record('glossary', array('id'=>$record->sourceglossaryid)); } else { $glossary = $DB->get_record('glossary', array('id'=>$record->glossaryid)); } if (!$glossary) { throw new comment_exception('invalidid', 'data'); } if (!$course = $DB->get_record('course', array('id'=>$glossary->course))) { throw new comment_exception('coursemisconf'); } if (!$cm = get_coursemodule_from_instance('glossary', $glossary->id, $course->id)) { throw new comment_exception('invalidcoursemodule'); } $context = context_module::instance($cm->id); if ($glossary->defaultapproval and !$record->approved and !has_capability('mod/glossary:approve', $context)) { throw new comment_exception('notapproved', 'glossary'); } // validate context id if ($context->id != $comment_param->context->id) { throw new comment_exception('invalidcontext'); } // validation for comment deletion if (!empty($comment_param->commentid)) { if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) { if ($comment->commentarea != 'glossary_entry') { throw new comment_exception('invalidcommentarea'); } if ($comment->contextid != $comment_param->context->id) { throw new comment_exception('invalidcontext'); } if ($comment->itemid != $comment_param->itemid) { throw new comment_exception('invalidcommentitemid'); } } else { throw new comment_exception('invalidcommentid'); } } return true; } /** * 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 glossary_page_type_list($pagetype, $parentcontext, $currentcontext) { $module_pagetype = array( 'mod-glossary-*'=>get_string('page-mod-glossary-x', 'glossary'), 'mod-glossary-view'=>get_string('page-mod-glossary-view', 'glossary'), 'mod-glossary-edit'=>get_string('page-mod-glossary-edit', 'glossary')); return $module_pagetype; } /** * Return list of all glossary tabs. * @throws coding_exception * @return array */ function glossary_get_all_tabs() { return array ( GLOSSARY_AUTHOR => get_string('authorview', 'glossary'), GLOSSARY_CATEGORY => get_string('categoryview', 'glossary'), GLOSSARY_DATE => get_string('dateview', 'glossary') ); } /** * Set 'showtabs' value for glossary formats * @param stdClass $glossaryformat record from 'glossary_formats' table */ function glossary_set_default_visible_tabs($glossaryformat) { global $DB; switch($glossaryformat->name) { case GLOSSARY_CONTINUOUS: $showtabs = 'standard,category,date'; break; case GLOSSARY_DICTIONARY: $showtabs = 'standard'; // Special code for upgraded instances that already had categories set up // in this format - enable "category" tab. // In new instances only 'standard' tab will be visible. if ($DB->record_exists_sql("SELECT 1 FROM {glossary} g, {glossary_categories} gc WHERE g.id = gc.glossaryid and g.displayformat = ?", array(GLOSSARY_DICTIONARY))) { $showtabs .= ',category'; } break; case GLOSSARY_FULLWITHOUTAUTHOR: $showtabs = 'standard,category,date'; break; default: $showtabs = 'standard,category,date,author'; break; } $DB->set_field('glossary_formats', 'showtabs', $showtabs, array('id' => $glossaryformat->id)); $glossaryformat->showtabs = $showtabs; } /** * Convert 'showtabs' string to array * @param stdClass $displayformat record from 'glossary_formats' table * @return array */ function glossary_get_visible_tabs($displayformat) { if (empty($displayformat->showtabs)) { glossary_set_default_visible_tabs($displayformat); } $showtabs = preg_split('/,/', $displayformat->showtabs, -1, PREG_SPLIT_NO_EMPTY); return $showtabs; } /** * Notify that the glossary was viewed. * * This will trigger relevant events and activity completion. * * @param stdClass $glossary The glossary object. * @param stdClass $course The course object. * @param stdClass $cm The course module object. * @param stdClass $context The context object. * @param string $mode The mode in which the glossary was viewed. * @since Moodle 3.1 */ function glossary_view($glossary, $course, $cm, $context, $mode) { // Completion trigger. $completion = new completion_info($course); $completion->set_module_viewed($cm); // Trigger the course module viewed event. $event = \mod_glossary\event\course_module_viewed::create(array( 'objectid' => $glossary->id, 'context' => $context, 'other' => array('mode' => $mode) )); $event->add_record_snapshot('course', $course); $event->add_record_snapshot('course_modules', $cm); $event->add_record_snapshot('glossary', $glossary); $event->trigger(); } /** * Notify that a glossary entry was viewed. * * This will trigger relevant events. * * @param stdClass $entry The entry object. * @param stdClass $context The context object. * @since Moodle 3.1 */ function glossary_entry_view($entry, $context) { // Trigger the entry viewed event. $event = \mod_glossary\event\entry_viewed::create(array( 'objectid' => $entry->id, 'context' => $context )); $event->add_record_snapshot('glossary_entries', $entry); $event->trigger(); } /** * Returns the entries of a glossary by letter. * * @param object $glossary The glossary. * @param context $context The context of the glossary. * @param string $letter The letter, or ALL, or SPECIAL. * @param int $from Fetch records from. * @param int $limit Number of records to fetch. * @param array $options Accepts: * - (bool) includenotapproved. When false, includes the non-approved entries created by * the current user. When true, also includes the ones that the user has the permission to approve. * @return array The first element being the recordset, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_entries_by_letter($glossary, $context, $letter, $from, $limit, $options = array()) { $qb = new mod_glossary_entry_query_builder($glossary); if ($letter != 'ALL' && $letter != 'SPECIAL' && core_text::strlen($letter)) { $qb->filter_by_concept_letter($letter); } if ($letter == 'SPECIAL') { $qb->filter_by_concept_non_letter(); } if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ALL); } else { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_SELF); } $qb->add_field('*', 'entries'); $qb->join_user(); $qb->add_user_fields(); $qb->order_by('concept', 'entries'); $qb->order_by('id', 'entries', 'ASC'); // Sort on ID to avoid random ordering when entries share an ordering value. $qb->limit($from, $limit); // Fetching the entries. $count = $qb->count_records(); $entries = $qb->get_records(); return array($entries, $count); } /** * Returns the entries of a glossary by date. * * @param object $glossary The glossary. * @param context $context The context of the glossary. * @param string $order The mode of ordering: CREATION or UPDATE. * @param string $sort The direction of the ordering: ASC or DESC. * @param int $from Fetch records from. * @param int $limit Number of records to fetch. * @param array $options Accepts: * - (bool) includenotapproved. When false, includes the non-approved entries created by * the current user. When true, also includes the ones that the user has the permission to approve. * @return array The first element being the recordset, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_entries_by_date($glossary, $context, $order, $sort, $from, $limit, $options = array()) { $qb = new mod_glossary_entry_query_builder($glossary); if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ALL); } else { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_SELF); } $qb->add_field('*', 'entries'); $qb->join_user(); $qb->add_user_fields(); $qb->limit($from, $limit); if ($order == 'CREATION') { $qb->order_by('timecreated', 'entries', $sort); } else { $qb->order_by('timemodified', 'entries', $sort); } $qb->order_by('id', 'entries', $sort); // Sort on ID to avoid random ordering when entries share an ordering value. // Fetching the entries. $count = $qb->count_records(); $entries = $qb->get_records(); return array($entries, $count); } /** * Returns the entries of a glossary by category. * * @param object $glossary The glossary. * @param context $context The context of the glossary. * @param int $categoryid The category ID, or GLOSSARY_SHOW_* constant. * @param int $from Fetch records from. * @param int $limit Number of records to fetch. * @param array $options Accepts: * - (bool) includenotapproved. When false, includes the non-approved entries created by * the current user. When true, also includes the ones that the user has the permission to approve. * @return array The first element being the recordset, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_entries_by_category($glossary, $context, $categoryid, $from, $limit, $options = array()) { $qb = new mod_glossary_entry_query_builder($glossary); if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ALL); } else { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_SELF); } $qb->join_category($categoryid); $qb->join_user(); // The first field must be the relationship ID when viewing all categories. if ($categoryid === GLOSSARY_SHOW_ALL_CATEGORIES) { $qb->add_field('id', 'entries_categories', 'cid'); } $qb->add_field('*', 'entries'); $qb->add_field('categoryid', 'entries_categories'); $qb->add_user_fields(); if ($categoryid === GLOSSARY_SHOW_ALL_CATEGORIES) { $qb->add_field('name', 'categories', 'categoryname'); $qb->order_by('name', 'categories'); } else if ($categoryid === GLOSSARY_SHOW_NOT_CATEGORISED) { $qb->where('categoryid', 'entries_categories', null); } // Sort on additional fields to avoid random ordering when entries share an ordering value. $qb->order_by('concept', 'entries'); $qb->order_by('id', 'entries', 'ASC'); $qb->limit($from, $limit); // Fetching the entries. $count = $qb->count_records(); $entries = $qb->get_records(); return array($entries, $count); } /** * Returns the entries of a glossary by author. * * @param object $glossary The glossary. * @param context $context The context of the glossary. * @param string $letter The letter * @param string $field The field to search: FIRSTNAME or LASTNAME. * @param string $sort The sorting: ASC or DESC. * @param int $from Fetch records from. * @param int $limit Number of records to fetch. * @param array $options Accepts: * - (bool) includenotapproved. When false, includes the non-approved entries created by * the current user. When true, also includes the ones that the user has the permission to approve. * @return array The first element being the recordset, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_entries_by_author($glossary, $context, $letter, $field, $sort, $from, $limit, $options = array()) { $firstnamefirst = $field === 'FIRSTNAME'; $qb = new mod_glossary_entry_query_builder($glossary); if ($letter != 'ALL' && $letter != 'SPECIAL' && core_text::strlen($letter)) { $qb->filter_by_author_letter($letter, $firstnamefirst); } if ($letter == 'SPECIAL') { $qb->filter_by_author_non_letter($firstnamefirst); } if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ALL); } else { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_SELF); } $qb->add_field('*', 'entries'); $qb->join_user(true); $qb->add_user_fields(); $qb->order_by_author($firstnamefirst, $sort); $qb->order_by('concept', 'entries'); $qb->order_by('id', 'entries', 'ASC'); // Sort on ID to avoid random ordering when entries share an ordering value. $qb->limit($from, $limit); // Fetching the entries. $count = $qb->count_records(); $entries = $qb->get_records(); return array($entries, $count); } /** * Returns the entries of a glossary by category. * * @param object $glossary The glossary. * @param context $context The context of the glossary. * @param int $authorid The author ID. * @param string $order The mode of ordering: CONCEPT, CREATION or UPDATE. * @param string $sort The direction of the ordering: ASC or DESC. * @param int $from Fetch records from. * @param int $limit Number of records to fetch. * @param array $options Accepts: * - (bool) includenotapproved. When false, includes the non-approved entries created by * the current user. When true, also includes the ones that the user has the permission to approve. * @return array The first element being the recordset, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_entries_by_author_id($glossary, $context, $authorid, $order, $sort, $from, $limit, $options = array()) { $qb = new mod_glossary_entry_query_builder($glossary); if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ALL); } else { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_SELF); } $qb->add_field('*', 'entries'); $qb->join_user(true); $qb->add_user_fields(); $qb->where('id', 'user', $authorid); if ($order == 'CREATION') { $qb->order_by('timecreated', 'entries', $sort); } else if ($order == 'UPDATE') { $qb->order_by('timemodified', 'entries', $sort); } else { $qb->order_by('concept', 'entries', $sort); } $qb->order_by('id', 'entries', $sort); // Sort on ID to avoid random ordering when entries share an ordering value. $qb->limit($from, $limit); // Fetching the entries. $count = $qb->count_records(); $entries = $qb->get_records(); return array($entries, $count); } /** * Returns the authors in a glossary * * @param object $glossary The glossary. * @param context $context The context of the glossary. * @param int $limit Number of records to fetch. * @param int $from Fetch records from. * @param array $options Accepts: * - (bool) includenotapproved. When false, includes self even if all of their entries require approval. * When true, also includes authors only having entries pending approval. * @return array The first element being the recordset, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_authors($glossary, $context, $limit, $from, $options = array()) { global $DB, $USER; $params = array(); $userfieldsapi = \core_user\fields::for_userpic(); $userfields = $userfieldsapi->get_sql('u', false, '', '', false)->selects; $approvedsql = '(ge.approved <> 0 OR ge.userid = :myid)'; $params['myid'] = $USER->id; if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) { $approvedsql = '1 = 1'; } $sqlselectcount = "SELECT COUNT(DISTINCT(u.id))"; $sqlselect = "SELECT DISTINCT(u.id) AS userId, $userfields"; $sql = " FROM {user} u JOIN {glossary_entries} ge ON ge.userid = u.id AND (ge.glossaryid = :gid1 OR ge.sourceglossaryid = :gid2) AND $approvedsql"; $ordersql = " ORDER BY u.lastname, u.firstname"; $params['gid1'] = $glossary->id; $params['gid2'] = $glossary->id; $count = $DB->count_records_sql($sqlselectcount . $sql, $params); $users = $DB->get_recordset_sql($sqlselect . $sql . $ordersql, $params, $from, $limit); return array($users, $count); } /** * Returns the categories of a glossary. * * @param object $glossary The glossary. * @param int $from Fetch records from. * @param int $limit Number of records to fetch. * @return array The first element being the recordset, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_categories($glossary, $from, $limit) { global $DB; $count = $DB->count_records('glossary_categories', array('glossaryid' => $glossary->id)); $categories = $DB->get_recordset('glossary_categories', array('glossaryid' => $glossary->id), 'name ASC', '*', $from, $limit); return array($categories, $count); } /** * Get the SQL where clause for searching terms. * * Note that this does not handle invalid or too short terms. * * @param array $terms Array of terms. * @param bool $fullsearch Whether or not full search should be enabled. * @param int $glossaryid The ID of a glossary to reduce the search results. * @return array The first element being the where clause, the second array of parameters. * @since Moodle 3.1 */ function glossary_get_search_terms_sql(array $terms, $fullsearch = true, $glossaryid = null) { global $DB; static $i = 0; if ($DB->sql_regex_supported()) { $regexp = $DB->sql_regex(true); $notregexp = $DB->sql_regex(false); } $params = array(); $conditions = array(); foreach ($terms as $searchterm) { $i++; $not = false; // Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle // will use it to simulate the "-" operator with LIKE clause. if (empty($fullsearch)) { // With fullsearch disabled, look only within concepts and aliases. $concat = $DB->sql_concat('ge.concept', "' '", "COALESCE(al.alias, :emptychar{$i})"); } else { // With fullsearch enabled, look also within definitions. $concat = $DB->sql_concat('ge.concept', "' '", 'ge.definition', "' '", "COALESCE(al.alias, :emptychar{$i})"); } $params['emptychar' . $i] = ''; // Under Oracle and MSSQL, trim the + and - operators and perform simpler LIKE (or NOT LIKE) queries. if (!$DB->sql_regex_supported()) { if (substr($searchterm, 0, 1) === '-') { $not = true; } $searchterm = trim($searchterm, '+-'); } if (substr($searchterm, 0, 1) === '+') { $searchterm = trim($searchterm, '+-'); $conditions[] = "$concat $regexp :searchterm{$i}"; $params['searchterm' . $i] = '(^|[^a-zA-Z0-9])' . preg_quote($searchterm, '|') . '([^a-zA-Z0-9]|$)'; } else if (substr($searchterm, 0, 1) === "-") { $searchterm = trim($searchterm, '+-'); $conditions[] = "$concat $notregexp :searchterm{$i}"; $params['searchterm' . $i] = '(^|[^a-zA-Z0-9])' . preg_quote($searchterm, '|') . '([^a-zA-Z0-9]|$)'; } else { $conditions[] = $DB->sql_like($concat, ":searchterm{$i}", false, true, $not); $params['searchterm' . $i] = '%' . $DB->sql_like_escape($searchterm) . '%'; } } // Reduce the search results by restricting it to one glossary. if (isset($glossaryid)) { $conditions[] = 'ge.glossaryid = :glossaryid'; $params['glossaryid'] = $glossaryid; } // When there are no conditions we add a negative one to ensure that we don't return anything. if (empty($conditions)) { $conditions[] = '1 = 2'; } $where = implode(' AND ', $conditions); return array($where, $params); } /** * Returns the entries of a glossary by search. * * @param object $glossary The glossary. * @param context $context The context of the glossary. * @param string $query The search query. * @param bool $fullsearch Whether or not full search is required. * @param string $order The mode of ordering: CONCEPT, CREATION or UPDATE. * @param string $sort The direction of the ordering: ASC or DESC. * @param int $from Fetch records from. * @param int $limit Number of records to fetch. * @param array $options Accepts: * - (bool) includenotapproved. When false, includes the non-approved entries created by * the current user. When true, also includes the ones that the user has the permission to approve. * @return array The first element being the array of results, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_entries_by_search($glossary, $context, $query, $fullsearch, $order, $sort, $from, $limit, $options = array()) { global $DB, $USER; // Clean terms. $terms = explode(' ', $query); foreach ($terms as $key => $term) { if (strlen(trim($term, '+-')) < 1) { unset($terms[$key]); } } list($searchcond, $params) = glossary_get_search_terms_sql($terms, $fullsearch, $glossary->id); $userfieldsapi = \core_user\fields::for_userpic(); $userfields = $userfieldsapi->get_sql('u', false, 'userdata', 'userdataid', false)->selects; // Need one inner view here to avoid distinct + text. $sqlwrapheader = 'SELECT ge.*, ge.concept AS glossarypivot, ' . $userfields . ' FROM {glossary_entries} ge LEFT JOIN {user} u ON u.id = ge.userid JOIN ( '; $sqlwrapfooter = ' ) gei ON (ge.id = gei.id)'; $sqlselect = "SELECT DISTINCT ge.id"; $sqlfrom = "FROM {glossary_entries} ge LEFT JOIN {glossary_alias} al ON al.entryid = ge.id"; if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) { $approvedsql = ''; } else { $approvedsql = 'AND (ge.approved <> 0 OR ge.userid = :myid)'; $params['myid'] = $USER->id; } if ($order == 'CREATION') { $sqlorderby = "ORDER BY ge.timecreated $sort"; } else if ($order == 'UPDATE') { $sqlorderby = "ORDER BY ge.timemodified $sort"; } else { $sqlorderby = "ORDER BY ge.concept $sort"; } $sqlorderby .= " , ge.id ASC"; // Sort on ID to avoid random ordering when entries share an ordering value. $sqlwhere = "WHERE ($searchcond) $approvedsql"; // Fetching the entries. $count = $DB->count_records_sql("SELECT COUNT(DISTINCT(ge.id)) $sqlfrom $sqlwhere", $params); $query = "$sqlwrapheader $sqlselect $sqlfrom $sqlwhere $sqlwrapfooter $sqlorderby"; $entries = $DB->get_records_sql($query, $params, $from, $limit); return array($entries, $count); } /** * Returns the entries of a glossary by term. * * @param object $glossary The glossary. * @param context $context The context of the glossary. * @param string $term The term we are searching for, a concept or alias. * @param int $from Fetch records from. * @param int $limit Number of records to fetch. * @param array $options Accepts: * - (bool) includenotapproved. When false, includes the non-approved entries created by * the current user. When true, also includes the ones that the user has the permission to approve. * @return array The first element being the recordset, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_entries_by_term($glossary, $context, $term, $from, $limit, $options = array()) { // Build the query. $qb = new mod_glossary_entry_query_builder($glossary); if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ALL); } else { $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_SELF); } $qb->add_field('*', 'entries'); $qb->join_alias(); $qb->join_user(); $qb->add_user_fields(); $qb->filter_by_term($term); $qb->order_by('concept', 'entries'); $qb->order_by('id', 'entries'); // Sort on ID to avoid random ordering when entries share an ordering value. $qb->limit($from, $limit); // Fetching the entries. $count = $qb->count_records(); $entries = $qb->get_records(); return array($entries, $count); } /** * Returns the entries to be approved. * * @param object $glossary The glossary. * @param context $context The context of the glossary. * @param string $letter The letter, or ALL, or SPECIAL. * @param string $order The mode of ordering: CONCEPT, CREATION or UPDATE. * @param string $sort The direction of the ordering: ASC or DESC. * @param int $from Fetch records from. * @param int $limit Number of records to fetch. * @return array The first element being the recordset, the second the number of entries. * @since Moodle 3.1 */ function glossary_get_entries_to_approve($glossary, $context, $letter, $order, $sort, $from, $limit) { $qb = new mod_glossary_entry_query_builder($glossary); if ($letter != 'ALL' && $letter != 'SPECIAL' && core_text::strlen($letter)) { $qb->filter_by_concept_letter($letter); } if ($letter == 'SPECIAL') { $qb->filter_by_concept_non_letter(); } $qb->add_field('*', 'entries'); $qb->join_user(); $qb->add_user_fields(); $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ONLY); if ($order == 'CREATION') { $qb->order_by('timecreated', 'entries', $sort); } else if ($order == 'UPDATE') { $qb->order_by('timemodified', 'entries', $sort); } else { $qb->order_by('concept', 'entries', $sort); } $qb->order_by('id', 'entries', $sort); // Sort on ID to avoid random ordering when entries share an ordering value. $qb->limit($from, $limit); // Fetching the entries. $count = $qb->count_records(); $entries = $qb->get_records(); return array($entries, $count); } /** * Fetch an entry. * * @param int $id The entry ID. * @return object|false The entry, or false when not found. * @since Moodle 3.1 */ function glossary_get_entry_by_id($id) { // Build the query. $qb = new mod_glossary_entry_query_builder(); $qb->add_field('*', 'entries'); $qb->join_user(); $qb->add_user_fields(); $qb->where('id', 'entries', $id); // Fetching the entries. $entries = $qb->get_records(); if (empty($entries)) { return false; } return array_pop($entries); } /** * Checks if the current user can see the glossary entry. * * @since Moodle 3.1 * @param stdClass $entry * @param cm_info $cminfo * @return bool */ function glossary_can_view_entry($entry, $cminfo) { global $USER; $cm = $cminfo->get_course_module_record(); $context = \context_module::instance($cm->id); // Recheck uservisible although it should have already been checked in core_search. if ($cminfo->uservisible === false) { return false; } // Check approval. if (empty($entry->approved) && $entry->userid != $USER->id && !has_capability('mod/glossary:approve', $context)) { return false; } return true; } /** * Check if a concept exists in a glossary. * * @param stdClass $glossary glossary object * @param string $concept the concept to check * @return bool true if exists * @since Moodle 3.2 */ function glossary_concept_exists($glossary, $concept) { global $DB; return $DB->record_exists_select('glossary_entries', 'glossaryid = :glossaryid AND LOWER(concept) = :concept', array( 'glossaryid' => $glossary->id, 'concept' => core_text::strtolower($concept) ) ); } /** * Return the editor and attachment options when editing a glossary entry * * @param stdClass $course course object * @param stdClass $context context object * @param stdClass $entry entry object * @return array array containing the editor and attachment options * @since Moodle 3.2 */ function glossary_get_editor_and_attachment_options($course, $context, $entry) { $maxfiles = 99; // TODO: add some setting. $maxbytes = $course->maxbytes; // TODO: add some setting. $definitionoptions = array('trusttext' => true, 'maxfiles' => $maxfiles, 'maxbytes' => $maxbytes, 'context' => $context, 'subdirs' => file_area_contains_subdirs($context, 'mod_glossary', 'entry', $entry->id)); $attachmentoptions = array('subdirs' => false, 'maxfiles' => $maxfiles, 'maxbytes' => $maxbytes); return array($definitionoptions, $attachmentoptions); } /** * Creates or updates a glossary entry * * @param stdClass $entry entry data * @param stdClass $course course object * @param stdClass $cm course module object * @param stdClass $glossary glossary object * @param stdClass $context context object * @return stdClass the complete new or updated entry * @since Moodle 3.2 */ function glossary_edit_entry($entry, $course, $cm, $glossary, $context) { global $DB, $USER; list($definitionoptions, $attachmentoptions) = glossary_get_editor_and_attachment_options($course, $context, $entry); $timenow = time(); $categories = empty($entry->categories) ? array() : $entry->categories; unset($entry->categories); $aliases = trim($entry->aliases); unset($entry->aliases); if (empty($entry->id)) { $entry->glossaryid = $glossary->id; $entry->timecreated = $timenow; $entry->userid = $USER->id; $entry->timecreated = $timenow; $entry->sourceglossaryid = 0; $entry->teacherentry = has_capability('mod/glossary:manageentries', $context); $isnewentry = true; } else { $isnewentry = false; } $entry->concept = trim($entry->concept); $entry->definition = ''; // Updated later. $entry->definitionformat = FORMAT_HTML; // Updated later. $entry->definitiontrust = 0; // Updated later. $entry->timemodified = $timenow; $entry->approved = 0; $entry->usedynalink = isset($entry->usedynalink) ? $entry->usedynalink : 0; $entry->casesensitive = isset($entry->casesensitive) ? $entry->casesensitive : 0; $entry->fullmatch = isset($entry->fullmatch) ? $entry->fullmatch : 0; if ($glossary->defaultapproval or has_capability('mod/glossary:approve', $context)) { $entry->approved = 1; } if ($isnewentry) { // Add new entry. $entry->id = $DB->insert_record('glossary_entries', $entry); } else { // Update existing entry. $DB->update_record('glossary_entries', $entry); } // Save and relink embedded images and save attachments. if (!empty($entry->definition_editor)) { $entry = file_postupdate_standard_editor($entry, 'definition', $definitionoptions, $context, 'mod_glossary', 'entry', $entry->id); } if (!empty($entry->attachment_filemanager)) { $entry = file_postupdate_standard_filemanager($entry, 'attachment', $attachmentoptions, $context, 'mod_glossary', 'attachment', $entry->id); } // Store the updated value values. $DB->update_record('glossary_entries', $entry); // Refetch complete entry. $entry = $DB->get_record('glossary_entries', array('id' => $entry->id)); // Update entry categories. $DB->delete_records('glossary_entries_categories', array('entryid' => $entry->id)); // TODO: this deletes cats from both both main and secondary glossary :-(. if (!empty($categories) and array_search(0, $categories) === false) { foreach ($categories as $catid) { $newcategory = new stdClass(); $newcategory->entryid = $entry->id; $newcategory->categoryid = $catid; $DB->insert_record('glossary_entries_categories', $newcategory, false); } } // Update aliases. $DB->delete_records('glossary_alias', array('entryid' => $entry->id)); if ($aliases !== '') { $aliases = explode("\n", $aliases); foreach ($aliases as $alias) { $alias = trim($alias); if ($alias !== '') { $newalias = new stdClass(); $newalias->entryid = $entry->id; $newalias->alias = $alias; $DB->insert_record('glossary_alias', $newalias, false); } } } // Trigger event and update completion (if entry was created). $eventparams = array( 'context' => $context, 'objectid' => $entry->id, 'other' => array('concept' => $entry->concept) ); if ($isnewentry) { $event = \mod_glossary\event\entry_created::create($eventparams); } else { $event = \mod_glossary\event\entry_updated::create($eventparams); } $event->add_record_snapshot('glossary_entries', $entry); $event->trigger(); if ($isnewentry) { // Update completion state. $completion = new completion_info($course); if ($completion->is_enabled($cm) == COMPLETION_TRACKING_AUTOMATIC && $glossary->completionentries && $entry->approved) { $completion->update_state($cm, COMPLETION_COMPLETE); } } // Reset caches. if ($isnewentry) { if ($entry->usedynalink and $entry->approved) { \mod_glossary\local\concept_cache::reset_glossary($glossary); } } else { // So many things may affect the linking, let's just purge the cache always on edit. \mod_glossary\local\concept_cache::reset_glossary($glossary); } return $entry; } /** * 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 glossary_check_updates_since(cm_info $cm, $from, $filter = array()) { global $DB; $updates = course_check_module_updates_since($cm, $from, array('attachment', 'entry'), $filter); $updates->entries = (object) array('updated' => false); $select = 'glossaryid = :id AND (timecreated > :since1 OR timemodified > :since2)'; $params = array('id' => $cm->instance, 'since1' => $from, 'since2' => $from); if (!has_capability('mod/glossary:approve', $cm->context)) { $select .= ' AND approved = 1'; } $entries = $DB->get_records_select('glossary_entries', $select, $params, '', 'id'); if (!empty($entries)) { $updates->entries->updated = true; $updates->entries->itemids = array_keys($entries); } return $updates; } /** * Get icon mapping for font-awesome. * * @return array */ function mod_glossary_get_fontawesome_icon_map() { return [ 'mod_glossary:export' => 'fa-download', 'mod_glossary:minus' => 'fa-minus' ]; } /** * 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 * @param int $userid User id to use for all capability checks, etc. Set to 0 for current user (default). * @return \core_calendar\local\event\entities\action_interface|null */ function mod_glossary_core_calendar_provide_event_action(calendar_event $event, \core_calendar\action_factory $factory, int $userid = 0) { global $USER; if (!$userid) { $userid = $USER->id; } $cm = get_fast_modinfo($event->courseid, $userid)->instances['glossary'][$event->instance]; if (!$cm->uservisible) { // The module is not visible to the user for any reason. return null; } $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/glossary/view.php', ['id' => $cm->id]), 1, true ); } /** * Add a get_coursemodule_info function in case any glossary type wants to add 'extra' information * for the course (see resource). * * Given a course_module object, this function returns any "extra" information that may be needed * when printing this activity in a course listing. See get_array_of_activities() in course/lib.php. * * @param stdClass $coursemodule The coursemodule object (record). * @return cached_cm_info An object on information that the courses * will know about (most noticeably, an icon). */ function glossary_get_coursemodule_info($coursemodule) { global $DB; $dbparams = ['id' => $coursemodule->instance]; $fields = 'id, name, intro, introformat, completionentries'; if (!$glossary = $DB->get_record('glossary', $dbparams, $fields)) { return false; } $result = new cached_cm_info(); $result->name = $glossary->name; if ($coursemodule->showdescription) { // Convert intro to html. Do not filter cached version, filters run at display time. $result->content = format_module_intro('glossary', $glossary, $coursemodule->id, false); } // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'. if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) { $result->customdata['customcompletionrules']['completionentries'] = $glossary->completionentries; } return $result; } /** * Callback which returns human-readable strings describing the active completion custom rules for the module instance. * * @param cm_info|stdClass $cm object with fields ->completion and ->customdata['customcompletionrules'] * @return array $descriptions the array of descriptions for the custom rules. */ function mod_glossary_get_completion_active_rule_descriptions($cm) { // Values will be present in cm_info, and we assume these are up to date. if (empty($cm->customdata['customcompletionrules']) || $cm->completion != COMPLETION_TRACKING_AUTOMATIC) { return []; } $descriptions = []; foreach ($cm->customdata['customcompletionrules'] as $key => $val) { switch ($key) { case 'completionentries': if (!empty($val)) { $descriptions[] = get_string('completionentriesdesc', 'glossary', $val); } break; default: break; } } return $descriptions; } /** * Checks if the current user can delete the given glossary entry. * * @since Moodle 3.10 * @param stdClass $entry the entry database object * @param stdClass $glossary the glossary database object * @param stdClass $context the glossary context * @param bool $return Whether to return a boolean value or stop the execution (exception) * @return bool if the user can delete the entry * @throws moodle_exception */ function mod_glossary_can_delete_entry($entry, $glossary, $context, $return = true) { global $USER, $CFG; $manageentries = has_capability('mod/glossary:manageentries', $context); if ($manageentries) { // Users with the capability will always be able to delete entries. return true; } if ($entry->userid != $USER->id) { // Guest id is never matched, no need for special check here. if ($return) { return false; } throw new moodle_exception('nopermissiontodelentry'); } $ineditperiod = ((time() - $entry->timecreated < $CFG->maxeditingtime) || $glossary->editalways); if (!$ineditperiod) { if ($return) { return false; } throw new moodle_exception('errdeltimeexpired', 'glossary'); } return true; } /** * Deletes the given entry, this function does not perform capabilities/permission checks. * * @since Moodle 3.10 * @param stdClass $entry the entry database object * @param stdClass $glossary the glossary database object * @param stdClass $cm the glossary course moduule object * @param stdClass $context the glossary context * @param stdClass $course the glossary course * @param string $hook the hook, usually type of filtering, value * @param string $prevmode the previsualisation mode * @throws moodle_exception */ function mod_glossary_delete_entry($entry, $glossary, $cm, $context, $course, $hook = '', $prevmode = '') { global $CFG, $DB; $origentry = fullclone($entry); // If it is an imported entry, just delete the relation. if ($entry->sourceglossaryid) { if (!$newcm = get_coursemodule_from_instance('glossary', $entry->sourceglossaryid)) {
< print_error('invalidcoursemodule');
> throw new \moodle_exception('invalidcoursemodule');
} $newcontext = context_module::instance($newcm->id); $entry->glossaryid = $entry->sourceglossaryid; $entry->sourceglossaryid = 0; $DB->update_record('glossary_entries', $entry); // Move attachments too. $fs = get_file_storage(); if ($oldfiles = $fs->get_area_files($context->id, 'mod_glossary', 'attachment', $entry->id)) { foreach ($oldfiles as $oldfile) { $filerecord = new stdClass(); $filerecord->contextid = $newcontext->id; $fs->create_file_from_storedfile($filerecord, $oldfile); } $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id); $entry->attachment = '1'; } else { $entry->attachment = '0'; } $DB->update_record('glossary_entries', $entry); } else { $fs = get_file_storage(); $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id); $DB->delete_records("comments", ['itemid' => $entry->id, 'commentarea' => 'glossary_entry', 'contextid' => $context->id]); $DB->delete_records("glossary_alias", ["entryid" => $entry->id]); $DB->delete_records("glossary_entries", ["id" => $entry->id]); // Update completion state. $completion = new completion_info($course); if ($completion->is_enabled($cm) == COMPLETION_TRACKING_AUTOMATIC && $glossary->completionentries) { $completion->update_state($cm, COMPLETION_INCOMPLETE, $entry->userid); } // Delete glossary entry ratings. require_once($CFG->dirroot.'/rating/lib.php'); $delopt = new stdClass; $delopt->contextid = $context->id; $delopt->component = 'mod_glossary'; $delopt->ratingarea = 'entry'; $delopt->itemid = $entry->id; $rm = new rating_manager(); $rm->delete_ratings($delopt); } // Delete cached RSS feeds. if (!empty($CFG->enablerssfeeds)) { require_once($CFG->dirroot . '/mod/glossary/rsslib.php'); glossary_rss_delete_file($glossary); } core_tag_tag::remove_all_item_tags('mod_glossary', 'glossary_entries', $origentry->id); $event = \mod_glossary\event\entry_deleted::create( [ 'context' => $context, 'objectid' => $origentry->id, 'other' => [ 'mode' => $prevmode, 'hook' => $hook, 'concept' => $origentry->concept ] ] ); $event->add_record_snapshot('glossary_entries', $origentry); $event->trigger(); // Reset caches. if ($entry->usedynalink and $entry->approved) { \mod_glossary\local\concept_cache::reset_glossary($glossary); } } /** * Checks if the current user can update the given glossary entry. * * @since Moodle 3.10 * @param stdClass $entry the entry database object * @param stdClass $glossary the glossary database object * @param stdClass $context the glossary context * @param object $cm the course module object (cm record or cm_info instance) * @param bool $return Whether to return a boolean value or stop the execution (exception) * @return bool if the user can update the entry * @throws moodle_exception */ function mod_glossary_can_update_entry(stdClass $entry, stdClass $glossary, stdClass $context, object $cm, bool $return = true): bool { global $USER, $CFG; $ineditperiod = ((time() - $entry->timecreated < $CFG->maxeditingtime) || $glossary->editalways); if (!has_capability('mod/glossary:manageentries', $context) and !($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context)))) { if ($USER->id != $entry->userid) { if ($return) { return false; } throw new moodle_exception('errcannoteditothers', 'glossary', "view.php?id=$cm->id&amp;mode=entry&amp;hook=$entry->id"); } else if (!$ineditperiod) { if ($return) { return false; } throw new moodle_exception('erredittimeexpired', 'glossary', "view.php?id=$cm->id&amp;mode=entry&amp;hook=$entry->id"); } } return true; } /** * Prepares an entry for editing, adding aliases and category information. * * @param stdClass $entry the entry being edited * @return stdClass the entry with the additional data */ function mod_glossary_prepare_entry_for_edition(stdClass $entry): stdClass { global $DB; if ($aliases = $DB->get_records_menu("glossary_alias", ["entryid" => $entry->id], '', 'id, alias')) { $entry->aliases = implode("\n", $aliases) . "\n"; } if ($categoriesarr = $DB->get_records_menu("glossary_entries_categories", ['entryid' => $entry->id], '', 'id, categoryid')) { // TODO: this fetches cats from both main and secondary glossary :-( $entry->categories = array_values($categoriesarr); } return $entry; }