Merge branch 'MDL-33400' of git://github.com/nebgor/moodle
[moodle.git] / mod / glossary / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of functions and constants for module glossary
20  * (replace glossary with the name of your module and delete this line)
21  *
22  * @package   mod-glossary
23  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
26 require_once($CFG->libdir . '/completionlib.php');
28 define("GLOSSARY_SHOW_ALL_CATEGORIES", 0);
29 define("GLOSSARY_SHOW_NOT_CATEGORISED", -1);
31 define("GLOSSARY_NO_VIEW", -1);
32 define("GLOSSARY_STANDARD_VIEW", 0);
33 define("GLOSSARY_CATEGORY_VIEW", 1);
34 define("GLOSSARY_DATE_VIEW", 2);
35 define("GLOSSARY_AUTHOR_VIEW", 3);
36 define("GLOSSARY_ADDENTRY_VIEW", 4);
37 define("GLOSSARY_IMPORT_VIEW", 5);
38 define("GLOSSARY_EXPORT_VIEW", 6);
39 define("GLOSSARY_APPROVAL_VIEW", 7);
41 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
42 /**
43  * @global object
44  * @param object $glossary
45  * @return int
46  */
47 function glossary_add_instance($glossary) {
48     global $DB;
49 /// Given an object containing all the necessary data,
50 /// (defined by the form in mod_form.php) this function
51 /// will create a new instance and return the id number
52 /// of the new instance.
54     if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
55         $glossary->assesstimestart  = 0;
56         $glossary->assesstimefinish = 0;
57     }
59     if (empty($glossary->globalglossary) ) {
60         $glossary->globalglossary = 0;
61     }
63     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
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', get_context_instance(CONTEXT_SYSTEM))) {
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 = get_context_instance(CONTEXT_MODULE, $cm->id)) {
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 = get_context_instance(CONTEXT_MODULE, $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->entryid     = $entry->entryid;
409         $tmpactivity->content->concept     = $entry->concept;
410         $tmpactivity->content->definition  = $entry->definition;
411         $tmpactivity->user->id             = $entry->userid;
412         $tmpactivity->user->firstname      = $entry->firstname;
413         $tmpactivity->user->lastname       = $entry->lastname;
414         $tmpactivity->user->fullname       = fullname($entry, $viewfullnames);
415         $tmpactivity->user->picture        = $entry->picture;
416         $tmpactivity->user->imagealt       = $entry->imagealt;
417         $tmpactivity->user->email          = $entry->email;
419         $activities[$index++] = $tmpactivity;
420     }
422     return true;
425 /**
426  * Outputs the glossary entry indicated by $activity
427  *
428  * @param object $activity      the activity object the glossary resides in
429  * @param int    $courseid      the id of the course the glossary resides in
430  * @param bool   $detail        not used, but required for compatibilty with other modules
431  * @param int    $modnames      not used, but required for compatibilty with other modules
432  * @param bool   $viewfullnames not used, but required for compatibilty with other modules
433  * @return void
434  */
435 function glossary_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) {
436     global $OUTPUT;
438     echo html_writer::start_tag('div', array('class'=>'glossary-activity clearfix'));
439     if (!empty($activity->user)) {
440         echo html_writer::tag('div', $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid)),
441             array('class' => 'glossary-activity-picture'));
442     }
444     echo html_writer::start_tag('div', array('class'=>'glossary-activity-content'));
445     echo html_writer::start_tag('div', array('class'=>'glossary-activity-entry'));
447     $urlparams = array('g' => $activity->glossaryid, 'mode' => 'entry', 'hook' => $activity->content->entryid);
448     echo html_writer::tag('a', strip_tags($activity->content->concept),
449         array('href' => new moodle_url('/mod/glossary/view.php', $urlparams)));
450     echo html_writer::end_tag('div');
452     $url = new moodle_url('/user/view.php', array('course'=>$courseid, 'id'=>$activity->user->id));
453     $name = $activity->user->fullname;
454     $link = html_writer::link($url, $name);
456     echo html_writer::start_tag('div', array('class'=>'user'));
457     echo $link .' - '. userdate($activity->timestamp);
458     echo html_writer::end_tag('div');
460     echo html_writer::end_tag('div');
462     echo html_writer::end_tag('div');
463     return;
465 /**
466  * Given a course and a time, this module should find recent activity
467  * that has occurred in glossary activities and print it out.
468  * Return true if there was output, or false is there was none.
469  *
470  * @global object
471  * @global object
472  * @global object
473  * @param object $course
474  * @param object $viewfullnames
475  * @param int $timestart
476  * @return bool
477  */
478 function glossary_print_recent_activity($course, $viewfullnames, $timestart) {
479     global $CFG, $USER, $DB, $OUTPUT, $PAGE;
481     //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0
482     if (!defined('GLOSSARY_RECENT_ACTIVITY_LIMIT')) {
483         define('GLOSSARY_RECENT_ACTIVITY_LIMIT', 50);
484     }
485     $modinfo = get_fast_modinfo($course);
486     $ids = array();
488     foreach ($modinfo->cms as $cm) {
489         if ($cm->modname != 'glossary') {
490             continue;
491         }
492         if (!$cm->uservisible) {
493             continue;
494         }
495         $ids[$cm->instance] = $cm->id;
496     }
498     if (!$ids) {
499         return false;
500     }
502     // generate list of approval capabilities for all glossaries in the course.
503     $approvals = array();
504     foreach ($ids as $glinstanceid => $glcmid) {
505         $context = get_context_instance(CONTEXT_MODULE, $glcmid);
506         if (has_capability('mod/glossary:view', $context)) {
507             // get records glossary entries that are approved if user has no capability to approve entries.
508             if (has_capability('mod/glossary:approve', $context)) {
509                 $approvals[] = ' ge.glossaryid = :glsid'.$glinstanceid.' ';
510             } else {
511                 $approvals[] = ' (ge.approved = 1 AND ge.glossaryid = :glsid'.$glinstanceid.') ';
512             }
513             $params['glsid'.$glinstanceid] = $glinstanceid;
514         }
515     }
517     if (count($approvals) == 0) {
518         return false;
519     }
520     $selectsql = 'SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
521                                         '.user_picture::fields('u',null,'userid');
522     $countsql = 'SELECT COUNT(*)';
524     $joins = array(' FROM {glossary_entries} ge ');
525     $joins[] = 'JOIN {user} u ON u.id = ge.userid ';
526     $fromsql = implode($joins, "\n");
528     $params['timestart'] = $timestart;
529     $clausesql = ' WHERE ge.timemodified > :timestart ';
531     if (count($approvals) > 0) {
532         $approvalsql = 'AND ('. implode($approvals, ' OR ') .') ';
533     } else {
534         $approvalsql = '';
535     }
536     $ordersql = 'ORDER BY ge.timemodified ASC';
537     $entries = $DB->get_records_sql($selectsql.$fromsql.$clausesql.$approvalsql.$ordersql, $params, 0, (GLOSSARY_RECENT_ACTIVITY_LIMIT+1));
539     if (empty($entries)) {
540         return false;
541     }
543     echo $OUTPUT->heading(get_string('newentries', 'glossary').':', 3);
544     $strftimerecent = get_string('strftimerecent');
545     $entrycount = 0;
546     foreach ($entries as $entry) {
547         if ($entrycount < GLOSSARY_RECENT_ACTIVITY_LIMIT) {
548             if ($entry->approved) {
549                 $dimmed = '';
550                 $urlparams = array('g' => $entry->glossaryid, 'mode' => 'entry', 'hook' => $entry->id);
551             } else {
552                 $dimmed = ' dimmed_text';
553                 $urlparams = array('id' => $ids[$entry->glossaryid], 'mode' => 'approval', 'hook' => format_text($entry->concept, true));
554             }
555             $link = new moodle_url($CFG->wwwroot.'/mod/glossary/view.php' , $urlparams);
556             echo '<div class="head'.$dimmed.'">';
557             echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
558             echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
559             echo '</div>';
560             echo '<div class="info"><a href="'.$link.'">'.format_string($entry->concept, true).'</a></div>';
561             $entrycount += 1;
562         } else {
563             $numnewentries = $DB->count_records_sql($countsql.$joins[0].$clausesql.$approvalsql.')', $params);
564             echo '<div class="head"><div class="activityhead">'.get_string('andmorenewentries', 'glossary', $numnewentries - GLOSSARY_RECENT_ACTIVITY_LIMIT).'</div></div>';
565             break;
566         }
567     }
569     return true;
572 /**
573  * @global object
574  * @param object $log
575  */
576 function glossary_log_info($log) {
577     global $DB;
579     return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
580                                   FROM {glossary_entries} e, {user} u
581                                  WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
584 /**
585  * Function to be run periodically according to the moodle cron
586  * This function searches for things that need to be done, such
587  * as sending out mail, toggling flags etc ...
588  * @return bool
589  */
590 function glossary_cron () {
591     return true;
594 /**
595  * Return grade for given user or all users.
596  *
597  * @param stdClass $glossary A glossary instance
598  * @param int $userid Optional user id, 0 means all users
599  * @return array An array of grades, false if none
600  */
601 function glossary_get_user_grades($glossary, $userid=0) {
602     global $CFG;
604     require_once($CFG->dirroot.'/rating/lib.php');
606     $ratingoptions = new stdClass;
608     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
609     $ratingoptions->modulename = 'glossary';
610     $ratingoptions->moduleid   = $glossary->id;
611     $ratingoptions->component  = 'mod_glossary';
612     $ratingoptions->ratingarea = 'entry';
614     $ratingoptions->userid = $userid;
615     $ratingoptions->aggregationmethod = $glossary->assessed;
616     $ratingoptions->scaleid = $glossary->scale;
617     $ratingoptions->itemtable = 'glossary_entries';
618     $ratingoptions->itemtableusercolumn = 'userid';
620     $rm = new rating_manager();
621     return $rm->get_user_grades($ratingoptions);
624 /**
625  * Return rating related permissions
626  *
627  * @param int $contextid the context id
628  * @param string $component The component we want to get permissions for
629  * @param string $ratingarea The ratingarea that we want to get permissions for
630  * @return array an associative array of the user's rating permissions
631  */
632 function glossary_rating_permissions($contextid, $component, $ratingarea) {
633     if ($component != 'mod_glossary' || $ratingarea != 'entry') {
634         // We don't know about this component/ratingarea so just return null to get the
635         // default restrictive permissions.
636         return null;
637     }
638     $context = get_context_instance_by_id($contextid);
639     return array(
640         'view'    => has_capability('mod/glossary:viewrating', $context),
641         'viewany' => has_capability('mod/glossary:viewanyrating', $context),
642         'viewall' => has_capability('mod/glossary:viewallratings', $context),
643         'rate'    => has_capability('mod/glossary:rate', $context)
644     );
647 /**
648  * Validates a submitted rating
649  * @param array $params submitted data
650  *            context => object the context in which the rated items exists [required]
651  *            component => The component for this module - should always be mod_forum [required]
652  *            ratingarea => object the context in which the rated items exists [required]
653  *            itemid => int the ID of the object being rated [required]
654  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
655  *            rating => int the submitted rating
656  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
657  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [optional]
658  * @return boolean true if the rating is valid. Will throw rating_exception if not
659  */
660 function glossary_rating_validate($params) {
661     global $DB, $USER;
663     // Check the component is mod_forum
664     if ($params['component'] != 'mod_glossary') {
665         throw new rating_exception('invalidcomponent');
666     }
668     // Check the ratingarea is post (the only rating area in forum)
669     if ($params['ratingarea'] != 'entry') {
670         throw new rating_exception('invalidratingarea');
671     }
673     // Check the rateduserid is not the current user .. you can't rate your own posts
674     if ($params['rateduserid'] == $USER->id) {
675         throw new rating_exception('nopermissiontorate');
676     }
678     $glossarysql = "SELECT g.id as glossaryid, g.scale, g.course, e.userid as userid, e.approved, e.timecreated, g.assesstimestart, g.assesstimefinish
679                       FROM {glossary_entries} e
680                       JOIN {glossary} g ON e.glossaryid = g.id
681                      WHERE e.id = :itemid";
682     $glossaryparams = array('itemid' => $params['itemid']);
683     $info = $DB->get_record_sql($glossarysql, $glossaryparams);
684     if (!$info) {
685         //item doesn't exist
686         throw new rating_exception('invaliditemid');
687     }
689     if ($info->scale != $params['scaleid']) {
690         //the scale being submitted doesnt match the one in the database
691         throw new rating_exception('invalidscaleid');
692     }
694     //check that the submitted rating is valid for the scale
696     // lower limit
697     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
698         throw new rating_exception('invalidnum');
699     }
701     // upper limit
702     if ($info->scale < 0) {
703         //its a custom scale
704         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
705         if ($scalerecord) {
706             $scalearray = explode(',', $scalerecord->scale);
707             if ($params['rating'] > count($scalearray)) {
708                 throw new rating_exception('invalidnum');
709             }
710         } else {
711             throw new rating_exception('invalidscaleid');
712         }
713     } else if ($params['rating'] > $info->scale) {
714         //if its numeric and submitted rating is above maximum
715         throw new rating_exception('invalidnum');
716     }
718     if (!$info->approved) {
719         //item isnt approved
720         throw new rating_exception('nopermissiontorate');
721     }
723     //check the item we're rating was created in the assessable time window
724     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
725         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
726             throw new rating_exception('notavailable');
727         }
728     }
730     $cm = get_coursemodule_from_instance('glossary', $info->glossaryid, $info->course, false, MUST_EXIST);
731     $context = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
733     // if the supplied context doesnt match the item's context
734     if ($context->id != $params['context']->id) {
735         throw new rating_exception('invalidcontext');
736     }
738     return true;
741 /**
742  * Update activity grades
743  *
744  * @category grade
745  * @param stdClass $glossary Null means all glossaries (with extra cmidnumber property)
746  * @param int $userid specific user only, 0 means all
747  * @param bool $nullifnone If true and the user has no grade then a grade item with rawgrade == null will be inserted
748  */
749 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
750     global $CFG, $DB;
751     require_once($CFG->libdir.'/gradelib.php');
753     if (!$glossary->assessed) {
754         glossary_grade_item_update($glossary);
756     } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
757         glossary_grade_item_update($glossary, $grades);
759     } else if ($userid and $nullifnone) {
760         $grade = new stdClass();
761         $grade->userid   = $userid;
762         $grade->rawgrade = NULL;
763         glossary_grade_item_update($glossary, $grade);
765     } else {
766         glossary_grade_item_update($glossary);
767     }
770 /**
771  * Update all grades in gradebook.
772  *
773  * @global object
774  */
775 function glossary_upgrade_grades() {
776     global $DB;
778     $sql = "SELECT COUNT('x')
779               FROM {glossary} g, {course_modules} cm, {modules} m
780              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
781     $count = $DB->count_records_sql($sql);
783     $sql = "SELECT g.*, cm.idnumber AS cmidnumber, g.course AS courseid
784               FROM {glossary} g, {course_modules} cm, {modules} m
785              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
786     $rs = $DB->get_recordset_sql($sql);
787     if ($rs->valid()) {
788         $pbar = new progress_bar('glossaryupgradegrades', 500, true);
789         $i=0;
790         foreach ($rs as $glossary) {
791             $i++;
792             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
793             glossary_update_grades($glossary, 0, false);
794             $pbar->update($i, $count, "Updating Glossary grades ($i/$count).");
795         }
796     }
797     $rs->close();
800 /**
801  * Create/update grade item for given glossary
802  *
803  * @category grade
804  * @param stdClass $glossary object with extra cmidnumber
805  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
806  * @return int, 0 if ok, error code otherwise
807  */
808 function glossary_grade_item_update($glossary, $grades=NULL) {
809     global $CFG;
810     require_once($CFG->libdir.'/gradelib.php');
812     $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
814     if (!$glossary->assessed or $glossary->scale == 0) {
815         $params['gradetype'] = GRADE_TYPE_NONE;
817     } else if ($glossary->scale > 0) {
818         $params['gradetype'] = GRADE_TYPE_VALUE;
819         $params['grademax']  = $glossary->scale;
820         $params['grademin']  = 0;
822     } else if ($glossary->scale < 0) {
823         $params['gradetype'] = GRADE_TYPE_SCALE;
824         $params['scaleid']   = -$glossary->scale;
825     }
827     if ($grades  === 'reset') {
828         $params['reset'] = true;
829         $grades = NULL;
830     }
832     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
835 /**
836  * Delete grade item for given glossary
837  *
838  * @category grade
839  * @param object $glossary object
840  */
841 function glossary_grade_item_delete($glossary) {
842     global $CFG;
843     require_once($CFG->libdir.'/gradelib.php');
845     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
848 /**
849  * @global object
850  * @param int $gloassryid
851  * @param int $scaleid
852  * @return bool
853  */
854 function glossary_scale_used ($glossaryid,$scaleid) {
855 //This function returns if a scale is being used by one glossary
856     global $DB;
858     $return = false;
860     $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
862     if (!empty($rec)  && !empty($scaleid)) {
863         $return = true;
864     }
866     return $return;
869 /**
870  * Checks if scale is being used by any instance of glossary
871  *
872  * This is used to find out if scale used anywhere
873  *
874  * @global object
875  * @param int $scaleid
876  * @return boolean True if the scale is used by any glossary
877  */
878 function glossary_scale_used_anywhere($scaleid) {
879     global $DB;
881     if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
882         return true;
883     } else {
884         return false;
885     }
888 //////////////////////////////////////////////////////////////////////////////////////
889 /// Any other glossary functions go here.  Each of them must have a name that
890 /// starts with glossary_
892 /**
893  * This function return an array of valid glossary_formats records
894  * Everytime it's called, every existing format is checked, new formats
895  * are included if detected and old formats are deleted and any glossary
896  * using an invalid format is updated to the default (dictionary).
897  *
898  * @global object
899  * @global object
900  * @return array
901  */
902 function glossary_get_available_formats() {
903     global $CFG, $DB;
905     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
906     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
907     $pluginformats = array();
908     foreach ($formats as $format) {
909         //If the format file exists
910         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
911             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
912             //If the function exists
913             if (function_exists('glossary_show_entry_'.$format)) {
914                 //Acummulate it as a valid format
915                 $pluginformats[] = $format;
916                 //If the format doesn't exist in the table
917                 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
918                     //Insert the record in glossary_formats
919                     $gf = new stdClass();
920                     $gf->name = $format;
921                     $gf->popupformatname = $format;
922                     $gf->visible = 1;
923                     $DB->insert_record("glossary_formats",$gf);
924                 }
925             }
926         }
927     }
929     //Delete non_existent formats from glossary_formats table
930     $formats = $DB->get_records("glossary_formats");
931     foreach ($formats as $format) {
932         $todelete = false;
933         //If the format in DB isn't a valid previously detected format then delete the record
934         if (!in_array($format->name,$pluginformats)) {
935             $todelete = true;
936         }
938         if ($todelete) {
939             //Delete the format
940             $DB->delete_records('glossary_formats', array('name'=>$format->name));
941             //Reasign existing glossaries to default (dictionary) format
942             if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
943                 foreach($glossaries as $glossary) {
944                     $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
945                 }
946             }
947         }
948     }
950     //Now everything is ready in glossary_formats table
951     $formats = $DB->get_records("glossary_formats");
953     return $formats;
956 /**
957  * @param bool $debug
958  * @param string $text
959  * @param int $br
960  */
961 function glossary_debug($debug,$text,$br=1) {
962     if ( $debug ) {
963         echo '<font color="red">' . $text . '</font>';
964         if ( $br ) {
965             echo '<br />';
966         }
967     }
970 /**
971  *
972  * @global object
973  * @param int $glossaryid
974  * @param string $entrylist
975  * @param string $pivot
976  * @return array
977  */
978 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
979     global $DB;
980     if ($pivot) {
981        $pivot .= ",";
982     }
984     return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
985                                    FROM {glossary_entries}
986                                   WHERE glossaryid = ?
987                                         AND id IN ($entrylist)", array($glossaryid));
990 /**
991  * @global object
992  * @global object
993  * @param object $concept
994  * @param string $courseid
995  * @return array
996  */
997 function glossary_get_entries_search($concept, $courseid) {
998     global $CFG, $DB;
1000     //Check if the user is an admin
1001     $bypassadmin = 1; //This means NO (by default)
1002     if (has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_SYSTEM))) {
1003         $bypassadmin = 0; //This means YES
1004     }
1006     //Check if the user is a teacher
1007     $bypassteacher = 1; //This means NO (by default)
1008     if (has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $courseid))) {
1009         $bypassteacher = 0; //This means YES
1010     }
1012     $conceptlower = textlib::strtolower(trim($concept));
1014     $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
1016     return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
1017                                    FROM {glossary_entries} e, {glossary} g,
1018                                         {course_modules} cm, {modules} m
1019                                   WHERE m.name = 'glossary' AND
1020                                         cm.module = m.id AND
1021                                         (cm.visible = 1 OR  cm.visible = $bypassadmin OR
1022                                             (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
1023                                         g.id = cm.instance AND
1024                                         e.glossaryid = g.id  AND
1025                                         ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
1026                                           (e.casesensitive = 0 and concept = :concept)) AND
1027                                         (g.course = :courseid2 OR g.globalglossary = 1) AND
1028                                          e.usedynalink != 0 AND
1029                                          g.usedynalink != 0", $params);
1032 /**
1033  * @global object
1034  * @global object
1035  * @param object $course
1036  * @param object $course
1037  * @param object $glossary
1038  * @param object $entry
1039  * @param string $mode
1040  * @param string $hook
1041  * @param int $printicons
1042  * @param int $displayformat
1043  * @param bool $printview
1044  * @return mixed
1045  */
1046 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $printview = false) {
1047     global $USER, $CFG;
1048     $return = false;
1049     if ( $displayformat < 0 ) {
1050         $displayformat = $glossary->displayformat;
1051     }
1052     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
1053         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1054         if ($printview) {
1055             $functionname = 'glossary_print_entry_'.$displayformat;
1056         } else {
1057             $functionname = 'glossary_show_entry_'.$displayformat;
1058         }
1060         if (file_exists($formatfile)) {
1061             include_once($formatfile);
1062             if (function_exists($functionname)) {
1063                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
1064             } else if ($printview) {
1065                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
1066                 $return = glossary_print_entry_default($entry, $glossary, $cm);
1067             }
1068         }
1069     }
1070     return $return;
1073 /**
1074  * Default (old) print format used if custom function doesn't exist in format
1075  *
1076  * @param object $entry
1077  * @param object $glossary
1078  * @param object $cm
1079  * @return void Output is echo'd
1080  */
1081 function glossary_print_entry_default ($entry, $glossary, $cm) {
1082     global $CFG;
1084     require_once($CFG->libdir . '/filelib.php');
1086     echo '<h3>'. strip_tags($entry->concept) . ': </h3>';
1088     $definition = $entry->definition;
1090     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
1092     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1093     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
1095     $options = new stdClass();
1096     $options->para = false;
1097     $options->trusted = $entry->definitiontrust;
1098     $options->context = $context;
1099     $options->overflowdiv = true;
1100     $definition = format_text($definition, $entry->definitionformat, $options);
1101     echo ($definition);
1102     echo '<br /><br />';
1105 /**
1106  * Print glossary concept/term as a heading &lt;h3>
1107  * @param object $entry
1108  */
1109 function  glossary_print_entry_concept($entry, $return=false) {
1110     global $OUTPUT;
1112     $text = html_writer::tag('h3', format_string($entry->concept));
1113     if (!empty($entry->highlight)) {
1114         $text = highlight($entry->highlight, $text);
1115     }
1117     if ($return) {
1118         return $text;
1119     } else {
1120         echo $text;
1121     }
1124 /**
1125  *
1126  * @global moodle_database DB
1127  * @param object $entry
1128  * @param object $glossary
1129  * @param object $cm
1130  */
1131 function glossary_print_entry_definition($entry, $glossary, $cm) {
1132     global $DB, $GLOSSARY_EXCLUDECONCEPTS;
1134     $definition = $entry->definition;
1136     //Calculate all the strings to be no-linked
1137     //First, the concept
1138     $GLOSSARY_EXCLUDECONCEPTS = array($entry->concept);
1139     //Now the aliases
1140     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
1141         foreach ($aliases as $alias) {
1142             $GLOSSARY_EXCLUDECONCEPTS[]=trim($alias->alias);
1143         }
1144     }
1146     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1147     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'mod_glossary', 'entry', $entry->id);
1149     $options = new stdClass();
1150     $options->para = false;
1151     $options->trusted = $entry->definitiontrust;
1152     $options->context = $context;
1153     $options->overflowdiv = true;
1155     $text = format_text($definition, $entry->definitionformat, $options);
1157     // Stop excluding concepts from autolinking
1158     unset($GLOSSARY_EXCLUDECONCEPTS);
1160     if (!empty($entry->highlight)) {
1161         $text = highlight($entry->highlight, $text);
1162     }
1163     if (isset($entry->footer)) {   // Unparsed footer info
1164         $text .= $entry->footer;
1165     }
1166     echo $text;
1169 /**
1170  *
1171  * @global object
1172  * @param object $course
1173  * @param object $cm
1174  * @param object $glossary
1175  * @param object $entry
1176  * @param string $mode
1177  * @param string $hook
1178  * @param string $type
1179  * @return string|void
1180  */
1181 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
1182     global $DB;
1184     $return = '';
1185     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
1186         foreach ($aliases as $alias) {
1187             if (trim($alias->alias)) {
1188                 if ($return == '') {
1189                     $return = '<select style="font-size:8pt">';
1190                 }
1191                 $return .= "<option>$alias->alias</option>";
1192             }
1193         }
1194         if ($return != '') {
1195             $return .= '</select>';
1196         }
1197     }
1198     if ($type == 'print') {
1199         echo $return;
1200     } else {
1201         return $return;
1202     }
1205 /**
1206  *
1207  * @global object
1208  * @global object
1209  * @global object
1210  * @param object $course
1211  * @param object $cm
1212  * @param object $glossary
1213  * @param object $entry
1214  * @param string $mode
1215  * @param string $hook
1216  * @param string $type
1217  * @return string|void
1218  */
1219 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
1220     global $USER, $CFG, $DB, $OUTPUT;
1222     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1224     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
1225     $importedentry = ($entry->sourceglossaryid == $glossary->id);
1226     $ismainglossary = $glossary->mainglossary;
1229     $return = '<span class="commands">';
1230     // Differentiate links for each entry.
1231     $altsuffix = ': '.strip_tags(format_text($entry->concept));
1233     if (!$entry->approved) {
1234         $output = true;
1235         $return .= get_string('entryishidden','glossary');
1236     }
1238     $iscurrentuser = ($entry->userid == $USER->id);
1240     if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $iscurrentuser)) {
1241         // only teachers can export entries so check it out
1242         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
1243             $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
1244             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
1245                 $output = true;
1246                 $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>';
1247             }
1248         }
1250         if ( $entry->sourceglossaryid ) {
1251             $icon = $OUTPUT->pix_url('minus', 'glossary');   // graphical metaphor (minus) for deleting an imported entry
1252         } else {
1253             $icon = $OUTPUT->pix_url('t/delete');
1254         }
1256         //Decide if an entry is editable:
1257         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
1258         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1259         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
1260         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1261             $output = true;
1262             $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=\"";
1263             $return .= $icon;
1264             $return .= "\" class=\"iconsmall\" alt=\"" . get_string("delete") .$altsuffix."\" /></a> ";
1266             $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>";
1267         } elseif ( $importedentry ) {
1268             $return .= " <font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1269         }
1270     }
1271     if (!empty($CFG->enableportfolios) && (has_capability('mod/glossary:exportentry', $context) || ($iscurrentuser && has_capability('mod/glossary:exportownentry', $context)))) {
1272         require_once($CFG->libdir . '/portfoliolib.php');
1273         $button = new portfolio_add_button();
1274         $button->set_callback_options('glossary_entry_portfolio_caller',  array('id' => $cm->id, 'entryid' => $entry->id), '/mod/glossary/locallib.php');
1276         $filecontext = $context;
1277         if ($entry->sourceglossaryid == $cm->instance) {
1278             if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1279                 $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1280             }
1281         }
1282         $fs = get_file_storage();
1283         if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1284             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1285         } else {
1286             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1287         }
1289         $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1290     }
1291     $return .= "&nbsp;&nbsp;"; // just to make up a little the output in Mozilla ;)
1293     $return .= '</span>';
1295     if (!empty($CFG->usecomments) && has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1296         require_once($CFG->dirroot . '/comment/lib.php');
1297         $cmt = new stdClass();
1298         $cmt->component = 'mod_glossary';
1299         $cmt->context  = $context;
1300         $cmt->course   = $course;
1301         $cmt->cm       = $cm;
1302         $cmt->area     = 'glossary_entry';
1303         $cmt->itemid   = $entry->id;
1304         $cmt->showcount = true;
1305         $comment = new comment($cmt);
1306         $return .= '<div>'.$comment->output(true).'</div>';
1307         $output = true;
1308     }
1310     //If we haven't calculated any REAL thing, delete result ($return)
1311     if (!$output) {
1312         $return = '';
1313     }
1314     //Print or get
1315     if ($type == 'print') {
1316         echo $return;
1317     } else {
1318         return $return;
1319     }
1322 /**
1323  * @param object $course
1324  * @param object $cm
1325  * @param object $glossary
1326  * @param object $entry
1327  * @param string $mode
1328  * @param object $hook
1329  * @param bool $printicons
1330  * @param bool $aliases
1331  * @return void
1332  */
1333 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1334     if ($aliases) {
1335         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1336     }
1337     $icons   = '';
1338     if ($printicons) {
1339         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1340     }
1341     if ($aliases || $icons || !empty($entry->rating)) {
1342         echo '<table>';
1343         if ( $aliases ) {
1344             echo '<tr valign="top"><td class="aliases">' .
1345                   get_string('aliases','glossary').': '.$aliases . '</td></tr>';
1346         }
1347         if ($icons) {
1348             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1349         }
1350         if (!empty($entry->rating)) {
1351             echo '<tr valign="top"><td class="ratings">';
1352             glossary_print_entry_ratings($course, $entry);
1353             echo '</td></tr>';
1354         }
1355         echo '</table>';
1356     }
1359 /**
1360  * @todo Document this function
1361  */
1362 function glossary_print_entry_attachment($entry, $cm, $format=NULL, $align="right", $insidetable=true) {
1363 ///   valid format values: html  : Return the HTML link for the attachment as an icon
1364 ///                        text  : Return the HTML link for tha attachment as text
1365 ///                        blank : Print the output to the screen
1366     if ($entry->attachment) {
1367           if ($insidetable) {
1368               echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
1369           }
1370           echo glossary_print_attachments($entry, $cm, $format, $align);
1371           if ($insidetable) {
1372               echo "</td></tr></table>\n";
1373           }
1374     }
1377 /**
1378  * @global object
1379  * @param object $cm
1380  * @param object $entry
1381  * @param string $mode
1382  * @param string $align
1383  * @param bool $insidetable
1384  */
1385 function  glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1386     global $CFG, $OUTPUT;
1388     if ($mode == 'approval' and !$entry->approved) {
1389         if ($insidetable) {
1390             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1391         }
1392         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>';
1393         if ($insidetable) {
1394             echo '</td></tr></table>';
1395         }
1396     }
1399 /**
1400  * It returns all entries from all glossaries that matches the specified criteria
1401  *  within a given $course. It performs an $extended search if necessary.
1402  * It restrict the search to only one $glossary if the $glossary parameter is set.
1403  *
1404  * @global object
1405  * @global object
1406  * @param object $course
1407  * @param array $searchterms
1408  * @param int $extended
1409  * @param object $glossary
1410  * @return array
1411  */
1412 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1413     global $CFG, $DB;
1415     if ( !$glossary ) {
1416         if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1417             $glos = "";
1418             foreach ( $glossaries as $glossary ) {
1419                 $glos .= "$glossary->id,";
1420             }
1421             $glos = substr($glos,0,-1);
1422         }
1423     } else {
1424         $glos = $glossary->id;
1425     }
1427     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $glossary->course))) {
1428         $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1429         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1430         $onlyvisibletable = ", {course_modules} cm";
1431     } else {
1433         $onlyvisible = "";
1434         $onlyvisibletable = "";
1435     }
1437     if ($DB->sql_regex_supported()) {
1438         $REGEXP    = $DB->sql_regex(true);
1439         $NOTREGEXP = $DB->sql_regex(false);
1440     }
1442     $searchcond = array();
1443     $params     = array();
1444     $i = 0;
1446     $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1449     foreach ($searchterms as $searchterm) {
1450         $i++;
1452         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1453                    /// will use it to simulate the "-" operator with LIKE clause
1455     /// Under Oracle and MSSQL, trim the + and - operators and perform
1456     /// simpler LIKE (or NOT LIKE) queries
1457         if (!$DB->sql_regex_supported()) {
1458             if (substr($searchterm, 0, 1) == '-') {
1459                 $NOT = true;
1460             }
1461             $searchterm = trim($searchterm, '+-');
1462         }
1464         // TODO: +- may not work for non latin languages
1466         if (substr($searchterm,0,1) == '+') {
1467             $searchterm = trim($searchterm, '+-');
1468             $searchterm = preg_quote($searchterm, '|');
1469             $searchcond[] = "$concat $REGEXP :ss$i";
1470             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1472         } else if (substr($searchterm,0,1) == "-") {
1473             $searchterm = trim($searchterm, '+-');
1474             $searchterm = preg_quote($searchterm, '|');
1475             $searchcond[] = "$concat $NOTREGEXP :ss$i";
1476             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1478         } else {
1479             $searchcond[] = $DB->sql_like($concat, ":ss$i", false, true, $NOT);
1480             $params['ss'.$i] = "%$searchterm%";
1481         }
1482     }
1484     if (empty($searchcond)) {
1485         $totalcount = 0;
1486         return array();
1487     }
1489     $searchcond = implode(" AND ", $searchcond);
1491     $sql = "SELECT e.*
1492               FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1493              WHERE $searchcond
1494                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1495                AND g.id IN ($glos) AND e.approved <> 0";
1497     return $DB->get_records_sql($sql, $params);
1500 /**
1501  * @global object
1502  * @param array $searchterms
1503  * @param object $glossary
1504  * @param bool $extended
1505  * @return array
1506  */
1507 function glossary_search_entries($searchterms, $glossary, $extended) {
1508     global $DB;
1510     $course = $DB->get_record("course", array("id"=>$glossary->course));
1511     return glossary_search($course,$searchterms,$extended,$glossary);
1514 /**
1515  * if return=html, then return a html string.
1516  * if return=text, then return a text-only string.
1517  * otherwise, print HTML for non-images, and return image HTML
1518  *     if attachment is an image, $align set its aligment.
1519  *
1520  * @global object
1521  * @global object
1522  * @param object $entry
1523  * @param object $cm
1524  * @param string $type html, txt, empty
1525  * @param string $align left or right
1526  * @return string image string or nothing depending on $type param
1527  */
1528 function glossary_print_attachments($entry, $cm, $type=NULL, $align="left") {
1529     global $CFG, $DB, $OUTPUT;
1531     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
1532         return '';
1533     }
1535     if ($entry->sourceglossaryid == $cm->instance) {
1536         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1537             return '';
1538         }
1539         $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1541     } else {
1542         $filecontext = $context;
1543     }
1545     $strattachment = get_string('attachment', 'glossary');
1547     $fs = get_file_storage();
1549     $imagereturn = '';
1550     $output = '';
1552     if ($files = $fs->get_area_files($filecontext->id, 'mod_glossary', 'attachment', $entry->id, "timemodified", false)) {
1553         foreach ($files as $file) {
1554             $filename = $file->get_filename();
1555             $mimetype = $file->get_mimetype();
1556             $iconimage = $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file), 'moodle', array('class' => 'icon'));
1557             $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_glossary/attachment/'.$entry->id.'/'.$filename);
1559             if ($type == 'html') {
1560                 $output .= "<a href=\"$path\">$iconimage</a> ";
1561                 $output .= "<a href=\"$path\">".s($filename)."</a>";
1562                 $output .= "<br />";
1564             } else if ($type == 'text') {
1565                 $output .= "$strattachment ".s($filename).":\n$path\n";
1567             } else {
1568                 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1569                     // Image attachments don't get printed as links
1570                     $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1571                 } else {
1572                     $output .= "<a href=\"$path\">$iconimage</a> ";
1573                     $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context));
1574                     $output .= '<br />';
1575                 }
1576             }
1577         }
1578     }
1580     if ($type) {
1581         return $output;
1582     } else {
1583         echo $output;
1584         return $imagereturn;
1585     }
1588 ////////////////////////////////////////////////////////////////////////////////
1589 // File API                                                                   //
1590 ////////////////////////////////////////////////////////////////////////////////
1592 /**
1593  * Lists all browsable file areas
1594  *
1595  * @package  mod_glossary
1596  * @category files
1597  * @param stdClass $course course object
1598  * @param stdClass $cm course module object
1599  * @param stdClass $context context object
1600  * @return array
1601  */
1602 function glossary_get_file_areas($course, $cm, $context) {
1603     return array(
1604         'attachment' => get_string('areaattachment', 'mod_glossary'),
1605         'entry' => get_string('areaentry', 'mod_glossary'),
1606     );
1609 /**
1610  * File browsing support for glossary module.
1611  *
1612  * @param file_browser $browser
1613  * @param array $areas
1614  * @param stdClass $course
1615  * @param cm_info $cm
1616  * @param context $context
1617  * @param string $filearea
1618  * @param int $itemid
1619  * @param string $filepath
1620  * @param string $filename
1621  * @return file_info_stored file_info_stored instance or null if not found
1622  */
1623 function glossary_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
1624     global $CFG, $DB;
1626     if ($context->contextlevel != CONTEXT_MODULE) {
1627         return null;
1628     }
1630     if (!isset($areas[$filearea])) {
1631         return null;
1632     }
1634     if (!has_capability('moodle/course:managefiles', $context)) {
1635         return null;
1636     }
1638     if (is_null($itemid)) {
1639         require_once($CFG->dirroot.'/mod/glossary/locallib.php');
1640         return new glossary_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
1641     }
1643     if (!$entry = $DB->get_record('glossary_entries', array('id' => $itemid))) {
1644         return null;
1645     }
1647     if (!$glossary = $DB->get_record('glossary', array('id' => $cm->instance))) {
1648         return null;
1649     }
1651     if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1652         return null;
1653     }
1655     // this trickery here is because we need to support source glossary access
1656     if ($entry->glossaryid == $cm->instance) {
1657         $filecontext = $context;
1658     } else if ($entry->sourceglossaryid == $cm->instance) {
1659         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1660             return null;
1661         }
1662         $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1663     } else {
1664         return null;
1665     }
1667     $fs = get_file_storage();
1668     $filepath = is_null($filepath) ? '/' : $filepath;
1669     $filename = is_null($filename) ? '.' : $filename;
1670     if (!($storedfile = $fs->get_file($filecontext->id, 'mod_glossary', $filearea, $itemid, $filepath, $filename))) {
1671         return null;
1672     }
1673     $urlbase = $CFG->wwwroot.'/pluginfile.php';
1675     return new file_info_stored($browser, $filecontext, $storedfile, $urlbase, s($entry->concept), true, true, false, false);
1678 /**
1679  * Serves the glossary attachments. Implements needed access control ;-)
1680  *
1681  * @package  mod_glossary
1682  * @category files
1683  * @param stdClass $course course object
1684  * @param stdClass $cm course module object
1685  * @param stdClsss $context context object
1686  * @param string $filearea file area
1687  * @param array $args extra arguments
1688  * @param bool $forcedownload whether or not force download
1689  * @param array $options additional options affecting the file serving
1690  * @return bool false if file not found, does not return if found - justsend the file
1691  */
1692 function glossary_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
1693     global $CFG, $DB;
1695     if ($context->contextlevel != CONTEXT_MODULE) {
1696         return false;
1697     }
1699     require_course_login($course, true, $cm);
1701     if ($filearea === 'attachment' or $filearea === 'entry') {
1702         $entryid = (int)array_shift($args);
1704         require_course_login($course, true, $cm);
1706         if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1707             return false;
1708         }
1710         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1711             return false;
1712         }
1714         if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1715             return false;
1716         }
1718         // this trickery here is because we need to support source glossary access
1720         if ($entry->glossaryid == $cm->instance) {
1721             $filecontext = $context;
1723         } else if ($entry->sourceglossaryid == $cm->instance) {
1724             if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1725                 return false;
1726             }
1727             $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1729         } else {
1730             return false;
1731         }
1733         $relativepath = implode('/', $args);
1734         $fullpath = "/$filecontext->id/mod_glossary/$filearea/$entryid/$relativepath";
1736         $fs = get_file_storage();
1737         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1738             return false;
1739         }
1741         // finally send the file
1742         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
1744     } else if ($filearea === 'export') {
1745         require_login($course, false, $cm);
1746         require_capability('mod/glossary:export', $context);
1748         if (!$glossary = $DB->get_record('glossary', array('id'=>$cm->instance))) {
1749             return false;
1750         }
1752         $cat = array_shift($args);
1753         $cat = clean_param($cat, PARAM_ALPHANUM);
1755         $filename = clean_filename(strip_tags(format_string($glossary->name)).'.xml');
1756         $content = glossary_generate_export_file($glossary, NULL, $cat);
1758         send_file($content, $filename, 0, 0, true, true);
1759     }
1761     return false;
1764 /**
1765  *
1766  */
1767 function glossary_print_tabbed_table_end() {
1768      echo "</div></div>";
1771 /**
1772  * @param object $cm
1773  * @param object $glossary
1774  * @param string $mode
1775  * @param string $hook
1776  * @param string $sortkey
1777  * @param string $sortorder
1778  */
1779 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1780     if ($glossary->showalphabet) {
1781         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1782     }
1783     glossary_print_special_links($cm, $glossary, $mode, $hook);
1785     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1787     glossary_print_all_links($cm, $glossary, $mode, $hook);
1789     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1791 /**
1792  * @param object $cm
1793  * @param object $glossary
1794  * @param string $hook
1795  * @param string $sortkey
1796  * @param string $sortorder
1797  */
1798 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1799     echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1802 /**
1803  * @param object $cm
1804  * @param object $glossary
1805  * @param string $hook
1806  * @param string $sortkey
1807  * @param string $sortorder
1808  */
1809 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1810     echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1812 /**
1813  * @param object $cm
1814  * @param object $glossary
1815  * @param string $hook
1816  * @param string $sortkey
1817  * @param string $sortorder
1818  */
1819 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1820     if ( $mode != 'date' ) {
1821         if ($glossary->showalphabet) {
1822             echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1823         }
1825         glossary_print_special_links($cm, $glossary, $mode, $hook);
1827         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1829         glossary_print_all_links($cm, $glossary, $mode, $hook);
1830     } else {
1831         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1832     }
1835 /**
1836  * @param object $cm
1837  * @param object $glossary
1838  * @param string $hook
1839  * @param string $sortkey
1840  * @param string $sortorder
1841  */
1842 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1843     if ($glossary->showalphabet) {
1844         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1845     }
1847     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1848     glossary_print_all_links($cm, $glossary, $mode, $hook);
1849     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1852 /**
1853  * @global object
1854  * @global object
1855  * @param object $cm
1856  * @param object $glossary
1857  * @param string $hook
1858  * @param object $category
1859  */
1860 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1861      global $CFG, $DB, $OUTPUT;
1863      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1865     // Prepare format_string/text options
1866     $fmtoptions = array(
1867         'context' => $context);
1869      echo '<table border="0" width="100%">';
1870      echo '<tr>';
1872      echo '<td align="center" style="width:20%">';
1873      if (has_capability('mod/glossary:managecategories', $context)) {
1874              $options['id'] = $cm->id;
1875              $options['mode'] = 'cat';
1876              $options['hook'] = $hook;
1877              echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1878      }
1879      echo '</td>';
1881      echo '<td align="center" style="width:60%">';
1882      echo '<b>';
1884      $menu = array();
1885      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1886      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1888      $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1889      $selected = '';
1890      if ( $categories ) {
1891           foreach ($categories as $currentcategory) {
1892                  $url = $currentcategory->id;
1893                  if ( $category ) {
1894                      if ($currentcategory->id == $category->id) {
1895                          $selected = $url;
1896                      }
1897                  }
1898                  $menu[$url] = format_string($currentcategory->name, true, $fmtoptions);
1899           }
1900      }
1901      if ( !$selected ) {
1902          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1903      }
1905      if ( $category ) {
1906         echo format_string($category->name, true, $fmtoptions);
1907      } else {
1908         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1910             echo get_string("entrieswithoutcategory","glossary");
1911             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1913         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1915             echo get_string("allcategories","glossary");
1916             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1918         }
1919      }
1920      echo '</b></td>';
1921      echo '<td align="center" style="width:20%">';
1923      $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1924      echo $OUTPUT->render($select);
1926      echo '</td>';
1927      echo '</tr>';
1929      echo '</table>';
1932 /**
1933  * @global object
1934  * @param object $cm
1935  * @param object $glossary
1936  * @param string $mode
1937  * @param string $hook
1938  */
1939 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1940 global $CFG;
1941      if ( $glossary->showall) {
1942          $strallentries       = get_string("allentries", "glossary");
1943          if ( $hook == 'ALL' ) {
1944               echo "<b>$strallentries</b>";
1945          } else {
1946               $strexplainall = strip_tags(get_string("explainall","glossary"));
1947               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1948          }
1949      }
1952 /**
1953  * @global object
1954  * @param object $cm
1955  * @param object $glossary
1956  * @param string $mode
1957  * @param string $hook
1958  */
1959 function glossary_print_special_links($cm, $glossary, $mode, $hook) {
1960 global $CFG;
1961      if ( $glossary->showspecial) {
1962          $strspecial          = get_string("special", "glossary");
1963          if ( $hook == 'SPECIAL' ) {
1964               echo "<b>$strspecial</b> | ";
1965          } else {
1966               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1967               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
1968          }
1969      }
1972 /**
1973  * @global object
1974  * @param object $glossary
1975  * @param string $mode
1976  * @param string $hook
1977  * @param string $sortkey
1978  * @param string $sortorder
1979  */
1980 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1981 global $CFG;
1982      if ( $glossary->showalphabet) {
1983           $alphabet = explode(",", get_string('alphabet', 'langconfig'));
1984           for ($i = 0; $i < count($alphabet); $i++) {
1985               if ( $hook == $alphabet[$i] and $hook) {
1986                    echo "<b>$alphabet[$i]</b>";
1987               } else {
1988                    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>";
1989               }
1990               echo ' | ';
1991           }
1992      }
1995 /**
1996  * @global object
1997  * @param object $cm
1998  * @param string $mode
1999  * @param string $sortkey
2000  * @param string $sortorder
2001  */
2002 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
2003     global $CFG, $OUTPUT;
2005     $asc    = get_string("ascending","glossary");
2006     $desc   = get_string("descending","glossary");
2007     $bopen  = '<b>';
2008     $bclose = '</b>';
2010      $neworder = '';
2011      $currentorder = '';
2012      $currentsort = '';
2013      if ( $sortorder ) {
2014          if ( $sortorder == 'asc' ) {
2015              $currentorder = $asc;
2016              $neworder = '&amp;sortorder=desc';
2017              $newordertitle = get_string('changeto', 'glossary', $desc);
2018          } else {
2019              $currentorder = $desc;
2020              $neworder = '&amp;sortorder=asc';
2021              $newordertitle = get_string('changeto', 'glossary', $asc);
2022          }
2023          $icon = " <img src=\"".$OUTPUT->pix_url($sortorder, 'glossary')."\" class=\"icon\" alt=\"$newordertitle\" />";
2024      } else {
2025          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
2026                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
2027              $icon = "";
2028              $newordertitle = $asc;
2029          } else {
2030              $newordertitle = $desc;
2031              $neworder = '&amp;sortorder=desc';
2032              $icon = ' <img src="'.$OUTPUT->pix_url('asc', 'glossary').'" class="icon" alt="'.$newordertitle.'" />';
2033          }
2034      }
2035      $ficon     = '';
2036      $fneworder = '';
2037      $fbtag     = '';
2038      $fendbtag  = '';
2040      $sicon     = '';
2041      $sneworder = '';
2043      $sbtag      = '';
2044      $fbtag      = '';
2045      $fendbtag      = '';
2046      $sendbtag      = '';
2048      $sendbtag  = '';
2050      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
2051          $ficon       = $icon;
2052          $fneworder   = $neworder;
2053          $fordertitle = $newordertitle;
2054          $sordertitle = $asc;
2055          $fbtag       = $bopen;
2056          $fendbtag    = $bclose;
2057      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
2058          $sicon = $icon;
2059          $sneworder   = $neworder;
2060          $fordertitle = $asc;
2061          $sordertitle = $newordertitle;
2062          $sbtag       = $bopen;
2063          $sendbtag    = $bclose;
2064      } else {
2065          $fordertitle = $asc;
2066          $sordertitle = $asc;
2067      }
2069      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
2070          $forder = 'CREATION';
2071          $sorder =  'UPDATE';
2072          $fsort  = get_string("sortbycreation", "glossary");
2073          $ssort  = get_string("sortbylastupdate", "glossary");
2075          $currentsort = $fsort;
2076          if ($sortkey == 'UPDATE') {
2077              $currentsort = $ssort;
2078          }
2079          $sort        = get_string("sortchronogically", "glossary");
2080      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
2081          $forder = 'FIRSTNAME';
2082          $sorder =  'LASTNAME';
2083          $fsort  = get_string("firstname");
2084          $ssort  = get_string("lastname");
2086          $currentsort = $fsort;
2087          if ($sortkey == 'LASTNAME') {
2088              $currentsort = $ssort;
2089          }
2090          $sort        = get_string("sortby", "glossary");
2091      }
2092      $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
2093      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 | ".
2094                           "$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 />";
2097 /**
2098  *
2099  * @param object $entry0
2100  * @param object $entry1
2101  * @return int [-1 | 0 | 1]
2102  */
2103 function glossary_sort_entries ( $entry0, $entry1 ) {
2105     if ( textlib::strtolower(ltrim($entry0->concept)) < textlib::strtolower(ltrim($entry1->concept)) ) {
2106         return -1;
2107     } elseif ( textlib::strtolower(ltrim($entry0->concept)) > textlib::strtolower(ltrim($entry1->concept)) ) {
2108         return 1;
2109     } else {
2110         return 0;
2111     }
2115 /**
2116  * @global object
2117  * @global object
2118  * @global object
2119  * @param object $course
2120  * @param object $entry
2121  * @return bool
2122  */
2123 function  glossary_print_entry_ratings($course, $entry) {
2124     global $OUTPUT;
2125     if( !empty($entry->rating) ){
2126         echo $OUTPUT->render($entry->rating);
2127     }
2130 /**
2131  *
2132  * @global object
2133  * @global object
2134  * @global object
2135  * @param int $courseid
2136  * @param array $entries
2137  * @param int $displayformat
2138  */
2139 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
2140     global $USER,$CFG, $DB;
2142     echo '<div class="boxaligncenter">';
2143     echo '<table class="glossarypopup" cellspacing="0"><tr>';
2144     echo '<td>';
2145     if ( $entries ) {
2146         foreach ( $entries as $entry ) {
2147             if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
2148                 print_error('invalidid', 'glossary');
2149             }
2150             if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
2151                 print_error('coursemisconf');
2152             }
2153             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
2154                 print_error('invalidid', 'glossary');
2155             }
2157             //If displayformat is present, override glossary->displayformat
2158             if ($displayformat < 0) {
2159                 $dp = $glossary->displayformat;
2160             } else {
2161                 $dp = $displayformat;
2162             }
2164             //Get popupformatname
2165             $format = $DB->get_record('glossary_formats', array('name'=>$dp));
2166             $displayformat = $format->popupformatname;
2168             //Check displayformat variable and set to default if necessary
2169             if (!$displayformat) {
2170                 $displayformat = 'dictionary';
2171             }
2173             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
2174             $functionname = 'glossary_show_entry_'.$displayformat;
2176             if (file_exists($formatfile)) {
2177                 include_once($formatfile);
2178                 if (function_exists($functionname)) {
2179                     $functionname($course, $cm, $glossary, $entry,'','','','');
2180                 }
2181             }
2182         }
2183     }
2184     echo '</td>';
2185     echo '</tr></table></div>';
2188 /**
2189  *
2190  * @global object
2191  * @param array $entries
2192  * @param array $aliases
2193  * @param array $categories
2194  * @return string
2195  */
2196 function glossary_generate_export_csv($entries, $aliases, $categories) {
2197     global $CFG;
2198     $csv = '';
2199     $delimiter = '';
2200     require_once($CFG->libdir . '/csvlib.class.php');
2201     $delimiter = csv_import_reader::get_delimiter('comma');
2202     $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
2203     $csvaliases = array(0 => array());
2204     $csvcategories = array(0 => array());
2205     $aliascount = 0;
2206     $categorycount = 0;
2208     foreach ($entries as $entry) {
2209         $thisaliasesentry = array();
2210         $thiscategoriesentry = array();
2211         $thiscsventry = array($entry->concept, nl2br($entry->definition));
2213         if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
2214             $thiscount = count($aliases[$entry->id]);
2215             if ($thiscount > $aliascount) {
2216                 $aliascount = $thiscount;
2217             }
2218             foreach ($aliases[$entry->id] as $alias) {
2219                 $thisaliasesentry[] = trim($alias);
2220             }
2221         }
2222         if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
2223             $thiscount = count($categories[$entry->id]);
2224             if ($thiscount > $categorycount) {
2225                 $categorycount = $thiscount;
2226             }
2227             foreach ($categories[$entry->id] as $catentry) {
2228                 $thiscategoriesentry[] = trim($catentry);
2229             }
2230         }
2231         $csventries[$entry->id] = $thiscsventry;
2232         $csvaliases[$entry->id] = $thisaliasesentry;
2233         $csvcategories[$entry->id] = $thiscategoriesentry;
2235     }
2236     $returnstr = '';
2237     foreach ($csventries as $id => $row) {
2238         $aliasstr = '';
2239         $categorystr = '';
2240         if ($id == 0) {
2241             $aliasstr = get_string('alias', 'glossary');
2242             $categorystr = get_string('category', 'glossary');
2243         }
2244         $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
2245         $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
2246     }
2247     return $returnstr;
2250 /**
2251  *
2252  * @param object $glossary
2253  * @param string $ignored invalid parameter
2254  * @param int|string $hook
2255  * @return string
2256  */
2257 function glossary_generate_export_file($glossary, $ignored = "", $hook = 0) {
2258     global $CFG, $DB;
2260     $co  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2262     $co .= glossary_start_tag("GLOSSARY",0,true);
2263     $co .= glossary_start_tag("INFO",1,true);
2264         $co .= glossary_full_tag("NAME",2,false,$glossary->name);
2265         $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
2266         $co .= glossary_full_tag("INTROFORMAT",2,false,$glossary->introformat);
2267         $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
2268         $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
2269         $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
2270         $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
2271         $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
2272         $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
2273         $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
2274         $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
2275         $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
2276         $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
2278         if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) {
2279             $co .= glossary_start_tag("ENTRIES",2,true);
2280             foreach ($entries as $entry) {
2281                 $permissiongranted = 1;
2282                 if ( $hook ) {
2283                     switch ( $hook ) {
2284                     case "ALL":
2285                     case "SPECIAL":
2286                     break;
2287                     default:
2288                         $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
2289                     break;
2290                     }
2291                 }
2292                 if ( $hook ) {
2293                     switch ( $hook ) {
2294                     case GLOSSARY_SHOW_ALL_CATEGORIES:
2295                     break;
2296                     case GLOSSARY_SHOW_NOT_CATEGORISED:
2297                         $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id));
2298                     break;
2299                     default:
2300                         $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook));
2301                     break;
2302                     }
2303                 }
2304                 if ( $entry->approved and $permissiongranted ) {
2305                     $co .= glossary_start_tag("ENTRY",3,true);
2306                     $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
2307                     $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition);
2308                     $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat); // note: use old name for BC reasons
2309                     $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
2310                     $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
2311                     $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
2312                     $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
2314                     if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) {
2315                         $co .= glossary_start_tag("ALIASES",4,true);
2316                         foreach ($aliases as $alias) {
2317                             $co .= glossary_start_tag("ALIAS",5,true);
2318                                 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
2319                             $co .= glossary_end_tag("ALIAS",5,true);
2320                         }
2321                         $co .= glossary_end_tag("ALIASES",4,true);
2322                     }
2323                     if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) {
2324                         $co .= glossary_start_tag("CATEGORIES",4,true);
2325                         foreach ($catentries as $catentry) {
2326                             $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid));
2328                             $co .= glossary_start_tag("CATEGORY",5,true);
2329                                 $co .= glossary_full_tag("NAME",6,false,$category->name);
2330                                 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
2331                             $co .= glossary_end_tag("CATEGORY",5,true);
2332                         }
2333                         $co .= glossary_end_tag("CATEGORIES",4,true);
2334                     }
2336                     $co .= glossary_end_tag("ENTRY",3,true);
2337                 }
2338             }
2339             $co .= glossary_end_tag("ENTRIES",2,true);
2341         }
2344     $co .= glossary_end_tag("INFO",1,true);
2345     $co .= glossary_end_tag("GLOSSARY",0,true);
2347     return $co;
2349 /// Functions designed by Eloy Lafuente
2350 /// Functions to create, open and write header of the xml file
2352 /**
2353  * Read import file and convert to current charset
2354  *
2355  * @global object
2356  * @param string $file
2357  * @return string
2358  */
2359 function glossary_read_imported_file($file_content) {
2360     require_once "../../lib/xmlize.php";
2361     global $CFG;
2363     return xmlize($file_content, 0);
2366 /**
2367  * Return the xml start tag
2368  *
2369  * @param string $tag
2370  * @param int $level
2371  * @param bool $endline
2372  * @return string
2373  */
2374 function glossary_start_tag($tag,$level=0,$endline=false) {
2375         if ($endline) {
2376            $endchar = "\n";
2377         } else {
2378            $endchar = "";
2379         }
2380         return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
2383 /**
2384  * Return the xml end tag
2385  * @param string $tag
2386  * @param int $level
2387  * @param bool $endline
2388  * @return string
2389  */
2390 function glossary_end_tag($tag,$level=0,$endline=true) {
2391         if ($endline) {
2392            $endchar = "\n";
2393         } else {
2394            $endchar = "";
2395         }
2396         return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
2399 /**
2400  * Return the start tag, the contents and the end tag
2401  *
2402  * @global object
2403  * @param string $tag
2404  * @param int $level
2405  * @param bool $endline
2406  * @param string $content
2407  * @return string
2408  */
2409 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
2410         global $CFG;
2412         $st = glossary_start_tag($tag,$level,$endline);
2413         $co = preg_replace("/\r\n|\r/", "\n", s($content));
2414         $et = glossary_end_tag($tag,0,true);
2415         return $st.$co.$et;
2418 /**
2419  * How many unrated entries are in the given glossary for a given user?
2420  *
2421  * @global moodle_database $DB
2422  * @param int $glossaryid
2423  * @param int $userid
2424  * @return int
2425  */
2426 function glossary_count_unrated_entries($glossaryid, $userid) {
2427     global $DB;
2429     $sql = "SELECT COUNT('x') as num
2430               FROM {glossary_entries}
2431              WHERE glossaryid = :glossaryid AND
2432                    userid <> :userid";
2433     $params = array('glossaryid' => $glossaryid, 'userid' => $userid);
2434     $entries = $DB->count_records_sql($sql, $params);
2436     if ($entries) {
2437         // We need to get the contextid for the glossaryid we have been given.
2438         $sql = "SELECT ctx.id
2439                   FROM {context} ctx
2440                   JOIN {course_modules} cm ON cm.id = ctx.instanceid
2441                   JOIN {modules} m ON m.id = cm.module
2442                   JOIN {glossary} g ON g.id = cm.instance
2443                  WHERE ctx.contextlevel = :contextlevel AND
2444                        m.name = 'glossary' AND
2445                        g.id = :glossaryid";
2446         $contextid = $DB->get_field_sql($sql, array('glossaryid' => $glossaryid, 'contextlevel' => CONTEXT_MODULE));
2448         // Now we need to count the ratings that this user has made
2449         $sql = "SELECT COUNT('x') AS num
2450                   FROM {glossary_entries} e
2451                   JOIN {rating} r ON r.itemid = e.id
2452                  WHERE e.glossaryid = :glossaryid AND
2453                        r.userid = :userid AND
2454                        r.component = 'mod_glossary' AND
2455                        r.ratingarea = 'entry' AND
2456                        r.contextid = :contextid";
2457         $params = array('glossaryid' => $glossaryid, 'userid' => $userid, 'contextid' => $contextid);
2458         $rated = $DB->count_records_sql($sql, $params);
2459         if ($rated) {
2460             // The number or enties minus the number or rated entries equals the number of unrated
2461             // entries
2462             if ($entries > $rated) {
2463                 return $entries - $rated;
2464             } else {
2465                 return 0;    // Just in case there was a counting error
2466             }
2467         } else {
2468             return (int)$entries;
2469         }
2470     } else {
2471         return 0;
2472     }
2475 /**
2476  *
2477  * Returns the html code to represent any pagging bar. Paramenters are:
2478  *
2479  * The function dinamically show the first and last pages, and "scroll" over pages.
2480  * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
2481  * could replace the general one. ;-)
2482  *
2483  * @param int $totalcount total number of records to be displayed
2484  * @param int $page page currently selected (0 based)
2485  * @param int $perpage number of records per page
2486  * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically.
2487  *
2488  * @param int $maxpageallowed Optional maximum number of page allowed.
2489  * @param int $maxdisplay Optional maximum number of page links to show in the bar
2490  * @param string $separator Optional string to be used between pages in the bar
2491  * @param string $specialtext Optional string to be showed as an special link
2492  * @param string $specialvalue Optional value (page) to be used in the special link
2493  * @param bool $previousandnext Optional to decide if we want the previous and next links
2494  * @return string
2495  */
2496 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) {
2498     $code = '';
2500     $showspecial = false;
2501     $specialselected = false;
2503     //Check if we have to show the special link
2504     if (!empty($specialtext)) {
2505         $showspecial = true;
2506     }
2507     //Check if we are with the special link selected
2508     if ($showspecial && $page == $specialvalue) {
2509         $specialselected = true;
2510     }
2512     //If there are results (more than 1 page)
2513     if ($totalcount > $perpage) {
2514         $code .= "<div style=\"text-align:center\">";
2515         $code .= "<p>".get_string("page").":";
2517         $maxpage = (int)(($totalcount-1)/$perpage);
2519         //Lower and upper limit of page
2520         if ($page < 0) {
2521             $page = 0;
2522         }
2523         if ($page > $maxpageallowed) {
2524             $page = $maxpageallowed;
2525         }
2526         if ($page > $maxpage) {
2527             $page = $maxpage;
2528         }
2530         //Calculate the window of pages
2531         $pagefrom = $page - ((int)($maxdisplay / 2));
2532         if ($pagefrom < 0) {
2533             $pagefrom = 0;
2534         }
2535         $pageto = $pagefrom + $maxdisplay - 1;
2536         if ($pageto > $maxpageallowed) {
2537             $pageto = $maxpageallowed;
2538         }
2539         if ($pageto > $maxpage) {
2540             $pageto = $maxpage;
2541         }
2543         //Some movements can be necessary if don't see enought pages
2544         if ($pageto - $pagefrom < $maxdisplay - 1) {
2545             if ($pageto - $maxdisplay + 1 > 0) {
2546                 $pagefrom = $pageto - $maxdisplay + 1;
2547             }
2548         }
2550         //Calculate first and last if necessary
2551         $firstpagecode = '';
2552         $lastpagecode = '';
2553         if ($pagefrom > 0) {
2554             $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2555             if ($pagefrom > 1) {
2556                 $firstpagecode .= "$separator...";
2557             }
2558         }
2559         if ($pageto < $maxpage) {
2560             if ($pageto < $maxpage -1) {
2561                 $lastpagecode = "$separator...";
2562             }
2563             $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2564         }
2566         //Previous
2567         if ($page > 0 && $previousandnext) {
2568             $pagenum = $page - 1;
2569             $code .= "&nbsp;(<a  href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;";
2570         }
2572         //Add first
2573         $code .= $firstpagecode;
2575         $pagenum = $pagefrom;
2577         //List of maxdisplay pages
2578         while ($pagenum <= $pageto) {
2579             $pagetoshow = $pagenum +1;
2580             if ($pagenum == $page && !$specialselected) {
2581                 $code .= "$separator<b>$pagetoshow</b>";
2582             } else {
2583                 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2584             }
2585             $pagenum++;
2586         }
2588         //Add last
2589         $code .= $lastpagecode;
2591         //Next
2592         if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2593             $pagenum = $page + 1;
2594             $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2595         }
2597         //Add special
2598         if ($showspecial) {
2599             $code .= '<br />';
2600             if ($specialselected) {
2601                 $code .= "<b>$specialtext</b>";
2602             } else {
2603                 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2604             }
2605         }
2607         //End html
2608         $code .= "</p>";
2609         $code .= "</div>";
2610     }
2612     return $code;
2614 /**
2615  * @return array
2616  */
2617 function glossary_get_view_actions() {
2618     return array('view','view all','view entry');
2620 /**
2621  * @return array
2622  */
2623 function glossary_get_post_actions() {
2624     return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry');
2628 /**
2629  * Implementation of the function for printing the form elements that control
2630  * whether the course reset functionality affects the glossary.
2631  * @param object $mform form passed by reference
2632  */
2633 function glossary_reset_course_form_definition(&$mform) {
2634     $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary'));
2635     $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary'));
2637     $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'),
2638                        array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple'));
2639     $mform->setAdvanced('reset_glossary_types');
2640     $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked');
2642     $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary'));
2643     $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked');
2645     $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings'));
2646     $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked');
2648     $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments'));
2649     $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked');
2652 /**
2653  * Course reset form defaults.
2654  * @return array
2655  */
2656 function glossary_reset_course_form_defaults($course) {
2657     return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0);
2660 /**
2661  * Removes all grades from gradebook
2662  *
2663  * @param int $courseid The ID of the course to reset
2664  * @param string $type The optional type of glossary. 'main', 'secondary' or ''
2665  */
2666 function glossary_reset_gradebook($courseid, $type='') {
2667     global $DB;
2669     switch ($type) {
2670         case 'main'      : $type = "AND g.mainglossary=1"; break;
2671         case 'secondary' : $type = "AND g.mainglossary=0"; break;
2672         default          : $type = ""; //all
2673     }
2675     $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid
2676               FROM {glossary} g, {course_modules} cm, {modules} m
2677              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type";
2679     if ($glossarys = $DB->get_records_sql($sql, array($courseid))) {
2680         foreach ($glossarys as $glossary) {
2681             glossary_grade_item_update($glossary, 'reset');
2682         }
2683     }
2685 /**
2686  * Actual implementation of the reset course functionality, delete all the
2687  * glossary responses for course $data->courseid.
2688  *
2689  * @global object
2690  * @param $data the data submitted from the reset course.
2691  * @return array status array
2692  */
2693 function glossary_reset_userdata($data) {
2694     global $CFG, $DB;
2695     require_once($CFG->dirroot.'/rating/lib.php');
2697     $componentstr = get_string('modulenameplural', 'glossary');
2698     $status = array();
2700     $allentriessql = "SELECT e.id
2701                         FROM {glossary_entries} e
2702                              JOIN {glossary} g ON e.glossaryid = g.id
2703                        WHERE g.course = ?";
2705     $allglossariessql = "SELECT g.id
2706                            FROM {glossary} g
2707                           WHERE g.course = ?";
2709     $params = array($data->courseid);
2711     $fs = get_file_storage();
2713     $rm = new rating_manager();
2714     $ratingdeloptions = new stdClass;
2715     $ratingdeloptions->component = 'mod_glossary';
2716     $ratingdeloptions->ratingarea = 'entry';
2718     // delete entries if requested
2719     if (!empty($data->reset_glossary_all)
2720          or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) {
2722         $params[] = 'glossary_entry';
2723         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea=?", $params);
2724         $DB->delete_records_select('glossary_alias',    "entryid IN ($allentriessql)", $params);
2725         $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2727         // now get rid of all attachments
2728         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2729             foreach ($glossaries as $glossaryid=>$unused) {
2730                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2731                     continue;
2732                 }
2733                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2734                 $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2736                 //delete ratings
2737                 $ratingdeloptions->contextid = $context->id;
2738                 $rm->delete_ratings($ratingdeloptions);
2739             }
2740         }
2742         // remove all grades from gradebook
2743         if (empty($data->reset_gradebook_grades)) {
2744             glossary_reset_gradebook($data->courseid);
2745         }
2747         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2749     } else if (!empty($data->reset_glossary_types)) {
2750         $mainentriessql         = "$allentriessql AND g.mainglossary=1";
2751         $secondaryentriessql    = "$allentriessql AND g.mainglossary=0";
2753         $mainglossariessql      = "$allglossariessql AND g.mainglossary=1";
2754         $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2756         if (in_array('main', $data->reset_glossary_types)) {
2757             $params[] = 'glossary_entry';
2758             $DB->delete_records_select('comments', "itemid IN ($mainentriessql) AND commentarea=?", $params);
2759             $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2761             if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2762                 foreach ($glossaries as $glossaryid=>$unused) {
2763                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2764                         continue;
2765                     }
2766                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2767                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2769                     //delete ratings
2770                     $ratingdeloptions->contextid = $context->id;
2771                     $rm->delete_ratings($ratingdeloptions);
2772                 }
2773             }
2775             // remove all grades from gradebook
2776             if (empty($data->reset_gradebook_grades)) {
2777                 glossary_reset_gradebook($data->courseid, 'main');
2778             }
2780             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('mainglossary', 'glossary'), 'error'=>false);
2782         } else if (in_array('secondary', $data->reset_glossary_types)) {
2783             $params[] = 'glossary_entry';
2784             $DB->delete_records_select('comments', "itemid IN ($secondaryentriessql) AND commentarea=?", $params);
2785             $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2786             // remove exported source flag from entries in main glossary
2787             $DB->execute("UPDATE {glossary_entries}
2788                              SET sourceglossaryid=0
2789                            WHERE glossaryid IN ($mainglossariessql)", $params);
2791             if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2792                 foreach ($glossaries as $glossaryid=>$unused) {
2793                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2794                         continue;
2795                     }
2796                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2797                     $fs->delete_area_files($context->id, 'mod_glossary', 'attachment');
2799                     //delete ratings
2800                     $ratingdeloptions->contextid = $context->id;
2801                     $rm->delete_ratings($ratingdeloptions);
2802                 }
2803             }
2805             // remove all grades from gradebook
2806             if (empty($data->reset_gradebook_grades)) {
2807                 glossary_reset_gradebook($data->courseid, 'secondary');
2808             }
2810             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2811         }
2812     }
2814     // remove entries by users not enrolled into course
2815     if (!empty($data->reset_glossary_notenrolled)) {
2816         $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2817                          FROM {glossary_entries} e
2818                               JOIN {glossary} g ON e.glossaryid = g.id
2819                               LEFT JOIN {user} u ON e.userid = u.id
2820                         WHERE g.course = ? AND e.userid > 0";
2822         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2823         $notenrolled = array();
2824         $rs = $DB->get_recordset_sql($entriessql, $params);
2825         if ($rs->valid()) {
2826             foreach ($rs as $entry) {
2827                 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2828                   or !is_enrolled($course_context , $entry->userid)) {
2829                     $DB->delete_records('comments', array('commentarea'=>'glossary_entry', 'itemid'=>$entry->id));
2830                     $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2832                     if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2833                         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2834                         $fs->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
2836                         //delete ratings
2837                         $ratingdeloptions->contextid = $context->id;
2838                         $rm->delete_ratings($ratingdeloptions);
2839                     }
2840                 }
2841             }
2842             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2843         }
2844         $rs->close();
2845     }
2847     // remove all ratings
2848     if (!empty($data->reset_glossary_ratings)) {
2849         //remove ratings
2850         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2851             foreach ($glossaries as $glossaryid=>$unused) {
2852                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2853                     continue;
2854                 }
2855                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2857                 //delete ratings
2858                 $ratingdeloptions->contextid = $context->id;
2859                 $rm->delete_ratings($ratingdeloptions);
2860             }
2861         }
2863         // remove all grades from gradebook
2864         if (empty($data->reset_gradebook_grades)) {
2865             glossary_reset_gradebook($data->courseid);
2866         }
2867         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2868     }
2870     // remove comments
2871     if (!empty($data->reset_glossary_comments)) {
2872         $params[] = 'glossary_entry';
2873         $DB->delete_records_select('comments', "itemid IN ($allentriessql) AND commentarea= ? ", $params);
2874         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2875     }
2877     /// updating dates - shift may be negative too
2878     if ($data->timeshift) {
2879         shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
2880         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2881     }
2883     return $status;
2886 /**
2887  * Returns all other caps used in module
2888  * @return array
2889  */
2890 function glossary_get_extra_capabilities() {
2891     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');
2894 /**
2895  * @param string $feature FEATURE_xx constant for requested feature
2896  * @return mixed True if module supports feature, null if doesn't know
2897  */
2898 function glossary_supports($feature) {
2899     switch($feature) {
2900         case FEATURE_GROUPS:                  return false;
2901         case FEATURE_GROUPINGS:               return false;
2902         case FEATURE_GROUPMEMBERSONLY:        return true;
2903         case FEATURE_MOD_INTRO:               return true;
2904         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2905         case FEATURE_COMPLETION_HAS_RULES:    return true;
2906         case FEATURE_GRADE_HAS_GRADE:         return true;
2907         case FEATURE_GRADE_OUTCOMES:          return true;
2908         case FEATURE_RATE:                    return true;
2909         case FEATURE_BACKUP_MOODLE2:          return true;
2910         case FEATURE_SHOW_DESCRIPTION:        return true;
2912         default: return null;
2913     }
2916 /**
2917  * Obtains the automatic completion state for this glossary based on any conditions
2918  * in glossary settings.
2919  *
2920  * @global object
2921  * @global object
2922  * @param object $course Course
2923  * @param object $cm Course-module
2924  * @param int $userid User ID
2925  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
2926  * @return bool True if completed, false if not. (If no conditions, then return
2927  *   value depends on comparison type)
2928  */
2929 function glossary_get_completion_state($course,$cm,$userid,$type) {
2930     global $CFG, $DB;
2932     // Get glossary details
2933     if (!($glossary=$DB->get_record('glossary',array('id'=>$cm->instance)))) {
2934         throw new Exception("Can't find glossary {$cm->instance}");
2935     }
2937     $result=$type; // Default return value
2939     if ($glossary->completionentries) {
2940         $value = $glossary->completionentries <=
2941                  $DB->count_records('glossary_entries',array('glossaryid'=>$glossary->id, 'userid'=>$userid, 'approved'=>1));
2942         if ($type == COMPLETION_AND) {
2943             $result = $result && $value;
2944         } else {
2945             $result = $result || $value;
2946         }
2947     }
2949     return $result;
2952 function glossary_extend_navigation($navigation, $course, $module, $cm) {
2953     global $CFG;
2954     $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'letter')));
2955     $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'cat')));
2956     $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'date')));
2957     $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'author')));
2960 /**
2961  * Adds module specific settings to the settings block
2962  *
2963  * @param settings_navigation $settings The settings navigation object
2964  * @param navigation_node $glossarynode The node to add module settings to
2965  */
2966 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
2967     global $PAGE, $DB, $CFG, $USER;
2969     $mode = optional_param('mode', '', PARAM_ALPHA);
2970     $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
2972     if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
2973         $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
2974     }
2976     if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
2977         $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
2978     }
2980     if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
2981         $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
2982     }
2984     if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
2985         $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
2986     }
2988     $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
2990     if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds) && $glossary->rsstype && $glossary->rssarticles && has_capability('mod/glossary:view', $PAGE->cm->context)) {
2991         require_once("$CFG->libdir/rsslib.php");
2993         $string = get_string('rsstype','forum');
2995         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_glossary', $glossary->id));
2996         $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2997     }
3000 /**
3001  * Running addtional permission check on plugin, for example, plugins
3002  * may have switch to turn on/off comments option, this callback will
3003  * affect UI display, not like pluginname_comment_validate only throw
3004  * exceptions.
3005  * Capability check has been done in comment->check_permissions(), we
3006  * don't need to do it again here.
3007  *
3008  * @package  mod_glossary
3009  * @category comment
3010  *
3011  * @param stdClass $comment_param {
3012  *              context  => context the context object
3013  *              courseid => int course id
3014  *              cm       => stdClass course module object
3015  *              commentarea => string comment area
3016  *              itemid      => int itemid
3017  * }
3018  * @return array
3019  */
3020 function glossary_comment_permissions($comment_param) {
3021     return array('post'=>true, 'view'=>true);
3024 /**
3025  * Validate comment parameter before perform other comments actions
3026  *
3027  * @package  mod_glossary
3028  * @category comment
3029  *
3030  * @param stdClass $comment_param {
3031  *              context  => context the context object
3032  *              courseid => int course id
3033  *              cm       => stdClass course module object
3034  *              commentarea => string comment area
3035  *              itemid      => int itemid
3036  * }
3037  * @return boolean
3038  */
3039 function glossary_comment_validate($comment_param) {
3040     global $DB;
3041     // validate comment area
3042     if ($comment_param->commentarea != 'glossary_entry') {
3043         throw new comment_exception('invalidcommentarea');
3044     }
3045     if (!$record = $DB->get_record('glossary_entries', array('id'=>$comment_param->itemid))) {
3046         throw new comment_exception('invalidcommentitemid');
3047     }
3048     if ($record->sourceglossaryid && $record->sourceglossaryid == $comment_param->cm->instance) {
3049         $glossary = $DB->get_record('glossary', array('id'=>$record->sourceglossaryid));
3050     } else {
3051         $glossary = $DB->get_record('glossary', array('id'=>$record->glossaryid));
3052     }
3053     if (!$glossary) {
3054         throw new comment_exception('invalidid', 'data');
3055     }
3056     if (!$course = $DB->get_record('course', array('id'=>$glossary->course))) {
3057         throw new comment_exception('coursemisconf');
3058     }
3059     if (!$cm = get_coursemodule_from_instance('glossary', $glossary->id, $course->id)) {
3060         throw new comment_exception('invalidcoursemodule');
3061     }
3062     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
3064     if ($glossary->defaultapproval and !$record->approved and !has_capability('mod/glossary:approve', $context)) {
3065         throw new comment_exception('notapproved', 'glossary');
3066     }
3067     // validate context id
3068     if ($context->id != $comment_param->context->id) {
3069         throw new comment_exception('invalidcontext');
3070     }
3071     // validation for comment deletion
3072     if (!empty($comment_param->commentid)) {
3073         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3074             if ($comment->commentarea != 'glossary_entry') {
3075                 throw new comment_exception('invalidcommentarea');
3076             }
3077             if ($comment->contextid != $comment_param->context->id) {
3078                 throw new comment_exception('invalidcontext');
3079             }
3080             if ($comment->itemid != $comment_param->itemid) {
3081                 throw new comment_exception('invalidcommentitemid');
3082             }
3083         } else {
3084             throw new comment_exception('invalidcommentid');
3085         }
3086     }
3087     return true;
3090 /**
3091  * Return a list of page types
3092  * @param string $pagetype current page type
3093  * @param stdClass $parentcontext Block's parent context
3094  * @param stdClass $currentcontext Current context of block
3095  */
3096 function glossary_page_type_list($pagetype, $parentcontext, $currentcontext) {
3097     $module_pagetype = array(
3098         'mod-glossary-*'=>get_string('page-mod-glossary-x', 'glossary'),
3099         'mod-glossary-view'=>get_string('page-mod-glossary-view', 'glossary'),
3100         'mod-glossary-edit'=>get_string('page-mod-glossary-edit', 'glossary'));
3101     return $module_pagetype;