3 // This file is part of Moodle - http://moodle.org/
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
19 * Library of functions and constants for module glossary
20 * (replace glossary with the name of your module and delete this line)
22 * @package mod-glossary
23 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 require_once($CFG->dirroot . '/rating/lib.php');
28 define("GLOSSARY_SHOW_ALL_CATEGORIES", 0);
29 define("GLOSSARY_SHOW_NOT_CATEGORISED", -1);
31 define("GLOSSARY_NO_VIEW", -1);
32 define("GLOSSARY_STANDARD_VIEW", 0);
33 define("GLOSSARY_CATEGORY_VIEW", 1);
34 define("GLOSSARY_DATE_VIEW", 2);
35 define("GLOSSARY_AUTHOR_VIEW", 3);
36 define("GLOSSARY_ADDENTRY_VIEW", 4);
37 define("GLOSSARY_IMPORT_VIEW", 5);
38 define("GLOSSARY_EXPORT_VIEW", 6);
39 define("GLOSSARY_APPROVAL_VIEW", 7);
41 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
44 * @param object $glossary
47 function glossary_add_instance($glossary) {
49 /// Given an object containing all the necessary data,
50 /// (defined by the form in mod_form.php) this function
51 /// will create a new instance and return the id number
52 /// of the new instance.
54 if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
55 $glossary->assesstimestart = 0;
56 $glossary->assesstimefinish = 0;
59 if (empty($glossary->globalglossary) ) {
60 $glossary->globalglossary = 0;
63 if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
64 $glossary->globalglossary = 0;
67 $glossary->timecreated = time();
68 $glossary->timemodified = $glossary->timecreated;
70 //Check displayformat is a valid one
71 $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
72 if (!in_array($glossary->displayformat, $formats)) {
73 print_error('unknowformat', '', '', $glossary->displayformat);
76 $returnid = $DB->insert_record("glossary", $glossary);
77 $glossary->id = $returnid;
78 glossary_grade_item_update($glossary);
84 * Given an object containing all the necessary data,
85 * (defined by the form in mod_form.php) this function
86 * will update an existing instance with new data.
90 * @param object $glossary
93 function glossary_update_instance($glossary) {
96 if (empty($glossary->globalglossary)) {
97 $glossary->globalglossary = 0;
100 if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
102 unset($glossary->globalglossary);
105 $glossary->timemodified = time();
106 $glossary->id = $glossary->instance;
108 if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
109 $glossary->assesstimestart = 0;
110 $glossary->assesstimefinish = 0;
113 //Check displayformat is a valid one
114 $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
115 if (!in_array($glossary->displayformat, $formats)) {
116 print_error('unknowformat', '', '', $glossary->displayformat);
119 $DB->update_record("glossary", $glossary);
120 if ($glossary->defaultapproval) {
121 $DB->execute("UPDATE {glossary_entries} SET approved = 1 where approved <> 1 and glossaryid = ?", array($glossary->id));
123 glossary_grade_item_update($glossary);
129 * Given an ID of an instance of this module,
130 * this function will permanently delete the instance
131 * and any data that depends on it.
134 * @param int $id glossary id
135 * @return bool success
137 function glossary_delete_instance($id) {
140 if (!$glossary = $DB->get_record('glossary', array('id'=>$id))) {
144 if (!$cm = get_coursemodule_from_instance('glossary', $id)) {
148 if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
152 $fs = get_file_storage();
154 if ($glossary->mainglossary) {
156 $sql = "SELECT ge.id, ge.sourceglossaryid, cm.id AS sourcecmid
157 FROM {glossary_entries} ge
158 JOIN {modules} m ON m.name = 'glossary'
159 JOIN {course_modules} cm ON (cm.module = m.id AND cm.instance = ge.sourceglossaryid)
160 WHERE ge.glossaryid = ? AND ge.sourceglossaryid > 0";
162 if ($exported = $DB->get_records_sql($sql, array($id))) {
163 foreach ($exported as $entry) {
164 $entry->glossaryid = $entry->sourceglossaryid;
165 $entry->sourceglossaryid = 0;
166 $newcontext = get_context_instance(CONTEXT_MODULE, $entry->sourcecmid);
167 if ($oldfiles = $fs->get_area_files($context->id, 'mod_glossary', 'attachment', $entry->id)) {
168 foreach ($oldfiles as $oldfile) {
169 $file_record = new object();
170 $file_record->contextid = $newcontext->id;
171 $fs->create_file_from_storedfile($file_record, $oldfile);
173 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
174 $entry->attachment = '1';
176 $entry->attachment = '0';
178 $DB->update_record('glossary_entries', $entry);
182 // move exported entries to main glossary
183 $sql = "UPDATE {glossary_entries}
184 SET sourceglossaryid = 0
185 WHERE sourceglossaryid = ?";
186 $DB->execute($sql, array($id));
189 // Delete any dependent records
190 $entry_select = "SELECT id FROM {glossary_entries} WHERE glossaryid = ?";
191 $DB->delete_records_select('comments', "contextid=? AND commentarea=? AND itemid IN ($entry_select)", array($id, 'glossary_entry', $context->id));
192 $DB->delete_records_select('glossary_alias', "entryid IN ($entry_select)", array($id));
194 $category_select = "SELECT id FROM {glossary_categories} WHERE glossaryid = ?";
195 $DB->delete_records_select('glossary_entries_categories', "categoryid IN ($category_select)", array($id));
196 $DB->delete_records('glossary_categories', array('glossaryid'=>$id));
199 $fs->delete_area_files($context->id);
202 $rm = new rating_manager();
203 $ratingdeloptions = new stdclass();
204 $ratingdeloptions->contextid = $context->id;
205 $rm->delete_ratings($ratingdeloptions);
207 glossary_grade_item_delete($glossary);
209 return $DB->delete_records('glossary', array('id'=>$id));
213 * Return a small object with summary information about what a
214 * user has done with a given particular instance of this module
215 * Used for user activity reports.
216 * $return->time = the time they did it
217 * $return->info = a short text description
219 * @param object $course
220 * @param object $user
222 * @param object $glossary
223 * @return object|null
225 function glossary_user_outline($course, $user, $mod, $glossary) {
228 require_once("$CFG->libdir/gradelib.php");
229 $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
230 if (empty($grades->items[0]->grades)) {
233 $grade = reset($grades->items[0]->grades);
236 if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
237 $result = new object();
238 $result->info = count($entries) . ' ' . get_string("entries", "glossary");
240 $lastentry = array_pop($entries);
241 $result->time = $lastentry->timemodified;
244 $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
248 $result = new object();
249 $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
250 $result->time = $grade->dategraded;
258 * @param int $glossaryid
262 function glossary_get_user_entries($glossaryid, $userid) {
263 /// Get all the entries for a user in a glossary
266 return $DB->get_records_sql("SELECT e.*, u.firstname, u.lastname, u.email, u.picture
267 FROM {glossary} g, {glossary_entries} e, {user} u
269 AND e.glossaryid = g.id
272 ORDER BY e.timemodified ASC", array($glossaryid, $userid));
276 * Print a detailed representation of what a user has done with
277 * a given particular instance of this module, for user activity reports.
280 * @param object $course
281 * @param object $user
283 * @param object $glossary
285 function glossary_user_complete($course, $user, $mod, $glossary) {
286 global $CFG, $OUTPUT;
287 require_once("$CFG->libdir/gradelib.php");
289 $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
290 if (!empty($grades->items[0]->grades)) {
291 $grade = reset($grades->items[0]->grades);
292 echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
293 if ($grade->str_feedback) {
294 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
298 if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
299 echo '<table width="95%" border="0"><tr><td>';
300 foreach ($entries as $entry) {
301 $cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id);
302 glossary_print_entry($course, $cm, $glossary, $entry,"","",0);
305 echo '</td></tr></table>';
309 * Given a course and a time, this module should find recent activity
310 * that has occurred in glossary activities and print it out.
311 * Return true if there was output, or false is there was none.
316 * @param object $course
317 * @param object $viewfullnames
318 * @param int $timestart
321 function glossary_print_recent_activity($course, $viewfullnames, $timestart) {
322 global $CFG, $USER, $DB, $OUTPUT;
324 //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0
326 $modinfo = get_fast_modinfo($course);
328 foreach ($modinfo->cms as $cm) {
329 if ($cm->modname != 'glossary') {
332 if (!$cm->uservisible) {
335 $ids[$cm->instance] = $cm->instance;
342 $glist = implode(',', $ids); // there should not be hundreds of glossaries in one course, right?
344 if (!$entries = $DB->get_records_sql("SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
345 ge.userid, u.firstname, u.lastname, u.email, u.picture
346 FROM {glossary_entries} ge
347 JOIN {user} u ON u.id = ge.userid
348 WHERE ge.glossaryid IN ($glist) AND ge.timemodified > ?
349 ORDER BY ge.timemodified ASC", array($timestart))) {
355 foreach ($entries as $entryid=>$entry) {
356 if ($entry->approved) {
360 if (!isset($editor[$entry->glossaryid])) {
361 $editor[$entry->glossaryid] = has_capability('mod/glossary:approve', get_context_instance(CONTEXT_MODULE, $modinfo->instances['glossary'][$entry->glossaryid]->id));
364 if (!$editor[$entry->glossaryid]) {
365 unset($entries[$entryid]);
372 echo $OUTPUT->heading(get_string('newentries', 'glossary').':');
374 $strftimerecent = get_string('strftimerecent');
375 foreach ($entries as $entry) {
376 $link = $CFG->wwwroot.'/mod/glossary/view.php?g='.$entry->glossaryid.'&mode=entry&hook='.$entry->id;
377 if ($entry->approved) {
380 $dimmed = ' dimmed_text';
382 echo '<div class="head'.$dimmed.'">';
383 echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
384 echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
386 echo '<div class="info"><a href="'.$link.'">'.format_text($entry->concept, true).'</a></div>';
396 function glossary_log_info($log) {
399 return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
400 FROM {glossary_entries} e, {user} u
401 WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
405 * Function to be run periodically according to the moodle cron
406 * This function searches for things that need to be done, such
407 * as sending out mail, toggling flags etc ...
410 function glossary_cron () {
415 * Return grade for given user or all users.
418 * @param int $glossaryid id of glossary
419 * @param int $userid optional user id, 0 means all users
420 * @return array array of grades, false if none
422 function glossary_get_user_grades($glossary, $userid=0) {
425 $params = array('userid'=>$userid, 'gid'=>$glossary->id);
427 $user = $userid ? "AND u.id = :userid" : "";
429 $sql = "SELECT u.id, u.id AS userid, avg(gr.rating) AS rawgrade
430 FROM {user} u, {glossary_entries} ge, {glossary_ratings} gr
431 WHERE u.id = ge.userid AND ge.id = gr.entryid
432 AND gr.userid != u.id AND ge.glossaryid = :gid
436 return $DB->get_records_sql($sql, $params);*/
439 require_once($CFG->dirroot.'/rating/lib.php');
440 $rm = new rating_manager();
442 $ratingoptions = new stdclass();
444 //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
445 $ratingoptions->modulename = 'glossary';
446 $ratingoptions->moduleid = $glossary->id;
448 $ratingoptions->userid = $userid;
449 $ratingoptions->aggregationmethod = $glossary->assessed;
450 $ratingoptions->scaleid = $glossary->scale;
451 $ratingoptions->itemtable = 'glossary_entries';
452 $ratingoptions->itemtableusercolumn = 'userid';
454 return $rm->get_user_grades($ratingoptions);
458 * Return rating related permissions
459 * @param string $options the context id
460 * @return array an associative array of the user's rating permissions
462 function glossary_rating_permissions($options) {
463 $contextid = $options;
464 $context = get_context_instance_by_id($contextid);
467 print_error('invalidcontext');
470 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));
475 * Returns the names of the table and columns necessary to check items for ratings
476 * @return array an array containing the item table, item id and user id columns
478 function glossary_rating_item_check_info() {
479 return array('glossary_entries','id','userid');
483 * Update activity grades
487 * @param object $glossary null means all glossaries (with extra cmidnumber property)
488 * @param int $userid specific user only, 0 means all
490 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
492 require_once($CFG->libdir.'/gradelib.php');
494 if (!$glossary->assessed) {
495 glossary_grade_item_update($glossary);
497 } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
498 glossary_grade_item_update($glossary, $grades);
500 } else if ($userid and $nullifnone) {
501 $grade = new object();
502 $grade->userid = $userid;
503 $grade->rawgrade = NULL;
504 glossary_grade_item_update($glossary, $grade);
507 glossary_grade_item_update($glossary);
512 * Update all grades in gradebook.
516 function glossary_upgrade_grades() {
519 $sql = "SELECT COUNT('x')
520 FROM {glossary} g, {course_modules} cm, {modules} m
521 WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
522 $count = $DB->count_records_sql($sql);
524 $sql = "SELECT g.*, cm.idnumber AS cmidnumber, g.course AS courseid
525 FROM {glossary} g, {course_modules} cm, {modules} m
526 WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
527 if ($rs = $DB->get_recordset_sql($sql)) {
528 $pbar = new progress_bar('glossaryupgradegrades', 500, true);
530 foreach ($rs as $glossary) {
532 upgrade_set_timeout(60*5); // set up timeout, may also abort execution
533 glossary_update_grades($glossary, 0, false);
534 $pbar->update($i, $count, "Updating Glossary grades ($i/$count).");
541 * Create/update grade item for given glossary
544 * @param object $glossary object with extra cmidnumber
545 * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
546 * @return int, 0 if ok, error code otherwise
548 function glossary_grade_item_update($glossary, $grades=NULL) {
550 require_once($CFG->libdir.'/gradelib.php');
552 $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
554 if (!$glossary->assessed or $glossary->scale == 0) {
555 $params['gradetype'] = GRADE_TYPE_NONE;
557 } else if ($glossary->scale > 0) {
558 $params['gradetype'] = GRADE_TYPE_VALUE;
559 $params['grademax'] = $glossary->scale;
560 $params['grademin'] = 0;
562 } else if ($glossary->scale < 0) {
563 $params['gradetype'] = GRADE_TYPE_SCALE;
564 $params['scaleid'] = -$glossary->scale;
567 if ($grades === 'reset') {
568 $params['reset'] = true;
572 return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
576 * Delete grade item for given glossary
579 * @param object $glossary object
581 function glossary_grade_item_delete($glossary) {
583 require_once($CFG->libdir.'/gradelib.php');
585 return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
589 * Returns the users with data in one glossary
590 * (users with records in glossary_entries, students)
593 * @param int $glossaryid
596 function glossary_get_participants($glossaryid) {
600 $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
601 FROM {user} u, {glossary_entries} g
602 WHERE g.glossaryid = ? AND u.id = g.userid", array($glossaryid));
604 //Return students array (it contains an array of unique users)
610 * @param int $gloassryid
611 * @param int $scaleid
614 function glossary_scale_used ($glossaryid,$scaleid) {
615 //This function returns if a scale is being used by one glossary
620 $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
622 if (!empty($rec) && !empty($scaleid)) {
630 * Checks if scale is being used by any instance of glossary
632 * This is used to find out if scale used anywhere
635 * @param int $scaleid
636 * @return boolean True if the scale is used by any glossary
638 function glossary_scale_used_anywhere($scaleid) {
641 if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
648 //////////////////////////////////////////////////////////////////////////////////////
649 /// Any other glossary functions go here. Each of them must have a name that
650 /// starts with glossary_
653 * This function return an array of valid glossary_formats records
654 * Everytime it's called, every existing format is checked, new formats
655 * are included if detected and old formats are deleted and any glossary
656 * using an invalid format is updated to the default (dictionary).
662 function glossary_get_available_formats() {
665 //Get available formats (plugin) and insert (if necessary) them into glossary_formats
666 $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
667 $pluginformats = array();
668 foreach ($formats as $format) {
669 //If the format file exists
670 if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
671 include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
672 //If the function exists
673 if (function_exists('glossary_show_entry_'.$format)) {
674 //Acummulate it as a valid format
675 $pluginformats[] = $format;
676 //If the format doesn't exist in the table
677 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
678 //Insert the record in glossary_formats
681 $gf->popupformatname = $format;
683 $DB->insert_record("glossary_formats",$gf);
689 //Delete non_existent formats from glossary_formats table
690 $formats = $DB->get_records("glossary_formats");
691 foreach ($formats as $format) {
693 //If the format in DB isn't a valid previously detected format then delete the record
694 if (!in_array($format->name,$pluginformats)) {
700 $DB->delete_records('glossary_formats', array('name'=>$format->name));
701 //Reasign existing glossaries to default (dictionary) format
702 if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
703 foreach($glossaries as $glossary) {
704 $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
710 //Now everything is ready in glossary_formats table
711 $formats = $DB->get_records("glossary_formats");
718 * @param string $text
721 function glossary_debug($debug,$text,$br=1) {
723 echo '<font color="red">' . $text . '</font>';
733 * @param int $glossaryid
734 * @param string $entrylist
735 * @param string $pivot
738 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
744 return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
745 FROM {glossary_entries}
747 AND id IN ($entrylist)", array($glossaryid));
753 * @param object $concept
754 * @param string $courseid
757 function glossary_get_entries_search($concept, $courseid) {
760 //Check if the user is an admin
761 $bypassadmin = 1; //This means NO (by default)
762 if (has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_SYSTEM))) {
763 $bypassadmin = 0; //This means YES
766 //Check if the user is a teacher
767 $bypassteacher = 1; //This means NO (by default)
768 if (has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $courseid))) {
769 $bypassteacher = 0; //This means YES
772 $conceptlower = moodle_strtolower(trim($concept));
774 $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
776 return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
777 FROM {glossary_entries} e, {glossary} g,
778 {course_modules} cm, {modules} m
779 WHERE m.name = 'glossary' AND
781 (cm.visible = 1 OR cm.visible = $bypassadmin OR
782 (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
783 g.id = cm.instance AND
784 e.glossaryid = g.id AND
785 ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
786 (e.casesensitive = 0 and concept = :concept)) AND
787 (g.course = :courseid2 OR g.globalglossary = 1) AND
788 e.usedynalink != 0 AND
789 g.usedynalink != 0", $params);
795 * @param object $course
796 * @param object $course
797 * @param object $glossary
798 * @param object $entry
799 * @param string $mode
800 * @param string $hook
801 * @param int $printicons
802 * @param int $displayformat
803 * @param bool $printview
806 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat = -1, $printview = false) {
809 if ( $displayformat < 0 ) {
810 $displayformat = $glossary->displayformat;
812 if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
813 $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
815 $functionname = 'glossary_print_entry_'.$displayformat;
817 $functionname = 'glossary_show_entry_'.$displayformat;
820 if (file_exists($formatfile)) {
821 include_once($formatfile);
822 if (function_exists($functionname)) {
823 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
824 } else if ($printview) {
825 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
826 $return = glossary_print_entry_default($entry, $glossary, $cm);
834 * Default (old) print format used if custom function doesn't exist in format
836 * @param object $entry
837 * @param object $glossary
839 * @return void Output is echo'd
841 function glossary_print_entry_default ($entry, $glossary, $cm) {
842 echo '<h3>'. strip_tags($entry->concept) . ': </h3>';
844 $definition = $entry->definition;
846 $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
848 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
849 $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
851 $options = new object();
852 $options->para = false;
853 $options->trusted = $entry->definitiontrust;
854 $definition = format_text($definition, $entry->definitionformat, $options);
860 * Print glossary concept/term as a heading <h3>
861 * @param object $entry
863 function glossary_print_entry_concept($entry, $return=false) {
865 $options = new object();
866 $options->para = false;
867 $text = format_text($OUTPUT->heading('<span class="nolink">' . $entry->concept . '</span>', 3, 'nolink'), FORMAT_MOODLE, $options);
868 if (!empty($entry->highlight)) {
869 $text = highlight($entry->highlight, $text);
883 * @param object $entry
884 * @param object $glossary
887 function glossary_print_entry_definition($entry, $glossary, $cm) {
890 $definition = $entry->definition;
892 global $GLOSSARY_EXCLUDECONCEPTS;
894 //Calculate all the strings to be no-linked
896 $GLOSSARY_EXCLUDECONCEPTS=array($entry->concept);
898 if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
899 foreach ($aliases as $alias) {
900 $GLOSSARY_EXCLUDECONCEPTS[]=trim($alias->alias);
904 $options = new object();
905 $options->para = false;
906 $options->trusted = $entry->definitiontrust;
908 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
909 $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
911 $text = format_text($definition, $entry->definitionformat, $options);
913 // Stop excluding concepts from autolinking
914 unset($GLOSSARY_EXCLUDECONCEPTS);
916 if (!empty($entry->highlight)) {
917 $text = highlight($entry->highlight, $text);
919 if (isset($entry->footer)) { // Unparsed footer info
920 $text .= $entry->footer;
928 * @param object $course
930 * @param object $glossary
931 * @param object $entry
932 * @param string $mode
933 * @param string $hook
934 * @param string $type
935 * @return string|void
937 function glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
941 if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
942 foreach ($aliases as $alias) {
943 if (trim($alias->alias)) {
945 $return = '<select style="font-size:8pt">';
947 $return .= "<option>$alias->alias</option>";
951 $return .= '</select>';
954 if ($type == 'print') {
966 * @param object $course
968 * @param object $glossary
969 * @param object $entry
970 * @param string $mode
971 * @param string $hook
972 * @param string $type
973 * @return string|void
975 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
976 global $USER, $CFG, $DB, $OUTPUT;
978 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
980 $output = false; //To decide if we must really return text in "return". Activate when needed only!
981 $importedentry = ($entry->sourceglossaryid == $glossary->id);
982 $ismainglossary = $glossary->mainglossary;
985 $return = '<span class="commands">';
986 // Differentiate links for each entry.
987 $altsuffix = ': '.strip_tags(format_text($entry->concept));
989 if (!$entry->approved) {
991 $return .= get_string('entryishidden','glossary');
994 if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $entry->userid == $USER->id)) {
995 // only teachers can export entries so check it out
996 if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
997 $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
998 if ( $mainglossary ) { // if there is a main glossary defined, allow to export the current entry
1000 $return .= ' <a title="'.get_string('exporttomainglossary','glossary') . '" href="exportentry.php?id='.$entry->id.'&prevmode='.$mode.'&hook='.urlencode($hook).'"><img src="'.$OUTPUT->pix_url('export', 'glossary').'" class="iconsmall" alt="'.get_string('exporttomainglossary','glossary').$altsuffix.'" /></a>';
1004 if ( $entry->sourceglossaryid ) {
1005 $icon = $OUTPUT->pix_url('minus', 'glossary'); // graphical metaphor (minus) for deleting an imported entry
1007 $icon = $OUTPUT->pix_url('t/delete');
1010 //Decide if an entry is editable:
1011 // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
1012 // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1013 $ineditperiod = ((time() - $entry->timecreated < $CFG->maxeditingtime) || $glossary->editalways);
1014 if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1016 $return .= " <a title=\"" . get_string("delete") . "\" href=\"deleteentry.php?id=$cm->id&mode=delete&entry=$entry->id&prevmode=$mode&hook=".urlencode($hook)."\"><img src=\"";
1018 $return .= "\" class=\"iconsmall\" alt=\"" . get_string("delete") .$altsuffix."\" /></a> ";
1020 $return .= " <a title=\"" . get_string("edit") . "\" href=\"edit.php?cmid=$cm->id&id=$entry->id&mode=$mode&hook=".urlencode($hook)."\"><img src=\"" . $OUTPUT->pix_url('t/edit') . "\" class=\"iconsmall\" alt=\"" . get_string("edit") .$altsuffix. "\" /></a>";
1021 } elseif ( $importedentry ) {
1022 $return .= " <font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1025 if (has_capability('mod/glossary:exportentry', $context)
1026 || ($entry->userid == $USER->id
1027 && has_capability('mod/glossary:exportownentry', $context))) {
1028 require_once($CFG->libdir . '/portfoliolib.php');
1029 $button = new portfolio_add_button();
1030 $button->set_callback_options('glossary_entry_portfolio_caller', array('id' => $cm->id, 'entryid' => $entry->id), '/mod/glossary/locallib.php');
1032 $filecontext = $context;
1033 if ($entry->sourceglossaryid == $cm->instance) {
1034 if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1035 $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1038 $fs = get_file_storage();
1039 if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1040 $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1042 $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1045 $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1047 $return .= " "; // just to make up a little the output in Mozilla ;)
1049 $return .= '</span>';
1051 if (has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1053 if (!empty($CFG->usecomments)) {
1054 require_once($CFG->dirroot . '/comment/lib.php');
1055 $cmt = new stdclass;
1056 $cmt->component = 'mod_glossary';
1057 $cmt->context = $context;
1058 $cmt->course = $course;
1060 $cmt->area = 'glossary_entry';
1061 $cmt->itemid = $entry->id;
1062 $cmt->showcount = true;
1063 $comment = new comment($cmt);
1064 $return .= '<div>'.$comment->output(true).'</div>';
1068 //If we haven't calculated any REAL thing, delete result ($return)
1073 if ($type == 'print') {
1081 * @param object $course
1083 * @param object $glossary
1084 * @param object $entry
1085 * @param string $mode
1086 * @param object $hook
1087 * @param bool $printicons
1088 * @param bool $aliases
1091 function glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1093 $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1097 $icons = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1099 if ($aliases || $icons || !empty($entry->rating)) {
1102 echo '<tr valign="top"><td class="aliases">' .
1103 get_string('aliases','glossary').': '.$aliases . '</td></tr>';
1106 echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1108 if (!empty($entry->rating)) {
1109 echo '<tr valign="top"><td class="ratings">';
1110 glossary_print_entry_ratings($course, $entry);
1118 * @todo Document this function
1120 function glossary_print_entry_attachment($entry, $cm, $format=NULL, $align="right", $insidetable=true) {
1121 /// valid format values: html : Return the HTML link for the attachment as an icon
1122 /// text : Return the HTML link for tha attachment as text
1123 /// blank : Print the output to the screen
1124 if ($entry->attachment) {
1126 echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
1128 echo glossary_print_attachments($entry, $cm, $format, $align);
1130 echo "</td></tr></table>\n";
1138 * @param object $entry
1139 * @param string $mode
1140 * @param string $align
1141 * @param bool $insidetable
1143 function glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1144 global $CFG, $OUTPUT;
1146 if ($mode == 'approval' and !$entry->approved) {
1148 echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1150 echo '<a title="'.get_string('approve','glossary').'" href="approve.php?eid='.$entry->id.'&mode='.$mode.'&sesskey='.sesskey().'"><img align="'.$align.'" src="'.$OUTPUT->pix_url('i/approve') . '" style="border:0px; width:34px; height:34px" alt="'.get_string('approve','glossary').'" /></a>';
1152 echo '</td></tr></table>';
1158 * It returns all entries from all glossaries that matches the specified criteria
1159 * within a given $course. It performs an $extended search if necessary.
1160 * It restrict the search to only one $glossary if the $glossary parameter is set.
1164 * @param object $course
1165 * @param array $searchterms
1166 * @param int $extended
1167 * @param object $glossary
1170 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1174 if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1176 foreach ( $glossaries as $glossary ) {
1177 $glos .= "$glossary->id,";
1179 $glos = substr($glos,0,-1);
1182 $glos = $glossary->id;
1185 if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $glossary->course))) {
1186 $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1187 $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1188 $onlyvisibletable = ", {course_modules} cm";
1192 $onlyvisibletable = "";
1195 if ($DB->sql_regex_supported()) {
1196 $REGEXP = $DB->sql_regex(true);
1197 $NOTREGEXP = $DB->sql_regex(false);
1200 $searchcond = array();
1204 $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1207 foreach ($searchterms as $searchterm) {
1210 $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1211 /// will use it to simulate the "-" operator with LIKE clause
1213 /// Under Oracle and MSSQL, trim the + and - operators and perform
1214 /// simpler LIKE (or NOT LIKE) queries
1215 if (!$DB->sql_regex_supported()) {
1216 if (substr($searchterm, 0, 1) == '-') {
1219 $searchterm = trim($searchterm, '+-');
1222 // TODO: +- may not work for non latin languages
1224 if (substr($searchterm,0,1) == '+') {
1225 $searchterm = trim($searchterm, '+-');
1226 $searchterm = preg_quote($searchterm, '|');
1227 $searchcond[] = "$concat $REGEXP :ss$i";
1228 $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1230 } else if (substr($searchterm,0,1) == "-") {
1231 $searchterm = trim($searchterm, '+-');
1232 $searchterm = preg_quote($searchterm, '|');
1233 $searchcond[] = "$concat $NOTREGEXP :ss$i";
1234 $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1237 $searchcond[] = $DB->sql_like($concat, ":ss$i", false, true, $NOT);
1238 $params['ss'.$i] = "%$searchterm%";
1242 if (empty($searchcond)) {
1247 $searchcond = implode(" AND ", $searchcond);
1250 FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1252 AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1253 AND g.id IN ($glos) AND e.approved <> 0";
1255 return $DB->get_records_sql($sql, $params);
1260 * @param array $searchterms
1261 * @param object $glossary
1262 * @param bool $extended
1265 function glossary_search_entries($searchterms, $glossary, $extended) {
1268 $course = $DB->get_record("course", array("id"=>$glossary->course));
1269 return glossary_search($course,$searchterms,$extended,$glossary);
1273 * if return=html, then return a html string.
1274 * if return=text, then return a text-only string.
1275 * otherwise, print HTML for non-images, and return image HTML
1276 * if attachment is an image, $align set its aligment.
1280 * @param object $entry
1282 * @param string $type html, txt, empty
1283 * @param string $align left or right
1284 * @return string image string or nothing depending on $type param
1286 function glossary_print_attachments($entry, $cm, $type=NULL, $align="left") {
1287 global $CFG, $DB, $OUTPUT;
1289 if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
1293 if ($entry->sourceglossaryid == $cm->instance) {
1294 if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1297 $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1300 $filecontext = $context;
1303 $strattachment = get_string('attachment', 'glossary');
1305 $fs = get_file_storage();
1310 if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1311 foreach ($files as $file) {
1312 $filename = $file->get_filename();
1313 $mimetype = $file->get_mimetype();
1314 $iconimage = '<img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />';
1315 $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename);
1317 if ($type == 'html') {
1318 $output .= "<a href=\"$path\">$iconimage</a> ";
1319 $output .= "<a href=\"$path\">".s($filename)."</a>";
1320 $output .= "<br />";
1322 } else if ($type == 'text') {
1323 $output .= "$strattachment ".s($filename).":\n$path\n";
1326 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1327 // Image attachments don't get printed as links
1328 $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1330 $output .= "<a href=\"$path\">$iconimage</a> ";
1331 $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context));
1332 $output .= '<br />';
1342 return $imagereturn;
1347 * Lists all browsable file areas
1349 * @param object $course
1351 * @param object $context
1354 function glossary_get_file_areas($course, $cm, $context) {
1360 * Serves the glossary attachments. Implements needed access control ;-)
1362 * @param object $course
1364 * @param object $context
1365 * @param string $filearea
1366 * @param array $args
1367 * @param bool $forcedownload
1368 * @return bool false if file not found, does not return if found - justsend the file
1370 function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
1373 if ($context->contextlevel != CONTEXT_MODULE) {
1377 require_course_login($course, true, $cm);
1379 if ($filearea === 'attachment' or $filearea === 'entry') {
1380 $entryid = (int)array_shift($args);
1382 require_course_login($course, true, $cm);
1384 if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1388 if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1392 if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1396 // this trickery here is because we need to support source glossary access
1398 if ($entry->glossaryid == $cm->instance) {
1399 $filecontext = $context;
1401 } else if ($entry->sourceglossaryid == $cm->instance) {
1402 if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1405 $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1411 $relativepath = implode('/', $args);
1412 $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath";
1414 $fs = get_file_storage();
1415 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1419 // finally send the file
1420 send_stored_file($file, 0, 0, true); // download MUST be forced - security!
1422 } else if ($filearea === 'export') {
1423 require_login($course, false, $cm);
1424 require_capability('mod/glossary:export', $context);
1426 if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1430 $cat = array_shift($args);
1431 $cat = clean_param($cat, PARAM_ALPHANUM);
1433 $filename = clean_filename(strip_tags(format_string($glossary->name)).'.xml');
1434 $content = glossary_generate_export_file($glossary, NULL, $cat);
1436 send_file($content, $filename, 0, 0, true, true);
1445 function glossary_print_tabbed_table_end() {
1446 echo "</div></div>";
1451 * @param object $glossary
1452 * @param string $mode
1453 * @param string $hook
1454 * @param string $sortkey
1455 * @param string $sortorder
1457 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1458 if ($glossary->showalphabet) {
1459 echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1461 glossary_print_special_links($cm, $glossary, $mode, $hook);
1463 glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1465 glossary_print_all_links($cm, $glossary, $mode, $hook);
1467 glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1471 * @param object $glossary
1472 * @param string $hook
1473 * @param string $sortkey
1474 * @param string $sortorder
1476 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1477 echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1482 * @param object $glossary
1483 * @param string $hook
1484 * @param string $sortkey
1485 * @param string $sortorder
1487 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1488 echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1492 * @param object $glossary
1493 * @param string $hook
1494 * @param string $sortkey
1495 * @param string $sortorder
1497 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1498 if ( $mode != 'date' ) {
1499 if ($glossary->showalphabet) {
1500 echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1503 glossary_print_special_links($cm, $glossary, $mode, $hook);
1505 glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1507 glossary_print_all_links($cm, $glossary, $mode, $hook);
1509 glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1515 * @param object $glossary
1516 * @param string $hook
1517 * @param string $sortkey
1518 * @param string $sortorder
1520 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1521 if ($glossary->showalphabet) {
1522 echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1525 glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1526 glossary_print_all_links($cm, $glossary, $mode, $hook);
1527 glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1534 * @param object $glossary
1535 * @param string $hook
1536 * @param object $category
1538 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1539 global $CFG, $DB, $OUTPUT;
1541 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1543 echo '<table border="0" width="100%">';
1546 echo '<td align="center" style="width:20%">';
1547 if (has_capability('mod/glossary:managecategories', $context)) {
1548 $options['id'] = $cm->id;
1549 $options['mode'] = 'cat';
1550 $options['hook'] = $hook;
1551 echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1555 echo '<td align="center" style="width:60%">';
1559 $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1560 $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1562 $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1564 if ( $categories ) {
1565 foreach ($categories as $currentcategory) {
1566 $url = $currentcategory->id;
1568 if ($currentcategory->id == $category->id) {
1572 $menu[$url] = clean_text($currentcategory->name); //Only clean, not filters
1576 $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1580 echo format_text($category->name, FORMAT_PLAIN);
1582 if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1584 echo get_string("entrieswithoutcategory","glossary");
1585 $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1587 } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1589 echo get_string("allcategories","glossary");
1590 $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1595 echo '<td align="center" style="width:20%">';
1597 $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1598 echo $OUTPUT->render($select);
1609 * @param object $glossary
1610 * @param string $mode
1611 * @param string $hook
1613 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1615 if ( $glossary->showall) {
1616 $strallentries = get_string("allentries", "glossary");
1617 if ( $hook == 'ALL' ) {
1618 echo "<b>$strallentries</b>";
1620 $strexplainall = strip_tags(get_string("explainall","glossary"));
1621 echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&mode=$mode&hook=ALL\">$strallentries</a>";
1629 * @param object $glossary
1630 * @param string $mode
1631 * @param string $hook
1633 function glossary_print_special_links($cm, $glossary, $mode, $hook) {
1635 if ( $glossary->showspecial) {
1636 $strspecial = get_string("special", "glossary");
1637 if ( $hook == 'SPECIAL' ) {
1638 echo "<b>$strspecial</b> | ";
1640 $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1641 echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&mode=$mode&hook=SPECIAL\">$strspecial</a> | ";
1648 * @param object $glossary
1649 * @param string $mode
1650 * @param string $hook
1651 * @param string $sortkey
1652 * @param string $sortorder
1654 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1656 if ( $glossary->showalphabet) {
1657 $alphabet = explode(",", get_string('alphabet', 'langconfig'));
1658 for ($i = 0; $i < count($alphabet); $i++) {
1659 if ( $hook == $alphabet[$i] and $hook) {
1660 echo "<b>$alphabet[$i]</b>";
1662 echo "<a href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&mode=$mode&hook=".urlencode($alphabet[$i])."&sortkey=$sortkey&sortorder=$sortorder\">$alphabet[$i]</a>";
1672 * @param string $mode
1673 * @param string $sortkey
1674 * @param string $sortorder
1676 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
1677 global $CFG, $OUTPUT;
1679 $asc = get_string("ascending","glossary");
1680 $desc = get_string("descending","glossary");
1688 if ( $sortorder == 'asc' ) {
1689 $currentorder = $asc;
1690 $neworder = '&sortorder=desc';
1691 $newordertitle = get_string('changeto', 'glossary', $desc);
1693 $currentorder = $desc;
1694 $neworder = '&sortorder=asc';
1695 $newordertitle = get_string('changeto', 'glossary', $asc);
1697 $icon = " <img src=\"".$OUTPUT->pix_url($sortorder, 'glossary')."\" class=\"icon\" alt=\"$newordertitle\" />";
1699 if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
1700 $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
1702 $newordertitle = $asc;
1704 $newordertitle = $desc;
1705 $neworder = '&sortorder=desc';
1706 $icon = ' <img src="'.$OUTPUT->pix_url('asc', 'glossary').'" class="icon" alt="'.$newordertitle.'" />';
1724 if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
1726 $fneworder = $neworder;
1727 $fordertitle = $newordertitle;
1728 $sordertitle = $asc;
1730 $fendbtag = $bclose;
1731 } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
1733 $sneworder = $neworder;
1734 $fordertitle = $asc;
1735 $sordertitle = $newordertitle;
1737 $sendbtag = $bclose;
1739 $fordertitle = $asc;
1740 $sordertitle = $asc;
1743 if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
1744 $forder = 'CREATION';
1746 $fsort = get_string("sortbycreation", "glossary");
1747 $ssort = get_string("sortbylastupdate", "glossary");
1749 $currentsort = $fsort;
1750 if ($sortkey == 'UPDATE') {
1751 $currentsort = $ssort;
1753 $sort = get_string("sortchronogically", "glossary");
1754 } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
1755 $forder = 'FIRSTNAME';
1756 $sorder = 'LASTNAME';
1757 $fsort = get_string("firstname");
1758 $ssort = get_string("lastname");
1760 $currentsort = $fsort;
1761 if ($sortkey == 'LASTNAME') {
1762 $currentsort = $ssort;
1764 $sort = get_string("sortby", "glossary");
1766 $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
1767 echo "<br />$current $sort: $sbtag<a title=\"$ssort $sordertitle\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&sortkey=$sorder$sneworder&mode=$mode\">$ssort$sicon</a>$sendbtag | ".
1768 "$fbtag<a title=\"$fsort $fordertitle\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&sortkey=$forder$fneworder&mode=$mode\">$fsort$ficon</a>$fendbtag<br />";
1773 * @param object $entry0
1774 * @param object $entry1
1775 * @return int [-1 | 0 | 1]
1777 function glossary_sort_entries ( $entry0, $entry1 ) {
1779 if ( moodle_strtolower(ltrim($entry0->concept)) < moodle_strtolower(ltrim($entry1->concept)) ) {
1781 } elseif ( moodle_strtolower(ltrim($entry0->concept)) > moodle_strtolower(ltrim($entry1->concept)) ) {
1793 * @param object $course
1794 * @param object $entry
1797 function glossary_print_entry_ratings($course, $entry) {
1799 if( !empty($entry->rating) ){
1800 echo $OUTPUT->render($entry->rating);
1809 * @param int $courseid
1810 * @param array $entries
1811 * @param int $displayformat
1813 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
1814 global $USER,$CFG, $DB;
1816 echo '<div class="boxaligncenter">';
1817 echo '<table class="glossarypopup" cellspacing="0"><tr>';
1820 foreach ( $entries as $entry ) {
1821 if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
1822 print_error('invalidid', 'glossary');
1824 if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
1825 print_error('coursemisconf');
1827 if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
1828 print_error('invalidid', 'glossary');
1831 //If displayformat is present, override glossary->displayformat
1832 if ($displayformat < 0) {
1833 $dp = $glossary->displayformat;
1835 $dp = $displayformat;
1838 //Get popupformatname
1839 $format = $DB->get_record('glossary_formats', array('name'=>$dp));
1840 $displayformat = $format->popupformatname;
1842 //Check displayformat variable and set to default if necessary
1843 if (!$displayformat) {
1844 $displayformat = 'dictionary';
1847 $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1848 $functionname = 'glossary_show_entry_'.$displayformat;
1850 if (file_exists($formatfile)) {
1851 include_once($formatfile);
1852 if (function_exists($functionname)) {
1853 $functionname($course, $cm, $glossary, $entry,'','','','');
1859 echo '</tr></table></div>';
1865 * @param array $entries
1866 * @param array $aliases
1867 * @param array $categories
1870 function glossary_generate_export_csv($entries, $aliases, $categories) {
1874 require_once($CFG->libdir . '/csvlib.class.php');
1875 $delimiter = csv_import_reader::get_delimiter('comma');
1876 $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
1877 $csvaliases = array(0 => array());
1878 $csvcategories = array(0 => array());
1882 foreach ($entries as $entry) {
1883 $thisaliasesentry = array();
1884 $thiscategoriesentry = array();
1885 $thiscsventry = array($entry->concept, nl2br($entry->definition));
1887 if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
1888 $thiscount = count($aliases[$entry->id]);
1889 if ($thiscount > $aliascount) {
1890 $aliascount = $thiscount;
1892 foreach ($aliases[$entry->id] as $alias) {
1893 $thisaliasesentry[] = trim($alias);
1896 if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
1897 $thiscount = count($categories[$entry->id]);
1898 if ($thiscount > $categorycount) {
1899 $categorycount = $thiscount;
1901 foreach ($categories[$entry->id] as $catentry) {
1902 $thiscategoriesentry[] = trim($catentry);
1905 $csventries[$entry->id] = $thiscsventry;
1906 $csvaliases[$entry->id] = $thisaliasesentry;
1907 $csvcategories[$entry->id] = $thiscategoriesentry;
1911 foreach ($csventries as $id => $row) {
1915 $aliasstr = get_string('alias', 'glossary');
1916 $categorystr = get_string('category', 'glossary');
1918 $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
1919 $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
1926 * @param object $glossary
1927 * @param string $ignored invalid parameter
1928 * @param int|string $hook
1931 function glossary_generate_export_file($glossary, $ignored = "", $hook = 0) {
1934 $co = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1936 $co .= glossary_start_tag("GLOSSARY",0,true);
1937 $co .= glossary_start_tag("INFO",1,true);
1938 $co .= glossary_full_tag("NAME",2,false,$glossary->name);
1939 $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
1940 $co .= glossary_full_tag("INTROFORMAT",2,false,$glossary->introformat);
1941 $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
1942 $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
1943 $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
1944 $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
1945 $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
1946 $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
1947 $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
1948 $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
1949 $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
1950 $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
1952 if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) {
1953 $co .= glossary_start_tag("ENTRIES",2,true);
1954 foreach ($entries as $entry) {
1955 $permissiongranted = 1;
1962 $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
1968 case GLOSSARY_SHOW_ALL_CATEGORIES:
1970 case GLOSSARY_SHOW_NOT_CATEGORISED:
1971 $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id));
1974 $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook));
1978 if ( $entry->approved and $permissiongranted ) {
1979 $co .= glossary_start_tag("ENTRY",3,true);
1980 $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
1981 $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition);
1982 $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat); // note: use old name for BC reasons
1983 $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
1984 $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
1985 $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
1986 $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
1988 if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) {
1989 $co .= glossary_start_tag("ALIASES",4,true);
1990 foreach ($aliases as $alias) {
1991 $co .= glossary_start_tag("ALIAS",5,true);
1992 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
1993 $co .= glossary_end_tag("ALIAS",5,true);
1995 $co .= glossary_end_tag("ALIASES",4,true);
1997 if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) {
1998 $co .= glossary_start_tag("CATEGORIES",4,true);
1999 foreach ($catentries as $catentry) {
2000 $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid));
2002 $co .= glossary_start_tag("CATEGORY",5,true);
2003 $co .= glossary_full_tag("NAME",6,false,$category->name);
2004 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
2005 $co .= glossary_end_tag("CATEGORY",5,true);
2007 $co .= glossary_end_tag("CATEGORIES",4,true);
2010 $co .= glossary_end_tag("ENTRY",3,true);
2013 $co .= glossary_end_tag("ENTRIES",2,true);
2018 $co .= glossary_end_tag("INFO",1,true);
2019 $co .= glossary_end_tag("GLOSSARY",0,true);
2023 /// Functions designed by Eloy Lafuente
2024 /// Functions to create, open and write header of the xml file
2027 * Read import file and convert to current charset
2030 * @param string $file
2033 function glossary_read_imported_file($file_content) {
2034 require_once "../../lib/xmlize.php";
2037 return xmlize($file_content, 0);
2041 * Return the xml start tag
2043 * @param string $tag
2045 * @param bool $endline
2048 function glossary_start_tag($tag,$level=0,$endline=false) {
2054 return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
2058 * Return the xml end tag
2059 * @param string $tag
2061 * @param bool $endline
2064 function glossary_end_tag($tag,$level=0,$endline=true) {
2070 return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
2074 * Return the start tag, the contents and the end tag
2077 * @param string $tag
2079 * @param bool $endline
2080 * @param string $content
2083 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
2086 $st = glossary_start_tag($tag,$level,$endline);
2087 $co = preg_replace("/\r\n|\r/", "\n", s($content));
2088 $et = glossary_end_tag($tag,0,true);
2093 * How many unrated entries are in the given glossary for a given user?
2096 * @param int $glossaryid
2097 * @param int $userid
2100 function glossary_count_unrated_entries($glossaryid, $userid) {
2102 if ($entries = $DB->get_record_sql("SELECT count('x') as num
2103 FROM {glossary_entries}
2104 WHERE glossaryid = ? AND userid <> ?", array($glossaryid, $userid))) {
2106 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2109 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2111 if ($rated = $DB->get_record_sql("SELECT count(*) as num
2112 FROM {glossary_entries} e, {ratings} r
2113 WHERE e.glossaryid = :glossaryid AND e.id = r.itemid
2114 AND r.userid = :userid and r.contextid = :contextid",
2115 array('glossaryid'=>$glossaryid, 'userid'=>$userid, 'contextid'=>$context->id))) {
2117 $difference = $entries->num - $rated->num;
2118 if ($difference > 0) {
2121 return 0; // Just in case there was a counting error
2124 return $entries->num;
2133 * Returns the html code to represent any pagging bar. Paramenters are:
2135 * The function dinamically show the first and last pages, and "scroll" over pages.
2136 * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
2137 * could replace the general one. ;-)
2139 * @param int $totalcount total number of records to be displayed
2140 * @param int $page page currently selected (0 based)
2141 * @param int $perpage number of records per page
2142 * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically.
2144 * @param int $maxpageallowed Optional maximum number of page allowed.
2145 * @param int $maxdisplay Optional maximum number of page links to show in the bar
2146 * @param string $separator Optional string to be used between pages in the bar
2147 * @param string $specialtext Optional string to be showed as an special link
2148 * @param string $specialvalue Optional value (page) to be used in the special link
2149 * @param bool $previousandnext Optional to decide if we want the previous and next links
2152 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator=" ", $specialtext="", $specialvalue=-1, $previousandnext = true) {
2156 $showspecial = false;
2157 $specialselected = false;
2159 //Check if we have to show the special link
2160 if (!empty($specialtext)) {
2161 $showspecial = true;
2163 //Check if we are with the special link selected
2164 if ($showspecial && $page == $specialvalue) {
2165 $specialselected = true;
2168 //If there are results (more than 1 page)
2169 if ($totalcount > $perpage) {
2170 $code .= "<div style=\"text-align:center\">";
2171 $code .= "<p>".get_string("page").":";
2173 $maxpage = (int)(($totalcount-1)/$perpage);
2175 //Lower and upper limit of page
2179 if ($page > $maxpageallowed) {
2180 $page = $maxpageallowed;
2182 if ($page > $maxpage) {
2186 //Calculate the window of pages
2187 $pagefrom = $page - ((int)($maxdisplay / 2));
2188 if ($pagefrom < 0) {
2191 $pageto = $pagefrom + $maxdisplay - 1;
2192 if ($pageto > $maxpageallowed) {
2193 $pageto = $maxpageallowed;
2195 if ($pageto > $maxpage) {
2199 //Some movements can be necessary if don't see enought pages
2200 if ($pageto - $pagefrom < $maxdisplay - 1) {
2201 if ($pageto - $maxdisplay + 1 > 0) {
2202 $pagefrom = $pageto - $maxdisplay + 1;
2206 //Calculate first and last if necessary
2207 $firstpagecode = '';
2209 if ($pagefrom > 0) {
2210 $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2211 if ($pagefrom > 1) {
2212 $firstpagecode .= "$separator...";
2215 if ($pageto < $maxpage) {
2216 if ($pageto < $maxpage -1) {
2217 $lastpagecode = "$separator...";
2219 $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2223 if ($page > 0 && $previousandnext) {
2224 $pagenum = $page - 1;
2225 $code .= " (<a href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>) ";
2229 $code .= $firstpagecode;
2231 $pagenum = $pagefrom;
2233 //List of maxdisplay pages
2234 while ($pagenum <= $pageto) {
2235 $pagetoshow = $pagenum +1;
2236 if ($pagenum == $page && !$specialselected) {
2237 $code .= "$separator<b>$pagetoshow</b>";
2239 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2245 $code .= $lastpagecode;
2248 if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2249 $pagenum = $page + 1;
2250 $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2256 if ($specialselected) {
2257 $code .= "<b>$specialtext</b>";
2259 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2273 function glossary_get_view_actions() {
2274 return array('view','view all','view entry');
2279 function glossary_get_post_actions() {
2280 return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry');
2285 * Implementation of the function for printing the form elements that control
2286 * whether the course reset functionality affects the glossary.
2287 * @param object $mform form passed by reference
2289 function glossary_reset_course_form_definition(&$mform) {
2290 $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary'));
2291 $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary'));
2293 $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'),
2294 array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple'));
2295 $mform->setAdvanced('reset_glossary_types');
2296 $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked');
2298 $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary'));
2299 $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked');
2301 $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings'));
2302 $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked');
2304 $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments'));
2305 $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked');
2309 * Course reset form defaults.
2312 function glossary_reset_course_form_defaults($course) {
2313 return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0);
2317 * Removes all grades from gradebook
2320 * @param int $courseid
2321 * @param string optional type
2323 function glossary_reset_gradebook($courseid, $type='') {
2327 case 'main' : $type = "AND g.mainglossary=1"; break;
2328 case 'secondary' : $type = "AND g.mainglossary=0"; break;
2329 default : $type = ""; //all
2332 $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid
2333 FROM {glossary} g, {course_modules} cm, {modules} m
2334 WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type";
2336 if ($glossarys = $DB->get_records_sql($sql, array($courseid))) {
2337 foreach ($glossarys as $glossary) {
2338 glossary_grade_item_update($glossary, 'reset');
2343 * Actual implementation of the reset course functionality, delete all the
2344 * glossary responses for course $data->courseid.
2347 * @param $data the data submitted from the reset course.
2348 * @return array status array
2350 function glossary_reset_userdata($data) {
2352 require_once($CFG->dirroot.'/rating/lib.php');
2354 $componentstr = get_string('modulenameplural', 'glossary');
2357 $allentriessql = "SELECT e.id
2358 FROM {glossary_entries} e
2359 JOIN {glossary} g ON e.glossaryid = g.id
2360 WHERE g.course = ?";
2362 $allglossariessql = "SELECT g.id
2364 WHERE g.course = ?";
2366 $params = array($data->courseid);
2368 $fs = get_file_storage();
2370 $rm = new rating_manager();
2371 $ratingdeloptions = new stdclass();
2373 // delete entries if requested
2374 if (!empty($data->reset_glossary_all)
2375 or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) {
2377 $params[] = 'glossary_entry';
2378 $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea=?", $params);
2379 $DB->delete_records_select('glossary_alias', "entryid IN ($allentriessql)", $params);
2380 $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2382 // now get rid of all attachments
2383 if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2384 foreach ($glossaries as $glossaryid=>$unused) {
2385 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2388 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2389 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2392 $ratingdeloptions->contextid = $context->id;
2393 $rm->delete_ratings($ratingdeloptions);
2397 // remove all grades from gradebook
2398 if (empty($data->reset_gradebook_grades)) {
2399 glossary_reset_gradebook($data->courseid);
2402 $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2404 } else if (!empty($data->reset_glossary_types)) {
2405 $mainentriessql = "$allentries AND g.mainglossary=1";
2406 $secondaryentriessql = "$allentries AND g.mainglossary=0";
2408 $mainglossariessql = "$allglossariessql AND g.mainglossary=1";
2409 $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2411 if (in_array('main', $data->reset_glossary_types)) {
2412 $params[] = 'glossary_entry';
2413 $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params);
2414 $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2416 if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2417 foreach ($glossaries as $glossaryid=>$unused) {
2418 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2421 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2422 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2425 $ratingdeloptions->contextid = $context->id;
2426 $rm->delete_ratings($ratingdeloptions);
2430 // remove all grades from gradebook
2431 if (empty($data->reset_gradebook_grades)) {
2432 glossary_reset_gradebook($data->courseid, 'main');
2435 $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary'), 'error'=>false);
2437 } else if (in_array('secondary', $data->reset_glossary_types)) {
2438 $params[] = 'glossary_entry';
2439 $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params);
2440 $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2441 // remove exported source flag from entries in main glossary
2442 $DB->execute("UPDATE {glossary_entries
2443 SET sourceglossaryid=0
2444 WHERE glossaryid IN ($mainglossariessql)", $params);
2446 if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2447 foreach ($glossaries as $glossaryid=>$unused) {
2448 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2451 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2452 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2455 $ratingdeloptions->contextid = $context->id;
2456 $rm->delete_ratings($ratingdeloptions);
2460 // remove all grades from gradebook
2461 if (empty($data->reset_gradebook_grades)) {
2462 glossary_reset_gradebook($data->courseid, 'secondary');
2465 $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2469 // remove entries by users not enrolled into course
2470 if (!empty($data->reset_glossary_notenrolled)) {
2471 $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2472 FROM {glossary_entries} e
2473 JOIN {glossary} g ON e.glossaryid = g.id
2474 LEFT JOIN {user} u ON e.userid = u.id
2475 WHERE g.course = ? AND e.userid > 0";
2477 $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2478 $notenrolled = array();
2479 if ($rs = $DB->get_recordset_sql($entriessql, $params)) {
2480 foreach ($rs as $entry) {
2481 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2482 or !is_enrolled($course_context , $entry->userid)) {
2483 $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id));
2484 $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2486 if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2487 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2488 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
2491 $ratingdeloptions->contextid = $context->id;
2492 $rm->delete_ratings($ratingdeloptions);
2497 $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2501 // remove all ratings
2502 if (!empty($data->reset_glossary_ratings)) {
2504 if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2505 foreach ($glossaries as $glossaryid=>$unused) {
2506 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2509 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2512 $ratingdeloptions->contextid = $context->id;
2513 $rm->delete_ratings($ratingdeloptions);
2517 // remove all grades from gradebook
2518 if (empty($data->reset_gradebook_grades)) {
2519 glossary_reset_gradebook($data->courseid);
2521 $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2525 if (!empty($data->reset_glossary_comments)) {
2526 $params[] = 'glossary_entry';
2527 $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params);
2528 $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2531 /// updating dates - shift may be negative too
2532 if ($data->timeshift) {
2533 shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
2534 $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2541 * Returns all other caps used in module
2544 function glossary_get_extra_capabilities() {
2545 return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames', 'moodle/site:trustcontent', 'moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate', 'moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete');
2549 * @param string $feature FEATURE_xx constant for requested feature
2550 * @return mixed True if module supports feature, null if doesn't know
2552 function glossary_supports($feature) {
2554 case FEATURE_GROUPS: return false;
2555 case FEATURE_GROUPINGS: return false;
2556 case FEATURE_GROUPMEMBERSONLY: return true;
2557 case FEATURE_MOD_INTRO: return true;
2558 case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2559 case FEATURE_GRADE_HAS_GRADE: return true;
2560 case FEATURE_GRADE_OUTCOMES: return true;
2561 case FEATURE_RATE: return true;
2562 case FEATURE_BACKUP_MOODLE2: return true;
2564 default: return null;
2568 function glossary_extend_navigation($navigation, $course, $module, $cm) {
2570 $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'letter')));
2571 $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'cat')));
2572 $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'date')));
2573 $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'author')));
2577 * Adds module specific settings to the settings block
2579 * @param settings_navigation $settings The settings navigation object
2580 * @param navigation_node $glossarynode The node to add module settings to
2582 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
2583 global $PAGE, $DB, $CFG, $USER;
2585 $mode = optional_param('mode', '', PARAM_ALPHA);
2586 $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
2588 if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
2589 $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
2592 if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
2593 $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
2596 if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
2597 $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
2600 if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
2601 $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
2604 $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
2606 if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles) {
2607 require_once("$CFG->libdir/rsslib.php");
2609 $string = get_string('rsstype','forum');
2611 $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_glossary', $glossary->id));
2612 $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));