Merge branch 'MDL-55808_master' of git://github.com/juancs/moodle
[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->libdir . '/completionlib.php');
28 define("GLOSSARY_SHOW_ALL_CATEGORIES", 0);
29 define("GLOSSARY_SHOW_NOT_CATEGORISED", -1);
31 define("GLOSSARY_NO_VIEW", -1);
32 define("GLOSSARY_STANDARD_VIEW", 0);
33 define("GLOSSARY_CATEGORY_VIEW", 1);
34 define("GLOSSARY_DATE_VIEW", 2);
35 define("GLOSSARY_AUTHOR_VIEW", 3);
36 define("GLOSSARY_ADDENTRY_VIEW", 4);
37 define("GLOSSARY_IMPORT_VIEW", 5);
38 define("GLOSSARY_EXPORT_VIEW", 6);
39 define("GLOSSARY_APPROVAL_VIEW", 7);
41 // Glossary tabs.
42 define('GLOSSARY_STANDARD', 'standard');
43 define('GLOSSARY_AUTHOR', 'author');
44 define('GLOSSARY_CATEGORY', 'category');
45 define('GLOSSARY_DATE', 'date');
47 // Glossary displayformats.
48 define('GLOSSARY_CONTINUOUS', 'continuous');
49 define('GLOSSARY_DICTIONARY', 'dictionary');
50 define('GLOSSARY_FULLWITHOUTAUTHOR', 'fullwithoutauthor');
52 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
53 /**
54  * @global object
55  * @param object $glossary
56  * @return int
57  */
58 function glossary_add_instance($glossary) {
59     global $DB;
60 /// Given an object containing all the necessary data,
61 /// (defined by the form in mod_form.php) this function
62 /// will create a new instance and return the id number
63 /// of the new instance.
65     if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
66         $glossary->assesstimestart  = 0;
67         $glossary->assesstimefinish = 0;
68     }
70     if (empty($glossary->globalglossary) ) {
71         $glossary->globalglossary = 0;
72     }
74     if (!has_capability('mod/glossary:manageentries', context_system::instance())) {
75         $glossary->globalglossary = 0;
76     }
78     $glossary->timecreated  = time();
79     $glossary->timemodified = $glossary->timecreated;
81     //Check displayformat is a valid one
82     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
83     if (!in_array($glossary->displayformat, $formats)) {
84         print_error('unknowformat', '', '', $glossary->displayformat);
85     }
87     $returnid = $DB->insert_record("glossary", $glossary);
88     $glossary->id = $returnid;
89     glossary_grade_item_update($glossary);
91     $completiontimeexpected = !empty($glossary->completionexpected) ? $glossary->completionexpected : null;
92     \core_completion\api::update_completion_date_event($glossary->coursemodule,
93         'glossary', $glossary->id, $completiontimeexpected);
95     return $returnid;
96 }
98 /**
99  * Given an object containing all the necessary data,
100  * (defined by the form in mod_form.php) this function
101  * will update an existing instance with new data.
102  *
103  * @global object
104  * @global object
105  * @param object $glossary
106  * @return bool
107  */
108 function glossary_update_instance($glossary) {
109     global $CFG, $DB;
111     if (empty($glossary->globalglossary)) {
112         $glossary->globalglossary = 0;
113     }
115     if (!has_capability('mod/glossary:manageentries', context_system::instance())) {
116         // keep previous
117         unset($glossary->globalglossary);
118     }
120     $glossary->timemodified = time();
121     $glossary->id           = $glossary->instance;
123     if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
124         $glossary->assesstimestart  = 0;
125         $glossary->assesstimefinish = 0;
126     }
128     //Check displayformat is a valid one
129     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
130     if (!in_array($glossary->displayformat, $formats)) {
131         print_error('unknowformat', '', '', $glossary->displayformat);
132     }
134     $DB->update_record("glossary", $glossary);
135     if ($glossary->defaultapproval) {
136         $DB->execute("UPDATE {glossary_entries} SET approved = 1 where approved <> 1 and glossaryid = ?", array($glossary->id));
137     }
138     glossary_grade_item_update($glossary);
140     $completiontimeexpected = !empty($glossary->completionexpected) ? $glossary->completionexpected : null;
141     \core_completion\api::update_completion_date_event($glossary->coursemodule,
142         'glossary', $glossary->id, $completiontimeexpected);
144     return true;
147 /**
148  * Given an ID of an instance of this module,
149  * this function will permanently delete the instance
150  * and any data that depends on it.
151  *
152  * @global object
153  * @param int $id glossary id
154  * @return bool success
155  */
156 function glossary_delete_instance($id) {
157     global $DB, $CFG;
159     if (!$glossary = $DB->get_record('glossary', array('id'=>$id))) {
160         return false;
161     }
163     if (!$cm = get_coursemodule_from_instance('glossary', $id)) {
164         return false;
165     }
167     if (!$context = context_module::instance($cm->id, IGNORE_MISSING)) {
168         return false;
169     }
171     $fs = get_file_storage();
173     if ($glossary->mainglossary) {
174         // unexport entries
175         $sql = "SELECT ge.id, ge.sourceglossaryid, cm.id AS sourcecmid
176                   FROM {glossary_entries} ge
177                   JOIN {modules} m ON m.name = 'glossary'
178                   JOIN {course_modules} cm ON (cm.module = m.id AND cm.instance = ge.sourceglossaryid)
179                  WHERE ge.glossaryid = ? AND ge.sourceglossaryid > 0";
181         if ($exported = $DB->get_records_sql($sql, array($id))) {
182             foreach ($exported as $entry) {
183                 $entry->glossaryid = $entry->sourceglossaryid;
184                 $entry->sourceglossaryid = 0;
185                 $newcontext = context_module::instance($entry->sourcecmid);
186                 if ($oldfiles = $fs->get_area_files($context->id, 'mod_glossary', 'attachment', $entry->id)) {
187                     foreach ($oldfiles as $oldfile) {
188                         $file_record = new stdClass();
189                         $file_record->contextid = $newcontext->id;
190                         $fs->create_file_from_storedfile($file_record, $oldfile);
191                     }
192                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
193                     $entry->attachment = '1';
194                 } else {
195                     $entry->attachment = '0';
196                 }
197                 $DB->update_record('glossary_entries', $entry);
198             }
199         }
200     } else {
201         // move exported entries to main glossary
202         $sql = "UPDATE {glossary_entries}
203                    SET sourceglossaryid = 0
204                  WHERE sourceglossaryid = ?";
205         $DB->execute($sql, array($id));
206     }
208     // Delete any dependent records
209     $entry_select = "SELECT id FROM {glossary_entries} WHERE glossaryid = ?";
210     $DB->delete_records_select('comments', "contextid=? AND commentarea=? AND itemid IN ($entry_select)", array($id, 'glossary_entry', $context->id));
211     $DB->delete_records_select('glossary_alias',    "entryid IN ($entry_select)", array($id));
213     $category_select = "SELECT id FROM {glossary_categories} WHERE glossaryid = ?";
214     $DB->delete_records_select('glossary_entries_categories', "categoryid IN ($category_select)", array($id));
215     $DB->delete_records('glossary_categories', array('glossaryid'=>$id));
216     $DB->delete_records('glossary_entries', array('glossaryid'=>$id));
218     // delete all files
219     $fs->delete_area_files($context->id);
221     glossary_grade_item_delete($glossary);
223     \core_completion\api::update_completion_date_event($cm->id, 'glossary', $glossary->id, null);
225     $DB->delete_records('glossary', array('id'=>$id));
227     // Reset caches.
228     \mod_glossary\local\concept_cache::reset_glossary($glossary);
230     return true;
233 /**
234  * Return a small object with summary information about what a
235  * user has done with a given particular instance of this module
236  * Used for user activity reports.
237  * $return->time = the time they did it
238  * $return->info = a short text description
239  *
240  * @param object $course
241  * @param object $user
242  * @param object $mod
243  * @param object $glossary
244  * @return object|null
245  */
246 function glossary_user_outline($course, $user, $mod, $glossary) {
247     global $CFG;
249     require_once("$CFG->libdir/gradelib.php");
250     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
251     if (empty($grades->items[0]->grades)) {
252         $grade = false;
253     } else {
254         $grade = reset($grades->items[0]->grades);
255     }
257     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
258         $result = new stdClass();
259         $result->info = count($entries) . ' ' . get_string("entries", "glossary");
261         $lastentry = array_pop($entries);
262         $result->time = $lastentry->timemodified;
264         if ($grade) {
265             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
266         }
267         return $result;
268     } else if ($grade) {
269         $result = new stdClass();
270         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
272         //datesubmitted == time created. dategraded == time modified or time overridden
273         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
274         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
275         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
276             $result->time = $grade->dategraded;
277         } else {
278             $result->time = $grade->datesubmitted;
279         }
281         return $result;
282     }
283     return NULL;
286 /**
287  * @global object
288  * @param int $glossaryid
289  * @param int $userid
290  * @return array
291  */
292 function glossary_get_user_entries($glossaryid, $userid) {
293 /// Get all the entries for a user in a glossary
294     global $DB;
296     return $DB->get_records_sql("SELECT e.*, u.firstname, u.lastname, u.email, u.picture
297                                    FROM {glossary} g, {glossary_entries} e, {user} u
298                              WHERE g.id = ?
299                                AND e.glossaryid = g.id
300                                AND e.userid = ?
301                                AND e.userid = u.id
302                           ORDER BY e.timemodified ASC", array($glossaryid, $userid));
305 /**
306  * Print a detailed representation of what a  user has done with
307  * a given particular instance of this module, for user activity reports.
308  *
309  * @global object
310  * @param object $course
311  * @param object $user
312  * @param object $mod
313  * @param object $glossary
314  */
315 function glossary_user_complete($course, $user, $mod, $glossary) {
316     global $CFG, $OUTPUT;
317     require_once("$CFG->libdir/gradelib.php");
319     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
320     if (!empty($grades->items[0]->grades)) {
321         $grade = reset($grades->items[0]->grades);
322         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
323         if ($grade->str_feedback) {
324             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
325         }
326     }
328     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
329         echo '<table width="95%" border="0"><tr><td>';
330         foreach ($entries as $entry) {
331             $cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id);
332             glossary_print_entry($course, $cm, $glossary, $entry,"","",0);
333             echo '<p>';
334         }
335         echo '</td></tr></table>';
336     }
339 /**
340  * Returns all glossary entries since a given time for specified glossary
341  *
342  * @param array $activities sequentially indexed array of objects
343  * @param int   $index
344  * @param int   $timestart
345  * @param int   $courseid
346  * @param int   $cmid
347  * @param int   $userid defaults to 0
348  * @param int   $groupid defaults to 0
349  * @return void adds items into $activities and increases $index
350  */
351 function glossary_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid = 0, $groupid = 0) {
352     global $COURSE, $USER, $DB;
354     if ($COURSE->id == $courseid) {
355         $course = $COURSE;
356     } else {
357         $course = $DB->get_record('course', array('id' => $courseid));
358     }
360     $modinfo = get_fast_modinfo($course);
361     $cm = $modinfo->cms[$cmid];
362     $context = context_module::instance($cm->id);
364     if (!$cm->uservisible) {
365         return;
366     }
368     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
369     // Groups are not yet supported for glossary. See MDL-10728 .
370     /*
371     $accessallgroups = has_capability('moodle/site:accessallgroups', $context);
372     $groupmode = groups_get_activity_groupmode($cm, $course);
373      */
375     $params['timestart'] = $timestart;
377     if ($userid) {
378         $userselect = "AND u.id = :userid";
379         $params['userid'] = $userid;
380     } else {
381         $userselect = '';
382     }
384     if ($groupid) {
385         $groupselect = 'AND gm.groupid = :groupid';
386         $groupjoin   = 'JOIN {groups_members} gm ON  gm.userid=u.id';
387         $params['groupid'] = $groupid;
388     } else {
389         $groupselect = '';
390         $groupjoin   = '';
391     }
393     $approvedselect = "";
394     if (!has_capability('mod/glossary:approve', $context)) {
395         $approvedselect = " AND ge.approved = 1 ";
396     }
398     $params['timestart'] = $timestart;
399     $params['glossaryid'] = $cm->instance;
401     $ufields = user_picture::fields('u', null, 'userid');
402     $entries = $DB->get_records_sql("
403               SELECT ge.id AS entryid, ge.glossaryid, ge.concept, ge.definition, ge.approved,
404                      ge.timemodified, $ufields
405                 FROM {glossary_entries} ge
406                 JOIN {user} u ON u.id = ge.userid
407                      $groupjoin
408                WHERE ge.timemodified > :timestart
409                  AND ge.glossaryid = :glossaryid
410                      $approvedselect
411                      $userselect
412                      $groupselect
413             ORDER BY ge.timemodified ASC", $params);
415     if (!$entries) {
416         return;
417     }
419     foreach ($entries as $entry) {
420         // Groups are not yet supported for glossary. See MDL-10728 .
421         /*
422         $usersgroups = null;
423         if ($entry->userid != $USER->id) {
424             if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
425                 if (is_null($usersgroups)) {
426                     $usersgroups = groups_get_all_groups($course->id, $entry->userid, $cm->groupingid);
427                     if (is_array($usersgroups)) {
428                         $usersgroups = array_keys($usersgroups);
429                     } else {
430                         $usersgroups = array();
431                     }
432                 }
433                 if (!array_intersect($usersgroups, $modinfo->get_groups($cm->groupingid))) {
434                     continue;
435                 }
436             }
437         }
438          */
440         $tmpactivity                       = new stdClass();
441         $tmpactivity->user                 = user_picture::unalias($entry, null, 'userid');
442         $tmpactivity->user->fullname       = fullname($tmpactivity->user, $viewfullnames);
443         $tmpactivity->type                 = 'glossary';
444         $tmpactivity->cmid                 = $cm->id;
445         $tmpactivity->glossaryid           = $entry->glossaryid;
446         $tmpactivity->name                 = format_string($cm->name, true);
447         $tmpactivity->sectionnum           = $cm->sectionnum;
448         $tmpactivity->timestamp            = $entry->timemodified;
449         $tmpactivity->content              = new stdClass();
450         $tmpactivity->content->entryid     = $entry->entryid;
451         $tmpactivity->content->concept     = $entry->concept;
452         $tmpactivity->content->definition  = $entry->definition;
453         $tmpactivity->content->approved    = $entry->approved;
455         $activities[$index++] = $tmpactivity;
456     }
458     return true;
461 /**
462  * Outputs the glossary entry indicated by $activity
463  *
464  * @param object $activity      the activity object the glossary resides in
465  * @param int    $courseid      the id of the course the glossary resides in
466  * @param bool   $detail        not used, but required for compatibilty with other modules
467  * @param int    $modnames      not used, but required for compatibilty with other modules
468  * @param bool   $viewfullnames not used, but required for compatibilty with other modules
469  * @return void
470  */
471 function glossary_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) {
472     global $OUTPUT;
474     echo html_writer::start_tag('div', array('class'=>'glossary-activity clearfix'));
475     if (!empty($activity->user)) {
476         echo html_writer::tag('div', $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid)),
477             array('class' => 'glossary-activity-picture'));
478     }
480     echo html_writer::start_tag('div', array('class'=>'glossary-activity-content'));
481     echo html_writer::start_tag('div', array('class'=>'glossary-activity-entry'));
483     if (isset($activity->content->approved) && !$activity->content->approved) {
484         $urlparams = array('g' => $activity->glossaryid, 'mode' => 'approval', 'hook' => $activity->content->concept);
485         $class = array('class' => 'dimmed_text');
486     } else {
487         $urlparams = array('g' => $activity->glossaryid, 'mode' => 'entry', 'hook' => $activity->content->entryid);
488         $class = array();
489     }
490     echo html_writer::link(new moodle_url('/mod/glossary/view.php', $urlparams),
491             strip_tags($activity->content->concept), $class);
492     echo html_writer::end_tag('div');
494     $url = new moodle_url('/user/view.php', array('course'=>$courseid, 'id'=>$activity->user->id));
495     $name = $activity->user->fullname;
496     $link = html_writer::link($url, $name, $class);
498     echo html_writer::start_tag('div', array('class'=>'user'));
499     echo $link .' - '. userdate($activity->timestamp);
500     echo html_writer::end_tag('div');
502     echo html_writer::end_tag('div');
504     echo html_writer::end_tag('div');
505     return;
507 /**
508  * Given a course and a time, this module should find recent activity
509  * that has occurred in glossary activities and print it out.
510  * Return true if there was output, or false is there was none.
511  *
512  * @global object
513  * @global object
514  * @global object
515  * @param object $course
516  * @param object $viewfullnames
517  * @param int $timestart
518  * @return bool
519  */
520 function glossary_print_recent_activity($course, $viewfullnames, $timestart) {
521     global $CFG, $USER, $DB, $OUTPUT, $PAGE;
523     //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0
524     if (!defined('GLOSSARY_RECENT_ACTIVITY_LIMIT')) {
525         define('GLOSSARY_RECENT_ACTIVITY_LIMIT', 50);
526     }
527     $modinfo = get_fast_modinfo($course);
528     $ids = array();
530     foreach ($modinfo->cms as $cm) {
531         if ($cm->modname != 'glossary') {
532             continue;
533         }
534         if (!$cm->uservisible) {
535             continue;
536         }
537         $ids[$cm->instance] = $cm->id;
538     }
540     if (!$ids) {
541         return false;
542     }
544     // generate list of approval capabilities for all glossaries in the course.
545     $approvals = array();
546     foreach ($ids as $glinstanceid => $glcmid) {
547         $context = context_module::instance($glcmid);
548         if (has_capability('mod/glossary:view', $context)) {
549             // get records glossary entries that are approved if user has no capability to approve entries.
550             if (has_capability('mod/glossary:approve', $context)) {
551                 $approvals[] = ' ge.glossaryid = :glsid'.$glinstanceid.' ';
552             } else {
553                 $approvals[] = ' (ge.approved = 1 AND ge.glossaryid = :glsid'.$glinstanceid.') ';
554             }
555             $params['glsid'.$glinstanceid] = $glinstanceid;
556         }
557     }
559     if (count($approvals) == 0) {
560         return false;
561     }
562     $selectsql = 'SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
563                                         '.user_picture::fields('u',null,'userid');
564     $countsql = 'SELECT COUNT(*)';
566     $joins = array(' FROM {glossary_entries} ge ');
567     $joins[] = 'JOIN {user} u ON u.id = ge.userid ';
568     $fromsql = implode($joins, "\n");
570     $params['timestart'] = $timestart;
571     $clausesql = ' WHERE ge.timemodified > :timestart ';
573     if (count($approvals) > 0) {
574         $approvalsql = 'AND ('. implode($approvals, ' OR ') .') ';
575     } else {
576         $approvalsql = '';
577     }
578     $ordersql = 'ORDER BY ge.timemodified ASC';
579     $entries = $DB->get_records_sql($selectsql.$fromsql.$clausesql.$approvalsql.$ordersql, $params, 0, (GLOSSARY_RECENT_ACTIVITY_LIMIT+1));
581     if (empty($entries)) {
582         return false;
583     }
585     echo $OUTPUT->heading(get_string('newentries', 'glossary').':', 3);
586     $strftimerecent = get_string('strftimerecent');
587     $entrycount = 0;
588     foreach ($entries as $entry) {
589         if ($entrycount < GLOSSARY_RECENT_ACTIVITY_LIMIT) {
590             if ($entry->approved) {
591                 $dimmed = '';
592                 $urlparams = array('g' => $entry->glossaryid, 'mode' => 'entry', 'hook' => $entry->id);
593             } else {
594                 $dimmed = ' dimmed_text';
595                 $urlparams = array('id' => $ids[$entry->glossaryid], 'mode' => 'approval', 'hook' => format_text($entry->concept, true));
596             }
597             $link = new moodle_url($CFG->wwwroot.'/mod/glossary/view.php' , $urlparams);
598             echo '<div class="head'.$dimmed.'">';
599             echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
600             echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
601             echo '</div>';
602             echo '<div class="info"><a href="'.$link.'">'.format_string($entry->concept, true).'</a></div>';
603             $entrycount += 1;
604         } else {
605             $numnewentries = $DB->count_records_sql($countsql.$joins[0].$clausesql.$approvalsql, $params);
606             echo '<div class="head"><div class="activityhead">'.get_string('andmorenewentries', 'glossary', $numnewentries - GLOSSARY_RECENT_ACTIVITY_LIMIT).'</div></div>';
607             break;
608         }
609     }
611     return true;
614 /**
615  * @global object
616  * @param object $log
617  */
618 function glossary_log_info($log) {
619     global $DB;
621     return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
622                                   FROM {glossary_entries} e, {user} u
623                                  WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
626 /**
627  * Function to be run periodically according to the moodle cron
628  * This function searches for things that need to be done, such
629  * as sending out mail, toggling flags etc ...
630  * @return bool
631  */
632 function glossary_cron () {
633     return true;
636 /**
637  * Return grade for given user or all users.
638  *
639  * @param stdClass $glossary A glossary instance
640  * @param int $userid Optional user id, 0 means all users
641  * @return array An array of grades, false if none
642  */
643 function glossary_get_user_grades($glossary, $userid=0) {
644     global $CFG;
646     require_once($CFG->dirroot.'/rating/lib.php');
648     $ratingoptions = new stdClass;
650     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
651     $ratingoptions->modulename = 'glossary';
652     $ratingoptions->moduleid   = $glossary->id;
653     $ratingoptions->component  = 'mod_glossary';
654     $ratingoptions->ratingarea = 'entry';
656     $ratingoptions->userid = $userid;
657     $ratingoptions->aggregationmethod = $glossary->assessed;
658     $ratingoptions->scaleid = $glossary->scale;
659     $ratingoptions->itemtable = 'glossary_entries';
660     $ratingoptions->itemtableusercolumn = 'userid';
662     $rm = new rating_manager();
663     return $rm->get_user_grades($ratingoptions);
666 /**
667  * Return rating related permissions
668  *
669  * @param int $contextid the context id
670  * @param string $component The component we want to get permissions for
671  * @param string $ratingarea The ratingarea that we want to get permissions for
672  * @return array an associative array of the user's rating permissions
673  */
674 function glossary_rating_permissions($contextid, $component, $ratingarea) {
675     if ($component != 'mod_glossary' || $ratingarea != 'entry') {
676         // We don't know about this component/ratingarea so just return null to get the
677         // default restrictive permissions.
678         return null;
679     }
680     $context = context::instance_by_id($contextid);
681     return array(
682         'view'    => has_capability('mod/glossary:viewrating', $context),
683         'viewany' => has_capability('mod/glossary:viewanyrating', $context),
684         'viewall' => has_capability('mod/glossary:viewallratings', $context),
685         'rate'    => has_capability('mod/glossary:rate', $context)
686     );
689 /**
690  * Validates a submitted rating
691  * @param array $params submitted data
692  *            context => object the context in which the rated items exists [required]
693  *            component => The component for this module - should always be mod_forum [required]
694  *            ratingarea => object the context in which the rated items exists [required]
695  *            itemid => int the ID of the object being rated [required]
696  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
697  *            rating => int the submitted rating
698  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
699  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [optional]
700  * @return boolean true if the rating is valid. Will throw rating_exception if not
701  */
702 function glossary_rating_validate($params) {
703     global $DB, $USER;
705     // Check the component is mod_forum
706     if ($params['component'] != 'mod_glossary') {
707         throw new rating_exception('invalidcomponent');
708     }
710     // Check the ratingarea is post (the only rating area in forum)
711     if ($params['ratingarea'] != 'entry') {
712         throw new rating_exception('invalidratingarea');
713     }
715     // Check the rateduserid is not the current user .. you can't rate your own posts
716     if ($params['rateduserid'] == $USER->id) {
717         throw new rating_exception('nopermissiontorate');
718     }
720     $glossarysql = "SELECT g.id as glossaryid, g.scale, g.course, e.userid as userid, e.approved, e.timecreated, g.assesstimestart, g.assesstimefinish
721                       FROM {glossary_entries} e
722                       JOIN {glossary} g ON e.glossaryid = g.id
723                      WHERE e.id = :itemid";
724     $glossaryparams = array('itemid' => $params['itemid']);
725     $info = $DB->get_record_sql($glossarysql, $glossaryparams);
726     if (!$info) {
727         //item doesn't exist
728         throw new rating_exception('invaliditemid');
729     }
731     if ($info->scale != $params['scaleid']) {
732         //the scale being submitted doesnt match the one in the database
733         throw new rating_exception('invalidscaleid');
734     }
736     //check that the submitted rating is valid for the scale
738     // lower limit
739     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
740         throw new rating_exception('invalidnum');
741     }
743     // upper limit
744     if ($info->scale < 0) {
745         //its a custom scale
746         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
747         if ($scalerecord) {
748             $scalearray = explode(',', $scalerecord->scale);
749             if ($params['rating'] > count($scalearray)) {
750                 throw new rating_exception('invalidnum');
751             }
752         } else {
753             throw new rating_exception('invalidscaleid');
754         }
755     } else if ($params['rating'] > $info->scale) {
756         //if its numeric and submitted rating is above maximum
757         throw new rating_exception('invalidnum');
758     }
760     //check the item we're rating was created in the assessable time window
761     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
762         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
763             throw new rating_exception('notavailable');
764         }
765     }
767     $cm = get_coursemodule_from_instance('glossary', $info->glossaryid, $info->course, false, MUST_EXIST);
768     $context = context_module::instance($cm->id, MUST_EXIST);
770     // if the supplied context doesnt match the item's context
771     if ($context->id != $params['context']->id) {
772         throw new rating_exception('invalidcontext');
773     }
775     return true;
778 /**
779  * Update activity grades
780  *
781  * @category grade
782  * @param stdClass $glossary Null means all glossaries (with extra cmidnumber property)
783  * @param int $userid specific user only, 0 means all
784  * @param bool $nullifnone If true and the user has no grade then a grade item with rawgrade == null will be inserted
785  */
786 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
787     global $CFG, $DB;
788     require_once($CFG->libdir.'/gradelib.php');
790     if (!$glossary->assessed) {
791         glossary_grade_item_update($glossary);
793     } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
794         glossary_grade_item_update($glossary, $grades);
796     } else if ($userid and $nullifnone) {
797         $grade = new stdClass();
798         $grade->userid   = $userid;
799         $grade->rawgrade = NULL;
800         glossary_grade_item_update($glossary, $grade);
802     } else {
803         glossary_grade_item_update($glossary);
804     }
807 /**
808  * Create/update grade item for given glossary
809  *
810  * @category grade
811  * @param stdClass $glossary object with extra cmidnumber
812  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
813  * @return int, 0 if ok, error code otherwise
814  */
815 function glossary_grade_item_update($glossary, $grades=NULL) {
816     global $CFG;
817     require_once($CFG->libdir.'/gradelib.php');
819     $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
821     if (!$glossary->assessed or $glossary->scale == 0) {
822         $params['gradetype'] = GRADE_TYPE_NONE;
824     } else if ($glossary->scale > 0) {
825         $params['gradetype'] = GRADE_TYPE_VALUE;
826         $params['grademax']  = $glossary->scale;
827         $params['grademin']  = 0;
829     } else if ($glossary->scale < 0) {
830         $params['gradetype'] = GRADE_TYPE_SCALE;
831         $params['scaleid']   = -$glossary->scale;
832     }
834     if ($grades  === 'reset') {
835         $params['reset'] = true;
836         $grades = NULL;
837     }
839     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
842 /**
843  * Delete grade item for given glossary
844  *
845  * @category grade
846  * @param object $glossary object
847  */
848 function glossary_grade_item_delete($glossary) {
849     global $CFG;
850     require_once($CFG->libdir.'/gradelib.php');
852     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
855 /**
856  * @global object
857  * @param int $gloassryid
858  * @param int $scaleid
859  * @return bool
860  */
861 function glossary_scale_used ($glossaryid,$scaleid) {
862 //This function returns if a scale is being used by one glossary
863     global $DB;
865     $return = false;
867     $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
869     if (!empty($rec)  && !empty($scaleid)) {
870         $return = true;
871     }
873     return $return;
876 /**
877  * Checks if scale is being used by any instance of glossary
878  *
879  * This is used to find out if scale used anywhere
880  *
881  * @global object
882  * @param int $scaleid
883  * @return boolean True if the scale is used by any glossary
884  */
885 function glossary_scale_used_anywhere($scaleid) {
886     global $DB;
888     if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
889         return true;
890     } else {
891         return false;
892     }
895 //////////////////////////////////////////////////////////////////////////////////////
896 /// Any other glossary functions go here.  Each of them must have a name that
897 /// starts with glossary_
899 /**
900  * This function return an array of valid glossary_formats records
901  * Everytime it's called, every existing format is checked, new formats
902  * are included if detected and old formats are deleted and any glossary
903  * using an invalid format is updated to the default (dictionary).
904  *
905  * @global object
906  * @global object
907  * @return array
908  */
909 function glossary_get_available_formats() {
910     global $CFG, $DB;
912     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
913     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
914     $pluginformats = array();
915     foreach ($formats as $format) {
916         //If the format file exists
917         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
918             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
919             //If the function exists
920             if (function_exists('glossary_show_entry_'.$format)) {
921                 //Acummulate it as a valid format
922                 $pluginformats[] = $format;
923                 //If the format doesn't exist in the table
924                 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
925                     //Insert the record in glossary_formats
926                     $gf = new stdClass();
927                     $gf->name = $format;
928                     $gf->popupformatname = $format;
929                     $gf->visible = 1;
930                     $id = $DB->insert_record('glossary_formats', $gf);
931                     $rec = $DB->get_record('glossary_formats', array('id' => $id));
932                 }
934                 if (empty($rec->showtabs)) {
935                     glossary_set_default_visible_tabs($rec);
936                 }
937             }
938         }
939     }
941     //Delete non_existent formats from glossary_formats table
942     $formats = $DB->get_records("glossary_formats");
943     foreach ($formats as $format) {
944         $todelete = false;
945         //If the format in DB isn't a valid previously detected format then delete the record
946         if (!in_array($format->name,$pluginformats)) {
947             $todelete = true;
948         }
950         if ($todelete) {
951             //Delete the format
952             $DB->delete_records('glossary_formats', array('name'=>$format->name));
953             //Reasign existing glossaries to default (dictionary) format
954             if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
955                 foreach($glossaries as $glossary) {
956                     $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
957                 }
958             }
959         }
960     }
962     //Now everything is ready in glossary_formats table
963     $formats = $DB->get_records("glossary_formats");
965     return $formats;
968 /**
969  * @param bool $debug
970  * @param string $text
971  * @param int $br
972  */
973 function glossary_debug($debug,$text,$br=1) {
974     if ( $debug ) {
975         echo '<font color="red">' . $text . '</font>';
976         if ( $br ) {
977             echo '<br />';
978         }
979     }
982 /**
983  *
984  * @global object
985  * @param int $glossaryid
986  * @param string $entrylist
987  * @param string $pivot
988  * @return array
989  */
990 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
991     global $DB;
992     if ($pivot) {
993        $pivot .= ",";
994     }
996     return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
997                                    FROM {glossary_entries}
998                                   WHERE glossaryid = ?
999                                         AND id IN ($entrylist)", array($glossaryid));
1002 /**
1003  * @global object
1004  * @global object
1005  * @param object $concept
1006  * @param string $courseid
1007  * @return array
1008  */
1009 function glossary_get_entries_search($concept, $courseid) {
1010     global $CFG, $DB;
1012     //Check if the user is an admin
1013     $bypassadmin = 1; //This means NO (by default)
1014     if (has_capability('moodle/course:viewhiddenactivities', context_system::instance())) {
1015         $bypassadmin = 0; //This means YES
1016     }
1018     //Check if the user is a teacher
1019     $bypassteacher = 1; //This means NO (by default)
1020     if (has_capability('mod/glossary:manageentries', context_course::instance($courseid))) {
1021         $bypassteacher = 0; //This means YES
1022     }
1024     $conceptlower = core_text::strtolower(trim($concept));
1026     $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
1028     return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
1029                                    FROM {glossary_entries} e, {glossary} g,
1030                                         {course_modules} cm, {modules} m
1031                                   WHERE m.name = 'glossary' AND
1032                                         cm.module = m.id AND
1033                                         (cm.visible = 1 OR  cm.visible = $bypassadmin OR
1034                                             (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
1035                                         g.id = cm.instance AND
1036                                         e.glossaryid = g.id  AND
1037                                         ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
1038                                           (e.casesensitive = 0 and concept = :concept)) AND
1039                                         (g.course = :courseid2 OR g.globalglossary = 1) AND
1040                                          e.usedynalink != 0 AND
1041                                          g.usedynalink != 0", $params);
1044 /**
1045  * @global object
1046  * @global object
1047  * @param object $course
1048  * @param object $course
1049  * @param object $glossary
1050  * @param object $entry
1051  * @param string $mode
1052  * @param string $hook
1053  * @param int $printicons
1054  * @param int $displayformat
1055  * @param bool $printview
1056  * @return mixed
1057  */
1058 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $printview = false) {
1059     global $USER, $CFG;
1060     $return = false;
1061     if ( $displayformat < 0 ) {
1062         $displayformat = $glossary->displayformat;
1063     }
1064     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
1065         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1066         if ($printview) {
1067             $functionname = 'glossary_print_entry_'.$displayformat;
1068         } else {
1069             $functionname = 'glossary_show_entry_'.$displayformat;
1070         }
1072         if (file_exists($formatfile)) {
1073             include_once($formatfile);
1074             if (function_exists($functionname)) {
1075                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
1076             } else if ($printview) {
1077                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
1078                 $return = glossary_print_entry_default($entry, $glossary, $cm);
1079             }
1080         }
1081     }
1082     return $return;
1085 /**
1086  * Default (old) print format used if custom function doesn't exist in format
1087  *
1088  * @param object $entry
1089  * @param object $glossary
1090  * @param object $cm
1091  * @return void Output is echo'd
1092  */
1093 function glossary_print_entry_default ($entry, $glossary, $cm) {
1094     global $CFG;
1096     require_once($CFG->libdir . '/filelib.php');
1098     echo $OUTPUT->heading(strip_tags($entry->concept), 4);
1100     $definition = $entry->definition;
1102     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
1104     $context = context_module::instance($cm->id);
1105     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
1107     $options = new stdClass();
1108     $options->para = false;
1109     $options->trusted = $entry->definitiontrust;
1110     $options->context = $context;
1111     $options->overflowdiv = true;
1112     $definition = format_text($definition, $entry->definitionformat, $options);
1113     echo ($definition);
1114     echo '<br /><br />';
1117 /**
1118  * Print glossary concept/term as a heading &lt;h4>
1119  * @param object $entry
1120  */
1121 function  glossary_print_entry_concept($entry, $return=false) {
1122     global $OUTPUT;
1124     $text = $OUTPUT->heading(format_string($entry->concept), 4);
1125     if (!empty($entry->highlight)) {
1126         $text = highlight($entry->highlight, $text);
1127     }
1129     if ($return) {
1130         return $text;
1131     } else {
1132         echo $text;
1133     }
1136 /**
1137  *
1138  * @global moodle_database DB
1139  * @param object $entry
1140  * @param object $glossary
1141  * @param object $cm
1142  */
1143 function glossary_print_entry_definition($entry, $glossary, $cm) {
1144     global $GLOSSARY_EXCLUDEENTRY;
1146     $definition = $entry->definition;
1148     // Do not link self.
1149     $GLOSSARY_EXCLUDEENTRY = $entry->id;
1151     $context = context_module::instance($cm->id);
1152     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
1154     $options = new stdClass();
1155     $options->para = false;
1156     $options->trusted = $entry->definitiontrust;
1157     $options->context = $context;
1158     $options->overflowdiv = true;
1160     $text = format_text($definition, $entry->definitionformat, $options);
1162     // Stop excluding concepts from autolinking
1163     unset($GLOSSARY_EXCLUDEENTRY);
1165     if (!empty($entry->highlight)) {
1166         $text = highlight($entry->highlight, $text);
1167     }
1168     if (isset($entry->footer)) {   // Unparsed footer info
1169         $text .= $entry->footer;
1170     }
1171     echo $text;
1174 /**
1175  *
1176  * @global object
1177  * @param object $course
1178  * @param object $cm
1179  * @param object $glossary
1180  * @param object $entry
1181  * @param string $mode
1182  * @param string $hook
1183  * @param string $type
1184  * @return string|void
1185  */
1186 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
1187     global $DB;
1189     $return = '';
1190     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
1191         foreach ($aliases as $alias) {
1192             if (trim($alias->alias)) {
1193                 if ($return == '') {
1194                     $return = '<select id="keyword" class="custom-select">';
1195                 }
1196                 $return .= "<option>$alias->alias</option>";
1197             }
1198         }
1199         if ($return != '') {
1200             $return .= '</select>';
1201         }
1202     }
1203     if ($type == 'print') {
1204         echo $return;
1205     } else {
1206         return $return;
1207     }
1210 /**
1211  *
1212  * @global object
1213  * @global object
1214  * @global object
1215  * @param object $course
1216  * @param object $cm
1217  * @param object $glossary
1218  * @param object $entry
1219  * @param string $mode
1220  * @param string $hook
1221  * @param string $type
1222  * @return string|void
1223  */
1224 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
1225     global $USER, $CFG, $DB, $OUTPUT;
1227     $context = context_module::instance($cm->id);
1229     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
1230     $importedentry = ($entry->sourceglossaryid == $glossary->id);
1231     $ismainglossary = $glossary->mainglossary;
1234     $return = '<span class="commands">';
1235     // Differentiate links for each entry.
1236     $altsuffix = strip_tags(format_text($entry->concept));
1238     if (!$entry->approved) {
1239         $output = true;
1240         $return .= html_writer::tag('span', get_string('entryishidden','glossary'),
1241             array('class' => 'glossary-hidden-note'));
1242     }
1244     if (has_capability('mod/glossary:approve', $context) && !$glossary->defaultapproval && $entry->approved) {
1245         $output = true;
1246         $return .= '<a class="icon" title="' . get_string('disapprove', 'glossary').
1247                    '" href="approve.php?newstate=0&amp;eid='.$entry->id.'&amp;mode='.$mode.
1248                    '&amp;hook='.urlencode($hook).'&amp;sesskey='.sesskey().
1249                    '">' . $OUTPUT->pix_icon('t/block', get_string('disapprove', 'glossary')) . '</a>';
1250     }
1252     $iscurrentuser = ($entry->userid == $USER->id);
1254     if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $iscurrentuser)) {
1255         // only teachers can export entries so check it out
1256         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
1257             $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
1258             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
1259                 $output = true;
1260                 $return .= '<a class="icon" title="'.get_string('exporttomainglossary','glossary') . '" ' .
1261                     'href="exportentry.php?id='.$entry->id.'&amp;prevmode='.$mode.'&amp;hook='.urlencode($hook).'">' .
1262                     $OUTPUT->pix_icon('export', get_string('exporttomainglossary', 'glossary'), 'glossary') . '</a>';
1263             }
1264         }
1266         $icon = 't/delete';
1267         $iconcomponent = 'moodle';
1268         if ( $entry->sourceglossaryid ) {
1269             $icon = 'minus';   // graphical metaphor (minus) for deleting an imported entry
1270             $iconcomponent = 'glossary';
1271         }
1273         //Decide if an entry is editable:
1274         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
1275         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1276         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
1277         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1278             $output = true;
1279             $url = "deleteentry.php?id=$cm->id&amp;mode=delete&amp;entry=$entry->id&amp;prevmode=$mode&amp;hook=".urlencode($hook);
1280             $return .= "<a class='icon' title=\"" . get_string("delete") . "\" " .
1281                        "href=\"$url\">" . $OUTPUT->pix_icon($icon, get_string('deleteentrya', 'mod_glossary', $altsuffix), $iconcomponent) . '</a>';
1283             $url = "edit.php?cmid=$cm->id&amp;id=$entry->id&amp;mode=$mode&amp;hook=".urlencode($hook);
1284             $return .= "<a class='icon' title=\"" . get_string("edit") . "\" href=\"$url\">" .
1285                        $OUTPUT->pix_icon('t/edit', get_string('editentrya', 'mod_glossary', $altsuffix)) . '</a>';
1286         } elseif ( $importedentry ) {
1287             $return .= "<font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1288         }
1289     }
1290     if (!empty($CFG->enableportfolios) && (has_capability('mod/glossary:exportentry', $context) || ($iscurrentuser && has_capability('mod/glossary:exportownentry', $context)))) {
1291         require_once($CFG->libdir . '/portfoliolib.php');
1292         $button = new portfolio_add_button();
1293         $button->set_callback_options('glossary_entry_portfolio_caller',  array('id' => $cm->id, 'entryid' => $entry->id), 'mod_glossary');
1295         $filecontext = $context;
1296         if ($entry->sourceglossaryid == $cm->instance) {
1297             if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1298                 $filecontext = context_module::instance($maincm->id);
1299             }
1300         }
1301         $fs = get_file_storage();
1302         if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)
1303          || $files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'entry', $entry->id, "timemodified", false)) {
1305             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1306         } else {
1307             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1308         }
1310         $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1311     }
1312     $return .= '</span>';
1314     if (!empty($CFG->usecomments) && has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1315         require_once($CFG->dirroot . '/comment/lib.php');
1316         $cmt = new stdClass();
1317         $cmt->component = 'mod_glossary';
1318         $cmt->context  = $context;
1319         $cmt->course   = $course;
1320         $cmt->cm       = $cm;
1321         $cmt->area     = 'glossary_entry';
1322         $cmt->itemid   = $entry->id;
1323         $cmt->showcount = true;
1324         $comment = new comment($cmt);
1325         $return .= '<div>'.$comment->output(true).'</div>';
1326         $output = true;
1327     }
1328     $return .= '<hr>';
1330     //If we haven't calculated any REAL thing, delete result ($return)
1331     if (!$output) {
1332         $return = '';
1333     }
1334     //Print or get
1335     if ($type == 'print') {
1336         echo $return;
1337     } else {
1338         return $return;
1339     }
1342 /**
1343  * @param object $course
1344  * @param object $cm
1345  * @param object $glossary
1346  * @param object $entry
1347  * @param string $mode
1348  * @param object $hook
1349  * @param bool $printicons
1350  * @param bool $aliases
1351  * @return void
1352  */
1353 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1354     if ($aliases) {
1355         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1356     }
1357     $icons   = '';
1358     if ($printicons) {
1359         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1360     }
1361     if ($aliases || $icons || !empty($entry->rating)) {
1362         echo '<table>';
1363         if ( $aliases ) {
1364             echo '<tr valign="top"><td class="aliases">' .
1365                  '<label for="keyword">' . get_string('aliases','glossary').': </label>' .
1366                  $aliases . '</td></tr>';
1367         }
1368         if ($icons) {
1369             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1370         }
1371         if (!empty($entry->rating)) {
1372             echo '<tr valign="top"><td class="ratings">';
1373             glossary_print_entry_ratings($course, $entry);
1374             echo '</td></tr>';
1375         }
1376         echo '</table>';
1377     }
1380 /**
1381  * Print the list of attachments for this glossary entry
1382  *
1383  * @param object $entry
1384  * @param object $cm The coursemodule
1385  * @param string $format The format for this view (html, or text)
1386  * @param string $unused1 This parameter is no longer used
1387  * @param string $unused2 This parameter is no longer used
1388  */
1389 function glossary_print_entry_attachment($entry, $cm, $format = null, $unused1 = null, $unused2 = null) {
1390     // Valid format values: html: The HTML link for the attachment is an icon; and
1391     //                      text: The HTML link for the attachment is text.
1392     if ($entry->attachment) {
1393         echo '<div class="attachments">';
1394         echo glossary_print_attachments($entry, $cm, $format);
1395         echo '</div>';
1396     }
1397     if ($unused1) {
1398         debugging('The align parameter is deprecated, please use appropriate CSS instead', DEBUG_DEVELOPER);
1399     }
1400     if ($unused2 !== null) {
1401         debugging('The insidetable parameter is deprecated, please use appropriate CSS instead', DEBUG_DEVELOPER);
1402     }
1405 /**
1406  * @global object
1407  * @param object $cm
1408  * @param object $entry
1409  * @param string $mode
1410  * @param string $align
1411  * @param bool $insidetable
1412  */
1413 function  glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1414     global $CFG, $OUTPUT;
1416     if ($mode == 'approval' and !$entry->approved) {
1417         if ($insidetable) {
1418             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1419         }
1420         echo $OUTPUT->action_icon(
1421             new moodle_url('approve.php', array('eid' => $entry->id, 'mode' => $mode, 'sesskey' => sesskey())),
1422             new pix_icon('t/approve', get_string('approve','glossary'), '',
1423                 array('class' => 'iconsmall', 'align' => $align))
1424         );
1425         if ($insidetable) {
1426             echo '</td></tr></table>';
1427         }
1428     }
1431 /**
1432  * It returns all entries from all glossaries that matches the specified criteria
1433  *  within a given $course. It performs an $extended search if necessary.
1434  * It restrict the search to only one $glossary if the $glossary parameter is set.
1435  *
1436  * @global object
1437  * @global object
1438  * @param object $course
1439  * @param array $searchterms
1440  * @param int $extended
1441  * @param object $glossary
1442  * @return array
1443  */
1444 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1445     global $CFG, $DB;
1447     if ( !$glossary ) {
1448         if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1449             $glos = "";
1450             foreach ( $glossaries as $glossary ) {
1451                 $glos .= "$glossary->id,";
1452             }
1453             $glos = substr($glos,0,-1);
1454         }
1455     } else {
1456         $glos = $glossary->id;
1457     }
1459     if (!has_capability('mod/glossary:manageentries', context_course::instance($glossary->course))) {
1460         $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1461         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1462         $onlyvisibletable = ", {course_modules} cm";
1463     } else {
1465         $onlyvisible = "";
1466         $onlyvisibletable = "";
1467     }
1469     if ($DB->sql_regex_supported()) {
1470         $REGEXP    = $DB->sql_regex(true);
1471         $NOTREGEXP = $DB->sql_regex(false);
1472     }
1474     $searchcond = array();
1475     $params     = array();
1476     $i = 0;
1478     $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1481     foreach ($searchterms as $searchterm) {
1482         $i++;
1484         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1485                    /// will use it to simulate the "-" operator with LIKE clause
1487     /// Under Oracle and MSSQL, trim the + and - operators and perform
1488     /// simpler LIKE (or NOT LIKE) queries
1489         if (!$DB->sql_regex_supported()) {
1490             if (substr($searchterm, 0, 1) == '-') {
1491                 $NOT = true;
1492             }
1493             $searchterm = trim($searchterm, '+-');
1494         }
1496         // TODO: +- may not work for non latin languages
1498         if (substr($searchterm,0,1) == '+') {
1499             $searchterm = trim($searchterm, '+-');
1500             $searchterm = preg_quote($searchterm, '|');
1501             $searchcond[] = "$concat $REGEXP :ss$i";
1502             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1504         } else if (substr($searchterm,0,1) == "-") {
1505             $searchterm = trim($searchterm, '+-');
1506             $searchterm = preg_quote($searchterm, '|');
1507             $searchcond[] = "$concat $NOTREGEXP :ss$i";
1508             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1510         } else {
1511             $searchcond[] = $DB->sql_like($concat, ":ss$i", false, true, $NOT);
1512             $params['ss'.$i] = "%$searchterm%";
1513         }
1514     }
1516     if (empty($searchcond)) {
1517         $totalcount = 0;
1518         return array();
1519     }
1521     $searchcond = implode(" AND ", $searchcond);
1523     $sql = "SELECT e.*
1524               FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1525              WHERE $searchcond
1526                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1527                AND g.id IN ($glos) AND e.approved <> 0";
1529     return $DB->get_records_sql($sql, $params);
1532 /**
1533  * @global object
1534  * @param array $searchterms
1535  * @param object $glossary
1536  * @param bool $extended
1537  * @return array
1538  */
1539 function glossary_search_entries($searchterms, $glossary, $extended) {
1540     global $DB;
1542     $course = $DB->get_record("course", array("id"=>$glossary->course));
1543     return glossary_search($course,$searchterms,$extended,$glossary);
1546 /**
1547  * if return=html, then return a html string.
1548  * if return=text, then return a text-only string.
1549  * otherwise, print HTML for non-images, and return image HTML
1550  *     if attachment is an image, $align set its aligment.
1551  *
1552  * @global object
1553  * @global object
1554  * @param object $entry
1555  * @param object $cm
1556  * @param string $type html, txt, empty
1557  * @param string $unused This parameter is no longer used
1558  * @return string image string or nothing depending on $type param
1559  */
1560 function glossary_print_attachments($entry, $cm, $type=NULL, $unused = null) {
1561     global $CFG, $DB, $OUTPUT;
1563     if (!$context = context_module::instance($cm->id, IGNORE_MISSING)) {
1564         return '';
1565     }
1567     if ($entry->sourceglossaryid == $cm->instance) {
1568         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1569             return '';
1570         }
1571         $filecontext = context_module::instance($maincm->id);
1573     } else {
1574         $filecontext = $context;
1575     }
1577     $strattachment = get_string('attachment', 'glossary');
1579     $fs = get_file_storage();
1581     $imagereturn = '';
1582     $output = '';
1584     if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1585         foreach ($files as $file) {
1586             $filename = $file->get_filename();
1587             $mimetype = $file->get_mimetype();
1588             $iconimage = $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file), 'moodle', array('class' => 'icon'));
1589             $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename);
1591             if ($type == 'html') {
1592                 $output .= "<a href=\"$path\">$iconimage</a> ";
1593                 $output .= "<a href=\"$path\">".s($filename)."</a>";
1594                 $output .= "<br />";
1596             } else if ($type == 'text') {
1597                 $output .= "$strattachment ".s($filename).":\n$path\n";
1599             } else {
1600                 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1601                     // Image attachments don't get printed as links
1602                     $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1603                 } else {
1604                     $output .= "<a href=\"$path\">$iconimage</a> ";
1605                     $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context));
1606                     $output .= '<br />';
1607                 }
1608             }
1609         }
1610     }
1612     if ($type) {
1613         return $output;
1614     } else {
1615         echo $output;
1616         return $imagereturn;
1617     }
1620 ////////////////////////////////////////////////////////////////////////////////
1621 // File API                                                                   //
1622 ////////////////////////////////////////////////////////////////////////////////
1624 /**
1625  * Lists all browsable file areas
1626  *
1627  * @package  mod_glossary
1628  * @category files
1629  * @param stdClass $course course object
1630  * @param stdClass $cm course module object
1631  * @param stdClass $context context object
1632  * @return array
1633  */
1634 function glossary_get_file_areas($course, $cm, $context) {
1635     return array(
1636         'attachment' => get_string('areaattachment', 'mod_glossary'),
1637         'entry' => get_string('areaentry', 'mod_glossary'),
1638     );
1641 /**
1642  * File browsing support for glossary module.
1643  *
1644  * @param file_browser $browser
1645  * @param array $areas
1646  * @param stdClass $course
1647  * @param cm_info $cm
1648  * @param context $context
1649  * @param string $filearea
1650  * @param int $itemid
1651  * @param string $filepath
1652  * @param string $filename
1653  * @return file_info_stored file_info_stored instance or null if not found
1654  */
1655 function glossary_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
1656     global $CFG, $DB, $USER;
1658     if ($context->contextlevel != CONTEXT_MODULE) {
1659         return null;
1660     }
1662     if (!isset($areas[$filearea])) {
1663         return null;
1664     }
1666     if (is_null($itemid)) {
1667         require_once($CFG->dirroot.'/mod/glossary/locallib.php');
1668         return new glossary_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
1669     }
1671     if (!$entry = $DB->get_record('glossary_entries', array('id' => $itemid))) {
1672         return null;
1673     }
1675     if (!$glossary = $DB->get_record('glossary', array('id' => $cm->instance))) {
1676         return null;
1677     }
1679     if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1680         return null;
1681     }
1683     // this trickery here is because we need to support source glossary access
1684     if ($entry->glossaryid == $cm->instance) {
1685         $filecontext = $context;
1686     } else if ($entry->sourceglossaryid == $cm->instance) {
1687         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1688             return null;
1689         }
1690         $filecontext = context_module::instance($maincm->id);
1691     } else {
1692         return null;
1693     }
1695     $fs = get_file_storage();
1696     $filepath = is_null($filepath) ? '/' : $filepath;
1697     $filename = is_null($filename) ? '.' : $filename;
1698     if (!($storedfile = $fs->get_file($filecontext->id, 'mod_glossary', $filearea, $itemid, $filepath, $filename))) {
1699         return null;
1700     }
1702     // Checks to see if the user can manage files or is the owner.
1703     // TODO MDL-33805 - Do not use userid here and move the capability check above.
1704     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
1705         return null;
1706     }
1708     $urlbase = $CFG->wwwroot.'/pluginfile.php';
1710     return new file_info_stored($browser, $filecontext, $storedfile, $urlbase, s($entry->concept), true, true, false, false);
1713 /**
1714  * Serves the glossary attachments. Implements needed access control ;-)
1715  *
1716  * @package  mod_glossary
1717  * @category files
1718  * @param stdClass $course course object
1719  * @param stdClass $cm course module object
1720  * @param stdClsss $context context object
1721  * @param string $filearea file area
1722  * @param array $args extra arguments
1723  * @param bool $forcedownload whether or not force download
1724  * @param array $options additional options affecting the file serving
1725  * @return bool false if file not found, does not return if found - justsend the file
1726  */
1727 function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
1728     global $CFG, $DB;
1730     if ($context->contextlevel != CONTEXT_MODULE) {
1731         return false;
1732     }
1734     require_course_login($course, true, $cm);
1736     if ($filearea === 'attachment' or $filearea === 'entry') {
1737         $entryid = (int)array_shift($args);
1739         require_course_login($course, true, $cm);
1741         if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1742             return false;
1743         }
1745         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1746             return false;
1747         }
1749         if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1750             return false;
1751         }
1753         // this trickery here is because we need to support source glossary access
1755         if ($entry->glossaryid == $cm->instance) {
1756             $filecontext = $context;
1758         } else if ($entry->sourceglossaryid == $cm->instance) {
1759             if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1760                 return false;
1761             }
1762             $filecontext = context_module::instance($maincm->id);
1764         } else {
1765             return false;
1766         }
1768         $relativepath = implode('/', $args);
1769         $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath";
1771         $fs = get_file_storage();
1772         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1773             return false;
1774         }
1776         // finally send the file
1777         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
1779     } else if ($filearea === 'export') {
1780         require_login($course, false, $cm);
1781         require_capability('mod/glossary:export', $context);
1783         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1784             return false;
1785         }
1787         $cat = array_shift($args);
1788         $cat = clean_param($cat, PARAM_ALPHANUM);
1790         $filename = clean_filename(strip_tags(format_string($glossary->name)).'.xml');
1791         $content = glossary_generate_export_file($glossary, NULL, $cat);
1793         send_file($content, $filename, 0, 0, true, true);
1794     }
1796     return false;
1799 /**
1800  *
1801  */
1802 function glossary_print_tabbed_table_end() {
1803      echo "</div></div>";
1806 /**
1807  * @param object $cm
1808  * @param object $glossary
1809  * @param string $mode
1810  * @param string $hook
1811  * @param string $sortkey
1812  * @param string $sortorder
1813  */
1814 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1815     if ($glossary->showalphabet) {
1816         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1817     }
1818     glossary_print_special_links($cm, $glossary, $mode, $hook);
1820     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1822     glossary_print_all_links($cm, $glossary, $mode, $hook);
1824     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1826 /**
1827  * @param object $cm
1828  * @param object $glossary
1829  * @param string $hook
1830  * @param string $sortkey
1831  * @param string $sortorder
1832  */
1833 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1834     echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1837 /**
1838  * @param object $cm
1839  * @param object $glossary
1840  * @param string $hook
1841  * @param string $sortkey
1842  * @param string $sortorder
1843  */
1844 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1845     echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1847 /**
1848  * @param object $cm
1849  * @param object $glossary
1850  * @param string $hook
1851  * @param string $sortkey
1852  * @param string $sortorder
1853  */
1854 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1855     if ( $mode != 'date' ) {
1856         if ($glossary->showalphabet) {
1857             echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1858         }
1860         glossary_print_special_links($cm, $glossary, $mode, $hook);
1862         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1864         glossary_print_all_links($cm, $glossary, $mode, $hook);
1865     } else {
1866         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1867     }
1870 /**
1871  * @param object $cm
1872  * @param object $glossary
1873  * @param string $hook
1874  * @param string $sortkey
1875  * @param string $sortorder
1876  */
1877 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1878     if ($glossary->showalphabet) {
1879         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1880     }
1882     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1883     glossary_print_all_links($cm, $glossary, $mode, $hook);
1884     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1887 /**
1888  * @global object
1889  * @global object
1890  * @param object $cm
1891  * @param object $glossary
1892  * @param string $hook
1893  * @param object $category
1894  */
1895 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1896      global $CFG, $DB, $OUTPUT;
1898      $context = context_module::instance($cm->id);
1900     // Prepare format_string/text options
1901     $fmtoptions = array(
1902         'context' => $context);
1904      echo '<table border="0" width="100%">';
1905      echo '<tr>';
1907      echo '<td align="center" style="width:20%">';
1908      if (has_capability('mod/glossary:managecategories', $context)) {
1909              $options['id'] = $cm->id;
1910              $options['mode'] = 'cat';
1911              $options['hook'] = $hook;
1912              echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1913      }
1914      echo '</td>';
1916      echo '<td align="center" style="width:60%">';
1917      echo '<b>';
1919      $menu = array();
1920      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1921      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1923      $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1924      $selected = '';
1925      if ( $categories ) {
1926           foreach ($categories as $currentcategory) {
1927                  $url = $currentcategory->id;
1928                  if ( $category ) {
1929                      if ($currentcategory->id == $category->id) {
1930                          $selected = $url;
1931                      }
1932                  }
1933                  $menu[$url] = format_string($currentcategory->name, true, $fmtoptions);
1934           }
1935      }
1936      if ( !$selected ) {
1937          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1938      }
1940      if ( $category ) {
1941         echo format_string($category->name, true, $fmtoptions);
1942      } else {
1943         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1945             echo get_string("entrieswithoutcategory","glossary");
1946             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1948         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1950             echo get_string("allcategories","glossary");
1951             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1953         }
1954      }
1955      echo '</b></td>';
1956      echo '<td align="center" style="width:20%">';
1958      $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1959      $select->set_label(get_string('categories', 'glossary'), array('class' => 'accesshide'));
1960      echo $OUTPUT->render($select);
1962      echo '</td>';
1963      echo '</tr>';
1965      echo '</table>';
1968 /**
1969  * @global object
1970  * @param object $cm
1971  * @param object $glossary
1972  * @param string $mode
1973  * @param string $hook
1974  */
1975 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1976 global $CFG;
1977      if ( $glossary->showall) {
1978          $strallentries       = get_string("allentries", "glossary");
1979          if ( $hook == 'ALL' ) {
1980               echo "<b>$strallentries</b>";
1981          } else {
1982               $strexplainall = strip_tags(get_string("explainall","glossary"));
1983               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1984          }
1985      }
1988 /**
1989  * @global object
1990  * @param object $cm
1991  * @param object $glossary
1992  * @param string $mode
1993  * @param string $hook
1994  */
1995 function glossary_print_special_links($cm, $glossary, $mode, $hook) {
1996 global $CFG;
1997      if ( $glossary->showspecial) {
1998          $strspecial          = get_string("special", "glossary");
1999          if ( $hook == 'SPECIAL' ) {
2000               echo "<b>$strspecial</b> | ";
2001          } else {
2002               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
2003               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
2004          }
2005      }
2008 /**
2009  * @global object
2010  * @param object $glossary
2011  * @param string $mode
2012  * @param string $hook
2013  * @param string $sortkey
2014  * @param string $sortorder
2015  */
2016 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
2017 global $CFG;
2018      if ( $glossary->showalphabet) {
2019           $alphabet = explode(",", get_string('alphabet', 'langconfig'));
2020           for ($i = 0; $i < count($alphabet); $i++) {
2021               if ( $hook == $alphabet[$i] and $hook) {
2022                    echo "<b>$alphabet[$i]</b>";
2023               } else {
2024                    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>";
2025               }
2026               echo ' | ';
2027           }
2028      }
2031 /**
2032  * @global object
2033  * @param object $cm
2034  * @param string $mode
2035  * @param string $sortkey
2036  * @param string $sortorder
2037  */
2038 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
2039     global $CFG, $OUTPUT;
2041     $asc    = get_string("ascending","glossary");
2042     $desc   = get_string("descending","glossary");
2043     $bopen  = '<b>';
2044     $bclose = '</b>';
2046      $neworder = '';
2047      $currentorder = '';
2048      $currentsort = '';
2049      if ( $sortorder ) {
2050          if ( $sortorder == 'asc' ) {
2051              $currentorder = $asc;
2052              $neworder = '&amp;sortorder=desc';
2053              $newordertitle = get_string('changeto', 'glossary', $desc);
2054          } else {
2055              $currentorder = $desc;
2056              $neworder = '&amp;sortorder=asc';
2057              $newordertitle = get_string('changeto', 'glossary', $asc);
2058          }
2059          $icon = " " . $OUTPUT->pix_icon($sortorder, $newordertitle, 'glossary');
2060      } else {
2061          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
2062                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
2063              $icon = "";
2064              $newordertitle = $asc;
2065          } else {
2066              $newordertitle = $desc;
2067              $neworder = '&amp;sortorder=desc';
2068              $icon = " " . $OUTPUT->pix_icon('asc', $newordertitle, 'glossary');
2069          }
2070      }
2071      $ficon     = '';
2072      $fneworder = '';
2073      $fbtag     = '';
2074      $fendbtag  = '';
2076      $sicon     = '';
2077      $sneworder = '';
2079      $sbtag      = '';
2080      $fbtag      = '';
2081      $fendbtag      = '';
2082      $sendbtag      = '';
2084      $sendbtag  = '';
2086      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
2087          $ficon       = $icon;
2088          $fneworder   = $neworder;
2089          $fordertitle = $newordertitle;
2090          $sordertitle = $asc;
2091          $fbtag       = $bopen;
2092          $fendbtag    = $bclose;
2093      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
2094          $sicon = $icon;
2095          $sneworder   = $neworder;
2096          $fordertitle = $asc;
2097          $sordertitle = $newordertitle;
2098          $sbtag       = $bopen;
2099          $sendbtag    = $bclose;
2100      } else {
2101          $fordertitle = $asc;
2102          $sordertitle = $asc;
2103      }
2105      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
2106          $forder = 'CREATION';
2107          $sorder =  'UPDATE';
2108          $fsort  = get_string("sortbycreation", "glossary");
2109          $ssort  = get_string("sortbylastupdate", "glossary");
2111          $currentsort = $fsort;
2112          if ($sortkey == 'UPDATE') {
2113              $currentsort = $ssort;
2114          }
2115          $sort        = get_string("sortchronogically", "glossary");
2116      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
2117          $forder = 'FIRSTNAME';
2118          $sorder =  'LASTNAME';
2119          $fsort  = get_string("firstname");
2120          $ssort  = get_string("lastname");
2122          $currentsort = $fsort;
2123          if ($sortkey == 'LASTNAME') {
2124              $currentsort = $ssort;
2125          }
2126          $sort        = get_string("sortby", "glossary");
2127      }
2128      $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
2129      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 | ".
2130                           "$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 />";
2133 /**
2134  *
2135  * @param object $entry0
2136  * @param object $entry1
2137  * @return int [-1 | 0 | 1]
2138  */
2139 function glossary_sort_entries ( $entry0, $entry1 ) {
2141     if ( core_text::strtolower(ltrim($entry0->concept)) < core_text::strtolower(ltrim($entry1->concept)) ) {
2142         return -1;
2143     } elseif ( core_text::strtolower(ltrim($entry0->concept)) > core_text::strtolower(ltrim($entry1->concept)) ) {
2144         return 1;
2145     } else {
2146         return 0;
2147     }
2151 /**
2152  * @global object
2153  * @global object
2154  * @global object
2155  * @param object $course
2156  * @param object $entry
2157  * @return bool
2158  */
2159 function  glossary_print_entry_ratings($course, $entry) {
2160     global $OUTPUT;
2161     if( !empty($entry->rating) ){
2162         echo $OUTPUT->render($entry->rating);
2163     }
2166 /**
2167  *
2168  * @global object
2169  * @global object
2170  * @global object
2171  * @param int $courseid
2172  * @param array $entries
2173  * @param int $displayformat
2174  */
2175 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
2176     global $USER, $CFG, $DB;
2178     echo '<div class="boxaligncenter">';
2179     echo '<table class="glossarypopup" cellspacing="0"><tr>';
2180     echo '<td>';
2181     if ( $entries ) {
2182         foreach ( $entries as $entry ) {
2183             if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
2184                 print_error('invalidid', 'glossary');
2185             }
2186             if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
2187                 print_error('coursemisconf');
2188             }
2189             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
2190                 print_error('invalidid', 'glossary');
2191             }
2193             //If displayformat is present, override glossary->displayformat
2194             if ($displayformat < 0) {
2195                 $dp = $glossary->displayformat;
2196             } else {
2197                 $dp = $displayformat;
2198             }
2200             //Get popupformatname
2201             $format = $DB->get_record('glossary_formats', array('name'=>$dp));
2202             $displayformat = $format->popupformatname;
2204             //Check displayformat variable and set to default if necessary
2205             if (!$displayformat) {
2206                 $displayformat = 'dictionary';
2207             }
2209             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
2210             $functionname = 'glossary_show_entry_'.$displayformat;
2212             if (file_exists($formatfile)) {
2213                 include_once($formatfile);
2214                 if (function_exists($functionname)) {
2215                     $functionname($course, $cm, $glossary, $entry,'','','','');
2216                 }
2217             }
2218         }
2219     }
2220     echo '</td>';
2221     echo '</tr></table></div>';
2224 /**
2225  *
2226  * @global object
2227  * @param array $entries
2228  * @param array $aliases
2229  * @param array $categories
2230  * @return string
2231  */
2232 function glossary_generate_export_csv($entries, $aliases, $categories) {
2233     global $CFG;
2234     $csv = '';
2235     $delimiter = '';
2236     require_once($CFG->libdir . '/csvlib.class.php');
2237     $delimiter = csv_import_reader::get_delimiter('comma');
2238     $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
2239     $csvaliases = array(0 => array());
2240     $csvcategories = array(0 => array());
2241     $aliascount = 0;
2242     $categorycount = 0;
2244     foreach ($entries as $entry) {
2245         $thisaliasesentry = array();
2246         $thiscategoriesentry = array();
2247         $thiscsventry = array($entry->concept, nl2br($entry->definition));
2249         if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
2250             $thiscount = count($aliases[$entry->id]);
2251             if ($thiscount > $aliascount) {
2252                 $aliascount = $thiscount;
2253             }
2254             foreach ($aliases[$entry->id] as $alias) {
2255                 $thisaliasesentry[] = trim($alias);
2256             }
2257         }
2258         if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
2259             $thiscount = count($categories[$entry->id]);
2260             if ($thiscount > $categorycount) {
2261                 $categorycount = $thiscount;
2262             }
2263             foreach ($categories[$entry->id] as $catentry) {
2264                 $thiscategoriesentry[] = trim($catentry);
2265             }
2266         }
2267         $csventries[$entry->id] = $thiscsventry;
2268         $csvaliases[$entry->id] = $thisaliasesentry;
2269         $csvcategories[$entry->id] = $thiscategoriesentry;
2271     }
2272     $returnstr = '';
2273     foreach ($csventries as $id => $row) {
2274         $aliasstr = '';
2275         $categorystr = '';
2276         if ($id == 0) {
2277             $aliasstr = get_string('alias', 'glossary');
2278             $categorystr = get_string('category', 'glossary');
2279         }
2280         $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
2281         $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
2282     }
2283     return $returnstr;
2286 /**
2287  *
2288  * @param object $glossary
2289  * @param string $ignored invalid parameter
2290  * @param int|string $hook
2291  * @return string
2292  */
2293 function glossary_generate_export_file($glossary, $ignored = "", $hook = 0) {
2294     global $CFG, $DB;
2296     // Large exports are likely to take their time and memory.
2297     core_php_time_limit::raise();
2298     raise_memory_limit(MEMORY_EXTRA);
2300     $cm = get_coursemodule_from_instance('glossary', $glossary->id, $glossary->course);
2301     $context = context_module::instance($cm->id);
2303     $co  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2305     $co .= glossary_start_tag("GLOSSARY",0,true);
2306     $co .= glossary_start_tag("INFO",1,true);
2307         $co .= glossary_full_tag("NAME",2,false,$glossary->name);
2308         $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
2309         $co .= glossary_full_tag("INTROFORMAT",2,false,$glossary->introformat);
2310         $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
2311         $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
2312         $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
2313         $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
2314         $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
2315         $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
2316         $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
2317         $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
2318         $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
2319         $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
2320         $co .= glossary_xml_export_files('INTROFILES', 2, $context->id, 'intro', 0);
2322         if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) {
2323             $co .= glossary_start_tag("ENTRIES",2,true);
2324             foreach ($entries as $entry) {
2325                 $permissiongranted = 1;
2326                 if ( $hook ) {
2327                     switch ( $hook ) {
2328                     case "ALL":
2329                     case "SPECIAL":
2330                     break;
2331                     default:
2332                         $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
2333                     break;
2334                     }
2335                 }
2336                 if ( $hook ) {
2337                     switch ( $hook ) {
2338                     case GLOSSARY_SHOW_ALL_CATEGORIES:
2339                     break;
2340                     case GLOSSARY_SHOW_NOT_CATEGORISED:
2341                         $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id));
2342                     break;
2343                     default:
2344                         $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook));
2345                     break;
2346                     }
2347                 }
2348                 if ( $entry->approved and $permissiongranted ) {
2349                     $co .= glossary_start_tag("ENTRY",3,true);
2350                     $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
2351                     $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition);
2352                     $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat); // note: use old name for BC reasons
2353                     $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
2354                     $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
2355                     $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
2356                     $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
2358                     if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) {
2359                         $co .= glossary_start_tag("ALIASES",4,true);
2360                         foreach ($aliases as $alias) {
2361                             $co .= glossary_start_tag("ALIAS",5,true);
2362                                 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
2363                             $co .= glossary_end_tag("ALIAS",5,true);
2364                         }
2365                         $co .= glossary_end_tag("ALIASES",4,true);
2366                     }
2367                     if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) {
2368                         $co .= glossary_start_tag("CATEGORIES",4,true);
2369                         foreach ($catentries as $catentry) {
2370                             $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid));
2372                             $co .= glossary_start_tag("CATEGORY",5,true);
2373                                 $co .= glossary_full_tag("NAME",6,false,$category->name);
2374                                 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
2375                             $co .= glossary_end_tag("CATEGORY",5,true);
2376                         }
2377                         $co .= glossary_end_tag("CATEGORIES",4,true);
2378                     }
2380                     // Export files embedded in entries.
2381                     $co .= glossary_xml_export_files('ENTRYFILES', 4, $context->id, 'entry', $entry->id);
2383                     // Export attachments.
2384                     $co .= glossary_xml_export_files('ATTACHMENTFILES', 4, $context->id, 'attachment', $entry->id);
2386                     $co .= glossary_end_tag("ENTRY",3,true);
2387                 }
2388             }
2389             $co .= glossary_end_tag("ENTRIES",2,true);
2391         }
2394     $co .= glossary_end_tag("INFO",1,true);
2395     $co .= glossary_end_tag("GLOSSARY",0,true);
2397     return $co;
2399 /// Functions designed by Eloy Lafuente
2400 /// Functions to create, open and write header of the xml file
2402 /**
2403  * Read import file and convert to current charset
2404  *
2405  * @global object
2406  * @param string $file
2407  * @return string
2408  */
2409 function glossary_read_imported_file($file_content) {
2410     require_once "../../lib/xmlize.php";
2411     global $CFG;
2413     return xmlize($file_content, 0);
2416 /**
2417  * Return the xml start tag
2418  *
2419  * @param string $tag
2420  * @param int $level
2421  * @param bool $endline
2422  * @return string
2423  */
2424 function glossary_start_tag($tag,$level=0,$endline=false) {
2425         if ($endline) {
2426            $endchar = "\n";
2427         } else {
2428            $endchar = "";
2429         }
2430         return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
2433 /**
2434  * Return the xml end tag
2435  * @param string $tag
2436  * @param int $level
2437  * @param bool $endline
2438  * @return string
2439  */
2440 function glossary_end_tag($tag,$level=0,$endline=true) {
2441         if ($endline) {
2442            $endchar = "\n";
2443         } else {
2444            $endchar = "";
2445         }
2446         return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
2449 /**
2450  * Return the start tag, the contents and the end tag
2451  *
2452  * @global object
2453  * @param string $tag
2454  * @param int $level
2455  * @param bool $endline
2456  * @param string $content
2457  * @return string
2458  */
2459 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
2460         global $CFG;
2462         $st = glossary_start_tag($tag,$level,$endline);
2463         $co = preg_replace("/\r\n|\r/", "\n", s($content));
2464         $et = glossary_end_tag($tag,0,true);
2465         return $st.$co.$et;
2468 /**
2469  * Prepares file area to export as part of XML export
2470  *
2471  * @param string $tag XML tag to use for the group
2472  * @param int $taglevel
2473  * @param int $contextid
2474  * @param string $filearea
2475  * @param int $itemid
2476  * @return string
2477  */
2478 function glossary_xml_export_files($tag, $taglevel, $contextid, $filearea, $itemid) {
2479     $co = '';
2480     $fs = get_file_storage();
2481     if ($files = $fs->get_area_files(
2482         $contextid, 'mod_glossary', $filearea, $itemid, 'itemid,filepath,filename', false)) {
2483         $co .= glossary_start_tag($tag, $taglevel, true);
2484         foreach ($files as $file) {
2485             $co .= glossary_start_tag('FILE', $taglevel + 1, true);
2486             $co .= glossary_full_tag('FILENAME', $taglevel + 2, false, $file->get_filename());
2487             $co .= glossary_full_tag('FILEPATH', $taglevel + 2, false, $file->get_filepath());
2488             $co .= glossary_full_tag('CONTENTS', $taglevel + 2, false, base64_encode($file->get_content()));
2489             $co .= glossary_full_tag('FILEAUTHOR', $taglevel + 2, false, $file->get_author());
2490             $co .= glossary_full_tag('FILELICENSE', $taglevel + 2, false, $file->get_license());
2491             $co .= glossary_end_tag('FILE', $taglevel + 1);
2492         }
2493         $co .= glossary_end_tag($tag, $taglevel);
2494     }
2495     return $co;
2498 /**
2499  * Parses files from XML import and inserts them into file system
2500  *
2501  * @param array $xmlparent parent element in parsed XML tree
2502  * @param string $tag
2503  * @param int $contextid
2504  * @param string $filearea
2505  * @param int $itemid
2506  * @return int
2507  */
2508 function glossary_xml_import_files($xmlparent, $tag, $contextid, $filearea, $itemid) {
2509     global $USER, $CFG;
2510     $count = 0;
2511     if (isset($xmlparent[$tag][0]['#']['FILE'])) {
2512         $fs = get_file_storage();
2513         $files = $xmlparent[$tag][0]['#']['FILE'];
2514         foreach ($files as $file) {
2515             $filerecord = array(
2516                 'contextid' => $contextid,
2517                 'component' => 'mod_glossary',
2518                 'filearea'  => $filearea,
2519                 'itemid'    => $itemid,
2520                 'filepath'  => $file['#']['FILEPATH'][0]['#'],
2521                 'filename'  => $file['#']['FILENAME'][0]['#'],
2522                 'userid'    => $USER->id
2523             );
2524             if (array_key_exists('FILEAUTHOR', $file['#'])) {
2525                 $filerecord['author'] = $file['#']['FILEAUTHOR'][0]['#'];
2526             }
2527             if (array_key_exists('FILELICENSE', $file['#'])) {
2528                 $license = $file['#']['FILELICENSE'][0]['#'];
2529                 require_once($CFG->libdir . "/licenselib.php");
2530                 if (license_manager::get_license_by_shortname($license)) {
2531                     $filerecord['license'] = $license;
2532                 }
2533             }
2534             $content =  $file['#']['CONTENTS'][0]['#'];
2535             $fs->create_file_from_string($filerecord, base64_decode($content));
2536             $count++;
2537         }
2538     }
2539     return $count;
2542 /**
2543  * How many unrated entries are in the given glossary for a given user?
2544  *
2545  * @global moodle_database $DB
2546  * @param int $glossaryid
2547  * @param int $userid
2548  * @return int
2549  */
2550 function glossary_count_unrated_entries($glossaryid, $userid) {
2551     global $DB;
2553     $sql = "SELECT COUNT('x') as num
2554               FROM {glossary_entries}
2555              WHERE glossaryid = :glossaryid AND
2556                    userid <> :userid";
2557     $params = array('glossaryid' => $glossaryid, 'userid' => $userid);
2558     $entries = $DB->count_records_sql($sql, $params);
2560     if ($entries) {
2561         // We need to get the contextid for the glossaryid we have been given.
2562         $sql = "SELECT ctx.id
2563                   FROM {context} ctx
2564                   JOIN {course_modules} cm ON cm.id = ctx.instanceid
2565                   JOIN {modules} m ON m.id = cm.module
2566                   JOIN {glossary} g ON g.id = cm.instance
2567                  WHERE ctx.contextlevel = :contextlevel AND
2568                        m.name = 'glossary' AND
2569                        g.id = :glossaryid";
2570         $contextid = $DB->get_field_sql($sql, array('glossaryid' => $glossaryid, 'contextlevel' => CONTEXT_MODULE));
2572         // Now we need to count the ratings that this user has made
2573         $sql = "SELECT COUNT('x') AS num
2574                   FROM {glossary_entries} e
2575                   JOIN {rating} r ON r.itemid = e.id
2576                  WHERE e.glossaryid = :glossaryid AND
2577                        r.userid = :userid AND
2578                        r.component = 'mod_glossary' AND
2579                        r.ratingarea = 'entry' AND
2580                        r.contextid = :contextid";
2581         $params = array('glossaryid' => $glossaryid, 'userid' => $userid, 'contextid' => $contextid);
2582         $rated = $DB->count_records_sql($sql, $params);
2583         if ($rated) {
2584             // The number or enties minus the number or rated entries equals the number of unrated
2585             // entries
2586             if ($entries > $rated) {
2587                 return $entries - $rated;
2588             } else {
2589                 return 0;    // Just in case there was a counting error
2590             }
2591         } else {
2592             return (int)$entries;
2593         }
2594     } else {
2595         return 0;
2596     }
2599 /**
2600  *
2601  * Returns the html code to represent any pagging bar. Paramenters are:
2602  *
2603  * The function dinamically show the first and last pages, and "scroll" over pages.
2604  * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
2605  * could replace the general one. ;-)
2606  *
2607  * @param int $totalcount total number of records to be displayed
2608  * @param int $page page currently selected (0 based)
2609  * @param int $perpage number of records per page
2610  * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically.
2611  *
2612  * @param int $maxpageallowed Optional maximum number of page allowed.
2613  * @param int $maxdisplay Optional maximum number of page links to show in the bar
2614  * @param string $separator Optional string to be used between pages in the bar
2615  * @param string $specialtext Optional string to be showed as an special link
2616  * @param string $specialvalue Optional value (page) to be used in the special link
2617  * @param bool $previousandnext Optional to decide if we want the previous and next links
2618  * @return string
2619  */
2620 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) {
2622     $code = '';
2624     $showspecial = false;
2625     $specialselected = false;
2627     //Check if we have to show the special link
2628     if (!empty($specialtext)) {
2629         $showspecial = true;
2630     }
2631     //Check if we are with the special link selected
2632     if ($showspecial && $page == $specialvalue) {
2633         $specialselected = true;
2634     }
2636     //If there are results (more than 1 page)
2637     if ($totalcount > $perpage) {
2638         $code .= "<div style=\"text-align:center\">";
2639         $code .= "<p>".get_string("page").":";
2641         $maxpage = (int)(($totalcount-1)/$perpage);
2643         //Lower and upper limit of page
2644         if ($page < 0) {
2645             $page = 0;
2646         }
2647         if ($page > $maxpageallowed) {
2648             $page = $maxpageallowed;
2649         }
2650         if ($page > $maxpage) {
2651             $page = $maxpage;
2652         }
2654         //Calculate the window of pages
2655         $pagefrom = $page - ((int)($maxdisplay / 2));
2656         if ($pagefrom < 0) {
2657             $pagefrom = 0;
2658         }
2659         $pageto = $pagefrom + $maxdisplay - 1;
2660         if ($pageto > $maxpageallowed) {
2661             $pageto = $maxpageallowed;
2662         }
2663         if ($pageto > $maxpage) {
2664             $pageto = $maxpage;
2665         }
2667         //Some movements can be necessary if don't see enought pages
2668         if ($pageto - $pagefrom < $maxdisplay - 1) {
2669             if ($pageto - $maxdisplay + 1 > 0) {
2670                 $pagefrom = $pageto - $maxdisplay + 1;
2671             }
2672         }
2674         //Calculate first and last if necessary
2675         $firstpagecode = '';
2676         $lastpagecode = '';
2677         if ($pagefrom > 0) {
2678             $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2679             if ($pagefrom > 1) {
2680                 $firstpagecode .= "$separator...";
2681             }
2682         }
2683         if ($pageto < $maxpage) {
2684             if ($pageto < $maxpage -1) {
2685                 $lastpagecode = "$separator...";
2686             }
2687             $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2688         }
2690         //Previous
2691         if ($page > 0 && $previousandnext) {
2692             $pagenum = $page - 1;
2693             $code .= "&nbsp;(<a  href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;";
2694         }
2696         //Add first
2697         $code .= $firstpagecode;
2699         $pagenum = $pagefrom;
2701         //List of maxdisplay pages
2702         while ($pagenum <= $pageto) {
2703             $pagetoshow = $pagenum +1;
2704             if ($pagenum == $page && !$specialselected) {
2705                 $code .= "$separator<b>$pagetoshow</b>";
2706             } else {
2707                 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2708             }
2709             $pagenum++;
2710         }
2712         //Add last
2713         $code .= $lastpagecode;
2715         //Next
2716         if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2717             $pagenum = $page + 1;
2718             $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2719         }
2721         //Add special
2722         if ($showspecial) {
2723             $code .= '<br />';
2724             if ($specialselected) {
2725                 $code .= "<b>$specialtext</b>";
2726             } else {
2727                 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2728             }
2729         }
2731         //End html
2732         $code .= "</p>";
2733         $code .= "</div>";
2734     }
2736     return $code;
2739 /**
2740  * List the actions that correspond to a view of this module.
2741  * This is used by the participation report.
2742  *
2743  * Note: This is not used by new logging system. Event with
2744  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
2745  *       be considered as view action.
2746  *
2747  * @return array
2748  */
2749 function glossary_get_view_actions() {
2750     return array('view','view all','view entry');
2753 /**
2754  * List the actions that correspond to a post of this module.
2755  * This is used by the participation report.
2756  *
2757  * Note: This is not used by new logging system. Event with
2758  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
2759  *       will be considered as post action.
2760  *
2761  * @return array
2762  */
2763 function glossary_get_post_actions() {
2764     return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry');
2768 /**
2769  * Implementation of the function for printing the form elements that control
2770  * whether the course reset functionality affects the glossary.
2771  * @param object $mform form passed by reference
2772  */
2773 function glossary_reset_course_form_definition(&$mform) {
2774     $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary'));
2775     $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary'));
2777     $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'),
2778                        array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple'));
2779     $mform->setAdvanced('reset_glossary_types');
2780     $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked');
2782     $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary'));
2783     $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked');
2785     $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings'));
2786     $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked');
2788     $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments'));
2789     $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked');
2791     $mform->addElement('checkbox', 'reset_glossary_tags', get_string('removeallglossarytags', 'glossary'));
2792     $mform->disabledIf('reset_glossary_tags', 'reset_glossary_all', 'checked');
2795 /**
2796  * Course reset form defaults.
2797  * @return array
2798  */
2799 function glossary_reset_course_form_defaults($course) {
2800     return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0);
2803 /**
2804  * Removes all grades from gradebook
2805  *
2806  * @param int $courseid The ID of the course to reset
2807  * @param string $type The optional type of glossary. 'main', 'secondary' or ''
2808  */
2809 function glossary_reset_gradebook($courseid, $type='') {
2810     global $DB;
2812     switch ($type) {
2813         case 'main'      : $type = "AND g.mainglossary=1"; break;
2814         case 'secondary' : $type = "AND g.mainglossary=0"; break;
2815         default          : $type = ""; //all
2816     }
2818     $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid
2819               FROM {glossary} g, {course_modules} cm, {modules} m
2820              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type";
2822     if ($glossarys = $DB->get_records_sql($sql, array($courseid))) {
2823         foreach ($glossarys as $glossary) {
2824             glossary_grade_item_update($glossary, 'reset');
2825         }
2826     }
2828 /**
2829  * Actual implementation of the reset course functionality, delete all the
2830  * glossary responses for course $data->courseid.
2831  *
2832  * @global object
2833  * @param $data the data submitted from the reset course.
2834  * @return array status array
2835  */
2836 function glossary_reset_userdata($data) {
2837     global $CFG, $DB;
2838     require_once($CFG->dirroot.'/rating/lib.php');
2840     $componentstr = get_string('modulenameplural', 'glossary');
2841     $status = array();
2843     $allentriessql = "SELECT e.id
2844                         FROM {glossary_entries} e
2845                              JOIN {glossary} g ON e.glossaryid = g.id
2846                        WHERE g.course = ?";
2848     $allglossariessql = "SELECT g.id
2849                            FROM {glossary} g
2850                           WHERE g.course = ?";
2852     $params = array($data->courseid);
2854     $fs = get_file_storage();
2856     $rm = new rating_manager();
2857     $ratingdeloptions = new stdClass;
2858     $ratingdeloptions->component = 'mod_glossary';
2859     $ratingdeloptions->ratingarea = 'entry';
2861     // delete entries if requested
2862     if (!empty($data->reset_glossary_all)
2863          or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) {
2865         $params[] = 'glossary_entry';
2866         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea=?", $params);
2867         $DB->delete_records_select('glossary_alias',    "entryid IN ($allentriessql)", $params);
2868         $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2870         // now get rid of all attachments
2871         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2872             foreach ($glossaries as $glossaryid=>$unused) {
2873                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2874                     continue;
2875                 }
2876                 $context = context_module::instance($cm->id);
2877                 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2879                 //delete ratings
2880                 $ratingdeloptions->contextid = $context->id;
2881                 $rm->delete_ratings($ratingdeloptions);
2883                 core_tag_tag::delete_instances('mod_glossary', null, $context->id);
2884             }
2885         }
2887         // remove all grades from gradebook
2888         if (empty($data->reset_gradebook_grades)) {
2889             glossary_reset_gradebook($data->courseid);
2890         }
2892         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2894     } else if (!empty($data->reset_glossary_types)) {
2895         $mainentriessql         = "$allentriessql AND g.mainglossary=1";
2896         $secondaryentriessql    = "$allentriessql AND g.mainglossary=0";
2898         $mainglossariessql      = "$allglossariessql AND g.mainglossary=1";
2899         $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2901         if (in_array('main', $data->reset_glossary_types)) {
2902             $params[] = 'glossary_entry';
2903             $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params);
2904             $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2906             if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2907                 foreach ($glossaries as $glossaryid=>$unused) {
2908                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2909                         continue;
2910                     }
2911                     $context = context_module::instance($cm->id);
2912                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2914                     //delete ratings
2915                     $ratingdeloptions->contextid = $context->id;
2916                     $rm->delete_ratings($ratingdeloptions);
2918                     core_tag_tag::delete_instances('mod_glossary', null, $context->id);
2919                 }
2920             }
2922             // remove all grades from gradebook
2923             if (empty($data->reset_gradebook_grades)) {
2924                 glossary_reset_gradebook($data->courseid, 'main');
2925             }
2927             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('mainglossary', 'glossary'), 'error'=>false);
2929         } else if (in_array('secondary', $data->reset_glossary_types)) {
2930             $params[] = 'glossary_entry';
2931             $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params);
2932             $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2933             // remove exported source flag from entries in main glossary
2934             $DB->execute("UPDATE {glossary_entries}
2935                              SET sourceglossaryid=0
2936                            WHERE glossaryid IN ($mainglossariessql)", $params);
2938             if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2939                 foreach ($glossaries as $glossaryid=>$unused) {
2940                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2941                         continue;
2942                     }
2943                     $context = context_module::instance($cm->id);
2944                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2946                     //delete ratings
2947                     $ratingdeloptions->contextid = $context->id;
2948                     $rm->delete_ratings($ratingdeloptions);
2950                     core_tag_tag::delete_instances('mod_glossary', null, $context->id);
2951                 }
2952             }
2954             // remove all grades from gradebook
2955             if (empty($data->reset_gradebook_grades)) {
2956                 glossary_reset_gradebook($data->courseid, 'secondary');
2957             }
2959             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2960         }
2961     }
2963     // remove entries by users not enrolled into course
2964     if (!empty($data->reset_glossary_notenrolled)) {
2965         $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2966                          FROM {glossary_entries} e
2967                               JOIN {glossary} g ON e.glossaryid = g.id
2968                               LEFT JOIN {user} u ON e.userid = u.id
2969                         WHERE g.course = ? AND e.userid > 0";
2971         $course_context = context_course::instance($data->courseid);
2972         $notenrolled = array();
2973         $rs = $DB->get_recordset_sql($entriessql, $params);
2974         if ($rs->valid()) {
2975             foreach ($rs as $entry) {
2976                 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2977                   or !is_enrolled($course_context , $entry->userid)) {
2978                     $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id));
2979                     $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2981                     if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2982                         $context = context_module::instance($cm->id);
2983                         $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
2985                         //delete ratings
2986                         $ratingdeloptions->contextid = $context->id;
2987                         $rm->delete_ratings($ratingdeloptions);
2988                     }
2989                 }
2990             }
2991             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2992         }
2993         $rs->close();
2994     }
2996     // remove all ratings
2997     if (!empty($data->reset_glossary_ratings)) {
2998         //remove ratings
2999         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
3000             foreach ($glossaries as $glossaryid=>$unused) {
3001                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
3002                     continue;
3003                 }
3004                 $context = context_module::instance($cm->id);
3006                 //delete ratings
3007                 $ratingdeloptions->contextid = $context->id;
3008                 $rm->delete_ratings($ratingdeloptions);
3009             }
3010         }
3012         // remove all grades from gradebook
3013         if (empty($data->reset_gradebook_grades)) {
3014             glossary_reset_gradebook($data->courseid);
3015         }
3016         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
3017     }
3019     // remove comments
3020     if (!empty($data->reset_glossary_comments)) {
3021         $params[] = 'glossary_entry';
3022         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params);
3023         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
3024     }
3026     // Remove all the tags.
3027     if (!empty($data->reset_glossary_tags)) {
3028         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
3029             foreach ($glossaries as $glossaryid => $unused) {
3030                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
3031                     continue;
3032                 }
3034                 $context = context_module::instance($cm->id);
3035                 core_tag_tag::delete_instances('mod_glossary', null, $context->id);
3036             }
3037         }
3039         $status[] = array('component' => $componentstr, 'item' => get_string('tagsdeleted', 'glossary'), 'error' => false);
3040     }
3042     /// updating dates - shift may be negative too
3043     if ($data->timeshift) {
3044         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
3045         // See MDL-9367.
3046         shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
3047         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
3048     }
3050     return $status;
3053 /**
3054  * Returns all other caps used in module
3055  * @return array
3056  */
3057 function glossary_get_extra_capabilities() {
3058     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');
3061 /**
3062  * @param string $feature FEATURE_xx constant for requested feature
3063  * @return mixed True if module supports feature, null if doesn't know
3064  */
3065 function glossary_supports($feature) {
3066     switch($feature) {
3067         case FEATURE_GROUPS:                  return false;
3068         case FEATURE_GROUPINGS:               return false;
3069         case FEATURE_MOD_INTRO:               return true;
3070         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
3071         case FEATURE_COMPLETION_HAS_RULES:    return true;
3072         case FEATURE_GRADE_HAS_GRADE:         return true;
3073         case FEATURE_GRADE_OUTCOMES:          return true;
3074         case FEATURE_RATE:                    return true;
3075         case FEATURE_BACKUP_MOODLE2:          return true;
3076         case FEATURE_SHOW_DESCRIPTION:        return true;
3077         case FEATURE_COMMENT:                 return true;
3079         default: return null;
3080     }
3083 /**
3084  * Obtains the automatic completion state for this glossary based on any conditions
3085  * in glossary settings.
3086  *
3087  * @global object
3088  * @global object
3089  * @param object $course Course
3090  * @param object $cm Course-module
3091  * @param int $userid User ID
3092  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
3093  * @return bool True if completed, false if not. (If no conditions, then return
3094  *   value depends on comparison type)
3095  */
3096 function glossary_get_completion_state($course,$cm,$userid,$type) {
3097     global $CFG, $DB;
3099     // Get glossary details
3100     if (!($glossary=$DB->get_record('glossary',array('id'=>$cm->instance)))) {
3101         throw new Exception("Can't find glossary {$cm->instance}");
3102     }
3104     $result=$type; // Default return value
3106     if ($glossary->completionentries) {
3107         $value = $glossary->completionentries <=
3108                  $DB->count_records('glossary_entries',array('glossaryid'=>$glossary->id, 'userid'=>$userid, 'approved'=>1));
3109         if ($type == COMPLETION_AND) {
3110             $result = $result && $value;
3111         } else {
3112             $result = $result || $value;
3113         }
3114     }
3116     return $result;
3119 function glossary_extend_navigation($navigation, $course, $module, $cm) {
3120     global $CFG, $DB;
3122     $displayformat = $DB->get_record('glossary_formats', array('name' => $module->displayformat));
3123     // Get visible tabs for the format and check if the menu needs to be displayed.
3124     $showtabs = glossary_get_visible_tabs($displayformat);
3126     foreach ($showtabs as $showtabkey => $showtabvalue) {
3128         switch($showtabvalue) {
3129             case GLOSSARY_STANDARD :
3130                 $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php',
3131                         array('id' => $cm->id, 'mode' => 'letter')));
3132                 break;
3133             case GLOSSARY_CATEGORY :
3134                 $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php',
3135                         array('id' => $cm->id, 'mode' => 'cat')));
3136                 break;
3137             case GLOSSARY_DATE :
3138                 $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php',
3139                         array('id' => $cm->id, 'mode' => 'date')));
3140                 break;
3141             case GLOSSARY_AUTHOR :
3142                 $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php',
3143                         array('id' => $cm->id, 'mode' => 'author')));
3144                 break;
3145         }
3146     }
3149 /**
3150  * Adds module specific settings to the settings block
3151  *
3152  * @param settings_navigation $settings The settings navigation object
3153  * @param navigation_node $glossarynode The node to add module settings to
3154  */
3155 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
3156     global $PAGE, $DB, $CFG, $USER;
3158     $mode = optional_param('mode', '', PARAM_ALPHA);
3159     $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
3161     if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
3162         $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
3163     }
3165     if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
3166         $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
3167     }
3169     if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
3170         $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
3171     }
3173     if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
3174         $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
3175     }
3177     $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
3179     if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles && has_capability('mod/glossary:view', $PAGE->cm->context)) {
3180         require_once("$CFG->libdir/rsslib.php");
3182         $string = get_string('rsstype','forum');
3184         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_glossary', $glossary->id));
3185         $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3186     }
3189 /**
3190  * Running addtional permission check on plugin, for example, plugins
3191  * may have switch to turn on/off comments option, this callback will
3192  * affect UI display, not like pluginname_comment_validate only throw
3193  * exceptions.
3194  * Capability check has been done in comment->check_permissions(), we
3195  * don't need to do it again here.
3196  *
3197  * @package  mod_glossary
3198  * @category comment
3199  *
3200  * @param stdClass $comment_param {
3201  *              context  => context the context object
3202  *              courseid => int course id
3203  *              cm       => stdClass course module object
3204  *              commentarea => string comment area
3205  *              itemid      => int itemid
3206  * }
3207  * @return array
3208  */
3209 function glossary_comment_permissions($comment_param) {
3210     return array('post'=>true, 'view'=>true);
3213 /**
3214  * Validate comment parameter before perform other comments actions
3215  *
3216  * @package  mod_glossary
3217  * @category comment
3218  *
3219  * @param stdClass $comment_param {
3220  *              context  => context the context object
3221  *              courseid => int course id
3222  *              cm       => stdClass course module object
3223  *              commentarea => string comment area
3224  *              itemid      => int itemid
3225  * }
3226  * @return boolean
3227  */
3228 function glossary_comment_validate($comment_param) {
3229     global $DB;
3230     // validate comment area
3231     if ($comment_param->commentarea != 'glossary_entry') {
3232         throw new comment_exception('invalidcommentarea');
3233     }
3234     if (!$record = $DB->get_record('glossary_entries', array('id'=>$comment_param->itemid))) {
3235         throw new comment_exception('invalidcommentitemid');
3236     }
3237     if ($record->sourceglossaryid && $record->sourceglossaryid == $comment_param->cm->instance) {
3238         $glossary = $DB->get_record('glossary', array('id'=>$record->sourceglossaryid));
3239     } else {
3240         $glossary = $DB->get_record('glossary', array('id'=>$record->glossaryid));
3241     }
3242     if (!$glossary) {
3243         throw new comment_exception('invalidid', 'data');
3244     }
3245     if (!$course = $DB->get_record('course', array('id'=>$glossary->course))) {
3246         throw new comment_exception('coursemisconf');
3247     }
3248     if (!$cm = get_coursemodule_from_instance('glossary', $glossary->id, $course->id)) {
3249         throw new comment_exception('invalidcoursemodule');
3250     }
3251     $context = context_module::instance($cm->id);
3253     if ($glossary->defaultapproval and !$record->approved and !has_capability('mod/glossary:approve', $context)) {
3254         throw new comment_exception('notapproved', 'glossary');
3255     }
3256     // validate context id
3257     if ($context->id != $comment_param->context->id) {
3258         throw new comment_exception('invalidcontext');
3259     }
3260     // validation for comment deletion
3261     if (!empty($comment_param->commentid)) {
3262         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3263             if ($comment->commentarea != 'glossary_entry') {
3264                 throw new comment_exception('invalidcommentarea');
3265             }
3266             if ($comment->contextid != $comment_param->context->id) {
3267                 throw new comment_exception('invalidcontext');
3268             }
3269             if ($comment->itemid != $comment_param->itemid) {
3270                 throw new comment_exception('invalidcommentitemid');
3271             }
3272         } else {
3273             throw new comment_exception('invalidcommentid');
3274         }
3275     }
3276     return true;
3279 /**
3280  * Return a list of page types
3281  * @param string $pagetype current page type
3282  * @param stdClass $parentcontext Block's parent context
3283  * @param stdClass $currentcontext Current context of block
3284  */
3285 function glossary_page_type_list($pagetype, $parentcontext, $currentcontext) {
3286     $module_pagetype = array(
3287         'mod-glossary-*'=>get_string('page-mod-glossary-x', 'glossary'),
3288         'mod-glossary-view'=>get_string('page-mod-glossary-view', 'glossary'),
3289         'mod-glossary-edit'=>get_string('page-mod-glossary-edit', 'glossary'));
3290     return $module_pagetype;
3293 /**
3294  * Return list of all glossary tabs.
3295  * @throws coding_exception
3296  * @return array
3297  */
3298 function glossary_get_all_tabs() {
3300     return array (
3301         GLOSSARY_AUTHOR => get_string('authorview', 'glossary'),
3302         GLOSSARY_CATEGORY => get_string('categoryview', 'glossary'),
3303         GLOSSARY_DATE => get_string('dateview', 'glossary')
3304     );
3307 /**
3308  * Set 'showtabs' value for glossary formats
3309  * @param stdClass $glossaryformat record from 'glossary_formats' table
3310  */
3311 function glossary_set_default_visible_tabs($glossaryformat) {
3312     global $DB;
3314     switch($glossaryformat->name) {
3315         case GLOSSARY_CONTINUOUS:
3316             $showtabs = 'standard,category,date';
3317             break;
3318         case GLOSSARY_DICTIONARY:
3319             $showtabs = 'standard';
3320             // Special code for upgraded instances that already had categories set up
3321             // in this format - enable "category" tab.
3322             // In new instances only 'standard' tab will be visible.
3323             if ($DB->record_exists_sql("SELECT 1
3324                     FROM {glossary} g, {glossary_categories} gc
3325                     WHERE g.id = gc.glossaryid and g.displayformat = ?",
3326                     array(GLOSSARY_DICTIONARY))) {
3327                 $showtabs .= ',category';
3328             }
3329             break;
3330         case GLOSSARY_FULLWITHOUTAUTHOR:
3331             $showtabs = 'standard,category,date';
3332             break;
3333         default:
3334             $showtabs = 'standard,category,date,author';
3335             break;
3336     }
3338     $DB->set_field('glossary_formats', 'showtabs', $showtabs, array('id' => $glossaryformat->id));
3339     $glossaryformat->showtabs = $showtabs;
3342 /**
3343  * Convert 'showtabs' string to array
3344  * @param stdClass $displayformat record from 'glossary_formats' table
3345  * @return array
3346  */
3347 function glossary_get_visible_tabs($displayformat) {
3348     if (empty($displayformat->showtabs)) {
3349         glossary_set_default_visible_tabs($displayformat);
3350     }
3351     $showtabs = preg_split('/,/', $displayformat->showtabs, -1, PREG_SPLIT_NO_EMPTY);
3353     return $showtabs;
3356 /**
3357  * Notify that the glossary was viewed.
3358  *
3359  * This will trigger relevant events and activity completion.
3360  *
3361  * @param stdClass $glossary The glossary object.
3362  * @param stdClass $course   The course object.
3363  * @param stdClass $cm       The course module object.
3364  * @param stdClass $context  The context object.
3365  * @param string   $mode     The mode in which the glossary was viewed.
3366  * @since Moodle 3.1
3367  */
3368 function glossary_view($glossary, $course, $cm, $context, $mode) {
3370     // Completion trigger.
3371     $completion = new completion_info($course);
3372     $completion->set_module_viewed($cm);
3374     // Trigger the course module viewed event.
3375     $event = \mod_glossary\event\course_module_viewed::create(array(
3376         'objectid' => $glossary->id,
3377         'context' => $context,
3378         'other' => array('mode' => $mode)
3379     ));
3380     $event->add_record_snapshot('course', $course);
3381     $event->add_record_snapshot('course_modules', $cm);
3382     $event->add_record_snapshot('glossary', $glossary);
3383     $event->trigger();
3386 /**
3387  * Notify that a glossary entry was viewed.
3388  *
3389  * This will trigger relevant events.
3390  *
3391  * @param stdClass $entry    The entry object.
3392  * @param stdClass $context  The context object.
3393  * @since Moodle 3.1
3394  */
3395 function glossary_entry_view($entry, $context) {
3397     // Trigger the entry viewed event.
3398     $event = \mod_glossary\event\entry_viewed::create(array(
3399         'objectid' => $entry->id,
3400         'context' => $context
3401     ));
3402     $event->add_record_snapshot('glossary_entries', $entry);
3403     $event->trigger();
3407 /**
3408  * Returns the entries of a glossary by letter.
3409  *
3410  * @param  object $glossary The glossary.
3411  * @param  context $context The context of the glossary.
3412  * @param  string $letter The letter, or ALL, or SPECIAL.
3413  * @param  int $from Fetch records from.
3414  * @param  int $limit Number of records to fetch.
3415  * @param  array $options Accepts:
3416  *                        - (bool) includenotapproved. When false, includes the non-approved entries created by
3417  *                          the current user. When true, also includes the ones that the user has the permission to approve.
3418  * @return array The first element being the recordset, the second the number of entries.
3419  * @since Moodle 3.1
3420  */
3421 function glossary_get_entries_by_letter($glossary, $context, $letter, $from, $limit, $options = array()) {
3423     $qb = new mod_glossary_entry_query_builder($glossary);
3424     if ($letter != 'ALL' && $letter != 'SPECIAL' && core_text::strlen($letter)) {
3425         $qb->filter_by_concept_letter($letter);
3426     }
3427     if ($letter == 'SPECIAL') {
3428         $qb->filter_by_concept_non_letter();
3429     }
3431     if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) {
3432         $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ALL);
3433     } else {
3434         $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_SELF);
3435     }
3437     $qb->add_field('*', 'entries');
3438     $qb->join_user();
3439     $qb->add_user_fields();
3440     $qb->order_by('concept', 'entries');
3441     $qb->order_by('id', 'entries', 'ASC'); // Sort on ID to avoid random ordering when entries share an ordering value.
3442     $qb->limit($from, $limit);
3444     // Fetching the entries.
3445     $count = $qb->count_records();
3446     $entries = $qb->get_records();
3448     return array($entries, $count);
3451 /**
3452  * Returns the entries of a glossary by date.
3453  *
3454  * @param  object $glossary The glossary.
3455  * @param  context $context The context of the glossary.
3456  * @param  string $order The mode of ordering: CREATION or UPDATE.
3457  * @param  string $sort The direction of the ordering: ASC or DESC.
3458  * @param  int $from Fetch records from.
3459  * @param  int $limit Number of records to fetch.
3460  * @param  array $options Accepts:
3461  *                        - (bool) includenotapproved. When false, includes the non-approved entries created by
3462  *                          the current user. When true, also includes the ones that the user has the permission to approve.
3463  * @return array The first element being the recordset, the second the number of entries.
3464  * @since Moodle 3.1
3465  */
3466 function glossary_get_entries_by_date($glossary, $context, $order, $sort, $from, $limit, $options = array()) {
3468     $qb = new mod_glossary_entry_query_builder($glossary);
3469     if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) {
3470         $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ALL);
3471     } else {
3472         $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_SELF);
3473     }
3475     $qb->add_field('*', 'entries');
3476     $qb->join_user();
3477     $qb->add_user_fields();
3478     $qb->limit($from, $limit);
3480     if ($order == 'CREATION') {
3481         $qb->order_by('timecreated', 'entries', $sort);
3482     } else {
3483         $qb->order_by('timemodified', 'entries', $sort);
3484     }
3485     $qb->order_by('id', 'entries', $sort); // Sort on ID to avoid random ordering when entries share an ordering value.
3487     // Fetching the entries.
3488     $count = $qb->count_records();
3489     $entries = $qb->get_records();
3491     return array($entries, $count);
3494 /**
3495  * Returns the entries of a glossary by category.
3496  *
3497  * @param  object $glossary The glossary.
3498  * @param  context $context The context of the glossary.
3499  * @param  int $categoryid The category ID, or GLOSSARY_SHOW_* constant.
3500  * @param  int $from Fetch records from.
3501  * @param  int $limit Number of records to fetch.
3502  * @param  array $options Accepts:
3503  *                        - (bool) includenotapproved. When false, includes the non-approved entries created by
3504  *                          the current user. When true, also includes the ones that the user has the permission to approve.
3505  * @return array The first element being the recordset, the second the number of entries.
3506  * @since Moodle 3.1
3507  */
3508 function glossary_get_entries_by_category($glossary, $context, $categoryid, $from, $limit, $options = array()) {
3510     $qb = new mod_glossary_entry_query_builder($glossary);
3511     if (!empty($options['includenotapproved']) && has_capability('mod/glossary:approve', $context)) {
3512         $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_ALL);
3513     } else {
3514         $qb->filter_by_non_approved(mod_glossary_entry_query_builder::NON_APPROVED_SELF);
3515     }
3517     $qb->join_category($categoryid);
3518     $qb->join_user();
3520     // The first field must be the relationship ID when viewing all categories.
3521     if ($categoryid === GLOSSARY_SHOW_ALL_CATEGORIES) {
3522         $qb->add_field('id', 'entries_categories', 'cid');
3523     }
3525     $qb->add_field('*', 'entries');
3526     $qb->add_field('categoryid', 'entries_categories');
3527     $qb->add_user_fields();
3529     if ($categoryid === GLOSSARY_SHOW_ALL_CATEGORIES) {
3530         $qb->add_field('name', 'categories', 'categoryname');
3531         $qb->order_by('name', 'categories');
3533     } else if ($categoryid === GLOSSARY_SHOW_NOT_CATEGORISED) {
3534         $qb->where('categoryid', 'entries_categories', null);
3535     }
3537     // Sort on additional fields to avoid random ordering when entries share an ordering value.
3538     $qb->order_by('concept', 'entries');
3539     $qb->order_by('id', 'entries', 'ASC');
3540     $qb->limit($from, $limit);
3542     // Fetching the entries.
3543     $count = $qb->count_records();
3544     $entries = $qb->get_records();
3546     return array($entries, $count);
3549 /**
3550  * Returns the entries of a glossary by author.
3551  *
3552  * @param  object $glossary The glossary.
3553  * @param  context $context The context of the glossary.
3554  * @param  string $letter The letter
3555  * @param  string $field The field to search: FIRSTNAME or LASTNAME.
3556  * @param  string $sort The sorting: ASC or DESC.
3557  * @param  int $from Fetch records from.
3558  * @param  int $limit Number of records to fetch.
3559  * @param  array $options Accepts:
3560  *                        - (bool) includenotapproved. When false, includes the non-approved entries created by
3561  *                          the current user. When true, also includes the ones that the user has the permission to approve.
3562  * @return array The first element being the recordset, the second the number of entries.
3563  * @since Moodle 3.1
3564  */
3565 function glossary_get_entries_by_author($glossary, $context, $letter, $field, $sort, $from, $limit, $options = array()) {
3567     $firstnamefirst = $field === 'FIRSTNAME';
3568     $qb = new mod_glossary_entry_query_builder($glossary);
3569     if ($letter != 'ALL' && $letter != 'SPECIAL' && core_text::strlen($letter)) {
3570         $qb->filter_by_author_letter($letter, $firstnamefirst);
3571     }
3572     if ($letter == 'SPECIAL') {