Merge branch '44158-27' of git://github.com/samhemelryk/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 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
42 /**
43  * @global object
44  * @param object $glossary
45  * @return int
46  */
47 function glossary_add_instance($glossary) {
48     global $DB;
49 /// Given an object containing all the necessary data,
50 /// (defined by the form in mod_form.php) this function
51 /// will create a new instance and return the id number
52 /// of the new instance.
54     if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
55         $glossary->assesstimestart  = 0;
56         $glossary->assesstimefinish = 0;
57     }
59     if (empty($glossary->globalglossary) ) {
60         $glossary->globalglossary = 0;
61     }
63     if (!has_capability('mod/glossary:manageentries', context_system::instance())) {
64         $glossary->globalglossary = 0;
65     }
67     $glossary->timecreated  = time();
68     $glossary->timemodified = $glossary->timecreated;
70     //Check displayformat is a valid one
71     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
72     if (!in_array($glossary->displayformat, $formats)) {
73         print_error('unknowformat', '', '', $glossary->displayformat);
74     }
76     $returnid = $DB->insert_record("glossary", $glossary);
77     $glossary->id = $returnid;
78     glossary_grade_item_update($glossary);
80     return $returnid;
81 }
83 /**
84  * Given an object containing all the necessary data,
85  * (defined by the form in mod_form.php) this function
86  * will update an existing instance with new data.
87  *
88  * @global object
89  * @global object
90  * @param object $glossary
91  * @return bool
92  */
93 function glossary_update_instance($glossary) {
94     global $CFG, $DB;
96     if (empty($glossary->globalglossary)) {
97         $glossary->globalglossary = 0;
98     }
100     if (!has_capability('mod/glossary:manageentries', context_system::instance())) {
101         // keep previous
102         unset($glossary->globalglossary);
103     }
105     $glossary->timemodified = time();
106     $glossary->id           = $glossary->instance;
108     if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
109         $glossary->assesstimestart  = 0;
110         $glossary->assesstimefinish = 0;
111     }
113     //Check displayformat is a valid one
114     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
115     if (!in_array($glossary->displayformat, $formats)) {
116         print_error('unknowformat', '', '', $glossary->displayformat);
117     }
119     $DB->update_record("glossary", $glossary);
120     if ($glossary->defaultapproval) {
121         $DB->execute("UPDATE {glossary_entries} SET approved = 1 where approved <> 1 and glossaryid = ?", array($glossary->id));
122     }
123     glossary_grade_item_update($glossary);
125     return true;
128 /**
129  * Given an ID of an instance of this module,
130  * this function will permanently delete the instance
131  * and any data that depends on it.
132  *
133  * @global object
134  * @param int $id glossary id
135  * @return bool success
136  */
137 function glossary_delete_instance($id) {
138     global $DB, $CFG;
140     if (!$glossary = $DB->get_record('glossary', array('id'=>$id))) {
141         return false;
142     }
144     if (!$cm = get_coursemodule_from_instance('glossary', $id)) {
145         return false;
146     }
148     if (!$context = context_module::instance($cm->id, IGNORE_MISSING)) {
149         return false;
150     }
152     $fs = get_file_storage();
154     if ($glossary->mainglossary) {
155         // unexport entries
156         $sql = "SELECT ge.id, ge.sourceglossaryid, cm.id AS sourcecmid
157                   FROM {glossary_entries} ge
158                   JOIN {modules} m ON m.name = 'glossary'
159                   JOIN {course_modules} cm ON (cm.module = m.id AND cm.instance = ge.sourceglossaryid)
160                  WHERE ge.glossaryid = ? AND ge.sourceglossaryid > 0";
162         if ($exported = $DB->get_records_sql($sql, array($id))) {
163             foreach ($exported as $entry) {
164                 $entry->glossaryid = $entry->sourceglossaryid;
165                 $entry->sourceglossaryid = 0;
166                 $newcontext = context_module::instance($entry->sourcecmid);
167                 if ($oldfiles = $fs->get_area_files($context->id, 'mod_glossary', 'attachment', $entry->id)) {
168                     foreach ($oldfiles as $oldfile) {
169                         $file_record = new stdClass();
170                         $file_record->contextid = $newcontext->id;
171                         $fs->create_file_from_storedfile($file_record, $oldfile);
172                     }
173                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
174                     $entry->attachment = '1';
175                 } else {
176                     $entry->attachment = '0';
177                 }
178                 $DB->update_record('glossary_entries', $entry);
179             }
180         }
181     } else {
182         // move exported entries to main glossary
183         $sql = "UPDATE {glossary_entries}
184                    SET sourceglossaryid = 0
185                  WHERE sourceglossaryid = ?";
186         $DB->execute($sql, array($id));
187     }
189     // Delete any dependent records
190     $entry_select = "SELECT id FROM {glossary_entries} WHERE glossaryid = ?";
191     $DB->delete_records_select('comments', "contextid=? AND commentarea=? AND itemid IN ($entry_select)", array($id, 'glossary_entry', $context->id));
192     $DB->delete_records_select('glossary_alias',    "entryid IN ($entry_select)", array($id));
194     $category_select = "SELECT id FROM {glossary_categories} WHERE glossaryid = ?";
195     $DB->delete_records_select('glossary_entries_categories', "categoryid IN ($category_select)", array($id));
196     $DB->delete_records('glossary_categories', array('glossaryid'=>$id));
197     $DB->delete_records('glossary_entries', array('glossaryid'=>$id));
199     // delete all files
200     $fs->delete_area_files($context->id);
202     glossary_grade_item_delete($glossary);
204     return $DB->delete_records('glossary', array('id'=>$id));
207 /**
208  * Return a small object with summary information about what a
209  * user has done with a given particular instance of this module
210  * Used for user activity reports.
211  * $return->time = the time they did it
212  * $return->info = a short text description
213  *
214  * @param object $course
215  * @param object $user
216  * @param object $mod
217  * @param object $glossary
218  * @return object|null
219  */
220 function glossary_user_outline($course, $user, $mod, $glossary) {
221     global $CFG;
223     require_once("$CFG->libdir/gradelib.php");
224     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
225     if (empty($grades->items[0]->grades)) {
226         $grade = false;
227     } else {
228         $grade = reset($grades->items[0]->grades);
229     }
231     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
232         $result = new stdClass();
233         $result->info = count($entries) . ' ' . get_string("entries", "glossary");
235         $lastentry = array_pop($entries);
236         $result->time = $lastentry->timemodified;
238         if ($grade) {
239             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
240         }
241         return $result;
242     } else if ($grade) {
243         $result = new stdClass();
244         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
246         //datesubmitted == time created. dategraded == time modified or time overridden
247         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
248         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
249         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
250             $result->time = $grade->dategraded;
251         } else {
252             $result->time = $grade->datesubmitted;
253         }
255         return $result;
256     }
257     return NULL;
260 /**
261  * @global object
262  * @param int $glossaryid
263  * @param int $userid
264  * @return array
265  */
266 function glossary_get_user_entries($glossaryid, $userid) {
267 /// Get all the entries for a user in a glossary
268     global $DB;
270     return $DB->get_records_sql("SELECT e.*, u.firstname, u.lastname, u.email, u.picture
271                                    FROM {glossary} g, {glossary_entries} e, {user} u
272                              WHERE g.id = ?
273                                AND e.glossaryid = g.id
274                                AND e.userid = ?
275                                AND e.userid = u.id
276                           ORDER BY e.timemodified ASC", array($glossaryid, $userid));
279 /**
280  * Print a detailed representation of what a  user has done with
281  * a given particular instance of this module, for user activity reports.
282  *
283  * @global object
284  * @param object $course
285  * @param object $user
286  * @param object $mod
287  * @param object $glossary
288  */
289 function glossary_user_complete($course, $user, $mod, $glossary) {
290     global $CFG, $OUTPUT;
291     require_once("$CFG->libdir/gradelib.php");
293     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
294     if (!empty($grades->items[0]->grades)) {
295         $grade = reset($grades->items[0]->grades);
296         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
297         if ($grade->str_feedback) {
298             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
299         }
300     }
302     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
303         echo '<table width="95%" border="0"><tr><td>';
304         foreach ($entries as $entry) {
305             $cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id);
306             glossary_print_entry($course, $cm, $glossary, $entry,"","",0);
307             echo '<p>';
308         }
309         echo '</td></tr></table>';
310     }
313 /**
314  * Returns all glossary entries since a given time for specified glossary
315  *
316  * @param array $activities sequentially indexed array of objects
317  * @param int   $index
318  * @param int   $timestart
319  * @param int   $courseid
320  * @param int   $cmid
321  * @param int   $userid defaults to 0
322  * @param int   $groupid defaults to 0
323  * @return void adds items into $activities and increases $index
324  */
325 function glossary_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid = 0, $groupid = 0) {
326     global $COURSE, $USER, $DB;
328     if ($COURSE->id == $courseid) {
329         $course = $COURSE;
330     } else {
331         $course = $DB->get_record('course', array('id' => $courseid));
332     }
334     $modinfo = get_fast_modinfo($course);
335     $cm = $modinfo->cms[$cmid];
336     $context = context_module::instance($cm->id);
338     if (!has_capability('mod/glossary:view', $context)) {
339         return;
340     }
342     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
343     $accessallgroups = has_capability('moodle/site:accessallgroups', $context);
344     $groupmode = groups_get_activity_groupmode($cm, $course);
346     $params['timestart'] = $timestart;
348     if ($userid) {
349         $userselect = "AND u.id = :userid";
350         $params['userid'] = $userid;
351     } else {
352         $userselect = '';
353     }
355     if ($groupid) {
356         $groupselect = 'AND gm.groupid = :groupid';
357         $groupjoin   = 'JOIN {groups_members} gm ON  gm.userid=u.id';
358         $params['groupid'] = $groupid;
359     } else {
360         $groupselect = '';
361         $groupjoin   = '';
362     }
364     $params['timestart'] = $timestart;
365     $params['glossaryid'] = $cm->instance;
367     $ufields = user_picture::fields('u');
368     $entries = $DB->get_records_sql("
369               SELECT ge.id AS entryid, ge.*, $ufields
370                 FROM {glossary_entries} ge
371                 JOIN {user} u ON u.id = ge.userid
372                      $groupjoin
373                WHERE ge.timemodified > :timestart
374                  AND ge.glossaryid = :glossaryid
375                      $userselect
376                      $groupselect
377             ORDER BY ge.timemodified ASC", $params);
379     if (!$entries) {
380         return;
381     }
383     foreach ($entries as $entry) {
384         $usersgroups = null;
385         if ($entry->userid != $USER->id) {
386             if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
387                 if (is_null($usersgroups)) {
388                     $usersgroups = groups_get_all_groups($course->id, $entry->userid, $cm->groupingid);
389                     if (is_array($usersgroups)) {
390                         $usersgroups = array_keys($usersgroups);
391                     } else {
392                         $usersgroups = array();
393                     }
394                 }
395                 if (!array_intersect($usersgroups, $modinfo->get_groups($cm->id))) {
396                     continue;
397                 }
398             }
399         }
401         $tmpactivity                       = new stdClass();
402         $tmpactivity->user = username_load_fields_from_object(new stdClass(), $entry, null,
403                 explode(',', user_picture::fields()));
404         $tmpactivity->user->fullname       = fullname($tmpactivity->user, $viewfullnames);
405         $tmpactivity->type                 = 'glossary';
406         $tmpactivity->cmid                 = $cm->id;
407         $tmpactivity->glossaryid           = $entry->glossaryid;
408         $tmpactivity->name                 = format_string($cm->name, true);
409         $tmpactivity->sectionnum           = $cm->sectionnum;
410         $tmpactivity->timestamp            = $entry->timemodified;
411         $tmpactivity->content              = new stdClass();
412         $tmpactivity->content->entryid     = $entry->entryid;
413         $tmpactivity->content->concept     = $entry->concept;
414         $tmpactivity->content->definition  = $entry->definition;
416         $activities[$index++] = $tmpactivity;
417     }
419     return true;
422 /**
423  * Outputs the glossary entry indicated by $activity
424  *
425  * @param object $activity      the activity object the glossary resides in
426  * @param int    $courseid      the id of the course the glossary resides in
427  * @param bool   $detail        not used, but required for compatibilty with other modules
428  * @param int    $modnames      not used, but required for compatibilty with other modules
429  * @param bool   $viewfullnames not used, but required for compatibilty with other modules
430  * @return void
431  */
432 function glossary_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) {
433     global $OUTPUT;
435     echo html_writer::start_tag('div', array('class'=>'glossary-activity clearfix'));
436     if (!empty($activity->user)) {
437         echo html_writer::tag('div', $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid)),
438             array('class' => 'glossary-activity-picture'));
439     }
441     echo html_writer::start_tag('div', array('class'=>'glossary-activity-content'));
442     echo html_writer::start_tag('div', array('class'=>'glossary-activity-entry'));
444     $urlparams = array('g' => $activity->glossaryid, 'mode' => 'entry', 'hook' => $activity->content->entryid);
445     echo html_writer::tag('a', strip_tags($activity->content->concept),
446         array('href' => new moodle_url('/mod/glossary/view.php', $urlparams)));
447     echo html_writer::end_tag('div');
449     $url = new moodle_url('/user/view.php', array('course'=>$courseid, 'id'=>$activity->user->id));
450     $name = $activity->user->fullname;
451     $link = html_writer::link($url, $name);
453     echo html_writer::start_tag('div', array('class'=>'user'));
454     echo $link .' - '. userdate($activity->timestamp);
455     echo html_writer::end_tag('div');
457     echo html_writer::end_tag('div');
459     echo html_writer::end_tag('div');
460     return;
462 /**
463  * Given a course and a time, this module should find recent activity
464  * that has occurred in glossary activities and print it out.
465  * Return true if there was output, or false is there was none.
466  *
467  * @global object
468  * @global object
469  * @global object
470  * @param object $course
471  * @param object $viewfullnames
472  * @param int $timestart
473  * @return bool
474  */
475 function glossary_print_recent_activity($course, $viewfullnames, $timestart) {
476     global $CFG, $USER, $DB, $OUTPUT, $PAGE;
478     //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0
479     if (!defined('GLOSSARY_RECENT_ACTIVITY_LIMIT')) {
480         define('GLOSSARY_RECENT_ACTIVITY_LIMIT', 50);
481     }
482     $modinfo = get_fast_modinfo($course);
483     $ids = array();
485     foreach ($modinfo->cms as $cm) {
486         if ($cm->modname != 'glossary') {
487             continue;
488         }
489         if (!$cm->uservisible) {
490             continue;
491         }
492         $ids[$cm->instance] = $cm->id;
493     }
495     if (!$ids) {
496         return false;
497     }
499     // generate list of approval capabilities for all glossaries in the course.
500     $approvals = array();
501     foreach ($ids as $glinstanceid => $glcmid) {
502         $context = context_module::instance($glcmid);
503         if (has_capability('mod/glossary:view', $context)) {
504             // get records glossary entries that are approved if user has no capability to approve entries.
505             if (has_capability('mod/glossary:approve', $context)) {
506                 $approvals[] = ' ge.glossaryid = :glsid'.$glinstanceid.' ';
507             } else {
508                 $approvals[] = ' (ge.approved = 1 AND ge.glossaryid = :glsid'.$glinstanceid.') ';
509             }
510             $params['glsid'.$glinstanceid] = $glinstanceid;
511         }
512     }
514     if (count($approvals) == 0) {
515         return false;
516     }
517     $selectsql = 'SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
518                                         '.user_picture::fields('u',null,'userid');
519     $countsql = 'SELECT COUNT(*)';
521     $joins = array(' FROM {glossary_entries} ge ');
522     $joins[] = 'JOIN {user} u ON u.id = ge.userid ';
523     $fromsql = implode($joins, "\n");
525     $params['timestart'] = $timestart;
526     $clausesql = ' WHERE ge.timemodified > :timestart ';
528     if (count($approvals) > 0) {
529         $approvalsql = 'AND ('. implode($approvals, ' OR ') .') ';
530     } else {
531         $approvalsql = '';
532     }
533     $ordersql = 'ORDER BY ge.timemodified ASC';
534     $entries = $DB->get_records_sql($selectsql.$fromsql.$clausesql.$approvalsql.$ordersql, $params, 0, (GLOSSARY_RECENT_ACTIVITY_LIMIT+1));
536     if (empty($entries)) {
537         return false;
538     }
540     echo $OUTPUT->heading(get_string('newentries', 'glossary').':', 3);
541     $strftimerecent = get_string('strftimerecent');
542     $entrycount = 0;
543     foreach ($entries as $entry) {
544         if ($entrycount < GLOSSARY_RECENT_ACTIVITY_LIMIT) {
545             if ($entry->approved) {
546                 $dimmed = '';
547                 $urlparams = array('g' => $entry->glossaryid, 'mode' => 'entry', 'hook' => $entry->id);
548             } else {
549                 $dimmed = ' dimmed_text';
550                 $urlparams = array('id' => $ids[$entry->glossaryid], 'mode' => 'approval', 'hook' => format_text($entry->concept, true));
551             }
552             $link = new moodle_url($CFG->wwwroot.'/mod/glossary/view.php' , $urlparams);
553             echo '<div class="head'.$dimmed.'">';
554             echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
555             echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
556             echo '</div>';
557             echo '<div class="info"><a href="'.$link.'">'.format_string($entry->concept, true).'</a></div>';
558             $entrycount += 1;
559         } else {
560             $numnewentries = $DB->count_records_sql($countsql.$joins[0].$clausesql.$approvalsql, $params);
561             echo '<div class="head"><div class="activityhead">'.get_string('andmorenewentries', 'glossary', $numnewentries - GLOSSARY_RECENT_ACTIVITY_LIMIT).'</div></div>';
562             break;
563         }
564     }
566     return true;
569 /**
570  * @global object
571  * @param object $log
572  */
573 function glossary_log_info($log) {
574     global $DB;
576     return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
577                                   FROM {glossary_entries} e, {user} u
578                                  WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
581 /**
582  * Function to be run periodically according to the moodle cron
583  * This function searches for things that need to be done, such
584  * as sending out mail, toggling flags etc ...
585  * @return bool
586  */
587 function glossary_cron () {
588     return true;
591 /**
592  * Return grade for given user or all users.
593  *
594  * @param stdClass $glossary A glossary instance
595  * @param int $userid Optional user id, 0 means all users
596  * @return array An array of grades, false if none
597  */
598 function glossary_get_user_grades($glossary, $userid=0) {
599     global $CFG;
601     require_once($CFG->dirroot.'/rating/lib.php');
603     $ratingoptions = new stdClass;
605     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
606     $ratingoptions->modulename = 'glossary';
607     $ratingoptions->moduleid   = $glossary->id;
608     $ratingoptions->component  = 'mod_glossary';
609     $ratingoptions->ratingarea = 'entry';
611     $ratingoptions->userid = $userid;
612     $ratingoptions->aggregationmethod = $glossary->assessed;
613     $ratingoptions->scaleid = $glossary->scale;
614     $ratingoptions->itemtable = 'glossary_entries';
615     $ratingoptions->itemtableusercolumn = 'userid';
617     $rm = new rating_manager();
618     return $rm->get_user_grades($ratingoptions);
621 /**
622  * Return rating related permissions
623  *
624  * @param int $contextid the context id
625  * @param string $component The component we want to get permissions for
626  * @param string $ratingarea The ratingarea that we want to get permissions for
627  * @return array an associative array of the user's rating permissions
628  */
629 function glossary_rating_permissions($contextid, $component, $ratingarea) {
630     if ($component != 'mod_glossary' || $ratingarea != 'entry') {
631         // We don't know about this component/ratingarea so just return null to get the
632         // default restrictive permissions.
633         return null;
634     }
635     $context = context::instance_by_id($contextid);
636     return array(
637         'view'    => has_capability('mod/glossary:viewrating', $context),
638         'viewany' => has_capability('mod/glossary:viewanyrating', $context),
639         'viewall' => has_capability('mod/glossary:viewallratings', $context),
640         'rate'    => has_capability('mod/glossary:rate', $context)
641     );
644 /**
645  * Validates a submitted rating
646  * @param array $params submitted data
647  *            context => object the context in which the rated items exists [required]
648  *            component => The component for this module - should always be mod_forum [required]
649  *            ratingarea => object the context in which the rated items exists [required]
650  *            itemid => int the ID of the object being rated [required]
651  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
652  *            rating => int the submitted rating
653  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
654  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [optional]
655  * @return boolean true if the rating is valid. Will throw rating_exception if not
656  */
657 function glossary_rating_validate($params) {
658     global $DB, $USER;
660     // Check the component is mod_forum
661     if ($params['component'] != 'mod_glossary') {
662         throw new rating_exception('invalidcomponent');
663     }
665     // Check the ratingarea is post (the only rating area in forum)
666     if ($params['ratingarea'] != 'entry') {
667         throw new rating_exception('invalidratingarea');
668     }
670     // Check the rateduserid is not the current user .. you can't rate your own posts
671     if ($params['rateduserid'] == $USER->id) {
672         throw new rating_exception('nopermissiontorate');
673     }
675     $glossarysql = "SELECT g.id as glossaryid, g.scale, g.course, e.userid as userid, e.approved, e.timecreated, g.assesstimestart, g.assesstimefinish
676                       FROM {glossary_entries} e
677                       JOIN {glossary} g ON e.glossaryid = g.id
678                      WHERE e.id = :itemid";
679     $glossaryparams = array('itemid' => $params['itemid']);
680     $info = $DB->get_record_sql($glossarysql, $glossaryparams);
681     if (!$info) {
682         //item doesn't exist
683         throw new rating_exception('invaliditemid');
684     }
686     if ($info->scale != $params['scaleid']) {
687         //the scale being submitted doesnt match the one in the database
688         throw new rating_exception('invalidscaleid');
689     }
691     //check that the submitted rating is valid for the scale
693     // lower limit
694     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
695         throw new rating_exception('invalidnum');
696     }
698     // upper limit
699     if ($info->scale < 0) {
700         //its a custom scale
701         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
702         if ($scalerecord) {
703             $scalearray = explode(',', $scalerecord->scale);
704             if ($params['rating'] > count($scalearray)) {
705                 throw new rating_exception('invalidnum');
706             }
707         } else {
708             throw new rating_exception('invalidscaleid');
709         }
710     } else if ($params['rating'] > $info->scale) {
711         //if its numeric and submitted rating is above maximum
712         throw new rating_exception('invalidnum');
713     }
715     if (!$info->approved) {
716         //item isnt approved
717         throw new rating_exception('nopermissiontorate');
718     }
720     //check the item we're rating was created in the assessable time window
721     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
722         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
723             throw new rating_exception('notavailable');
724         }
725     }
727     $cm = get_coursemodule_from_instance('glossary', $info->glossaryid, $info->course, false, MUST_EXIST);
728     $context = context_module::instance($cm->id, MUST_EXIST);
730     // if the supplied context doesnt match the item's context
731     if ($context->id != $params['context']->id) {
732         throw new rating_exception('invalidcontext');
733     }
735     return true;
738 /**
739  * Update activity grades
740  *
741  * @category grade
742  * @param stdClass $glossary Null means all glossaries (with extra cmidnumber property)
743  * @param int $userid specific user only, 0 means all
744  * @param bool $nullifnone If true and the user has no grade then a grade item with rawgrade == null will be inserted
745  */
746 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
747     global $CFG, $DB;
748     require_once($CFG->libdir.'/gradelib.php');
750     if (!$glossary->assessed) {
751         glossary_grade_item_update($glossary);
753     } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
754         glossary_grade_item_update($glossary, $grades);
756     } else if ($userid and $nullifnone) {
757         $grade = new stdClass();
758         $grade->userid   = $userid;
759         $grade->rawgrade = NULL;
760         glossary_grade_item_update($glossary, $grade);
762     } else {
763         glossary_grade_item_update($glossary);
764     }
767 /**
768  * Update all grades in gradebook.
769  *
770  * @global object
771  */
772 function glossary_upgrade_grades() {
773     global $DB;
775     $sql = "SELECT COUNT('x')
776               FROM {glossary} g, {course_modules} cm, {modules} m
777              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
778     $count = $DB->count_records_sql($sql);
780     $sql = "SELECT g.*, cm.idnumber AS cmidnumber, g.course AS courseid
781               FROM {glossary} g, {course_modules} cm, {modules} m
782              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
783     $rs = $DB->get_recordset_sql($sql);
784     if ($rs->valid()) {
785         $pbar = new progress_bar('glossaryupgradegrades', 500, true);
786         $i=0;
787         foreach ($rs as $glossary) {
788             $i++;
789             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
790             glossary_update_grades($glossary, 0, false);
791             $pbar->update($i, $count, "Updating Glossary grades ($i/$count).");
792         }
793     }
794     $rs->close();
797 /**
798  * Create/update grade item for given glossary
799  *
800  * @category grade
801  * @param stdClass $glossary object with extra cmidnumber
802  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
803  * @return int, 0 if ok, error code otherwise
804  */
805 function glossary_grade_item_update($glossary, $grades=NULL) {
806     global $CFG;
807     require_once($CFG->libdir.'/gradelib.php');
809     $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
811     if (!$glossary->assessed or $glossary->scale == 0) {
812         $params['gradetype'] = GRADE_TYPE_NONE;
814     } else if ($glossary->scale > 0) {
815         $params['gradetype'] = GRADE_TYPE_VALUE;
816         $params['grademax']  = $glossary->scale;
817         $params['grademin']  = 0;
819     } else if ($glossary->scale < 0) {
820         $params['gradetype'] = GRADE_TYPE_SCALE;
821         $params['scaleid']   = -$glossary->scale;
822     }
824     if ($grades  === 'reset') {
825         $params['reset'] = true;
826         $grades = NULL;
827     }
829     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
832 /**
833  * Delete grade item for given glossary
834  *
835  * @category grade
836  * @param object $glossary object
837  */
838 function glossary_grade_item_delete($glossary) {
839     global $CFG;
840     require_once($CFG->libdir.'/gradelib.php');
842     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
845 /**
846  * @global object
847  * @param int $gloassryid
848  * @param int $scaleid
849  * @return bool
850  */
851 function glossary_scale_used ($glossaryid,$scaleid) {
852 //This function returns if a scale is being used by one glossary
853     global $DB;
855     $return = false;
857     $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
859     if (!empty($rec)  && !empty($scaleid)) {
860         $return = true;
861     }
863     return $return;
866 /**
867  * Checks if scale is being used by any instance of glossary
868  *
869  * This is used to find out if scale used anywhere
870  *
871  * @global object
872  * @param int $scaleid
873  * @return boolean True if the scale is used by any glossary
874  */
875 function glossary_scale_used_anywhere($scaleid) {
876     global $DB;
878     if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
879         return true;
880     } else {
881         return false;
882     }
885 //////////////////////////////////////////////////////////////////////////////////////
886 /// Any other glossary functions go here.  Each of them must have a name that
887 /// starts with glossary_
889 /**
890  * This function return an array of valid glossary_formats records
891  * Everytime it's called, every existing format is checked, new formats
892  * are included if detected and old formats are deleted and any glossary
893  * using an invalid format is updated to the default (dictionary).
894  *
895  * @global object
896  * @global object
897  * @return array
898  */
899 function glossary_get_available_formats() {
900     global $CFG, $DB;
902     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
903     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
904     $pluginformats = array();
905     foreach ($formats as $format) {
906         //If the format file exists
907         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
908             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
909             //If the function exists
910             if (function_exists('glossary_show_entry_'.$format)) {
911                 //Acummulate it as a valid format
912                 $pluginformats[] = $format;
913                 //If the format doesn't exist in the table
914                 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
915                     //Insert the record in glossary_formats
916                     $gf = new stdClass();
917                     $gf->name = $format;
918                     $gf->popupformatname = $format;
919                     $gf->visible = 1;
920                     $DB->insert_record("glossary_formats",$gf);
921                 }
922             }
923         }
924     }
926     //Delete non_existent formats from glossary_formats table
927     $formats = $DB->get_records("glossary_formats");
928     foreach ($formats as $format) {
929         $todelete = false;
930         //If the format in DB isn't a valid previously detected format then delete the record
931         if (!in_array($format->name,$pluginformats)) {
932             $todelete = true;
933         }
935         if ($todelete) {
936             //Delete the format
937             $DB->delete_records('glossary_formats', array('name'=>$format->name));
938             //Reasign existing glossaries to default (dictionary) format
939             if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
940                 foreach($glossaries as $glossary) {
941                     $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
942                 }
943             }
944         }
945     }
947     //Now everything is ready in glossary_formats table
948     $formats = $DB->get_records("glossary_formats");
950     return $formats;
953 /**
954  * @param bool $debug
955  * @param string $text
956  * @param int $br
957  */
958 function glossary_debug($debug,$text,$br=1) {
959     if ( $debug ) {
960         echo '<font color="red">' . $text . '</font>';
961         if ( $br ) {
962             echo '<br />';
963         }
964     }
967 /**
968  *
969  * @global object
970  * @param int $glossaryid
971  * @param string $entrylist
972  * @param string $pivot
973  * @return array
974  */
975 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
976     global $DB;
977     if ($pivot) {
978        $pivot .= ",";
979     }
981     return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
982                                    FROM {glossary_entries}
983                                   WHERE glossaryid = ?
984                                         AND id IN ($entrylist)", array($glossaryid));
987 /**
988  * @global object
989  * @global object
990  * @param object $concept
991  * @param string $courseid
992  * @return array
993  */
994 function glossary_get_entries_search($concept, $courseid) {
995     global $CFG, $DB;
997     //Check if the user is an admin
998     $bypassadmin = 1; //This means NO (by default)
999     if (has_capability('moodle/course:viewhiddenactivities', context_system::instance())) {
1000         $bypassadmin = 0; //This means YES
1001     }
1003     //Check if the user is a teacher
1004     $bypassteacher = 1; //This means NO (by default)
1005     if (has_capability('mod/glossary:manageentries', context_course::instance($courseid))) {
1006         $bypassteacher = 0; //This means YES
1007     }
1009     $conceptlower = core_text::strtolower(trim($concept));
1011     $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
1013     return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
1014                                    FROM {glossary_entries} e, {glossary} g,
1015                                         {course_modules} cm, {modules} m
1016                                   WHERE m.name = 'glossary' AND
1017                                         cm.module = m.id AND
1018                                         (cm.visible = 1 OR  cm.visible = $bypassadmin OR
1019                                             (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
1020                                         g.id = cm.instance AND
1021                                         e.glossaryid = g.id  AND
1022                                         ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
1023                                           (e.casesensitive = 0 and concept = :concept)) AND
1024                                         (g.course = :courseid2 OR g.globalglossary = 1) AND
1025                                          e.usedynalink != 0 AND
1026                                          g.usedynalink != 0", $params);
1029 /**
1030  * @global object
1031  * @global object
1032  * @param object $course
1033  * @param object $course
1034  * @param object $glossary
1035  * @param object $entry
1036  * @param string $mode
1037  * @param string $hook
1038  * @param int $printicons
1039  * @param int $displayformat
1040  * @param bool $printview
1041  * @return mixed
1042  */
1043 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $printview = false) {
1044     global $USER, $CFG;
1045     $return = false;
1046     if ( $displayformat < 0 ) {
1047         $displayformat = $glossary->displayformat;
1048     }
1049     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
1050         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1051         if ($printview) {
1052             $functionname = 'glossary_print_entry_'.$displayformat;
1053         } else {
1054             $functionname = 'glossary_show_entry_'.$displayformat;
1055         }
1057         if (file_exists($formatfile)) {
1058             include_once($formatfile);
1059             if (function_exists($functionname)) {
1060                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
1061             } else if ($printview) {
1062                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
1063                 $return = glossary_print_entry_default($entry, $glossary, $cm);
1064             }
1065         }
1066     }
1067     return $return;
1070 /**
1071  * Default (old) print format used if custom function doesn't exist in format
1072  *
1073  * @param object $entry
1074  * @param object $glossary
1075  * @param object $cm
1076  * @return void Output is echo'd
1077  */
1078 function glossary_print_entry_default ($entry, $glossary, $cm) {
1079     global $CFG;
1081     require_once($CFG->libdir . '/filelib.php');
1083     echo $OUTPUT->heading(strip_tags($entry->concept), 4);
1085     $definition = $entry->definition;
1087     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
1089     $context = context_module::instance($cm->id);
1090     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
1092     $options = new stdClass();
1093     $options->para = false;
1094     $options->trusted = $entry->definitiontrust;
1095     $options->context = $context;
1096     $options->overflowdiv = true;
1097     $definition = format_text($definition, $entry->definitionformat, $options);
1098     echo ($definition);
1099     echo '<br /><br />';
1102 /**
1103  * Print glossary concept/term as a heading &lt;h4>
1104  * @param object $entry
1105  */
1106 function  glossary_print_entry_concept($entry, $return=false) {
1107     global $OUTPUT;
1109     $text = $OUTPUT->heading(format_string($entry->concept), 4);
1110     if (!empty($entry->highlight)) {
1111         $text = highlight($entry->highlight, $text);
1112     }
1114     if ($return) {
1115         return $text;
1116     } else {
1117         echo $text;
1118     }
1121 /**
1122  *
1123  * @global moodle_database DB
1124  * @param object $entry
1125  * @param object $glossary
1126  * @param object $cm
1127  */
1128 function glossary_print_entry_definition($entry, $glossary, $cm) {
1129     global $DB, $GLOSSARY_EXCLUDECONCEPTS;
1131     $definition = $entry->definition;
1133     //Calculate all the strings to be no-linked
1134     //First, the concept
1135     $GLOSSARY_EXCLUDECONCEPTS = array($entry->concept);
1136     //Now the aliases
1137     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
1138         foreach ($aliases as $alias) {
1139             $GLOSSARY_EXCLUDECONCEPTS[]=trim($alias->alias);
1140         }
1141     }
1143     $context = context_module::instance($cm->id);
1144     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
1146     $options = new stdClass();
1147     $options->para = false;
1148     $options->trusted = $entry->definitiontrust;
1149     $options->context = $context;
1150     $options->overflowdiv = true;
1152     $text = format_text($definition, $entry->definitionformat, $options);
1154     // Stop excluding concepts from autolinking
1155     unset($GLOSSARY_EXCLUDECONCEPTS);
1157     if (!empty($entry->highlight)) {
1158         $text = highlight($entry->highlight, $text);
1159     }
1160     if (isset($entry->footer)) {   // Unparsed footer info
1161         $text .= $entry->footer;
1162     }
1163     echo $text;
1166 /**
1167  *
1168  * @global object
1169  * @param object $course
1170  * @param object $cm
1171  * @param object $glossary
1172  * @param object $entry
1173  * @param string $mode
1174  * @param string $hook
1175  * @param string $type
1176  * @return string|void
1177  */
1178 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
1179     global $DB;
1181     $return = '';
1182     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
1183         foreach ($aliases as $alias) {
1184             if (trim($alias->alias)) {
1185                 if ($return == '') {
1186                     $return = '<select id="keyword" style="font-size:8pt">';
1187                 }
1188                 $return .= "<option>$alias->alias</option>";
1189             }
1190         }
1191         if ($return != '') {
1192             $return .= '</select>';
1193         }
1194     }
1195     if ($type == 'print') {
1196         echo $return;
1197     } else {
1198         return $return;
1199     }
1202 /**
1203  *
1204  * @global object
1205  * @global object
1206  * @global object
1207  * @param object $course
1208  * @param object $cm
1209  * @param object $glossary
1210  * @param object $entry
1211  * @param string $mode
1212  * @param string $hook
1213  * @param string $type
1214  * @return string|void
1215  */
1216 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
1217     global $USER, $CFG, $DB, $OUTPUT;
1219     $context = context_module::instance($cm->id);
1221     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
1222     $importedentry = ($entry->sourceglossaryid == $glossary->id);
1223     $ismainglossary = $glossary->mainglossary;
1226     $return = '<span class="commands">';
1227     // Differentiate links for each entry.
1228     $altsuffix = ': '.strip_tags(format_text($entry->concept));
1230     if (!$entry->approved) {
1231         $output = true;
1232         $return .= html_writer::tag('span', get_string('entryishidden','glossary'),
1233             array('class' => 'glossary-hidden-note'));
1234     }
1236     if (has_capability('mod/glossary:approve', $context) && !$glossary->defaultapproval && $entry->approved) {
1237         $output = true;
1238         $return .= '<a class="action-icon" title="' . get_string('disapprove', 'glossary').
1239                    '" href="approve.php?newstate=0&amp;eid='.$entry->id.'&amp;mode='.$mode.
1240                    '&amp;hook='.urlencode($hook).'&amp;sesskey='.sesskey().
1241                    '"><img src="'.$OUTPUT->pix_url('t/block').'" class="smallicon" alt="'.
1242                    get_string('disapprove','glossary').$altsuffix.'" /></a>';
1243     }
1245     $iscurrentuser = ($entry->userid == $USER->id);
1247     if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $iscurrentuser)) {
1248         // only teachers can export entries so check it out
1249         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
1250             $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
1251             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
1252                 $output = true;
1253                 $return .= '<a class="action-icon" title="'.get_string('exporttomainglossary','glossary') . '" href="exportentry.php?id='.$entry->id.'&amp;prevmode='.$mode.'&amp;hook='.urlencode($hook).'"><img src="'.$OUTPUT->pix_url('export', 'glossary').'" class="smallicon" alt="'.get_string('exporttomainglossary','glossary').$altsuffix.'" /></a>';
1254             }
1255         }
1257         if ( $entry->sourceglossaryid ) {
1258             $icon = $OUTPUT->pix_url('minus', 'glossary');   // graphical metaphor (minus) for deleting an imported entry
1259         } else {
1260             $icon = $OUTPUT->pix_url('t/delete');
1261         }
1263         //Decide if an entry is editable:
1264         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
1265         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1266         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
1267         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1268             $output = true;
1269             $return .= "<a class='action-icon' title=\"" . get_string("delete") . "\" href=\"deleteentry.php?id=$cm->id&amp;mode=delete&amp;entry=$entry->id&amp;prevmode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"";
1270             $return .= $icon;
1271             $return .= "\" class=\"smallicon\" alt=\"" . get_string("delete") .$altsuffix."\" /></a>";
1273             $return .= "<a class='action-icon' title=\"" . get_string("edit") . "\" href=\"edit.php?cmid=$cm->id&amp;id=$entry->id&amp;mode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"" . $OUTPUT->pix_url('t/edit') . "\" class=\"smallicon\" alt=\"" . get_string("edit") .$altsuffix. "\" /></a>";
1274         } elseif ( $importedentry ) {
1275             $return .= "<font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1276         }
1277     }
1278     if (!empty($CFG->enableportfolios) && (has_capability('mod/glossary:exportentry', $context) || ($iscurrentuser && has_capability('mod/glossary:exportownentry', $context)))) {
1279         require_once($CFG->libdir . '/portfoliolib.php');
1280         $button = new portfolio_add_button();
1281         $button->set_callback_options('glossary_entry_portfolio_caller',  array('id' => $cm->id, 'entryid' => $entry->id), 'mod_glossary');
1283         $filecontext = $context;
1284         if ($entry->sourceglossaryid == $cm->instance) {
1285             if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1286                 $filecontext = context_module::instance($maincm->id);
1287             }
1288         }
1289         $fs = get_file_storage();
1290         if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)
1291          || $files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'entry', $entry->id, "timemodified", false)) {
1293             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1294         } else {
1295             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1296         }
1298         $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1299     }
1300     $return .= '</span>';
1302     if (!empty($CFG->usecomments) && has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1303         require_once($CFG->dirroot . '/comment/lib.php');
1304         $cmt = new stdClass();
1305         $cmt->component = 'mod_glossary';
1306         $cmt->context  = $context;
1307         $cmt->course   = $course;
1308         $cmt->cm       = $cm;
1309         $cmt->area     = 'glossary_entry';
1310         $cmt->itemid   = $entry->id;
1311         $cmt->showcount = true;
1312         $comment = new comment($cmt);
1313         $return .= '<div>'.$comment->output(true).'</div>';
1314         $output = true;
1315     }
1317     //If we haven't calculated any REAL thing, delete result ($return)
1318     if (!$output) {
1319         $return = '';
1320     }
1321     //Print or get
1322     if ($type == 'print') {
1323         echo $return;
1324     } else {
1325         return $return;
1326     }
1329 /**
1330  * @param object $course
1331  * @param object $cm
1332  * @param object $glossary
1333  * @param object $entry
1334  * @param string $mode
1335  * @param object $hook
1336  * @param bool $printicons
1337  * @param bool $aliases
1338  * @return void
1339  */
1340 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1341     if ($aliases) {
1342         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1343     }
1344     $icons   = '';
1345     if ($printicons) {
1346         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1347     }
1348     if ($aliases || $icons || !empty($entry->rating)) {
1349         echo '<table>';
1350         if ( $aliases ) {
1351             echo '<tr valign="top"><td class="aliases">' .
1352                  '<label for="keyword">' . get_string('aliases','glossary').': </label>' .
1353                  $aliases . '</td></tr>';
1354         }
1355         if ($icons) {
1356             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1357         }
1358         if (!empty($entry->rating)) {
1359             echo '<tr valign="top"><td class="ratings">';
1360             glossary_print_entry_ratings($course, $entry);
1361             echo '</td></tr>';
1362         }
1363         echo '</table>';
1364     }
1367 /**
1368  * @todo Document this function
1369  */
1370 function glossary_print_entry_attachment($entry, $cm, $format=NULL, $align="right", $insidetable=true) {
1371 ///   valid format values: html  : Return the HTML link for the attachment as an icon
1372 ///                        text  : Return the HTML link for tha attachment as text
1373 ///                        blank : Print the output to the screen
1374     if ($entry->attachment) {
1375           if ($insidetable) {
1376               echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
1377           }
1378           echo glossary_print_attachments($entry, $cm, $format, $align);
1379           if ($insidetable) {
1380               echo "</td></tr></table>\n";
1381           }
1382     }
1385 /**
1386  * @global object
1387  * @param object $cm
1388  * @param object $entry
1389  * @param string $mode
1390  * @param string $align
1391  * @param bool $insidetable
1392  */
1393 function  glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1394     global $CFG, $OUTPUT;
1396     if ($mode == 'approval' and !$entry->approved) {
1397         if ($insidetable) {
1398             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1399         }
1400         echo $OUTPUT->action_icon(
1401             new moodle_url('approve.php', array('eid' => $entry->id, 'mode' => $mode, 'sesskey' => sesskey())),
1402             new pix_icon('t/approve', get_string('approve','glossary'), '',
1403                 array('class' => 'iconsmall', 'align' => $align))
1404         );
1405         if ($insidetable) {
1406             echo '</td></tr></table>';
1407         }
1408     }
1411 /**
1412  * It returns all entries from all glossaries that matches the specified criteria
1413  *  within a given $course. It performs an $extended search if necessary.
1414  * It restrict the search to only one $glossary if the $glossary parameter is set.
1415  *
1416  * @global object
1417  * @global object
1418  * @param object $course
1419  * @param array $searchterms
1420  * @param int $extended
1421  * @param object $glossary
1422  * @return array
1423  */
1424 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1425     global $CFG, $DB;
1427     if ( !$glossary ) {
1428         if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1429             $glos = "";
1430             foreach ( $glossaries as $glossary ) {
1431                 $glos .= "$glossary->id,";
1432             }
1433             $glos = substr($glos,0,-1);
1434         }
1435     } else {
1436         $glos = $glossary->id;
1437     }
1439     if (!has_capability('mod/glossary:manageentries', context_course::instance($glossary->course))) {
1440         $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1441         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1442         $onlyvisibletable = ", {course_modules} cm";
1443     } else {
1445         $onlyvisible = "";
1446         $onlyvisibletable = "";
1447     }
1449     if ($DB->sql_regex_supported()) {
1450         $REGEXP    = $DB->sql_regex(true);
1451         $NOTREGEXP = $DB->sql_regex(false);
1452     }
1454     $searchcond = array();
1455     $params     = array();
1456     $i = 0;
1458     $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1461     foreach ($searchterms as $searchterm) {
1462         $i++;
1464         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1465                    /// will use it to simulate the "-" operator with LIKE clause
1467     /// Under Oracle and MSSQL, trim the + and - operators and perform
1468     /// simpler LIKE (or NOT LIKE) queries
1469         if (!$DB->sql_regex_supported()) {
1470             if (substr($searchterm, 0, 1) == '-') {
1471                 $NOT = true;
1472             }
1473             $searchterm = trim($searchterm, '+-');
1474         }
1476         // TODO: +- may not work for non latin languages
1478         if (substr($searchterm,0,1) == '+') {
1479             $searchterm = trim($searchterm, '+-');
1480             $searchterm = preg_quote($searchterm, '|');
1481             $searchcond[] = "$concat $REGEXP :ss$i";
1482             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1484         } else if (substr($searchterm,0,1) == "-") {
1485             $searchterm = trim($searchterm, '+-');
1486             $searchterm = preg_quote($searchterm, '|');
1487             $searchcond[] = "$concat $NOTREGEXP :ss$i";
1488             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1490         } else {
1491             $searchcond[] = $DB->sql_like($concat, ":ss$i", false, true, $NOT);
1492             $params['ss'.$i] = "%$searchterm%";
1493         }
1494     }
1496     if (empty($searchcond)) {
1497         $totalcount = 0;
1498         return array();
1499     }
1501     $searchcond = implode(" AND ", $searchcond);
1503     $sql = "SELECT e.*
1504               FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1505              WHERE $searchcond
1506                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1507                AND g.id IN ($glos) AND e.approved <> 0";
1509     return $DB->get_records_sql($sql, $params);
1512 /**
1513  * @global object
1514  * @param array $searchterms
1515  * @param object $glossary
1516  * @param bool $extended
1517  * @return array
1518  */
1519 function glossary_search_entries($searchterms, $glossary, $extended) {
1520     global $DB;
1522     $course = $DB->get_record("course", array("id"=>$glossary->course));
1523     return glossary_search($course,$searchterms,$extended,$glossary);
1526 /**
1527  * if return=html, then return a html string.
1528  * if return=text, then return a text-only string.
1529  * otherwise, print HTML for non-images, and return image HTML
1530  *     if attachment is an image, $align set its aligment.
1531  *
1532  * @global object
1533  * @global object
1534  * @param object $entry
1535  * @param object $cm
1536  * @param string $type html, txt, empty
1537  * @param string $align left or right
1538  * @return string image string or nothing depending on $type param
1539  */
1540 function glossary_print_attachments($entry, $cm, $type=NULL, $align="left") {
1541     global $CFG, $DB, $OUTPUT;
1543     if (!$context = context_module::instance($cm->id, IGNORE_MISSING)) {
1544         return '';
1545     }
1547     if ($entry->sourceglossaryid == $cm->instance) {
1548         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1549             return '';
1550         }
1551         $filecontext = context_module::instance($maincm->id);
1553     } else {
1554         $filecontext = $context;
1555     }
1557     $strattachment = get_string('attachment', 'glossary');
1559     $fs = get_file_storage();
1561     $imagereturn = '';
1562     $output = '';
1564     if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1565         foreach ($files as $file) {
1566             $filename = $file->get_filename();
1567             $mimetype = $file->get_mimetype();
1568             $iconimage = $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file), 'moodle', array('class' => 'icon'));
1569             $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename);
1571             if ($type == 'html') {
1572                 $output .= "<a href=\"$path\">$iconimage</a> ";
1573                 $output .= "<a href=\"$path\">".s($filename)."</a>";
1574                 $output .= "<br />";
1576             } else if ($type == 'text') {
1577                 $output .= "$strattachment ".s($filename).":\n$path\n";
1579             } else {
1580                 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1581                     // Image attachments don't get printed as links
1582                     $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1583                 } else {
1584                     $output .= "<a href=\"$path\">$iconimage</a> ";
1585                     $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context));
1586                     $output .= '<br />';
1587                 }
1588             }
1589         }
1590     }
1592     if ($type) {
1593         return $output;
1594     } else {
1595         echo $output;
1596         return $imagereturn;
1597     }
1600 ////////////////////////////////////////////////////////////////////////////////
1601 // File API                                                                   //
1602 ////////////////////////////////////////////////////////////////////////////////
1604 /**
1605  * Lists all browsable file areas
1606  *
1607  * @package  mod_glossary
1608  * @category files
1609  * @param stdClass $course course object
1610  * @param stdClass $cm course module object
1611  * @param stdClass $context context object
1612  * @return array
1613  */
1614 function glossary_get_file_areas($course, $cm, $context) {
1615     return array(
1616         'attachment' => get_string('areaattachment', 'mod_glossary'),
1617         'entry' => get_string('areaentry', 'mod_glossary'),
1618     );
1621 /**
1622  * File browsing support for glossary module.
1623  *
1624  * @param file_browser $browser
1625  * @param array $areas
1626  * @param stdClass $course
1627  * @param cm_info $cm
1628  * @param context $context
1629  * @param string $filearea
1630  * @param int $itemid
1631  * @param string $filepath
1632  * @param string $filename
1633  * @return file_info_stored file_info_stored instance or null if not found
1634  */
1635 function glossary_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
1636     global $CFG, $DB, $USER;
1638     if ($context->contextlevel != CONTEXT_MODULE) {
1639         return null;
1640     }
1642     if (!isset($areas[$filearea])) {
1643         return null;
1644     }
1646     if (is_null($itemid)) {
1647         require_once($CFG->dirroot.'/mod/glossary/locallib.php');
1648         return new glossary_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
1649     }
1651     if (!$entry = $DB->get_record('glossary_entries', array('id' => $itemid))) {
1652         return null;
1653     }
1655     if (!$glossary = $DB->get_record('glossary', array('id' => $cm->instance))) {
1656         return null;
1657     }
1659     if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1660         return null;
1661     }
1663     // this trickery here is because we need to support source glossary access
1664     if ($entry->glossaryid == $cm->instance) {
1665         $filecontext = $context;
1666     } else if ($entry->sourceglossaryid == $cm->instance) {
1667         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1668             return null;
1669         }
1670         $filecontext = context_module::instance($maincm->id);
1671     } else {
1672         return null;
1673     }
1675     $fs = get_file_storage();
1676     $filepath = is_null($filepath) ? '/' : $filepath;
1677     $filename = is_null($filename) ? '.' : $filename;
1678     if (!($storedfile = $fs->get_file($filecontext->id, 'mod_glossary', $filearea, $itemid, $filepath, $filename))) {
1679         return null;
1680     }
1682     // Checks to see if the user can manage files or is the owner.
1683     // TODO MDL-33805 - Do not use userid here and move the capability check above.
1684     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
1685         return null;
1686     }
1688     $urlbase = $CFG->wwwroot.'/pluginfile.php';
1690     return new file_info_stored($browser, $filecontext, $storedfile, $urlbase, s($entry->concept), true, true, false, false);
1693 /**
1694  * Serves the glossary attachments. Implements needed access control ;-)
1695  *
1696  * @package  mod_glossary
1697  * @category files
1698  * @param stdClass $course course object
1699  * @param stdClass $cm course module object
1700  * @param stdClsss $context context object
1701  * @param string $filearea file area
1702  * @param array $args extra arguments
1703  * @param bool $forcedownload whether or not force download
1704  * @param array $options additional options affecting the file serving
1705  * @return bool false if file not found, does not return if found - justsend the file
1706  */
1707 function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
1708     global $CFG, $DB;
1710     if ($context->contextlevel != CONTEXT_MODULE) {
1711         return false;
1712     }
1714     require_course_login($course, true, $cm);
1716     if ($filearea === 'attachment' or $filearea === 'entry') {
1717         $entryid = (int)array_shift($args);
1719         require_course_login($course, true, $cm);
1721         if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1722             return false;
1723         }
1725         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1726             return false;
1727         }
1729         if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1730             return false;
1731         }
1733         // this trickery here is because we need to support source glossary access
1735         if ($entry->glossaryid == $cm->instance) {
1736             $filecontext = $context;
1738         } else if ($entry->sourceglossaryid == $cm->instance) {
1739             if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1740                 return false;
1741             }
1742             $filecontext = context_module::instance($maincm->id);
1744         } else {
1745             return false;
1746         }
1748         $relativepath = implode('/', $args);
1749         $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath";
1751         $fs = get_file_storage();
1752         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1753             return false;
1754         }
1756         // finally send the file
1757         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
1759     } else if ($filearea === 'export') {
1760         require_login($course, false, $cm);
1761         require_capability('mod/glossary:export', $context);
1763         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1764             return false;
1765         }
1767         $cat = array_shift($args);
1768         $cat = clean_param($cat, PARAM_ALPHANUM);
1770         $filename = clean_filename(strip_tags(format_string($glossary->name)).'.xml');
1771         $content = glossary_generate_export_file($glossary, NULL, $cat);
1773         send_file($content, $filename, 0, 0, true, true);
1774     }
1776     return false;
1779 /**
1780  *
1781  */
1782 function glossary_print_tabbed_table_end() {
1783      echo "</div></div>";
1786 /**
1787  * @param object $cm
1788  * @param object $glossary
1789  * @param string $mode
1790  * @param string $hook
1791  * @param string $sortkey
1792  * @param string $sortorder
1793  */
1794 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1795     if ($glossary->showalphabet) {
1796         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1797     }
1798     glossary_print_special_links($cm, $glossary, $mode, $hook);
1800     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1802     glossary_print_all_links($cm, $glossary, $mode, $hook);
1804     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1806 /**
1807  * @param object $cm
1808  * @param object $glossary
1809  * @param string $hook
1810  * @param string $sortkey
1811  * @param string $sortorder
1812  */
1813 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1814     echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1817 /**
1818  * @param object $cm
1819  * @param object $glossary
1820  * @param string $hook
1821  * @param string $sortkey
1822  * @param string $sortorder
1823  */
1824 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1825     echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1827 /**
1828  * @param object $cm
1829  * @param object $glossary
1830  * @param string $hook
1831  * @param string $sortkey
1832  * @param string $sortorder
1833  */
1834 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1835     if ( $mode != 'date' ) {
1836         if ($glossary->showalphabet) {
1837             echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1838         }
1840         glossary_print_special_links($cm, $glossary, $mode, $hook);
1842         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1844         glossary_print_all_links($cm, $glossary, $mode, $hook);
1845     } else {
1846         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1847     }
1850 /**
1851  * @param object $cm
1852  * @param object $glossary
1853  * @param string $hook
1854  * @param string $sortkey
1855  * @param string $sortorder
1856  */
1857 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1858     if ($glossary->showalphabet) {
1859         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1860     }
1862     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1863     glossary_print_all_links($cm, $glossary, $mode, $hook);
1864     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1867 /**
1868  * @global object
1869  * @global object
1870  * @param object $cm
1871  * @param object $glossary
1872  * @param string $hook
1873  * @param object $category
1874  */
1875 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1876      global $CFG, $DB, $OUTPUT;
1878      $context = context_module::instance($cm->id);
1880     // Prepare format_string/text options
1881     $fmtoptions = array(
1882         'context' => $context);
1884      echo '<table border="0" width="100%">';
1885      echo '<tr>';
1887      echo '<td align="center" style="width:20%">';
1888      if (has_capability('mod/glossary:managecategories', $context)) {
1889              $options['id'] = $cm->id;
1890              $options['mode'] = 'cat';
1891              $options['hook'] = $hook;
1892              echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1893      }
1894      echo '</td>';
1896      echo '<td align="center" style="width:60%">';
1897      echo '<b>';
1899      $menu = array();
1900      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1901      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1903      $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1904      $selected = '';
1905      if ( $categories ) {
1906           foreach ($categories as $currentcategory) {
1907                  $url = $currentcategory->id;
1908                  if ( $category ) {
1909                      if ($currentcategory->id == $category->id) {
1910                          $selected = $url;
1911                      }
1912                  }
1913                  $menu[$url] = format_string($currentcategory->name, true, $fmtoptions);
1914           }
1915      }
1916      if ( !$selected ) {
1917          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1918      }
1920      if ( $category ) {
1921         echo format_string($category->name, true, $fmtoptions);
1922      } else {
1923         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1925             echo get_string("entrieswithoutcategory","glossary");
1926             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1928         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1930             echo get_string("allcategories","glossary");
1931             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1933         }
1934      }
1935      echo '</b></td>';
1936      echo '<td align="center" style="width:20%">';
1938      $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1939      $select->set_label(get_string('categories', 'glossary'), array('class' => 'accesshide'));
1940      echo $OUTPUT->render($select);
1942      echo '</td>';
1943      echo '</tr>';
1945      echo '</table>';
1948 /**
1949  * @global object
1950  * @param object $cm
1951  * @param object $glossary
1952  * @param string $mode
1953  * @param string $hook
1954  */
1955 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1956 global $CFG;
1957      if ( $glossary->showall) {
1958          $strallentries       = get_string("allentries", "glossary");
1959          if ( $hook == 'ALL' ) {
1960               echo "<b>$strallentries</b>";
1961          } else {
1962               $strexplainall = strip_tags(get_string("explainall","glossary"));
1963               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1964          }
1965      }
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_special_links($cm, $glossary, $mode, $hook) {
1976 global $CFG;
1977      if ( $glossary->showspecial) {
1978          $strspecial          = get_string("special", "glossary");
1979          if ( $hook == 'SPECIAL' ) {
1980               echo "<b>$strspecial</b> | ";
1981          } else {
1982               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1983               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
1984          }
1985      }
1988 /**
1989  * @global object
1990  * @param object $glossary
1991  * @param string $mode
1992  * @param string $hook
1993  * @param string $sortkey
1994  * @param string $sortorder
1995  */
1996 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1997 global $CFG;
1998      if ( $glossary->showalphabet) {
1999           $alphabet = explode(",", get_string('alphabet', 'langconfig'));
2000           for ($i = 0; $i < count($alphabet); $i++) {
2001               if ( $hook == $alphabet[$i] and $hook) {
2002                    echo "<b>$alphabet[$i]</b>";
2003               } else {
2004                    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>";
2005               }
2006               echo ' | ';
2007           }
2008      }
2011 /**
2012  * @global object
2013  * @param object $cm
2014  * @param string $mode
2015  * @param string $sortkey
2016  * @param string $sortorder
2017  */
2018 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
2019     global $CFG, $OUTPUT;
2021     $asc    = get_string("ascending","glossary");
2022     $desc   = get_string("descending","glossary");
2023     $bopen  = '<b>';
2024     $bclose = '</b>';
2026      $neworder = '';
2027      $currentorder = '';
2028      $currentsort = '';
2029      if ( $sortorder ) {
2030          if ( $sortorder == 'asc' ) {
2031              $currentorder = $asc;
2032              $neworder = '&amp;sortorder=desc';
2033              $newordertitle = get_string('changeto', 'glossary', $desc);
2034          } else {
2035              $currentorder = $desc;
2036              $neworder = '&amp;sortorder=asc';
2037              $newordertitle = get_string('changeto', 'glossary', $asc);
2038          }
2039          $icon = " <img src=\"".$OUTPUT->pix_url($sortorder, 'glossary')."\" class=\"icon\" alt=\"$newordertitle\" />";
2040      } else {
2041          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
2042                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
2043              $icon = "";
2044              $newordertitle = $asc;
2045          } else {
2046              $newordertitle = $desc;
2047              $neworder = '&amp;sortorder=desc';
2048              $icon = ' <img src="'.$OUTPUT->pix_url('asc', 'glossary').'" class="icon" alt="'.$newordertitle.'" />';
2049          }
2050      }
2051      $ficon     = '';
2052      $fneworder = '';
2053      $fbtag     = '';
2054      $fendbtag  = '';
2056      $sicon     = '';
2057      $sneworder = '';
2059      $sbtag      = '';
2060      $fbtag      = '';
2061      $fendbtag      = '';
2062      $sendbtag      = '';
2064      $sendbtag  = '';
2066      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
2067          $ficon       = $icon;
2068          $fneworder   = $neworder;
2069          $fordertitle = $newordertitle;
2070          $sordertitle = $asc;
2071          $fbtag       = $bopen;
2072          $fendbtag    = $bclose;
2073      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
2074          $sicon = $icon;
2075          $sneworder   = $neworder;
2076          $fordertitle = $asc;
2077          $sordertitle = $newordertitle;
2078          $sbtag       = $bopen;
2079          $sendbtag    = $bclose;
2080      } else {
2081          $fordertitle = $asc;
2082          $sordertitle = $asc;
2083      }
2085      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
2086          $forder = 'CREATION';
2087          $sorder =  'UPDATE';
2088          $fsort  = get_string("sortbycreation", "glossary");
2089          $ssort  = get_string("sortbylastupdate", "glossary");
2091          $currentsort = $fsort;
2092          if ($sortkey == 'UPDATE') {
2093              $currentsort = $ssort;
2094          }
2095          $sort        = get_string("sortchronogically", "glossary");
2096      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
2097          $forder = 'FIRSTNAME';
2098          $sorder =  'LASTNAME';
2099          $fsort  = get_string("firstname");
2100          $ssort  = get_string("lastname");
2102          $currentsort = $fsort;
2103          if ($sortkey == 'LASTNAME') {
2104              $currentsort = $ssort;
2105          }
2106          $sort        = get_string("sortby", "glossary");
2107      }
2108      $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
2109      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 | ".
2110                           "$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 />";
2113 /**
2114  *
2115  * @param object $entry0
2116  * @param object $entry1
2117  * @return int [-1 | 0 | 1]
2118  */
2119 function glossary_sort_entries ( $entry0, $entry1 ) {
2121     if ( core_text::strtolower(ltrim($entry0->concept)) < core_text::strtolower(ltrim($entry1->concept)) ) {
2122         return -1;
2123     } elseif ( core_text::strtolower(ltrim($entry0->concept)) > core_text::strtolower(ltrim($entry1->concept)) ) {
2124         return 1;
2125     } else {
2126         return 0;
2127     }
2131 /**
2132  * @global object
2133  * @global object
2134  * @global object
2135  * @param object $course
2136  * @param object $entry
2137  * @return bool
2138  */
2139 function  glossary_print_entry_ratings($course, $entry) {
2140     global $OUTPUT;
2141     if( !empty($entry->rating) ){
2142         echo $OUTPUT->render($entry->rating);
2143     }
2146 /**
2147  *
2148  * @global object
2149  * @global object
2150  * @global object
2151  * @param int $courseid
2152  * @param array $entries
2153  * @param int $displayformat
2154  */
2155 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
2156     global $USER,$CFG, $DB;
2158     echo '<div class="boxaligncenter">';
2159     echo '<table class="glossarypopup" cellspacing="0"><tr>';
2160     echo '<td>';
2161     if ( $entries ) {
2162         foreach ( $entries as $entry ) {
2163             if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
2164                 print_error('invalidid', 'glossary');
2165             }
2166             if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
2167                 print_error('coursemisconf');
2168             }
2169             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
2170                 print_error('invalidid', 'glossary');
2171             }
2173             //If displayformat is present, override glossary->displayformat
2174             if ($displayformat < 0) {
2175                 $dp = $glossary->displayformat;
2176             } else {
2177                 $dp = $displayformat;
2178             }
2180             //Get popupformatname
2181             $format = $DB->get_record('glossary_formats', array('name'=>$dp));
2182             $displayformat = $format->popupformatname;
2184             //Check displayformat variable and set to default if necessary
2185             if (!$displayformat) {
2186                 $displayformat = 'dictionary';
2187             }
2189             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
2190             $functionname = 'glossary_show_entry_'.$displayformat;
2192             if (file_exists($formatfile)) {
2193                 include_once($formatfile);
2194                 if (function_exists($functionname)) {
2195                     $functionname($course, $cm, $glossary, $entry,'','','','');
2196                 }
2197             }
2198         }
2199     }
2200     echo '</td>';
2201     echo '</tr></table></div>';
2204 /**
2205  *
2206  * @global object
2207  * @param array $entries
2208  * @param array $aliases
2209  * @param array $categories
2210  * @return string
2211  */
2212 function glossary_generate_export_csv($entries, $aliases, $categories) {
2213     global $CFG;
2214     $csv = '';
2215     $delimiter = '';
2216     require_once($CFG->libdir . '/csvlib.class.php');
2217     $delimiter = csv_import_reader::get_delimiter('comma');
2218     $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
2219     $csvaliases = array(0 => array());
2220     $csvcategories = array(0 => array());
2221     $aliascount = 0;
2222     $categorycount = 0;
2224     foreach ($entries as $entry) {
2225         $thisaliasesentry = array();
2226         $thiscategoriesentry = array();
2227         $thiscsventry = array($entry->concept, nl2br($entry->definition));
2229         if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
2230             $thiscount = count($aliases[$entry->id]);
2231             if ($thiscount > $aliascount) {
2232                 $aliascount = $thiscount;
2233             }
2234             foreach ($aliases[$entry->id] as $alias) {
2235                 $thisaliasesentry[] = trim($alias);
2236             }
2237         }
2238         if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
2239             $thiscount = count($categories[$entry->id]);
2240             if ($thiscount > $categorycount) {
2241                 $categorycount = $thiscount;
2242             }
2243             foreach ($categories[$entry->id] as $catentry) {
2244                 $thiscategoriesentry[] = trim($catentry);
2245             }
2246         }
2247         $csventries[$entry->id] = $thiscsventry;
2248         $csvaliases[$entry->id] = $thisaliasesentry;
2249         $csvcategories[$entry->id] = $thiscategoriesentry;
2251     }
2252     $returnstr = '';
2253     foreach ($csventries as $id => $row) {
2254         $aliasstr = '';
2255         $categorystr = '';
2256         if ($id == 0) {
2257             $aliasstr = get_string('alias', 'glossary');
2258             $categorystr = get_string('category', 'glossary');
2259         }
2260         $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
2261         $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
2262     }
2263     return $returnstr;
2266 /**
2267  *
2268  * @param object $glossary
2269  * @param string $ignored invalid parameter
2270  * @param int|string $hook
2271  * @return string
2272  */
2273 function glossary_generate_export_file($glossary, $ignored = "", $hook = 0) {
2274     global $CFG, $DB;
2276     $co  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2278     $co .= glossary_start_tag("GLOSSARY",0,true);
2279     $co .= glossary_start_tag("INFO",1,true);
2280         $co .= glossary_full_tag("NAME",2,false,$glossary->name);
2281         $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
2282         $co .= glossary_full_tag("INTROFORMAT",2,false,$glossary->introformat);
2283         $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
2284         $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
2285         $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
2286         $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
2287         $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
2288         $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
2289         $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
2290         $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
2291         $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
2292         $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
2294         if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) {
2295             $co .= glossary_start_tag("ENTRIES",2,true);
2296             foreach ($entries as $entry) {
2297                 $permissiongranted = 1;
2298                 if ( $hook ) {
2299                     switch ( $hook ) {
2300                     case "ALL":
2301                     case "SPECIAL":
2302                     break;
2303                     default:
2304                         $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
2305                     break;
2306                     }
2307                 }
2308                 if ( $hook ) {
2309                     switch ( $hook ) {
2310                     case GLOSSARY_SHOW_ALL_CATEGORIES:
2311                     break;
2312                     case GLOSSARY_SHOW_NOT_CATEGORISED:
2313                         $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id));
2314                     break;
2315                     default:
2316                         $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook));
2317                     break;
2318                     }
2319                 }
2320                 if ( $entry->approved and $permissiongranted ) {
2321                     $co .= glossary_start_tag("ENTRY",3,true);
2322                     $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
2323                     $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition);
2324                     $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat); // note: use old name for BC reasons
2325                     $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
2326                     $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
2327                     $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
2328                     $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
2330                     if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) {
2331                         $co .= glossary_start_tag("ALIASES",4,true);
2332                         foreach ($aliases as $alias) {
2333                             $co .= glossary_start_tag("ALIAS",5,true);
2334                                 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
2335                             $co .= glossary_end_tag("ALIAS",5,true);
2336                         }
2337                         $co .= glossary_end_tag("ALIASES",4,true);
2338                     }
2339                     if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) {
2340                         $co .= glossary_start_tag("CATEGORIES",4,true);
2341                         foreach ($catentries as $catentry) {
2342                             $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid));
2344                             $co .= glossary_start_tag("CATEGORY",5,true);
2345                                 $co .= glossary_full_tag("NAME",6,false,$category->name);
2346                                 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
2347                             $co .= glossary_end_tag("CATEGORY",5,true);
2348                         }
2349                         $co .= glossary_end_tag("CATEGORIES",4,true);
2350                     }
2352                     $co .= glossary_end_tag("ENTRY",3,true);
2353                 }
2354             }
2355             $co .= glossary_end_tag("ENTRIES",2,true);
2357         }
2360     $co .= glossary_end_tag("INFO",1,true);
2361     $co .= glossary_end_tag("GLOSSARY",0,true);
2363     return $co;
2365 /// Functions designed by Eloy Lafuente
2366 /// Functions to create, open and write header of the xml file
2368 /**
2369  * Read import file and convert to current charset
2370  *
2371  * @global object
2372  * @param string $file
2373  * @return string
2374  */
2375 function glossary_read_imported_file($file_content) {
2376     require_once "../../lib/xmlize.php";
2377     global $CFG;
2379     return xmlize($file_content, 0);
2382 /**
2383  * Return the xml start tag
2384  *
2385  * @param string $tag
2386  * @param int $level
2387  * @param bool $endline
2388  * @return string
2389  */
2390 function glossary_start_tag($tag,$level=0,$endline=false) {
2391         if ($endline) {
2392            $endchar = "\n";
2393         } else {
2394            $endchar = "";
2395         }
2396         return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
2399 /**
2400  * Return the xml end tag
2401  * @param string $tag
2402  * @param int $level
2403  * @param bool $endline
2404  * @return string
2405  */
2406 function glossary_end_tag($tag,$level=0,$endline=true) {
2407         if ($endline) {
2408            $endchar = "\n";
2409         } else {
2410            $endchar = "";
2411         }
2412         return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
2415 /**
2416  * Return the start tag, the contents and the end tag
2417  *
2418  * @global object
2419  * @param string $tag
2420  * @param int $level
2421  * @param bool $endline
2422  * @param string $content
2423  * @return string
2424  */
2425 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
2426         global $CFG;
2428         $st = glossary_start_tag($tag,$level,$endline);
2429         $co = preg_replace("/\r\n|\r/", "\n", s($content));
2430         $et = glossary_end_tag($tag,0,true);
2431         return $st.$co.$et;
2434 /**
2435  * How many unrated entries are in the given glossary for a given user?
2436  *
2437  * @global moodle_database $DB
2438  * @param int $glossaryid
2439  * @param int $userid
2440  * @return int
2441  */
2442 function glossary_count_unrated_entries($glossaryid, $userid) {
2443     global $DB;
2445     $sql = "SELECT COUNT('x') as num
2446               FROM {glossary_entries}
2447              WHERE glossaryid = :glossaryid AND
2448                    userid <> :userid";
2449     $params = array('glossaryid' => $glossaryid, 'userid' => $userid);
2450     $entries = $DB->count_records_sql($sql, $params);
2452     if ($entries) {
2453         // We need to get the contextid for the glossaryid we have been given.
2454         $sql = "SELECT ctx.id
2455                   FROM {context} ctx
2456                   JOIN {course_modules} cm ON cm.id = ctx.instanceid
2457                   JOIN {modules} m ON m.id = cm.module
2458                   JOIN {glossary} g ON g.id = cm.instance
2459                  WHERE ctx.contextlevel = :contextlevel AND
2460                        m.name = 'glossary' AND
2461                        g.id = :glossaryid";
2462         $contextid = $DB->get_field_sql($sql, array('glossaryid' => $glossaryid, 'contextlevel' => CONTEXT_MODULE));
2464         // Now we need to count the ratings that this user has made
2465         $sql = "SELECT COUNT('x') AS num
2466                   FROM {glossary_entries} e
2467                   JOIN {rating} r ON r.itemid = e.id
2468                  WHERE e.glossaryid = :glossaryid AND
2469                        r.userid = :userid AND
2470                        r.component = 'mod_glossary' AND
2471                        r.ratingarea = 'entry' AND
2472                        r.contextid = :contextid";
2473         $params = array('glossaryid' => $glossaryid, 'userid' => $userid, 'contextid' => $contextid);
2474         $rated = $DB->count_records_sql($sql, $params);
2475         if ($rated) {
2476             // The number or enties minus the number or rated entries equals the number of unrated
2477             // entries
2478             if ($entries > $rated) {
2479                 return $entries - $rated;
2480             } else {
2481                 return 0;    // Just in case there was a counting error
2482             }
2483         } else {
2484             return (int)$entries;
2485         }
2486     } else {
2487         return 0;
2488     }
2491 /**
2492  *
2493  * Returns the html code to represent any pagging bar. Paramenters are:
2494  *
2495  * The function dinamically show the first and last pages, and "scroll" over pages.
2496  * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
2497  * could replace the general one. ;-)
2498  *
2499  * @param int $totalcount total number of records to be displayed
2500  * @param int $page page currently selected (0 based)
2501  * @param int $perpage number of records per page
2502  * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically.
2503  *
2504  * @param int $maxpageallowed Optional maximum number of page allowed.
2505  * @param int $maxdisplay Optional maximum number of page links to show in the bar
2506  * @param string $separator Optional string to be used between pages in the bar
2507  * @param string $specialtext Optional string to be showed as an special link
2508  * @param string $specialvalue Optional value (page) to be used in the special link
2509  * @param bool $previousandnext Optional to decide if we want the previous and next links
2510  * @return string
2511  */
2512 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) {
2514     $code = '';
2516     $showspecial = false;
2517     $specialselected = false;
2519     //Check if we have to show the special link
2520     if (!empty($specialtext)) {
2521         $showspecial = true;
2522     }
2523     //Check if we are with the special link selected
2524     if ($showspecial && $page == $specialvalue) {
2525         $specialselected = true;
2526     }
2528     //If there are results (more than 1 page)
2529     if ($totalcount > $perpage) {
2530         $code .= "<div style=\"text-align:center\">";
2531         $code .= "<p>".get_string("page").":";
2533         $maxpage = (int)(($totalcount-1)/$perpage);
2535         //Lower and upper limit of page
2536         if ($page < 0) {
2537             $page = 0;
2538         }
2539         if ($page > $maxpageallowed) {
2540             $page = $maxpageallowed;
2541         }
2542         if ($page > $maxpage) {
2543             $page = $maxpage;
2544         }
2546         //Calculate the window of pages
2547         $pagefrom = $page - ((int)($maxdisplay / 2));
2548         if ($pagefrom < 0) {
2549             $pagefrom = 0;
2550         }
2551         $pageto = $pagefrom + $maxdisplay - 1;
2552         if ($pageto > $maxpageallowed) {
2553             $pageto = $maxpageallowed;
2554         }
2555         if ($pageto > $maxpage) {
2556             $pageto = $maxpage;
2557         }
2559         //Some movements can be necessary if don't see enought pages
2560         if ($pageto - $pagefrom < $maxdisplay - 1) {
2561             if ($pageto - $maxdisplay + 1 > 0) {
2562                 $pagefrom = $pageto - $maxdisplay + 1;
2563             }
2564         }
2566         //Calculate first and last if necessary
2567         $firstpagecode = '';
2568         $lastpagecode = '';
2569         if ($pagefrom > 0) {
2570             $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2571             if ($pagefrom > 1) {
2572                 $firstpagecode .= "$separator...";
2573             }
2574         }
2575         if ($pageto < $maxpage) {
2576             if ($pageto < $maxpage -1) {
2577                 $lastpagecode = "$separator...";
2578             }
2579             $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2580         }
2582         //Previous
2583         if ($page > 0 && $previousandnext) {
2584             $pagenum = $page - 1;
2585             $code .= "&nbsp;(<a  href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;";
2586         }
2588         //Add first
2589         $code .= $firstpagecode;
2591         $pagenum = $pagefrom;
2593         //List of maxdisplay pages
2594         while ($pagenum <= $pageto) {
2595             $pagetoshow = $pagenum +1;
2596             if ($pagenum == $page && !$specialselected) {
2597                 $code .= "$separator<b>$pagetoshow</b>";
2598             } else {
2599                 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2600             }
2601             $pagenum++;
2602         }
2604         //Add last
2605         $code .= $lastpagecode;
2607         //Next
2608         if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2609             $pagenum = $page + 1;
2610             $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2611         }
2613         //Add special
2614         if ($showspecial) {
2615             $code .= '<br />';
2616             if ($specialselected) {
2617                 $code .= "<b>$specialtext</b>";
2618             } else {
2619                 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2620             }
2621         }
2623         //End html
2624         $code .= "</p>";
2625         $code .= "</div>";
2626     }
2628     return $code;
2630 /**
2631  * @return array
2632  */
2633 function glossary_get_view_actions() {
2634     return array('view','view all','view entry');
2636 /**
2637  * @return array
2638  */
2639 function glossary_get_post_actions() {
2640     return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry');
2644 /**
2645  * Implementation of the function for printing the form elements that control
2646  * whether the course reset functionality affects the glossary.
2647  * @param object $mform form passed by reference
2648  */
2649 function glossary_reset_course_form_definition(&$mform) {
2650     $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary'));
2651     $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary'));
2653     $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'),
2654                        array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple'));
2655     $mform->setAdvanced('reset_glossary_types');
2656     $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked');
2658     $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary'));
2659     $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked');
2661     $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings'));
2662     $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked');
2664     $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments'));
2665     $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked');
2668 /**
2669  * Course reset form defaults.
2670  * @return array
2671  */
2672 function glossary_reset_course_form_defaults($course) {
2673     return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0);
2676 /**
2677  * Removes all grades from gradebook
2678  *
2679  * @param int $courseid The ID of the course to reset
2680  * @param string $type The optional type of glossary. 'main', 'secondary' or ''
2681  */
2682 function glossary_reset_gradebook($courseid, $type='') {
2683     global $DB;
2685     switch ($type) {
2686         case 'main'      : $type = "AND g.mainglossary=1"; break;
2687         case 'secondary' : $type = "AND g.mainglossary=0"; break;
2688         default          : $type = ""; //all
2689     }
2691     $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid
2692               FROM {glossary} g, {course_modules} cm, {modules} m
2693              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type";
2695     if ($glossarys = $DB->get_records_sql($sql, array($courseid))) {
2696         foreach ($glossarys as $glossary) {
2697             glossary_grade_item_update($glossary, 'reset');
2698         }
2699     }
2701 /**
2702  * Actual implementation of the reset course functionality, delete all the
2703  * glossary responses for course $data->courseid.
2704  *
2705  * @global object
2706  * @param $data the data submitted from the reset course.
2707  * @return array status array
2708  */
2709 function glossary_reset_userdata($data) {
2710     global $CFG, $DB;
2711     require_once($CFG->dirroot.'/rating/lib.php');
2713     $componentstr = get_string('modulenameplural', 'glossary');
2714     $status = array();
2716     $allentriessql = "SELECT e.id
2717                         FROM {glossary_entries} e
2718                              JOIN {glossary} g ON e.glossaryid = g.id
2719                        WHERE g.course = ?";
2721     $allglossariessql = "SELECT g.id
2722                            FROM {glossary} g
2723                           WHERE g.course = ?";
2725     $params = array($data->courseid);
2727     $fs = get_file_storage();
2729     $rm = new rating_manager();
2730     $ratingdeloptions = new stdClass;
2731     $ratingdeloptions->component = 'mod_glossary';
2732     $ratingdeloptions->ratingarea = 'entry';
2734     // delete entries if requested
2735     if (!empty($data->reset_glossary_all)
2736          or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) {
2738         $params[] = 'glossary_entry';
2739         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea=?", $params);
2740         $DB->delete_records_select('glossary_alias',    "entryid IN ($allentriessql)", $params);
2741         $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2743         // now get rid of all attachments
2744         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2745             foreach ($glossaries as $glossaryid=>$unused) {
2746                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2747                     continue;
2748                 }
2749                 $context = context_module::instance($cm->id);
2750                 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2752                 //delete ratings
2753                 $ratingdeloptions->contextid = $context->id;
2754                 $rm->delete_ratings($ratingdeloptions);
2755             }
2756         }
2758         // remove all grades from gradebook
2759         if (empty($data->reset_gradebook_grades)) {
2760             glossary_reset_gradebook($data->courseid);
2761         }
2763         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2765     } else if (!empty($data->reset_glossary_types)) {
2766         $mainentriessql         = "$allentriessql AND g.mainglossary=1";
2767         $secondaryentriessql    = "$allentriessql AND g.mainglossary=0";
2769         $mainglossariessql      = "$allglossariessql AND g.mainglossary=1";
2770         $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2772         if (in_array('main', $data->reset_glossary_types)) {
2773             $params[] = 'glossary_entry';
2774             $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params);
2775             $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2777             if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2778                 foreach ($glossaries as $glossaryid=>$unused) {
2779                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2780                         continue;
2781                     }
2782                     $context = context_module::instance($cm->id);
2783                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2785                     //delete ratings
2786                     $ratingdeloptions->contextid = $context->id;
2787                     $rm->delete_ratings($ratingdeloptions);
2788                 }
2789             }
2791             // remove all grades from gradebook
2792             if (empty($data->reset_gradebook_grades)) {
2793                 glossary_reset_gradebook($data->courseid, 'main');
2794             }
2796             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('mainglossary', 'glossary'), 'error'=>false);
2798         } else if (in_array('secondary', $data->reset_glossary_types)) {
2799             $params[] = 'glossary_entry';
2800             $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params);
2801             $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2802             // remove exported source flag from entries in main glossary
2803             $DB->execute("UPDATE {glossary_entries}
2804                              SET sourceglossaryid=0
2805                            WHERE glossaryid IN ($mainglossariessql)", $params);
2807             if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2808                 foreach ($glossaries as $glossaryid=>$unused) {
2809                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2810                         continue;
2811                     }
2812                     $context = context_module::instance($cm->id);
2813                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2815                     //delete ratings
2816                     $ratingdeloptions->contextid = $context->id;
2817                     $rm->delete_ratings($ratingdeloptions);
2818                 }
2819             }
2821             // remove all grades from gradebook
2822             if (empty($data->reset_gradebook_grades)) {
2823                 glossary_reset_gradebook($data->courseid, 'secondary');
2824             }
2826             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2827         }
2828     }
2830     // remove entries by users not enrolled into course
2831     if (!empty($data->reset_glossary_notenrolled)) {
2832         $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2833                          FROM {glossary_entries} e
2834                               JOIN {glossary} g ON e.glossaryid = g.id
2835                               LEFT JOIN {user} u ON e.userid = u.id
2836                         WHERE g.course = ? AND e.userid > 0";
2838         $course_context = context_course::instance($data->courseid);
2839         $notenrolled = array();
2840         $rs = $DB->get_recordset_sql($entriessql, $params);
2841         if ($rs->valid()) {
2842             foreach ($rs as $entry) {
2843                 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2844                   or !is_enrolled($course_context , $entry->userid)) {
2845                     $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id));
2846                     $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2848                     if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2849                         $context = context_module::instance($cm->id);
2850                         $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
2852                         //delete ratings
2853                         $ratingdeloptions->contextid = $context->id;
2854                         $rm->delete_ratings($ratingdeloptions);
2855                     }
2856                 }
2857             }
2858             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2859         }
2860         $rs->close();
2861     }
2863     // remove all ratings
2864     if (!empty($data->reset_glossary_ratings)) {
2865         //remove ratings
2866         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2867             foreach ($glossaries as $glossaryid=>$unused) {
2868                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2869                     continue;
2870                 }
2871                 $context = context_module::instance($cm->id);
2873                 //delete ratings
2874                 $ratingdeloptions->contextid = $context->id;
2875                 $rm->delete_ratings($ratingdeloptions);
2876             }
2877         }
2879         // remove all grades from gradebook
2880         if (empty($data->reset_gradebook_grades)) {
2881             glossary_reset_gradebook($data->courseid);
2882         }
2883         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2884     }
2886     // remove comments
2887     if (!empty($data->reset_glossary_comments)) {
2888         $params[] = 'glossary_entry';
2889         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params);
2890         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2891     }
2893     /// updating dates - shift may be negative too
2894     if ($data->timeshift) {
2895         shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
2896         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2897     }
2899     return $status;
2902 /**
2903  * Returns all other caps used in module
2904  * @return array
2905  */
2906 function glossary_get_extra_capabilities() {
2907     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');
2910 /**
2911  * @param string $feature FEATURE_xx constant for requested feature
2912  * @return mixed True if module supports feature, null if doesn't know
2913  */
2914 function glossary_supports($feature) {
2915     switch($feature) {
2916         case FEATURE_GROUPS:                  return false;
2917         case FEATURE_GROUPINGS:               return false;
2918         case FEATURE_GROUPMEMBERSONLY:        return true;
2919         case FEATURE_MOD_INTRO:               return true;
2920         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2921         case FEATURE_COMPLETION_HAS_RULES:    return true;
2922         case FEATURE_GRADE_HAS_GRADE:         return true;
2923         case FEATURE_GRADE_OUTCOMES:          return true;
2924         case FEATURE_RATE:                    return true;
2925         case FEATURE_BACKUP_MOODLE2:          return true;
2926         case FEATURE_SHOW_DESCRIPTION:        return true;
2928         default: return null;
2929     }
2932 /**
2933  * Obtains the automatic completion state for this glossary based on any conditions
2934  * in glossary settings.
2935  *
2936  * @global object
2937  * @global object
2938  * @param object $course Course
2939  * @param object $cm Course-module
2940  * @param int $userid User ID
2941  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
2942  * @return bool True if completed, false if not. (If no conditions, then return
2943  *   value depends on comparison type)
2944  */
2945 function glossary_get_completion_state($course,$cm,$userid,$type) {
2946     global $CFG, $DB;
2948     // Get glossary details
2949     if (!($glossary=$DB->get_record('glossary',array('id'=>$cm->instance)))) {
2950         throw new Exception("Can't find glossary {$cm->instance}");
2951     }
2953     $result=$type; // Default return value
2955     if ($glossary->completionentries) {
2956         $value = $glossary->completionentries <=
2957                  $DB->count_records('glossary_entries',array('glossaryid'=>$glossary->id, 'userid'=>$userid, 'approved'=>1));
2958         if ($type == COMPLETION_AND) {
2959             $result = $result && $value;
2960         } else {
2961             $result = $result || $value;
2962         }
2963     }
2965     return $result;
2968 function glossary_extend_navigation($navigation, $course, $module, $cm) {
2969     global $CFG;
2970     $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'letter')));
2971     $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'cat')));
2972     $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'date')));
2973     $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'author')));
2976 /**
2977  * Adds module specific settings to the settings block
2978  *
2979  * @param settings_navigation $settings The settings navigation object
2980  * @param navigation_node $glossarynode The node to add module settings to
2981  */
2982 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
2983     global $PAGE, $DB, $CFG, $USER;
2985     $mode = optional_param('mode', '', PARAM_ALPHA);
2986     $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
2988     if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
2989         $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
2990     }
2992     if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
2993         $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
2994     }
2996     if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
2997         $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
2998     }
3000     if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
3001         $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
3002     }
3004     $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
3006     if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles && has_capability('mod/glossary:view', $PAGE->cm->context)) {
3007         require_once("$CFG->libdir/rsslib.php");
3009         $string = get_string('rsstype','forum');
3011         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_glossary', $glossary->id));
3012         $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3013     }
3016 /**
3017  * Running addtional permission check on plugin, for example, plugins
3018  * may have switch to turn on/off comments option, this callback will
3019  * affect UI display, not like pluginname_comment_validate only throw
3020  * exceptions.
3021  * Capability check has been done in comment->check_permissions(), we
3022  * don't need to do it again here.
3023  *
3024  * @package  mod_glossary
3025  * @category comment
3026  *
3027  * @param stdClass $comment_param {
3028  *              context  => context the context object
3029  *              courseid => int course id
3030  *              cm       => stdClass course module object
3031  *              commentarea => string comment area
3032  *              itemid      => int itemid
3033  * }
3034  * @return array
3035  */
3036 function glossary_comment_permissions($comment_param) {
3037     return array('post'=>true, 'view'=>true);
3040 /**
3041  * Validate comment parameter before perform other comments actions
3042  *
3043  * @package  mod_glossary
3044  * @category comment
3045  *
3046  * @param stdClass $comment_param {
3047  *              context  => context the context object
3048  *              courseid => int course id
3049  *              cm       => stdClass course module object
3050  *              commentarea => string comment area
3051  *              itemid      => int itemid
3052  * }
3053  * @return boolean
3054  */
3055 function glossary_comment_validate($comment_param) {
3056     global $DB;
3057     // validate comment area
3058     if ($comment_param->commentarea != 'glossary_entry') {
3059         throw new comment_exception('invalidcommentarea');
3060     }
3061     if (!$record = $DB->get_record('glossary_entries', array('id'=>$comment_param->itemid))) {
3062         throw new comment_exception('invalidcommentitemid');
3063     }
3064     if ($record->sourceglossaryid && $record->sourceglossaryid == $comment_param->cm->instance) {
3065         $glossary = $DB->get_record('glossary', array('id'=>$record->sourceglossaryid));
3066     } else {
3067         $glossary = $DB->get_record('glossary', array('id'=>$record->glossaryid));
3068     }
3069     if (!$glossary) {
3070         throw new comment_exception('invalidid', 'data');
3071     }
3072     if (!$course = $DB->get_record('course', array('id'=>$glossary->course))) {
3073         throw new comment_exception('coursemisconf');
3074     }
3075     if (!$cm = get_coursemodule_from_instance('glossary', $glossary->id, $course->id)) {
3076         throw new comment_exception('invalidcoursemodule');
3077     }
3078     $context = context_module::instance($cm->id);
3080     if ($glossary->defaultapproval and !$record->approved and !has_capability('mod/glossary:approve', $context)) {
3081         throw new comment_exception('notapproved', 'glossary');
3082     }
3083     // validate context id
3084     if ($context->id != $comment_param->context->id) {
3085         throw new comment_exception('invalidcontext');
3086     }
3087     // validation for comment deletion
3088     if (!empty($comment_param->commentid)) {
3089         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3090             if ($comment->commentarea != 'glossary_entry') {
3091                 throw new comment_exception('invalidcommentarea');
3092             }
3093             if ($comment->contextid != $comment_param->context->id) {
3094                 throw new comment_exception('invalidcontext');
3095             }
3096             if ($comment->itemid != $comment_param->itemid) {
3097                 throw new comment_exception('invalidcommentitemid');
3098             }
3099         } else {
3100             throw new comment_exception('invalidcommentid');
3101         }
3102     }
3103     return true;
3106 /**
3107  * Return a list of page types
3108  * @param string $pagetype current page type
3109  * @param stdClass $parentcontext Block's parent context
3110  * @param stdClass $currentcontext Current context of block
3111  */
3112 function glossary_page_type_list($pagetype, $parentcontext, $currentcontext) {
3113     $module_pagetype = array(
3114         'mod-glossary-*'=>get_string('page-mod-glossary-x', 'glossary'),
3115         'mod-glossary-view'=>get_string('page-mod-glossary-view', 'glossary'),
3116         'mod-glossary-edit'=>get_string('page-mod-glossary-edit', 'glossary'));
3117     return $module_pagetype;