rss MDL-23391 refactored rss feeds to make them standard across components
[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;
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 all files
199     $fs->delete_area_files($context->id);
201     //delete ratings
202     $rm = new rating_manager();
203     $ratingdeloptions = new stdclass();
204     $ratingdeloptions->contextid = $context->id;
205     $rm->delete_ratings($ratingdeloptions);
207     glossary_grade_item_delete($glossary);
209     return $DB->delete_records('glossary', array('id'=>$id));
212 /**
213  * Return a small object with summary information about what a
214  * user has done with a given particular instance of this module
215  * Used for user activity reports.
216  * $return->time = the time they did it
217  * $return->info = a short text description
218  *
219  * @param object $course
220  * @param object $user
221  * @param object $mod
222  * @param object $glossary
223  * @return object|null
224  */
225 function glossary_user_outline($course, $user, $mod, $glossary) {
226     global $CFG;
228     require_once("$CFG->libdir/gradelib.php");
229     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
230     if (empty($grades->items[0]->grades)) {
231         $grade = false;
232     } else {
233         $grade = reset($grades->items[0]->grades);
234     }
236     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
237         $result = new object();
238         $result->info = count($entries) . ' ' . get_string("entries", "glossary");
240         $lastentry = array_pop($entries);
241         $result->time = $lastentry->timemodified;
243         if ($grade) {
244             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
245         }
246         return $result;
247     } else if ($grade) {
248         $result = new object();
249         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
250         $result->time = $grade->dategraded;
251         return $result;
252     }
253     return NULL;
256 /**
257  * @global object
258  * @param int $glossaryid
259  * @param int $userid
260  * @return array
261  */
262 function glossary_get_user_entries($glossaryid, $userid) {
263 /// Get all the entries for a user in a glossary
264     global $DB;
266     return $DB->get_records_sql("SELECT e.*, u.firstname, u.lastname, u.email, u.picture
267                                    FROM {glossary} g, {glossary_entries} e, {user} u
268                              WHERE g.id = ?
269                                AND e.glossaryid = g.id
270                                AND e.userid = ?
271                                AND e.userid = u.id
272                           ORDER BY e.timemodified ASC", array($glossaryid, $userid));
275 /**
276  * Print a detailed representation of what a  user has done with
277  * a given particular instance of this module, for user activity reports.
278  *
279  * @global object
280  * @param object $course
281  * @param object $user
282  * @param object $mod
283  * @param object $glossary
284  */
285 function glossary_user_complete($course, $user, $mod, $glossary) {
286     global $CFG, $OUTPUT;
287     require_once("$CFG->libdir/gradelib.php");
289     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
290     if (!empty($grades->items[0]->grades)) {
291         $grade = reset($grades->items[0]->grades);
292         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
293         if ($grade->str_feedback) {
294             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
295         }
296     }
298     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
299         echo '<table width="95%" border="0"><tr><td>';
300         foreach ($entries as $entry) {
301             $cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id);
302             glossary_print_entry($course, $cm, $glossary, $entry,"","",0);
303             echo '<p>';
304         }
305         echo '</td></tr></table>';
306     }
308 /**
309  * Given a course and a time, this module should find recent activity
310  * that has occurred in glossary activities and print it out.
311  * Return true if there was output, or false is there was none.
312  *
313  * @global object
314  * @global object
315  * @global object
316  * @param object $course
317  * @param object $viewfullnames
318  * @param int $timestart
319  * @return bool
320  */
321 function glossary_print_recent_activity($course, $viewfullnames, $timestart) {
322     global $CFG, $USER, $DB, $OUTPUT;
324     //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0
326     $modinfo = get_fast_modinfo($course);
327     $ids = array();
328     foreach ($modinfo->cms as $cm) {
329         if ($cm->modname != 'glossary') {
330             continue;
331         }
332         if (!$cm->uservisible) {
333             continue;
334         }
335         $ids[$cm->instance] = $cm->instance;
336     }
338     if (!$ids) {
339         return false;
340     }
342     $glist = implode(',', $ids); // there should not be hundreds of glossaries in one course, right?
344     if (!$entries = $DB->get_records_sql("SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
345                                                  ge.userid, u.firstname, u.lastname, u.email, u.picture
346                                             FROM {glossary_entries} ge
347                                             JOIN {user} u ON u.id = ge.userid
348                                            WHERE ge.glossaryid IN ($glist) AND ge.timemodified > ?
349                                         ORDER BY ge.timemodified ASC", array($timestart))) {
350         return false;
351     }
353     $editor  = array();
355     foreach ($entries as $entryid=>$entry) {
356         if ($entry->approved) {
357             continue;
358         }
360         if (!isset($editor[$entry->glossaryid])) {
361             $editor[$entry->glossaryid] = has_capability('mod/glossary:approve', get_context_instance(CONTEXT_MODULE, $modinfo->instances['glossary'][$entry->glossaryid]->id));
362         }
364         if (!$editor[$entry->glossaryid]) {
365             unset($entries[$entryid]);
366         }
367     }
369     if (!$entries) {
370         return false;
371     }
372     echo $OUTPUT->heading(get_string('newentries', 'glossary').':');
374     $strftimerecent = get_string('strftimerecent');
375     foreach ($entries as $entry) {
376         $link = $CFG->wwwroot.'/mod/glossary/view.php?g='.$entry->glossaryid.'&amp;mode=entry&amp;hook='.$entry->id;
377         if ($entry->approved) {
378             $dimmed = '';
379         } else {
380             $dimmed = ' dimmed_text';
381         }
382         echo '<div class="head'.$dimmed.'">';
383         echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
384         echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
385         echo '</div>';
386         echo '<div class="info"><a href="'.$link.'">'.format_text($entry->concept, true).'</a></div>';
387     }
389     return true;
392 /**
393  * @global object
394  * @param object $log
395  */
396 function glossary_log_info($log) {
397     global $DB;
399     return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
400                                   FROM {glossary_entries} e, {user} u
401                                  WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
404 /**
405  * Function to be run periodically according to the moodle cron
406  * This function searches for things that need to be done, such
407  * as sending out mail, toggling flags etc ...
408  * @return bool
409  */
410 function glossary_cron () {
411     return true;
414 /**
415  * Return grade for given user or all users.
416  *
417  * @global object
418  * @param int $glossaryid id of glossary
419  * @param int $userid optional user id, 0 means all users
420  * @return array array of grades, false if none
421  */
422 function glossary_get_user_grades($glossary, $userid=0) {
423     /*global $DB;
425     $params = array('userid'=>$userid, 'gid'=>$glossary->id);
427     $user = $userid ? "AND u.id = :userid" : "";
429     $sql = "SELECT u.id, u.id AS userid, avg(gr.rating) AS rawgrade
430               FROM {user} u, {glossary_entries} ge, {glossary_ratings} gr
431              WHERE u.id = ge.userid AND ge.id = gr.entryid
432                    AND gr.userid != u.id AND ge.glossaryid = :gid
433                    $user
434           GROUP BY u.id";
436     return $DB->get_records_sql($sql, $params);*/
437     global $CFG;
439     require_once($CFG->dirroot.'/rating/lib.php');
440     $rm = new rating_manager();
442     $ratingoptions = new stdclass();
444     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
445     $ratingoptions->modulename = 'glossary';
446     $ratingoptions->moduleid   = $glossary->id;
448     $ratingoptions->userid = $userid;
449     $ratingoptions->aggregationmethod = $glossary->assessed;
450     $ratingoptions->scaleid = $glossary->scale;
451     $ratingoptions->itemtable = 'glossary_entries';
452     $ratingoptions->itemtableusercolumn = 'userid';
454     return $rm->get_user_grades($ratingoptions);
457 /**
458  * Return rating related permissions
459  * @param string $options the context id
460  * @return array an associative array of the user's rating permissions
461  */
462 function glossary_rating_permissions($options) {
463     $contextid = $options;
464     $context = get_context_instance_by_id($contextid);
466     if (!$context) {
467         print_error('invalidcontext');
468         return null;
469     } else {
470         return array('view'=>has_capability('mod/glossary:viewrating',$context), 'viewany'=>has_capability('mod/glossary:viewanyrating',$context), 'viewall'=>has_capability('mod/glossary:viewallratings',$context), 'rate'=>has_capability('mod/glossary:rate',$context));
471     }
474 /**
475  * Returns the names of the table and columns necessary to check items for ratings
476  * @return array an array containing the item table, item id and user id columns
477  */
478 function glossary_rating_item_check_info() {
479     return array('glossary_entries','id','userid');
482 /**
483  * Update activity grades
484  *
485  * @global object
486  * @global object
487  * @param object $glossary null means all glossaries (with extra cmidnumber property)
488  * @param int $userid specific user only, 0 means all
489  */
490 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
491     global $CFG, $DB;
492     require_once($CFG->libdir.'/gradelib.php');
494     if (!$glossary->assessed) {
495         glossary_grade_item_update($glossary);
497     } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
498         glossary_grade_item_update($glossary, $grades);
500     } else if ($userid and $nullifnone) {
501         $grade = new object();
502         $grade->userid   = $userid;
503         $grade->rawgrade = NULL;
504         glossary_grade_item_update($glossary, $grade);
506     } else {
507         glossary_grade_item_update($glossary);
508     }
511 /**
512  * Update all grades in gradebook.
513  *
514  * @global object
515  */
516 function glossary_upgrade_grades() {
517     global $DB;
519     $sql = "SELECT COUNT('x')
520               FROM {glossary} g, {course_modules} cm, {modules} m
521              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
522     $count = $DB->count_records_sql($sql);
524     $sql = "SELECT g.*, cm.idnumber AS cmidnumber, g.course AS courseid
525               FROM {glossary} g, {course_modules} cm, {modules} m
526              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
527     if ($rs = $DB->get_recordset_sql($sql)) {
528         $pbar = new progress_bar('glossaryupgradegrades', 500, true);
529         $i=0;
530         foreach ($rs as $glossary) {
531             $i++;
532             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
533             glossary_update_grades($glossary, 0, false);
534             $pbar->update($i, $count, "Updating Glossary grades ($i/$count).");
535         }
536         $rs->close();
537     }
540 /**
541  * Create/update grade item for given glossary
542  *
543  * @global object
544  * @param object $glossary object with extra cmidnumber
545  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
546  * @return int, 0 if ok, error code otherwise
547  */
548 function glossary_grade_item_update($glossary, $grades=NULL) {
549     global $CFG;
550     require_once($CFG->libdir.'/gradelib.php');
552     $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
554     if (!$glossary->assessed or $glossary->scale == 0) {
555         $params['gradetype'] = GRADE_TYPE_NONE;
557     } else if ($glossary->scale > 0) {
558         $params['gradetype'] = GRADE_TYPE_VALUE;
559         $params['grademax']  = $glossary->scale;
560         $params['grademin']  = 0;
562     } else if ($glossary->scale < 0) {
563         $params['gradetype'] = GRADE_TYPE_SCALE;
564         $params['scaleid']   = -$glossary->scale;
565     }
567     if ($grades  === 'reset') {
568         $params['reset'] = true;
569         $grades = NULL;
570     }
572     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
575 /**
576  * Delete grade item for given glossary
577  *
578  * @global object
579  * @param object $glossary object
580  */
581 function glossary_grade_item_delete($glossary) {
582     global $CFG;
583     require_once($CFG->libdir.'/gradelib.php');
585     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
588 /**
589  * Returns the users with data in one glossary
590  * (users with records in glossary_entries, students)
591  *
592  * @global object
593  * @param int $glossaryid
594  * @return array
595  */
596 function glossary_get_participants($glossaryid) {
597     global $DB;
599     //Get students
600     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
601                                         FROM {user} u, {glossary_entries} g
602                                  WHERE g.glossaryid = ? AND u.id = g.userid", array($glossaryid));
604     //Return students array (it contains an array of unique users)
605     return $students;
608 /**
609  * @global object
610  * @param int $gloassryid
611  * @param int $scaleid
612  * @return bool
613  */
614 function glossary_scale_used ($glossaryid,$scaleid) {
615 //This function returns if a scale is being used by one glossary
616     global $DB;
618     $return = false;
620     $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
622     if (!empty($rec)  && !empty($scaleid)) {
623         $return = true;
624     }
626     return $return;
629 /**
630  * Checks if scale is being used by any instance of glossary
631  *
632  * This is used to find out if scale used anywhere
633  *
634  * @global object
635  * @param int $scaleid
636  * @return boolean True if the scale is used by any glossary
637  */
638 function glossary_scale_used_anywhere($scaleid) {
639     global $DB;
641     if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
642         return true;
643     } else {
644         return false;
645     }
648 //////////////////////////////////////////////////////////////////////////////////////
649 /// Any other glossary functions go here.  Each of them must have a name that
650 /// starts with glossary_
652 /**
653  * This function return an array of valid glossary_formats records
654  * Everytime it's called, every existing format is checked, new formats
655  * are included if detected and old formats are deleted and any glossary
656  * using an invalid format is updated to the default (dictionary).
657  *
658  * @global object
659  * @global object
660  * @return array
661  */
662 function glossary_get_available_formats() {
663     global $CFG, $DB;
665     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
666     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
667     $pluginformats = array();
668     foreach ($formats as $format) {
669         //If the format file exists
670         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
671             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
672             //If the function exists
673             if (function_exists('glossary_show_entry_'.$format)) {
674                 //Acummulate it as a valid format
675                 $pluginformats[] = $format;
676                 //If the format doesn't exist in the table
677                 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
678                     //Insert the record in glossary_formats
679                     $gf = new object();
680                     $gf->name = $format;
681                     $gf->popupformatname = $format;
682                     $gf->visible = 1;
683                     $DB->insert_record("glossary_formats",$gf);
684                 }
685             }
686         }
687     }
689     //Delete non_existent formats from glossary_formats table
690     $formats = $DB->get_records("glossary_formats");
691     foreach ($formats as $format) {
692         $todelete = false;
693         //If the format in DB isn't a valid previously detected format then delete the record
694         if (!in_array($format->name,$pluginformats)) {
695             $todelete = true;
696         }
698         if ($todelete) {
699             //Delete the format
700             $DB->delete_records('glossary_formats', array('name'=>$format->name));
701             //Reasign existing glossaries to default (dictionary) format
702             if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
703                 foreach($glossaries as $glossary) {
704                     $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
705                 }
706             }
707         }
708     }
710     //Now everything is ready in glossary_formats table
711     $formats = $DB->get_records("glossary_formats");
713     return $formats;
716 /**
717  * @param bool $debug
718  * @param string $text
719  * @param int $br
720  */
721 function glossary_debug($debug,$text,$br=1) {
722     if ( $debug ) {
723         echo '<font color="red">' . $text . '</font>';
724         if ( $br ) {
725             echo '<br />';
726         }
727     }
730 /**
731  *
732  * @global object
733  * @param int $glossaryid
734  * @param string $entrylist
735  * @param string $pivot
736  * @return array
737  */
738 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
739     global $DB;
740     if ($pivot) {
741        $pivot .= ",";
742     }
744     return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
745                                    FROM {glossary_entries}
746                                   WHERE glossaryid = ?
747                                         AND id IN ($entrylist)", array($glossaryid));
750 /**
751  * @global object
752  * @global object
753  * @param object $concept
754  * @param string $courseid
755  * @return array
756  */
757 function glossary_get_entries_search($concept, $courseid) {
758     global $CFG, $DB;
760     //Check if the user is an admin
761     $bypassadmin = 1; //This means NO (by default)
762     if (has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_SYSTEM))) {
763         $bypassadmin = 0; //This means YES
764     }
766     //Check if the user is a teacher
767     $bypassteacher = 1; //This means NO (by default)
768     if (has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $courseid))) {
769         $bypassteacher = 0; //This means YES
770     }
772     $conceptlower = moodle_strtolower(trim($concept));
774     $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
776     return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
777                                    FROM {glossary_entries} e, {glossary} g,
778                                         {course_modules} cm, {modules} m
779                                   WHERE m.name = 'glossary' AND
780                                         cm.module = m.id AND
781                                         (cm.visible = 1 OR  cm.visible = $bypassadmin OR
782                                             (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
783                                         g.id = cm.instance AND
784                                         e.glossaryid = g.id  AND
785                                         ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
786                                           (e.casesensitive = 0 and concept = :concept)) AND
787                                         (g.course = :courseid2 OR g.globalglossary = 1) AND
788                                          e.usedynalink != 0 AND
789                                          g.usedynalink != 0", $params);
792 /**
793  * @global object
794  * @global object
795  * @param object $course
796  * @param object $course
797  * @param object $glossary
798  * @param object $entry
799  * @param string $mode
800  * @param string $hook
801  * @param int $printicons
802  * @param int $displayformat
803  * @param bool $printview
804  * @return mixed
805  */
806 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $printview = false) {
807     global $USER, $CFG;
808     $return = false;
809     if ( $displayformat < 0 ) {
810         $displayformat = $glossary->displayformat;
811     }
812     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
813         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
814         if ($printview) {
815             $functionname = 'glossary_print_entry_'.$displayformat;
816         } else {
817             $functionname = 'glossary_show_entry_'.$displayformat;
818         }
820         if (file_exists($formatfile)) {
821             include_once($formatfile);
822             if (function_exists($functionname)) {
823                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
824             } else if ($printview) {
825                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
826                 $return = glossary_print_entry_default($entry, $glossary, $cm);
827             }
828         }
829     }
830     return $return;
833 /**
834  * Default (old) print format used if custom function doesn't exist in format
835  *
836  * @param object $entry
837  * @param object $glossary
838  * @param object $cm
839  * @return void Output is echo'd
840  */
841 function glossary_print_entry_default ($entry, $glossary, $cm) {
842     echo '<h3>'. strip_tags($entry->concept) . ': </h3>';
844     $definition = $entry->definition;
846     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
848     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
849     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
851     $options = new object();
852     $options->para = false;
853     $options->trusted = $entry->definitiontrust;
854     $definition = format_text($definition, $entry->definitionformat, $options);
855     echo ($definition);
856     echo '<br /><br />';
859 /**
860  * Print glossary concept/term as a heading &lt;h3>
861  * @param object $entry
862  */
863 function  glossary_print_entry_concept($entry, $return=false) {
864     global $OUTPUT;
865     $options = new object();
866     $options->para = false;
867     $text = format_text($OUTPUT->heading('<span class="nolink">' . $entry->concept . '</span>', 3, 'nolink'), FORMAT_MOODLE, $options);
868     if (!empty($entry->highlight)) {
869         $text = highlight($entry->highlight, $text);
870     }
872     if ($return) {
873         return $text;
874     } else {
875         echo $text;
876     }
879 /**
880  *
881  * @global object
882  * @global array
883  * @param object $entry
884  * @param object $glossary
885  * @param object $cm
886  */
887 function glossary_print_entry_definition($entry, $glossary, $cm) {
888     global $DB;
890     $definition = $entry->definition;
892     global $GLOSSARY_EXCLUDECONCEPTS;
894     //Calculate all the strings to be no-linked
895     //First, the concept
896     $GLOSSARY_EXCLUDECONCEPTS=array($entry->concept);
897     //Now the aliases
898     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
899         foreach ($aliases as $alias) {
900             $GLOSSARY_EXCLUDECONCEPTS[]=trim($alias->alias);
901         }
902     }
904     $options = new object();
905     $options->para = false;
906     $options->trusted = $entry->definitiontrust;
908     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
909     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
911     $text = format_text($definition, $entry->definitionformat, $options);
913     // Stop excluding concepts from autolinking
914     unset($GLOSSARY_EXCLUDECONCEPTS);
916     if (!empty($entry->highlight)) {
917         $text = highlight($entry->highlight, $text);
918     }
919     if (isset($entry->footer)) {   // Unparsed footer info
920         $text .= $entry->footer;
921     }
922     echo $text;
925 /**
926  *
927  * @global object
928  * @param object $course
929  * @param object $cm
930  * @param object $glossary
931  * @param object $entry
932  * @param string $mode
933  * @param string $hook
934  * @param string $type
935  * @return string|void
936  */
937 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
938     global $DB;
940     $return = '';
941     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
942         foreach ($aliases as $alias) {
943             if (trim($alias->alias)) {
944                 if ($return == '') {
945                     $return = '<select style="font-size:8pt">';
946                 }
947                 $return .= "<option>$alias->alias</option>";
948             }
949         }
950         if ($return != '') {
951             $return .= '</select>';
952         }
953     }
954     if ($type == 'print') {
955         echo $return;
956     } else {
957         return $return;
958     }
961 /**
962  *
963  * @global object
964  * @global object
965  * @global object
966  * @param object $course
967  * @param object $cm
968  * @param object $glossary
969  * @param object $entry
970  * @param string $mode
971  * @param string $hook
972  * @param string $type
973  * @return string|void
974  */
975 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
976     global $USER, $CFG, $DB, $OUTPUT;
978     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
980     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
981     $importedentry = ($entry->sourceglossaryid == $glossary->id);
982     $ismainglossary = $glossary->mainglossary;
985     $return = '<span class="commands">';
986     // Differentiate links for each entry.
987     $altsuffix = ': '.strip_tags(format_text($entry->concept));
989     if (!$entry->approved) {
990         $output = true;
991         $return .= get_string('entryishidden','glossary');
992     }
994     if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $entry->userid == $USER->id)) {
995         // only teachers can export entries so check it out
996         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
997             $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
998             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
999                 $output = true;
1000                 $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>';
1001             }
1002         }
1004         if ( $entry->sourceglossaryid ) {
1005             $icon = $OUTPUT->pix_url('minus', 'glossary');   // graphical metaphor (minus) for deleting an imported entry
1006         } else {
1007             $icon = $OUTPUT->pix_url('t/delete');
1008         }
1010         //Decide if an entry is editable:
1011         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
1012         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1013         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
1014         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1015             $output = true;
1016             $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=\"";
1017             $return .= $icon;
1018             $return .= "\" class=\"iconsmall\" alt=\"" . get_string("delete") .$altsuffix."\" /></a> ";
1020             $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>";
1021         } elseif ( $importedentry ) {
1022             $return .= " <font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1023         }
1024     }
1025     if (has_capability('mod/glossary:exportentry', $context)
1026         || ($entry->userid == $USER->id
1027             && has_capability('mod/glossary:exportownentry', $context))) {
1028         require_once($CFG->libdir . '/portfoliolib.php');
1029         $button = new portfolio_add_button();
1030         $button->set_callback_options('glossary_entry_portfolio_caller',  array('id' => $cm->id, 'entryid' => $entry->id), '/mod/glossary/locallib.php');
1032         $filecontext = $context;
1033         if ($entry->sourceglossaryid == $cm->instance) {
1034             if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1035                 $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1036             }
1037         }
1038         $fs = get_file_storage();
1039         if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1040             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1041         } else {
1042             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1043         }
1045         $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1046     }
1047     $return .= "&nbsp;&nbsp;"; // just to make up a little the output in Mozilla ;)
1049     $return .= '</span>';
1051     if (has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1052         $output = true;
1053         if (!empty($CFG->usecomments)) {
1054             require_once($CFG->dirroot . '/comment/lib.php');
1055             $cmt = new stdclass;
1056             $cmt->pluginname = 'glossary';
1057             $cmt->context  = $context;
1058             $cmt->course   = $course;
1059             $cmt->cm       = $cm;
1060             $cmt->area     = 'glossary_entry';
1061             $cmt->itemid   = $entry->id;
1062             $cmt->showcount = true;
1063             $comment = new comment($cmt);
1064             $return .= '<div>'.$comment->output(true).'</div>';
1065         }
1066     }
1068     //If we haven't calculated any REAL thing, delete result ($return)
1069     if (!$output) {
1070         $return = '';
1071     }
1072     //Print or get
1073     if ($type == 'print') {
1074         echo $return;
1075     } else {
1076         return $return;
1077     }
1080 /**
1081  * @param object $course
1082  * @param object $cm
1083  * @param object $glossary
1084  * @param object $entry
1085  * @param string $mode
1086  * @param object $hook
1087  * @param bool $printicons
1088  * @param bool $aliases
1089  * @return void
1090  */
1091 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1092     if ($aliases) {
1093         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1094     }
1095     $icons   = '';
1096     if ($printicons) {
1097         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1098     }
1099     if ($aliases || $icons || !empty($entry->rating)) {
1100         echo '<table>';
1101         if ( $aliases ) {
1102             echo '<tr valign="top"><td class="aliases">' .
1103                   get_string('aliases','glossary').': '.$aliases . '</td></tr>';
1104         }
1105         if ($icons) {
1106             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1107         }
1108         if (!empty($entry->rating)) {
1109             echo '<tr valign="top"><td class="ratings">';
1110             glossary_print_entry_ratings($course, $entry);
1111             echo '</td></tr>';
1112         }
1113         echo '</table>';
1114     }
1117 /**
1118  * @todo Document this function
1119  */
1120 function glossary_print_entry_attachment($entry, $cm, $format=NULL, $align="right", $insidetable=true) {
1121 ///   valid format values: html  : Return the HTML link for the attachment as an icon
1122 ///                        text  : Return the HTML link for tha attachment as text
1123 ///                        blank : Print the output to the screen
1124     if ($entry->attachment) {
1125           if ($insidetable) {
1126               echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
1127           }
1128           echo glossary_print_attachments($entry, $cm, $format, $align);
1129           if ($insidetable) {
1130               echo "</td></tr></table>\n";
1131           }
1132     }
1135 /**
1136  * @global object
1137  * @param object $cm
1138  * @param object $entry
1139  * @param string $mode
1140  * @param string $align
1141  * @param bool $insidetable
1142  */
1143 function  glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1144     global $CFG, $OUTPUT;
1146     if ($mode == 'approval' and !$entry->approved) {
1147         if ($insidetable) {
1148             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1149         }
1150         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>';
1151         if ($insidetable) {
1152             echo '</td></tr></table>';
1153         }
1154     }
1157 /**
1158  * It returns all entries from all glossaries that matches the specified criteria
1159  *  within a given $course. It performs an $extended search if necessary.
1160  * It restrict the search to only one $glossary if the $glossary parameter is set.
1161  *
1162  * @global object
1163  * @global object
1164  * @param object $course
1165  * @param array $searchterms
1166  * @param int $extended
1167  * @param object $glossary
1168  * @return array
1169  */
1170 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1171     global $CFG, $DB;
1173     if ( !$glossary ) {
1174         if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1175             $glos = "";
1176             foreach ( $glossaries as $glossary ) {
1177                 $glos .= "$glossary->id,";
1178             }
1179             $glos = substr($glos,0,-1);
1180         }
1181     } else {
1182         $glos = $glossary->id;
1183     }
1185     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $glossary->course))) {
1186         $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1187         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1188         $onlyvisibletable = ", {course_modules} cm";
1189     } else {
1191         $onlyvisible = "";
1192         $onlyvisibletable = "";
1193     }
1195     if ($DB->sql_regex_supported()) {
1196         $REGEXP    = $DB->sql_regex(true);
1197         $NOTREGEXP = $DB->sql_regex(false);
1198     }
1199     $LIKE = $DB->sql_ilike(); // case-insensitive
1201     $searchcond = array();
1202     $params     = array();
1203     $i = 0;
1205     $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1208     foreach ($searchterms as $searchterm) {
1209         $i++;
1211         $NOT = ''; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1212                    /// will use it to simulate the "-" operator with LIKE clause
1214     /// Under Oracle and MSSQL, trim the + and - operators and perform
1215     /// simpler LIKE (or NOT LIKE) queries
1216         if (!$DB->sql_regex_supported()) {
1217             if (substr($searchterm, 0, 1) == '-') {
1218                 $NOT = ' NOT ';
1219             }
1220             $searchterm = trim($searchterm, '+-');
1221         }
1223         // TODO: +- may not work for non latin languages
1225         if (substr($searchterm,0,1) == '+') {
1226             $searchterm = trim($searchterm, '+-');
1227             $searchterm = preg_quote($searchterm, '|');
1228             $searchcond[] = "$concat $REGEXP :ss$i";
1229             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1231         } else if (substr($searchterm,0,1) == "-") {
1232             $searchterm = trim($searchterm, '+-');
1233             $searchterm = preg_quote($searchterm, '|');
1234             $searchcond[] = "$concat $NOTREGEXP :ss$i";
1235             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1237         } else {
1238             $searchcond[] = "$concat $NOT $LIKE :ss$i";
1239             $params['ss'.$i] = "%$searchterm%";
1240         }
1241     }
1243     if (empty($searchcond)) {
1244         $totalcount = 0;
1245         return array();
1246     }
1248     $searchcond = implode(" AND ", $searchcond);
1250     $sql = "SELECT e.*
1251               FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1252              WHERE $searchcond
1253                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1254                AND g.id IN ($glos) AND e.approved <> 0";
1256     return $DB->get_records_sql($sql, $params);
1259 /**
1260  * @global object
1261  * @param array $searchterms
1262  * @param object $glossary
1263  * @param bool $extended
1264  * @return array
1265  */
1266 function glossary_search_entries($searchterms, $glossary, $extended) {
1267     global $DB;
1269     $course = $DB->get_record("course", array("id"=>$glossary->course));
1270     return glossary_search($course,$searchterms,$extended,$glossary);
1273 /**
1274  * if return=html, then return a html string.
1275  * if return=text, then return a text-only string.
1276  * otherwise, print HTML for non-images, and return image HTML
1277  *     if attachment is an image, $align set its aligment.
1278  *
1279  * @global object
1280  * @global object
1281  * @param object $entry
1282  * @param object $cm
1283  * @param string $type html, txt, empty
1284  * @param string $align left or right
1285  * @return string image string or nothing depending on $type param
1286  */
1287 function glossary_print_attachments($entry, $cm, $type=NULL, $align="left") {
1288     global $CFG, $DB, $OUTPUT;
1290     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
1291         return '';
1292     }
1294     if ($entry->sourceglossaryid == $cm->instance) {
1295         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1296             return '';
1297         }
1298         $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1300     } else {
1301         $filecontext = $context;
1302     }
1304     $strattachment = get_string('attachment', 'glossary');
1306     $fs = get_file_storage();
1308     $imagereturn = '';
1309     $output = '';
1311     if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1312         foreach ($files as $file) {
1313             $filename = $file->get_filename();
1314             $mimetype = $file->get_mimetype();
1315             $iconimage = '<img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />';
1316             $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename);
1318             if ($type == 'html') {
1319                 $output .= "<a href=\"$path\">$iconimage</a> ";
1320                 $output .= "<a href=\"$path\">".s($filename)."</a>";
1321                 $output .= "<br />";
1323             } else if ($type == 'text') {
1324                 $output .= "$strattachment ".s($filename).":\n$path\n";
1326             } else {
1327                 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1328                     // Image attachments don't get printed as links
1329                     $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1330                 } else {
1331                     $output .= "<a href=\"$path\">$iconimage</a> ";
1332                     $output .= filter_text("<a href=\"$path\">".s($filename)."</a>");
1333                     $output .= '<br />';
1334                 }
1335             }
1336         }
1337     }
1339     if ($type) {
1340         return $output;
1341     } else {
1342         echo $output;
1343         return $imagereturn;
1344     }
1347 /**
1348  * Lists all browsable file areas
1349  *
1350  * @param object $course
1351  * @param object $cm
1352  * @param object $context
1353  * @return array
1354  */
1355 function glossary_get_file_areas($course, $cm, $context) {
1356     $areas = array();
1357     return $areas;
1360 /**
1361  * Serves the glossary attachments. Implements needed access control ;-)
1362  *
1363  * @param object $course
1364  * @param object $cm
1365  * @param object $context
1366  * @param string $filearea
1367  * @param array $args
1368  * @param bool $forcedownload
1369  * @return bool false if file not found, does not return if found - justsend the file
1370  */
1371 function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
1372     global $CFG, $DB;
1374     if ($context->contextlevel != CONTEXT_MODULE) {
1375         return false;
1376     }
1378     require_course_login($course, true, $cm);
1380     if ($filearea === 'attachment' or $filearea === 'entry') {
1381         $entryid = (int)array_shift($args);
1383         require_course_login($course, true, $cm);
1385         if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1386             return false;
1387         }
1389         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1390             return false;
1391         }
1393         if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1394             return false;
1395         }
1397         // this trickery here is because we need to support source glossary access
1399         if ($entry->glossaryid == $cm->instance) {
1400             $filecontext = $context;
1402         } else if ($entry->sourceglossaryid == $cm->instance) {
1403             if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1404                 return false;
1405             }
1406             $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1408         } else {
1409             return false;
1410         }
1412         $relativepath = implode('/', $args);
1413         $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath";
1415         $fs = get_file_storage();
1416         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1417             return false;
1418         }
1420         // finally send the file
1421         send_stored_file($file, 0, 0, true); // download MUST be forced - security!
1422     }
1424     return false;
1427 /**
1428  *
1429  */
1430 function glossary_print_tabbed_table_end() {
1431      echo "</div></div>";
1434 /**
1435  * @param object $cm
1436  * @param object $glossary
1437  * @param string $mode
1438  * @param string $hook
1439  * @param string $sortkey
1440  * @param string $sortorder
1441  */
1442 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1443     if ($glossary->showalphabet) {
1444         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1445     }
1446     glossary_print_special_links($cm, $glossary, $mode, $hook);
1448     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1450     glossary_print_all_links($cm, $glossary, $mode, $hook);
1452     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1454 /**
1455  * @param object $cm
1456  * @param object $glossary
1457  * @param string $hook
1458  * @param string $sortkey
1459  * @param string $sortorder
1460  */
1461 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1462     echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1465 /**
1466  * @param object $cm
1467  * @param object $glossary
1468  * @param string $hook
1469  * @param string $sortkey
1470  * @param string $sortorder
1471  */
1472 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1473     echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1475 /**
1476  * @param object $cm
1477  * @param object $glossary
1478  * @param string $hook
1479  * @param string $sortkey
1480  * @param string $sortorder
1481  */
1482 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1483     if ( $mode != 'date' ) {
1484         if ($glossary->showalphabet) {
1485             echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1486         }
1488         glossary_print_special_links($cm, $glossary, $mode, $hook);
1490         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1492         glossary_print_all_links($cm, $glossary, $mode, $hook);
1493     } else {
1494         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1495     }
1498 /**
1499  * @param object $cm
1500  * @param object $glossary
1501  * @param string $hook
1502  * @param string $sortkey
1503  * @param string $sortorder
1504  */
1505 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1506     if ($glossary->showalphabet) {
1507         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1508     }
1510     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1511     glossary_print_all_links($cm, $glossary, $mode, $hook);
1512     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1515 /**
1516  * @global object
1517  * @global object
1518  * @param object $cm
1519  * @param object $glossary
1520  * @param string $hook
1521  * @param object $category
1522  */
1523 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1524      global $CFG, $DB, $OUTPUT;
1526      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1528      echo '<table border="0" width="100%">';
1529      echo '<tr>';
1531      echo '<td align="center" style="width:20%">';
1532      if (has_capability('mod/glossary:managecategories', $context)) {
1533              $options['id'] = $cm->id;
1534              $options['mode'] = 'cat';
1535              $options['hook'] = $hook;
1536              echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1537      }
1538      echo '</td>';
1540      echo '<td align="center" style="width:60%">';
1541      echo '<b>';
1543      $menu = array();
1544      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1545      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1547      $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1548      $selected = '';
1549      if ( $categories ) {
1550           foreach ($categories as $currentcategory) {
1551                  $url = $currentcategory->id;
1552                  if ( $category ) {
1553                      if ($currentcategory->id == $category->id) {
1554                          $selected = $url;
1555                      }
1556                  }
1557                  $menu[$url] = clean_text($currentcategory->name); //Only clean, not filters
1558           }
1559      }
1560      if ( !$selected ) {
1561          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1562      }
1564      if ( $category ) {
1565         echo format_text($category->name, FORMAT_PLAIN);
1566      } else {
1567         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1569             echo get_string("entrieswithoutcategory","glossary");
1570             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1572         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1574             echo get_string("allcategories","glossary");
1575             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1577         }
1578      }
1579      echo '</b></td>';
1580      echo '<td align="center" style="width:20%">';
1582      $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1583      echo $OUTPUT->render($select);
1585      echo '</td>';
1586      echo '</tr>';
1588      echo '</table>';
1591 /**
1592  * @global object
1593  * @param object $cm
1594  * @param object $glossary
1595  * @param string $mode
1596  * @param string $hook
1597  */
1598 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1599 global $CFG;
1600      if ( $glossary->showall) {
1601          $strallentries       = get_string("allentries", "glossary");
1602          if ( $hook == 'ALL' ) {
1603               echo "<b>$strallentries</b>";
1604          } else {
1605               $strexplainall = strip_tags(get_string("explainall","glossary"));
1606               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1607          }
1608      }
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_special_links($cm, $glossary, $mode, $hook) {
1619 global $CFG;
1620      if ( $glossary->showspecial) {
1621          $strspecial          = get_string("special", "glossary");
1622          if ( $hook == 'SPECIAL' ) {
1623               echo "<b>$strspecial</b> | ";
1624          } else {
1625               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1626               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
1627          }
1628      }
1631 /**
1632  * @global object
1633  * @param object $glossary
1634  * @param string $mode
1635  * @param string $hook
1636  * @param string $sortkey
1637  * @param string $sortorder
1638  */
1639 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1640 global $CFG;
1641      if ( $glossary->showalphabet) {
1642           $alphabet = explode(",", get_string('alphabet', 'langconfig'));
1643           for ($i = 0; $i < count($alphabet); $i++) {
1644               if ( $hook == $alphabet[$i] and $hook) {
1645                    echo "<b>$alphabet[$i]</b>";
1646               } else {
1647                    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>";
1648               }
1649               echo ' | ';
1650           }
1651      }
1654 /**
1655  * @global object
1656  * @param object $cm
1657  * @param string $mode
1658  * @param string $sortkey
1659  * @param string $sortorder
1660  */
1661 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
1662     global $CFG, $OUTPUT;
1664     $asc    = get_string("ascending","glossary");
1665     $desc   = get_string("descending","glossary");
1666     $bopen  = '<b>';
1667     $bclose = '</b>';
1669      $neworder = '';
1670      $currentorder = '';
1671      $currentsort = '';
1672      if ( $sortorder ) {
1673          if ( $sortorder == 'asc' ) {
1674              $currentorder = $asc;
1675              $neworder = '&amp;sortorder=desc';
1676              $newordertitle = get_string('changeto', 'glossary', $desc);
1677          } else {
1678              $currentorder = $desc;
1679              $neworder = '&amp;sortorder=asc';
1680              $newordertitle = get_string('changeto', 'glossary', $asc);
1681          }
1682          $icon = " <img src=\"".$OUTPUT->pix_url($sortorder, 'glossary')."\" class=\"icon\" alt=\"$newordertitle\" />";
1683      } else {
1684          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
1685                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
1686              $icon = "";
1687              $newordertitle = $asc;
1688          } else {
1689              $newordertitle = $desc;
1690              $neworder = '&amp;sortorder=desc';
1691              $icon = ' <img src="'.$OUTPUT->pix_url('asc', 'glossary').'" class="icon" alt="'.$newordertitle.'" />';
1692          }
1693      }
1694      $ficon     = '';
1695      $fneworder = '';
1696      $fbtag     = '';
1697      $fendbtag  = '';
1699      $sicon     = '';
1700      $sneworder = '';
1702      $sbtag      = '';
1703      $fbtag      = '';
1704      $fendbtag      = '';
1705      $sendbtag      = '';
1707      $sendbtag  = '';
1709      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
1710          $ficon       = $icon;
1711          $fneworder   = $neworder;
1712          $fordertitle = $newordertitle;
1713          $sordertitle = $asc;
1714          $fbtag       = $bopen;
1715          $fendbtag    = $bclose;
1716      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
1717          $sicon = $icon;
1718          $sneworder   = $neworder;
1719          $fordertitle = $asc;
1720          $sordertitle = $newordertitle;
1721          $sbtag       = $bopen;
1722          $sendbtag    = $bclose;
1723      } else {
1724          $fordertitle = $asc;
1725          $sordertitle = $asc;
1726      }
1728      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
1729          $forder = 'CREATION';
1730          $sorder =  'UPDATE';
1731          $fsort  = get_string("sortbycreation", "glossary");
1732          $ssort  = get_string("sortbylastupdate", "glossary");
1734          $currentsort = $fsort;
1735          if ($sortkey == 'UPDATE') {
1736              $currentsort = $ssort;
1737          }
1738          $sort        = get_string("sortchronogically", "glossary");
1739      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
1740          $forder = 'FIRSTNAME';
1741          $sorder =  'LASTNAME';
1742          $fsort  = get_string("firstname");
1743          $ssort  = get_string("lastname");
1745          $currentsort = $fsort;
1746          if ($sortkey == 'LASTNAME') {
1747              $currentsort = $ssort;
1748          }
1749          $sort        = get_string("sortby", "glossary");
1750      }
1751      $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
1752      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 | ".
1753                           "$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 />";
1756 /**
1757  *
1758  * @param object $entry0
1759  * @param object $entry1
1760  * @return int [-1 | 0 | 1]
1761  */
1762 function glossary_sort_entries ( $entry0, $entry1 ) {
1764     if ( moodle_strtolower(ltrim($entry0->concept)) < moodle_strtolower(ltrim($entry1->concept)) ) {
1765         return -1;
1766     } elseif ( moodle_strtolower(ltrim($entry0->concept)) > moodle_strtolower(ltrim($entry1->concept)) ) {
1767         return 1;
1768     } else {
1769         return 0;
1770     }
1774 /**
1775  * @global object
1776  * @global object
1777  * @global object
1778  * @param object $course
1779  * @param object $entry
1780  * @return bool
1781  */
1782 function  glossary_print_entry_ratings($course, $entry) {
1783     global $OUTPUT;
1784     if( !empty($entry->rating) ){
1785         echo $OUTPUT->render($entry->rating);
1786     }
1789 /**
1790  *
1791  * @global object
1792  * @global object
1793  * @global object
1794  * @param int $courseid
1795  * @param array $entries
1796  * @param int $displayformat
1797  */
1798 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
1799     global $USER,$CFG, $DB;
1801     echo '<div class="boxaligncenter">';
1802     echo '<table class="glossarypopup" cellspacing="0"><tr>';
1803     echo '<td>';
1804     if ( $entries ) {
1805         foreach ( $entries as $entry ) {
1806             if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
1807                 print_error('invalidid', 'glossary');
1808             }
1809             if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
1810                 print_error('coursemisconf');
1811             }
1812             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
1813                 print_error('invalidid', 'glossary');
1814             }
1816             //If displayformat is present, override glossary->displayformat
1817             if ($displayformat < 0) {
1818                 $dp = $glossary->displayformat;
1819             } else {
1820                 $dp = $displayformat;
1821             }
1823             //Get popupformatname
1824             $format = $DB->get_record('glossary_formats', array('name'=>$dp));
1825             $displayformat = $format->popupformatname;
1827             //Check displayformat variable and set to default if necessary
1828             if (!$displayformat) {
1829                 $displayformat = 'dictionary';
1830             }
1832             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1833             $functionname = 'glossary_show_entry_'.$displayformat;
1835             if (file_exists($formatfile)) {
1836                 include_once($formatfile);
1837                 if (function_exists($functionname)) {
1838                     $functionname($course, $cm, $glossary, $entry,'','','','');
1839                 }
1840             }
1841         }
1842     }
1843     echo '</td>';
1844     echo '</tr></table></div>';
1847 /**
1848  *
1849  * @global object
1850  * @param array $entries
1851  * @param array $aliases
1852  * @param array $categories
1853  * @return string
1854  */
1855 function glossary_generate_export_csv($entries, $aliases, $categories) {
1856     global $CFG;
1857     $csv = '';
1858     $delimiter = '';
1859     require_once($CFG->libdir . '/csvlib.class.php');
1860     $delimiter = csv_import_reader::get_delimiter('comma');
1861     $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
1862     $csvaliases = array(0 => array());
1863     $csvcategories = array(0 => array());
1864     $aliascount = 0;
1865     $categorycount = 0;
1867     foreach ($entries as $entry) {
1868         $thisaliasesentry = array();
1869         $thiscategoriesentry = array();
1870         $thiscsventry = array($entry->concept, nl2br($entry->definition));
1872         if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
1873             $thiscount = count($aliases[$entry->id]);
1874             if ($thiscount > $aliascount) {
1875                 $aliascount = $thiscount;
1876             }
1877             foreach ($aliases[$entry->id] as $alias) {
1878                 $thisaliasesentry[] = trim($alias);
1879             }
1880         }
1881         if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
1882             $thiscount = count($categories[$entry->id]);
1883             if ($thiscount > $categorycount) {
1884                 $categorycount = $thiscount;
1885             }
1886             foreach ($categories[$entry->id] as $catentry) {
1887                 $thiscategoriesentry[] = trim($catentry);
1888             }
1889         }
1890         $csventries[$entry->id] = $thiscsventry;
1891         $csvaliases[$entry->id] = $thisaliasesentry;
1892         $csvcategories[$entry->id] = $thiscategoriesentry;
1894     }
1895     $returnstr = '';
1896     foreach ($csventries as $id => $row) {
1897         $aliasstr = '';
1898         $categorystr = '';
1899         if ($id == 0) {
1900             $aliasstr = get_string('alias', 'glossary');
1901             $categorystr = get_string('category', 'glossary');
1902         }
1903         $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
1904         $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
1905     }
1906     return $returnstr;
1909 /**
1910  * @todo Check whether the third argument is valid
1911  * @global object
1912  * @global object
1913  * @param object $glossary
1914  * @param string $hook
1915  * @param int $hook
1916  * @return string
1917  */
1918 function glossary_generate_export_file($glossary, $hook = "", $hook = 0) {
1919     global $CFG, $DB;
1921     $co  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1923     $co .= glossary_start_tag("GLOSSARY",0,true);
1924     $co .= glossary_start_tag("INFO",1,true);
1925         $co .= glossary_full_tag("NAME",2,false,$glossary->name);
1926         $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
1927         $co .= glossary_full_tag("INTROFORMAT",2,false,$glossary->introformat);
1928         $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
1929         $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
1930         $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
1931         $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
1932         $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
1933         $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
1934         $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
1935         $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
1936         $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
1937         $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
1939         if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) {
1940             $co .= glossary_start_tag("ENTRIES",2,true);
1941             foreach ($entries as $entry) {
1942                 $permissiongranted = 1;
1943                 if ( $hook ) {
1944                     switch ( $hook ) {
1945                     case "ALL":
1946                     case "SPECIAL":
1947                     break;
1948                     default:
1949                         $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
1950                     break;
1951                     }
1952                 }
1953                 if ( $hook ) {
1954                     switch ( $hook ) {
1955                     case GLOSSARY_SHOW_ALL_CATEGORIES:
1956                     break;
1957                     case GLOSSARY_SHOW_NOT_CATEGORISED:
1958                         $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id));
1959                     break;
1960                     default:
1961                         $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook));
1962                     break;
1963                     }
1964                 }
1965                 if ( $entry->approved and $permissiongranted ) {
1966                     $co .= glossary_start_tag("ENTRY",3,true);
1967                     $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
1968                     $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition);
1969                     $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat); // note: use old name for BC reasons
1970                     $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
1971                     $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
1972                     $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
1973                     $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
1975                     if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) {
1976                         $co .= glossary_start_tag("ALIASES",4,true);
1977                         foreach ($aliases as $alias) {
1978                             $co .= glossary_start_tag("ALIAS",5,true);
1979                                 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
1980                             $co .= glossary_end_tag("ALIAS",5,true);
1981                         }
1982                         $co .= glossary_end_tag("ALIASES",4,true);
1983                     }
1984                     if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) {
1985                         $co .= glossary_start_tag("CATEGORIES",4,true);
1986                         foreach ($catentries as $catentry) {
1987                             $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid));
1989                             $co .= glossary_start_tag("CATEGORY",5,true);
1990                                 $co .= glossary_full_tag("NAME",6,false,$category->name);
1991                                 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
1992                             $co .= glossary_end_tag("CATEGORY",5,true);
1993                         }
1994                         $co .= glossary_end_tag("CATEGORIES",4,true);
1995                     }
1997                     $co .= glossary_end_tag("ENTRY",3,true);
1998                 }
1999             }
2000             $co .= glossary_end_tag("ENTRIES",2,true);
2002         }
2005     $co .= glossary_end_tag("INFO",1,true);
2006     $co .= glossary_end_tag("GLOSSARY",0,true);
2008     return $co;
2010 /// Functions designed by Eloy Lafuente
2011 /// Functions to create, open and write header of the xml file
2013 /**
2014  * Read import file and convert to current charset
2015  *
2016  * @global object
2017  * @param string $file
2018  * @return string
2019  */
2020 function glossary_read_imported_file($file_content) {
2021     require_once "../../lib/xmlize.php";
2022     global $CFG;
2024     return xmlize($file_content, 0);
2027 /**
2028  * Return the xml start tag
2029  *
2030  * @param string $tag
2031  * @param int $level
2032  * @param bool $endline
2033  * @return string
2034  */
2035 function glossary_start_tag($tag,$level=0,$endline=false) {
2036         if ($endline) {
2037            $endchar = "\n";
2038         } else {
2039            $endchar = "";
2040         }
2041         return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
2044 /**
2045  * Return the xml end tag
2046  * @param string $tag
2047  * @param int $level
2048  * @param bool $endline
2049  * @return string
2050  */
2051 function glossary_end_tag($tag,$level=0,$endline=true) {
2052         if ($endline) {
2053            $endchar = "\n";
2054         } else {
2055            $endchar = "";
2056         }
2057         return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
2060 /**
2061  * Return the start tag, the contents and the end tag
2062  *
2063  * @global object
2064  * @param string $tag
2065  * @param int $level
2066  * @param bool $endline
2067  * @param string $content
2068  * @return string
2069  */
2070 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
2071         global $CFG;
2073         $st = glossary_start_tag($tag,$level,$endline);
2074         $co = preg_replace("/\r\n|\r/", "\n", s($content));
2075         $et = glossary_end_tag($tag,0,true);
2076         return $st.$co.$et;
2079 /**
2080  * How many unrated entries are in the given glossary for a given user?
2081  *
2082  * @global object
2083  * @param int $glossaryid
2084  * @param int $userid
2085  * @return int
2086  */
2087 function glossary_count_unrated_entries($glossaryid, $userid) {
2088     global $DB;
2089     if ($entries = $DB->get_record_sql("SELECT count('x') as num
2090                                           FROM {glossary_entries}
2091                                          WHERE glossaryid = ? AND userid <> ?", array($glossaryid, $userid))) {
2093         if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2094             return 0;
2095         }
2096         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2098         if ($rated = $DB->get_record_sql("SELECT count(*) as num
2099                                             FROM {glossary_entries} e, {ratings} r
2100                                            WHERE e.glossaryid = :glossaryid AND e.id = r.itemid
2101                                                  AND r.userid = :userid and r.contextid = :contextid",
2102                 array('glossaryid'=>$glossaryid, 'userid'=>$userid, 'contextid'=>$context->id))) {
2104             $difference = $entries->num - $rated->num;
2105             if ($difference > 0) {
2106                 return $difference;
2107             } else {
2108                 return 0;    // Just in case there was a counting error
2109             }
2110         } else {
2111             return $entries->num;
2112         }
2113     } else {
2114         return 0;
2115     }
2118 /**
2119  *
2120  * Returns the html code to represent any pagging bar. Paramenters are:
2121  *
2122  * The function dinamically show the first and last pages, and "scroll" over pages.
2123  * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
2124  * could replace the general one. ;-)
2125  *
2126  * @param int $totalcount total number of records to be displayed
2127  * @param int $page page currently selected (0 based)
2128  * @param int $perpage number of records per page
2129  * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically.
2130  *
2131  * @param int $maxpageallowed Optional maximum number of page allowed.
2132  * @param int $maxdisplay Optional maximum number of page links to show in the bar
2133  * @param string $separator Optional string to be used between pages in the bar
2134  * @param string $specialtext Optional string to be showed as an special link
2135  * @param string $specialvalue Optional value (page) to be used in the special link
2136  * @param bool $previousandnext Optional to decide if we want the previous and next links
2137  * @return string
2138  */
2139 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) {
2141     $code = '';
2143     $showspecial = false;
2144     $specialselected = false;
2146     //Check if we have to show the special link
2147     if (!empty($specialtext)) {
2148         $showspecial = true;
2149     }
2150     //Check if we are with the special link selected
2151     if ($showspecial && $page == $specialvalue) {
2152         $specialselected = true;
2153     }
2155     //If there are results (more than 1 page)
2156     if ($totalcount > $perpage) {
2157         $code .= "<div style=\"text-align:center\">";
2158         $code .= "<p>".get_string("page").":";
2160         $maxpage = (int)(($totalcount-1)/$perpage);
2162         //Lower and upper limit of page
2163         if ($page < 0) {
2164             $page = 0;
2165         }
2166         if ($page > $maxpageallowed) {
2167             $page = $maxpageallowed;
2168         }
2169         if ($page > $maxpage) {
2170             $page = $maxpage;
2171         }
2173         //Calculate the window of pages
2174         $pagefrom = $page - ((int)($maxdisplay / 2));
2175         if ($pagefrom < 0) {
2176             $pagefrom = 0;
2177         }
2178         $pageto = $pagefrom + $maxdisplay - 1;
2179         if ($pageto > $maxpageallowed) {
2180             $pageto = $maxpageallowed;
2181         }
2182         if ($pageto > $maxpage) {
2183             $pageto = $maxpage;
2184         }
2186         //Some movements can be necessary if don't see enought pages
2187         if ($pageto - $pagefrom < $maxdisplay - 1) {
2188             if ($pageto - $maxdisplay + 1 > 0) {
2189                 $pagefrom = $pageto - $maxdisplay + 1;
2190             }
2191         }
2193         //Calculate first and last if necessary
2194         $firstpagecode = '';
2195         $lastpagecode = '';
2196         if ($pagefrom > 0) {
2197             $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2198             if ($pagefrom > 1) {
2199                 $firstpagecode .= "$separator...";
2200             }
2201         }
2202         if ($pageto < $maxpage) {
2203             if ($pageto < $maxpage -1) {
2204                 $lastpagecode = "$separator...";
2205             }
2206             $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2207         }
2209         //Previous
2210         if ($page > 0 && $previousandnext) {
2211             $pagenum = $page - 1;
2212             $code .= "&nbsp;(<a  href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;";
2213         }
2215         //Add first
2216         $code .= $firstpagecode;
2218         $pagenum = $pagefrom;
2220         //List of maxdisplay pages
2221         while ($pagenum <= $pageto) {
2222             $pagetoshow = $pagenum +1;
2223             if ($pagenum == $page && !$specialselected) {
2224                 $code .= "$separator<b>$pagetoshow</b>";
2225             } else {
2226                 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2227             }
2228             $pagenum++;
2229         }
2231         //Add last
2232         $code .= $lastpagecode;
2234         //Next
2235         if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2236             $pagenum = $page + 1;
2237             $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2238         }
2240         //Add special
2241         if ($showspecial) {
2242             $code .= '<br />';
2243             if ($specialselected) {
2244                 $code .= "<b>$specialtext</b>";
2245             } else {
2246                 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2247             }
2248         }
2250         //End html
2251         $code .= "</p>";
2252         $code .= "</div>";
2253     }
2255     return $code;
2257 /**
2258  * @return array
2259  */
2260 function glossary_get_view_actions() {
2261     return array('view','view all','view entry');
2263 /**
2264  * @return array
2265  */
2266 function glossary_get_post_actions() {
2267     return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry');
2271 /**
2272  * Implementation of the function for printing the form elements that control
2273  * whether the course reset functionality affects the glossary.
2274  * @param object $mform form passed by reference
2275  */
2276 function glossary_reset_course_form_definition(&$mform) {
2277     $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary'));
2278     $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary'));
2280     $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'),
2281                        array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple'));
2282     $mform->setAdvanced('reset_glossary_types');
2283     $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked');
2285     $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary'));
2286     $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked');
2288     $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings'));
2289     $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked');
2291     $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments'));
2292     $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked');
2295 /**
2296  * Course reset form defaults.
2297  * @return array
2298  */
2299 function glossary_reset_course_form_defaults($course) {
2300     return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0);
2303 /**
2304  * Removes all grades from gradebook
2305  *
2306  * @global object
2307  * @param int $courseid
2308  * @param string optional type
2309  */
2310 function glossary_reset_gradebook($courseid, $type='') {
2311     global $DB;
2313     switch ($type) {
2314         case 'main'      : $type = "AND g.mainglossary=1"; break;
2315         case 'secondary' : $type = "AND g.mainglossary=0"; break;
2316         default          : $type = ""; //all
2317     }
2319     $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid
2320               FROM {glossary} g, {course_modules} cm, {modules} m
2321              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type";
2323     if ($glossarys = $DB->get_records_sql($sql, array($courseid))) {
2324         foreach ($glossarys as $glossary) {
2325             glossary_grade_item_update($glossary, 'reset');
2326         }
2327     }
2329 /**
2330  * Actual implementation of the rest coures functionality, delete all the
2331  * glossary responses for course $data->courseid.
2332  *
2333  * @global object
2334  * @param $data the data submitted from the reset course.
2335  * @return array status array
2336  */
2337 function glossary_reset_userdata($data) {
2338     global $CFG, $DB;
2339     require_once($CFG->dirroot.'/rating/lib.php');
2341     $componentstr = get_string('modulenameplural', 'glossary');
2342     $status = array();
2344     $allentriessql = "SELECT e.id
2345                         FROM {glossary_entries} e
2346                              JOIN {glossary} g ON e.glossaryid = g.id
2347                        WHERE g.course = ?";
2349     $allglossariessql = "SELECT g.id
2350                            FROM {glossary} g
2351                           WHERE g.course = ?";
2353     $params = array($data->courseid);
2355     $fs = get_file_storage();
2357     $rm = new rating_manager();
2358     $ratingdeloptions = new stdclass();
2360     // delete entries if requested
2361     if (!empty($data->reset_glossary_all)
2362          or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) {
2364         $params[] = 'glossary_entry';
2365         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea=?", $params);
2366         $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2368         // now get rid of all attachments
2369         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2370             foreach ($glossaries as $glossaryid=>$unused) {
2371                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2372                     continue;
2373                 }
2374                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2375                 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2377                 //delete ratings
2378                 $ratingdeloptions->contextid = $context->id;
2379                 $rm->delete_ratings($ratingdeloptions);
2380             }
2381         }
2383         // remove all grades from gradebook
2384         if (empty($data->reset_gradebook_grades)) {
2385             glossary_reset_gradebook($data->courseid);
2386         }
2388         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2390     } else if (!empty($data->reset_glossary_types)) {
2391         $mainentriessql         = "$allentries AND g.mainglossary=1";
2392         $secondaryentriessql    = "$allentries AND g.mainglossary=0";
2394         $mainglossariessql      = "$allglossariessql AND g.mainglossary=1";
2395         $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2397         if (in_array('main', $data->reset_glossary_types)) {
2398             $params[] = 'glossary_entry';
2399             $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params);
2400             $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2402             if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2403                 foreach ($glossaries as $glossaryid=>$unused) {
2404                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2405                         continue;
2406                     }
2407                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2408                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2410                     //delete ratings
2411                     $ratingdeloptions->contextid = $context->id;
2412                     $rm->delete_ratings($ratingdeloptions);
2413                 }
2414             }
2416             // remove all grades from gradebook
2417             if (empty($data->reset_gradebook_grades)) {
2418                 glossary_reset_gradebook($data->courseid, 'main');
2419             }
2421             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary'), 'error'=>false);
2423         } else if (in_array('secondary', $data->reset_glossary_types)) {
2424             $params[] = 'glossary_entry';
2425             $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params);
2426             $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2427             // remove exported source flag from entries in main glossary
2428             $DB->execute("UPDATE {glossary_entries
2429                              SET sourceglossaryid=0
2430                            WHERE glossaryid IN ($mainglossariessql)", $params);
2432             if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2433                 foreach ($glossaries as $glossaryid=>$unused) {
2434                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2435                         continue;
2436                     }
2437                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2438                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2440                     //delete ratings
2441                     $ratingdeloptions->contextid = $context->id;
2442                     $rm->delete_ratings($ratingdeloptions);
2443                 }
2444             }
2446             // remove all grades from gradebook
2447             if (empty($data->reset_gradebook_grades)) {
2448                 glossary_reset_gradebook($data->courseid, 'secondary');
2449             }
2451             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2452         }
2453     }
2455     // remove entries by users not enrolled into course
2456     if (!empty($data->reset_glossary_notenrolled)) {
2457         $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2458                          FROM {glossary_entries} e
2459                               JOIN {glossary} g ON e.glossaryid = g.id
2460                               LEFT JOIN {user} u ON e.userid = u.id
2461                         WHERE g.course = ? AND e.userid > 0";
2463         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2464         $notenrolled = array();
2465         if ($rs = $DB->get_recordset_sql($entriessql, $params)) {
2466             foreach ($rs as $entry) {
2467                 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2468                   or !is_enrolled($course_context , $entry->userid)) {
2469                     $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id));
2470                     $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2472                     if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2473                         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2474                         $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
2476                         //delete ratings
2477                         $ratingdeloptions->contextid = $context->id;
2478                         $rm->delete_ratings($ratingdeloptions);
2479                     }
2480                 }
2481             }
2482             $rs->close();
2483             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2484         }
2485     }
2487     // remove all ratings
2488     if (!empty($data->reset_glossary_ratings)) {
2489         //remove ratings
2490         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2491             foreach ($glossaries as $glossaryid=>$unused) {
2492                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2493                     continue;
2494                 }
2495                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2497                 //delete ratings
2498                 $ratingdeloptions->contextid = $context->id;
2499                 $rm->delete_ratings($ratingdeloptions);
2500             }
2501         }
2503         // remove all grades from gradebook
2504         if (empty($data->reset_gradebook_grades)) {
2505             glossary_reset_gradebook($data->courseid);
2506         }
2507         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2508     }
2510     // remove comments
2511     if (!empty($data->reset_glossary_comments)) {
2512         $params[] = 'glossary_entry';
2513         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params);
2514         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2515     }
2517     /// updating dates - shift may be negative too
2518     if ($data->timeshift) {
2519         shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
2520         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2521     }
2523     return $status;
2526 /**
2527  * Returns all other caps used in module
2528  * @return array
2529  */
2530 function glossary_get_extra_capabilities() {
2531     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames', 'moodle/site:trustcontent', 'moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate');
2534 /**
2535  * @param string $feature FEATURE_xx constant for requested feature
2536  * @return mixed True if module supports feature, null if doesn't know
2537  */
2538 function glossary_supports($feature) {
2539     switch($feature) {
2540         case FEATURE_GROUPS:                  return false;
2541         case FEATURE_GROUPINGS:               return false;
2542         case FEATURE_GROUPMEMBERSONLY:        return true;
2543         case FEATURE_MOD_INTRO:               return true;
2544         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2545         case FEATURE_GRADE_HAS_GRADE:         return true;
2546         case FEATURE_GRADE_OUTCOMES:          return true;
2547         case FEATURE_RATE:                    return true;
2548         case FEATURE_BACKUP_MOODLE2:          return true;
2550         default: return null;
2551     }
2554 function glossary_extend_navigation($navigation, $course, $module, $cm) {
2555     global $CFG;
2556     $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'letter')));
2557     $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'cat')));
2558     $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'date')));
2559     $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'author')));
2562 /**
2563  * Adds module specific settings to the settings block
2564  *
2565  * @param settings_navigation $settings The settings navigation object
2566  * @param navigation_node $glossarynode The node to add module settings to
2567  */
2568 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
2569     global $PAGE, $DB, $CFG, $USER;
2571     $mode = optional_param('mode', '', PARAM_ALPHA);
2572     $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
2574     if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
2575         $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
2576     }
2578     if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
2579         $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
2580     }
2582     if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
2583         $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
2584     }
2586     if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
2587         $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
2588     }
2590     $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
2592     if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles) {
2593         require_once("$CFG->libdir/rsslib.php");
2595         $string = get_string('rsstype','forum');
2597         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_glossary', $glossary->id));
2598         $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2599     }