MDL-33791 Portfolio: Fixed security issue with passing file paths.
[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', array('lastaccess', 'firstname', 'lastname', 'email', 'picture', 'imagealt'));
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->type                 = 'glossary';
403         $tmpactivity->cmid                 = $cm->id;
404         $tmpactivity->glossaryid           = $entry->glossaryid;
405         $tmpactivity->name                 = format_string($cm->name, true);
406         $tmpactivity->sectionnum           = $cm->sectionnum;
407         $tmpactivity->timestamp            = $entry->timemodified;
408         $tmpactivity->content              = new stdClass();
409         $tmpactivity->content->entryid     = $entry->entryid;
410         $tmpactivity->content->concept     = $entry->concept;
411         $tmpactivity->content->definition  = $entry->definition;
412         $tmpactivity->user                 = new stdClass();
413         $tmpactivity->user->id             = $entry->userid;
414         $tmpactivity->user->firstname      = $entry->firstname;
415         $tmpactivity->user->lastname       = $entry->lastname;
416         $tmpactivity->user->fullname       = fullname($entry, $viewfullnames);
417         $tmpactivity->user->picture        = $entry->picture;
418         $tmpactivity->user->imagealt       = $entry->imagealt;
419         $tmpactivity->user->email          = $entry->email;
421         $activities[$index++] = $tmpactivity;
422     }
424     return true;
427 /**
428  * Outputs the glossary entry indicated by $activity
429  *
430  * @param object $activity      the activity object the glossary resides in
431  * @param int    $courseid      the id of the course the glossary resides in
432  * @param bool   $detail        not used, but required for compatibilty with other modules
433  * @param int    $modnames      not used, but required for compatibilty with other modules
434  * @param bool   $viewfullnames not used, but required for compatibilty with other modules
435  * @return void
436  */
437 function glossary_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) {
438     global $OUTPUT;
440     echo html_writer::start_tag('div', array('class'=>'glossary-activity clearfix'));
441     if (!empty($activity->user)) {
442         echo html_writer::tag('div', $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid)),
443             array('class' => 'glossary-activity-picture'));
444     }
446     echo html_writer::start_tag('div', array('class'=>'glossary-activity-content'));
447     echo html_writer::start_tag('div', array('class'=>'glossary-activity-entry'));
449     $urlparams = array('g' => $activity->glossaryid, 'mode' => 'entry', 'hook' => $activity->content->entryid);
450     echo html_writer::tag('a', strip_tags($activity->content->concept),
451         array('href' => new moodle_url('/mod/glossary/view.php', $urlparams)));
452     echo html_writer::end_tag('div');
454     $url = new moodle_url('/user/view.php', array('course'=>$courseid, 'id'=>$activity->user->id));
455     $name = $activity->user->fullname;
456     $link = html_writer::link($url, $name);
458     echo html_writer::start_tag('div', array('class'=>'user'));
459     echo $link .' - '. userdate($activity->timestamp);
460     echo html_writer::end_tag('div');
462     echo html_writer::end_tag('div');
464     echo html_writer::end_tag('div');
465     return;
467 /**
468  * Given a course and a time, this module should find recent activity
469  * that has occurred in glossary activities and print it out.
470  * Return true if there was output, or false is there was none.
471  *
472  * @global object
473  * @global object
474  * @global object
475  * @param object $course
476  * @param object $viewfullnames
477  * @param int $timestart
478  * @return bool
479  */
480 function glossary_print_recent_activity($course, $viewfullnames, $timestart) {
481     global $CFG, $USER, $DB, $OUTPUT, $PAGE;
483     //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0
484     if (!defined('GLOSSARY_RECENT_ACTIVITY_LIMIT')) {
485         define('GLOSSARY_RECENT_ACTIVITY_LIMIT', 50);
486     }
487     $modinfo = get_fast_modinfo($course);
488     $ids = array();
490     foreach ($modinfo->cms as $cm) {
491         if ($cm->modname != 'glossary') {
492             continue;
493         }
494         if (!$cm->uservisible) {
495             continue;
496         }
497         $ids[$cm->instance] = $cm->id;
498     }
500     if (!$ids) {
501         return false;
502     }
504     // generate list of approval capabilities for all glossaries in the course.
505     $approvals = array();
506     foreach ($ids as $glinstanceid => $glcmid) {
507         $context = context_module::instance($glcmid);
508         if (has_capability('mod/glossary:view', $context)) {
509             // get records glossary entries that are approved if user has no capability to approve entries.
510             if (has_capability('mod/glossary:approve', $context)) {
511                 $approvals[] = ' ge.glossaryid = :glsid'.$glinstanceid.' ';
512             } else {
513                 $approvals[] = ' (ge.approved = 1 AND ge.glossaryid = :glsid'.$glinstanceid.') ';
514             }
515             $params['glsid'.$glinstanceid] = $glinstanceid;
516         }
517     }
519     if (count($approvals) == 0) {
520         return false;
521     }
522     $selectsql = 'SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
523                                         '.user_picture::fields('u',null,'userid');
524     $countsql = 'SELECT COUNT(*)';
526     $joins = array(' FROM {glossary_entries} ge ');
527     $joins[] = 'JOIN {user} u ON u.id = ge.userid ';
528     $fromsql = implode($joins, "\n");
530     $params['timestart'] = $timestart;
531     $clausesql = ' WHERE ge.timemodified > :timestart ';
533     if (count($approvals) > 0) {
534         $approvalsql = 'AND ('. implode($approvals, ' OR ') .') ';
535     } else {
536         $approvalsql = '';
537     }
538     $ordersql = 'ORDER BY ge.timemodified ASC';
539     $entries = $DB->get_records_sql($selectsql.$fromsql.$clausesql.$approvalsql.$ordersql, $params, 0, (GLOSSARY_RECENT_ACTIVITY_LIMIT+1));
541     if (empty($entries)) {
542         return false;
543     }
545     echo $OUTPUT->heading(get_string('newentries', 'glossary').':', 3);
546     $strftimerecent = get_string('strftimerecent');
547     $entrycount = 0;
548     foreach ($entries as $entry) {
549         if ($entrycount < GLOSSARY_RECENT_ACTIVITY_LIMIT) {
550             if ($entry->approved) {
551                 $dimmed = '';
552                 $urlparams = array('g' => $entry->glossaryid, 'mode' => 'entry', 'hook' => $entry->id);
553             } else {
554                 $dimmed = ' dimmed_text';
555                 $urlparams = array('id' => $ids[$entry->glossaryid], 'mode' => 'approval', 'hook' => format_text($entry->concept, true));
556             }
557             $link = new moodle_url($CFG->wwwroot.'/mod/glossary/view.php' , $urlparams);
558             echo '<div class="head'.$dimmed.'">';
559             echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
560             echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
561             echo '</div>';
562             echo '<div class="info"><a href="'.$link.'">'.format_string($entry->concept, true).'</a></div>';
563             $entrycount += 1;
564         } else {
565             $numnewentries = $DB->count_records_sql($countsql.$joins[0].$clausesql.$approvalsql, $params);
566             echo '<div class="head"><div class="activityhead">'.get_string('andmorenewentries', 'glossary', $numnewentries - GLOSSARY_RECENT_ACTIVITY_LIMIT).'</div></div>';
567             break;
568         }
569     }
571     return true;
574 /**
575  * @global object
576  * @param object $log
577  */
578 function glossary_log_info($log) {
579     global $DB;
581     return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
582                                   FROM {glossary_entries} e, {user} u
583                                  WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
586 /**
587  * Function to be run periodically according to the moodle cron
588  * This function searches for things that need to be done, such
589  * as sending out mail, toggling flags etc ...
590  * @return bool
591  */
592 function glossary_cron () {
593     return true;
596 /**
597  * Return grade for given user or all users.
598  *
599  * @param stdClass $glossary A glossary instance
600  * @param int $userid Optional user id, 0 means all users
601  * @return array An array of grades, false if none
602  */
603 function glossary_get_user_grades($glossary, $userid=0) {
604     global $CFG;
606     require_once($CFG->dirroot.'/rating/lib.php');
608     $ratingoptions = new stdClass;
610     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
611     $ratingoptions->modulename = 'glossary';
612     $ratingoptions->moduleid   = $glossary->id;
613     $ratingoptions->component  = 'mod_glossary';
614     $ratingoptions->ratingarea = 'entry';
616     $ratingoptions->userid = $userid;
617     $ratingoptions->aggregationmethod = $glossary->assessed;
618     $ratingoptions->scaleid = $glossary->scale;
619     $ratingoptions->itemtable = 'glossary_entries';
620     $ratingoptions->itemtableusercolumn = 'userid';
622     $rm = new rating_manager();
623     return $rm->get_user_grades($ratingoptions);
626 /**
627  * Return rating related permissions
628  *
629  * @param int $contextid the context id
630  * @param string $component The component we want to get permissions for
631  * @param string $ratingarea The ratingarea that we want to get permissions for
632  * @return array an associative array of the user's rating permissions
633  */
634 function glossary_rating_permissions($contextid, $component, $ratingarea) {
635     if ($component != 'mod_glossary' || $ratingarea != 'entry') {
636         // We don't know about this component/ratingarea so just return null to get the
637         // default restrictive permissions.
638         return null;
639     }
640     $context = context::instance_by_id($contextid);
641     return array(
642         'view'    => has_capability('mod/glossary:viewrating', $context),
643         'viewany' => has_capability('mod/glossary:viewanyrating', $context),
644         'viewall' => has_capability('mod/glossary:viewallratings', $context),
645         'rate'    => has_capability('mod/glossary:rate', $context)
646     );
649 /**
650  * Validates a submitted rating
651  * @param array $params submitted data
652  *            context => object the context in which the rated items exists [required]
653  *            component => The component for this module - should always be mod_forum [required]
654  *            ratingarea => object the context in which the rated items exists [required]
655  *            itemid => int the ID of the object being rated [required]
656  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
657  *            rating => int the submitted rating
658  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
659  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [optional]
660  * @return boolean true if the rating is valid. Will throw rating_exception if not
661  */
662 function glossary_rating_validate($params) {
663     global $DB, $USER;
665     // Check the component is mod_forum
666     if ($params['component'] != 'mod_glossary') {
667         throw new rating_exception('invalidcomponent');
668     }
670     // Check the ratingarea is post (the only rating area in forum)
671     if ($params['ratingarea'] != 'entry') {
672         throw new rating_exception('invalidratingarea');
673     }
675     // Check the rateduserid is not the current user .. you can't rate your own posts
676     if ($params['rateduserid'] == $USER->id) {
677         throw new rating_exception('nopermissiontorate');
678     }
680     $glossarysql = "SELECT g.id as glossaryid, g.scale, g.course, e.userid as userid, e.approved, e.timecreated, g.assesstimestart, g.assesstimefinish
681                       FROM {glossary_entries} e
682                       JOIN {glossary} g ON e.glossaryid = g.id
683                      WHERE e.id = :itemid";
684     $glossaryparams = array('itemid' => $params['itemid']);
685     $info = $DB->get_record_sql($glossarysql, $glossaryparams);
686     if (!$info) {
687         //item doesn't exist
688         throw new rating_exception('invaliditemid');
689     }
691     if ($info->scale != $params['scaleid']) {
692         //the scale being submitted doesnt match the one in the database
693         throw new rating_exception('invalidscaleid');
694     }
696     //check that the submitted rating is valid for the scale
698     // lower limit
699     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
700         throw new rating_exception('invalidnum');
701     }
703     // upper limit
704     if ($info->scale < 0) {
705         //its a custom scale
706         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
707         if ($scalerecord) {
708             $scalearray = explode(',', $scalerecord->scale);
709             if ($params['rating'] > count($scalearray)) {
710                 throw new rating_exception('invalidnum');
711             }
712         } else {
713             throw new rating_exception('invalidscaleid');
714         }
715     } else if ($params['rating'] > $info->scale) {
716         //if its numeric and submitted rating is above maximum
717         throw new rating_exception('invalidnum');
718     }
720     if (!$info->approved) {
721         //item isnt approved
722         throw new rating_exception('nopermissiontorate');
723     }
725     //check the item we're rating was created in the assessable time window
726     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
727         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
728             throw new rating_exception('notavailable');
729         }
730     }
732     $cm = get_coursemodule_from_instance('glossary', $info->glossaryid, $info->course, false, MUST_EXIST);
733     $context = context_module::instance($cm->id, MUST_EXIST);
735     // if the supplied context doesnt match the item's context
736     if ($context->id != $params['context']->id) {
737         throw new rating_exception('invalidcontext');
738     }
740     return true;
743 /**
744  * Update activity grades
745  *
746  * @category grade
747  * @param stdClass $glossary Null means all glossaries (with extra cmidnumber property)
748  * @param int $userid specific user only, 0 means all
749  * @param bool $nullifnone If true and the user has no grade then a grade item with rawgrade == null will be inserted
750  */
751 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
752     global $CFG, $DB;
753     require_once($CFG->libdir.'/gradelib.php');
755     if (!$glossary->assessed) {
756         glossary_grade_item_update($glossary);
758     } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
759         glossary_grade_item_update($glossary, $grades);
761     } else if ($userid and $nullifnone) {
762         $grade = new stdClass();
763         $grade->userid   = $userid;
764         $grade->rawgrade = NULL;
765         glossary_grade_item_update($glossary, $grade);
767     } else {
768         glossary_grade_item_update($glossary);
769     }
772 /**
773  * Update all grades in gradebook.
774  *
775  * @global object
776  */
777 function glossary_upgrade_grades() {
778     global $DB;
780     $sql = "SELECT COUNT('x')
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     $count = $DB->count_records_sql($sql);
785     $sql = "SELECT g.*, cm.idnumber AS cmidnumber, g.course AS courseid
786               FROM {glossary} g, {course_modules} cm, {modules} m
787              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
788     $rs = $DB->get_recordset_sql($sql);
789     if ($rs->valid()) {
790         $pbar = new progress_bar('glossaryupgradegrades', 500, true);
791         $i=0;
792         foreach ($rs as $glossary) {
793             $i++;
794             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
795             glossary_update_grades($glossary, 0, false);
796             $pbar->update($i, $count, "Updating Glossary grades ($i/$count).");
797         }
798     }
799     $rs->close();
802 /**
803  * Create/update grade item for given glossary
804  *
805  * @category grade
806  * @param stdClass $glossary object with extra cmidnumber
807  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
808  * @return int, 0 if ok, error code otherwise
809  */
810 function glossary_grade_item_update($glossary, $grades=NULL) {
811     global $CFG;
812     require_once($CFG->libdir.'/gradelib.php');
814     $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
816     if (!$glossary->assessed or $glossary->scale == 0) {
817         $params['gradetype'] = GRADE_TYPE_NONE;
819     } else if ($glossary->scale > 0) {
820         $params['gradetype'] = GRADE_TYPE_VALUE;
821         $params['grademax']  = $glossary->scale;
822         $params['grademin']  = 0;
824     } else if ($glossary->scale < 0) {
825         $params['gradetype'] = GRADE_TYPE_SCALE;
826         $params['scaleid']   = -$glossary->scale;
827     }
829     if ($grades  === 'reset') {
830         $params['reset'] = true;
831         $grades = NULL;
832     }
834     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
837 /**
838  * Delete grade item for given glossary
839  *
840  * @category grade
841  * @param object $glossary object
842  */
843 function glossary_grade_item_delete($glossary) {
844     global $CFG;
845     require_once($CFG->libdir.'/gradelib.php');
847     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
850 /**
851  * @global object
852  * @param int $gloassryid
853  * @param int $scaleid
854  * @return bool
855  */
856 function glossary_scale_used ($glossaryid,$scaleid) {
857 //This function returns if a scale is being used by one glossary
858     global $DB;
860     $return = false;
862     $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
864     if (!empty($rec)  && !empty($scaleid)) {
865         $return = true;
866     }
868     return $return;
871 /**
872  * Checks if scale is being used by any instance of glossary
873  *
874  * This is used to find out if scale used anywhere
875  *
876  * @global object
877  * @param int $scaleid
878  * @return boolean True if the scale is used by any glossary
879  */
880 function glossary_scale_used_anywhere($scaleid) {
881     global $DB;
883     if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
884         return true;
885     } else {
886         return false;
887     }
890 //////////////////////////////////////////////////////////////////////////////////////
891 /// Any other glossary functions go here.  Each of them must have a name that
892 /// starts with glossary_
894 /**
895  * This function return an array of valid glossary_formats records
896  * Everytime it's called, every existing format is checked, new formats
897  * are included if detected and old formats are deleted and any glossary
898  * using an invalid format is updated to the default (dictionary).
899  *
900  * @global object
901  * @global object
902  * @return array
903  */
904 function glossary_get_available_formats() {
905     global $CFG, $DB;
907     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
908     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
909     $pluginformats = array();
910     foreach ($formats as $format) {
911         //If the format file exists
912         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
913             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
914             //If the function exists
915             if (function_exists('glossary_show_entry_'.$format)) {
916                 //Acummulate it as a valid format
917                 $pluginformats[] = $format;
918                 //If the format doesn't exist in the table
919                 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
920                     //Insert the record in glossary_formats
921                     $gf = new stdClass();
922                     $gf->name = $format;
923                     $gf->popupformatname = $format;
924                     $gf->visible = 1;
925                     $DB->insert_record("glossary_formats",$gf);
926                 }
927             }
928         }
929     }
931     //Delete non_existent formats from glossary_formats table
932     $formats = $DB->get_records("glossary_formats");
933     foreach ($formats as $format) {
934         $todelete = false;
935         //If the format in DB isn't a valid previously detected format then delete the record
936         if (!in_array($format->name,$pluginformats)) {
937             $todelete = true;
938         }
940         if ($todelete) {
941             //Delete the format
942             $DB->delete_records('glossary_formats', array('name'=>$format->name));
943             //Reasign existing glossaries to default (dictionary) format
944             if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
945                 foreach($glossaries as $glossary) {
946                     $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
947                 }
948             }
949         }
950     }
952     //Now everything is ready in glossary_formats table
953     $formats = $DB->get_records("glossary_formats");
955     return $formats;
958 /**
959  * @param bool $debug
960  * @param string $text
961  * @param int $br
962  */
963 function glossary_debug($debug,$text,$br=1) {
964     if ( $debug ) {
965         echo '<font color="red">' . $text . '</font>';
966         if ( $br ) {
967             echo '<br />';
968         }
969     }
972 /**
973  *
974  * @global object
975  * @param int $glossaryid
976  * @param string $entrylist
977  * @param string $pivot
978  * @return array
979  */
980 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
981     global $DB;
982     if ($pivot) {
983        $pivot .= ",";
984     }
986     return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
987                                    FROM {glossary_entries}
988                                   WHERE glossaryid = ?
989                                         AND id IN ($entrylist)", array($glossaryid));
992 /**
993  * @global object
994  * @global object
995  * @param object $concept
996  * @param string $courseid
997  * @return array
998  */
999 function glossary_get_entries_search($concept, $courseid) {
1000     global $CFG, $DB;
1002     //Check if the user is an admin
1003     $bypassadmin = 1; //This means NO (by default)
1004     if (has_capability('moodle/course:viewhiddenactivities', context_system::instance())) {
1005         $bypassadmin = 0; //This means YES
1006     }
1008     //Check if the user is a teacher
1009     $bypassteacher = 1; //This means NO (by default)
1010     if (has_capability('mod/glossary:manageentries', context_course::instance($courseid))) {
1011         $bypassteacher = 0; //This means YES
1012     }
1014     $conceptlower = textlib::strtolower(trim($concept));
1016     $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
1018     return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
1019                                    FROM {glossary_entries} e, {glossary} g,
1020                                         {course_modules} cm, {modules} m
1021                                   WHERE m.name = 'glossary' AND
1022                                         cm.module = m.id AND
1023                                         (cm.visible = 1 OR  cm.visible = $bypassadmin OR
1024                                             (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
1025                                         g.id = cm.instance AND
1026                                         e.glossaryid = g.id  AND
1027                                         ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
1028                                           (e.casesensitive = 0 and concept = :concept)) AND
1029                                         (g.course = :courseid2 OR g.globalglossary = 1) AND
1030                                          e.usedynalink != 0 AND
1031                                          g.usedynalink != 0", $params);
1034 /**
1035  * @global object
1036  * @global object
1037  * @param object $course
1038  * @param object $course
1039  * @param object $glossary
1040  * @param object $entry
1041  * @param string $mode
1042  * @param string $hook
1043  * @param int $printicons
1044  * @param int $displayformat
1045  * @param bool $printview
1046  * @return mixed
1047  */
1048 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $printview = false) {
1049     global $USER, $CFG;
1050     $return = false;
1051     if ( $displayformat < 0 ) {
1052         $displayformat = $glossary->displayformat;
1053     }
1054     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
1055         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1056         if ($printview) {
1057             $functionname = 'glossary_print_entry_'.$displayformat;
1058         } else {
1059             $functionname = 'glossary_show_entry_'.$displayformat;
1060         }
1062         if (file_exists($formatfile)) {
1063             include_once($formatfile);
1064             if (function_exists($functionname)) {
1065                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
1066             } else if ($printview) {
1067                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
1068                 $return = glossary_print_entry_default($entry, $glossary, $cm);
1069             }
1070         }
1071     }
1072     return $return;
1075 /**
1076  * Default (old) print format used if custom function doesn't exist in format
1077  *
1078  * @param object $entry
1079  * @param object $glossary
1080  * @param object $cm
1081  * @return void Output is echo'd
1082  */
1083 function glossary_print_entry_default ($entry, $glossary, $cm) {
1084     global $CFG;
1086     require_once($CFG->libdir . '/filelib.php');
1088     echo '<h3>'. strip_tags($entry->concept) . ': </h3>';
1090     $definition = $entry->definition;
1092     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
1094     $context = context_module::instance($cm->id);
1095     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
1097     $options = new stdClass();
1098     $options->para = false;
1099     $options->trusted = $entry->definitiontrust;
1100     $options->context = $context;
1101     $options->overflowdiv = true;
1102     $definition = format_text($definition, $entry->definitionformat, $options);
1103     echo ($definition);
1104     echo '<br /><br />';
1107 /**
1108  * Print glossary concept/term as a heading &lt;h3>
1109  * @param object $entry
1110  */
1111 function  glossary_print_entry_concept($entry, $return=false) {
1112     global $OUTPUT;
1114     $text = html_writer::tag('h3', format_string($entry->concept));
1115     if (!empty($entry->highlight)) {
1116         $text = highlight($entry->highlight, $text);
1117     }
1119     if ($return) {
1120         return $text;
1121     } else {
1122         echo $text;
1123     }
1126 /**
1127  *
1128  * @global moodle_database DB
1129  * @param object $entry
1130  * @param object $glossary
1131  * @param object $cm
1132  */
1133 function glossary_print_entry_definition($entry, $glossary, $cm) {
1134     global $DB, $GLOSSARY_EXCLUDECONCEPTS;
1136     $definition = $entry->definition;
1138     //Calculate all the strings to be no-linked
1139     //First, the concept
1140     $GLOSSARY_EXCLUDECONCEPTS = array($entry->concept);
1141     //Now the aliases
1142     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
1143         foreach ($aliases as $alias) {
1144             $GLOSSARY_EXCLUDECONCEPTS[]=trim($alias->alias);
1145         }
1146     }
1148     $context = context_module::instance($cm->id);
1149     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
1151     $options = new stdClass();
1152     $options->para = false;
1153     $options->trusted = $entry->definitiontrust;
1154     $options->context = $context;
1155     $options->overflowdiv = true;
1157     $text = format_text($definition, $entry->definitionformat, $options);
1159     // Stop excluding concepts from autolinking
1160     unset($GLOSSARY_EXCLUDECONCEPTS);
1162     if (!empty($entry->highlight)) {
1163         $text = highlight($entry->highlight, $text);
1164     }
1165     if (isset($entry->footer)) {   // Unparsed footer info
1166         $text .= $entry->footer;
1167     }
1168     echo $text;
1171 /**
1172  *
1173  * @global object
1174  * @param object $course
1175  * @param object $cm
1176  * @param object $glossary
1177  * @param object $entry
1178  * @param string $mode
1179  * @param string $hook
1180  * @param string $type
1181  * @return string|void
1182  */
1183 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
1184     global $DB;
1186     $return = '';
1187     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
1188         foreach ($aliases as $alias) {
1189             if (trim($alias->alias)) {
1190                 if ($return == '') {
1191                     $return = '<select id="keyword" style="font-size:8pt">';
1192                 }
1193                 $return .= "<option>$alias->alias</option>";
1194             }
1195         }
1196         if ($return != '') {
1197             $return .= '</select>';
1198         }
1199     }
1200     if ($type == 'print') {
1201         echo $return;
1202     } else {
1203         return $return;
1204     }
1207 /**
1208  *
1209  * @global object
1210  * @global object
1211  * @global object
1212  * @param object $course
1213  * @param object $cm
1214  * @param object $glossary
1215  * @param object $entry
1216  * @param string $mode
1217  * @param string $hook
1218  * @param string $type
1219  * @return string|void
1220  */
1221 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
1222     global $USER, $CFG, $DB, $OUTPUT;
1224     $context = context_module::instance($cm->id);
1226     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
1227     $importedentry = ($entry->sourceglossaryid == $glossary->id);
1228     $ismainglossary = $glossary->mainglossary;
1231     $return = '<span class="commands">';
1232     // Differentiate links for each entry.
1233     $altsuffix = ': '.strip_tags(format_text($entry->concept));
1235     if (!$entry->approved) {
1236         $output = true;
1237         $return .= get_string('entryishidden','glossary');
1238     }
1240     $iscurrentuser = ($entry->userid == $USER->id);
1242     if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $iscurrentuser)) {
1243         // only teachers can export entries so check it out
1244         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
1245             $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
1246             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
1247                 $output = true;
1248                 $return .= ' <a title="'.get_string('exporttomainglossary','glossary') . '" href="exportentry.php?id='.$entry->id.'&amp;prevmode='.$mode.'&amp;hook='.urlencode($hook).'"><img src="'.$OUTPUT->pix_url('export', 'glossary').'" class="iconsmall" alt="'.get_string('exporttomainglossary','glossary').$altsuffix.'" /></a>';
1249             }
1250         }
1252         if ( $entry->sourceglossaryid ) {
1253             $icon = $OUTPUT->pix_url('minus', 'glossary');   // graphical metaphor (minus) for deleting an imported entry
1254         } else {
1255             $icon = $OUTPUT->pix_url('t/delete');
1256         }
1258         //Decide if an entry is editable:
1259         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
1260         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1261         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
1262         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1263             $output = true;
1264             $return .= " <a title=\"" . get_string("delete") . "\" href=\"deleteentry.php?id=$cm->id&amp;mode=delete&amp;entry=$entry->id&amp;prevmode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"";
1265             $return .= $icon;
1266             $return .= "\" class=\"iconsmall\" alt=\"" . get_string("delete") .$altsuffix."\" /></a> ";
1268             $return .= " <a title=\"" . get_string("edit") . "\" href=\"edit.php?cmid=$cm->id&amp;id=$entry->id&amp;mode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"" . $OUTPUT->pix_url('t/edit') . "\" class=\"iconsmall\" alt=\"" . get_string("edit") .$altsuffix. "\" /></a>";
1269         } elseif ( $importedentry ) {
1270             $return .= " <font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1271         }
1272     }
1273     if (!empty($CFG->enableportfolios) && (has_capability('mod/glossary:exportentry', $context) || ($iscurrentuser && has_capability('mod/glossary:exportownentry', $context)))) {
1274         require_once($CFG->libdir . '/portfoliolib.php');
1275         $button = new portfolio_add_button();
1276         $button->set_callback_options('glossary_entry_portfolio_caller',  array('id' => $cm->id, 'entryid' => $entry->id), 'mod_glossary');
1278         $filecontext = $context;
1279         if ($entry->sourceglossaryid == $cm->instance) {
1280             if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1281                 $filecontext = context_module::instance($maincm->id);
1282             }
1283         }
1284         $fs = get_file_storage();
1285         if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)
1286          || $files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'entry', $entry->id, "timemodified", false)) {
1288             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1289         } else {
1290             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1291         }
1293         $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1294     }
1295     $return .= "&nbsp;&nbsp;"; // just to make up a little the output in Mozilla ;)
1297     $return .= '</span>';
1299     if (!empty($CFG->usecomments) && has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1300         require_once($CFG->dirroot . '/comment/lib.php');
1301         $cmt = new stdClass();
1302         $cmt->component = 'mod_glossary';
1303         $cmt->context  = $context;
1304         $cmt->course   = $course;
1305         $cmt->cm       = $cm;
1306         $cmt->area     = 'glossary_entry';
1307         $cmt->itemid   = $entry->id;
1308         $cmt->showcount = true;
1309         $comment = new comment($cmt);
1310         $return .= '<div>'.$comment->output(true).'</div>';
1311         $output = true;
1312     }
1314     //If we haven't calculated any REAL thing, delete result ($return)
1315     if (!$output) {
1316         $return = '';
1317     }
1318     //Print or get
1319     if ($type == 'print') {
1320         echo $return;
1321     } else {
1322         return $return;
1323     }
1326 /**
1327  * @param object $course
1328  * @param object $cm
1329  * @param object $glossary
1330  * @param object $entry
1331  * @param string $mode
1332  * @param object $hook
1333  * @param bool $printicons
1334  * @param bool $aliases
1335  * @return void
1336  */
1337 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1338     if ($aliases) {
1339         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1340     }
1341     $icons   = '';
1342     if ($printicons) {
1343         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1344     }
1345     if ($aliases || $icons || !empty($entry->rating)) {
1346         echo '<table>';
1347         if ( $aliases ) {
1348             echo '<tr valign="top"><td class="aliases">' .
1349                  '<label for="keyword">' . get_string('aliases','glossary').': </label>' .
1350                  $aliases . '</td></tr>';
1351         }
1352         if ($icons) {
1353             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1354         }
1355         if (!empty($entry->rating)) {
1356             echo '<tr valign="top"><td class="ratings">';
1357             glossary_print_entry_ratings($course, $entry);
1358             echo '</td></tr>';
1359         }
1360         echo '</table>';
1361     }
1364 /**
1365  * @todo Document this function
1366  */
1367 function glossary_print_entry_attachment($entry, $cm, $format=NULL, $align="right", $insidetable=true) {
1368 ///   valid format values: html  : Return the HTML link for the attachment as an icon
1369 ///                        text  : Return the HTML link for tha attachment as text
1370 ///                        blank : Print the output to the screen
1371     if ($entry->attachment) {
1372           if ($insidetable) {
1373               echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
1374           }
1375           echo glossary_print_attachments($entry, $cm, $format, $align);
1376           if ($insidetable) {
1377               echo "</td></tr></table>\n";
1378           }
1379     }
1382 /**
1383  * @global object
1384  * @param object $cm
1385  * @param object $entry
1386  * @param string $mode
1387  * @param string $align
1388  * @param bool $insidetable
1389  */
1390 function  glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1391     global $CFG, $OUTPUT;
1393     if ($mode == 'approval' and !$entry->approved) {
1394         if ($insidetable) {
1395             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1396         }
1397         echo '<a title="'.get_string('approve','glossary').'" href="approve.php?eid='.$entry->id.'&amp;mode='.$mode.'&amp;sesskey='.sesskey().'"><img align="'.$align.'" src="'.$OUTPUT->pix_url('i/approve') . '" style="border:0px; width:34px; height:34px" alt="'.get_string('approve','glossary').'" /></a>';
1398         if ($insidetable) {
1399             echo '</td></tr></table>';
1400         }
1401     }
1404 /**
1405  * It returns all entries from all glossaries that matches the specified criteria
1406  *  within a given $course. It performs an $extended search if necessary.
1407  * It restrict the search to only one $glossary if the $glossary parameter is set.
1408  *
1409  * @global object
1410  * @global object
1411  * @param object $course
1412  * @param array $searchterms
1413  * @param int $extended
1414  * @param object $glossary
1415  * @return array
1416  */
1417 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1418     global $CFG, $DB;
1420     if ( !$glossary ) {
1421         if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1422             $glos = "";
1423             foreach ( $glossaries as $glossary ) {
1424                 $glos .= "$glossary->id,";
1425             }
1426             $glos = substr($glos,0,-1);
1427         }
1428     } else {
1429         $glos = $glossary->id;
1430     }
1432     if (!has_capability('mod/glossary:manageentries', context_course::instance($glossary->course))) {
1433         $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1434         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1435         $onlyvisibletable = ", {course_modules} cm";
1436     } else {
1438         $onlyvisible = "";
1439         $onlyvisibletable = "";
1440     }
1442     if ($DB->sql_regex_supported()) {
1443         $REGEXP    = $DB->sql_regex(true);
1444         $NOTREGEXP = $DB->sql_regex(false);
1445     }
1447     $searchcond = array();
1448     $params     = array();
1449     $i = 0;
1451     $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1454     foreach ($searchterms as $searchterm) {
1455         $i++;
1457         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1458                    /// will use it to simulate the "-" operator with LIKE clause
1460     /// Under Oracle and MSSQL, trim the + and - operators and perform
1461     /// simpler LIKE (or NOT LIKE) queries
1462         if (!$DB->sql_regex_supported()) {
1463             if (substr($searchterm, 0, 1) == '-') {
1464                 $NOT = true;
1465             }
1466             $searchterm = trim($searchterm, '+-');
1467         }
1469         // TODO: +- may not work for non latin languages
1471         if (substr($searchterm,0,1) == '+') {
1472             $searchterm = trim($searchterm, '+-');
1473             $searchterm = preg_quote($searchterm, '|');
1474             $searchcond[] = "$concat $REGEXP :ss$i";
1475             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1477         } else if (substr($searchterm,0,1) == "-") {
1478             $searchterm = trim($searchterm, '+-');
1479             $searchterm = preg_quote($searchterm, '|');
1480             $searchcond[] = "$concat $NOTREGEXP :ss$i";
1481             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1483         } else {
1484             $searchcond[] = $DB->sql_like($concat, ":ss$i", false, true, $NOT);
1485             $params['ss'.$i] = "%$searchterm%";
1486         }
1487     }
1489     if (empty($searchcond)) {
1490         $totalcount = 0;
1491         return array();
1492     }
1494     $searchcond = implode(" AND ", $searchcond);
1496     $sql = "SELECT e.*
1497               FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1498              WHERE $searchcond
1499                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1500                AND g.id IN ($glos) AND e.approved <> 0";
1502     return $DB->get_records_sql($sql, $params);
1505 /**
1506  * @global object
1507  * @param array $searchterms
1508  * @param object $glossary
1509  * @param bool $extended
1510  * @return array
1511  */
1512 function glossary_search_entries($searchterms, $glossary, $extended) {
1513     global $DB;
1515     $course = $DB->get_record("course", array("id"=>$glossary->course));
1516     return glossary_search($course,$searchterms,$extended,$glossary);
1519 /**
1520  * if return=html, then return a html string.
1521  * if return=text, then return a text-only string.
1522  * otherwise, print HTML for non-images, and return image HTML
1523  *     if attachment is an image, $align set its aligment.
1524  *
1525  * @global object
1526  * @global object
1527  * @param object $entry
1528  * @param object $cm
1529  * @param string $type html, txt, empty
1530  * @param string $align left or right
1531  * @return string image string or nothing depending on $type param
1532  */
1533 function glossary_print_attachments($entry, $cm, $type=NULL, $align="left") {
1534     global $CFG, $DB, $OUTPUT;
1536     if (!$context = context_module::instance($cm->id, IGNORE_MISSING)) {
1537         return '';
1538     }
1540     if ($entry->sourceglossaryid == $cm->instance) {
1541         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1542             return '';
1543         }
1544         $filecontext = context_module::instance($maincm->id);
1546     } else {
1547         $filecontext = $context;
1548     }
1550     $strattachment = get_string('attachment', 'glossary');
1552     $fs = get_file_storage();
1554     $imagereturn = '';
1555     $output = '';
1557     if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1558         foreach ($files as $file) {
1559             $filename = $file->get_filename();
1560             $mimetype = $file->get_mimetype();
1561             $iconimage = $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file), 'moodle', array('class' => 'icon'));
1562             $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename);
1564             if ($type == 'html') {
1565                 $output .= "<a href=\"$path\">$iconimage</a> ";
1566                 $output .= "<a href=\"$path\">".s($filename)."</a>";
1567                 $output .= "<br />";
1569             } else if ($type == 'text') {
1570                 $output .= "$strattachment ".s($filename).":\n$path\n";
1572             } else {
1573                 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1574                     // Image attachments don't get printed as links
1575                     $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1576                 } else {
1577                     $output .= "<a href=\"$path\">$iconimage</a> ";
1578                     $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context));
1579                     $output .= '<br />';
1580                 }
1581             }
1582         }
1583     }
1585     if ($type) {
1586         return $output;
1587     } else {
1588         echo $output;
1589         return $imagereturn;
1590     }
1593 ////////////////////////////////////////////////////////////////////////////////
1594 // File API                                                                   //
1595 ////////////////////////////////////////////////////////////////////////////////
1597 /**
1598  * Lists all browsable file areas
1599  *
1600  * @package  mod_glossary
1601  * @category files
1602  * @param stdClass $course course object
1603  * @param stdClass $cm course module object
1604  * @param stdClass $context context object
1605  * @return array
1606  */
1607 function glossary_get_file_areas($course, $cm, $context) {
1608     return array(
1609         'attachment' => get_string('areaattachment', 'mod_glossary'),
1610         'entry' => get_string('areaentry', 'mod_glossary'),
1611     );
1614 /**
1615  * File browsing support for glossary module.
1616  *
1617  * @param file_browser $browser
1618  * @param array $areas
1619  * @param stdClass $course
1620  * @param cm_info $cm
1621  * @param context $context
1622  * @param string $filearea
1623  * @param int $itemid
1624  * @param string $filepath
1625  * @param string $filename
1626  * @return file_info_stored file_info_stored instance or null if not found
1627  */
1628 function glossary_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
1629     global $CFG, $DB, $USER;
1631     if ($context->contextlevel != CONTEXT_MODULE) {
1632         return null;
1633     }
1635     if (!isset($areas[$filearea])) {
1636         return null;
1637     }
1639     if (is_null($itemid)) {
1640         require_once($CFG->dirroot.'/mod/glossary/locallib.php');
1641         return new glossary_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
1642     }
1644     if (!$entry = $DB->get_record('glossary_entries', array('id' => $itemid))) {
1645         return null;
1646     }
1648     if (!$glossary = $DB->get_record('glossary', array('id' => $cm->instance))) {
1649         return null;
1650     }
1652     if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1653         return null;
1654     }
1656     // this trickery here is because we need to support source glossary access
1657     if ($entry->glossaryid == $cm->instance) {
1658         $filecontext = $context;
1659     } else if ($entry->sourceglossaryid == $cm->instance) {
1660         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1661             return null;
1662         }
1663         $filecontext = context_module::instance($maincm->id);
1664     } else {
1665         return null;
1666     }
1668     $fs = get_file_storage();
1669     $filepath = is_null($filepath) ? '/' : $filepath;
1670     $filename = is_null($filename) ? '.' : $filename;
1671     if (!($storedfile = $fs->get_file($filecontext->id, 'mod_glossary', $filearea, $itemid, $filepath, $filename))) {
1672         return null;
1673     }
1675     // Checks to see if the user can manage files or is the owner.
1676     // TODO MDL-33805 - Do not use userid here and move the capability check above.
1677     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
1678         return null;
1679     }
1681     $urlbase = $CFG->wwwroot.'/pluginfile.php';
1683     return new file_info_stored($browser, $filecontext, $storedfile, $urlbase, s($entry->concept), true, true, false, false);
1686 /**
1687  * Serves the glossary attachments. Implements needed access control ;-)
1688  *
1689  * @package  mod_glossary
1690  * @category files
1691  * @param stdClass $course course object
1692  * @param stdClass $cm course module object
1693  * @param stdClsss $context context object
1694  * @param string $filearea file area
1695  * @param array $args extra arguments
1696  * @param bool $forcedownload whether or not force download
1697  * @param array $options additional options affecting the file serving
1698  * @return bool false if file not found, does not return if found - justsend the file
1699  */
1700 function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
1701     global $CFG, $DB;
1703     if ($context->contextlevel != CONTEXT_MODULE) {
1704         return false;
1705     }
1707     require_course_login($course, true, $cm);
1709     if ($filearea === 'attachment' or $filearea === 'entry') {
1710         $entryid = (int)array_shift($args);
1712         require_course_login($course, true, $cm);
1714         if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1715             return false;
1716         }
1718         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1719             return false;
1720         }
1722         if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1723             return false;
1724         }
1726         // this trickery here is because we need to support source glossary access
1728         if ($entry->glossaryid == $cm->instance) {
1729             $filecontext = $context;
1731         } else if ($entry->sourceglossaryid == $cm->instance) {
1732             if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1733                 return false;
1734             }
1735             $filecontext = context_module::instance($maincm->id);
1737         } else {
1738             return false;
1739         }
1741         $relativepath = implode('/', $args);
1742         $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath";
1744         $fs = get_file_storage();
1745         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1746             return false;
1747         }
1749         // finally send the file
1750         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
1752     } else if ($filearea === 'export') {
1753         require_login($course, false, $cm);
1754         require_capability('mod/glossary:export', $context);
1756         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1757             return false;
1758         }
1760         $cat = array_shift($args);
1761         $cat = clean_param($cat, PARAM_ALPHANUM);
1763         $filename = clean_filename(strip_tags(format_string($glossary->name)).'.xml');
1764         $content = glossary_generate_export_file($glossary, NULL, $cat);
1766         send_file($content, $filename, 0, 0, true, true);
1767     }
1769     return false;
1772 /**
1773  *
1774  */
1775 function glossary_print_tabbed_table_end() {
1776      echo "</div></div>";
1779 /**
1780  * @param object $cm
1781  * @param object $glossary
1782  * @param string $mode
1783  * @param string $hook
1784  * @param string $sortkey
1785  * @param string $sortorder
1786  */
1787 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1788     if ($glossary->showalphabet) {
1789         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1790     }
1791     glossary_print_special_links($cm, $glossary, $mode, $hook);
1793     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1795     glossary_print_all_links($cm, $glossary, $mode, $hook);
1797     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1799 /**
1800  * @param object $cm
1801  * @param object $glossary
1802  * @param string $hook
1803  * @param string $sortkey
1804  * @param string $sortorder
1805  */
1806 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1807     echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1810 /**
1811  * @param object $cm
1812  * @param object $glossary
1813  * @param string $hook
1814  * @param string $sortkey
1815  * @param string $sortorder
1816  */
1817 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1818     echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1820 /**
1821  * @param object $cm
1822  * @param object $glossary
1823  * @param string $hook
1824  * @param string $sortkey
1825  * @param string $sortorder
1826  */
1827 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1828     if ( $mode != 'date' ) {
1829         if ($glossary->showalphabet) {
1830             echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1831         }
1833         glossary_print_special_links($cm, $glossary, $mode, $hook);
1835         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1837         glossary_print_all_links($cm, $glossary, $mode, $hook);
1838     } else {
1839         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1840     }
1843 /**
1844  * @param object $cm
1845  * @param object $glossary
1846  * @param string $hook
1847  * @param string $sortkey
1848  * @param string $sortorder
1849  */
1850 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1851     if ($glossary->showalphabet) {
1852         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1853     }
1855     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1856     glossary_print_all_links($cm, $glossary, $mode, $hook);
1857     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1860 /**
1861  * @global object
1862  * @global object
1863  * @param object $cm
1864  * @param object $glossary
1865  * @param string $hook
1866  * @param object $category
1867  */
1868 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1869      global $CFG, $DB, $OUTPUT;
1871      $context = context_module::instance($cm->id);
1873     // Prepare format_string/text options
1874     $fmtoptions = array(
1875         'context' => $context);
1877      echo '<table border="0" width="100%">';
1878      echo '<tr>';
1880      echo '<td align="center" style="width:20%">';
1881      if (has_capability('mod/glossary:managecategories', $context)) {
1882              $options['id'] = $cm->id;
1883              $options['mode'] = 'cat';
1884              $options['hook'] = $hook;
1885              echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1886      }
1887      echo '</td>';
1889      echo '<td align="center" style="width:60%">';
1890      echo '<b>';
1892      $menu = array();
1893      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1894      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1896      $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1897      $selected = '';
1898      if ( $categories ) {
1899           foreach ($categories as $currentcategory) {
1900                  $url = $currentcategory->id;
1901                  if ( $category ) {
1902                      if ($currentcategory->id == $category->id) {
1903                          $selected = $url;
1904                      }
1905                  }
1906                  $menu[$url] = format_string($currentcategory->name, true, $fmtoptions);
1907           }
1908      }
1909      if ( !$selected ) {
1910          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1911      }
1913      if ( $category ) {
1914         echo format_string($category->name, true, $fmtoptions);
1915      } else {
1916         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1918             echo get_string("entrieswithoutcategory","glossary");
1919             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1921         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1923             echo get_string("allcategories","glossary");
1924             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1926         }
1927      }
1928      echo '</b></td>';
1929      echo '<td align="center" style="width:20%">';
1931      $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1932      $select->set_label(get_string('categories', 'glossary'), array('class' => 'accesshide'));
1933      echo $OUTPUT->render($select);
1935      echo '</td>';
1936      echo '</tr>';
1938      echo '</table>';
1941 /**
1942  * @global object
1943  * @param object $cm
1944  * @param object $glossary
1945  * @param string $mode
1946  * @param string $hook
1947  */
1948 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1949 global $CFG;
1950      if ( $glossary->showall) {
1951          $strallentries       = get_string("allentries", "glossary");
1952          if ( $hook == 'ALL' ) {
1953               echo "<b>$strallentries</b>";
1954          } else {
1955               $strexplainall = strip_tags(get_string("explainall","glossary"));
1956               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1957          }
1958      }
1961 /**
1962  * @global object
1963  * @param object $cm
1964  * @param object $glossary
1965  * @param string $mode
1966  * @param string $hook
1967  */
1968 function glossary_print_special_links($cm, $glossary, $mode, $hook) {
1969 global $CFG;
1970      if ( $glossary->showspecial) {
1971          $strspecial          = get_string("special", "glossary");
1972          if ( $hook == 'SPECIAL' ) {
1973               echo "<b>$strspecial</b> | ";
1974          } else {
1975               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1976               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
1977          }
1978      }
1981 /**
1982  * @global object
1983  * @param object $glossary
1984  * @param string $mode
1985  * @param string $hook
1986  * @param string $sortkey
1987  * @param string $sortorder
1988  */
1989 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1990 global $CFG;
1991      if ( $glossary->showalphabet) {
1992           $alphabet = explode(",", get_string('alphabet', 'langconfig'));
1993           for ($i = 0; $i < count($alphabet); $i++) {
1994               if ( $hook == $alphabet[$i] and $hook) {
1995                    echo "<b>$alphabet[$i]</b>";
1996               } else {
1997                    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>";
1998               }
1999               echo ' | ';
2000           }
2001      }
2004 /**
2005  * @global object
2006  * @param object $cm
2007  * @param string $mode
2008  * @param string $sortkey
2009  * @param string $sortorder
2010  */
2011 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
2012     global $CFG, $OUTPUT;
2014     $asc    = get_string("ascending","glossary");
2015     $desc   = get_string("descending","glossary");
2016     $bopen  = '<b>';
2017     $bclose = '</b>';
2019      $neworder = '';
2020      $currentorder = '';
2021      $currentsort = '';
2022      if ( $sortorder ) {
2023          if ( $sortorder == 'asc' ) {
2024              $currentorder = $asc;
2025              $neworder = '&amp;sortorder=desc';
2026              $newordertitle = get_string('changeto', 'glossary', $desc);
2027          } else {
2028              $currentorder = $desc;
2029              $neworder = '&amp;sortorder=asc';
2030              $newordertitle = get_string('changeto', 'glossary', $asc);
2031          }
2032          $icon = " <img src=\"".$OUTPUT->pix_url($sortorder, 'glossary')."\" class=\"icon\" alt=\"$newordertitle\" />";
2033      } else {
2034          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
2035                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
2036              $icon = "";
2037              $newordertitle = $asc;
2038          } else {
2039              $newordertitle = $desc;
2040              $neworder = '&amp;sortorder=desc';
2041              $icon = ' <img src="'.$OUTPUT->pix_url('asc', 'glossary').'" class="icon" alt="'.$newordertitle.'" />';
2042          }
2043      }
2044      $ficon     = '';
2045      $fneworder = '';
2046      $fbtag     = '';
2047      $fendbtag  = '';
2049      $sicon     = '';
2050      $sneworder = '';
2052      $sbtag      = '';
2053      $fbtag      = '';
2054      $fendbtag      = '';
2055      $sendbtag      = '';
2057      $sendbtag  = '';
2059      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
2060          $ficon       = $icon;
2061          $fneworder   = $neworder;
2062          $fordertitle = $newordertitle;
2063          $sordertitle = $asc;
2064          $fbtag       = $bopen;
2065          $fendbtag    = $bclose;
2066      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
2067          $sicon = $icon;
2068          $sneworder   = $neworder;
2069          $fordertitle = $asc;
2070          $sordertitle = $newordertitle;
2071          $sbtag       = $bopen;
2072          $sendbtag    = $bclose;
2073      } else {
2074          $fordertitle = $asc;
2075          $sordertitle = $asc;
2076      }
2078      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
2079          $forder = 'CREATION';
2080          $sorder =  'UPDATE';
2081          $fsort  = get_string("sortbycreation", "glossary");
2082          $ssort  = get_string("sortbylastupdate", "glossary");
2084          $currentsort = $fsort;
2085          if ($sortkey == 'UPDATE') {
2086              $currentsort = $ssort;
2087          }
2088          $sort        = get_string("sortchronogically", "glossary");
2089      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
2090          $forder = 'FIRSTNAME';
2091          $sorder =  'LASTNAME';
2092          $fsort  = get_string("firstname");
2093          $ssort  = get_string("lastname");
2095          $currentsort = $fsort;
2096          if ($sortkey == 'LASTNAME') {
2097              $currentsort = $ssort;
2098          }
2099          $sort        = get_string("sortby", "glossary");
2100      }
2101      $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
2102      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 | ".
2103                           "$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 />";
2106 /**
2107  *
2108  * @param object $entry0
2109  * @param object $entry1
2110  * @return int [-1 | 0 | 1]
2111  */
2112 function glossary_sort_entries ( $entry0, $entry1 ) {
2114     if ( textlib::strtolower(ltrim($entry0->concept)) < textlib::strtolower(ltrim($entry1->concept)) ) {
2115         return -1;
2116     } elseif ( textlib::strtolower(ltrim($entry0->concept)) > textlib::strtolower(ltrim($entry1->concept)) ) {
2117         return 1;
2118     } else {
2119         return 0;
2120     }
2124 /**
2125  * @global object
2126  * @global object
2127  * @global object
2128  * @param object $course
2129  * @param object $entry
2130  * @return bool
2131  */
2132 function  glossary_print_entry_ratings($course, $entry) {
2133     global $OUTPUT;
2134     if( !empty($entry->rating) ){
2135         echo $OUTPUT->render($entry->rating);
2136     }
2139 /**
2140  *
2141  * @global object
2142  * @global object
2143  * @global object
2144  * @param int $courseid
2145  * @param array $entries
2146  * @param int $displayformat
2147  */
2148 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
2149     global $USER,$CFG, $DB;
2151     echo '<div class="boxaligncenter">';
2152     echo '<table class="glossarypopup" cellspacing="0"><tr>';
2153     echo '<td>';
2154     if ( $entries ) {
2155         foreach ( $entries as $entry ) {
2156             if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
2157                 print_error('invalidid', 'glossary');
2158             }
2159             if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
2160                 print_error('coursemisconf');
2161             }
2162             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
2163                 print_error('invalidid', 'glossary');
2164             }
2166             //If displayformat is present, override glossary->displayformat
2167             if ($displayformat < 0) {
2168                 $dp = $glossary->displayformat;
2169             } else {
2170                 $dp = $displayformat;
2171             }
2173             //Get popupformatname
2174             $format = $DB->get_record('glossary_formats', array('name'=>$dp));
2175             $displayformat = $format->popupformatname;
2177             //Check displayformat variable and set to default if necessary
2178             if (!$displayformat) {
2179                 $displayformat = 'dictionary';
2180             }
2182             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
2183             $functionname = 'glossary_show_entry_'.$displayformat;
2185             if (file_exists($formatfile)) {
2186                 include_once($formatfile);
2187                 if (function_exists($functionname)) {
2188                     $functionname($course, $cm, $glossary, $entry,'','','','');
2189                 }
2190             }
2191         }
2192     }
2193     echo '</td>';
2194     echo '</tr></table></div>';
2197 /**
2198  *
2199  * @global object
2200  * @param array $entries
2201  * @param array $aliases
2202  * @param array $categories
2203  * @return string
2204  */
2205 function glossary_generate_export_csv($entries, $aliases, $categories) {
2206     global $CFG;
2207     $csv = '';
2208     $delimiter = '';
2209     require_once($CFG->libdir . '/csvlib.class.php');
2210     $delimiter = csv_import_reader::get_delimiter('comma');
2211     $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
2212     $csvaliases = array(0 => array());
2213     $csvcategories = array(0 => array());
2214     $aliascount = 0;
2215     $categorycount = 0;
2217     foreach ($entries as $entry) {
2218         $thisaliasesentry = array();
2219         $thiscategoriesentry = array();
2220         $thiscsventry = array($entry->concept, nl2br($entry->definition));
2222         if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
2223             $thiscount = count($aliases[$entry->id]);
2224             if ($thiscount > $aliascount) {
2225                 $aliascount = $thiscount;
2226             }
2227             foreach ($aliases[$entry->id] as $alias) {
2228                 $thisaliasesentry[] = trim($alias);
2229             }
2230         }
2231         if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
2232             $thiscount = count($categories[$entry->id]);
2233             if ($thiscount > $categorycount) {
2234                 $categorycount = $thiscount;
2235             }
2236             foreach ($categories[$entry->id] as $catentry) {
2237                 $thiscategoriesentry[] = trim($catentry);
2238             }
2239         }
2240         $csventries[$entry->id] = $thiscsventry;
2241         $csvaliases[$entry->id] = $thisaliasesentry;
2242         $csvcategories[$entry->id] = $thiscategoriesentry;
2244     }
2245     $returnstr = '';
2246     foreach ($csventries as $id => $row) {
2247         $aliasstr = '';
2248         $categorystr = '';
2249         if ($id == 0) {
2250             $aliasstr = get_string('alias', 'glossary');
2251             $categorystr = get_string('category', 'glossary');
2252         }
2253         $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
2254         $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
2255     }
2256     return $returnstr;
2259 /**
2260  *
2261  * @param object $glossary
2262  * @param string $ignored invalid parameter
2263  * @param int|string $hook
2264  * @return string
2265  */
2266 function glossary_generate_export_file($glossary, $ignored = "", $hook = 0) {
2267     global $CFG, $DB;
2269     $co  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2271     $co .= glossary_start_tag("GLOSSARY",0,true);
2272     $co .= glossary_start_tag("INFO",1,true);
2273         $co .= glossary_full_tag("NAME",2,false,$glossary->name);
2274         $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
2275         $co .= glossary_full_tag("INTROFORMAT",2,false,$glossary->introformat);
2276         $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
2277         $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
2278         $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
2279         $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
2280         $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
2281         $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
2282         $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
2283         $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
2284         $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
2285         $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
2287         if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) {
2288             $co .= glossary_start_tag("ENTRIES",2,true);
2289             foreach ($entries as $entry) {
2290                 $permissiongranted = 1;
2291                 if ( $hook ) {
2292                     switch ( $hook ) {
2293                     case "ALL":
2294                     case "SPECIAL":
2295                     break;
2296                     default:
2297                         $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
2298                     break;
2299                     }
2300                 }
2301                 if ( $hook ) {
2302                     switch ( $hook ) {
2303                     case GLOSSARY_SHOW_ALL_CATEGORIES:
2304                     break;
2305                     case GLOSSARY_SHOW_NOT_CATEGORISED:
2306                         $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id));
2307                     break;
2308                     default:
2309                         $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook));
2310                     break;
2311                     }
2312                 }
2313                 if ( $entry->approved and $permissiongranted ) {
2314                     $co .= glossary_start_tag("ENTRY",3,true);
2315                     $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
2316                     $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition);
2317                     $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat); // note: use old name for BC reasons
2318                     $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
2319                     $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
2320                     $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
2321                     $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
2323                     if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) {
2324                         $co .= glossary_start_tag("ALIASES",4,true);
2325                         foreach ($aliases as $alias) {
2326                             $co .= glossary_start_tag("ALIAS",5,true);
2327                                 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
2328                             $co .= glossary_end_tag("ALIAS",5,true);
2329                         }
2330                         $co .= glossary_end_tag("ALIASES",4,true);
2331                     }
2332                     if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) {
2333                         $co .= glossary_start_tag("CATEGORIES",4,true);
2334                         foreach ($catentries as $catentry) {
2335                             $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid));
2337                             $co .= glossary_start_tag("CATEGORY",5,true);
2338                                 $co .= glossary_full_tag("NAME",6,false,$category->name);
2339                                 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
2340                             $co .= glossary_end_tag("CATEGORY",5,true);
2341                         }
2342                         $co .= glossary_end_tag("CATEGORIES",4,true);
2343                     }
2345                     $co .= glossary_end_tag("ENTRY",3,true);
2346                 }
2347             }
2348             $co .= glossary_end_tag("ENTRIES",2,true);
2350         }
2353     $co .= glossary_end_tag("INFO",1,true);
2354     $co .= glossary_end_tag("GLOSSARY",0,true);
2356     return $co;
2358 /// Functions designed by Eloy Lafuente
2359 /// Functions to create, open and write header of the xml file
2361 /**
2362  * Read import file and convert to current charset
2363  *
2364  * @global object
2365  * @param string $file
2366  * @return string
2367  */
2368 function glossary_read_imported_file($file_content) {
2369     require_once "../../lib/xmlize.php";
2370     global $CFG;
2372     return xmlize($file_content, 0);
2375 /**
2376  * Return the xml start tag
2377  *
2378  * @param string $tag
2379  * @param int $level
2380  * @param bool $endline
2381  * @return string
2382  */
2383 function glossary_start_tag($tag,$level=0,$endline=false) {
2384         if ($endline) {
2385            $endchar = "\n";
2386         } else {
2387            $endchar = "";
2388         }
2389         return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
2392 /**
2393  * Return the xml end tag
2394  * @param string $tag
2395  * @param int $level
2396  * @param bool $endline
2397  * @return string
2398  */
2399 function glossary_end_tag($tag,$level=0,$endline=true) {
2400         if ($endline) {
2401            $endchar = "\n";
2402         } else {
2403            $endchar = "";
2404         }
2405         return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
2408 /**
2409  * Return the start tag, the contents and the end tag
2410  *
2411  * @global object
2412  * @param string $tag
2413  * @param int $level
2414  * @param bool $endline
2415  * @param string $content
2416  * @return string
2417  */
2418 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
2419         global $CFG;
2421         $st = glossary_start_tag($tag,$level,$endline);
2422         $co = preg_replace("/\r\n|\r/", "\n", s($content));
2423         $et = glossary_end_tag($tag,0,true);
2424         return $st.$co.$et;
2427 /**
2428  * How many unrated entries are in the given glossary for a given user?
2429  *
2430  * @global moodle_database $DB
2431  * @param int $glossaryid
2432  * @param int $userid
2433  * @return int
2434  */
2435 function glossary_count_unrated_entries($glossaryid, $userid) {
2436     global $DB;
2438     $sql = "SELECT COUNT('x') as num
2439               FROM {glossary_entries}
2440              WHERE glossaryid = :glossaryid AND
2441                    userid <> :userid";
2442     $params = array('glossaryid' => $glossaryid, 'userid' => $userid);
2443     $entries = $DB->count_records_sql($sql, $params);
2445     if ($entries) {
2446         // We need to get the contextid for the glossaryid we have been given.
2447         $sql = "SELECT ctx.id
2448                   FROM {context} ctx
2449                   JOIN {course_modules} cm ON cm.id = ctx.instanceid
2450                   JOIN {modules} m ON m.id = cm.module
2451                   JOIN {glossary} g ON g.id = cm.instance
2452                  WHERE ctx.contextlevel = :contextlevel AND
2453                        m.name = 'glossary' AND
2454                        g.id = :glossaryid";
2455         $contextid = $DB->get_field_sql($sql, array('glossaryid' => $glossaryid, 'contextlevel' => CONTEXT_MODULE));
2457         // Now we need to count the ratings that this user has made
2458         $sql = "SELECT COUNT('x') AS num
2459                   FROM {glossary_entries} e
2460                   JOIN {rating} r ON r.itemid = e.id
2461                  WHERE e.glossaryid = :glossaryid AND
2462                        r.userid = :userid AND
2463                        r.component = 'mod_glossary' AND
2464                        r.ratingarea = 'entry' AND
2465                        r.contextid = :contextid";
2466         $params = array('glossaryid' => $glossaryid, 'userid' => $userid, 'contextid' => $contextid);
2467         $rated = $DB->count_records_sql($sql, $params);
2468         if ($rated) {
2469             // The number or enties minus the number or rated entries equals the number of unrated
2470             // entries
2471             if ($entries > $rated) {
2472                 return $entries - $rated;
2473             } else {
2474                 return 0;    // Just in case there was a counting error
2475             }
2476         } else {
2477             return (int)$entries;
2478         }
2479     } else {
2480         return 0;
2481     }
2484 /**
2485  *
2486  * Returns the html code to represent any pagging bar. Paramenters are:
2487  *
2488  * The function dinamically show the first and last pages, and "scroll" over pages.
2489  * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
2490  * could replace the general one. ;-)
2491  *
2492  * @param int $totalcount total number of records to be displayed
2493  * @param int $page page currently selected (0 based)
2494  * @param int $perpage number of records per page
2495  * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically.
2496  *
2497  * @param int $maxpageallowed Optional maximum number of page allowed.
2498  * @param int $maxdisplay Optional maximum number of page links to show in the bar
2499  * @param string $separator Optional string to be used between pages in the bar
2500  * @param string $specialtext Optional string to be showed as an special link
2501  * @param string $specialvalue Optional value (page) to be used in the special link
2502  * @param bool $previousandnext Optional to decide if we want the previous and next links
2503  * @return string
2504  */
2505 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) {
2507     $code = '';
2509     $showspecial = false;
2510     $specialselected = false;
2512     //Check if we have to show the special link
2513     if (!empty($specialtext)) {
2514         $showspecial = true;
2515     }
2516     //Check if we are with the special link selected
2517     if ($showspecial && $page == $specialvalue) {
2518         $specialselected = true;
2519     }
2521     //If there are results (more than 1 page)
2522     if ($totalcount > $perpage) {
2523         $code .= "<div style=\"text-align:center\">";
2524         $code .= "<p>".get_string("page").":";
2526         $maxpage = (int)(($totalcount-1)/$perpage);
2528         //Lower and upper limit of page
2529         if ($page < 0) {
2530             $page = 0;
2531         }
2532         if ($page > $maxpageallowed) {
2533             $page = $maxpageallowed;
2534         }
2535         if ($page > $maxpage) {
2536             $page = $maxpage;
2537         }
2539         //Calculate the window of pages
2540         $pagefrom = $page - ((int)($maxdisplay / 2));
2541         if ($pagefrom < 0) {
2542             $pagefrom = 0;
2543         }
2544         $pageto = $pagefrom + $maxdisplay - 1;
2545         if ($pageto > $maxpageallowed) {
2546             $pageto = $maxpageallowed;
2547         }
2548         if ($pageto > $maxpage) {
2549             $pageto = $maxpage;
2550         }
2552         //Some movements can be necessary if don't see enought pages
2553         if ($pageto - $pagefrom < $maxdisplay - 1) {
2554             if ($pageto - $maxdisplay + 1 > 0) {
2555                 $pagefrom = $pageto - $maxdisplay + 1;
2556             }
2557         }
2559         //Calculate first and last if necessary
2560         $firstpagecode = '';
2561         $lastpagecode = '';
2562         if ($pagefrom > 0) {
2563             $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2564             if ($pagefrom > 1) {
2565                 $firstpagecode .= "$separator...";
2566             }
2567         }
2568         if ($pageto < $maxpage) {
2569             if ($pageto < $maxpage -1) {
2570                 $lastpagecode = "$separator...";
2571             }
2572             $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2573         }
2575         //Previous
2576         if ($page > 0 && $previousandnext) {
2577             $pagenum = $page - 1;
2578             $code .= "&nbsp;(<a  href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;";
2579         }
2581         //Add first
2582         $code .= $firstpagecode;
2584         $pagenum = $pagefrom;
2586         //List of maxdisplay pages
2587         while ($pagenum <= $pageto) {
2588             $pagetoshow = $pagenum +1;
2589             if ($pagenum == $page && !$specialselected) {
2590                 $code .= "$separator<b>$pagetoshow</b>";
2591             } else {
2592                 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2593             }
2594             $pagenum++;
2595         }
2597         //Add last
2598         $code .= $lastpagecode;
2600         //Next
2601         if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2602             $pagenum = $page + 1;
2603             $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2604         }
2606         //Add special
2607         if ($showspecial) {
2608             $code .= '<br />';
2609             if ($specialselected) {
2610                 $code .= "<b>$specialtext</b>";
2611             } else {
2612                 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2613             }
2614         }
2616         //End html
2617         $code .= "</p>";
2618         $code .= "</div>";
2619     }
2621     return $code;
2623 /**
2624  * @return array
2625  */
2626 function glossary_get_view_actions() {
2627     return array('view','view all','view entry');
2629 /**
2630  * @return array
2631  */
2632 function glossary_get_post_actions() {
2633     return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry');
2637 /**
2638  * Implementation of the function for printing the form elements that control
2639  * whether the course reset functionality affects the glossary.
2640  * @param object $mform form passed by reference
2641  */
2642 function glossary_reset_course_form_definition(&$mform) {
2643     $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary'));
2644     $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary'));
2646     $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'),
2647                        array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple'));
2648     $mform->setAdvanced('reset_glossary_types');
2649     $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked');
2651     $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary'));
2652     $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked');
2654     $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings'));
2655     $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked');
2657     $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments'));
2658     $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked');
2661 /**
2662  * Course reset form defaults.
2663  * @return array
2664  */
2665 function glossary_reset_course_form_defaults($course) {
2666     return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0);
2669 /**
2670  * Removes all grades from gradebook
2671  *
2672  * @param int $courseid The ID of the course to reset
2673  * @param string $type The optional type of glossary. 'main', 'secondary' or ''
2674  */
2675 function glossary_reset_gradebook($courseid, $type='') {
2676     global $DB;
2678     switch ($type) {
2679         case 'main'      : $type = "AND g.mainglossary=1"; break;
2680         case 'secondary' : $type = "AND g.mainglossary=0"; break;
2681         default          : $type = ""; //all
2682     }
2684     $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid
2685               FROM {glossary} g, {course_modules} cm, {modules} m
2686              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type";
2688     if ($glossarys = $DB->get_records_sql($sql, array($courseid))) {
2689         foreach ($glossarys as $glossary) {
2690             glossary_grade_item_update($glossary, 'reset');
2691         }
2692     }
2694 /**
2695  * Actual implementation of the reset course functionality, delete all the
2696  * glossary responses for course $data->courseid.
2697  *
2698  * @global object
2699  * @param $data the data submitted from the reset course.
2700  * @return array status array
2701  */
2702 function glossary_reset_userdata($data) {
2703     global $CFG, $DB;
2704     require_once($CFG->dirroot.'/rating/lib.php');
2706     $componentstr = get_string('modulenameplural', 'glossary');
2707     $status = array();
2709     $allentriessql = "SELECT e.id
2710                         FROM {glossary_entries} e
2711                              JOIN {glossary} g ON e.glossaryid = g.id
2712                        WHERE g.course = ?";
2714     $allglossariessql = "SELECT g.id
2715                            FROM {glossary} g
2716                           WHERE g.course = ?";
2718     $params = array($data->courseid);
2720     $fs = get_file_storage();
2722     $rm = new rating_manager();
2723     $ratingdeloptions = new stdClass;
2724     $ratingdeloptions->component = 'mod_glossary';
2725     $ratingdeloptions->ratingarea = 'entry';
2727     // delete entries if requested
2728     if (!empty($data->reset_glossary_all)
2729          or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) {
2731         $params[] = 'glossary_entry';
2732         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea=?", $params);
2733         $DB->delete_records_select('glossary_alias',    "entryid IN ($allentriessql)", $params);
2734         $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2736         // now get rid of all attachments
2737         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2738             foreach ($glossaries as $glossaryid=>$unused) {
2739                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2740                     continue;
2741                 }
2742                 $context = context_module::instance($cm->id);
2743                 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2745                 //delete ratings
2746                 $ratingdeloptions->contextid = $context->id;
2747                 $rm->delete_ratings($ratingdeloptions);
2748             }
2749         }
2751         // remove all grades from gradebook
2752         if (empty($data->reset_gradebook_grades)) {
2753             glossary_reset_gradebook($data->courseid);
2754         }
2756         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2758     } else if (!empty($data->reset_glossary_types)) {
2759         $mainentriessql         = "$allentriessql AND g.mainglossary=1";
2760         $secondaryentriessql    = "$allentriessql AND g.mainglossary=0";
2762         $mainglossariessql      = "$allglossariessql AND g.mainglossary=1";
2763         $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2765         if (in_array('main', $data->reset_glossary_types)) {
2766             $params[] = 'glossary_entry';
2767             $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params);
2768             $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2770             if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2771                 foreach ($glossaries as $glossaryid=>$unused) {
2772                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2773                         continue;
2774                     }
2775                     $context = context_module::instance($cm->id);
2776                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2778                     //delete ratings
2779                     $ratingdeloptions->contextid = $context->id;
2780                     $rm->delete_ratings($ratingdeloptions);
2781                 }
2782             }
2784             // remove all grades from gradebook
2785             if (empty($data->reset_gradebook_grades)) {
2786                 glossary_reset_gradebook($data->courseid, 'main');
2787             }
2789             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('mainglossary', 'glossary'), 'error'=>false);
2791         } else if (in_array('secondary', $data->reset_glossary_types)) {
2792             $params[] = 'glossary_entry';
2793             $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params);
2794             $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2795             // remove exported source flag from entries in main glossary
2796             $DB->execute("UPDATE {glossary_entries}
2797                              SET sourceglossaryid=0
2798                            WHERE glossaryid IN ($mainglossariessql)", $params);
2800             if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2801                 foreach ($glossaries as $glossaryid=>$unused) {
2802                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2803                         continue;
2804                     }
2805                     $context = context_module::instance($cm->id);
2806                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2808                     //delete ratings
2809                     $ratingdeloptions->contextid = $context->id;
2810                     $rm->delete_ratings($ratingdeloptions);
2811                 }
2812             }
2814             // remove all grades from gradebook
2815             if (empty($data->reset_gradebook_grades)) {
2816                 glossary_reset_gradebook($data->courseid, 'secondary');
2817             }
2819             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2820         }
2821     }
2823     // remove entries by users not enrolled into course
2824     if (!empty($data->reset_glossary_notenrolled)) {
2825         $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2826                          FROM {glossary_entries} e
2827                               JOIN {glossary} g ON e.glossaryid = g.id
2828                               LEFT JOIN {user} u ON e.userid = u.id
2829                         WHERE g.course = ? AND e.userid > 0";
2831         $course_context = context_course::instance($data->courseid);
2832         $notenrolled = array();
2833         $rs = $DB->get_recordset_sql($entriessql, $params);
2834         if ($rs->valid()) {
2835             foreach ($rs as $entry) {
2836                 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2837                   or !is_enrolled($course_context , $entry->userid)) {
2838                     $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id));
2839                     $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2841                     if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2842                         $context = context_module::instance($cm->id);
2843                         $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
2845                         //delete ratings
2846                         $ratingdeloptions->contextid = $context->id;
2847                         $rm->delete_ratings($ratingdeloptions);
2848                     }
2849                 }
2850             }
2851             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2852         }
2853         $rs->close();
2854     }
2856     // remove all ratings
2857     if (!empty($data->reset_glossary_ratings)) {
2858         //remove ratings
2859         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2860             foreach ($glossaries as $glossaryid=>$unused) {
2861                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2862                     continue;
2863                 }
2864                 $context = context_module::instance($cm->id);
2866                 //delete ratings
2867                 $ratingdeloptions->contextid = $context->id;
2868                 $rm->delete_ratings($ratingdeloptions);
2869             }
2870         }
2872         // remove all grades from gradebook
2873         if (empty($data->reset_gradebook_grades)) {
2874             glossary_reset_gradebook($data->courseid);
2875         }
2876         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2877     }
2879     // remove comments
2880     if (!empty($data->reset_glossary_comments)) {
2881         $params[] = 'glossary_entry';
2882         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params);
2883         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2884     }
2886     /// updating dates - shift may be negative too
2887     if ($data->timeshift) {
2888         shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
2889         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2890     }
2892     return $status;
2895 /**
2896  * Returns all other caps used in module
2897  * @return array
2898  */
2899 function glossary_get_extra_capabilities() {
2900     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');
2903 /**
2904  * @param string $feature FEATURE_xx constant for requested feature
2905  * @return mixed True if module supports feature, null if doesn't know
2906  */
2907 function glossary_supports($feature) {
2908     switch($feature) {
2909         case FEATURE_GROUPS:                  return false;
2910         case FEATURE_GROUPINGS:               return false;
2911         case FEATURE_GROUPMEMBERSONLY:        return true;
2912         case FEATURE_MOD_INTRO:               return true;
2913         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2914         case FEATURE_COMPLETION_HAS_RULES:    return true;
2915         case FEATURE_GRADE_HAS_GRADE:         return true;
2916         case FEATURE_GRADE_OUTCOMES:          return true;
2917         case FEATURE_RATE:                    return true;
2918         case FEATURE_BACKUP_MOODLE2:          return true;
2919         case FEATURE_SHOW_DESCRIPTION:        return true;
2921         default: return null;
2922     }
2925 /**
2926  * Obtains the automatic completion state for this glossary based on any conditions
2927  * in glossary settings.
2928  *
2929  * @global object
2930  * @global object
2931  * @param object $course Course
2932  * @param object $cm Course-module
2933  * @param int $userid User ID
2934  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
2935  * @return bool True if completed, false if not. (If no conditions, then return
2936  *   value depends on comparison type)
2937  */
2938 function glossary_get_completion_state($course,$cm,$userid,$type) {
2939     global $CFG, $DB;
2941     // Get glossary details
2942     if (!($glossary=$DB->get_record('glossary',array('id'=>$cm->instance)))) {
2943         throw new Exception("Can't find glossary {$cm->instance}");
2944     }
2946     $result=$type; // Default return value
2948     if ($glossary->completionentries) {
2949         $value = $glossary->completionentries <=
2950                  $DB->count_records('glossary_entries',array('glossaryid'=>$glossary->id, 'userid'=>$userid, 'approved'=>1));
2951         if ($type == COMPLETION_AND) {
2952             $result = $result && $value;
2953         } else {
2954             $result = $result || $value;
2955         }
2956     }
2958     return $result;
2961 function glossary_extend_navigation($navigation, $course, $module, $cm) {
2962     global $CFG;
2963     $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'letter')));
2964     $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'cat')));
2965     $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'date')));
2966     $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'author')));
2969 /**
2970  * Adds module specific settings to the settings block
2971  *
2972  * @param settings_navigation $settings The settings navigation object
2973  * @param navigation_node $glossarynode The node to add module settings to
2974  */
2975 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
2976     global $PAGE, $DB, $CFG, $USER;
2978     $mode = optional_param('mode', '', PARAM_ALPHA);
2979     $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
2981     if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
2982         $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
2983     }
2985     if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
2986         $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
2987     }
2989     if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
2990         $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
2991     }
2993     if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
2994         $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
2995     }
2997     $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
2999     if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles && has_capability('mod/glossary:view', $PAGE->cm->context)) {
3000         require_once("$CFG->libdir/rsslib.php");
3002         $string = get_string('rsstype','forum');
3004         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_glossary', $glossary->id));
3005         $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3006     }
3009 /**
3010  * Running addtional permission check on plugin, for example, plugins
3011  * may have switch to turn on/off comments option, this callback will
3012  * affect UI display, not like pluginname_comment_validate only throw
3013  * exceptions.
3014  * Capability check has been done in comment->check_permissions(), we
3015  * don't need to do it again here.
3016  *
3017  * @package  mod_glossary
3018  * @category comment
3019  *
3020  * @param stdClass $comment_param {
3021  *              context  => context the context object
3022  *              courseid => int course id
3023  *              cm       => stdClass course module object
3024  *              commentarea => string comment area
3025  *              itemid      => int itemid
3026  * }
3027  * @return array
3028  */
3029 function glossary_comment_permissions($comment_param) {
3030     return array('post'=>true, 'view'=>true);
3033 /**
3034  * Validate comment parameter before perform other comments actions
3035  *
3036  * @package  mod_glossary
3037  * @category comment
3038  *
3039  * @param stdClass $comment_param {
3040  *              context  => context the context object
3041  *              courseid => int course id
3042  *              cm       => stdClass course module object
3043  *              commentarea => string comment area
3044  *              itemid      => int itemid
3045  * }
3046  * @return boolean
3047  */
3048 function glossary_comment_validate($comment_param) {
3049     global $DB;
3050     // validate comment area
3051     if ($comment_param->commentarea != 'glossary_entry') {
3052         throw new comment_exception('invalidcommentarea');
3053     }
3054     if (!$record = $DB->get_record('glossary_entries', array('id'=>$comment_param->itemid))) {
3055         throw new comment_exception('invalidcommentitemid');
3056     }
3057     if ($record->sourceglossaryid && $record->sourceglossaryid == $comment_param->cm->instance) {
3058         $glossary = $DB->get_record('glossary', array('id'=>$record->sourceglossaryid));
3059     } else {
3060         $glossary = $DB->get_record('glossary', array('id'=>$record->glossaryid));
3061     }
3062     if (!$glossary) {
3063         throw new comment_exception('invalidid', 'data');
3064     }
3065     if (!$course = $DB->get_record('course', array('id'=>$glossary->course))) {
3066         throw new comment_exception('coursemisconf');
3067     }
3068     if (!$cm = get_coursemodule_from_instance('glossary', $glossary->id, $course->id)) {
3069         throw new comment_exception('invalidcoursemodule');
3070     }
3071     $context = context_module::instance($cm->id);
3073     if ($glossary->defaultapproval and !$record->approved and !has_capability('mod/glossary:approve', $context)) {
3074         throw new comment_exception('notapproved', 'glossary');
3075     }
3076     // validate context id
3077     if ($context->id != $comment_param->context->id) {
3078         throw new comment_exception('invalidcontext');
3079     }
3080     // validation for comment deletion
3081     if (!empty($comment_param->commentid)) {
3082         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3083             if ($comment->commentarea != 'glossary_entry') {
3084                 throw new comment_exception('invalidcommentarea');
3085             }
3086             if ($comment->contextid != $comment_param->context->id) {
3087                 throw new comment_exception('invalidcontext');
3088             }
3089             if ($comment->itemid != $comment_param->itemid) {
3090                 throw new comment_exception('invalidcommentitemid');
3091             }
3092         } else {
3093             throw new comment_exception('invalidcommentid');
3094         }
3095     }
3096     return true;
3099 /**
3100  * Return a list of page types
3101  * @param string $pagetype current page type
3102  * @param stdClass $parentcontext Block's parent context
3103  * @param stdClass $currentcontext Current context of block
3104  */
3105 function glossary_page_type_list($pagetype, $parentcontext, $currentcontext) {
3106     $module_pagetype = array(
3107         'mod-glossary-*'=>get_string('page-mod-glossary-x', 'glossary'),
3108         'mod-glossary-view'=>get_string('page-mod-glossary-view', 'glossary'),
3109         'mod-glossary-edit'=>get_string('page-mod-glossary-edit', 'glossary'));
3110     return $module_pagetype;