MDL-22970 glossary - perf. improvements in recent activity
[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
321     if (!defined('GLOSSARY_RECENT_ACTIVITY_LIMIT')) {
322         define('GLOSSARY_RECENT_ACTIVITY_LIMIT', 50);
323     }
325     $modinfo = get_fast_modinfo($course);
326     $ids = array();
328     foreach ($modinfo->cms as $cm) {
329         if ($cm->modname != 'glossary') {
330             continue;
331         }
332         if (!$cm->uservisible) {
333             continue;
334         }
335         $ids[$cm->instance] = $cm->id;
336     }
338     if (!$ids) {
339         return false;
340     }
342     // generate list of approval capabilities for all glossaries in the course.
343     $approvals = array();
344     foreach ($ids as $glinstanceid => $glcmid) {
345         $context = get_context_instance(CONTEXT_MODULE, $glcmid);
346         // get records glossary entries that are approved if user has no capability to approve entries.
347         if (has_capability('mod/glossary:approve', $context)) {
348             $approvals[] = ' ge.glossaryid = :glsid'.$glinstanceid.' ';
349         } else {
350             $approvals[] = ' (ge.approved = 1 AND ge.glossaryid = :glsid'.$glinstanceid.') ';
351         }
352         $params['glsid'.$glinstanceid] = $glinstanceid;
353     }
355     $selectsql = 'SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
356                                         ge.userid, '.user_picture::fields('u',null,'userid');
357     $countsql = 'SELECT COUNT(*)';
359     $joins = array(' FROM {glossary_entries} ge ');
360     $joins[] = 'JOIN {user} u ON u.id = ge.userid ';
361     $fromsql = implode($joins, "\n");
363     $params['timestart'] = $timestart;
364     $clausesql = ' WHERE ge.timemodified > :timestart AND (';
365     $approvalsql = implode($approvals, ' OR ');
367     $ordersql = ') ORDER BY ge.timemodified ASC';
369     $entries = $DB->get_records_sql($selectsql.$fromsql.$clausesql.$approvalsql.$ordersql, $params, 0, (GLOSSARY_RECENT_ACTIVITY_LIMIT+1));
371     if (empty($entries)) {
372         return false;
373     }
375     echo $OUTPUT->heading(get_string('newentries', 'glossary').':');
377     $strftimerecent = get_string('strftimerecent');
378     $entrycount = 0;
379     foreach ($entries as $entry) {
380         if ($entrycount < GLOSSARY_RECENT_ACTIVITY_LIMIT) {
381             if ($entry->approved) {
382                 $dimmed = '';
383                 $urlparams = array('g' => $entry->glossaryid, 'mode' => 'entry', 'hook' => $entry->id);
384             } else {
385                 $dimmed = ' dimmed_text';
386                 $urlparams = array('id' => $ids[$entry->glossaryid], 'mode' => 'approval', 'hook' => format_text($entry->concept, true));
387             }
388             $link = new moodle_url($CFG->wwwroot.'/mod/glossary/view.php' , $urlparams);
389             echo '<div class="head'.$dimmed.'">';
390             echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
391             echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
392             echo '</div>';
393             echo '<div class="info"><a href="'.$link.'">'.format_text($entry->concept, true).'</a></div>';
394             $entrycount += 1;
395         } else {
396             $numnewentries = $DB->count_records_sql($countsql.$joins[0].$clausesql.$approvalsql.')', $params);
397             echo '<div class="head"><div class="activityhead">'.get_string('andmorenewentries', 'glossary', $numnewentries - GLOSSARY_RECENT_ACTIVITY_LIMIT).'</div></div>';
398             break;
399         }
400     }
402     return true;
405 /**
406  * @global object
407  * @param object $log
408  */
409 function glossary_log_info($log) {
410     global $DB;
412     return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
413                                   FROM {glossary_entries} e, {user} u
414                                  WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
417 /**
418  * Function to be run periodically according to the moodle cron
419  * This function searches for things that need to be done, such
420  * as sending out mail, toggling flags etc ...
421  * @return bool
422  */
423 function glossary_cron () {
424     return true;
427 /**
428  * Return grade for given user or all users.
429  *
430  * @global object
431  * @param int $glossaryid id of glossary
432  * @param int $userid optional user id, 0 means all users
433  * @return array array of grades, false if none
434  */
435 function glossary_get_user_grades($glossary, $userid=0) {
436     global $CFG;
438     require_once($CFG->dirroot.'/rating/lib.php');
439     $rm = new rating_manager();
441     $ratingoptions = new stdclass();
443     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
444     $ratingoptions->modulename = 'glossary';
445     $ratingoptions->moduleid   = $glossary->id;
447     $ratingoptions->userid = $userid;
448     $ratingoptions->aggregationmethod = $glossary->assessed;
449     $ratingoptions->scaleid = $glossary->scale;
450     $ratingoptions->itemtable = 'glossary_entries';
451     $ratingoptions->itemtableusercolumn = 'userid';
453     return $rm->get_user_grades($ratingoptions);
456 /**
457  * Return rating related permissions
458  * @param string $options the context id
459  * @return array an associative array of the user's rating permissions
460  */
461 function glossary_rating_permissions($options) {
462     $contextid = $options;
463     $context = get_context_instance_by_id($contextid);
465     if (!$context) {
466         print_error('invalidcontext');
467         return null;
468     } else {
469         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));
470     }
473 /**
474  * Returns the names of the table and columns necessary to check items for ratings
475  * @return array an array containing the item table, item id and user id columns
476  */
477 function glossary_rating_item_check_info() {
478     return array('glossary_entries','id','userid');
481 /**
482  * Update activity grades
483  *
484  * @global object
485  * @global object
486  * @param object $glossary null means all glossaries (with extra cmidnumber property)
487  * @param int $userid specific user only, 0 means all
488  */
489 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
490     global $CFG, $DB;
491     require_once($CFG->libdir.'/gradelib.php');
493     if (!$glossary->assessed) {
494         glossary_grade_item_update($glossary);
496     } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
497         glossary_grade_item_update($glossary, $grades);
499     } else if ($userid and $nullifnone) {
500         $grade = new stdClass();
501         $grade->userid   = $userid;
502         $grade->rawgrade = NULL;
503         glossary_grade_item_update($glossary, $grade);
505     } else {
506         glossary_grade_item_update($glossary);
507     }
510 /**
511  * Update all grades in gradebook.
512  *
513  * @global object
514  */
515 function glossary_upgrade_grades() {
516     global $DB;
518     $sql = "SELECT COUNT('x')
519               FROM {glossary} g, {course_modules} cm, {modules} m
520              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
521     $count = $DB->count_records_sql($sql);
523     $sql = "SELECT g.*, cm.idnumber AS cmidnumber, g.course AS courseid
524               FROM {glossary} g, {course_modules} cm, {modules} m
525              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
526     $rs = $DB->get_recordset_sql($sql);
527     if ($rs->valid()) {
528         $pbar = new progress_bar('glossaryupgradegrades', 500, true);
529         $i=0;
530         foreach ($rs as $glossary) {
531             $i++;
532             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
533             glossary_update_grades($glossary, 0, false);
534             $pbar->update($i, $count, "Updating Glossary grades ($i/$count).");
535         }
536     }
537     $rs->close();
540 /**
541  * Create/update grade item for given glossary
542  *
543  * @global object
544  * @param object $glossary object with extra cmidnumber
545  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
546  * @return int, 0 if ok, error code otherwise
547  */
548 function glossary_grade_item_update($glossary, $grades=NULL) {
549     global $CFG;
550     require_once($CFG->libdir.'/gradelib.php');
552     $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
554     if (!$glossary->assessed or $glossary->scale == 0) {
555         $params['gradetype'] = GRADE_TYPE_NONE;
557     } else if ($glossary->scale > 0) {
558         $params['gradetype'] = GRADE_TYPE_VALUE;
559         $params['grademax']  = $glossary->scale;
560         $params['grademin']  = 0;
562     } else if ($glossary->scale < 0) {
563         $params['gradetype'] = GRADE_TYPE_SCALE;
564         $params['scaleid']   = -$glossary->scale;
565     }
567     if ($grades  === 'reset') {
568         $params['reset'] = true;
569         $grades = NULL;
570     }
572     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
575 /**
576  * Delete grade item for given glossary
577  *
578  * @global object
579  * @param object $glossary object
580  */
581 function glossary_grade_item_delete($glossary) {
582     global $CFG;
583     require_once($CFG->libdir.'/gradelib.php');
585     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
588 /**
589  * Returns the users with data in one glossary
590  * (users with records in glossary_entries, students)
591  *
592  * @global object
593  * @param int $glossaryid
594  * @return array
595  */
596 function glossary_get_participants($glossaryid) {
597     global $DB;
599     //Get students
600     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
601                                         FROM {user} u, {glossary_entries} g
602                                  WHERE g.glossaryid = ? AND u.id = g.userid", array($glossaryid));
604     //Return students array (it contains an array of unique users)
605     return $students;
608 /**
609  * @global object
610  * @param int $gloassryid
611  * @param int $scaleid
612  * @return bool
613  */
614 function glossary_scale_used ($glossaryid,$scaleid) {
615 //This function returns if a scale is being used by one glossary
616     global $DB;
618     $return = false;
620     $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
622     if (!empty($rec)  && !empty($scaleid)) {
623         $return = true;
624     }
626     return $return;
629 /**
630  * Checks if scale is being used by any instance of glossary
631  *
632  * This is used to find out if scale used anywhere
633  *
634  * @global object
635  * @param int $scaleid
636  * @return boolean True if the scale is used by any glossary
637  */
638 function glossary_scale_used_anywhere($scaleid) {
639     global $DB;
641     if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
642         return true;
643     } else {
644         return false;
645     }
648 //////////////////////////////////////////////////////////////////////////////////////
649 /// Any other glossary functions go here.  Each of them must have a name that
650 /// starts with glossary_
652 /**
653  * This function return an array of valid glossary_formats records
654  * Everytime it's called, every existing format is checked, new formats
655  * are included if detected and old formats are deleted and any glossary
656  * using an invalid format is updated to the default (dictionary).
657  *
658  * @global object
659  * @global object
660  * @return array
661  */
662 function glossary_get_available_formats() {
663     global $CFG, $DB;
665     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
666     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
667     $pluginformats = array();
668     foreach ($formats as $format) {
669         //If the format file exists
670         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
671             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
672             //If the function exists
673             if (function_exists('glossary_show_entry_'.$format)) {
674                 //Acummulate it as a valid format
675                 $pluginformats[] = $format;
676                 //If the format doesn't exist in the table
677                 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
678                     //Insert the record in glossary_formats
679                     $gf = new stdClass();
680                     $gf->name = $format;
681                     $gf->popupformatname = $format;
682                     $gf->visible = 1;
683                     $DB->insert_record("glossary_formats",$gf);
684                 }
685             }
686         }
687     }
689     //Delete non_existent formats from glossary_formats table
690     $formats = $DB->get_records("glossary_formats");
691     foreach ($formats as $format) {
692         $todelete = false;
693         //If the format in DB isn't a valid previously detected format then delete the record
694         if (!in_array($format->name,$pluginformats)) {
695             $todelete = true;
696         }
698         if ($todelete) {
699             //Delete the format
700             $DB->delete_records('glossary_formats', array('name'=>$format->name));
701             //Reasign existing glossaries to default (dictionary) format
702             if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
703                 foreach($glossaries as $glossary) {
704                     $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
705                 }
706             }
707         }
708     }
710     //Now everything is ready in glossary_formats table
711     $formats = $DB->get_records("glossary_formats");
713     return $formats;
716 /**
717  * @param bool $debug
718  * @param string $text
719  * @param int $br
720  */
721 function glossary_debug($debug,$text,$br=1) {
722     if ( $debug ) {
723         echo '<font color="red">' . $text . '</font>';
724         if ( $br ) {
725             echo '<br />';
726         }
727     }
730 /**
731  *
732  * @global object
733  * @param int $glossaryid
734  * @param string $entrylist
735  * @param string $pivot
736  * @return array
737  */
738 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
739     global $DB;
740     if ($pivot) {
741        $pivot .= ",";
742     }
744     return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
745                                    FROM {glossary_entries}
746                                   WHERE glossaryid = ?
747                                         AND id IN ($entrylist)", array($glossaryid));
750 /**
751  * @global object
752  * @global object
753  * @param object $concept
754  * @param string $courseid
755  * @return array
756  */
757 function glossary_get_entries_search($concept, $courseid) {
758     global $CFG, $DB;
760     //Check if the user is an admin
761     $bypassadmin = 1; //This means NO (by default)
762     if (has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_SYSTEM))) {
763         $bypassadmin = 0; //This means YES
764     }
766     //Check if the user is a teacher
767     $bypassteacher = 1; //This means NO (by default)
768     if (has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $courseid))) {
769         $bypassteacher = 0; //This means YES
770     }
772     $conceptlower = moodle_strtolower(trim($concept));
774     $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
776     return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
777                                    FROM {glossary_entries} e, {glossary} g,
778                                         {course_modules} cm, {modules} m
779                                   WHERE m.name = 'glossary' AND
780                                         cm.module = m.id AND
781                                         (cm.visible = 1 OR  cm.visible = $bypassadmin OR
782                                             (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
783                                         g.id = cm.instance AND
784                                         e.glossaryid = g.id  AND
785                                         ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
786                                           (e.casesensitive = 0 and concept = :concept)) AND
787                                         (g.course = :courseid2 OR g.globalglossary = 1) AND
788                                          e.usedynalink != 0 AND
789                                          g.usedynalink != 0", $params);
792 /**
793  * @global object
794  * @global object
795  * @param object $course
796  * @param object $course
797  * @param object $glossary
798  * @param object $entry
799  * @param string $mode
800  * @param string $hook
801  * @param int $printicons
802  * @param int $displayformat
803  * @param bool $printview
804  * @return mixed
805  */
806 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $printview = false) {
807     global $USER, $CFG;
808     $return = false;
809     if ( $displayformat < 0 ) {
810         $displayformat = $glossary->displayformat;
811     }
812     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
813         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
814         if ($printview) {
815             $functionname = 'glossary_print_entry_'.$displayformat;
816         } else {
817             $functionname = 'glossary_show_entry_'.$displayformat;
818         }
820         if (file_exists($formatfile)) {
821             include_once($formatfile);
822             if (function_exists($functionname)) {
823                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
824             } else if ($printview) {
825                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
826                 $return = glossary_print_entry_default($entry, $glossary, $cm);
827             }
828         }
829     }
830     return $return;
833 /**
834  * Default (old) print format used if custom function doesn't exist in format
835  *
836  * @param object $entry
837  * @param object $glossary
838  * @param object $cm
839  * @return void Output is echo'd
840  */
841 function glossary_print_entry_default ($entry, $glossary, $cm) {
842     global $CFG;
844     require_once($CFG->libdir . '/filelib.php');
846     echo '<h3>'. strip_tags($entry->concept) . ': </h3>';
848     $definition = $entry->definition;
850     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
852     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
853     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
855     $options = new stdClass();
856     $options->para = false;
857     $options->trusted = $entry->definitiontrust;
858     $options->context = $context;
859     $options->overflowdiv = true;
860     $definition = format_text($definition, $entry->definitionformat, $options);
861     echo ($definition);
862     echo '<br /><br />';
865 /**
866  * Print glossary concept/term as a heading &lt;h3>
867  * @param object $entry
868  */
869 function  glossary_print_entry_concept($entry, $return=false) {
870     global $OUTPUT;
871     $options = new stdClass();
872     $options->para = false;
873     $text = format_text($OUTPUT->heading('<span class="nolink">' . $entry->concept . '</span>', 3, 'nolink'), FORMAT_MOODLE, $options);
874     if (!empty($entry->highlight)) {
875         $text = highlight($entry->highlight, $text);
876     }
878     if ($return) {
879         return $text;
880     } else {
881         echo $text;
882     }
885 /**
886  *
887  * @global moodle_database DB
888  * @param object $entry
889  * @param object $glossary
890  * @param object $cm
891  */
892 function glossary_print_entry_definition($entry, $glossary, $cm) {
893     global $DB, $GLOSSARY_EXCLUDECONCEPTS;
895     $definition = $entry->definition;
897     //Calculate all the strings to be no-linked
898     //First, the concept
899     $GLOSSARY_EXCLUDECONCEPTS = array($entry->concept);
900     //Now the aliases
901     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
902         foreach ($aliases as $alias) {
903             $GLOSSARY_EXCLUDECONCEPTS[]=trim($alias->alias);
904         }
905     }
907     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
908     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
910     $options = new stdClass();
911     $options->para = false;
912     $options->trusted = $entry->definitiontrust;
913     $options->context = $context;
914     $options->overflowdiv = true;
915     $text = format_text($definition, $entry->definitionformat, $options);
917     // Stop excluding concepts from autolinking
918     unset($GLOSSARY_EXCLUDECONCEPTS);
920     if (!empty($entry->highlight)) {
921         $text = highlight($entry->highlight, $text);
922     }
923     if (isset($entry->footer)) {   // Unparsed footer info
924         $text .= $entry->footer;
925     }
926     echo $text;
929 /**
930  *
931  * @global object
932  * @param object $course
933  * @param object $cm
934  * @param object $glossary
935  * @param object $entry
936  * @param string $mode
937  * @param string $hook
938  * @param string $type
939  * @return string|void
940  */
941 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
942     global $DB;
944     $return = '';
945     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
946         foreach ($aliases as $alias) {
947             if (trim($alias->alias)) {
948                 if ($return == '') {
949                     $return = '<select style="font-size:8pt">';
950                 }
951                 $return .= "<option>$alias->alias</option>";
952             }
953         }
954         if ($return != '') {
955             $return .= '</select>';
956         }
957     }
958     if ($type == 'print') {
959         echo $return;
960     } else {
961         return $return;
962     }
965 /**
966  *
967  * @global object
968  * @global object
969  * @global object
970  * @param object $course
971  * @param object $cm
972  * @param object $glossary
973  * @param object $entry
974  * @param string $mode
975  * @param string $hook
976  * @param string $type
977  * @return string|void
978  */
979 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
980     global $USER, $CFG, $DB, $OUTPUT;
982     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
984     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
985     $importedentry = ($entry->sourceglossaryid == $glossary->id);
986     $ismainglossary = $glossary->mainglossary;
989     $return = '<span class="commands">';
990     // Differentiate links for each entry.
991     $altsuffix = ': '.strip_tags(format_text($entry->concept));
993     if (!$entry->approved) {
994         $output = true;
995         $return .= get_string('entryishidden','glossary');
996     }
998     if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $entry->userid == $USER->id)) {
999         // only teachers can export entries so check it out
1000         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
1001             $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
1002             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
1003                 $output = true;
1004                 $return .= ' <a title="'.get_string('exporttomainglossary','glossary') . '" href="exportentry.php?id='.$entry->id.'&amp;prevmode='.$mode.'&amp;hook='.urlencode($hook).'"><img src="'.$OUTPUT->pix_url('export', 'glossary').'" class="iconsmall" alt="'.get_string('exporttomainglossary','glossary').$altsuffix.'" /></a>';
1005             }
1006         }
1008         if ( $entry->sourceglossaryid ) {
1009             $icon = $OUTPUT->pix_url('minus', 'glossary');   // graphical metaphor (minus) for deleting an imported entry
1010         } else {
1011             $icon = $OUTPUT->pix_url('t/delete');
1012         }
1014         //Decide if an entry is editable:
1015         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
1016         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1017         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
1018         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1019             $output = true;
1020             $return .= " <a title=\"" . get_string("delete") . "\" href=\"deleteentry.php?id=$cm->id&amp;mode=delete&amp;entry=$entry->id&amp;prevmode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"";
1021             $return .= $icon;
1022             $return .= "\" class=\"iconsmall\" alt=\"" . get_string("delete") .$altsuffix."\" /></a> ";
1024             $return .= " <a title=\"" . get_string("edit") . "\" href=\"edit.php?cmid=$cm->id&amp;id=$entry->id&amp;mode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"" . $OUTPUT->pix_url('t/edit') . "\" class=\"iconsmall\" alt=\"" . get_string("edit") .$altsuffix. "\" /></a>";
1025         } elseif ( $importedentry ) {
1026             $return .= " <font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1027         }
1028     }
1029     if (has_capability('mod/glossary:exportentry', $context)
1030         || ($entry->userid == $USER->id
1031             && has_capability('mod/glossary:exportownentry', $context))) {
1032         require_once($CFG->libdir . '/portfoliolib.php');
1033         $button = new portfolio_add_button();
1034         $button->set_callback_options('glossary_entry_portfolio_caller',  array('id' => $cm->id, 'entryid' => $entry->id), '/mod/glossary/locallib.php');
1036         $filecontext = $context;
1037         if ($entry->sourceglossaryid == $cm->instance) {
1038             if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1039                 $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1040             }
1041         }
1042         $fs = get_file_storage();
1043         if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1044             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1045         } else {
1046             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1047         }
1049         $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1050     }
1051     $return .= "&nbsp;&nbsp;"; // just to make up a little the output in Mozilla ;)
1053     $return .= '</span>';
1055     if (has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1056         $output = true;
1057         if (!empty($CFG->usecomments)) {
1058             require_once($CFG->dirroot . '/comment/lib.php');
1059             $cmt = new stdClass();
1060             $cmt->component = 'mod_glossary';
1061             $cmt->context  = $context;
1062             $cmt->course   = $course;
1063             $cmt->cm       = $cm;
1064             $cmt->area     = 'glossary_entry';
1065             $cmt->itemid   = $entry->id;
1066             $cmt->showcount = true;
1067             $comment = new comment($cmt);
1068             $return .= '<div>'.$comment->output(true).'</div>';
1069         }
1070     }
1072     //If we haven't calculated any REAL thing, delete result ($return)
1073     if (!$output) {
1074         $return = '';
1075     }
1076     //Print or get
1077     if ($type == 'print') {
1078         echo $return;
1079     } else {
1080         return $return;
1081     }
1084 /**
1085  * @param object $course
1086  * @param object $cm
1087  * @param object $glossary
1088  * @param object $entry
1089  * @param string $mode
1090  * @param object $hook
1091  * @param bool $printicons
1092  * @param bool $aliases
1093  * @return void
1094  */
1095 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1096     if ($aliases) {
1097         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1098     }
1099     $icons   = '';
1100     if ($printicons) {
1101         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1102     }
1103     if ($aliases || $icons || !empty($entry->rating)) {
1104         echo '<table>';
1105         if ( $aliases ) {
1106             echo '<tr valign="top"><td class="aliases">' .
1107                   get_string('aliases','glossary').': '.$aliases . '</td></tr>';
1108         }
1109         if ($icons) {
1110             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1111         }
1112         if (!empty($entry->rating)) {
1113             echo '<tr valign="top"><td class="ratings">';
1114             glossary_print_entry_ratings($course, $entry);
1115             echo '</td></tr>';
1116         }
1117         echo '</table>';
1118     }
1121 /**
1122  * @todo Document this function
1123  */
1124 function glossary_print_entry_attachment($entry, $cm, $format=NULL, $align="right", $insidetable=true) {
1125 ///   valid format values: html  : Return the HTML link for the attachment as an icon
1126 ///                        text  : Return the HTML link for tha attachment as text
1127 ///                        blank : Print the output to the screen
1128     if ($entry->attachment) {
1129           if ($insidetable) {
1130               echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
1131           }
1132           echo glossary_print_attachments($entry, $cm, $format, $align);
1133           if ($insidetable) {
1134               echo "</td></tr></table>\n";
1135           }
1136     }
1139 /**
1140  * @global object
1141  * @param object $cm
1142  * @param object $entry
1143  * @param string $mode
1144  * @param string $align
1145  * @param bool $insidetable
1146  */
1147 function  glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1148     global $CFG, $OUTPUT;
1150     if ($mode == 'approval' and !$entry->approved) {
1151         if ($insidetable) {
1152             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1153         }
1154         echo '<a title="'.get_string('approve','glossary').'" href="approve.php?eid='.$entry->id.'&amp;mode='.$mode.'&amp;sesskey='.sesskey().'"><img align="'.$align.'" src="'.$OUTPUT->pix_url('i/approve') . '" style="border:0px; width:34px; height:34px" alt="'.get_string('approve','glossary').'" /></a>';
1155         if ($insidetable) {
1156             echo '</td></tr></table>';
1157         }
1158     }
1161 /**
1162  * It returns all entries from all glossaries that matches the specified criteria
1163  *  within a given $course. It performs an $extended search if necessary.
1164  * It restrict the search to only one $glossary if the $glossary parameter is set.
1165  *
1166  * @global object
1167  * @global object
1168  * @param object $course
1169  * @param array $searchterms
1170  * @param int $extended
1171  * @param object $glossary
1172  * @return array
1173  */
1174 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1175     global $CFG, $DB;
1177     if ( !$glossary ) {
1178         if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1179             $glos = "";
1180             foreach ( $glossaries as $glossary ) {
1181                 $glos .= "$glossary->id,";
1182             }
1183             $glos = substr($glos,0,-1);
1184         }
1185     } else {
1186         $glos = $glossary->id;
1187     }
1189     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $glossary->course))) {
1190         $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1191         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1192         $onlyvisibletable = ", {course_modules} cm";
1193     } else {
1195         $onlyvisible = "";
1196         $onlyvisibletable = "";
1197     }
1199     if ($DB->sql_regex_supported()) {
1200         $REGEXP    = $DB->sql_regex(true);
1201         $NOTREGEXP = $DB->sql_regex(false);
1202     }
1204     $searchcond = array();
1205     $params     = array();
1206     $i = 0;
1208     $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1211     foreach ($searchterms as $searchterm) {
1212         $i++;
1214         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1215                    /// will use it to simulate the "-" operator with LIKE clause
1217     /// Under Oracle and MSSQL, trim the + and - operators and perform
1218     /// simpler LIKE (or NOT LIKE) queries
1219         if (!$DB->sql_regex_supported()) {
1220             if (substr($searchterm, 0, 1) == '-') {
1221                 $NOT = true;
1222             }
1223             $searchterm = trim($searchterm, '+-');
1224         }
1226         // TODO: +- may not work for non latin languages
1228         if (substr($searchterm,0,1) == '+') {
1229             $searchterm = trim($searchterm, '+-');
1230             $searchterm = preg_quote($searchterm, '|');
1231             $searchcond[] = "$concat $REGEXP :ss$i";
1232             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1234         } else if (substr($searchterm,0,1) == "-") {
1235             $searchterm = trim($searchterm, '+-');
1236             $searchterm = preg_quote($searchterm, '|');
1237             $searchcond[] = "$concat $NOTREGEXP :ss$i";
1238             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1240         } else {
1241             $searchcond[] = $DB->sql_like($concat, ":ss$i", false, true, $NOT);
1242             $params['ss'.$i] = "%$searchterm%";
1243         }
1244     }
1246     if (empty($searchcond)) {
1247         $totalcount = 0;
1248         return array();
1249     }
1251     $searchcond = implode(" AND ", $searchcond);
1253     $sql = "SELECT e.*
1254               FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1255              WHERE $searchcond
1256                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1257                AND g.id IN ($glos) AND e.approved <> 0";
1259     return $DB->get_records_sql($sql, $params);
1262 /**
1263  * @global object
1264  * @param array $searchterms
1265  * @param object $glossary
1266  * @param bool $extended
1267  * @return array
1268  */
1269 function glossary_search_entries($searchterms, $glossary, $extended) {
1270     global $DB;
1272     $course = $DB->get_record("course", array("id"=>$glossary->course));
1273     return glossary_search($course,$searchterms,$extended,$glossary);
1276 /**
1277  * if return=html, then return a html string.
1278  * if return=text, then return a text-only string.
1279  * otherwise, print HTML for non-images, and return image HTML
1280  *     if attachment is an image, $align set its aligment.
1281  *
1282  * @global object
1283  * @global object
1284  * @param object $entry
1285  * @param object $cm
1286  * @param string $type html, txt, empty
1287  * @param string $align left or right
1288  * @return string image string or nothing depending on $type param
1289  */
1290 function glossary_print_attachments($entry, $cm, $type=NULL, $align="left") {
1291     global $CFG, $DB, $OUTPUT;
1293     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
1294         return '';
1295     }
1297     if ($entry->sourceglossaryid == $cm->instance) {
1298         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1299             return '';
1300         }
1301         $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1303     } else {
1304         $filecontext = $context;
1305     }
1307     $strattachment = get_string('attachment', 'glossary');
1309     $fs = get_file_storage();
1311     $imagereturn = '';
1312     $output = '';
1314     if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1315         foreach ($files as $file) {
1316             $filename = $file->get_filename();
1317             $mimetype = $file->get_mimetype();
1318             $iconimage = '<img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />';
1319             $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename);
1321             if ($type == 'html') {
1322                 $output .= "<a href=\"$path\">$iconimage</a> ";
1323                 $output .= "<a href=\"$path\">".s($filename)."</a>";
1324                 $output .= "<br />";
1326             } else if ($type == 'text') {
1327                 $output .= "$strattachment ".s($filename).":\n$path\n";
1329             } else {
1330                 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1331                     // Image attachments don't get printed as links
1332                     $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1333                 } else {
1334                     $output .= "<a href=\"$path\">$iconimage</a> ";
1335                     $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context));
1336                     $output .= '<br />';
1337                 }
1338             }
1339         }
1340     }
1342     if ($type) {
1343         return $output;
1344     } else {
1345         echo $output;
1346         return $imagereturn;
1347     }
1350 /**
1351  * Lists all browsable file areas
1352  *
1353  * @param object $course
1354  * @param object $cm
1355  * @param object $context
1356  * @return array
1357  */
1358 function glossary_get_file_areas($course, $cm, $context) {
1359     $areas = array();
1360     return $areas;
1363 /**
1364  * Serves the glossary attachments. Implements needed access control ;-)
1365  *
1366  * @param object $course
1367  * @param object $cm
1368  * @param object $context
1369  * @param string $filearea
1370  * @param array $args
1371  * @param bool $forcedownload
1372  * @return bool false if file not found, does not return if found - justsend the file
1373  */
1374 function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
1375     global $CFG, $DB;
1377     if ($context->contextlevel != CONTEXT_MODULE) {
1378         return false;
1379     }
1381     require_course_login($course, true, $cm);
1383     if ($filearea === 'attachment' or $filearea === 'entry') {
1384         $entryid = (int)array_shift($args);
1386         require_course_login($course, true, $cm);
1388         if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1389             return false;
1390         }
1392         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1393             return false;
1394         }
1396         if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1397             return false;
1398         }
1400         // this trickery here is because we need to support source glossary access
1402         if ($entry->glossaryid == $cm->instance) {
1403             $filecontext = $context;
1405         } else if ($entry->sourceglossaryid == $cm->instance) {
1406             if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1407                 return false;
1408             }
1409             $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1411         } else {
1412             return false;
1413         }
1415         $relativepath = implode('/', $args);
1416         $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath";
1418         $fs = get_file_storage();
1419         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1420             return false;
1421         }
1423         // finally send the file
1424         send_stored_file($file, 0, 0, true); // download MUST be forced - security!
1426     } else if ($filearea === 'export') {
1427         require_login($course, false, $cm);
1428         require_capability('mod/glossary:export', $context);
1430         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1431             return false;
1432         }
1434         $cat = array_shift($args);
1435         $cat = clean_param($cat, PARAM_ALPHANUM);
1437         $filename = clean_filename(strip_tags(format_string($glossary->name)).'.xml');
1438         $content = glossary_generate_export_file($glossary, NULL, $cat);
1440         send_file($content, $filename, 0, 0, true, true);
1441     }
1443     return false;
1446 /**
1447  *
1448  */
1449 function glossary_print_tabbed_table_end() {
1450      echo "</div></div>";
1453 /**
1454  * @param object $cm
1455  * @param object $glossary
1456  * @param string $mode
1457  * @param string $hook
1458  * @param string $sortkey
1459  * @param string $sortorder
1460  */
1461 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1462     if ($glossary->showalphabet) {
1463         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1464     }
1465     glossary_print_special_links($cm, $glossary, $mode, $hook);
1467     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1469     glossary_print_all_links($cm, $glossary, $mode, $hook);
1471     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1473 /**
1474  * @param object $cm
1475  * @param object $glossary
1476  * @param string $hook
1477  * @param string $sortkey
1478  * @param string $sortorder
1479  */
1480 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1481     echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1484 /**
1485  * @param object $cm
1486  * @param object $glossary
1487  * @param string $hook
1488  * @param string $sortkey
1489  * @param string $sortorder
1490  */
1491 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1492     echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1494 /**
1495  * @param object $cm
1496  * @param object $glossary
1497  * @param string $hook
1498  * @param string $sortkey
1499  * @param string $sortorder
1500  */
1501 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1502     if ( $mode != 'date' ) {
1503         if ($glossary->showalphabet) {
1504             echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1505         }
1507         glossary_print_special_links($cm, $glossary, $mode, $hook);
1509         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1511         glossary_print_all_links($cm, $glossary, $mode, $hook);
1512     } else {
1513         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1514     }
1517 /**
1518  * @param object $cm
1519  * @param object $glossary
1520  * @param string $hook
1521  * @param string $sortkey
1522  * @param string $sortorder
1523  */
1524 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1525     if ($glossary->showalphabet) {
1526         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1527     }
1529     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1530     glossary_print_all_links($cm, $glossary, $mode, $hook);
1531     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1534 /**
1535  * @global object
1536  * @global object
1537  * @param object $cm
1538  * @param object $glossary
1539  * @param string $hook
1540  * @param object $category
1541  */
1542 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1543      global $CFG, $DB, $OUTPUT;
1545      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1547      echo '<table border="0" width="100%">';
1548      echo '<tr>';
1550      echo '<td align="center" style="width:20%">';
1551      if (has_capability('mod/glossary:managecategories', $context)) {
1552              $options['id'] = $cm->id;
1553              $options['mode'] = 'cat';
1554              $options['hook'] = $hook;
1555              echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1556      }
1557      echo '</td>';
1559      echo '<td align="center" style="width:60%">';
1560      echo '<b>';
1562      $menu = array();
1563      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1564      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1566      $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1567      $selected = '';
1568      if ( $categories ) {
1569           foreach ($categories as $currentcategory) {
1570                  $url = $currentcategory->id;
1571                  if ( $category ) {
1572                      if ($currentcategory->id == $category->id) {
1573                          $selected = $url;
1574                      }
1575                  }
1576                  $menu[$url] = clean_text($currentcategory->name); //Only clean, not filters
1577           }
1578      }
1579      if ( !$selected ) {
1580          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1581      }
1583      if ( $category ) {
1584         echo format_text($category->name, FORMAT_PLAIN);
1585      } else {
1586         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1588             echo get_string("entrieswithoutcategory","glossary");
1589             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1591         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1593             echo get_string("allcategories","glossary");
1594             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1596         }
1597      }
1598      echo '</b></td>';
1599      echo '<td align="center" style="width:20%">';
1601      $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1602      echo $OUTPUT->render($select);
1604      echo '</td>';
1605      echo '</tr>';
1607      echo '</table>';
1610 /**
1611  * @global object
1612  * @param object $cm
1613  * @param object $glossary
1614  * @param string $mode
1615  * @param string $hook
1616  */
1617 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1618 global $CFG;
1619      if ( $glossary->showall) {
1620          $strallentries       = get_string("allentries", "glossary");
1621          if ( $hook == 'ALL' ) {
1622               echo "<b>$strallentries</b>";
1623          } else {
1624               $strexplainall = strip_tags(get_string("explainall","glossary"));
1625               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1626          }
1627      }
1630 /**
1631  * @global object
1632  * @param object $cm
1633  * @param object $glossary
1634  * @param string $mode
1635  * @param string $hook
1636  */
1637 function glossary_print_special_links($cm, $glossary, $mode, $hook) {
1638 global $CFG;
1639      if ( $glossary->showspecial) {
1640          $strspecial          = get_string("special", "glossary");
1641          if ( $hook == 'SPECIAL' ) {
1642               echo "<b>$strspecial</b> | ";
1643          } else {
1644               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1645               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
1646          }
1647      }
1650 /**
1651  * @global object
1652  * @param object $glossary
1653  * @param string $mode
1654  * @param string $hook
1655  * @param string $sortkey
1656  * @param string $sortorder
1657  */
1658 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1659 global $CFG;
1660      if ( $glossary->showalphabet) {
1661           $alphabet = explode(",", get_string('alphabet', 'langconfig'));
1662           for ($i = 0; $i < count($alphabet); $i++) {
1663               if ( $hook == $alphabet[$i] and $hook) {
1664                    echo "<b>$alphabet[$i]</b>";
1665               } else {
1666                    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>";
1667               }
1668               echo ' | ';
1669           }
1670      }
1673 /**
1674  * @global object
1675  * @param object $cm
1676  * @param string $mode
1677  * @param string $sortkey
1678  * @param string $sortorder
1679  */
1680 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
1681     global $CFG, $OUTPUT;
1683     $asc    = get_string("ascending","glossary");
1684     $desc   = get_string("descending","glossary");
1685     $bopen  = '<b>';
1686     $bclose = '</b>';
1688      $neworder = '';
1689      $currentorder = '';
1690      $currentsort = '';
1691      if ( $sortorder ) {
1692          if ( $sortorder == 'asc' ) {
1693              $currentorder = $asc;
1694              $neworder = '&amp;sortorder=desc';
1695              $newordertitle = get_string('changeto', 'glossary', $desc);
1696          } else {
1697              $currentorder = $desc;
1698              $neworder = '&amp;sortorder=asc';
1699              $newordertitle = get_string('changeto', 'glossary', $asc);
1700          }
1701          $icon = " <img src=\"".$OUTPUT->pix_url($sortorder, 'glossary')."\" class=\"icon\" alt=\"$newordertitle\" />";
1702      } else {
1703          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
1704                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
1705              $icon = "";
1706              $newordertitle = $asc;
1707          } else {
1708              $newordertitle = $desc;
1709              $neworder = '&amp;sortorder=desc';
1710              $icon = ' <img src="'.$OUTPUT->pix_url('asc', 'glossary').'" class="icon" alt="'.$newordertitle.'" />';
1711          }
1712      }
1713      $ficon     = '';
1714      $fneworder = '';
1715      $fbtag     = '';
1716      $fendbtag  = '';
1718      $sicon     = '';
1719      $sneworder = '';
1721      $sbtag      = '';
1722      $fbtag      = '';
1723      $fendbtag      = '';
1724      $sendbtag      = '';
1726      $sendbtag  = '';
1728      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
1729          $ficon       = $icon;
1730          $fneworder   = $neworder;
1731          $fordertitle = $newordertitle;
1732          $sordertitle = $asc;
1733          $fbtag       = $bopen;
1734          $fendbtag    = $bclose;
1735      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
1736          $sicon = $icon;
1737          $sneworder   = $neworder;
1738          $fordertitle = $asc;
1739          $sordertitle = $newordertitle;
1740          $sbtag       = $bopen;
1741          $sendbtag    = $bclose;
1742      } else {
1743          $fordertitle = $asc;
1744          $sordertitle = $asc;
1745      }
1747      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
1748          $forder = 'CREATION';
1749          $sorder =  'UPDATE';
1750          $fsort  = get_string("sortbycreation", "glossary");
1751          $ssort  = get_string("sortbylastupdate", "glossary");
1753          $currentsort = $fsort;
1754          if ($sortkey == 'UPDATE') {
1755              $currentsort = $ssort;
1756          }
1757          $sort        = get_string("sortchronogically", "glossary");
1758      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
1759          $forder = 'FIRSTNAME';
1760          $sorder =  'LASTNAME';
1761          $fsort  = get_string("firstname");
1762          $ssort  = get_string("lastname");
1764          $currentsort = $fsort;
1765          if ($sortkey == 'LASTNAME') {
1766              $currentsort = $ssort;
1767          }
1768          $sort        = get_string("sortby", "glossary");
1769      }
1770      $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
1771      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 | ".
1772                           "$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 />";
1775 /**
1776  *
1777  * @param object $entry0
1778  * @param object $entry1
1779  * @return int [-1 | 0 | 1]
1780  */
1781 function glossary_sort_entries ( $entry0, $entry1 ) {
1783     if ( moodle_strtolower(ltrim($entry0->concept)) < moodle_strtolower(ltrim($entry1->concept)) ) {
1784         return -1;
1785     } elseif ( moodle_strtolower(ltrim($entry0->concept)) > moodle_strtolower(ltrim($entry1->concept)) ) {
1786         return 1;
1787     } else {
1788         return 0;
1789     }
1793 /**
1794  * @global object
1795  * @global object
1796  * @global object
1797  * @param object $course
1798  * @param object $entry
1799  * @return bool
1800  */
1801 function  glossary_print_entry_ratings($course, $entry) {
1802     global $OUTPUT;
1803     if( !empty($entry->rating) ){
1804         echo $OUTPUT->render($entry->rating);
1805     }
1808 /**
1809  *
1810  * @global object
1811  * @global object
1812  * @global object
1813  * @param int $courseid
1814  * @param array $entries
1815  * @param int $displayformat
1816  */
1817 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
1818     global $USER,$CFG, $DB;
1820     echo '<div class="boxaligncenter">';
1821     echo '<table class="glossarypopup" cellspacing="0"><tr>';
1822     echo '<td>';
1823     if ( $entries ) {
1824         foreach ( $entries as $entry ) {
1825             if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
1826                 print_error('invalidid', 'glossary');
1827             }
1828             if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
1829                 print_error('coursemisconf');
1830             }
1831             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
1832                 print_error('invalidid', 'glossary');
1833             }
1835             //If displayformat is present, override glossary->displayformat
1836             if ($displayformat < 0) {
1837                 $dp = $glossary->displayformat;
1838             } else {
1839                 $dp = $displayformat;
1840             }
1842             //Get popupformatname
1843             $format = $DB->get_record('glossary_formats', array('name'=>$dp));
1844             $displayformat = $format->popupformatname;
1846             //Check displayformat variable and set to default if necessary
1847             if (!$displayformat) {
1848                 $displayformat = 'dictionary';
1849             }
1851             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1852             $functionname = 'glossary_show_entry_'.$displayformat;
1854             if (file_exists($formatfile)) {
1855                 include_once($formatfile);
1856                 if (function_exists($functionname)) {
1857                     $functionname($course, $cm, $glossary, $entry,'','','','');
1858                 }
1859             }
1860         }
1861     }
1862     echo '</td>';
1863     echo '</tr></table></div>';
1866 /**
1867  *
1868  * @global object
1869  * @param array $entries
1870  * @param array $aliases
1871  * @param array $categories
1872  * @return string
1873  */
1874 function glossary_generate_export_csv($entries, $aliases, $categories) {
1875     global $CFG;
1876     $csv = '';
1877     $delimiter = '';
1878     require_once($CFG->libdir . '/csvlib.class.php');
1879     $delimiter = csv_import_reader::get_delimiter('comma');
1880     $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
1881     $csvaliases = array(0 => array());
1882     $csvcategories = array(0 => array());
1883     $aliascount = 0;
1884     $categorycount = 0;
1886     foreach ($entries as $entry) {
1887         $thisaliasesentry = array();
1888         $thiscategoriesentry = array();
1889         $thiscsventry = array($entry->concept, nl2br($entry->definition));
1891         if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
1892             $thiscount = count($aliases[$entry->id]);
1893             if ($thiscount > $aliascount) {
1894                 $aliascount = $thiscount;
1895             }
1896             foreach ($aliases[$entry->id] as $alias) {
1897                 $thisaliasesentry[] = trim($alias);
1898             }
1899         }
1900         if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
1901             $thiscount = count($categories[$entry->id]);
1902             if ($thiscount > $categorycount) {
1903                 $categorycount = $thiscount;
1904             }
1905             foreach ($categories[$entry->id] as $catentry) {
1906                 $thiscategoriesentry[] = trim($catentry);
1907             }
1908         }
1909         $csventries[$entry->id] = $thiscsventry;
1910         $csvaliases[$entry->id] = $thisaliasesentry;
1911         $csvcategories[$entry->id] = $thiscategoriesentry;
1913     }
1914     $returnstr = '';
1915     foreach ($csventries as $id => $row) {
1916         $aliasstr = '';
1917         $categorystr = '';
1918         if ($id == 0) {
1919             $aliasstr = get_string('alias', 'glossary');
1920             $categorystr = get_string('category', 'glossary');
1921         }
1922         $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
1923         $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
1924     }
1925     return $returnstr;
1928 /**
1929  *
1930  * @param object $glossary
1931  * @param string $ignored invalid parameter
1932  * @param int|string $hook
1933  * @return string
1934  */
1935 function glossary_generate_export_file($glossary, $ignored = "", $hook = 0) {
1936     global $CFG, $DB;
1938     $co  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1940     $co .= glossary_start_tag("GLOSSARY",0,true);
1941     $co .= glossary_start_tag("INFO",1,true);
1942         $co .= glossary_full_tag("NAME",2,false,$glossary->name);
1943         $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
1944         $co .= glossary_full_tag("INTROFORMAT",2,false,$glossary->introformat);
1945         $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
1946         $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
1947         $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
1948         $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
1949         $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
1950         $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
1951         $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
1952         $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
1953         $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
1954         $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
1956         if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) {
1957             $co .= glossary_start_tag("ENTRIES",2,true);
1958             foreach ($entries as $entry) {
1959                 $permissiongranted = 1;
1960                 if ( $hook ) {
1961                     switch ( $hook ) {
1962                     case "ALL":
1963                     case "SPECIAL":
1964                     break;
1965                     default:
1966                         $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
1967                     break;
1968                     }
1969                 }
1970                 if ( $hook ) {
1971                     switch ( $hook ) {
1972                     case GLOSSARY_SHOW_ALL_CATEGORIES:
1973                     break;
1974                     case GLOSSARY_SHOW_NOT_CATEGORISED:
1975                         $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id));
1976                     break;
1977                     default:
1978                         $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook));
1979                     break;
1980                     }
1981                 }
1982                 if ( $entry->approved and $permissiongranted ) {
1983                     $co .= glossary_start_tag("ENTRY",3,true);
1984                     $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
1985                     $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition);
1986                     $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat); // note: use old name for BC reasons
1987                     $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
1988                     $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
1989                     $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
1990                     $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
1992                     if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) {
1993                         $co .= glossary_start_tag("ALIASES",4,true);
1994                         foreach ($aliases as $alias) {
1995                             $co .= glossary_start_tag("ALIAS",5,true);
1996                                 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
1997                             $co .= glossary_end_tag("ALIAS",5,true);
1998                         }
1999                         $co .= glossary_end_tag("ALIASES",4,true);
2000                     }
2001                     if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) {
2002                         $co .= glossary_start_tag("CATEGORIES",4,true);
2003                         foreach ($catentries as $catentry) {
2004                             $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid));
2006                             $co .= glossary_start_tag("CATEGORY",5,true);
2007                                 $co .= glossary_full_tag("NAME",6,false,$category->name);
2008                                 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
2009                             $co .= glossary_end_tag("CATEGORY",5,true);
2010                         }
2011                         $co .= glossary_end_tag("CATEGORIES",4,true);
2012                     }
2014                     $co .= glossary_end_tag("ENTRY",3,true);
2015                 }
2016             }
2017             $co .= glossary_end_tag("ENTRIES",2,true);
2019         }
2022     $co .= glossary_end_tag("INFO",1,true);
2023     $co .= glossary_end_tag("GLOSSARY",0,true);
2025     return $co;
2027 /// Functions designed by Eloy Lafuente
2028 /// Functions to create, open and write header of the xml file
2030 /**
2031  * Read import file and convert to current charset
2032  *
2033  * @global object
2034  * @param string $file
2035  * @return string
2036  */
2037 function glossary_read_imported_file($file_content) {
2038     require_once "../../lib/xmlize.php";
2039     global $CFG;
2041     return xmlize($file_content, 0);
2044 /**
2045  * Return the xml start tag
2046  *
2047  * @param string $tag
2048  * @param int $level
2049  * @param bool $endline
2050  * @return string
2051  */
2052 function glossary_start_tag($tag,$level=0,$endline=false) {
2053         if ($endline) {
2054            $endchar = "\n";
2055         } else {
2056            $endchar = "";
2057         }
2058         return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
2061 /**
2062  * Return the xml end tag
2063  * @param string $tag
2064  * @param int $level
2065  * @param bool $endline
2066  * @return string
2067  */
2068 function glossary_end_tag($tag,$level=0,$endline=true) {
2069         if ($endline) {
2070            $endchar = "\n";
2071         } else {
2072            $endchar = "";
2073         }
2074         return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
2077 /**
2078  * Return the start tag, the contents and the end tag
2079  *
2080  * @global object
2081  * @param string $tag
2082  * @param int $level
2083  * @param bool $endline
2084  * @param string $content
2085  * @return string
2086  */
2087 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
2088         global $CFG;
2090         $st = glossary_start_tag($tag,$level,$endline);
2091         $co = preg_replace("/\r\n|\r/", "\n", s($content));
2092         $et = glossary_end_tag($tag,0,true);
2093         return $st.$co.$et;
2096 /**
2097  * How many unrated entries are in the given glossary for a given user?
2098  *
2099  * @global object
2100  * @param int $glossaryid
2101  * @param int $userid
2102  * @return int
2103  */
2104 function glossary_count_unrated_entries($glossaryid, $userid) {
2105     global $DB;
2106     if ($entries = $DB->get_record_sql("SELECT count('x') as num
2107                                           FROM {glossary_entries}
2108                                          WHERE glossaryid = ? AND userid <> ?", array($glossaryid, $userid))) {
2110         if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2111             return 0;
2112         }
2113         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2115         if ($rated = $DB->get_record_sql("SELECT count(*) as num
2116                                             FROM {glossary_entries} e, {ratings} r
2117                                            WHERE e.glossaryid = :glossaryid AND e.id = r.itemid
2118                                                  AND r.userid = :userid and r.contextid = :contextid",
2119                 array('glossaryid'=>$glossaryid, 'userid'=>$userid, 'contextid'=>$context->id))) {
2121             $difference = $entries->num - $rated->num;
2122             if ($difference > 0) {
2123                 return $difference;
2124             } else {
2125                 return 0;    // Just in case there was a counting error
2126             }
2127         } else {
2128             return $entries->num;
2129         }
2130     } else {
2131         return 0;
2132     }
2135 /**
2136  *
2137  * Returns the html code to represent any pagging bar. Paramenters are:
2138  *
2139  * The function dinamically show the first and last pages, and "scroll" over pages.
2140  * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
2141  * could replace the general one. ;-)
2142  *
2143  * @param int $totalcount total number of records to be displayed
2144  * @param int $page page currently selected (0 based)
2145  * @param int $perpage number of records per page
2146  * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically.
2147  *
2148  * @param int $maxpageallowed Optional maximum number of page allowed.
2149  * @param int $maxdisplay Optional maximum number of page links to show in the bar
2150  * @param string $separator Optional string to be used between pages in the bar
2151  * @param string $specialtext Optional string to be showed as an special link
2152  * @param string $specialvalue Optional value (page) to be used in the special link
2153  * @param bool $previousandnext Optional to decide if we want the previous and next links
2154  * @return string
2155  */
2156 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) {
2158     $code = '';
2160     $showspecial = false;
2161     $specialselected = false;
2163     //Check if we have to show the special link
2164     if (!empty($specialtext)) {
2165         $showspecial = true;
2166     }
2167     //Check if we are with the special link selected
2168     if ($showspecial && $page == $specialvalue) {
2169         $specialselected = true;
2170     }
2172     //If there are results (more than 1 page)
2173     if ($totalcount > $perpage) {
2174         $code .= "<div style=\"text-align:center\">";
2175         $code .= "<p>".get_string("page").":";
2177         $maxpage = (int)(($totalcount-1)/$perpage);
2179         //Lower and upper limit of page
2180         if ($page < 0) {
2181             $page = 0;
2182         }
2183         if ($page > $maxpageallowed) {
2184             $page = $maxpageallowed;
2185         }
2186         if ($page > $maxpage) {
2187             $page = $maxpage;
2188         }
2190         //Calculate the window of pages
2191         $pagefrom = $page - ((int)($maxdisplay / 2));
2192         if ($pagefrom < 0) {
2193             $pagefrom = 0;
2194         }
2195         $pageto = $pagefrom + $maxdisplay - 1;
2196         if ($pageto > $maxpageallowed) {
2197             $pageto = $maxpageallowed;
2198         }
2199         if ($pageto > $maxpage) {
2200             $pageto = $maxpage;
2201         }
2203         //Some movements can be necessary if don't see enought pages
2204         if ($pageto - $pagefrom < $maxdisplay - 1) {
2205             if ($pageto - $maxdisplay + 1 > 0) {
2206                 $pagefrom = $pageto - $maxdisplay + 1;
2207             }
2208         }
2210         //Calculate first and last if necessary
2211         $firstpagecode = '';
2212         $lastpagecode = '';
2213         if ($pagefrom > 0) {
2214             $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2215             if ($pagefrom > 1) {
2216                 $firstpagecode .= "$separator...";
2217             }
2218         }
2219         if ($pageto < $maxpage) {
2220             if ($pageto < $maxpage -1) {
2221                 $lastpagecode = "$separator...";
2222             }
2223             $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2224         }
2226         //Previous
2227         if ($page > 0 && $previousandnext) {
2228             $pagenum = $page - 1;
2229             $code .= "&nbsp;(<a  href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;";
2230         }
2232         //Add first
2233         $code .= $firstpagecode;
2235         $pagenum = $pagefrom;
2237         //List of maxdisplay pages
2238         while ($pagenum <= $pageto) {
2239             $pagetoshow = $pagenum +1;
2240             if ($pagenum == $page && !$specialselected) {
2241                 $code .= "$separator<b>$pagetoshow</b>";
2242             } else {
2243                 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2244             }
2245             $pagenum++;
2246         }
2248         //Add last
2249         $code .= $lastpagecode;
2251         //Next
2252         if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2253             $pagenum = $page + 1;
2254             $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2255         }
2257         //Add special
2258         if ($showspecial) {
2259             $code .= '<br />';
2260             if ($specialselected) {
2261                 $code .= "<b>$specialtext</b>";
2262             } else {
2263                 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2264             }
2265         }
2267         //End html
2268         $code .= "</p>";
2269         $code .= "</div>";
2270     }
2272     return $code;
2274 /**
2275  * @return array
2276  */
2277 function glossary_get_view_actions() {
2278     return array('view','view all','view entry');
2280 /**
2281  * @return array
2282  */
2283 function glossary_get_post_actions() {
2284     return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry');
2288 /**
2289  * Implementation of the function for printing the form elements that control
2290  * whether the course reset functionality affects the glossary.
2291  * @param object $mform form passed by reference
2292  */
2293 function glossary_reset_course_form_definition(&$mform) {
2294     $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary'));
2295     $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary'));
2297     $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'),
2298                        array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple'));
2299     $mform->setAdvanced('reset_glossary_types');
2300     $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked');
2302     $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary'));
2303     $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked');
2305     $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings'));
2306     $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked');
2308     $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments'));
2309     $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked');
2312 /**
2313  * Course reset form defaults.
2314  * @return array
2315  */
2316 function glossary_reset_course_form_defaults($course) {
2317     return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0);
2320 /**
2321  * Removes all grades from gradebook
2322  *
2323  * @global object
2324  * @param int $courseid
2325  * @param string optional type
2326  */
2327 function glossary_reset_gradebook($courseid, $type='') {
2328     global $DB;
2330     switch ($type) {
2331         case 'main'      : $type = "AND g.mainglossary=1"; break;
2332         case 'secondary' : $type = "AND g.mainglossary=0"; break;
2333         default          : $type = ""; //all
2334     }
2336     $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid
2337               FROM {glossary} g, {course_modules} cm, {modules} m
2338              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type";
2340     if ($glossarys = $DB->get_records_sql($sql, array($courseid))) {
2341         foreach ($glossarys as $glossary) {
2342             glossary_grade_item_update($glossary, 'reset');
2343         }
2344     }
2346 /**
2347  * Actual implementation of the reset course functionality, delete all the
2348  * glossary responses for course $data->courseid.
2349  *
2350  * @global object
2351  * @param $data the data submitted from the reset course.
2352  * @return array status array
2353  */
2354 function glossary_reset_userdata($data) {
2355     global $CFG, $DB;
2356     require_once($CFG->dirroot.'/rating/lib.php');
2358     $componentstr = get_string('modulenameplural', 'glossary');
2359     $status = array();
2361     $allentriessql = "SELECT e.id
2362                         FROM {glossary_entries} e
2363                              JOIN {glossary} g ON e.glossaryid = g.id
2364                        WHERE g.course = ?";
2366     $allglossariessql = "SELECT g.id
2367                            FROM {glossary} g
2368                           WHERE g.course = ?";
2370     $params = array($data->courseid);
2372     $fs = get_file_storage();
2374     $rm = new rating_manager();
2375     $ratingdeloptions = new stdclass();
2377     // delete entries if requested
2378     if (!empty($data->reset_glossary_all)
2379          or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) {
2381         $params[] = 'glossary_entry';
2382         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea=?", $params);
2383         $DB->delete_records_select('glossary_alias',    "entryid IN ($allentriessql)", $params);
2384         $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2386         // now get rid of all attachments
2387         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2388             foreach ($glossaries as $glossaryid=>$unused) {
2389                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2390                     continue;
2391                 }
2392                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2393                 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2395                 //delete ratings
2396                 $ratingdeloptions->contextid = $context->id;
2397                 $rm->delete_ratings($ratingdeloptions);
2398             }
2399         }
2401         // remove all grades from gradebook
2402         if (empty($data->reset_gradebook_grades)) {
2403             glossary_reset_gradebook($data->courseid);
2404         }
2406         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2408     } else if (!empty($data->reset_glossary_types)) {
2409         $mainentriessql         = "$allentries AND g.mainglossary=1";
2410         $secondaryentriessql    = "$allentries AND g.mainglossary=0";
2412         $mainglossariessql      = "$allglossariessql AND g.mainglossary=1";
2413         $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2415         if (in_array('main', $data->reset_glossary_types)) {
2416             $params[] = 'glossary_entry';
2417             $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params);
2418             $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2420             if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2421                 foreach ($glossaries as $glossaryid=>$unused) {
2422                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2423                         continue;
2424                     }
2425                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2426                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2428                     //delete ratings
2429                     $ratingdeloptions->contextid = $context->id;
2430                     $rm->delete_ratings($ratingdeloptions);
2431                 }
2432             }
2434             // remove all grades from gradebook
2435             if (empty($data->reset_gradebook_grades)) {
2436                 glossary_reset_gradebook($data->courseid, 'main');
2437             }
2439             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary'), 'error'=>false);
2441         } else if (in_array('secondary', $data->reset_glossary_types)) {
2442             $params[] = 'glossary_entry';
2443             $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params);
2444             $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2445             // remove exported source flag from entries in main glossary
2446             $DB->execute("UPDATE {glossary_entries
2447                              SET sourceglossaryid=0
2448                            WHERE glossaryid IN ($mainglossariessql)", $params);
2450             if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2451                 foreach ($glossaries as $glossaryid=>$unused) {
2452                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2453                         continue;
2454                     }
2455                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2456                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2458                     //delete ratings
2459                     $ratingdeloptions->contextid = $context->id;
2460                     $rm->delete_ratings($ratingdeloptions);
2461                 }
2462             }
2464             // remove all grades from gradebook
2465             if (empty($data->reset_gradebook_grades)) {
2466                 glossary_reset_gradebook($data->courseid, 'secondary');
2467             }
2469             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2470         }
2471     }
2473     // remove entries by users not enrolled into course
2474     if (!empty($data->reset_glossary_notenrolled)) {
2475         $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2476                          FROM {glossary_entries} e
2477                               JOIN {glossary} g ON e.glossaryid = g.id
2478                               LEFT JOIN {user} u ON e.userid = u.id
2479                         WHERE g.course = ? AND e.userid > 0";
2481         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2482         $notenrolled = array();
2483         $rs = $DB->get_recordset_sql($entriessql, $params);
2484         if ($rs->valid()) {
2485             foreach ($rs as $entry) {
2486                 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2487                   or !is_enrolled($course_context , $entry->userid)) {
2488                     $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id));
2489                     $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2491                     if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2492                         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2493                         $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
2495                         //delete ratings
2496                         $ratingdeloptions->contextid = $context->id;
2497                         $rm->delete_ratings($ratingdeloptions);
2498                     }
2499                 }
2500             }
2501             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2502         }
2503         $rs->close();
2504     }
2506     // remove all ratings
2507     if (!empty($data->reset_glossary_ratings)) {
2508         //remove ratings
2509         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2510             foreach ($glossaries as $glossaryid=>$unused) {
2511                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2512                     continue;
2513                 }
2514                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2516                 //delete ratings
2517                 $ratingdeloptions->contextid = $context->id;
2518                 $rm->delete_ratings($ratingdeloptions);
2519             }
2520         }
2522         // remove all grades from gradebook
2523         if (empty($data->reset_gradebook_grades)) {
2524             glossary_reset_gradebook($data->courseid);
2525         }
2526         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2527     }
2529     // remove comments
2530     if (!empty($data->reset_glossary_comments)) {
2531         $params[] = 'glossary_entry';
2532         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params);
2533         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2534     }
2536     /// updating dates - shift may be negative too
2537     if ($data->timeshift) {
2538         shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
2539         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2540     }
2542     return $status;
2545 /**
2546  * Returns all other caps used in module
2547  * @return array
2548  */
2549 function glossary_get_extra_capabilities() {
2550     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');
2553 /**
2554  * @param string $feature FEATURE_xx constant for requested feature
2555  * @return mixed True if module supports feature, null if doesn't know
2556  */
2557 function glossary_supports($feature) {
2558     switch($feature) {
2559         case FEATURE_GROUPS:                  return false;
2560         case FEATURE_GROUPINGS:               return false;
2561         case FEATURE_GROUPMEMBERSONLY:        return true;
2562         case FEATURE_MOD_INTRO:               return true;
2563         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2564         case FEATURE_COMPLETION_HAS_RULES:    return true;
2565         case FEATURE_GRADE_HAS_GRADE:         return true;
2566         case FEATURE_GRADE_OUTCOMES:          return true;
2567         case FEATURE_RATE:                    return true;
2568         case FEATURE_BACKUP_MOODLE2:          return true;
2570         default: return null;
2571     }
2574 /**
2575  * Obtains the automatic completion state for this glossary based on any conditions
2576  * in glossary settings.
2577  *
2578  * @global object
2579  * @global object
2580  * @param object $course Course
2581  * @param object $cm Course-module
2582  * @param int $userid User ID
2583  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
2584  * @return bool True if completed, false if not. (If no conditions, then return
2585  *   value depends on comparison type)
2586  */
2587 function glossary_get_completion_state($course,$cm,$userid,$type) {
2588     global $CFG, $DB;
2590     // Get glossary details
2591     if (!($glossary=$DB->get_record('glossary',array('id'=>$cm->instance)))) {
2592         throw new Exception("Can't find glossary {$cm->instance}");
2593     }
2595     $result=$type; // Default return value
2597     if ($glossary->completionentries) {
2598         $value = $glossary->completionentries <=
2599                  $DB->count_records('glossary_entries',array('glossaryid'=>$glossary->id, 'userid'=>$userid, 'approved'=>1));
2600         if ($type == COMPLETION_AND) {
2601             $result = $result && $value;
2602         } else {
2603             $result = $result || $value;
2604         }
2605     }
2607     return $result;
2610 function glossary_extend_navigation($navigation, $course, $module, $cm) {
2611     global $CFG;
2612     $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'letter')));
2613     $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'cat')));
2614     $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'date')));
2615     $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'author')));
2618 /**
2619  * Adds module specific settings to the settings block
2620  *
2621  * @param settings_navigation $settings The settings navigation object
2622  * @param navigation_node $glossarynode The node to add module settings to
2623  */
2624 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
2625     global $PAGE, $DB, $CFG, $USER;
2627     $mode = optional_param('mode', '', PARAM_ALPHA);
2628     $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
2630     if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
2631         $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
2632     }
2634     if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
2635         $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
2636     }
2638     if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
2639         $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
2640     }
2642     if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
2643         $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
2644     }
2646     $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
2648     if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles) {
2649         require_once("$CFG->libdir/rsslib.php");
2651         $string = get_string('rsstype','forum');
2653         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_glossary', $glossary->id));
2654         $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2655     }