c3247f0d8fbbeed13126e9ebc6ff69e8be250464
[moodle.git] / mod / glossary / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of functions and constants for module glossary
20  * (replace glossary with the name of your module and delete this line)
21  *
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
25  */
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 ///////////////////////////////////////////////////////////
42 /**
43  * @global object
44  * @param object $glossary
45  * @return int
46  */
47 function glossary_add_instance($glossary) {
48     global $DB;
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;
57     }
59     if (empty($glossary->globalglossary) ) {
60         $glossary->globalglossary = 0;
61     }
63     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
64         $glossary->globalglossary = 0;
65     }
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);
74     }
76     $returnid = $DB->insert_record("glossary", $glossary);
77     $glossary->id = $returnid;
78     glossary_grade_item_update($glossary);
80     return $returnid;
81 }
83 /**
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.
87  *
88  * @global object
89  * @global object
90  * @param object $glossary
91  * @return bool
92  */
93 function glossary_update_instance($glossary) {
94     global $CFG, $DB;
96     if (empty($glossary->globalglossary)) {
97         $glossary->globalglossary = 0;
98     }
100     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
101         // keep previous
102         unset($glossary->globalglossary);
103     }
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;
111     }
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);
117     }
119     $return = $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));
122     }
123     glossary_grade_item_update($glossary);
125     return $return;
128 /**
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.
132  *
133  * @global object
134  * @param int $id glossary id
135  * @return bool success
136  */
137 function glossary_delete_instance($id) {
138     global $DB, $CFG;
140     if (!$glossary = $DB->get_record('glossary', array('id'=>$id))) {
141         return false;
142     }
144     if (!$cm = get_coursemodule_from_instance('glossary', $id)) {
145         return false;
146     }
148     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
149         return false;
150     }
152     $fs = get_file_storage();
154     if ($glossary->mainglossary) {
155         // unexport entries
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);
172                     }
173                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
174                     $entry->attachment = '1';
175                 } else {
176                     $entry->attachment = '0';
177                 }
178                 $DB->update_record('glossary_entries', $entry);
179             }
180         }
181     } else {
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));
187     }
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));
198     // Delete comments
199     require_once($CFG->dirroot.'/comment/lib.php');
200     comment::delete_comments(array('contextid'=>$context->id));
202     // delete all files
203     $fs->delete_area_files($context->id);
205     //delete ratings
206     $rm = new rating_manager();
207     $ratingdeloptions = new stdclass();
208     $ratingdeloptions->contextid = $context->id;
209     $rm->delete_ratings($ratingdeloptions);
211     glossary_grade_item_delete($glossary);
213     return $DB->delete_records('glossary', array('id'=>$id));
216 /**
217  * Return a small object with summary information about what a
218  * user has done with a given particular instance of this module
219  * Used for user activity reports.
220  * $return->time = the time they did it
221  * $return->info = a short text description
222  *
223  * @param object $course
224  * @param object $user
225  * @param object $mod
226  * @param object $glossary
227  * @return object|null
228  */
229 function glossary_user_outline($course, $user, $mod, $glossary) {
230     global $CFG;
232     require_once("$CFG->libdir/gradelib.php");
233     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
234     if (empty($grades->items[0]->grades)) {
235         $grade = false;
236     } else {
237         $grade = reset($grades->items[0]->grades);
238     }
240     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
241         $result = new object();
242         $result->info = count($entries) . ' ' . get_string("entries", "glossary");
244         $lastentry = array_pop($entries);
245         $result->time = $lastentry->timemodified;
247         if ($grade) {
248             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
249         }
250         return $result;
251     } else if ($grade) {
252         $result = new object();
253         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
254         $result->time = $grade->dategraded;
255         return $result;
256     }
257     return NULL;
260 /**
261  * @global object
262  * @param int $glossaryid
263  * @param int $userid
264  * @return array
265  */
266 function glossary_get_user_entries($glossaryid, $userid) {
267 /// Get all the entries for a user in a glossary
268     global $DB;
270     return $DB->get_records_sql("SELECT e.*, u.firstname, u.lastname, u.email, u.picture
271                                    FROM {glossary} g, {glossary_entries} e, {user} u
272                              WHERE g.id = ?
273                                AND e.glossaryid = g.id
274                                AND e.userid = ?
275                                AND e.userid = u.id
276                           ORDER BY e.timemodified ASC", array($glossaryid, $userid));
279 /**
280  * Print a detailed representation of what a  user has done with
281  * a given particular instance of this module, for user activity reports.
282  *
283  * @global object
284  * @param object $course
285  * @param object $user
286  * @param object $mod
287  * @param object $glossary
288  */
289 function glossary_user_complete($course, $user, $mod, $glossary) {
290     global $CFG, $OUTPUT;
291     require_once("$CFG->libdir/gradelib.php");
293     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
294     if (!empty($grades->items[0]->grades)) {
295         $grade = reset($grades->items[0]->grades);
296         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
297         if ($grade->str_feedback) {
298             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
299         }
300     }
302     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
303         echo '<table width="95%" border="0"><tr><td>';
304         foreach ($entries as $entry) {
305             $cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id);
306             glossary_print_entry($course, $cm, $glossary, $entry,"","",0);
307             echo '<p>';
308         }
309         echo '</td></tr></table>';
310     }
312 /**
313  * Given a course and a time, this module should find recent activity
314  * that has occurred in glossary activities and print it out.
315  * Return true if there was output, or false is there was none.
316  *
317  * @global object
318  * @global object
319  * @global object
320  * @param object $course
321  * @param object $viewfullnames
322  * @param int $timestart
323  * @return bool
324  */
325 function glossary_print_recent_activity($course, $viewfullnames, $timestart) {
326     global $CFG, $USER, $DB, $OUTPUT;
328     //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0
330     $modinfo = get_fast_modinfo($course);
331     $ids = array();
332     foreach ($modinfo->cms as $cm) {
333         if ($cm->modname != 'glossary') {
334             continue;
335         }
336         if (!$cm->uservisible) {
337             continue;
338         }
339         $ids[$cm->instance] = $cm->instance;
340     }
342     if (!$ids) {
343         return false;
344     }
346     $glist = implode(',', $ids); // there should not be hundreds of glossaries in one course, right?
348     if (!$entries = $DB->get_records_sql("SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
349                                                  ge.userid, u.firstname, u.lastname, u.email, u.picture
350                                             FROM {glossary_entries} ge
351                                             JOIN {user} u ON u.id = ge.userid
352                                            WHERE ge.glossaryid IN ($glist) AND ge.timemodified > ?
353                                         ORDER BY ge.timemodified ASC", array($timestart))) {
354         return false;
355     }
357     $editor  = array();
359     foreach ($entries as $entryid=>$entry) {
360         if ($entry->approved) {
361             continue;
362         }
364         if (!isset($editor[$entry->glossaryid])) {
365             $editor[$entry->glossaryid] = has_capability('mod/glossary:approve', get_context_instance(CONTEXT_MODULE, $modinfo->instances['glossary'][$entry->glossaryid]->id));
366         }
368         if (!$editor[$entry->glossaryid]) {
369             unset($entries[$entryid]);
370         }
371     }
373     if (!$entries) {
374         return false;
375     }
376     echo $OUTPUT->heading(get_string('newentries', 'glossary').':');
378     $strftimerecent = get_string('strftimerecent');
379     foreach ($entries as $entry) {
380         $link = $CFG->wwwroot.'/mod/glossary/view.php?g='.$entry->glossaryid.'&amp;mode=entry&amp;hook='.$entry->id;
381         if ($entry->approved) {
382             $dimmed = '';
383         } else {
384             $dimmed = ' dimmed_text';
385         }
386         echo '<div class="head'.$dimmed.'">';
387         echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
388         echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
389         echo '</div>';
390         echo '<div class="info"><a href="'.$link.'">'.format_text($entry->concept, true).'</a></div>';
391     }
393     return true;
396 /**
397  * @global object
398  * @param object $log
399  */
400 function glossary_log_info($log) {
401     global $DB;
403     return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
404                                   FROM {glossary_entries} e, {user} u
405                                  WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
408 /**
409  * Function to be run periodically according to the moodle cron
410  * This function searches for things that need to be done, such
411  * as sending out mail, toggling flags etc ...
412  * @return bool
413  */
414 function glossary_cron () {
415     return true;
418 /**
419  * Return grade for given user or all users.
420  *
421  * @global object
422  * @param int $glossaryid id of glossary
423  * @param int $userid optional user id, 0 means all users
424  * @return array array of grades, false if none
425  */
426 function glossary_get_user_grades($glossary, $userid=0) {
427     /*global $DB;
429     $params = array('userid'=>$userid, 'gid'=>$glossary->id);
431     $user = $userid ? "AND u.id = :userid" : "";
433     $sql = "SELECT u.id, u.id AS userid, avg(gr.rating) AS rawgrade
434               FROM {user} u, {glossary_entries} ge, {glossary_ratings} gr
435              WHERE u.id = ge.userid AND ge.id = gr.entryid
436                    AND gr.userid != u.id AND ge.glossaryid = :gid
437                    $user
438           GROUP BY u.id";
440     return $DB->get_records_sql($sql, $params);*/
441     global $CFG;
443     require_once($CFG->dirroot.'/rating/lib.php');
444     $rm = new rating_manager();
446     $ratingoptions = new stdclass();
448     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
449     $ratingoptions->modulename = 'glossary';
450     $ratingoptions->moduleid   = $glossary->id;
452     $ratingoptions->userid = $userid;
453     $ratingoptions->aggregationmethod = $glossary->assessed;
454     $ratingoptions->scaleid = $glossary->scale;
455     $ratingoptions->itemtable = 'glossary_entries';
456     $ratingoptions->itemtableusercolumn = 'userid';
458     return $rm->get_user_grades($ratingoptions);
461 /**
462  * Return rating related permissions
463  * @param string $options the context id
464  * @return array an associative array of the user's rating permissions
465  */
466 function glossary_rating_permissions($options) {
467     $contextid = $options;
468     $context = get_context_instance_by_id($contextid);
470     if (!$context) {
471         print_error('invalidcontext');
472         return null;
473     } else {
474         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     }
478 /**
479  * Returns the names of the table and columns necessary to check items for ratings
480  * @return array an array containing the item table, item id and user id columns
481  */
482 function glossary_rating_item_check_info() {
483     return array('glossary_entries','id','userid');
486 /**
487  * Update activity grades
488  *
489  * @global object
490  * @global object
491  * @param object $glossary null means all glossaries (with extra cmidnumber property)
492  * @param int $userid specific user only, 0 means all
493  */
494 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
495     global $CFG, $DB;
496     require_once($CFG->libdir.'/gradelib.php');
498     if (!$glossary->assessed) {
499         glossary_grade_item_update($glossary);
501     } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
502         glossary_grade_item_update($glossary, $grades);
504     } else if ($userid and $nullifnone) {
505         $grade = new object();
506         $grade->userid   = $userid;
507         $grade->rawgrade = NULL;
508         glossary_grade_item_update($glossary, $grade);
510     } else {
511         glossary_grade_item_update($glossary);
512     }
515 /**
516  * Update all grades in gradebook.
517  *
518  * @global object
519  */
520 function glossary_upgrade_grades() {
521     global $DB;
523     $sql = "SELECT COUNT('x')
524               FROM {glossary} g, {course_modules} cm, {modules} m
525              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
526     $count = $DB->count_records_sql($sql);
528     $sql = "SELECT g.*, cm.idnumber AS cmidnumber, g.course AS courseid
529               FROM {glossary} g, {course_modules} cm, {modules} m
530              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
531     if ($rs = $DB->get_recordset_sql($sql)) {
532         $pbar = new progress_bar('glossaryupgradegrades', 500, true);
533         $i=0;
534         foreach ($rs as $glossary) {
535             $i++;
536             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
537             glossary_update_grades($glossary, 0, false);
538             $pbar->update($i, $count, "Updating Glossary grades ($i/$count).");
539         }
540         $rs->close();
541     }
544 /**
545  * Create/update grade item for given glossary
546  *
547  * @global object
548  * @param object $glossary object with extra cmidnumber
549  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
550  * @return int, 0 if ok, error code otherwise
551  */
552 function glossary_grade_item_update($glossary, $grades=NULL) {
553     global $CFG;
554     require_once($CFG->libdir.'/gradelib.php');
556     $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
558     if (!$glossary->assessed or $glossary->scale == 0) {
559         $params['gradetype'] = GRADE_TYPE_NONE;
561     } else if ($glossary->scale > 0) {
562         $params['gradetype'] = GRADE_TYPE_VALUE;
563         $params['grademax']  = $glossary->scale;
564         $params['grademin']  = 0;
566     } else if ($glossary->scale < 0) {
567         $params['gradetype'] = GRADE_TYPE_SCALE;
568         $params['scaleid']   = -$glossary->scale;
569     }
571     if ($grades  === 'reset') {
572         $params['reset'] = true;
573         $grades = NULL;
574     }
576     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
579 /**
580  * Delete grade item for given glossary
581  *
582  * @global object
583  * @param object $glossary object
584  */
585 function glossary_grade_item_delete($glossary) {
586     global $CFG;
587     require_once($CFG->libdir.'/gradelib.php');
589     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
592 /**
593  * Returns the users with data in one glossary
594  * (users with records in glossary_entries, students)
595  *
596  * @global object
597  * @param int $glossaryid
598  * @return array
599  */
600 function glossary_get_participants($glossaryid) {
601     global $DB;
603     //Get students
604     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
605                                         FROM {user} u, {glossary_entries} g
606                                  WHERE g.glossaryid = ? AND u.id = g.userid", array($glossaryid));
608     //Return students array (it contains an array of unique users)
609     return $students;
612 /**
613  * @global object
614  * @param int $gloassryid
615  * @param int $scaleid
616  * @return bool
617  */
618 function glossary_scale_used ($glossaryid,$scaleid) {
619 //This function returns if a scale is being used by one glossary
620     global $DB;
622     $return = false;
624     $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
626     if (!empty($rec)  && !empty($scaleid)) {
627         $return = true;
628     }
630     return $return;
633 /**
634  * Checks if scale is being used by any instance of glossary
635  *
636  * This is used to find out if scale used anywhere
637  *
638  * @global object
639  * @param int $scaleid
640  * @return boolean True if the scale is used by any glossary
641  */
642 function glossary_scale_used_anywhere($scaleid) {
643     global $DB;
645     if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
646         return true;
647     } else {
648         return false;
649     }
652 //////////////////////////////////////////////////////////////////////////////////////
653 /// Any other glossary functions go here.  Each of them must have a name that
654 /// starts with glossary_
656 /**
657  * This function return an array of valid glossary_formats records
658  * Everytime it's called, every existing format is checked, new formats
659  * are included if detected and old formats are deleted and any glossary
660  * using an invalid format is updated to the default (dictionary).
661  *
662  * @global object
663  * @global object
664  * @return array
665  */
666 function glossary_get_available_formats() {
667     global $CFG, $DB;
669     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
670     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
671     $pluginformats = array();
672     foreach ($formats as $format) {
673         //If the format file exists
674         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
675             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
676             //If the function exists
677             if (function_exists('glossary_show_entry_'.$format)) {
678                 //Acummulate it as a valid format
679                 $pluginformats[] = $format;
680                 //If the format doesn't exist in the table
681                 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
682                     //Insert the record in glossary_formats
683                     $gf = new object();
684                     $gf->name = $format;
685                     $gf->popupformatname = $format;
686                     $gf->visible = 1;
687                     $DB->insert_record("glossary_formats",$gf);
688                 }
689             }
690         }
691     }
693     //Delete non_existent formats from glossary_formats table
694     $formats = $DB->get_records("glossary_formats");
695     foreach ($formats as $format) {
696         $todelete = false;
697         //If the format in DB isn't a valid previously detected format then delete the record
698         if (!in_array($format->name,$pluginformats)) {
699             $todelete = true;
700         }
702         if ($todelete) {
703             //Delete the format
704             $DB->delete_records('glossary_formats', array('name'=>$format->name));
705             //Reasign existing glossaries to default (dictionary) format
706             if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
707                 foreach($glossaries as $glossary) {
708                     $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
709                 }
710             }
711         }
712     }
714     //Now everything is ready in glossary_formats table
715     $formats = $DB->get_records("glossary_formats");
717     return $formats;
720 /**
721  * @param bool $debug
722  * @param string $text
723  * @param int $br
724  */
725 function glossary_debug($debug,$text,$br=1) {
726     if ( $debug ) {
727         echo '<font color="red">' . $text . '</font>';
728         if ( $br ) {
729             echo '<br />';
730         }
731     }
734 /**
735  *
736  * @global object
737  * @param int $glossaryid
738  * @param string $entrylist
739  * @param string $pivot
740  * @return array
741  */
742 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
743     global $DB;
744     if ($pivot) {
745        $pivot .= ",";
746     }
748     return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
749                                    FROM {glossary_entries}
750                                   WHERE glossaryid = ?
751                                         AND id IN ($entrylist)", array($glossaryid));
754 /**
755  * @global object
756  * @global object
757  * @param object $concept
758  * @param string $courseid
759  * @return array
760  */
761 function glossary_get_entries_search($concept, $courseid) {
762     global $CFG, $DB;
764     //Check if the user is an admin
765     $bypassadmin = 1; //This means NO (by default)
766     if (has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_SYSTEM))) {
767         $bypassadmin = 0; //This means YES
768     }
770     //Check if the user is a teacher
771     $bypassteacher = 1; //This means NO (by default)
772     if (has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $courseid))) {
773         $bypassteacher = 0; //This means YES
774     }
776     $conceptlower = moodle_strtolower(trim($concept));
778     $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
780     return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
781                                    FROM {glossary_entries} e, {glossary} g,
782                                         {course_modules} cm, {modules} m
783                                   WHERE m.name = 'glossary' AND
784                                         cm.module = m.id AND
785                                         (cm.visible = 1 OR  cm.visible = $bypassadmin OR
786                                             (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
787                                         g.id = cm.instance AND
788                                         e.glossaryid = g.id  AND
789                                         ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
790                                           (e.casesensitive = 0 and concept = :concept)) AND
791                                         (g.course = :courseid2 OR g.globalglossary = 1) AND
792                                          e.usedynalink != 0 AND
793                                          g.usedynalink != 0", $params);
796 /**
797  * @global object
798  * @global object
799  * @param object $course
800  * @param object $course
801  * @param object $glossary
802  * @param object $entry
803  * @param string $mode
804  * @param string $hook
805  * @param int $printicons
806  * @param int $displayformat
807  * @param bool $printview
808  * @return mixed
809  */
810 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $printview = false) {
811     global $USER, $CFG;
812     $return = false;
813     if ( $displayformat < 0 ) {
814         $displayformat = $glossary->displayformat;
815     }
816     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
817         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
818         if ($printview) {
819             $functionname = 'glossary_print_entry_'.$displayformat;
820         } else {
821             $functionname = 'glossary_show_entry_'.$displayformat;
822         }
824         if (file_exists($formatfile)) {
825             include_once($formatfile);
826             if (function_exists($functionname)) {
827                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
828             } else if ($printview) {
829                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
830                 $return = glossary_print_entry_default($entry, $glossary, $cm);
831             }
832         }
833     }
834     return $return;
837 /**
838  * Default (old) print format used if custom function doesn't exist in format
839  *
840  * @param object $entry
841  * @param object $glossary
842  * @param object $cm
843  * @return void Output is echo'd
844  */
845 function glossary_print_entry_default ($entry, $glossary, $cm) {
846     echo '<h3>'. strip_tags($entry->concept) . ': </h3>';
848     $definition = $entry->definition;
850     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
852     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
853     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
855     $options = new object();
856     $options->para = false;
857     $options->trusted = $entry->definitiontrust;
858     $definition = format_text($definition, $entry->definitionformat, $options);
859     echo ($definition);
860     echo '<br /><br />';
863 /**
864  * Print glossary concept/term as a heading &lt;h3>
865  * @param object $entry
866  */
867 function  glossary_print_entry_concept($entry, $return=false) {
868     global $OUTPUT;
869     $options = new object();
870     $options->para = false;
871     $text = format_text($OUTPUT->heading('<span class="nolink">' . $entry->concept . '</span>', 3, 'nolink'), FORMAT_MOODLE, $options);
872     if (!empty($entry->highlight)) {
873         $text = highlight($entry->highlight, $text);
874     }
876     if ($return) {
877         return $text;
878     } else {
879         echo $text;
880     }
883 /**
884  *
885  * @global object
886  * @global array
887  * @param object $entry
888  * @param object $glossary
889  * @param object $cm
890  */
891 function glossary_print_entry_definition($entry, $glossary, $cm) {
892     global $DB;
894     $definition = $entry->definition;
896     global $GLOSSARY_EXCLUDECONCEPTS;
898     //Calculate all the strings to be no-linked
899     //First, the concept
900     $GLOSSARY_EXCLUDECONCEPTS=array($entry->concept);
901     //Now the aliases
902     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
903         foreach ($aliases as $alias) {
904             $GLOSSARY_EXCLUDECONCEPTS[]=trim($alias->alias);
905         }
906     }
908     $options = new object();
909     $options->para = false;
910     $options->trusted = $entry->definitiontrust;
912     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
913     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
915     $text = format_text($definition, $entry->definitionformat, $options);
917     // Stop excluding concepts from autolinking
918     unset($GLOSSARY_EXCLUDECONCEPTS);
920     if (!empty($entry->highlight)) {
921         $text = highlight($entry->highlight, $text);
922     }
923     if (isset($entry->footer)) {   // Unparsed footer info
924         $text .= $entry->footer;
925     }
926     echo $text;
929 /**
930  *
931  * @global object
932  * @param object $course
933  * @param object $cm
934  * @param object $glossary
935  * @param object $entry
936  * @param string $mode
937  * @param string $hook
938  * @param string $type
939  * @return string|void
940  */
941 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
942     global $DB;
944     $return = '';
945     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
946         foreach ($aliases as $alias) {
947             if (trim($alias->alias)) {
948                 if ($return == '') {
949                     $return = '<select style="font-size:8pt">';
950                 }
951                 $return .= "<option>$alias->alias</option>";
952             }
953         }
954         if ($return != '') {
955             $return .= '</select>';
956         }
957     }
958     if ($type == 'print') {
959         echo $return;
960     } else {
961         return $return;
962     }
965 /**
966  *
967  * @global object
968  * @global object
969  * @global object
970  * @param object $course
971  * @param object $cm
972  * @param object $glossary
973  * @param object $entry
974  * @param string $mode
975  * @param string $hook
976  * @param string $type
977  * @return string|void
978  */
979 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
980     global $USER, $CFG, $DB, $OUTPUT;
982     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
984     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
985     $importedentry = ($entry->sourceglossaryid == $glossary->id);
986     $ismainglossary = $glossary->mainglossary;
989     $return = '<span class="commands">';
990     // Differentiate links for each entry.
991     $altsuffix = ': '.strip_tags(format_text($entry->concept));
993     if (!$entry->approved) {
994         $output = true;
995         $return .= get_string('entryishidden','glossary');
996     }
998     if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $entry->userid == $USER->id)) {
999         // only teachers can export entries so check it out
1000         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
1001             $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
1002             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
1003                 $output = true;
1004                 $return .= ' <a title="'.get_string('exporttomainglossary','glossary') . '" href="exportentry.php?id='.$entry->id.'&amp;prevmode='.$mode.'&amp;hook='.urlencode($hook).'"><img src="'.$OUTPUT->pix_url('export', 'glossary').'" class="iconsmall" alt="'.get_string('exporttomainglossary','glossary').$altsuffix.'" /></a>';
1005             }
1006         }
1008         if ( $entry->sourceglossaryid ) {
1009             $icon = $OUTPUT->pix_url('minus', 'glossary');   // graphical metaphor (minus) for deleting an imported entry
1010         } else {
1011             $icon = $OUTPUT->pix_url('t/delete');
1012         }
1014         //Decide if an entry is editable:
1015         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
1016         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1017         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
1018         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1019             $output = true;
1020             $return .= " <a title=\"" . get_string("delete") . "\" href=\"deleteentry.php?id=$cm->id&amp;mode=delete&amp;entry=$entry->id&amp;prevmode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"";
1021             $return .= $icon;
1022             $return .= "\" class=\"iconsmall\" alt=\"" . get_string("delete") .$altsuffix."\" /></a> ";
1024             $return .= " <a title=\"" . get_string("edit") . "\" href=\"edit.php?cmid=$cm->id&amp;id=$entry->id&amp;mode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"" . $OUTPUT->pix_url('t/edit') . "\" class=\"iconsmall\" alt=\"" . get_string("edit") .$altsuffix. "\" /></a>";
1025         } elseif ( $importedentry ) {
1026             $return .= " <font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1027         }
1028     }
1029     if (has_capability('mod/glossary:exportentry', $context)
1030         || ($entry->userid == $USER->id
1031             && has_capability('mod/glossary:exportownentry', $context))) {
1032         require_once($CFG->libdir . '/portfoliolib.php');
1033         $button = new portfolio_add_button();
1034         $button->set_callback_options('glossary_entry_portfolio_caller',  array('id' => $cm->id, 'entryid' => $entry->id), '/mod/glossary/locallib.php');
1036         $filecontext = $context;
1037         if ($entry->sourceglossaryid == $cm->instance) {
1038             if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1039                 $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1040             }
1041         }
1042         $fs = get_file_storage();
1043         if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1044             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1045         } else {
1046             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1047         }
1049         $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1050     }
1051     $return .= "&nbsp;&nbsp;"; // just to make up a little the output in Mozilla ;)
1053     $return .= '</span>';
1055     if (has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1056         $output = true;
1057         if (!empty($CFG->usecomments)) {
1058             require_once($CFG->dirroot . '/comment/lib.php');
1059             $cmt = new stdclass;
1060             $cmt->pluginname = 'glossary';
1061             $cmt->context  = $context;
1062             $cmt->course   = $course;
1063             $cmt->cm       = $cm;
1064             $cmt->area     = 'glossary_entry';
1065             $cmt->itemid   = $entry->id;
1066             $cmt->showcount = true;
1067             $comment = new comment($cmt);
1068             $return .= '<div>'.$comment->output(true).'</div>';
1069         }
1070     }
1072     //If we haven't calculated any REAL thing, delete result ($return)
1073     if (!$output) {
1074         $return = '';
1075     }
1076     //Print or get
1077     if ($type == 'print') {
1078         echo $return;
1079     } else {
1080         return $return;
1081     }
1084 /**
1085  * @param object $course
1086  * @param object $cm
1087  * @param object $glossary
1088  * @param object $entry
1089  * @param string $mode
1090  * @param object $hook
1091  * @param bool $printicons
1092  * @param bool $aliases
1093  * @return void
1094  */
1095 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1096     if ($aliases) {
1097         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1098     }
1099     $icons   = '';
1100     if ($printicons) {
1101         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1102     }
1103     if ($aliases || $icons || !empty($entry->rating)) {
1104         echo '<table>';
1105         if ( $aliases ) {
1106             echo '<tr valign="top"><td class="aliases">' .
1107                   get_string('aliases','glossary').': '.$aliases . '</td></tr>';
1108         }
1109         if ($icons) {
1110             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1111         }
1112         if (!empty($entry->rating)) {
1113             echo '<tr valign="top"><td class="ratings">';
1114             glossary_print_entry_ratings($course, $entry);
1115             echo '</td></tr>';
1116         }
1117         echo '</table>';
1118     }
1121 /**
1122  * @todo Document this function
1123  */
1124 function glossary_print_entry_attachment($entry, $cm, $format=NULL, $align="right", $insidetable=true) {
1125 ///   valid format values: html  : Return the HTML link for the attachment as an icon
1126 ///                        text  : Return the HTML link for tha attachment as text
1127 ///                        blank : Print the output to the screen
1128     if ($entry->attachment) {
1129           if ($insidetable) {
1130               echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
1131           }
1132           echo glossary_print_attachments($entry, $cm, $format, $align);
1133           if ($insidetable) {
1134               echo "</td></tr></table>\n";
1135           }
1136     }
1139 /**
1140  * @global object
1141  * @param object $cm
1142  * @param object $entry
1143  * @param string $mode
1144  * @param string $align
1145  * @param bool $insidetable
1146  */
1147 function  glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1148     global $CFG, $OUTPUT;
1150     if ($mode == 'approval' and !$entry->approved) {
1151         if ($insidetable) {
1152             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1153         }
1154         echo '<a title="'.get_string('approve','glossary').'" href="approve.php?eid='.$entry->id.'&amp;mode='.$mode.'&amp;sesskey='.sesskey().'"><img align="'.$align.'" src="'.$OUTPUT->pix_url('i/approve') . '" style="border:0px; width:34px; height:34px" alt="'.get_string('approve','glossary').'" /></a>';
1155         if ($insidetable) {
1156             echo '</td></tr></table>';
1157         }
1158     }
1161 /**
1162  * It returns all entries from all glossaries that matches the specified criteria
1163  *  within a given $course. It performs an $extended search if necessary.
1164  * It restrict the search to only one $glossary if the $glossary parameter is set.
1165  *
1166  * @global object
1167  * @global object
1168  * @param object $course
1169  * @param array $searchterms
1170  * @param int $extended
1171  * @param object $glossary
1172  * @return array
1173  */
1174 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1175     global $CFG, $DB;
1177     if ( !$glossary ) {
1178         if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1179             $glos = "";
1180             foreach ( $glossaries as $glossary ) {
1181                 $glos .= "$glossary->id,";
1182             }
1183             $glos = substr($glos,0,-1);
1184         }
1185     } else {
1186         $glos = $glossary->id;
1187     }
1189     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $glossary->course))) {
1190         $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1191         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1192         $onlyvisibletable = ", {course_modules} cm";
1193     } else {
1195         $onlyvisible = "";
1196         $onlyvisibletable = "";
1197     }
1199     if ($DB->sql_regex_supported()) {
1200         $REGEXP    = $DB->sql_regex(true);
1201         $NOTREGEXP = $DB->sql_regex(false);
1202     }
1203     $LIKE = $DB->sql_ilike(); // case-insensitive
1205     $searchcond = array();
1206     $params     = array();
1207     $i = 0;
1209     $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1212     foreach ($searchterms as $searchterm) {
1213         $i++;
1215         $NOT = ''; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1216                    /// will use it to simulate the "-" operator with LIKE clause
1218     /// Under Oracle and MSSQL, trim the + and - operators and perform
1219     /// simpler LIKE (or NOT LIKE) queries
1220         if (!$DB->sql_regex_supported()) {
1221             if (substr($searchterm, 0, 1) == '-') {
1222                 $NOT = ' NOT ';
1223             }
1224             $searchterm = trim($searchterm, '+-');
1225         }
1227         // TODO: +- may not work for non latin languages
1229         if (substr($searchterm,0,1) == '+') {
1230             $searchterm = trim($searchterm, '+-');
1231             $searchterm = preg_quote($searchterm, '|');
1232             $searchcond[] = "$concat $REGEXP :ss$i";
1233             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1235         } else if (substr($searchterm,0,1) == "-") {
1236             $searchterm = trim($searchterm, '+-');
1237             $searchterm = preg_quote($searchterm, '|');
1238             $searchcond[] = "$concat $NOTREGEXP :ss$i";
1239             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1241         } else {
1242             $searchcond[] = "$concat $NOT $LIKE :ss$i";
1243             $params['ss'.$i] = "%$searchterm%";
1244         }
1245     }
1247     if (empty($searchcond)) {
1248         $totalcount = 0;
1249         return array();
1250     }
1252     $searchcond = implode(" AND ", $searchcond);
1254     $sql = "SELECT e.*
1255               FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1256              WHERE $searchcond
1257                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1258                AND g.id IN ($glos) AND e.approved <> 0";
1260     return $DB->get_records_sql($sql, $params);
1263 /**
1264  * @global object
1265  * @param array $searchterms
1266  * @param object $glossary
1267  * @param bool $extended
1268  * @return array
1269  */
1270 function glossary_search_entries($searchterms, $glossary, $extended) {
1271     global $DB;
1273     $course = $DB->get_record("course", array("id"=>$glossary->course));
1274     return glossary_search($course,$searchterms,$extended,$glossary);
1277 /**
1278  * if return=html, then return a html string.
1279  * if return=text, then return a text-only string.
1280  * otherwise, print HTML for non-images, and return image HTML
1281  *     if attachment is an image, $align set its aligment.
1282  *
1283  * @global object
1284  * @global object
1285  * @param object $entry
1286  * @param object $cm
1287  * @param string $type html, txt, empty
1288  * @param string $align left or right
1289  * @return string image string or nothing depending on $type param
1290  */
1291 function glossary_print_attachments($entry, $cm, $type=NULL, $align="left") {
1292     global $CFG, $DB, $OUTPUT;
1294     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
1295         return '';
1296     }
1298     if ($entry->sourceglossaryid == $cm->instance) {
1299         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1300             return '';
1301         }
1302         $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1304     } else {
1305         $filecontext = $context;
1306     }
1308     $strattachment = get_string('attachment', 'glossary');
1310     $fs = get_file_storage();
1312     $imagereturn = '';
1313     $output = '';
1315     if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1316         foreach ($files as $file) {
1317             $filename = $file->get_filename();
1318             $mimetype = $file->get_mimetype();
1319             $iconimage = '<img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />';
1320             $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename);
1322             if ($type == 'html') {
1323                 $output .= "<a href=\"$path\">$iconimage</a> ";
1324                 $output .= "<a href=\"$path\">".s($filename)."</a>";
1325                 $output .= "<br />";
1327             } else if ($type == 'text') {
1328                 $output .= "$strattachment ".s($filename).":\n$path\n";
1330             } else {
1331                 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1332                     // Image attachments don't get printed as links
1333                     $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1334                 } else {
1335                     $output .= "<a href=\"$path\">$iconimage</a> ";
1336                     $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context));
1337                     $output .= '<br />';
1338                 }
1339             }
1340         }
1341     }
1343     if ($type) {
1344         return $output;
1345     } else {
1346         echo $output;
1347         return $imagereturn;
1348     }
1351 /**
1352  * Lists all browsable file areas
1353  *
1354  * @param object $course
1355  * @param object $cm
1356  * @param object $context
1357  * @return array
1358  */
1359 function glossary_get_file_areas($course, $cm, $context) {
1360     $areas = array();
1361     return $areas;
1364 /**
1365  * Serves the glossary attachments. Implements needed access control ;-)
1366  *
1367  * @param object $course
1368  * @param object $cm
1369  * @param object $context
1370  * @param string $filearea
1371  * @param array $args
1372  * @param bool $forcedownload
1373  * @return bool false if file not found, does not return if found - justsend the file
1374  */
1375 function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
1376     global $CFG, $DB;
1378     if ($context->contextlevel != CONTEXT_MODULE) {
1379         return false;
1380     }
1382     require_course_login($course, true, $cm);
1384     if ($filearea === 'attachment' or $filearea === 'entry') {
1385         $entryid = (int)array_shift($args);
1387         require_course_login($course, true, $cm);
1389         if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1390             return false;
1391         }
1393         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1394             return false;
1395         }
1397         if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1398             return false;
1399         }
1401         // this trickery here is because we need to support source glossary access
1403         if ($entry->glossaryid == $cm->instance) {
1404             $filecontext = $context;
1406         } else if ($entry->sourceglossaryid == $cm->instance) {
1407             if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1408                 return false;
1409             }
1410             $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1412         } else {
1413             return false;
1414         }
1416         $relativepath = implode('/', $args);
1417         $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath";
1419         $fs = get_file_storage();
1420         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1421             return false;
1422         }
1424         // finally send the file
1425         send_stored_file($file, 0, 0, true); // download MUST be forced - security!
1427     } else if ($filearea === 'export') {
1428         require_login($course, false, $cm);
1429         require_capability('mod/glossary:export', $context);
1431         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1432             return false;
1433         }
1435         $cat = array_shift($args);
1436         $cat = clean_param($cat, PARAM_ALPHANUM);
1438         $filename = clean_filename(strip_tags(format_string($glossary->name)).'.xml');
1439         $content = glossary_generate_export_file($glossary, NULL, $cat);
1441         send_file($content, $filename, 0, 0, true, true);
1442     }
1444     return false;
1447 /**
1448  *
1449  */
1450 function glossary_print_tabbed_table_end() {
1451      echo "</div></div>";
1454 /**
1455  * @param object $cm
1456  * @param object $glossary
1457  * @param string $mode
1458  * @param string $hook
1459  * @param string $sortkey
1460  * @param string $sortorder
1461  */
1462 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1463     if ($glossary->showalphabet) {
1464         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1465     }
1466     glossary_print_special_links($cm, $glossary, $mode, $hook);
1468     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1470     glossary_print_all_links($cm, $glossary, $mode, $hook);
1472     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1474 /**
1475  * @param object $cm
1476  * @param object $glossary
1477  * @param string $hook
1478  * @param string $sortkey
1479  * @param string $sortorder
1480  */
1481 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1482     echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1485 /**
1486  * @param object $cm
1487  * @param object $glossary
1488  * @param string $hook
1489  * @param string $sortkey
1490  * @param string $sortorder
1491  */
1492 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1493     echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1495 /**
1496  * @param object $cm
1497  * @param object $glossary
1498  * @param string $hook
1499  * @param string $sortkey
1500  * @param string $sortorder
1501  */
1502 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1503     if ( $mode != 'date' ) {
1504         if ($glossary->showalphabet) {
1505             echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1506         }
1508         glossary_print_special_links($cm, $glossary, $mode, $hook);
1510         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1512         glossary_print_all_links($cm, $glossary, $mode, $hook);
1513     } else {
1514         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1515     }
1518 /**
1519  * @param object $cm
1520  * @param object $glossary
1521  * @param string $hook
1522  * @param string $sortkey
1523  * @param string $sortorder
1524  */
1525 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1526     if ($glossary->showalphabet) {
1527         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1528     }
1530     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1531     glossary_print_all_links($cm, $glossary, $mode, $hook);
1532     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1535 /**
1536  * @global object
1537  * @global object
1538  * @param object $cm
1539  * @param object $glossary
1540  * @param string $hook
1541  * @param object $category
1542  */
1543 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1544      global $CFG, $DB, $OUTPUT;
1546      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1548      echo '<table border="0" width="100%">';
1549      echo '<tr>';
1551      echo '<td align="center" style="width:20%">';
1552      if (has_capability('mod/glossary:managecategories', $context)) {
1553              $options['id'] = $cm->id;
1554              $options['mode'] = 'cat';
1555              $options['hook'] = $hook;
1556              echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1557      }
1558      echo '</td>';
1560      echo '<td align="center" style="width:60%">';
1561      echo '<b>';
1563      $menu = array();
1564      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1565      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1567      $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1568      $selected = '';
1569      if ( $categories ) {
1570           foreach ($categories as $currentcategory) {
1571                  $url = $currentcategory->id;
1572                  if ( $category ) {
1573                      if ($currentcategory->id == $category->id) {
1574                          $selected = $url;
1575                      }
1576                  }
1577                  $menu[$url] = clean_text($currentcategory->name); //Only clean, not filters
1578           }
1579      }
1580      if ( !$selected ) {
1581          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1582      }
1584      if ( $category ) {
1585         echo format_text($category->name, FORMAT_PLAIN);
1586      } else {
1587         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1589             echo get_string("entrieswithoutcategory","glossary");
1590             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1592         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1594             echo get_string("allcategories","glossary");
1595             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1597         }
1598      }
1599      echo '</b></td>';
1600      echo '<td align="center" style="width:20%">';
1602      $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1603      echo $OUTPUT->render($select);
1605      echo '</td>';
1606      echo '</tr>';
1608      echo '</table>';
1611 /**
1612  * @global object
1613  * @param object $cm
1614  * @param object $glossary
1615  * @param string $mode
1616  * @param string $hook
1617  */
1618 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1619 global $CFG;
1620      if ( $glossary->showall) {
1621          $strallentries       = get_string("allentries", "glossary");
1622          if ( $hook == 'ALL' ) {
1623               echo "<b>$strallentries</b>";
1624          } else {
1625               $strexplainall = strip_tags(get_string("explainall","glossary"));
1626               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1627          }
1628      }
1631 /**
1632  * @global object
1633  * @param object $cm
1634  * @param object $glossary
1635  * @param string $mode
1636  * @param string $hook
1637  */
1638 function glossary_print_special_links($cm, $glossary, $mode, $hook) {
1639 global $CFG;
1640      if ( $glossary->showspecial) {
1641          $strspecial          = get_string("special", "glossary");
1642          if ( $hook == 'SPECIAL' ) {
1643               echo "<b>$strspecial</b> | ";
1644          } else {
1645               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1646               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
1647          }
1648      }
1651 /**
1652  * @global object
1653  * @param object $glossary
1654  * @param string $mode
1655  * @param string $hook
1656  * @param string $sortkey
1657  * @param string $sortorder
1658  */
1659 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1660 global $CFG;
1661      if ( $glossary->showalphabet) {
1662           $alphabet = explode(",", get_string('alphabet', 'langconfig'));
1663           for ($i = 0; $i < count($alphabet); $i++) {
1664               if ( $hook == $alphabet[$i] and $hook) {
1665                    echo "<b>$alphabet[$i]</b>";
1666               } else {
1667                    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>";
1668               }
1669               echo ' | ';
1670           }
1671      }
1674 /**
1675  * @global object
1676  * @param object $cm
1677  * @param string $mode
1678  * @param string $sortkey
1679  * @param string $sortorder
1680  */
1681 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
1682     global $CFG, $OUTPUT;
1684     $asc    = get_string("ascending","glossary");
1685     $desc   = get_string("descending","glossary");
1686     $bopen  = '<b>';
1687     $bclose = '</b>';
1689      $neworder = '';
1690      $currentorder = '';
1691      $currentsort = '';
1692      if ( $sortorder ) {
1693          if ( $sortorder == 'asc' ) {
1694              $currentorder = $asc;
1695              $neworder = '&amp;sortorder=desc';
1696              $newordertitle = get_string('changeto', 'glossary', $desc);
1697          } else {
1698              $currentorder = $desc;
1699              $neworder = '&amp;sortorder=asc';
1700              $newordertitle = get_string('changeto', 'glossary', $asc);
1701          }
1702          $icon = " <img src=\"".$OUTPUT->pix_url($sortorder, 'glossary')."\" class=\"icon\" alt=\"$newordertitle\" />";
1703      } else {
1704          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
1705                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
1706              $icon = "";
1707              $newordertitle = $asc;
1708          } else {
1709              $newordertitle = $desc;
1710              $neworder = '&amp;sortorder=desc';
1711              $icon = ' <img src="'.$OUTPUT->pix_url('asc', 'glossary').'" class="icon" alt="'.$newordertitle.'" />';
1712          }
1713      }
1714      $ficon     = '';
1715      $fneworder = '';
1716      $fbtag     = '';
1717      $fendbtag  = '';
1719      $sicon     = '';
1720      $sneworder = '';
1722      $sbtag      = '';
1723      $fbtag      = '';
1724      $fendbtag      = '';
1725      $sendbtag      = '';
1727      $sendbtag  = '';
1729      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
1730          $ficon       = $icon;
1731          $fneworder   = $neworder;
1732          $fordertitle = $newordertitle;
1733          $sordertitle = $asc;
1734          $fbtag       = $bopen;
1735          $fendbtag    = $bclose;
1736      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
1737          $sicon = $icon;
1738          $sneworder   = $neworder;
1739          $fordertitle = $asc;
1740          $sordertitle = $newordertitle;
1741          $sbtag       = $bopen;
1742          $sendbtag    = $bclose;
1743      } else {
1744          $fordertitle = $asc;
1745          $sordertitle = $asc;
1746      }
1748      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
1749          $forder = 'CREATION';
1750          $sorder =  'UPDATE';
1751          $fsort  = get_string("sortbycreation", "glossary");
1752          $ssort  = get_string("sortbylastupdate", "glossary");
1754          $currentsort = $fsort;
1755          if ($sortkey == 'UPDATE') {
1756              $currentsort = $ssort;
1757          }
1758          $sort        = get_string("sortchronogically", "glossary");
1759      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
1760          $forder = 'FIRSTNAME';
1761          $sorder =  'LASTNAME';
1762          $fsort  = get_string("firstname");
1763          $ssort  = get_string("lastname");
1765          $currentsort = $fsort;
1766          if ($sortkey == 'LASTNAME') {
1767              $currentsort = $ssort;
1768          }
1769          $sort        = get_string("sortby", "glossary");
1770      }
1771      $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
1772      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 | ".
1773                           "$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 />";
1776 /**
1777  *
1778  * @param object $entry0
1779  * @param object $entry1
1780  * @return int [-1 | 0 | 1]
1781  */
1782 function glossary_sort_entries ( $entry0, $entry1 ) {
1784     if ( moodle_strtolower(ltrim($entry0->concept)) < moodle_strtolower(ltrim($entry1->concept)) ) {
1785         return -1;
1786     } elseif ( moodle_strtolower(ltrim($entry0->concept)) > moodle_strtolower(ltrim($entry1->concept)) ) {
1787         return 1;
1788     } else {
1789         return 0;
1790     }
1794 /**
1795  * @global object
1796  * @global object
1797  * @global object
1798  * @param object $course
1799  * @param object $entry
1800  * @return bool
1801  */
1802 function  glossary_print_entry_ratings($course, $entry) {
1803     global $OUTPUT;
1804     if( !empty($entry->rating) ){
1805         echo $OUTPUT->render($entry->rating);
1806     }
1809 /**
1810  *
1811  * @global object
1812  * @global object
1813  * @global object
1814  * @param int $courseid
1815  * @param array $entries
1816  * @param int $displayformat
1817  */
1818 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
1819     global $USER,$CFG, $DB;
1821     echo '<div class="boxaligncenter">';
1822     echo '<table class="glossarypopup" cellspacing="0"><tr>';
1823     echo '<td>';
1824     if ( $entries ) {
1825         foreach ( $entries as $entry ) {
1826             if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
1827                 print_error('invalidid', 'glossary');
1828             }
1829             if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
1830                 print_error('coursemisconf');
1831             }
1832             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
1833                 print_error('invalidid', 'glossary');
1834             }
1836             //If displayformat is present, override glossary->displayformat
1837             if ($displayformat < 0) {
1838                 $dp = $glossary->displayformat;
1839             } else {
1840                 $dp = $displayformat;
1841             }
1843             //Get popupformatname
1844             $format = $DB->get_record('glossary_formats', array('name'=>$dp));
1845             $displayformat = $format->popupformatname;
1847             //Check displayformat variable and set to default if necessary
1848             if (!$displayformat) {
1849                 $displayformat = 'dictionary';
1850             }
1852             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1853             $functionname = 'glossary_show_entry_'.$displayformat;
1855             if (file_exists($formatfile)) {
1856                 include_once($formatfile);
1857                 if (function_exists($functionname)) {
1858                     $functionname($course, $cm, $glossary, $entry,'','','','');
1859                 }
1860             }
1861         }
1862     }
1863     echo '</td>';
1864     echo '</tr></table></div>';
1867 /**
1868  *
1869  * @global object
1870  * @param array $entries
1871  * @param array $aliases
1872  * @param array $categories
1873  * @return string
1874  */
1875 function glossary_generate_export_csv($entries, $aliases, $categories) {
1876     global $CFG;
1877     $csv = '';
1878     $delimiter = '';
1879     require_once($CFG->libdir . '/csvlib.class.php');
1880     $delimiter = csv_import_reader::get_delimiter('comma');
1881     $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
1882     $csvaliases = array(0 => array());
1883     $csvcategories = array(0 => array());
1884     $aliascount = 0;
1885     $categorycount = 0;
1887     foreach ($entries as $entry) {
1888         $thisaliasesentry = array();
1889         $thiscategoriesentry = array();
1890         $thiscsventry = array($entry->concept, nl2br($entry->definition));
1892         if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
1893             $thiscount = count($aliases[$entry->id]);
1894             if ($thiscount > $aliascount) {
1895                 $aliascount = $thiscount;
1896             }
1897             foreach ($aliases[$entry->id] as $alias) {
1898                 $thisaliasesentry[] = trim($alias);
1899             }
1900         }
1901         if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
1902             $thiscount = count($categories[$entry->id]);
1903             if ($thiscount > $categorycount) {
1904                 $categorycount = $thiscount;
1905             }
1906             foreach ($categories[$entry->id] as $catentry) {
1907                 $thiscategoriesentry[] = trim($catentry);
1908             }
1909         }
1910         $csventries[$entry->id] = $thiscsventry;
1911         $csvaliases[$entry->id] = $thisaliasesentry;
1912         $csvcategories[$entry->id] = $thiscategoriesentry;
1914     }
1915     $returnstr = '';
1916     foreach ($csventries as $id => $row) {
1917         $aliasstr = '';
1918         $categorystr = '';
1919         if ($id == 0) {
1920             $aliasstr = get_string('alias', 'glossary');
1921             $categorystr = get_string('category', 'glossary');
1922         }
1923         $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
1924         $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
1925     }
1926     return $returnstr;
1929 /**
1930  *
1931  * @param object $glossary
1932  * @param string $ignored invalid parameter
1933  * @param int|string $hook
1934  * @return string
1935  */
1936 function glossary_generate_export_file($glossary, $ignored = "", $hook = 0) {
1937     global $CFG, $DB;
1939     $co  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1941     $co .= glossary_start_tag("GLOSSARY",0,true);
1942     $co .= glossary_start_tag("INFO",1,true);
1943         $co .= glossary_full_tag("NAME",2,false,$glossary->name);
1944         $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
1945         $co .= glossary_full_tag("INTROFORMAT",2,false,$glossary->introformat);
1946         $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
1947         $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
1948         $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
1949         $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
1950         $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
1951         $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
1952         $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
1953         $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
1954         $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
1955         $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
1957         if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) {
1958             $co .= glossary_start_tag("ENTRIES",2,true);
1959             foreach ($entries as $entry) {
1960                 $permissiongranted = 1;
1961                 if ( $hook ) {
1962                     switch ( $hook ) {
1963                     case "ALL":
1964                     case "SPECIAL":
1965                     break;
1966                     default:
1967                         $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
1968                     break;
1969                     }
1970                 }
1971                 if ( $hook ) {
1972                     switch ( $hook ) {
1973                     case GLOSSARY_SHOW_ALL_CATEGORIES:
1974                     break;
1975                     case GLOSSARY_SHOW_NOT_CATEGORISED:
1976                         $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id));
1977                     break;
1978                     default:
1979                         $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook));
1980                     break;
1981                     }
1982                 }
1983                 if ( $entry->approved and $permissiongranted ) {
1984                     $co .= glossary_start_tag("ENTRY",3,true);
1985                     $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
1986                     $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition);
1987                     $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat); // note: use old name for BC reasons
1988                     $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
1989                     $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
1990                     $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
1991                     $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
1993                     if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) {
1994                         $co .= glossary_start_tag("ALIASES",4,true);
1995                         foreach ($aliases as $alias) {
1996                             $co .= glossary_start_tag("ALIAS",5,true);
1997                                 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
1998                             $co .= glossary_end_tag("ALIAS",5,true);
1999                         }
2000                         $co .= glossary_end_tag("ALIASES",4,true);
2001                     }
2002                     if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) {
2003                         $co .= glossary_start_tag("CATEGORIES",4,true);
2004                         foreach ($catentries as $catentry) {
2005                             $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid));
2007                             $co .= glossary_start_tag("CATEGORY",5,true);
2008                                 $co .= glossary_full_tag("NAME",6,false,$category->name);
2009                                 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
2010                             $co .= glossary_end_tag("CATEGORY",5,true);
2011                         }
2012                         $co .= glossary_end_tag("CATEGORIES",4,true);
2013                     }
2015                     $co .= glossary_end_tag("ENTRY",3,true);
2016                 }
2017             }
2018             $co .= glossary_end_tag("ENTRIES",2,true);
2020         }
2023     $co .= glossary_end_tag("INFO",1,true);
2024     $co .= glossary_end_tag("GLOSSARY",0,true);
2026     return $co;
2028 /// Functions designed by Eloy Lafuente
2029 /// Functions to create, open and write header of the xml file
2031 /**
2032  * Read import file and convert to current charset
2033  *
2034  * @global object
2035  * @param string $file
2036  * @return string
2037  */
2038 function glossary_read_imported_file($file_content) {
2039     require_once "../../lib/xmlize.php";
2040     global $CFG;
2042     return xmlize($file_content, 0);
2045 /**
2046  * Return the xml start tag
2047  *
2048  * @param string $tag
2049  * @param int $level
2050  * @param bool $endline
2051  * @return string
2052  */
2053 function glossary_start_tag($tag,$level=0,$endline=false) {
2054         if ($endline) {
2055            $endchar = "\n";
2056         } else {
2057            $endchar = "";
2058         }
2059         return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
2062 /**
2063  * Return the xml end tag
2064  * @param string $tag
2065  * @param int $level
2066  * @param bool $endline
2067  * @return string
2068  */
2069 function glossary_end_tag($tag,$level=0,$endline=true) {
2070         if ($endline) {
2071            $endchar = "\n";
2072         } else {
2073            $endchar = "";
2074         }
2075         return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
2078 /**
2079  * Return the start tag, the contents and the end tag
2080  *
2081  * @global object
2082  * @param string $tag
2083  * @param int $level
2084  * @param bool $endline
2085  * @param string $content
2086  * @return string
2087  */
2088 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
2089         global $CFG;
2091         $st = glossary_start_tag($tag,$level,$endline);
2092         $co = preg_replace("/\r\n|\r/", "\n", s($content));
2093         $et = glossary_end_tag($tag,0,true);
2094         return $st.$co.$et;
2097 /**
2098  * How many unrated entries are in the given glossary for a given user?
2099  *
2100  * @global object
2101  * @param int $glossaryid
2102  * @param int $userid
2103  * @return int
2104  */
2105 function glossary_count_unrated_entries($glossaryid, $userid) {
2106     global $DB;
2107     if ($entries = $DB->get_record_sql("SELECT count('x') as num
2108                                           FROM {glossary_entries}
2109                                          WHERE glossaryid = ? AND userid <> ?", array($glossaryid, $userid))) {
2111         if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2112             return 0;
2113         }
2114         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2116         if ($rated = $DB->get_record_sql("SELECT count(*) as num
2117                                             FROM {glossary_entries} e, {ratings} r
2118                                            WHERE e.glossaryid = :glossaryid AND e.id = r.itemid
2119                                                  AND r.userid = :userid and r.contextid = :contextid",
2120                 array('glossaryid'=>$glossaryid, 'userid'=>$userid, 'contextid'=>$context->id))) {
2122             $difference = $entries->num - $rated->num;
2123             if ($difference > 0) {
2124                 return $difference;
2125             } else {
2126                 return 0;    // Just in case there was a counting error
2127             }
2128         } else {
2129             return $entries->num;
2130         }
2131     } else {
2132         return 0;
2133     }
2136 /**
2137  *
2138  * Returns the html code to represent any pagging bar. Paramenters are:
2139  *
2140  * The function dinamically show the first and last pages, and "scroll" over pages.
2141  * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
2142  * could replace the general one. ;-)
2143  *
2144  * @param int $totalcount total number of records to be displayed
2145  * @param int $page page currently selected (0 based)
2146  * @param int $perpage number of records per page
2147  * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically.
2148  *
2149  * @param int $maxpageallowed Optional maximum number of page allowed.
2150  * @param int $maxdisplay Optional maximum number of page links to show in the bar
2151  * @param string $separator Optional string to be used between pages in the bar
2152  * @param string $specialtext Optional string to be showed as an special link
2153  * @param string $specialvalue Optional value (page) to be used in the special link
2154  * @param bool $previousandnext Optional to decide if we want the previous and next links
2155  * @return string
2156  */
2157 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) {
2159     $code = '';
2161     $showspecial = false;
2162     $specialselected = false;
2164     //Check if we have to show the special link
2165     if (!empty($specialtext)) {
2166         $showspecial = true;
2167     }
2168     //Check if we are with the special link selected
2169     if ($showspecial && $page == $specialvalue) {
2170         $specialselected = true;
2171     }
2173     //If there are results (more than 1 page)
2174     if ($totalcount > $perpage) {
2175         $code .= "<div style=\"text-align:center\">";
2176         $code .= "<p>".get_string("page").":";
2178         $maxpage = (int)(($totalcount-1)/$perpage);
2180         //Lower and upper limit of page
2181         if ($page < 0) {
2182             $page = 0;
2183         }
2184         if ($page > $maxpageallowed) {
2185             $page = $maxpageallowed;
2186         }
2187         if ($page > $maxpage) {
2188             $page = $maxpage;
2189         }
2191         //Calculate the window of pages
2192         $pagefrom = $page - ((int)($maxdisplay / 2));
2193         if ($pagefrom < 0) {
2194             $pagefrom = 0;
2195         }
2196         $pageto = $pagefrom + $maxdisplay - 1;
2197         if ($pageto > $maxpageallowed) {
2198             $pageto = $maxpageallowed;
2199         }
2200         if ($pageto > $maxpage) {
2201             $pageto = $maxpage;
2202         }
2204         //Some movements can be necessary if don't see enought pages
2205         if ($pageto - $pagefrom < $maxdisplay - 1) {
2206             if ($pageto - $maxdisplay + 1 > 0) {
2207                 $pagefrom = $pageto - $maxdisplay + 1;
2208             }
2209         }
2211         //Calculate first and last if necessary
2212         $firstpagecode = '';
2213         $lastpagecode = '';
2214         if ($pagefrom > 0) {
2215             $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2216             if ($pagefrom > 1) {
2217                 $firstpagecode .= "$separator...";
2218             }
2219         }
2220         if ($pageto < $maxpage) {
2221             if ($pageto < $maxpage -1) {
2222                 $lastpagecode = "$separator...";
2223             }
2224             $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2225         }
2227         //Previous
2228         if ($page > 0 && $previousandnext) {
2229             $pagenum = $page - 1;
2230             $code .= "&nbsp;(<a  href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;";
2231         }
2233         //Add first
2234         $code .= $firstpagecode;
2236         $pagenum = $pagefrom;
2238         //List of maxdisplay pages
2239         while ($pagenum <= $pageto) {
2240             $pagetoshow = $pagenum +1;
2241             if ($pagenum == $page && !$specialselected) {
2242                 $code .= "$separator<b>$pagetoshow</b>";
2243             } else {
2244                 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2245             }
2246             $pagenum++;
2247         }
2249         //Add last
2250         $code .= $lastpagecode;
2252         //Next
2253         if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2254             $pagenum = $page + 1;
2255             $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2256         }
2258         //Add special
2259         if ($showspecial) {
2260             $code .= '<br />';
2261             if ($specialselected) {
2262                 $code .= "<b>$specialtext</b>";
2263             } else {
2264                 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2265             }
2266         }
2268         //End html
2269         $code .= "</p>";
2270         $code .= "</div>";
2271     }
2273     return $code;
2275 /**
2276  * @return array
2277  */
2278 function glossary_get_view_actions() {
2279     return array('view','view all','view entry');
2281 /**
2282  * @return array
2283  */
2284 function glossary_get_post_actions() {
2285     return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry');
2289 /**
2290  * Implementation of the function for printing the form elements that control
2291  * whether the course reset functionality affects the glossary.
2292  * @param object $mform form passed by reference
2293  */
2294 function glossary_reset_course_form_definition(&$mform) {
2295     $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary'));
2296     $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary'));
2298     $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'),
2299                        array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple'));
2300     $mform->setAdvanced('reset_glossary_types');
2301     $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked');
2303     $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary'));
2304     $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked');
2306     $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings'));
2307     $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked');
2309     $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments'));
2310     $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked');
2313 /**
2314  * Course reset form defaults.
2315  * @return array
2316  */
2317 function glossary_reset_course_form_defaults($course) {
2318     return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0);
2321 /**
2322  * Removes all grades from gradebook
2323  *
2324  * @global object
2325  * @param int $courseid
2326  * @param string optional type
2327  */
2328 function glossary_reset_gradebook($courseid, $type='') {
2329     global $DB;
2331     switch ($type) {
2332         case 'main'      : $type = "AND g.mainglossary=1"; break;
2333         case 'secondary' : $type = "AND g.mainglossary=0"; break;
2334         default          : $type = ""; //all
2335     }
2337     $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid
2338               FROM {glossary} g, {course_modules} cm, {modules} m
2339              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type";
2341     if ($glossarys = $DB->get_records_sql($sql, array($courseid))) {
2342         foreach ($glossarys as $glossary) {
2343             glossary_grade_item_update($glossary, 'reset');
2344         }
2345     }
2347 /**
2348  * Actual implementation of the rest coures functionality, delete all the
2349  * glossary responses for course $data->courseid.
2350  *
2351  * @global object
2352  * @param $data the data submitted from the reset course.
2353  * @return array status array
2354  */
2355 function glossary_reset_userdata($data) {
2356     global $CFG, $DB;
2357     require_once($CFG->dirroot.'/rating/lib.php');
2359     $componentstr = get_string('modulenameplural', 'glossary');
2360     $status = array();
2362     $allentriessql = "SELECT e.id
2363                         FROM {glossary_entries} e
2364                              JOIN {glossary} g ON e.glossaryid = g.id
2365                        WHERE g.course = ?";
2367     $allglossariessql = "SELECT g.id
2368                            FROM {glossary} g
2369                           WHERE g.course = ?";
2371     $params = array($data->courseid);
2373     $fs = get_file_storage();
2375     $rm = new rating_manager();
2376     $ratingdeloptions = new stdclass();
2378     // delete entries if requested
2379     if (!empty($data->reset_glossary_all)
2380          or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) {
2382         $params[] = 'glossary_entry';
2383         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea=?", $params);
2384         $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2386         // now get rid of all attachments
2387         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2388             foreach ($glossaries as $glossaryid=>$unused) {
2389                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2390                     continue;
2391                 }
2392                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2393                 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2395                 //delete ratings
2396                 $ratingdeloptions->contextid = $context->id;
2397                 $rm->delete_ratings($ratingdeloptions);
2398             }
2399         }
2401         // remove all grades from gradebook
2402         if (empty($data->reset_gradebook_grades)) {
2403             glossary_reset_gradebook($data->courseid);
2404         }
2406         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2408     } else if (!empty($data->reset_glossary_types)) {
2409         $mainentriessql         = "$allentries AND g.mainglossary=1";
2410         $secondaryentriessql    = "$allentries AND g.mainglossary=0";
2412         $mainglossariessql      = "$allglossariessql AND g.mainglossary=1";
2413         $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2415         if (in_array('main', $data->reset_glossary_types)) {
2416             $params[] = 'glossary_entry';
2417             $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params);
2418             $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2420             if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2421                 foreach ($glossaries as $glossaryid=>$unused) {
2422                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2423                         continue;
2424                     }
2425                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2426                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2428                     //delete ratings
2429                     $ratingdeloptions->contextid = $context->id;
2430                     $rm->delete_ratings($ratingdeloptions);
2431                 }
2432             }
2434             // remove all grades from gradebook
2435             if (empty($data->reset_gradebook_grades)) {
2436                 glossary_reset_gradebook($data->courseid, 'main');
2437             }
2439             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary'), 'error'=>false);
2441         } else if (in_array('secondary', $data->reset_glossary_types)) {
2442             $params[] = 'glossary_entry';
2443             $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params);
2444             $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2445             // remove exported source flag from entries in main glossary
2446             $DB->execute("UPDATE {glossary_entries
2447                              SET sourceglossaryid=0
2448                            WHERE glossaryid IN ($mainglossariessql)", $params);
2450             if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2451                 foreach ($glossaries as $glossaryid=>$unused) {
2452                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2453                         continue;
2454                     }
2455                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2456                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2458                     //delete ratings
2459                     $ratingdeloptions->contextid = $context->id;
2460                     $rm->delete_ratings($ratingdeloptions);
2461                 }
2462             }
2464             // remove all grades from gradebook
2465             if (empty($data->reset_gradebook_grades)) {
2466                 glossary_reset_gradebook($data->courseid, 'secondary');
2467             }
2469             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2470         }
2471     }
2473     // remove entries by users not enrolled into course
2474     if (!empty($data->reset_glossary_notenrolled)) {
2475         $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2476                          FROM {glossary_entries} e
2477                               JOIN {glossary} g ON e.glossaryid = g.id
2478                               LEFT JOIN {user} u ON e.userid = u.id
2479                         WHERE g.course = ? AND e.userid > 0";
2481         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2482         $notenrolled = array();
2483         if ($rs = $DB->get_recordset_sql($entriessql, $params)) {
2484             foreach ($rs as $entry) {
2485                 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2486                   or !is_enrolled($course_context , $entry->userid)) {
2487                     $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id));
2488                     $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2490                     if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2491                         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2492                         $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
2494                         //delete ratings
2495                         $ratingdeloptions->contextid = $context->id;
2496                         $rm->delete_ratings($ratingdeloptions);
2497                     }
2498                 }
2499             }
2500             $rs->close();
2501             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2502         }
2503     }
2505     // remove all ratings
2506     if (!empty($data->reset_glossary_ratings)) {
2507         //remove ratings
2508         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2509             foreach ($glossaries as $glossaryid=>$unused) {
2510                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2511                     continue;
2512                 }
2513                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2515                 //delete ratings
2516                 $ratingdeloptions->contextid = $context->id;
2517                 $rm->delete_ratings($ratingdeloptions);
2518             }
2519         }
2521         // remove all grades from gradebook
2522         if (empty($data->reset_gradebook_grades)) {
2523             glossary_reset_gradebook($data->courseid);
2524         }
2525         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2526     }
2528     // remove comments
2529     if (!empty($data->reset_glossary_comments)) {
2530         $params[] = 'glossary_entry';
2531         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params);
2532         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2533     }
2535     /// updating dates - shift may be negative too
2536     if ($data->timeshift) {
2537         shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
2538         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2539     }
2541     return $status;
2544 /**
2545  * Returns all other caps used in module
2546  * @return array
2547  */
2548 function glossary_get_extra_capabilities() {
2549     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');
2552 /**
2553  * @param string $feature FEATURE_xx constant for requested feature
2554  * @return mixed True if module supports feature, null if doesn't know
2555  */
2556 function glossary_supports($feature) {
2557     switch($feature) {
2558         case FEATURE_GROUPS:                  return false;
2559         case FEATURE_GROUPINGS:               return false;
2560         case FEATURE_GROUPMEMBERSONLY:        return true;
2561         case FEATURE_MOD_INTRO:               return true;
2562         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2563         case FEATURE_GRADE_HAS_GRADE:         return true;
2564         case FEATURE_GRADE_OUTCOMES:          return true;
2565         case FEATURE_RATE:                    return true;
2566         case FEATURE_BACKUP_MOODLE2:          return true;
2568         default: return null;
2569     }
2572 function glossary_extend_navigation($navigation, $course, $module, $cm) {
2573     global $CFG;
2574     $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'letter')));
2575     $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'cat')));
2576     $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'date')));
2577     $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'author')));
2580 /**
2581  * Adds module specific settings to the settings block
2582  *
2583  * @param settings_navigation $settings The settings navigation object
2584  * @param navigation_node $glossarynode The node to add module settings to
2585  */
2586 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
2587     global $PAGE, $DB, $CFG, $USER;
2589     $mode = optional_param('mode', '', PARAM_ALPHA);
2590     $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
2592     if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
2593         $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
2594     }
2596     if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
2597         $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
2598     }
2600     if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
2601         $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
2602     }
2604     if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
2605         $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
2606     }
2608     $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
2610     if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles) {
2611         require_once("$CFG->libdir/rsslib.php");
2613         $string = get_string('rsstype','forum');
2615         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_glossary', $glossary->id));
2616         $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2617     }