f8fa08358bb67313fe4403884e8b45294967a8c0
[moodle.git] / mod / glossary / lib.php
1 <?php  // $Id$
3 /// Library of functions and constants for module glossary
4 /// (replace glossary with the name of your module and delete this line)
6 require_once($CFG->libdir.'/filelib.php');
8 define("GLOSSARY_SHOW_ALL_CATEGORIES", 0);
9 define("GLOSSARY_SHOW_NOT_CATEGORISED", -1);
11 define("GLOSSARY_NO_VIEW", -1);
12 define("GLOSSARY_STANDARD_VIEW", 0);
13 define("GLOSSARY_CATEGORY_VIEW", 1);
14 define("GLOSSARY_DATE_VIEW", 2);
15 define("GLOSSARY_AUTHOR_VIEW", 3);
16 define("GLOSSARY_ADDENTRY_VIEW", 4);
17 define("GLOSSARY_IMPORT_VIEW", 5);
18 define("GLOSSARY_EXPORT_VIEW", 6);
19 define("GLOSSARY_APPROVAL_VIEW", 7);
21 //Check for global configure default variables
23 if (!isset($CFG->glossary_studentspost)) {
24     set_config("glossary_studentspost", 1);  // Students can post entries.
25 }
27 if (!isset($CFG->glossary_dupentries)) {
28     set_config("glossary_dupentries", 0);  // Duplicate entries are not allowed.
29 }
31 if (!isset($CFG->glossary_allowcomments)) {
32     set_config("glossary_allowcomments", 0);  // Comments are not allowed.
33 }
35 if (!isset($CFG->glossary_linkbydefault)) {
36     set_config("glossary_linkbydefault", 1);  // Linking entries is enabled.
37 }
39 if (!isset($CFG->glossary_defaultapproval)) {
40     set_config("glossary_defaultapproval", 1);  // Entries are approved.
41 }
43 if (!isset($CFG->glossary_entbypage)) {
44     set_config("glossary_entbypage", 10);  // 10 entries are showed.
45 }
47 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
49 function glossary_add_instance($glossary) {
50 /// Given an object containing all the necessary data,
51 /// (defined by the form in mod.html) this function
52 /// will create a new instance and return the id number
53 /// of the new instance.
55     if (!isset($glossary->userating) || !$glossary->userating) {
56         $glossary->assessed = 0;
57     }
59     if (empty($glossary->ratingtime)) {
60         $glossary->assesstimestart  = 0;
61         $glossary->assesstimefinish = 0;
62     }
64     if ( !isset($glossary->globalglossary) ) {
65         $glossary->globalglossary = 0;
66     } elseif (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM, SITEID))) {
67         $glossary->globalglossary = 0;
68     }
70     $glossary->timecreated = time();
71     $glossary->timemodified = $glossary->timecreated;
73     //Check displayformat is a valid one
74     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
75     if (!in_array($glossary->displayformat, $formats)) {
76         error("This format doesn't exist!");
77     }
79     return insert_record("glossary", $glossary);
80 }
83 function glossary_update_instance($glossary) {
84 /// Given an object containing all the necessary data,
85 /// (defined by the form in mod.html) this function
86 /// will update an existing instance with new data.
87     global $CFG;
89     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM, SITEID))) {
90         unset($glossary->globalglossary);
91     }
92     if (empty($glossary->globalglossary)) {
93         $glossary->globalglossary = 0;
94     }
96     $glossary->timemodified = time();
97     $glossary->id = $glossary->instance;
99     if (!isset($glossary->userating) || !$glossary->userating) {
100         $glossary->assessed = 0;
101     }
103     if (empty($glossary->ratingtime)) {
104         $glossary->assesstimestart  = 0;
105         $glossary->assesstimefinish = 0;
106     }
108     //Check displayformat is a valid one
109     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
110     if (!in_array($glossary->displayformat, $formats)) {
111         error("This format doesn't exist!");
112     }
114     $return = update_record("glossary", $glossary);
115     if ($return and $glossary->defaultapproval) {
116         execute_sql("update {$CFG->prefix}glossary_entries SET approved = 1 where approved != 1 and glossaryid = " . $glossary->id,false);
117     }
119     return $return;
123 function glossary_delete_instance($id) {
124 /// Given an ID of an instance of this module,
125 /// this function will permanently delete the instance
126 /// and any data that depends on it.
128     if (! $glossary = get_record("glossary", "id", "$id")) {
129         return false;
130     }
132     $result = true;
134     # Delete any dependent records here #
136     if (! delete_records("glossary", "id", "$glossary->id")) {
137         $result = false;
138     } else {
139         if ($categories = get_records("glossary_categories","glossaryid",$glossary->id)) {
140             $cats = "";
141             foreach ( $categories as $cat ) {
142                 $cats .= "$cat->id,";
143             }
144             $cats = substr($cats,0,-1);
145             if ($cats) {
146                 delete_records_select("glossary_entries_categories", "categoryid in ($cats)");
147                 delete_records("glossary_categories", "glossaryid", $glossary->id);
148             }
149         }
150         if ( $entries = get_records("glossary_entries", "glossaryid", $glossary->id) ) {
151             $ents = "";
152             foreach ( $entries as $entry ) {
153                 if ( $entry->sourceglossaryid ) {
154                     $entry->glossaryid = $entry->sourceglossaryid;
155                     $entry->sourceglossaryid = 0;
156                     update_record("glossary_entries",$entry);
157                 } else {
158                     $ents .= "$entry->id,";
159                 }
160             }
161             $ents = substr($ents,0,-1);
162             if ($ents) {
163                 delete_records_select("glossary_comments", "entryid in ($ents)");
164                 delete_records_select("glossary_alias", "entryid in ($ents)");
165                 delete_records_select("glossary_ratings", "entryid in ($ents)");
166             }
167         }
168         glossary_delete_attachments($glossary);
169         delete_records("glossary_entries", "glossaryid", "$glossary->id");
170     }
172     return $result;
175 function glossary_user_outline($course, $user, $mod, $glossary) {
176 /// Return a small object with summary information about what a
177 /// user has done with a given particular instance of this module
178 /// Used for user activity reports.
179 /// $return->time = the time they did it
180 /// $return->info = a short text description
182     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
183         $result->info = count($entries) . ' ' . get_string("entries", "glossary");
185         $lastentry = array_pop($entries);
186         $result->time = $lastentry->timemodified;
187         return $result;
188     }
189     return NULL;
192 function glossary_get_user_entries($glossaryid, $userid) {
193 /// Get all the entries for a user in a glossary
194     global $CFG;
196     return get_records_sql("SELECT e.*, u.firstname, u.lastname, u.email, u.picture
197                               FROM {$CFG->prefix}glossary g,
198                                    {$CFG->prefix}glossary_entries e,
199                                    {$CFG->prefix}user u
200                              WHERE g.id = '$glossaryid'
201                                AND e.glossaryid = g.id
202                                AND e.userid = '$userid'
203                                AND e.userid = u.id
204                           ORDER BY e.timemodified ASC");
207 function glossary_user_complete($course, $user, $mod, $glossary) {
208 /// Print a detailed representation of what a  user has done with
209 /// a given particular instance of this module, for user activity reports.
210     global $CFG;
212     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
213         echo '<table width="95%" border="0"><tr><td>';
214         foreach ($entries as $entry) {
215             $cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id);
216             glossary_print_entry($course, $cm, $glossary, $entry,"","",0);
217             echo '<p>';
218         }
219         echo '</td></tr></table>';
220     }
223 function glossary_print_recent_activity($course, $isteacher, $timestart) {
224 /// Given a course and a time, this module should find recent activity
225 /// that has occurred in glossary activities and print it out.
226 /// Return true if there was output, or false is there was none.
228     global $CFG;
230     if (!$logs = get_records_select('log', 'time > \''.$timestart.'\' AND '.
231                                            'course = \''.$course->id.'\' AND '.
232                                            'module = \'glossary\' AND '.
233                                            '(action = \'add entry\' OR '.
234                                            ' action  = \'approve entry\')', 'time ASC')) {
235         return false;
236     }
238     $entries = array();
240     foreach ($logs as $log) {
241         //Create a temp valid module structure (course,id)
242         $tempmod->course = $log->course;
243         $entry           = get_record('glossary_entries','id',$log->info);
244         if (!$entry) {
245             continue;
246         }
247         $tempmod->id = $entry->glossaryid;
248         //Obtain the visible property from the instance
249         $modvisible = instance_is_visible($log->module,$tempmod);
251         //Only if the mod is visible
252         if ($modvisible and $entry->approved) {
253             $entries[$log->info] = glossary_log_info($log);
254             $entries[$log->info]->time = $log->time;
255             $entries[$log->info]->url  = str_replace('&', '&amp;', $log->url);
256         }
257     }
259     $content = false;
260     if ($entries) {
261         $content = true;
262         print_headline(get_string('newentries', 'glossary').':');
263         foreach ($entries as $entry) {
264             $user = get_record('user','id',$entry->userid, '','', '','', 'firstname,lastname');
266             print_recent_activity_note($entry->timemodified, $user, $entry->concept,
267                                        $CFG->wwwroot.'/mod/glossary/view.php?g='.$entry->glossaryid.
268                                        '&amp;mode=entry&amp;hook='.$entry->id);
269         }
270     }
272     return $content;
276 function glossary_log_info($log) {
277     global $CFG;
279     return get_record_sql("SELECT e.*, u.firstname, u.lastname
280                              FROM {$CFG->prefix}glossary_entries e,
281                                   {$CFG->prefix}user u
282                             WHERE e.id = '$log->info'
283                               AND u.id = '$log->userid'");
286 function glossary_cron () {
287 /// Function to be run periodically according to the moodle cron
288 /// This function searches for things that need to be done, such
289 /// as sending out mail, toggling flags etc ...
291     global $CFG;
293     return true;
296 function glossary_grades($glossaryid) {
297 /// Must return an array of grades for a given instance of this module,
298 /// indexed by user.  It also returns a maximum allowed grade.
299     if (!$glossary = get_record("glossary", "id", $glossaryid)) {
300         return false;
301     }
302     if (!$glossary->assessed) {
303         return false;
304     }
305     $scalemenu = make_grades_menu($glossary->scale);
307     $currentuser = 0;
308     $ratingsuser = array();
310     if ($ratings = glossary_get_user_grades($glossaryid)) {
311         foreach ($ratings as $rating) {     // Ordered by user
312             if ($currentuser and $rating->userid != $currentuser) {
313                 if (!empty($ratingsuser)) {
314                     if ($glossary->scale < 0) {
315                         $return->grades[$currentuser] = glossary_get_ratings_mean(0, $scalemenu, $ratingsuser);
316                         $return->grades[$currentuser] .= "<br />".glossary_get_ratings_summary(0, $scalemenu, $ratingsuser);
317                     } else {
318                         $total = 0;
319                         $count = 0;
320                         foreach ($ratingsuser as $ra) {
321                             $total += $ra;
322                             $count ++;
323                         }
324                         $return->grades[$currentuser] = (string) format_float($total/$count, 2);
325                         if ( count($ratingsuser) > 1 ) {
326                             $return->grades[$currentuser] .= " (" . count($ratingsuser) . ")";
327                         }
328                     }
329                 } else {
330                     $return->grades[$currentuser] = "";
331                 }
332                 $ratingsuser = array();
333             }
334             $ratingsuser[] = $rating->rating;
335             $currentuser = $rating->userid;
336         }
337         if (!empty($ratingsuser)) {
338             if ($glossary->scale < 0) {
339                 $return->grades[$currentuser] = glossary_get_ratings_mean(0, $scalemenu, $ratingsuser);
340                 $return->grades[$currentuser] .= "<br />".glossary_get_ratings_summary(0, $scalemenu, $ratingsuser);
341             } else {
342                 $total = 0;
343                 $count = 0;
344                 foreach ($ratingsuser as $ra) {
345                     $total += $ra;
346                     $count ++;
347                 }
348                 $return->grades[$currentuser] = (string) format_float((float)$total/(float)$count, 2);
350                 if ( count($ratingsuser) > 1 ) {
351                     $return->grades[$currentuser] .= " (" . count($ratingsuser) . ")";
352                 }
353             }
354         } else {
355             $return->grades[$currentuser] = "";
356         }
357     } else {
358         $return->grades = array();
359     }
361     if ($glossary->scale < 0) {
362         $return->maxgrade = "";
363     } else {
364         $return->maxgrade = $glossary->scale;
365     }
366     return $return;
369 function glossary_get_participants($glossaryid) {
370 //Returns the users with data in one glossary
371 //(users with records in glossary_entries, students)
373     global $CFG;
375     //Get students
376     $students = get_records_sql("SELECT DISTINCT u.id, u.id
377                                  FROM {$CFG->prefix}user u,
378                                       {$CFG->prefix}glossary_entries g
379                                  WHERE g.glossaryid = '$glossaryid' and
380                                        u.id = g.userid");
382     //Return students array (it contains an array of unique users)
383     return ($students);
386 function glossary_scale_used ($glossaryid,$scaleid) {
387 //This function returns if a scale is being used by one glossary
389     $return = false;
391     $rec = get_record("glossary","id","$glossaryid","scale","-$scaleid");
393     if (!empty($rec)  && !empty($scaleid)) {
394         $return = true;
395     }
397     return $return;
400 //////////////////////////////////////////////////////////////////////////////////////
401 /// Any other glossary functions go here.  Each of them must have a name that
402 /// starts with glossary_
404 //This function return an array of valid glossary_formats records
405 //Everytime it's called, every existing format is checked, new formats
406 //are included if detected and old formats are deleted and any glossary
407 //using an invalid format is updated to the default (dictionary).
408 function glossary_get_available_formats() {
410     global $CFG;
412     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
413     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
414     $pluginformats = array();
415     foreach ($formats as $format) {
416         //If the format file exists
417         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
418             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
419             //If the function exists
420             if (function_exists('glossary_show_entry_'.$format)) {
421                 //Acummulate it as a valid format
422                 $pluginformats[] = $format;
423                 //If the format doesn't exist in the table
424                 if (!$rec = get_record('glossary_formats','name',$format)) {
425                     //Insert the record in glossary_formats
426                     $gf->name = $format;
427                     $gf->popupformatname = $format;
428                     $gf->visible = 1;
429                     insert_record("glossary_formats",$gf);
430                 }
431             }
432         }
433     }
435     //Delete non_existent formats from glossary_formats table
436     $formats = get_records("glossary_formats");
437     foreach ($formats as $format) {
438         $todelete = false;
439         //If the format in DB isn't a valid previously detected format then delete the record
440         if (!in_array($format->name,$pluginformats)) {
441             $todelete = true;
442         }
444         if ($todelete) {
445             //Delete the format
446             delete_records('glossary_formats','name',$format->name);
447             //Reasign existing glossaries to default (dictionary) format
448             if ($glossaries = get_records('glossary','displayformat',$format->name)) {
449                 foreach($glossaries as $glossary) {
450                     set_field('glossary','displayformat','dictionary','id',$glossary->id);
451                 }
452             }
453         }
454     }
456     //Now everything is ready in glossary_formats table
457     $formats = get_records("glossary_formats");
459     return $formats;
462 function glossary_debug($debug,$text,$br=1) {
463     if ( $debug ) {
464         echo '<font color="red">' . $text . '</font>';
465         if ( $br ) {
466             echo '<br />';
467         }
468     }
471 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
472     global $CFG;
473     if ($pivot) {
474        $pivot .= ",";
475     }
477     return get_records_sql("SELECT $pivot id,userid,concept,definition,format
478                             FROM {$CFG->prefix}glossary_entries
479                             WHERE glossaryid = '$glossaryid'
480                             AND id IN ($entrylist)");
483 function glossary_get_entries_search($concept, $courseid) {
485     global $CFG;
487     //Check if the user is an admin
488     $bypassadmin = 1; //This means NO (by default)
489     if (has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_SYSTEM, SITEID))) {
490         $bypassadmin = 0; //This means YES
491     }
493     //Check if the user is a teacher
494     $bypassteacher = 1; //This means NO (by default)
495     if (has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $courseid))) {
496         $bypassteacher = 0; //This means YES
497     }
499     $conceptlower = moodle_strtolower(trim($concept));
501     return get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
502                             FROM {$CFG->prefix}glossary_entries e,
503                                  {$CFG->prefix}glossary g,
504                                  {$CFG->prefix}course_modules cm,
505                                  {$CFG->prefix}modules m
506                             WHERE m.name = 'glossary' AND
507                                   cm.module = m.id AND
508                                   (cm.visible = 1 OR  cm.visible = $bypassadmin OR
509                                     (cm.course = '$courseid' AND cm.visible = $bypassteacher)) AND
510                                   g.id = cm.instance AND
511                                   e.glossaryid = g.id  AND
512                                   ( (e.casesensitive != 0 AND LOWER(concept) = '$conceptlower') OR
513                                     (e.casesensitive = 0 and concept = '$concept')) AND
514                                   (g.course = '$courseid' OR g.globalglossary = 1) AND
515                                   e.usedynalink != 0 AND
516                                   g.usedynalink != 0");
519 function glossary_get_entries_sorted($glossary, $where="", $orderby="", $pivot = "") {
520 global $CFG;
521     if ($where) {
522        $where = " and $where";
523     }
524     if ($orderby) {
525        $orderby = " ORDER BY $orderby";
526     }
527     if ($pivot) {
528        $pivot .= ",";
529     }
530     return      get_records_sql("SELECT $pivot *
531                                  FROM {$CFG->prefix}glossary_entries
532                                  WHERE (glossaryid = $glossary->id or sourceglossaryid = $glossary->id) $where $orderby");
535 function glossary_get_entries_by_category($glossary, $hook, $where="", $orderby="", $pivot = "") {
536 global $CFG;
537     if ($where) {
538        $where = " and $where";
539     }
540     if ($orderby) {
541        $orderby = " ORDER BY $orderby";
542     }
543     if ($pivot) {
544        $pivot .= ",";
545     }
546     return      get_records_sql("SELECT $pivot ge.*
547                                  FROM {$CFG->prefix}glossary_entries ge, {$CFG->prefix}glossary_entries_categories c
548                                  WHERE (ge.id = c.entryidid and c.categoryid = $hook) and
549                                              (ge.glossaryid = $glossary->id or ge.sourceglossaryid = $glossary->id) $where $orderby");
552 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $ratings = NULL, $printview = false) {
553     global $USER, $CFG;
554     $return = false;
555     if ( $displayformat < 0 ) {
556         $displayformat = $glossary->displayformat;
557     }
558     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
559         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
560         if ($printview) {
561             $functionname = 'glossary_print_entry_'.$displayformat;
562         } else {
563             $functionname = 'glossary_show_entry_'.$displayformat;
564         }
566         if (file_exists($formatfile)) {
567             include_once($formatfile);
568             if (function_exists($functionname)) {
569                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons,$ratings);
570             } else if ($printview) {
571                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
572                 $return = glossary_print_entry_default($entry);
573             }
574         }
575     }
576     return $return;
579  //Default (old) print format used if custom function doesn't exist in format
580 function glossary_print_entry_default ($entry) {
581     echo '<b>'. strip_tags($entry->concept) . ': </b>';
583     $definition = $entry->definition;
585     // always detect and strip TRUSTTEXT marker before processing and add+strip it afterwards!
586     if (trusttext_present($definition)) {
587         $ttpresent = true;
588         $definition = trusttext_strip($definition);
589     } else {
590         $ttpresent = false;
591     }
593     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
595     // reconstruct the TRUSTTEXT properly after processing
596     if ($ttpresent) {
597         $definition = trusttext_mark($definition);
598     } else {
599         $definition = trusttext_strip($definition); //make 100% sure TRUSTTEXT marker was not created
600     }
602     $options = new object();
603     $options->para = false;
604     $options->trusttext = true;
605     $definition = format_text($definition, $entry->format, $options);
606     echo ($definition);
607     echo '<br /><br />';
610 function  glossary_print_entry_concept($entry) {
611     $options = new object();
612     $options->para = false;
613     $text = format_text('<span class="nolink">' . $entry->concept . '</span>', FORMAT_MOODLE, $options);
614     if (!empty($entry->highlight)) {
615         $text = highlight($entry->highlight, $text);
616     }
617     echo $text;
620 function glossary_print_entry_definition($entry) {
622     $definition = $entry->definition;
624     // always detect and strip TRUSTTEXT marker before processing and add+strip it afterwards!
625     if (trusttext_present($definition)) {
626         $ttpresent = true;
627         $definition = trusttext_strip($definition);
628     } else {
629         $ttpresent = false;
630     }
632     $links = array();
633     $tags = array();
634     $urls = array();
635     $addrs = array();
637     //Calculate all the strings to be no-linked
638     //First, the concept
639     $term = preg_quote(trim($entry->concept),'/');
640     $pat = '/('.$term.')/is';
641     $doNolinks[] = $pat;
642     //Now the aliases
643     if ( $aliases = get_records('glossary_alias','entryid',$entry->id) ) {
644         foreach ($aliases as $alias) {
645             $term = preg_quote(trim($alias->alias),'/');
646             $pat = '/('.$term.')/is';
647             $doNolinks[] = $pat;
648         }
649     }
652     //Extract <a>..><a> tags from definition
653     preg_match_all('/<a[^>]+?>(.*?)<\/a>/is',$definition,$list_of_a);
655     //Save them into links array to use them later
656     foreach (array_unique($list_of_a[0]) as $key=>$value) {
657         $links['<#'.$key.'#>'] = $value;
658     }
659     //Take off every link from definition
660     if ( $links ) {
661         $definition = str_replace($links,array_keys($links),$definition);
662     }
665     //Extract all tags from definition
666     preg_match_all('/(<.*?>)/is',$definition,$list_of_tags);
668     //Save them into tags array to use them later
669     foreach (array_unique($list_of_tags[0]) as $key=>$value) {
670         $tags['<@'.$key.'@>'] = $value;
671     }
672     //Take off every tag from definition
673     if ( $tags ) {
674         $definition = str_replace($tags,array_keys($tags),$definition);
675     }
678     //Extract all URLS with protocol (http://domain.com) from definition
679     preg_match_all('/([[:space:]]|^|\(|\[)([[:alnum:]]+):\/\/([^[:space:]]*)([[:alnum:]#?\/&=])/is',$definition,$list_of_urls);
681     //Save them into urls array to use them later
682     foreach (array_unique($list_of_urls[0]) as $key=>$value) {
683         $urls['<*'.$key.'*>'] = $value;
684     }
685     //Take off every url from definition
686     if ( $urls ) {
687         $definition = str_replace($urls,array_keys($urls),$definition);
688     }
691     //Extract all WEB ADDRESSES (www.domain.com) from definition
692     preg_match_all('/([[:space:]]|^|\(|\[)www\.([^[:space:]]*)([[:alnum:]#?\/&=])/is',$definition,$list_of_addresses);
694     //Save them into addrs array to use them later
695     foreach (array_unique($list_of_addresses[0]) as $key=>$value) {
696         $addrs['<+'.$key.'+>'] = $value;
697     }
698     //Take off every addr from definition
699     if ( $addrs ) {
700         $definition = str_replace($addrs,array_keys($addrs),$definition);
701     }
704     //Put doNolinks (concept + aliases) enclosed by <nolink> tag
705     $definition= preg_replace($doNolinks,'<span class="nolink">$1</span>',$definition);
707     //Restore addrs
708     if ( $addrs ) {
709         $definition = str_replace(array_keys($addrs),$addrs,$definition);
710     }
712     //Restore urls
713     if ( $urls ) {
714         $definition = str_replace(array_keys($urls),$urls,$definition);
715     }
717     //Restore tags
718     if ( $tags ) {
719         $definition = str_replace(array_keys($tags),$tags,$definition);
720     }
722     //Restore links
723     if ( $links ) {
724         $definition = str_replace(array_keys($links),$links,$definition);
725     }
727     $options = new object();
728     $options->para = false;
729     $options->trusttext = true;
731     // reconstruct the TRUSTTEXT properly after processing
732     if ($ttpresent) {
733         $definition = trusttext_mark($definition);
734     } else {
735         $definition = trusttext_strip($definition); //make 100% sure TRUSTTEXT marker was not created
736     }
738     $text = format_text($definition, $entry->format, $options);
739     if (!empty($entry->highlight)) {
740         $text = highlight($entry->highlight, $text);
741     }
742     if (isset($entry->footer)) {   // Unparsed footer info
743         $text .= $entry->footer;
744     }
745     echo $text;
748 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
749     $return = '';
750     if ( $aliases = get_records('glossary_alias','entryid',$entry->id) ) {
751         foreach ($aliases as $alias) {
752             if (trim($alias->alias)) {
753                 if ($return == '') {
754                     $return = '<select style="font-size:8pt">';
755                 }
756                 $return .= "<option>$alias->alias</option>";
757             }
758         }
759         if ($return != '') {
760             $return .= '</select>';
761         }
762     }
763     if ($type == 'print') {
764         echo $return;
765     } else {
766         return $return;
767     }
770 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
771     global $USER, $CFG;
773     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
775     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
776     $importedentry = ($entry->sourceglossaryid == $glossary->id);
777     $ismainglossary = $glossary->mainglossary;
780     $return = '<span class="commands">';
781     if (!$entry->approved) {
782         $output = true;
783         $return .= get_string('entryishidden','glossary');
784     }
785     $return .= glossary_print_entry_commentslink($course, $cm, $glossary, $entry,$mode,$hook,'html');
787     if (has_capability('mod/glossary:comment', $context)) {
788         $output = true;
789         $return .= ' <a title="' . get_string('addcomment','glossary') . '" href="comment.php?action=add&amp;eid='.$entry->id.'"><img src="comment.gif" class="iconsmall" alt="'.get_string('addcomment','glossary').'" /></a>';
790     }
793     if (has_capability('mod/glossary:manageentries', $context) or (!empty($USER->id) and has_capability('mod/glossary:write', $context) and $entry->userid == $USER->id)) {
794         // only teachers can export entries so check it out
795         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
796             $mainglossary = get_record('glossary','mainglossary',1,'course',$course->id);
797             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
798                 $output = true;
799                 $return .= ' <a title="'.get_string('exporttomainglossary','glossary') . '" href="exportentry.php?id='.$cm->id.'&amp;entry='.$entry->id.'&amp;mode='.$mode.'&amp;hook='.$hook.'"><img src="export.gif" class="iconsmall" alt="'.get_string('exporttomainglossary','glossary').'" /></a>';
800             }
801         }
803         if ( $entry->sourceglossaryid ) {
804             $icon = "minus.gif";   // graphical metaphor (minus) for deleting an imported entry
805         } else {
806             $icon = "$CFG->pixpath/t/delete.gif";
807         }
809         //Decide if an entry is editable:
810         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
811         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
812         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
813         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
814             $output = true;
815             $return .= " <a title=\"" . get_string("delete") . "\" href=\"deleteentry.php?id=$cm->id&amp;mode=delete&amp;entry=$entry->id&amp;prevmode=$mode&amp;hook=$hook\"><img src=\"";
816             $return .= $icon;
817             $return .= "\" class=\"iconsmall\" alt=\"" . get_string("delete") . "\" /></a> ";
819             $return .= " <a title=\"" . get_string("edit") . "\" href=\"edit.php?id=$cm->id&amp;e=$entry->id&amp;mode=$mode&amp;hook=$hook\"><img src=\"$CFG->pixpath/t/edit.gif\" class=\"iconsmall\" alt=\"" . get_string("edit") . "\" /></a>";
820         } elseif ( $importedentry ) {
821             $return .= " <font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
822         }
823     }
824     $return .= "&nbsp;&nbsp;"; // just to make up a little the output in Mozilla ;)
826     $return .= '</span>';
828     //If we haven't calculated any REAL thing, delete result ($return)
829     if (!$output) {
830         $return = '';
831     }
832     //Print or get
833     if ($type == 'print') {
834         echo $return;
835     } else {
836         return $return;
837     }
840 function glossary_print_entry_commentslink($course, $cm, $glossary, $entry,$mode,$hook, $type = 'print') {
841     $return = '';
843     $count = count_records('glossary_comments','entryid',$entry->id);
844     if ($count) {
845         $return = '';
846         $return .= "<a href=\"comments.php?id=$cm->id&amp;eid=$entry->id\">$count ";
847         if ($count == 1) {
848             $return .= get_string('comment', 'glossary');
849         } else {
850             $return .= get_string('comments', 'glossary');
851         }
852         $return .= '</a>';
853     }
855     if ($type == 'print') {
856         echo $return;
857     } else {
858         return $return;
859     }
862 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook,$printicons,$ratings,$aliases=true) {
864     if ($aliases) {
865         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
866     }
867     $icons   = '';
868     $return   = '';
869     if ( $printicons ) {
870         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
871     }
872     if ($aliases || $icons || $ratings) {
873         echo '<table>';
874         if ( $aliases ) {
875             echo '<tr valign="top"><td class="aliases">' .
876                   get_string('aliases','glossary').': '.$aliases . '</td></tr>';
877         }
878         if ($icons) {
879             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
880         }
881         if ($ratings) {
882             echo '<tr valign="top"><td class="ratings">';
883             $return = glossary_print_entry_ratings($course, $entry, $ratings);
884             echo '</td></tr>';
885         }
886         echo '</table>';
887     }
888     return $return;
891 function glossary_print_entry_attachment($entry,$format=NULL,$align="right",$insidetable=true) {
892 ///   valid format values: html  : Return the HTML link for the attachment as an icon
893 ///                        text  : Return the HTML link for tha attachment as text
894 ///                        blank : Print the output to the screen
895     if ($entry->attachment) {
896           $glossary = get_record("glossary","id",$entry->glossaryid);
897           $entry->course = $glossary->course; //used inside print_attachment
898           if ($insidetable) {
899               echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
900           }
901           echo glossary_print_attachments($entry,$format,$align);
902           if ($insidetable) {
903               echo "</td></tr></table>\n";
904           }
905     }
908 function  glossary_print_entry_approval($cm, $entry, $mode,$align="right",$insidetable=true) {
909     if ( $mode == 'approval' and !$entry->approved ) {
910         if ($insidetable) {
911             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
912         }
913         echo '<a title="'.get_string('approve','glossary').'" href="approve.php?id='.$cm->id.'&amp;eid='.$entry->id.'&amp;mode='.$mode.'"><img align="'.$align.'" src="check.gif" border="0" width="34" height="34" alt="'.get_string('approve','glossary').'" /></a>';
914         if ($insidetable) {
915             echo '</td></tr></table>';
916         }
917     }
920 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
921 // It returns all entries from all glossaries that matches the specified criteria
922 //    within a given $course. It performs an $extended search if necessary.
923 // It restrict the search to only one $glossary if the $glossary parameter is set.
925     global $CFG;
926     if ( !$glossary ) {
927         if ( $glossaries = get_records("glossary", "course", $course->id) ) {
928             $glos = "";
929             foreach ( $glossaries as $glossary ) {
930                 $glos .= "$glossary->id,";
931             }
932             $glos = substr($glos,0,-1);
933         }
934     } else {
935         $glos = $glossary->id;
936     }
938     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $glossary->course))) {
939         $glossarymodule = get_record("modules", "name", "glossary");
940         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
941         $onlyvisibletable = ", {$CFG->prefix}course_modules cm";
942     } else {
944         $onlyvisible = "";
945         $onlyvisibletable = "";
946     }
948     /// Some differences in syntax for entrygreSQL
949     switch ($CFG->dbtype) {
950     case 'postgres7':
951         $LIKE = "ILIKE";   // case-insensitive
952         $NOTLIKE = "NOT ILIKE";   // case-insensitive
953         $REGEXP = "~*";
954         $NOTREGEXP = "!~*";
955     break;
956     case 'mysql':
957     default:
958         $LIKE = "LIKE";
959         $NOTLIKE = "NOT LIKE";
960         $REGEXP = "REGEXP";
961         $NOTREGEXP = "NOT REGEXP";
962     break;
963     }
965     $conceptsearch = "";
966     $definitionsearch = "";
969     foreach ($searchterms as $searchterm) {
970         if ($conceptsearch) {
971             $conceptsearch.= " OR ";
972         }
973         if ($definitionsearch) {
974             $definitionsearch.= " OR ";
975         }
977     /// Under Oracle and MSSQL, trim the + and - operators and perform
978     /// simpler LIKE search
979         if ($CFG->dbtype == 'oci8po' || $CFG->dbtype == 'mssql' || $CFG->dbtype == 'mssql_n' || $CFG->dbtype == 'odbc_mssql') {
980             $searchterm = trim($searchterm, '+-');
981         }
983         if (substr($searchterm,0,1) == "+") {
984             $searchterm = substr($searchterm,1);
985             $conceptsearch.= " e.concept $REGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
986             $definitionsearch .= " e.definition $REGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
987         } else if (substr($searchterm,0,1) == "-") {
988             $searchterm = substr($searchterm,1);
989             $conceptsearch .= " e.concept $NOTREGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
990             $definitionsearch .= " e.definition $NOTREGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
991         } else {
992             $conceptsearch .= " e.concept $LIKE '%$searchterm%' ";
993             $definitionsearch .= " e.definition $LIKE '%$searchterm%' ";
994         }
995     }
997     if ( !$extended ) {
998         $definitionsearch = "0";
999     }
1001     $selectsql = "{$CFG->prefix}glossary_entries e,
1002                   {$CFG->prefix}glossary g $onlyvisibletable
1003              WHERE ($conceptsearch OR $definitionsearch)
1004                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1005                AND g.id IN ($glos) AND e.approved != 0";
1007     return get_records_sql("SELECT e.*
1008                             FROM $selectsql ORDER BY e.concept ASC");
1011 function glossary_search_entries($searchterms, $glossary, $extended) {
1012     $course = get_record("course","id",$glossary->course);
1013     return glossary_search($course,$searchterms,$extended,$glossary);
1016 function glossary_file_area_name($entry) {
1017     global $CFG;
1018 //  Creates a directory file name, suitable for make_upload_directory()
1020     // I'm doing this workaround for make it works for delete_instance also
1021     //  (when called from delete_instance, glossary is already deleted so
1022     //   getting the course from mdl_glossary does not work)
1023     $module = get_record("modules","name","glossary");
1024     $cm = get_record("course_modules","module",$module->id,"instance",$entry->glossaryid);
1025     return "$cm->course/$CFG->moddata/glossary/$entry->glossaryid/$entry->id";
1028 function glossary_file_area($entry) {
1029     return make_upload_directory( glossary_file_area_name($entry) );
1032 function glossary_main_file_area($glossary) {
1033     $modarea = glossary_mod_file_area($glossary);
1034     return "$modarea/$glossary->id";
1037 function glossary_mod_file_area($glossary) {
1038     global $CFG;
1040     return make_upload_directory( "$glossary->course/$CFG->moddata/glossary" );
1043 function glossary_delete_old_attachments($entry, $exception="") {
1044 // Deletes all the user files in the attachments area for a entry
1045 // EXCEPT for any file named $exception
1047     if ($basedir = glossary_file_area($entry)) {
1048         if ($files = get_directory_list($basedir)) {
1049             foreach ($files as $file) {
1050                 if ($file != $exception) {
1051                     unlink("$basedir/$file");
1052 //                    notify("Existing file '$file' has been deleted!");
1053                 }
1054             }
1055         }
1056         if (!$exception) {  // Delete directory as well, if empty
1057             rmdir("$basedir");
1058         }
1059     }
1061 function glossary_delete_attachments($glossary) {
1062 // Deletes all the user files in the attachments area for the glossary
1063     if ( $entries = get_records("glossary_entries","glossaryid",$glossary->id) ) {
1064         $deleted = 0;
1065         foreach ($entries as $entry) {
1066             if ( $entry->attachment ) {
1067                 if ($basedir = glossary_file_area($entry)) {
1068                     if ($files = get_directory_list($basedir)) {
1069                         foreach ($files as $file) {
1070                             unlink("$basedir/$file");
1071                         }
1072                     }
1073                     rmdir("$basedir");
1074                     $deleted++;
1075                 }
1076             }
1077         }
1078         if ( $deleted ) {
1079             $attachmentdir = glossary_main_file_area($glossary);
1080             $glossarydir = glossary_mod_file_area($glossary);
1082             rmdir("$attachmentdir");
1083             if (!$files = get_directory_list($glossarydir) ) {
1084                 rmdir( "$glossarydir" );
1085             }
1086         }
1087     }
1090 function glossary_copy_attachments($entry, $newentry) {
1091 /// Given a entry object that is being copied to glossaryid,
1092 /// this function checks that entry
1093 /// for attachments, and if any are found, these are
1094 /// copied to the new glossary directory.
1096     global $CFG;
1098     $return = true;
1100     if ($entries = get_records_select("glossary_entries", "id = '$entry->id' AND attachment <> ''")) {
1101         foreach ($entries as $curentry) {
1102             $oldentry->id = $entry->id;
1103             $oldentry->course = $entry->course;
1104             $oldentry->glossaryid = $curentry->glossaryid;
1105             $oldentrydir = "$CFG->dataroot/".glossary_file_area_name($oldentry);
1106             if (is_dir($oldentrydir)) {
1108                 $newentrydir = glossary_file_area($newentry);
1109                 if (! copy("$oldentrydir/$newentry->attachment", "$newentrydir/$newentry->attachment")) {
1110                     $return = false;
1111                 }
1112             }
1113         }
1114      }
1115     return $return;
1118 function glossary_move_attachments($entry, $glossaryid) {
1119 /// Given a entry object that is being moved to glossaryid,
1120 /// this function checks that entry
1121 /// for attachments, and if any are found, these are
1122 /// moved to the new glossary directory.
1124     global $CFG;
1126     require_once($CFG->dirroot.'/lib/uploadlib.php');
1128     $return = true;
1130     if ($entries = get_records_select("glossary_entries", "glossaryid = '$entry->id' AND attachment <> ''")) {
1131         foreach ($entries as $entry) {
1132             $oldentry->course = $entry->course;
1133             $oldentry->glossaryid = $entry->glossaryid;
1134             $oldentrydir = "$CFG->dataroot/".glossary_file_area_name($oldentry);
1135             if (is_dir($oldentrydir)) {
1136                 $newentry = $oldentry;
1137                 $newentry->glossaryid = $glossaryid;
1138                 $newentrydir = "$CFG->dataroot/".glossary_file_area_name($newentry);
1139                 $files = get_directory_list($oldentrydir); // get it before we rename it.
1140                 if (! @rename($oldentrydir, $newentrydir)) {
1141                     $return = false;
1142                 }
1143                 foreach ($files as $file) {
1144                     // this is not tested as I can't find anywhere that calls this function, grepping the source.
1145                     clam_change_log($oldentrydir.'/'.$file,$newentrydir.'/'.$file);
1146                 }
1147             }
1148         }
1149     }
1150     return $return;
1153 function glossary_print_attachments($entry, $return=NULL, $align="left") {
1154 // if return=html, then return a html string.
1155 // if return=text, then return a text-only string.
1156 // otherwise, print HTML for non-images, and return image HTML
1157 //     if attachment is an image, $align set its aligment.
1158     global $CFG;
1160     $newentry = $entry;
1161     if ( $newentry->sourceglossaryid ) {
1162         $newentry->glossaryid = $newentry->sourceglossaryid;
1163     }
1165     $filearea = glossary_file_area_name($newentry);
1167     $imagereturn = "";
1168     $output = "";
1170     if ($basedir = glossary_file_area($newentry)) {
1171         if ($files = get_directory_list($basedir)) {
1172             $strattachment = get_string("attachment", "glossary");
1173             foreach ($files as $file) {
1174                 $icon = mimeinfo("icon", $file);
1175                 if ($CFG->slasharguments) {
1176                     $ffurl = "$CFG->wwwroot/file.php/$filearea/$file";
1177                 } else {
1178                     $ffurl = "$CFG->wwwroot/file.php?file=/$filearea/$file";
1179                 }
1180                 $image = "<img src=\"$CFG->pixpath/f/$icon\" class=\"icon\" alt=\"\" />";
1182                 if ($return == "html") {
1183                     $output .= "<a href=\"$ffurl\">$image</a> ";
1184                     $output .= "<a href=\"$ffurl\">$file</a><br />";
1186                 } else if ($return == "text") {
1187                     $output .= "$strattachment $file:\n$ffurl\n";
1189                 } else {
1190                     if ($icon == "image.gif") {    // Image attachments don't get printed as links
1191                         $imagereturn .= "<img src=\"$ffurl\" align=\"$align\" alt=\"\" />";
1192                     } else {
1193                         echo "<a href=\"$ffurl\">$image</a> ";
1194                         echo "<a href=\"$ffurl\">$file</a><br />";
1195                     }
1196                 }
1197             }
1198         }
1199     }
1201     if ($return) {
1202         return $output;
1203     }
1205     return $imagereturn;
1208 function glossary_print_tabbed_table_start($data, $currenttab, $tabsperrow=4) {
1210 $tabs                 = count($data);
1211 $tabwidth             = (int) (100 / $tabsperrow);
1213 $currentrow           = ( $currenttab - ( $currenttab % $tabsperrow) ) / $tabsperrow;
1215 $numrows              = (int) ( $tabs / $tabsperrow ) + 1;
1218 /// Following lines are to create a tab object so that
1219 /// we can use the new tab objects and functions
1220 $tabrows = array();
1221 $tabnumber = 0;
1222 $row = array();
1223 $inactive = array();
1224 foreach ($data as $tab) {
1225     $row[] = new tabobject($tabnumber, $tab->link, $tab->caption);
1226     if (empty($tab->link)) {
1227         $inactive[] = $tabnumber;
1228     }
1229     $tabnumber++;
1230     if (($tabnumber % $tabsperrow) == 0) {
1231         $tabrows[] = $row;
1232         unset($row);
1233         $row = array();
1234     }
1236 //Add the last row! if it contains anything!
1237 if (!empty($row)) {
1238     $tabrows[] = $row;
1242 ?>
1243   <table cellspacing="0" class="glossarydisplay">
1244     <tr>
1245       <td width="100%">
1247 <?php print_tabs($tabrows, $currenttab, $inactive);
1249 ?>
1250       </td>
1251     </tr>
1252     <tr>
1253       <td width="100%" class="entryboxheader"><hr /></td>
1254     </tr>
1255     <tr>
1256       <td width="100%" class="entrybox">
1257           <center>
1258 <?php
1261 function glossary_print_tabbed_table_end() {
1262      echo "</td></tr></table></center>";
1265 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1266     if ($glossary->showalphabet) {
1267         echo '<center>' . get_string("explainalphabet","glossary") . '</center><br />';
1268     }
1269     glossary_print_special_links($cm, $glossary, $mode, $hook);
1271     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1273     glossary_print_all_links($cm, $glossary, $mode, $hook);
1275     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1278 function glossary_print_addentry_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1279     echo '<center>' . get_string("explainaddentry","glossary") . '</center><br />';
1282 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1283     echo '<center>' . get_string("explainimport","glossary") . '</center><br />';
1286 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1287     echo '<center>' . get_string("explainexport","glossary") . '</center><br />';
1290 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1291     if ( $mode != 'date' ) {
1292         if ($glossary->showalphabet) {
1293             echo '<center>' . get_string("explainalphabet","glossary") . '</center><br />';
1294         }
1296         glossary_print_special_links($cm, $glossary, $mode, $hook);
1298         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1300         glossary_print_all_links($cm, $glossary, $mode, $hook);
1301     } else {
1302         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1303     }
1306 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1307     if ($glossary->showalphabet) {
1308         echo '<center>' . get_string("explainalphabet","glossary") . '</center><br />';
1309     }
1311     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1312     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1313     glossary_print_all_links($cm, $glossary, $mode, $hook);
1316 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1318      global $CFG;
1320      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1322      echo '<table border="0" width="100%">';
1323      echo '<tr>';
1325      echo '<td align="center" width="20%">';
1326      if (has_capability('mod/glossary:managecategories', $context)) {
1327              $options['id'] = $cm->id;
1328              $options['mode'] = 'cat';
1329              $options['hook'] = $hook;
1330              echo print_single_button("editcategories.php", $options, get_string("editcategories","glossary"), "get");
1331      }
1332      echo '</td>';
1334      echo '<td align="center" width="60%">';
1335      echo '<b>';
1337      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1338      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1340      $categories = get_records("glossary_categories", "glossaryid", $glossary->id, "name ASC");
1341      $selected = '';
1342      if ( $categories ) {
1343           foreach ($categories as $currentcategory) {
1344                  $url = $currentcategory->id;
1345                  if ( $category ) {
1346                      if ($currentcategory->id == $category->id) {
1347                          $selected = $url;
1348                      }
1349                  }
1350                  $menu[$url] = clean_text($currentcategory->name); //Only clean, not filters
1351           }
1352      }
1353      if ( !$selected ) {
1354          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1355      }
1357      if ( $category ) {
1358         echo format_text($category->name);
1359      } else {
1360         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1362             echo get_string("entrieswithoutcategory","glossary");
1363             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1365         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1367             echo get_string("allcategories","glossary");
1368             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1370         }
1371      }
1372      echo '</b></td>';
1373      echo '<td align="center" width="20%">';
1375      echo popup_form("$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=cat&amp;hook=", $menu, "catmenu", $selected, "",
1376                       "", "", false);
1378      echo '</td>';
1379      echo '</tr>';
1381      echo '</table>';
1384 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1385 global $CFG;
1386      if ( $glossary->showall) {
1387          $strallentries       = get_string("allentries", "glossary");
1388          if ( $hook == 'ALL' ) {
1389               echo "<b>$strallentries</b>";
1390          } else {
1391               $strexplainall = strip_tags(get_string("explainall","glossary"));
1392               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1393          }
1394      }
1397 function glossary_print_special_links($cm, $glossary, $mode, $hook) {
1398 global $CFG;
1399      if ( $glossary->showspecial) {
1400          $strspecial          = get_string("special", "glossary");
1401          if ( $hook == 'SPECIAL' ) {
1402               echo "<b>$strspecial</b> | ";
1403          } else {
1404               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1405               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
1406          }
1407      }
1410 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1411 global $CFG;
1412      if ( $glossary->showalphabet) {
1413           $alphabet = explode(",", get_string("alphabet"));
1414           $letters_by_line = 14;
1415           for ($i = 0; $i < count($alphabet); $i++) {
1416               if ( $hook == $alphabet[$i] and $hook) {
1417                    echo "<b>$alphabet[$i]</b>";
1418               } else {
1419                    echo "<a href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=$alphabet[$i]&amp;sortkey=$sortkey&amp;sortorder=$sortorder\">$alphabet[$i]</a>";
1420               }
1421               if ((int) ($i % $letters_by_line) != 0 or $i == 0) {
1422                    echo ' | ';
1423               } else {
1424                    echo '<br />';
1425               }
1426           }
1427      }
1430 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
1431 global $CFG;
1433     $asc    = get_string("ascending","glossary");
1434     $desc   = get_string("descending","glossary");
1435     $bopen  = '<b>';
1436     $bclose = '</b>';
1438      $neworder = '';
1439      if ( $sortorder ) {
1440          if ( $sortorder == 'asc' ) {
1441              $neworder = '&amp;sortorder=desc';
1442              $newordertitle = $desc;
1443          } else {
1444              $neworder = '&amp;sortorder=asc';
1445              $newordertitle = $asc;
1446          }
1447          $icon = " <img src=\"$sortorder.gif\" class=\"icon\" alt=\"". get_string($sortorder)."\" />";
1448      } else {
1449          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
1450                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
1451              $icon = "";
1452              $newordertitle = $asc;
1453          } else {
1454              $newordertitle = $desc;
1455              $neworder = '&amp;sortorder=desc';
1456              $icon = ' <img src="asc.gif" border="0" class="icon" alt="" />';
1457          }
1458      }
1459      $ficon     = '';
1460      $fneworder = '';
1461      $fbtag     = '';
1462      $fendbtag  = '';
1464      $sicon     = '';
1465      $sneworder = '';
1467      $sbtag      = '';
1468      $fbtag      = '';
1469      $fendbtag      = '';
1470      $sendbtag      = '';
1472      $sendbtag  = '';
1474      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
1475          $ficon       = $icon;
1476          $fneworder   = $neworder;
1477          $fordertitle = $newordertitle;
1478          $sordertitle = $asc;
1479          $fbtag       = $bopen;
1480          $fendbtag    = $bclose;
1481      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
1482          $sicon = $icon;
1483          $sneworder   = $neworder;
1484          $fordertitle = $asc;
1485          $sordertitle = $newordertitle;
1486          $sbtag       = $bopen;
1487          $sendbtag    = $bclose;
1488      } else {
1489          $fordertitle = $asc;
1490          $sordertitle = $asc;
1491      }
1493      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
1494          $forder = 'CREATION';
1495          $sorder =  'UPDATE';
1496          $fsort  = get_string("sortbycreation", "glossary");
1497          $ssort  = get_string("sortbylastupdate", "glossary");
1499          $sort        = get_string("sortchronogically", "glossary");
1500      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
1501          $forder = 'FIRSTNAME';
1502          $sorder =  'LASTNAME';
1503          $fsort  = get_string("firstname");
1504          $ssort  = get_string("lastname");
1506          $sort        = get_string("sortby", "glossary");
1507      }
1509      echo "<br />$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 | ".
1510                           "$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 />";
1513 function glossary_sort_entries ( $entry0, $entry1 ) {
1515     if ( moodle_strtolower(ltrim($entry0->concept)) < moodle_strtolower(ltrim($entry1->concept)) ) {
1516         return -1;
1517     } elseif ( moodle_strtolower(ltrim($entry0->concept)) > moodle_strtolower(ltrim($entry1->concept)) ) {
1518         return 1;
1519     } else {
1520         return 0;
1521     }
1524 function glossary_print_comment($course, $cm, $glossary, $entry, $comment) {
1525     global $CFG, $USER;
1527     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1529     $user = get_record('user', 'id', $comment->userid);
1530     $strby = get_string('writtenby','glossary');
1531     $fullname = fullname($user, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
1533     echo '<center>';
1534     echo '<table class="glossarycomment" cellspacing="0">';
1535     echo '<tr valign="top">';
1536     echo '<tr><td class="left picture">';
1537     print_user_picture($user->id, $course->id, $user->picture);
1538     echo '</td>';
1539     echo '<td class="entryheader">';
1541     $fullname = fullname($user, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
1542     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$user->id.'&amp;course='.$course->id.'">'.$fullname.'</a>';
1543     $by->date = userdate($comment->timemodified);
1544     echo '<span class="author">'.get_string('bynameondate', 'forum', $by).'</span>';
1546     echo '</td></tr>';
1548     echo '<tr valign="top"><td class="left side">';
1549     echo '&nbsp;';
1550     echo '</td><td class="entry">';
1552     $options = new object();
1553     $options->trusttext = true;
1554     echo format_text($comment->entrycomment, $comment->format, $options);
1556     echo '<div class="icons commands">';
1558     $ineditperiod = ((time() - $comment->timemodified <  $CFG->maxeditingtime) || $glossary->editalways);
1559     if ( ($glossary->allowcomments &&  $ineditperiod && $USER->id == $comment->userid)  || has_capability('mod/glossary:managecomments', $context)) {
1560         echo "<a href=\"comment.php?cid=$comment->id&amp;action=edit\"><img
1561                alt=\"" . get_string("edit") . "\" src=\"$CFG->pixpath/t/edit.gif\" class=\"iconsmall\" /></a> ";
1562     }
1563     if ( ($glossary->allowcomments && $USER->id == $comment->userid) || has_capability('mod/glossary:managecomments', $context) ) {
1564         echo "<a href=\"comment.php?cid=$comment->id&amp;action=delete\"><img
1565                alt=\"" . get_string("delete") . "\" src=\"$CFG->pixpath/t/delete.gif\" class=\"iconsmall\" /></a>";
1566     }
1568     echo '</div></td></tr>';
1569     echo '</table></center>';
1573 function  glossary_print_entry_ratings($course, $entry, $ratings = NULL) {
1575     global $USER, $CFG;
1577     $glossary = get_record('glossary', 'id', $entry->glossaryid);
1578     $glossarymod = get_record('modules','name','glossary');
1579     $cm = get_record_sql("select * from {$CFG->prefix}course_modules where course = $course->id
1580                           and module = $glossarymod->id and instance = $glossary->id");
1582     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1584     $ratingsmenuused = false;
1585     if (!empty($ratings) and !empty($USER->id)) {
1586         $useratings = true;
1587         if ($ratings->assesstimestart and $ratings->assesstimefinish) {
1588             if ($entry->timecreated < $ratings->assesstimestart or $entry->timecreated > $ratings->assesstimefinish) {
1589                 $useratings = false;
1590             }
1591         }
1592         if ($useratings) {
1593             if (has_capability('mod/glossary:viewrating', $context)) {
1594                 glossary_print_ratings_mean($entry->id, $ratings->scale);
1595                 if ($USER->id != $entry->userid) {
1596                      glossary_print_rating_menu($entry->id, $USER->id, $ratings->scale);
1597                      $ratingsmenuused = true;
1598                 }
1599             } else if ($USER->id == $entry->userid) {
1600                 glossary_print_ratings_mean($entry->id, $ratings->scale);
1601             } else if (!empty($ratings->allow) ) {
1602                 glossary_print_rating_menu($entry->id, $USER->id, $ratings->scale);
1603                 $ratingsmenuused = true;
1604             }
1605         }
1606     }
1607     return $ratingsmenuused;
1610 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
1611     global $USER,$CFG;
1613     echo '<center>';
1614     echo '<table class="glossarypopup" cellspacing="0"><tr>';
1615     echo '<td>';
1616     if ( $entries ) {
1617         foreach ( $entries as $entry ) {
1618             if (! $glossary = get_record('glossary', 'id', $entry->glossaryid)) {
1619                 error('Glossary ID was incorrect or no longer exists');
1620             }
1621             if (! $course = get_record('course', 'id', $glossary->course)) {
1622                 error('Glossary is misconfigured - don\'t know what course it\'s from');
1623             }
1624             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
1625                 error('Glossary is misconfigured - don\'t know what course module it is');
1626             }
1628             //If displayformat is present, override glossary->displayformat
1629             if ($displayformat < 0) {
1630                 $dp = $glossary->displayformat;
1631             } else {
1632                 $dp = $displayformat;
1633             }
1635             //Get popupformatname
1636             $format = get_record('glossary_formats','name',$dp);
1637             $displayformat = $format->popupformatname;
1639             //Check displayformat variable and set to default if necessary
1640             if (!$displayformat) {
1641                 $displayformat = 'dictionary';
1642             }
1644             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1645             $functionname = 'glossary_show_entry_'.$displayformat;
1647             if (file_exists($formatfile)) {
1648                 include_once($formatfile);
1649                 if (function_exists($functionname)) {
1650                     $functionname($course, $cm, $glossary, $entry,'','','','');
1651                 }
1652             }
1653         }
1654     }
1655     echo '</td>';
1656     echo '</tr></table></center>';
1659 function glossary_generate_export_file($glossary, $hook = "", $hook = 0) {
1660     global $CFG;
1662     $co  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1664     $co .= glossary_start_tag("GLOSSARY",0,true);
1665     $co .= glossary_start_tag("INFO",1,true);
1666         $co .= glossary_full_tag("NAME",2,false,$glossary->name);
1667         $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
1668         $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
1669         $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
1670         $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
1671         $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
1672         $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
1673         $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
1674         $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
1675         $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
1676         $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
1677         $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
1679         if ( $entries = get_records("glossary_entries","glossaryid",$glossary->id) ) {
1680             $co .= glossary_start_tag("ENTRIES",2,true);
1681             foreach ($entries as $entry) {
1682                 $permissiongranted = 1;
1683                 if ( $hook ) {
1684                     switch ( $hook ) {
1685                     case "ALL":
1686                     case "SPECIAL":
1687                     break;
1688                     default:
1689                         $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
1690                     break;
1691                     }
1692                 }
1693                 if ( $hook ) {
1694                     switch ( $hook ) {
1695                     case GLOSSARY_SHOW_ALL_CATEGORIES:
1696                     break;
1697                     case GLOSSARY_SHOW_NOT_CATEGORISED:
1698                         $permissiongranted = !record_exists("glossary_entries_categories","entryid",$entry->id);
1699                     break;
1700                     default:
1701                         $permissiongranted = record_exists("glossary_entries_categories","entryid",$entry->id, "categoryid",$hook);
1702                     break;
1703                     }
1704                 }
1705                 if ( $entry->approved and $permissiongranted ) {
1706                     $co .= glossary_start_tag("ENTRY",3,true);
1707                     $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
1708                     $co .= glossary_full_tag("DEFINITION",4,false,trusttext_strip($entry->definition));
1709                     $co .= glossary_full_tag("FORMAT",4,false,$entry->format);
1710                     $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
1711                     $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
1712                     $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
1713                     $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
1715                     if ( $aliases = get_records("glossary_alias","entryid",$entry->id) ) {
1716                         $co .= glossary_start_tag("ALIASES",4,true);
1717                         foreach ($aliases as $alias) {
1718                             $co .= glossary_start_tag("ALIAS",5,true);
1719                                 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
1720                             $co .= glossary_end_tag("ALIAS",5,true);
1721                         }
1722                         $co .= glossary_end_tag("ALIASES",4,true);
1723                     }
1724                     if ( $catentries = get_records("glossary_entries_categories","entryid",$entry->id) ) {
1725                         $co .= glossary_start_tag("CATEGORIES",4,true);
1726                         foreach ($catentries as $catentry) {
1727                             $category = get_record("glossary_categories","id",$catentry->categoryid);
1729                             $co .= glossary_start_tag("CATEGORY",5,true);
1730                                 $co .= glossary_full_tag("NAME",6,false,$category->name);
1731                                 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
1732                             $co .= glossary_end_tag("CATEGORY",5,true);
1733                         }
1734                         $co .= glossary_end_tag("CATEGORIES",4,true);
1735                     }
1737                     $co .= glossary_end_tag("ENTRY",3,true);
1738                 }
1739             }
1740             $co .= glossary_end_tag("ENTRIES",2,true);
1742         }
1745     $co .= glossary_end_tag("INFO",1,true);
1746     $co .= glossary_end_tag("GLOSSARY",0,true);
1748     return $co;
1750 /// Functions designed by Eloy Lafuente
1751 /// Functions to create, open and write header of the xml file
1753 // Read import file and convert to current charset
1754 function glossary_read_imported_file($file) {
1755     require_once "../../lib/xmlize.php";
1756     global $CFG;
1758     $h = fopen($file,"r");
1759     $line = '';
1760     if ($h) {
1761         while ( !feof($h) ) {
1762            $char = fread($h,1024);
1763            $line .= $char;
1764         }
1765         fclose($h);
1766     }
1767     return xmlize($line, 0);
1770 //Return the xml start tag
1771 function glossary_start_tag($tag,$level=0,$endline=false) {
1772         if ($endline) {
1773            $endchar = "\n";
1774         } else {
1775            $endchar = "";
1776         }
1777         return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
1780 //Return the xml end tag
1781 function glossary_end_tag($tag,$level=0,$endline=true) {
1782         if ($endline) {
1783            $endchar = "\n";
1784         } else {
1785            $endchar = "";
1786         }
1787         return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
1790 //Return the start tag, the contents and the end tag
1791 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
1792         global $CFG;
1794         $st = glossary_start_tag($tag,$level,$endline);
1795         $co = preg_replace("/\r\n|\r/", "\n", s($content));
1796         $et = glossary_end_tag($tag,0,true);
1797         return $st.$co.$et;
1800 /*
1801 * Adding grading functions
1802 */
1804 function glossary_get_ratings($entryid, $sort="u.firstname ASC") {
1805 /// Returns a list of ratings for a particular entry - sorted.
1806     global $CFG;
1807     return get_records_sql("SELECT u.*, r.rating, r.time
1808                               FROM {$CFG->prefix}glossary_ratings r,
1809                                    {$CFG->prefix}user u
1810                              WHERE r.entryid = '$entryid'
1811                                AND r.userid = u.id
1812                              ORDER BY $sort");
1815 function glossary_get_user_grades($glossaryid) {
1816 /// Get all user grades for a glossary
1817     global $CFG;
1819     return get_records_sql("SELECT r.id, e.userid, r.rating
1820                               FROM {$CFG->prefix}glossary_entries e,
1821                                    {$CFG->prefix}glossary_ratings r
1822                              WHERE e.glossaryid = '$glossaryid'
1823                                AND r.entryid = e.id
1824                              ORDER by e.userid ");
1827 function glossary_count_unrated_entries($glossaryid, $userid) {
1828 // How many unrated entries are in the given glossary for a given user?
1829     global $CFG;
1830     if ($entries = get_record_sql("SELECT count(*) as num
1831                                    FROM {$CFG->prefix}glossary_entries
1832                                   WHERE glossaryid = '$glossaryid'
1833                                     AND userid <> '$userid' ")) {
1835         if ($rated = get_record_sql("SELECT count(*) as num
1836                                        FROM {$CFG->prefix}glossary_entries e,
1837                                             {$CFG->prefix}glossary_ratings r
1838                                       WHERE e.glossaryid = '$glossaryid'
1839                                         AND e.id = r.entryid
1840                                         AND r.userid = '$userid'")) {
1841             $difference = $entries->num - $rated->num;
1842             if ($difference > 0) {
1843                 return $difference;
1844             } else {
1845                 return 0;    // Just in case there was a counting error
1846             }
1847         } else {
1848             return $entries->num;
1849         }
1850     } else {
1851         return 0;
1852     }
1855 function glossary_print_ratings_mean($entryid, $scale) {
1856 /// Print the multiple ratings on a entry given to the current user by others.
1857 /// Scale is an array of ratings
1859     static $strrate;
1861     $mean = glossary_get_ratings_mean($entryid, $scale);
1863     if ($mean !== "") {
1865         if (empty($strratings)) {
1866             $strratings = get_string("ratings", "glossary");
1867         }
1869         echo "$strratings: ";
1870         link_to_popup_window ("/mod/glossary/report.php?id=$entryid", "ratings", $mean, 400, 600);
1871     }
1875 function glossary_get_ratings_mean($entryid, $scale, $ratings=NULL) {
1876 /// Return the mean rating of a entry given to the current user by others.
1877 /// Scale is an array of possible ratings in the scale
1878 /// Ratings is an optional simple array of actual ratings (just integers)
1880     if (!$ratings) {
1881         $ratings = array();
1882         if ($rates = get_records("glossary_ratings", "entryid", $entryid)) {
1883             foreach ($rates as $rate) {
1884                 $ratings[] = $rate->rating;
1885             }
1886         }
1887     }
1889     $count = count($ratings);
1891     if ($count == 0) {
1892         return "";
1894     } else if ($count == 1) {
1895         return $scale[$ratings[0]];
1897     } else {
1898         $total = 0;
1899         foreach ($ratings as $rating) {
1900             $total += $rating;
1901         }
1902         $mean = round( ((float)$total/(float)$count) + 0.001);  // Little fudge factor so that 0.5 goes UP
1904         if (isset($scale[$mean])) {
1905             return $scale[$mean]." ($count)";
1906         } else {
1907             return "$mean ($count)";    // Should never happen, hopefully
1908         }
1909     }
1912 function glossary_get_ratings_summary($entryid, $scale, $ratings=NULL) {
1913 /// Return a summary of entry ratings given to the current user by others.
1914 /// Scale is an array of possible ratings in the scale
1915 /// Ratings is an optional simple array of actual ratings (just integers)
1917     if (!$ratings) {
1918         $ratings = array();
1919         if ($rates = get_records("glossary_ratings", "entryid", $entryid)) {
1920             foreach ($rates as $rate) {
1921                 $rating[] = $rate->rating;
1922             }
1923         }
1924     }
1927     if (!$count = count($ratings)) {
1928         return "";
1929     }
1932     foreach ($scale as $key => $scaleitem) {
1933         $sumrating[$key] = 0;
1934     }
1936     foreach ($ratings as $rating) {
1937         $sumrating[$rating]++;
1938     }
1940     $summary = "";
1941     foreach ($scale as $key => $scaleitem) {
1942         $summary = $sumrating[$key].$summary;
1943         if ($key > 1) {
1944             $summary = "/$summary";
1945         }
1946     }
1947     return $summary;
1950 function glossary_print_rating_menu($entryid, $userid, $scale) {
1951 /// Print the menu of ratings as part of a larger form.
1952 /// If the entry has already been - set that value.
1953 /// Scale is an array of ratings
1955     static $strrate;
1957     if (!$rating = get_record("glossary_ratings", "userid", $userid, "entryid", $entryid)) {
1958         $rating->rating = -999;
1959     }
1961     if (empty($strrate)) {
1962         $strrate = get_string("rate", "glossary");
1963     }
1965     choose_from_menu($scale, $entryid, $rating->rating, "$strrate...",'',-999);
1969 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) {
1970 // Returns the html code to represent any pagging bar. Paramenters are:
1971 //
1972 //  Mandatory:
1973 //     $totalcount: total number of records to be displayed
1974 //     $page: page currently selected (0 based)
1975 //     $perpage: number of records per page
1976 //     $baseurl: url to link in each page, the string 'page=XX' will be added automatically.
1977 //  Optional:
1978 //     $maxpageallowed: maximum number of page allowed.
1979 //     $maxdisplay: maximum number of page links to show in the bar
1980 //     $separator: string to be used between pages in the bar
1981 //     $specialtext: string to be showed as an special link
1982 //     $specialvalue: value (page) to be used in the special link
1983 //     $previousandnext: to decide if we want the previous and next links
1984 //
1985 // The function dinamically show the first and last pages, and "scroll" over pages.
1986 // Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
1987 // could replace the general one. ;-)
1989     $code = '';
1991     $showspecial = false;
1992     $specialselected = false;
1994     //Check if we have to show the special link
1995     if (!empty($specialtext)) {
1996         $showspecial = true;
1997     }
1998     //Check if we are with the special link selected
1999     if ($showspecial && $page == $specialvalue) {
2000         $specialselected = true;
2001     }
2003     //If there are results (more than 1 page)
2004     if ($totalcount > $perpage) {
2005         $code .= "<center>";
2006         $code .= "<p>".get_string("page").":";
2008         $maxpage = (int)(($totalcount-1)/$perpage);
2010         //Lower and upper limit of page
2011         if ($page < 0) {
2012             $page = 0;
2013         }
2014         if ($page > $maxpageallowed) {
2015             $page = $maxpageallowed;
2016         }
2017         if ($page > $maxpage) {
2018             $page = $maxpage;
2019         }
2021         //Calculate the window of pages
2022         $pagefrom = $page - ((int)($maxdisplay / 2));
2023         if ($pagefrom < 0) {
2024             $pagefrom = 0;
2025         }
2026         $pageto = $pagefrom + $maxdisplay - 1;
2027         if ($pageto > $maxpageallowed) {
2028             $pageto = $maxpageallowed;
2029         }
2030         if ($pageto > $maxpage) {
2031             $pageto = $maxpage;
2032         }
2034         //Some movements can be necessary if don't see enought pages
2035         if ($pageto - $pagefrom < $maxdisplay - 1) {
2036             if ($pageto - $maxdisplay + 1 > 0) {
2037                 $pagefrom = $pageto - $maxdisplay + 1;
2038             }
2039         }
2041         //Calculate first and last if necessary
2042         $firstpagecode = '';
2043         $lastpagecode = '';
2044         if ($pagefrom > 0) {
2045             $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2046             if ($pagefrom > 1) {
2047                 $firstpagecode .= "$separator...";
2048             }
2049         }
2050         if ($pageto < $maxpage) {
2051             if ($pageto < $maxpage -1) {
2052                 $lastpagecode = "$separator...";
2053             }
2054             $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2055         }
2057         //Previous
2058         if ($page > 0 && $previousandnext) {
2059             $pagenum = $page - 1;
2060             $code .= "&nbsp;(<a  href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;";
2061         }
2063         //Add first
2064         $code .= $firstpagecode;
2066         $pagenum = $pagefrom;
2068         //List of maxdisplay pages
2069         while ($pagenum <= $pageto) {
2070             $pagetoshow = $pagenum +1;
2071             if ($pagenum == $page && !$specialselected) {
2072                 $code .= "$separator$pagetoshow";
2073             } else {
2074                 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2075             }
2076             $pagenum++;
2077         }
2079         //Add last
2080         $code .= $lastpagecode;
2082         //Next
2083         if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2084             $pagenum = $page + 1;
2085             $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2086         }
2088         //Add special
2089         if ($showspecial) {
2090             $code .= '<br />';
2091             if ($specialselected) {
2092                 $code .= $specialtext;
2093             } else {
2094                 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2095             }
2096         }
2098         //End html
2099         $code .= "</p>";
2100         $code .= "</center>";
2101     }
2103     return $code;
2106 function glossary_get_view_actions() {
2107     return array('view','view all','view entry');
2110 function glossary_get_post_actions() {
2111     return array('add category','add comment','add entry','approve entry','delete category','delete comment','delete entry','edit category','update comment','update entry');
2114 ?>