498036b9c29b04ce855f59dbe49b58fba912597f
[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');
27 require_once($CFG->libdir . '/completionlib.php');
29 define("GLOSSARY_SHOW_ALL_CATEGORIES", 0);
30 define("GLOSSARY_SHOW_NOT_CATEGORISED", -1);
32 define("GLOSSARY_NO_VIEW", -1);
33 define("GLOSSARY_STANDARD_VIEW", 0);
34 define("GLOSSARY_CATEGORY_VIEW", 1);
35 define("GLOSSARY_DATE_VIEW", 2);
36 define("GLOSSARY_AUTHOR_VIEW", 3);
37 define("GLOSSARY_ADDENTRY_VIEW", 4);
38 define("GLOSSARY_IMPORT_VIEW", 5);
39 define("GLOSSARY_EXPORT_VIEW", 6);
40 define("GLOSSARY_APPROVAL_VIEW", 7);
42 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
43 /**
44  * @global object
45  * @param object $glossary
46  * @return int
47  */
48 function glossary_add_instance($glossary) {
49     global $DB;
50 /// Given an object containing all the necessary data,
51 /// (defined by the form in mod_form.php) this function
52 /// will create a new instance and return the id number
53 /// of the new instance.
55     if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
56         $glossary->assesstimestart  = 0;
57         $glossary->assesstimefinish = 0;
58     }
60     if (empty($glossary->globalglossary) ) {
61         $glossary->globalglossary = 0;
62     }
64     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
65         $glossary->globalglossary = 0;
66     }
68     $glossary->timecreated  = time();
69     $glossary->timemodified = $glossary->timecreated;
71     //Check displayformat is a valid one
72     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
73     if (!in_array($glossary->displayformat, $formats)) {
74         print_error('unknowformat', '', '', $glossary->displayformat);
75     }
77     $returnid = $DB->insert_record("glossary", $glossary);
78     $glossary->id = $returnid;
79     glossary_grade_item_update($glossary);
81     return $returnid;
82 }
84 /**
85  * Given an object containing all the necessary data,
86  * (defined by the form in mod_form.php) this function
87  * will update an existing instance with new data.
88  *
89  * @global object
90  * @global object
91  * @param object $glossary
92  * @return bool
93  */
94 function glossary_update_instance($glossary) {
95     global $CFG, $DB;
97     if (empty($glossary->globalglossary)) {
98         $glossary->globalglossary = 0;
99     }
101     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
102         // keep previous
103         unset($glossary->globalglossary);
104     }
106     $glossary->timemodified = time();
107     $glossary->id           = $glossary->instance;
109     if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
110         $glossary->assesstimestart  = 0;
111         $glossary->assesstimefinish = 0;
112     }
114     //Check displayformat is a valid one
115     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
116     if (!in_array($glossary->displayformat, $formats)) {
117         print_error('unknowformat', '', '', $glossary->displayformat);
118     }
120     $DB->update_record("glossary", $glossary);
121     if ($glossary->defaultapproval) {
122         $DB->execute("UPDATE {glossary_entries} SET approved = 1 where approved <> 1 and glossaryid = ?", array($glossary->id));
123     }
124     glossary_grade_item_update($glossary);
126     return true;
129 /**
130  * Given an ID of an instance of this module,
131  * this function will permanently delete the instance
132  * and any data that depends on it.
133  *
134  * @global object
135  * @param int $id glossary id
136  * @return bool success
137  */
138 function glossary_delete_instance($id) {
139     global $DB, $CFG;
141     if (!$glossary = $DB->get_record('glossary', array('id'=>$id))) {
142         return false;
143     }
145     if (!$cm = get_coursemodule_from_instance('glossary', $id)) {
146         return false;
147     }
149     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
150         return false;
151     }
153     $fs = get_file_storage();
155     if ($glossary->mainglossary) {
156         // unexport entries
157         $sql = "SELECT ge.id, ge.sourceglossaryid, cm.id AS sourcecmid
158                   FROM {glossary_entries} ge
159                   JOIN {modules} m ON m.name = 'glossary'
160                   JOIN {course_modules} cm ON (cm.module = m.id AND cm.instance = ge.sourceglossaryid)
161                  WHERE ge.glossaryid = ? AND ge.sourceglossaryid > 0";
163         if ($exported = $DB->get_records_sql($sql, array($id))) {
164             foreach ($exported as $entry) {
165                 $entry->glossaryid = $entry->sourceglossaryid;
166                 $entry->sourceglossaryid = 0;
167                 $newcontext = get_context_instance(CONTEXT_MODULE, $entry->sourcecmid);
168                 if ($oldfiles = $fs->get_area_files($context->id, 'mod_glossary', 'attachment', $entry->id)) {
169                     foreach ($oldfiles as $oldfile) {
170                         $file_record = new stdClass();
171                         $file_record->contextid = $newcontext->id;
172                         $fs->create_file_from_storedfile($file_record, $oldfile);
173                     }
174                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
175                     $entry->attachment = '1';
176                 } else {
177                     $entry->attachment = '0';
178                 }
179                 $DB->update_record('glossary_entries', $entry);
180             }
181         }
182     } else {
183         // move exported entries to main glossary
184         $sql = "UPDATE {glossary_entries}
185                    SET sourceglossaryid = 0
186                  WHERE sourceglossaryid = ?";
187         $DB->execute($sql, array($id));
188     }
190     // Delete any dependent records
191     $entry_select = "SELECT id FROM {glossary_entries} WHERE glossaryid = ?";
192     $DB->delete_records_select('comments', "contextid=? AND commentarea=? AND itemid IN ($entry_select)", array($id, 'glossary_entry', $context->id));
193     $DB->delete_records_select('glossary_alias',    "entryid IN ($entry_select)", array($id));
195     $category_select = "SELECT id FROM {glossary_categories} WHERE glossaryid = ?";
196     $DB->delete_records_select('glossary_entries_categories', "categoryid IN ($category_select)", array($id));
197     $DB->delete_records('glossary_categories', array('glossaryid'=>$id));
198     $DB->delete_records('glossary_entries', array('glossaryid'=>$id));
200     // delete all files
201     $fs->delete_area_files($context->id);
203     glossary_grade_item_delete($glossary);
205     return $DB->delete_records('glossary', array('id'=>$id));
208 /**
209  * Return a small object with summary information about what a
210  * user has done with a given particular instance of this module
211  * Used for user activity reports.
212  * $return->time = the time they did it
213  * $return->info = a short text description
214  *
215  * @param object $course
216  * @param object $user
217  * @param object $mod
218  * @param object $glossary
219  * @return object|null
220  */
221 function glossary_user_outline($course, $user, $mod, $glossary) {
222     global $CFG;
224     require_once("$CFG->libdir/gradelib.php");
225     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
226     if (empty($grades->items[0]->grades)) {
227         $grade = false;
228     } else {
229         $grade = reset($grades->items[0]->grades);
230     }
232     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
233         $result = new stdClass();
234         $result->info = count($entries) . ' ' . get_string("entries", "glossary");
236         $lastentry = array_pop($entries);
237         $result->time = $lastentry->timemodified;
239         if ($grade) {
240             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
241         }
242         return $result;
243     } else if ($grade) {
244         $result = new stdClass();
245         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
246         $result->time = $grade->dategraded;
247         return $result;
248     }
249     return NULL;
252 /**
253  * @global object
254  * @param int $glossaryid
255  * @param int $userid
256  * @return array
257  */
258 function glossary_get_user_entries($glossaryid, $userid) {
259 /// Get all the entries for a user in a glossary
260     global $DB;
262     return $DB->get_records_sql("SELECT e.*, u.firstname, u.lastname, u.email, u.picture
263                                    FROM {glossary} g, {glossary_entries} e, {user} u
264                              WHERE g.id = ?
265                                AND e.glossaryid = g.id
266                                AND e.userid = ?
267                                AND e.userid = u.id
268                           ORDER BY e.timemodified ASC", array($glossaryid, $userid));
271 /**
272  * Print a detailed representation of what a  user has done with
273  * a given particular instance of this module, for user activity reports.
274  *
275  * @global object
276  * @param object $course
277  * @param object $user
278  * @param object $mod
279  * @param object $glossary
280  */
281 function glossary_user_complete($course, $user, $mod, $glossary) {
282     global $CFG, $OUTPUT;
283     require_once("$CFG->libdir/gradelib.php");
285     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
286     if (!empty($grades->items[0]->grades)) {
287         $grade = reset($grades->items[0]->grades);
288         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
289         if ($grade->str_feedback) {
290             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
291         }
292     }
294     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
295         echo '<table width="95%" border="0"><tr><td>';
296         foreach ($entries as $entry) {
297             $cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id);
298             glossary_print_entry($course, $cm, $glossary, $entry,"","",0);
299             echo '<p>';
300         }
301         echo '</td></tr></table>';
302     }
304 /**
305  * Given a course and a time, this module should find recent activity
306  * that has occurred in glossary activities and print it out.
307  * Return true if there was output, or false is there was none.
308  *
309  * @global object
310  * @global object
311  * @global object
312  * @param object $course
313  * @param object $viewfullnames
314  * @param int $timestart
315  * @return bool
316  */
317 function glossary_print_recent_activity($course, $viewfullnames, $timestart) {
318     global $CFG, $USER, $DB, $OUTPUT;
320     //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0
322     $modinfo = get_fast_modinfo($course);
323     $ids = array();
324     foreach ($modinfo->cms as $cm) {
325         if ($cm->modname != 'glossary') {
326             continue;
327         }
328         if (!$cm->uservisible) {
329             continue;
330         }
331         $ids[$cm->instance] = $cm->instance;
332     }
334     if (!$ids) {
335         return false;
336     }
338     $glist = implode(',', $ids); // there should not be hundreds of glossaries in one course, right?
340     if (!$entries = $DB->get_records_sql("SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
341                                                  ge.userid, u.firstname, u.lastname, u.email, u.picture
342                                             FROM {glossary_entries} ge
343                                             JOIN {user} u ON u.id = ge.userid
344                                            WHERE ge.glossaryid IN ($glist) AND ge.timemodified > ?
345                                         ORDER BY ge.timemodified ASC", array($timestart))) {
346         return false;
347     }
349     $editor  = array();
351     foreach ($entries as $entryid=>$entry) {
352         if ($entry->approved) {
353             continue;
354         }
356         if (!isset($editor[$entry->glossaryid])) {
357             $editor[$entry->glossaryid] = has_capability('mod/glossary:approve', get_context_instance(CONTEXT_MODULE, $modinfo->instances['glossary'][$entry->glossaryid]->id));
358         }
360         if (!$editor[$entry->glossaryid]) {
361             unset($entries[$entryid]);
362         }
363     }
365     if (!$entries) {
366         return false;
367     }
368     echo $OUTPUT->heading(get_string('newentries', 'glossary').':');
370     $strftimerecent = get_string('strftimerecent');
371     foreach ($entries as $entry) {
372         $link = $CFG->wwwroot.'/mod/glossary/view.php?g='.$entry->glossaryid.'&amp;mode=entry&amp;hook='.$entry->id;
373         if ($entry->approved) {
374             $dimmed = '';
375         } else {
376             $dimmed = ' dimmed_text';
377         }
378         echo '<div class="head'.$dimmed.'">';
379         echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
380         echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
381         echo '</div>';
382         echo '<div class="info"><a href="'.$link.'">'.format_text($entry->concept, true).'</a></div>';
383     }
385     return true;
388 /**
389  * @global object
390  * @param object $log
391  */
392 function glossary_log_info($log) {
393     global $DB;
395     return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
396                                   FROM {glossary_entries} e, {user} u
397                                  WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
400 /**
401  * Function to be run periodically according to the moodle cron
402  * This function searches for things that need to be done, such
403  * as sending out mail, toggling flags etc ...
404  * @return bool
405  */
406 function glossary_cron () {
407     return true;
410 /**
411  * Return grade for given user or all users.
412  *
413  * @global object
414  * @param int $glossaryid id of glossary
415  * @param int $userid optional user id, 0 means all users
416  * @return array array of grades, false if none
417  */
418 function glossary_get_user_grades($glossary, $userid=0) {
419     global $CFG;
421     require_once($CFG->dirroot.'/rating/lib.php');
422     $rm = new rating_manager();
424     $ratingoptions = new stdclass();
426     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
427     $ratingoptions->modulename = 'glossary';
428     $ratingoptions->moduleid   = $glossary->id;
430     $ratingoptions->userid = $userid;
431     $ratingoptions->aggregationmethod = $glossary->assessed;
432     $ratingoptions->scaleid = $glossary->scale;
433     $ratingoptions->itemtable = 'glossary_entries';
434     $ratingoptions->itemtableusercolumn = 'userid';
436     return $rm->get_user_grades($ratingoptions);
439 /**
440  * Return rating related permissions
441  * @param string $options the context id
442  * @return array an associative array of the user's rating permissions
443  */
444 function glossary_rating_permissions($options) {
445     $contextid = $options;
446     $context = get_context_instance_by_id($contextid);
448     if (!$context) {
449         print_error('invalidcontext');
450         return null;
451     } else {
452         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));
453     }
456 /**
457  * Returns the names of the table and columns necessary to check items for ratings
458  * @return array an array containing the item table, item id and user id columns
459  */
460 function glossary_rating_item_check_info() {
461     return array('glossary_entries','id','userid');
464 /**
465  * Update activity grades
466  *
467  * @global object
468  * @global object
469  * @param object $glossary null means all glossaries (with extra cmidnumber property)
470  * @param int $userid specific user only, 0 means all
471  */
472 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
473     global $CFG, $DB;
474     require_once($CFG->libdir.'/gradelib.php');
476     if (!$glossary->assessed) {
477         glossary_grade_item_update($glossary);
479     } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
480         glossary_grade_item_update($glossary, $grades);
482     } else if ($userid and $nullifnone) {
483         $grade = new stdClass();
484         $grade->userid   = $userid;
485         $grade->rawgrade = NULL;
486         glossary_grade_item_update($glossary, $grade);
488     } else {
489         glossary_grade_item_update($glossary);
490     }
493 /**
494  * Update all grades in gradebook.
495  *
496  * @global object
497  */
498 function glossary_upgrade_grades() {
499     global $DB;
501     $sql = "SELECT COUNT('x')
502               FROM {glossary} g, {course_modules} cm, {modules} m
503              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
504     $count = $DB->count_records_sql($sql);
506     $sql = "SELECT g.*, cm.idnumber AS cmidnumber, g.course AS courseid
507               FROM {glossary} g, {course_modules} cm, {modules} m
508              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
509     $rs = $DB->get_recordset_sql($sql);
510     if ($rs->valid()) {
511         $pbar = new progress_bar('glossaryupgradegrades', 500, true);
512         $i=0;
513         foreach ($rs as $glossary) {
514             $i++;
515             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
516             glossary_update_grades($glossary, 0, false);
517             $pbar->update($i, $count, "Updating Glossary grades ($i/$count).");
518         }
519     }
520     $rs->close();
523 /**
524  * Create/update grade item for given glossary
525  *
526  * @global object
527  * @param object $glossary object with extra cmidnumber
528  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
529  * @return int, 0 if ok, error code otherwise
530  */
531 function glossary_grade_item_update($glossary, $grades=NULL) {
532     global $CFG;
533     require_once($CFG->libdir.'/gradelib.php');
535     $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
537     if (!$glossary->assessed or $glossary->scale == 0) {
538         $params['gradetype'] = GRADE_TYPE_NONE;
540     } else if ($glossary->scale > 0) {
541         $params['gradetype'] = GRADE_TYPE_VALUE;
542         $params['grademax']  = $glossary->scale;
543         $params['grademin']  = 0;
545     } else if ($glossary->scale < 0) {
546         $params['gradetype'] = GRADE_TYPE_SCALE;
547         $params['scaleid']   = -$glossary->scale;
548     }
550     if ($grades  === 'reset') {
551         $params['reset'] = true;
552         $grades = NULL;
553     }
555     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
558 /**
559  * Delete grade item for given glossary
560  *
561  * @global object
562  * @param object $glossary object
563  */
564 function glossary_grade_item_delete($glossary) {
565     global $CFG;
566     require_once($CFG->libdir.'/gradelib.php');
568     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
571 /**
572  * Returns the users with data in one glossary
573  * (users with records in glossary_entries, students)
574  *
575  * @global object
576  * @param int $glossaryid
577  * @return array
578  */
579 function glossary_get_participants($glossaryid) {
580     global $DB;
582     //Get students
583     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
584                                         FROM {user} u, {glossary_entries} g
585                                  WHERE g.glossaryid = ? AND u.id = g.userid", array($glossaryid));
587     //Return students array (it contains an array of unique users)
588     return $students;
591 /**
592  * @global object
593  * @param int $gloassryid
594  * @param int $scaleid
595  * @return bool
596  */
597 function glossary_scale_used ($glossaryid,$scaleid) {
598 //This function returns if a scale is being used by one glossary
599     global $DB;
601     $return = false;
603     $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
605     if (!empty($rec)  && !empty($scaleid)) {
606         $return = true;
607     }
609     return $return;
612 /**
613  * Checks if scale is being used by any instance of glossary
614  *
615  * This is used to find out if scale used anywhere
616  *
617  * @global object
618  * @param int $scaleid
619  * @return boolean True if the scale is used by any glossary
620  */
621 function glossary_scale_used_anywhere($scaleid) {
622     global $DB;
624     if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
625         return true;
626     } else {
627         return false;
628     }
631 //////////////////////////////////////////////////////////////////////////////////////
632 /// Any other glossary functions go here.  Each of them must have a name that
633 /// starts with glossary_
635 /**
636  * This function return an array of valid glossary_formats records
637  * Everytime it's called, every existing format is checked, new formats
638  * are included if detected and old formats are deleted and any glossary
639  * using an invalid format is updated to the default (dictionary).
640  *
641  * @global object
642  * @global object
643  * @return array
644  */
645 function glossary_get_available_formats() {
646     global $CFG, $DB;
648     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
649     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
650     $pluginformats = array();
651     foreach ($formats as $format) {
652         //If the format file exists
653         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
654             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
655             //If the function exists
656             if (function_exists('glossary_show_entry_'.$format)) {
657                 //Acummulate it as a valid format
658                 $pluginformats[] = $format;
659                 //If the format doesn't exist in the table
660                 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
661                     //Insert the record in glossary_formats
662                     $gf = new stdClass();
663                     $gf->name = $format;
664                     $gf->popupformatname = $format;
665                     $gf->visible = 1;
666                     $DB->insert_record("glossary_formats",$gf);
667                 }
668             }
669         }
670     }
672     //Delete non_existent formats from glossary_formats table
673     $formats = $DB->get_records("glossary_formats");
674     foreach ($formats as $format) {
675         $todelete = false;
676         //If the format in DB isn't a valid previously detected format then delete the record
677         if (!in_array($format->name,$pluginformats)) {
678             $todelete = true;
679         }
681         if ($todelete) {
682             //Delete the format
683             $DB->delete_records('glossary_formats', array('name'=>$format->name));
684             //Reasign existing glossaries to default (dictionary) format
685             if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
686                 foreach($glossaries as $glossary) {
687                     $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
688                 }
689             }
690         }
691     }
693     //Now everything is ready in glossary_formats table
694     $formats = $DB->get_records("glossary_formats");
696     return $formats;
699 /**
700  * @param bool $debug
701  * @param string $text
702  * @param int $br
703  */
704 function glossary_debug($debug,$text,$br=1) {
705     if ( $debug ) {
706         echo '<font color="red">' . $text . '</font>';
707         if ( $br ) {
708             echo '<br />';
709         }
710     }
713 /**
714  *
715  * @global object
716  * @param int $glossaryid
717  * @param string $entrylist
718  * @param string $pivot
719  * @return array
720  */
721 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
722     global $DB;
723     if ($pivot) {
724        $pivot .= ",";
725     }
727     return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
728                                    FROM {glossary_entries}
729                                   WHERE glossaryid = ?
730                                         AND id IN ($entrylist)", array($glossaryid));
733 /**
734  * @global object
735  * @global object
736  * @param object $concept
737  * @param string $courseid
738  * @return array
739  */
740 function glossary_get_entries_search($concept, $courseid) {
741     global $CFG, $DB;
743     //Check if the user is an admin
744     $bypassadmin = 1; //This means NO (by default)
745     if (has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_SYSTEM))) {
746         $bypassadmin = 0; //This means YES
747     }
749     //Check if the user is a teacher
750     $bypassteacher = 1; //This means NO (by default)
751     if (has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $courseid))) {
752         $bypassteacher = 0; //This means YES
753     }
755     $conceptlower = moodle_strtolower(trim($concept));
757     $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
759     return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
760                                    FROM {glossary_entries} e, {glossary} g,
761                                         {course_modules} cm, {modules} m
762                                   WHERE m.name = 'glossary' AND
763                                         cm.module = m.id AND
764                                         (cm.visible = 1 OR  cm.visible = $bypassadmin OR
765                                             (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
766                                         g.id = cm.instance AND
767                                         e.glossaryid = g.id  AND
768                                         ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
769                                           (e.casesensitive = 0 and concept = :concept)) AND
770                                         (g.course = :courseid2 OR g.globalglossary = 1) AND
771                                          e.usedynalink != 0 AND
772                                          g.usedynalink != 0", $params);
775 /**
776  * @global object
777  * @global object
778  * @param object $course
779  * @param object $course
780  * @param object $glossary
781  * @param object $entry
782  * @param string $mode
783  * @param string $hook
784  * @param int $printicons
785  * @param int $displayformat
786  * @param bool $printview
787  * @return mixed
788  */
789 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $printview = false) {
790     global $USER, $CFG;
791     $return = false;
792     if ( $displayformat < 0 ) {
793         $displayformat = $glossary->displayformat;
794     }
795     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
796         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
797         if ($printview) {
798             $functionname = 'glossary_print_entry_'.$displayformat;
799         } else {
800             $functionname = 'glossary_show_entry_'.$displayformat;
801         }
803         if (file_exists($formatfile)) {
804             include_once($formatfile);
805             if (function_exists($functionname)) {
806                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
807             } else if ($printview) {
808                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
809                 $return = glossary_print_entry_default($entry, $glossary, $cm);
810             }
811         }
812     }
813     return $return;
816 /**
817  * Default (old) print format used if custom function doesn't exist in format
818  *
819  * @param object $entry
820  * @param object $glossary
821  * @param object $cm
822  * @return void Output is echo'd
823  */
824 function glossary_print_entry_default ($entry, $glossary, $cm) {
825     global $CFG;
827     require_once($CFG->libdir . '/filelib.php');
829     echo '<h3>'. strip_tags($entry->concept) . ': </h3>';
831     $definition = $entry->definition;
833     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
835     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
836     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
838     $options = new stdClass();
839     $options->para = false;
840     $options->trusted = $entry->definitiontrust;
841     $options->context = $context;
842     $options->overflowdiv = true;
843     $definition = format_text($definition, $entry->definitionformat, $options);
844     echo ($definition);
845     echo '<br /><br />';
848 /**
849  * Print glossary concept/term as a heading &lt;h3>
850  * @param object $entry
851  */
852 function  glossary_print_entry_concept($entry, $return=false) {
853     global $OUTPUT;
854     $options = new stdClass();
855     $options->para = false;
856     $text = format_text($OUTPUT->heading('<span class="nolink">' . $entry->concept . '</span>', 3, 'nolink'), FORMAT_MOODLE, $options);
857     if (!empty($entry->highlight)) {
858         $text = highlight($entry->highlight, $text);
859     }
861     if ($return) {
862         return $text;
863     } else {
864         echo $text;
865     }
868 /**
869  *
870  * @global moodle_database DB
871  * @param object $entry
872  * @param object $glossary
873  * @param object $cm
874  */
875 function glossary_print_entry_definition($entry, $glossary, $cm) {
876     global $DB, $GLOSSARY_EXCLUDECONCEPTS;
878     $definition = $entry->definition;
880     //Calculate all the strings to be no-linked
881     //First, the concept
882     $GLOSSARY_EXCLUDECONCEPTS = array($entry->concept);
883     //Now the aliases
884     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
885         foreach ($aliases as $alias) {
886             $GLOSSARY_EXCLUDECONCEPTS[]=trim($alias->alias);
887         }
888     }
890     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
891     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
893     $options = new stdClass();
894     $options->para = false;
895     $options->trusted = $entry->definitiontrust;
896     $options->context = $context;
897     $options->overflowdiv = true;
898     $text = format_text($definition, $entry->definitionformat, $options);
900     // Stop excluding concepts from autolinking
901     unset($GLOSSARY_EXCLUDECONCEPTS);
903     if (!empty($entry->highlight)) {
904         $text = highlight($entry->highlight, $text);
905     }
906     if (isset($entry->footer)) {   // Unparsed footer info
907         $text .= $entry->footer;
908     }
909     echo $text;
912 /**
913  *
914  * @global object
915  * @param object $course
916  * @param object $cm
917  * @param object $glossary
918  * @param object $entry
919  * @param string $mode
920  * @param string $hook
921  * @param string $type
922  * @return string|void
923  */
924 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
925     global $DB;
927     $return = '';
928     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
929         foreach ($aliases as $alias) {
930             if (trim($alias->alias)) {
931                 if ($return == '') {
932                     $return = '<select style="font-size:8pt">';
933                 }
934                 $return .= "<option>$alias->alias</option>";
935             }
936         }
937         if ($return != '') {
938             $return .= '</select>';
939         }
940     }
941     if ($type == 'print') {
942         echo $return;
943     } else {
944         return $return;
945     }
948 /**
949  *
950  * @global object
951  * @global object
952  * @global object
953  * @param object $course
954  * @param object $cm
955  * @param object $glossary
956  * @param object $entry
957  * @param string $mode
958  * @param string $hook
959  * @param string $type
960  * @return string|void
961  */
962 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
963     global $USER, $CFG, $DB, $OUTPUT;
965     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
967     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
968     $importedentry = ($entry->sourceglossaryid == $glossary->id);
969     $ismainglossary = $glossary->mainglossary;
972     $return = '<span class="commands">';
973     // Differentiate links for each entry.
974     $altsuffix = ': '.strip_tags(format_text($entry->concept));
976     if (!$entry->approved) {
977         $output = true;
978         $return .= get_string('entryishidden','glossary');
979     }
981     if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $entry->userid == $USER->id)) {
982         // only teachers can export entries so check it out
983         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
984             $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
985             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
986                 $output = true;
987                 $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>';
988             }
989         }
991         if ( $entry->sourceglossaryid ) {
992             $icon = $OUTPUT->pix_url('minus', 'glossary');   // graphical metaphor (minus) for deleting an imported entry
993         } else {
994             $icon = $OUTPUT->pix_url('t/delete');
995         }
997         //Decide if an entry is editable:
998         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
999         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1000         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
1001         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1002             $output = true;
1003             $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=\"";
1004             $return .= $icon;
1005             $return .= "\" class=\"iconsmall\" alt=\"" . get_string("delete") .$altsuffix."\" /></a> ";
1007             $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>";
1008         } elseif ( $importedentry ) {
1009             $return .= " <font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1010         }
1011     }
1012     if (has_capability('mod/glossary:exportentry', $context)
1013         || ($entry->userid == $USER->id
1014             && has_capability('mod/glossary:exportownentry', $context))) {
1015         require_once($CFG->libdir . '/portfoliolib.php');
1016         $button = new portfolio_add_button();
1017         $button->set_callback_options('glossary_entry_portfolio_caller',  array('id' => $cm->id, 'entryid' => $entry->id), '/mod/glossary/locallib.php');
1019         $filecontext = $context;
1020         if ($entry->sourceglossaryid == $cm->instance) {
1021             if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1022                 $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1023             }
1024         }
1025         $fs = get_file_storage();
1026         if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1027             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1028         } else {
1029             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1030         }
1032         $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1033     }
1034     $return .= "&nbsp;&nbsp;"; // just to make up a little the output in Mozilla ;)
1036     $return .= '</span>';
1038     if (has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1039         $output = true;
1040         if (!empty($CFG->usecomments)) {
1041             require_once($CFG->dirroot . '/comment/lib.php');
1042             $cmt = new stdClass();
1043             $cmt->component = 'mod_glossary';
1044             $cmt->context  = $context;
1045             $cmt->course   = $course;
1046             $cmt->cm       = $cm;
1047             $cmt->area     = 'glossary_entry';
1048             $cmt->itemid   = $entry->id;
1049             $cmt->showcount = true;
1050             $comment = new comment($cmt);
1051             $return .= '<div>'.$comment->output(true).'</div>';
1052         }
1053     }
1055     //If we haven't calculated any REAL thing, delete result ($return)
1056     if (!$output) {
1057         $return = '';
1058     }
1059     //Print or get
1060     if ($type == 'print') {
1061         echo $return;
1062     } else {
1063         return $return;
1064     }
1067 /**
1068  * @param object $course
1069  * @param object $cm
1070  * @param object $glossary
1071  * @param object $entry
1072  * @param string $mode
1073  * @param object $hook
1074  * @param bool $printicons
1075  * @param bool $aliases
1076  * @return void
1077  */
1078 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1079     if ($aliases) {
1080         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1081     }
1082     $icons   = '';
1083     if ($printicons) {
1084         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1085     }
1086     if ($aliases || $icons || !empty($entry->rating)) {
1087         echo '<table>';
1088         if ( $aliases ) {
1089             echo '<tr valign="top"><td class="aliases">' .
1090                   get_string('aliases','glossary').': '.$aliases . '</td></tr>';
1091         }
1092         if ($icons) {
1093             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1094         }
1095         if (!empty($entry->rating)) {
1096             echo '<tr valign="top"><td class="ratings">';
1097             glossary_print_entry_ratings($course, $entry);
1098             echo '</td></tr>';
1099         }
1100         echo '</table>';
1101     }
1104 /**
1105  * @todo Document this function
1106  */
1107 function glossary_print_entry_attachment($entry, $cm, $format=NULL, $align="right", $insidetable=true) {
1108 ///   valid format values: html  : Return the HTML link for the attachment as an icon
1109 ///                        text  : Return the HTML link for tha attachment as text
1110 ///                        blank : Print the output to the screen
1111     if ($entry->attachment) {
1112           if ($insidetable) {
1113               echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
1114           }
1115           echo glossary_print_attachments($entry, $cm, $format, $align);
1116           if ($insidetable) {
1117               echo "</td></tr></table>\n";
1118           }
1119     }
1122 /**
1123  * @global object
1124  * @param object $cm
1125  * @param object $entry
1126  * @param string $mode
1127  * @param string $align
1128  * @param bool $insidetable
1129  */
1130 function  glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1131     global $CFG, $OUTPUT;
1133     if ($mode == 'approval' and !$entry->approved) {
1134         if ($insidetable) {
1135             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1136         }
1137         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>';
1138         if ($insidetable) {
1139             echo '</td></tr></table>';
1140         }
1141     }
1144 /**
1145  * It returns all entries from all glossaries that matches the specified criteria
1146  *  within a given $course. It performs an $extended search if necessary.
1147  * It restrict the search to only one $glossary if the $glossary parameter is set.
1148  *
1149  * @global object
1150  * @global object
1151  * @param object $course
1152  * @param array $searchterms
1153  * @param int $extended
1154  * @param object $glossary
1155  * @return array
1156  */
1157 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1158     global $CFG, $DB;
1160     if ( !$glossary ) {
1161         if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1162             $glos = "";
1163             foreach ( $glossaries as $glossary ) {
1164                 $glos .= "$glossary->id,";
1165             }
1166             $glos = substr($glos,0,-1);
1167         }
1168     } else {
1169         $glos = $glossary->id;
1170     }
1172     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $glossary->course))) {
1173         $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1174         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1175         $onlyvisibletable = ", {course_modules} cm";
1176     } else {
1178         $onlyvisible = "";
1179         $onlyvisibletable = "";
1180     }
1182     if ($DB->sql_regex_supported()) {
1183         $REGEXP    = $DB->sql_regex(true);
1184         $NOTREGEXP = $DB->sql_regex(false);
1185     }
1187     $searchcond = array();
1188     $params     = array();
1189     $i = 0;
1191     $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1194     foreach ($searchterms as $searchterm) {
1195         $i++;
1197         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1198                    /// will use it to simulate the "-" operator with LIKE clause
1200     /// Under Oracle and MSSQL, trim the + and - operators and perform
1201     /// simpler LIKE (or NOT LIKE) queries
1202         if (!$DB->sql_regex_supported()) {
1203             if (substr($searchterm, 0, 1) == '-') {
1204                 $NOT = true;
1205             }
1206             $searchterm = trim($searchterm, '+-');
1207         }
1209         // TODO: +- may not work for non latin languages
1211         if (substr($searchterm,0,1) == '+') {
1212             $searchterm = trim($searchterm, '+-');
1213             $searchterm = preg_quote($searchterm, '|');
1214             $searchcond[] = "$concat $REGEXP :ss$i";
1215             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1217         } else if (substr($searchterm,0,1) == "-") {
1218             $searchterm = trim($searchterm, '+-');
1219             $searchterm = preg_quote($searchterm, '|');
1220             $searchcond[] = "$concat $NOTREGEXP :ss$i";
1221             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1223         } else {
1224             $searchcond[] = $DB->sql_like($concat, ":ss$i", false, true, $NOT);
1225             $params['ss'.$i] = "%$searchterm%";
1226         }
1227     }
1229     if (empty($searchcond)) {
1230         $totalcount = 0;
1231         return array();
1232     }
1234     $searchcond = implode(" AND ", $searchcond);
1236     $sql = "SELECT e.*
1237               FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1238              WHERE $searchcond
1239                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1240                AND g.id IN ($glos) AND e.approved <> 0";
1242     return $DB->get_records_sql($sql, $params);
1245 /**
1246  * @global object
1247  * @param array $searchterms
1248  * @param object $glossary
1249  * @param bool $extended
1250  * @return array
1251  */
1252 function glossary_search_entries($searchterms, $glossary, $extended) {
1253     global $DB;
1255     $course = $DB->get_record("course", array("id"=>$glossary->course));
1256     return glossary_search($course,$searchterms,$extended,$glossary);
1259 /**
1260  * if return=html, then return a html string.
1261  * if return=text, then return a text-only string.
1262  * otherwise, print HTML for non-images, and return image HTML
1263  *     if attachment is an image, $align set its aligment.
1264  *
1265  * @global object
1266  * @global object
1267  * @param object $entry
1268  * @param object $cm
1269  * @param string $type html, txt, empty
1270  * @param string $align left or right
1271  * @return string image string or nothing depending on $type param
1272  */
1273 function glossary_print_attachments($entry, $cm, $type=NULL, $align="left") {
1274     global $CFG, $DB, $OUTPUT;
1276     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
1277         return '';
1278     }
1280     if ($entry->sourceglossaryid == $cm->instance) {
1281         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1282             return '';
1283         }
1284         $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1286     } else {
1287         $filecontext = $context;
1288     }
1290     $strattachment = get_string('attachment', 'glossary');
1292     $fs = get_file_storage();
1294     $imagereturn = '';
1295     $output = '';
1297     if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1298         foreach ($files as $file) {
1299             $filename = $file->get_filename();
1300             $mimetype = $file->get_mimetype();
1301             $iconimage = '<img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />';
1302             $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename);
1304             if ($type == 'html') {
1305                 $output .= "<a href=\"$path\">$iconimage</a> ";
1306                 $output .= "<a href=\"$path\">".s($filename)."</a>";
1307                 $output .= "<br />";
1309             } else if ($type == 'text') {
1310                 $output .= "$strattachment ".s($filename).":\n$path\n";
1312             } else {
1313                 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1314                     // Image attachments don't get printed as links
1315                     $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1316                 } else {
1317                     $output .= "<a href=\"$path\">$iconimage</a> ";
1318                     $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context));
1319                     $output .= '<br />';
1320                 }
1321             }
1322         }
1323     }
1325     if ($type) {
1326         return $output;
1327     } else {
1328         echo $output;
1329         return $imagereturn;
1330     }
1333 /**
1334  * Lists all browsable file areas
1335  *
1336  * @param object $course
1337  * @param object $cm
1338  * @param object $context
1339  * @return array
1340  */
1341 function glossary_get_file_areas($course, $cm, $context) {
1342     $areas = array();
1343     return $areas;
1346 /**
1347  * Serves the glossary attachments. Implements needed access control ;-)
1348  *
1349  * @param object $course
1350  * @param object $cm
1351  * @param object $context
1352  * @param string $filearea
1353  * @param array $args
1354  * @param bool $forcedownload
1355  * @return bool false if file not found, does not return if found - justsend the file
1356  */
1357 function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
1358     global $CFG, $DB;
1360     if ($context->contextlevel != CONTEXT_MODULE) {
1361         return false;
1362     }
1364     require_course_login($course, true, $cm);
1366     if ($filearea === 'attachment' or $filearea === 'entry') {
1367         $entryid = (int)array_shift($args);
1369         require_course_login($course, true, $cm);
1371         if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1372             return false;
1373         }
1375         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1376             return false;
1377         }
1379         if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1380             return false;
1381         }
1383         // this trickery here is because we need to support source glossary access
1385         if ($entry->glossaryid == $cm->instance) {
1386             $filecontext = $context;
1388         } else if ($entry->sourceglossaryid == $cm->instance) {
1389             if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1390                 return false;
1391             }
1392             $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1394         } else {
1395             return false;
1396         }
1398         $relativepath = implode('/', $args);
1399         $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath";
1401         $fs = get_file_storage();
1402         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1403             return false;
1404         }
1406         // finally send the file
1407         send_stored_file($file, 0, 0, true); // download MUST be forced - security!
1409     } else if ($filearea === 'export') {
1410         require_login($course, false, $cm);
1411         require_capability('mod/glossary:export', $context);
1413         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1414             return false;
1415         }
1417         $cat = array_shift($args);
1418         $cat = clean_param($cat, PARAM_ALPHANUM);
1420         $filename = clean_filename(strip_tags(format_string($glossary->name)).'.xml');
1421         $content = glossary_generate_export_file($glossary, NULL, $cat);
1423         send_file($content, $filename, 0, 0, true, true);
1424     }
1426     return false;
1429 /**
1430  *
1431  */
1432 function glossary_print_tabbed_table_end() {
1433      echo "</div></div>";
1436 /**
1437  * @param object $cm
1438  * @param object $glossary
1439  * @param string $mode
1440  * @param string $hook
1441  * @param string $sortkey
1442  * @param string $sortorder
1443  */
1444 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1445     if ($glossary->showalphabet) {
1446         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1447     }
1448     glossary_print_special_links($cm, $glossary, $mode, $hook);
1450     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1452     glossary_print_all_links($cm, $glossary, $mode, $hook);
1454     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1456 /**
1457  * @param object $cm
1458  * @param object $glossary
1459  * @param string $hook
1460  * @param string $sortkey
1461  * @param string $sortorder
1462  */
1463 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1464     echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1467 /**
1468  * @param object $cm
1469  * @param object $glossary
1470  * @param string $hook
1471  * @param string $sortkey
1472  * @param string $sortorder
1473  */
1474 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1475     echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1477 /**
1478  * @param object $cm
1479  * @param object $glossary
1480  * @param string $hook
1481  * @param string $sortkey
1482  * @param string $sortorder
1483  */
1484 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1485     if ( $mode != 'date' ) {
1486         if ($glossary->showalphabet) {
1487             echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1488         }
1490         glossary_print_special_links($cm, $glossary, $mode, $hook);
1492         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1494         glossary_print_all_links($cm, $glossary, $mode, $hook);
1495     } else {
1496         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1497     }
1500 /**
1501  * @param object $cm
1502  * @param object $glossary
1503  * @param string $hook
1504  * @param string $sortkey
1505  * @param string $sortorder
1506  */
1507 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1508     if ($glossary->showalphabet) {
1509         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1510     }
1512     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1513     glossary_print_all_links($cm, $glossary, $mode, $hook);
1514     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1517 /**
1518  * @global object
1519  * @global object
1520  * @param object $cm
1521  * @param object $glossary
1522  * @param string $hook
1523  * @param object $category
1524  */
1525 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1526      global $CFG, $DB, $OUTPUT;
1528      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1530      echo '<table border="0" width="100%">';
1531      echo '<tr>';
1533      echo '<td align="center" style="width:20%">';
1534      if (has_capability('mod/glossary:managecategories', $context)) {
1535              $options['id'] = $cm->id;
1536              $options['mode'] = 'cat';
1537              $options['hook'] = $hook;
1538              echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1539      }
1540      echo '</td>';
1542      echo '<td align="center" style="width:60%">';
1543      echo '<b>';
1545      $menu = array();
1546      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1547      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1549      $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1550      $selected = '';
1551      if ( $categories ) {
1552           foreach ($categories as $currentcategory) {
1553                  $url = $currentcategory->id;
1554                  if ( $category ) {
1555                      if ($currentcategory->id == $category->id) {
1556                          $selected = $url;
1557                      }
1558                  }
1559                  $menu[$url] = clean_text($currentcategory->name); //Only clean, not filters
1560           }
1561      }
1562      if ( !$selected ) {
1563          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1564      }
1566      if ( $category ) {
1567         echo format_text($category->name, FORMAT_PLAIN);
1568      } else {
1569         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1571             echo get_string("entrieswithoutcategory","glossary");
1572             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1574         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1576             echo get_string("allcategories","glossary");
1577             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1579         }
1580      }
1581      echo '</b></td>';
1582      echo '<td align="center" style="width:20%">';
1584      $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1585      echo $OUTPUT->render($select);
1587      echo '</td>';
1588      echo '</tr>';
1590      echo '</table>';
1593 /**
1594  * @global object
1595  * @param object $cm
1596  * @param object $glossary
1597  * @param string $mode
1598  * @param string $hook
1599  */
1600 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1601 global $CFG;
1602      if ( $glossary->showall) {
1603          $strallentries       = get_string("allentries", "glossary");
1604          if ( $hook == 'ALL' ) {
1605               echo "<b>$strallentries</b>";
1606          } else {
1607               $strexplainall = strip_tags(get_string("explainall","glossary"));
1608               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1609          }
1610      }
1613 /**
1614  * @global object
1615  * @param object $cm
1616  * @param object $glossary
1617  * @param string $mode
1618  * @param string $hook
1619  */
1620 function glossary_print_special_links($cm, $glossary, $mode, $hook) {
1621 global $CFG;
1622      if ( $glossary->showspecial) {
1623          $strspecial          = get_string("special", "glossary");
1624          if ( $hook == 'SPECIAL' ) {
1625               echo "<b>$strspecial</b> | ";
1626          } else {
1627               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1628               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
1629          }
1630      }
1633 /**
1634  * @global object
1635  * @param object $glossary
1636  * @param string $mode
1637  * @param string $hook
1638  * @param string $sortkey
1639  * @param string $sortorder
1640  */
1641 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1642 global $CFG;
1643      if ( $glossary->showalphabet) {
1644           $alphabet = explode(",", get_string('alphabet', 'langconfig'));
1645           for ($i = 0; $i < count($alphabet); $i++) {
1646               if ( $hook == $alphabet[$i] and $hook) {
1647                    echo "<b>$alphabet[$i]</b>";
1648               } else {
1649                    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>";
1650               }
1651               echo ' | ';
1652           }
1653      }
1656 /**
1657  * @global object
1658  * @param object $cm
1659  * @param string $mode
1660  * @param string $sortkey
1661  * @param string $sortorder
1662  */
1663 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
1664     global $CFG, $OUTPUT;
1666     $asc    = get_string("ascending","glossary");
1667     $desc   = get_string("descending","glossary");
1668     $bopen  = '<b>';
1669     $bclose = '</b>';
1671      $neworder = '';
1672      $currentorder = '';
1673      $currentsort = '';
1674      if ( $sortorder ) {
1675          if ( $sortorder == 'asc' ) {
1676              $currentorder = $asc;
1677              $neworder = '&amp;sortorder=desc';
1678              $newordertitle = get_string('changeto', 'glossary', $desc);
1679          } else {
1680              $currentorder = $desc;
1681              $neworder = '&amp;sortorder=asc';
1682              $newordertitle = get_string('changeto', 'glossary', $asc);
1683          }
1684          $icon = " <img src=\"".$OUTPUT->pix_url($sortorder, 'glossary')."\" class=\"icon\" alt=\"$newordertitle\" />";
1685      } else {
1686          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
1687                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
1688              $icon = "";
1689              $newordertitle = $asc;
1690          } else {
1691              $newordertitle = $desc;
1692              $neworder = '&amp;sortorder=desc';
1693              $icon = ' <img src="'.$OUTPUT->pix_url('asc', 'glossary').'" class="icon" alt="'.$newordertitle.'" />';
1694          }
1695      }
1696      $ficon     = '';
1697      $fneworder = '';
1698      $fbtag     = '';
1699      $fendbtag  = '';
1701      $sicon     = '';
1702      $sneworder = '';
1704      $sbtag      = '';
1705      $fbtag      = '';
1706      $fendbtag      = '';
1707      $sendbtag      = '';
1709      $sendbtag  = '';
1711      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
1712          $ficon       = $icon;
1713          $fneworder   = $neworder;
1714          $fordertitle = $newordertitle;
1715          $sordertitle = $asc;
1716          $fbtag       = $bopen;
1717          $fendbtag    = $bclose;
1718      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
1719          $sicon = $icon;
1720          $sneworder   = $neworder;
1721          $fordertitle = $asc;
1722          $sordertitle = $newordertitle;
1723          $sbtag       = $bopen;
1724          $sendbtag    = $bclose;
1725      } else {
1726          $fordertitle = $asc;
1727          $sordertitle = $asc;
1728      }
1730      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
1731          $forder = 'CREATION';
1732          $sorder =  'UPDATE';
1733          $fsort  = get_string("sortbycreation", "glossary");
1734          $ssort  = get_string("sortbylastupdate", "glossary");
1736          $currentsort = $fsort;
1737          if ($sortkey == 'UPDATE') {
1738              $currentsort = $ssort;
1739          }
1740          $sort        = get_string("sortchronogically", "glossary");
1741      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
1742          $forder = 'FIRSTNAME';
1743          $sorder =  'LASTNAME';
1744          $fsort  = get_string("firstname");
1745          $ssort  = get_string("lastname");
1747          $currentsort = $fsort;
1748          if ($sortkey == 'LASTNAME') {
1749              $currentsort = $ssort;
1750          }
1751          $sort        = get_string("sortby", "glossary");
1752      }
1753      $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
1754      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 | ".
1755                           "$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 />";
1758 /**
1759  *
1760  * @param object $entry0
1761  * @param object $entry1
1762  * @return int [-1 | 0 | 1]
1763  */
1764 function glossary_sort_entries ( $entry0, $entry1 ) {
1766     if ( moodle_strtolower(ltrim($entry0->concept)) < moodle_strtolower(ltrim($entry1->concept)) ) {
1767         return -1;
1768     } elseif ( moodle_strtolower(ltrim($entry0->concept)) > moodle_strtolower(ltrim($entry1->concept)) ) {
1769         return 1;
1770     } else {
1771         return 0;
1772     }
1776 /**
1777  * @global object
1778  * @global object
1779  * @global object
1780  * @param object $course
1781  * @param object $entry
1782  * @return bool
1783  */
1784 function  glossary_print_entry_ratings($course, $entry) {
1785     global $OUTPUT;
1786     if( !empty($entry->rating) ){
1787         echo $OUTPUT->render($entry->rating);
1788     }
1791 /**
1792  *
1793  * @global object
1794  * @global object
1795  * @global object
1796  * @param int $courseid
1797  * @param array $entries
1798  * @param int $displayformat
1799  */
1800 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
1801     global $USER,$CFG, $DB;
1803     echo '<div class="boxaligncenter">';
1804     echo '<table class="glossarypopup" cellspacing="0"><tr>';
1805     echo '<td>';
1806     if ( $entries ) {
1807         foreach ( $entries as $entry ) {
1808             if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
1809                 print_error('invalidid', 'glossary');
1810             }
1811             if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
1812                 print_error('coursemisconf');
1813             }
1814             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
1815                 print_error('invalidid', 'glossary');
1816             }
1818             //If displayformat is present, override glossary->displayformat
1819             if ($displayformat < 0) {
1820                 $dp = $glossary->displayformat;
1821             } else {
1822                 $dp = $displayformat;
1823             }
1825             //Get popupformatname
1826             $format = $DB->get_record('glossary_formats', array('name'=>$dp));
1827             $displayformat = $format->popupformatname;
1829             //Check displayformat variable and set to default if necessary
1830             if (!$displayformat) {
1831                 $displayformat = 'dictionary';
1832             }
1834             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1835             $functionname = 'glossary_show_entry_'.$displayformat;
1837             if (file_exists($formatfile)) {
1838                 include_once($formatfile);
1839                 if (function_exists($functionname)) {
1840                     $functionname($course, $cm, $glossary, $entry,'','','','');
1841                 }
1842             }
1843         }
1844     }
1845     echo '</td>';
1846     echo '</tr></table></div>';
1849 /**
1850  *
1851  * @global object
1852  * @param array $entries
1853  * @param array $aliases
1854  * @param array $categories
1855  * @return string
1856  */
1857 function glossary_generate_export_csv($entries, $aliases, $categories) {
1858     global $CFG;
1859     $csv = '';
1860     $delimiter = '';
1861     require_once($CFG->libdir . '/csvlib.class.php');
1862     $delimiter = csv_import_reader::get_delimiter('comma');
1863     $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
1864     $csvaliases = array(0 => array());
1865     $csvcategories = array(0 => array());
1866     $aliascount = 0;
1867     $categorycount = 0;
1869     foreach ($entries as $entry) {
1870         $thisaliasesentry = array();
1871         $thiscategoriesentry = array();
1872         $thiscsventry = array($entry->concept, nl2br($entry->definition));
1874         if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
1875             $thiscount = count($aliases[$entry->id]);
1876             if ($thiscount > $aliascount) {
1877                 $aliascount = $thiscount;
1878             }
1879             foreach ($aliases[$entry->id] as $alias) {
1880                 $thisaliasesentry[] = trim($alias);
1881             }
1882         }
1883         if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
1884             $thiscount = count($categories[$entry->id]);
1885             if ($thiscount > $categorycount) {
1886                 $categorycount = $thiscount;
1887             }
1888             foreach ($categories[$entry->id] as $catentry) {
1889                 $thiscategoriesentry[] = trim($catentry);
1890             }
1891         }
1892         $csventries[$entry->id] = $thiscsventry;
1893         $csvaliases[$entry->id] = $thisaliasesentry;
1894         $csvcategories[$entry->id] = $thiscategoriesentry;
1896     }
1897     $returnstr = '';
1898     foreach ($csventries as $id => $row) {
1899         $aliasstr = '';
1900         $categorystr = '';
1901         if ($id == 0) {
1902             $aliasstr = get_string('alias', 'glossary');
1903             $categorystr = get_string('category', 'glossary');
1904         }
1905         $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
1906         $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
1907     }
1908     return $returnstr;
1911 /**
1912  *
1913  * @param object $glossary
1914  * @param string $ignored invalid parameter
1915  * @param int|string $hook
1916  * @return string
1917  */
1918 function glossary_generate_export_file($glossary, $ignored = "", $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 reset course 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_alias',    "entryid IN ($allentriessql)", $params);
2367         $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2369         // now get rid of all attachments
2370         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2371             foreach ($glossaries as $glossaryid=>$unused) {
2372                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2373                     continue;
2374                 }
2375                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2376                 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2378                 //delete ratings
2379                 $ratingdeloptions->contextid = $context->id;
2380                 $rm->delete_ratings($ratingdeloptions);
2381             }
2382         }
2384         // remove all grades from gradebook
2385         if (empty($data->reset_gradebook_grades)) {
2386             glossary_reset_gradebook($data->courseid);
2387         }
2389         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2391     } else if (!empty($data->reset_glossary_types)) {
2392         $mainentriessql         = "$allentries AND g.mainglossary=1";
2393         $secondaryentriessql    = "$allentries AND g.mainglossary=0";
2395         $mainglossariessql      = "$allglossariessql AND g.mainglossary=1";
2396         $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2398         if (in_array('main', $data->reset_glossary_types)) {
2399             $params[] = 'glossary_entry';
2400             $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params);
2401             $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2403             if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2404                 foreach ($glossaries as $glossaryid=>$unused) {
2405                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2406                         continue;
2407                     }
2408                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2409                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2411                     //delete ratings
2412                     $ratingdeloptions->contextid = $context->id;
2413                     $rm->delete_ratings($ratingdeloptions);
2414                 }
2415             }
2417             // remove all grades from gradebook
2418             if (empty($data->reset_gradebook_grades)) {
2419                 glossary_reset_gradebook($data->courseid, 'main');
2420             }
2422             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary'), 'error'=>false);
2424         } else if (in_array('secondary', $data->reset_glossary_types)) {
2425             $params[] = 'glossary_entry';
2426             $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params);
2427             $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2428             // remove exported source flag from entries in main glossary
2429             $DB->execute("UPDATE {glossary_entries
2430                              SET sourceglossaryid=0
2431                            WHERE glossaryid IN ($mainglossariessql)", $params);
2433             if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2434                 foreach ($glossaries as $glossaryid=>$unused) {
2435                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2436                         continue;
2437                     }
2438                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2439                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2441                     //delete ratings
2442                     $ratingdeloptions->contextid = $context->id;
2443                     $rm->delete_ratings($ratingdeloptions);
2444                 }
2445             }
2447             // remove all grades from gradebook
2448             if (empty($data->reset_gradebook_grades)) {
2449                 glossary_reset_gradebook($data->courseid, 'secondary');
2450             }
2452             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2453         }
2454     }
2456     // remove entries by users not enrolled into course
2457     if (!empty($data->reset_glossary_notenrolled)) {
2458         $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2459                          FROM {glossary_entries} e
2460                               JOIN {glossary} g ON e.glossaryid = g.id
2461                               LEFT JOIN {user} u ON e.userid = u.id
2462                         WHERE g.course = ? AND e.userid > 0";
2464         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2465         $notenrolled = array();
2466         $rs = $DB->get_recordset_sql($entriessql, $params);
2467         if ($rs->valid()) {
2468             foreach ($rs as $entry) {
2469                 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2470                   or !is_enrolled($course_context , $entry->userid)) {
2471                     $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id));
2472                     $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2474                     if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2475                         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2476                         $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
2478                         //delete ratings
2479                         $ratingdeloptions->contextid = $context->id;
2480                         $rm->delete_ratings($ratingdeloptions);
2481                     }
2482                 }
2483             }
2484             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2485         }
2486         $rs->close();
2487     }
2489     // remove all ratings
2490     if (!empty($data->reset_glossary_ratings)) {
2491         //remove ratings
2492         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2493             foreach ($glossaries as $glossaryid=>$unused) {
2494                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2495                     continue;
2496                 }
2497                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2499                 //delete ratings
2500                 $ratingdeloptions->contextid = $context->id;
2501                 $rm->delete_ratings($ratingdeloptions);
2502             }
2503         }
2505         // remove all grades from gradebook
2506         if (empty($data->reset_gradebook_grades)) {
2507             glossary_reset_gradebook($data->courseid);
2508         }
2509         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2510     }
2512     // remove comments
2513     if (!empty($data->reset_glossary_comments)) {
2514         $params[] = 'glossary_entry';
2515         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params);
2516         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2517     }
2519     /// updating dates - shift may be negative too
2520     if ($data->timeshift) {
2521         shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
2522         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2523     }
2525     return $status;
2528 /**
2529  * Returns all other caps used in module
2530  * @return array
2531  */
2532 function glossary_get_extra_capabilities() {
2533     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames', 'moodle/site:trustcontent', 'moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate', 'moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete');
2536 /**
2537  * @param string $feature FEATURE_xx constant for requested feature
2538  * @return mixed True if module supports feature, null if doesn't know
2539  */
2540 function glossary_supports($feature) {
2541     switch($feature) {
2542         case FEATURE_GROUPS:                  return false;
2543         case FEATURE_GROUPINGS:               return false;
2544         case FEATURE_GROUPMEMBERSONLY:        return true;
2545         case FEATURE_MOD_INTRO:               return true;
2546         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2547         case FEATURE_COMPLETION_HAS_RULES:    return true;
2548         case FEATURE_GRADE_HAS_GRADE:         return true;
2549         case FEATURE_GRADE_OUTCOMES:          return true;
2550         case FEATURE_RATE:                    return true;
2551         case FEATURE_BACKUP_MOODLE2:          return true;
2553         default: return null;
2554     }
2557 /**
2558  * Obtains the automatic completion state for this glossary based on any conditions
2559  * in glossary settings.
2560  *
2561  * @global object
2562  * @global object
2563  * @param object $course Course
2564  * @param object $cm Course-module
2565  * @param int $userid User ID
2566  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
2567  * @return bool True if completed, false if not. (If no conditions, then return
2568  *   value depends on comparison type)
2569  */
2570 function glossary_get_completion_state($course,$cm,$userid,$type) {
2571     global $CFG, $DB;
2573     // Get glossary details
2574     if (!($glossary=$DB->get_record('glossary',array('id'=>$cm->instance)))) {
2575         throw new Exception("Can't find glossary {$cm->instance}");
2576     }
2578     $result=$type; // Default return value
2580     if ($glossary->completionentries) {
2581         $value = $glossary->completionentries <=
2582                  $DB->count_records('glossary_entries',array('glossaryid'=>$glossary->id, 'userid'=>$userid, 'approved'=>1));
2583         if ($type == COMPLETION_AND) {
2584             $result = $result && $value;
2585         } else {
2586             $result = $result || $value;
2587         }
2588     }
2590     return $result;
2593 function glossary_extend_navigation($navigation, $course, $module, $cm) {
2594     global $CFG;
2595     $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'letter')));
2596     $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'cat')));
2597     $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'date')));
2598     $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'author')));
2601 /**
2602  * Adds module specific settings to the settings block
2603  *
2604  * @param settings_navigation $settings The settings navigation object
2605  * @param navigation_node $glossarynode The node to add module settings to
2606  */
2607 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
2608     global $PAGE, $DB, $CFG, $USER;
2610     $mode = optional_param('mode', '', PARAM_ALPHA);
2611     $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
2613     if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
2614         $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
2615     }
2617     if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
2618         $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
2619     }
2621     if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
2622         $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
2623     }
2625     if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
2626         $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
2627     }
2629     $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
2631     if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles) {
2632         require_once("$CFG->libdir/rsslib.php");
2634         $string = get_string('rsstype','forum');
2636         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_glossary', $glossary->id));
2637         $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2638     }