5d2dc5337008b59e102bd0120b906ac239d85714
[moodle.git] / mod / glossary / view.php
1 <?php
3 /// This page prints a particular instance of glossary
4 require_once("../../config.php");
5 require_once("lib.php");
6 require_once("$CFG->libdir/rsslib.php");
8 $id = optional_param('id', 0, PARAM_INT);           // Course Module ID
9 $g  = optional_param('g', 0, PARAM_INT);            // Glossary ID
11 $tab  = optional_param('tab', GLOSSARY_NO_VIEW, PARAM_ALPHA);    // browsing entries by categories?
12 $displayformat = optional_param('displayformat',-1, PARAM_INT);  // override of the glossary display format
14 $mode       = optional_param('mode', '', PARAM_ALPHA);           // term entry cat date letter search author approval
15 $hook       = optional_param('hook', '', PARAM_CLEAN);           // the term, entry, cat, etc... to look for based on mode
16 $fullsearch = optional_param('fullsearch', 0,PARAM_INT);         // full search (concept and definition) when searching?
17 $sortkey    = optional_param('sortkey', '', PARAM_ALPHA);// Sorted view: CREATION | UPDATE | FIRSTNAME | LASTNAME...
18 $sortorder  = optional_param('sortorder', 'ASC', PARAM_ALPHA);   // it defines the order of the sorting (ASC or DESC)
19 $offset     = optional_param('offset', 0,PARAM_INT);             // entries to bypass (for paging purposes)
20 $page       = optional_param('page', 0,PARAM_INT);               // Page to show (for paging purposes)
21 $show       = optional_param('show', '', PARAM_ALPHA);           // [ concept | alias ] => mode=term hook=$show
23 if (!empty($id)) {
24     if (! $cm = get_coursemodule_from_id('glossary', $id)) {
25         print_error('invalidcoursemodule');
26     }
27     if (! $course = $DB->get_record("course", array("id"=>$cm->course))) {
28         print_error('coursemisconf');
29     }
30     if (! $glossary = $DB->get_record("glossary", array("id"=>$cm->instance))) {
31         print_error('invalidid', 'glossary');
32     }
34 } else if (!empty($g)) {
35     if (! $glossary = $DB->get_record("glossary", array("id"=>$g))) {
36         print_error('invalidid', 'glossary');
37     }
38     if (! $course = $DB->get_record("course", array("id"=>$glossary->course))) {
39         print_error('invalidcourseid');
40     }
41     if (!$cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id)) {
42         print_error('invalidcoursemodule');
43     }
44     $id = $cm->id;
45 } else {
46     print_error('invalidid', 'glossary');
47 }
49 require_course_login($course->id, true, $cm);
50 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
52 require_once($CFG->dirroot . '/comment/lib.php');
53 comment::init();
55 /// Loading the textlib singleton instance. We are going to need it.
56 $textlib = textlib_get_instance();
58 /// redirecting if adding a new entry
59 if ($tab == GLOSSARY_ADDENTRY_VIEW ) {
60     redirect("edit.php?cmid=$cm->id&amp;mode=$mode");
61 }
63 /// setting the defaut number of entries per page if not set
65 if ( !$entriesbypage = $glossary->entbypage ) {
66     $entriesbypage = $CFG->glossary_entbypage;
67 }
69 /// If we have received a page, recalculate offset
70 if ($page != 0 && $offset == 0) {
71     $offset = $page * $entriesbypage;
72 }
74 /// setting the default values for the display mode of the current glossary
75 /// only if the glossary is viewed by the first time
76 if ( $dp = $DB->get_record('glossary_formats', array('name'=>$glossary->displayformat)) ) {
77 /// Based on format->defaultmode, we build the defaulttab to be showed sometimes
78     switch ($dp->defaultmode) {
79         case 'cat':
80             $defaulttab = GLOSSARY_CATEGORY_VIEW;
81             break;
82         case 'date':
83             $defaulttab = GLOSSARY_DATE_VIEW;
84             break;
85         case 'author':
86             $defaulttab = GLOSSARY_AUTHOR_VIEW;
87             break;
88         default:
89             $defaulttab = GLOSSARY_STANDARD_VIEW;
90     }
91 /// Fetch the rest of variables
92     $printpivot = $dp->showgroup;
93     if ( $mode == '' and $hook == '' and $show == '') {
94         $mode      = $dp->defaultmode;
95         $hook      = $dp->defaulthook;
96         $sortkey   = $dp->sortkey;
97         $sortorder = $dp->sortorder;
98     }
99 } else {
100     $defaulttab = GLOSSARY_STANDARD_VIEW;
101     $printpivot = 1;
102     if ( $mode == '' and $hook == '' and $show == '') {
103         $mode = 'letter';
104         $hook = 'ALL';
105     }
108 if ( $displayformat == -1 ) {
109      $displayformat = $glossary->displayformat;
112 if ( $show ) {
113     $mode = 'term';
114     $hook = $show;
115     $show = '';
117 /// Processing standard security processes
118 if ($course->id != SITEID) {
119     require_login($course->id);
121 if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', $context)) {
122     echo $OUTPUT->header();
123     notice(get_string("activityiscurrentlyhidden"));
125 add_to_log($course->id, "glossary", "view", "view.php?id=$cm->id&amp;tab=$tab", $glossary->id, $cm->id);
127 /// stablishing flag variables
128 if ( $sortorder = strtolower($sortorder) ) {
129     if ($sortorder != 'asc' and $sortorder != 'desc') {
130         $sortorder = '';
131     }
133 if ( $sortkey = strtoupper($sortkey) ) {
134     if ($sortkey != 'CREATION' and
135         $sortkey != 'UPDATE' and
136         $sortkey != 'FIRSTNAME' and
137         $sortkey != 'LASTNAME'
138         ) {
139         $sortkey = '';
140     }
143 switch ( $mode = strtolower($mode) ) {
144 case 'search': /// looking for terms containing certain word(s)
145     $tab = GLOSSARY_STANDARD_VIEW;
147     //Clean a bit the search string
148     $hook = trim(strip_tags($hook));
150 break;
152 case 'entry':  /// Looking for a certain entry id
153     $tab = GLOSSARY_STANDARD_VIEW;
154     if ( $dp = $DB->get_record("glossary_formats", array("name"=>$glossary->displayformat)) ) {
155         $displayformat = $dp->popupformatname;
156     }
157 break;
159 case 'cat':    /// Looking for a certain cat
160     $tab = GLOSSARY_CATEGORY_VIEW;
161     if ( $hook > 0 ) {
162         $category = $DB->get_record("glossary_categories", array("id"=>$hook));
163     }
164 break;
166 case 'approval':    /// Looking for entries waiting for approval
167     $tab = GLOSSARY_APPROVAL_VIEW;
168     if ( !$hook and !$sortkey and !$sortorder) {
169         $hook = 'ALL';
170     }
171 break;
173 case 'term':   /// Looking for entries that include certain term in its concept, definition or aliases
174     $tab = GLOSSARY_STANDARD_VIEW;
175 break;
177 case 'date':
178     $tab = GLOSSARY_DATE_VIEW;
179     if ( !$sortkey ) {
180         $sortkey = 'UPDATE';
181     }
182     if ( !$sortorder ) {
183         $sortorder = 'desc';
184     }
185 break;
187 case 'author':  /// Looking for entries, browsed by author
188     $tab = GLOSSARY_AUTHOR_VIEW;
189     if ( !$hook ) {
190         $hook = 'ALL';
191     }
192     if ( !$sortkey ) {
193         $sortkey = 'FIRSTNAME';
194     }
195     if ( !$sortorder ) {
196         $sortorder = 'asc';
197     }
198 break;
200 case 'letter':  /// Looking for entries that begin with a certain letter, ALL or SPECIAL characters
201 default:
202     $tab = GLOSSARY_STANDARD_VIEW;
203     if ( !$hook ) {
204         $hook = 'ALL';
205     }
206 break;
209 switch ( $tab ) {
210 case GLOSSARY_IMPORT_VIEW:
211 case GLOSSARY_EXPORT_VIEW:
212 case GLOSSARY_APPROVAL_VIEW:
213     $showcommonelements = 0;
214 break;
216 default:
217     $showcommonelements = 1;
218 break;
221 /// Printing the heading
222 $strglossaries = get_string("modulenameplural", "glossary");
223 $strglossary = get_string("modulename", "glossary");
224 $strallcategories = get_string("allcategories", "glossary");
225 $straddentry = get_string("addentry", "glossary");
226 $strnoentries = get_string("noentries", "glossary");
227 $strsearchindefinition = get_string("searchindefinition", "glossary");
228 $strsearch = get_string("search");
229 $strwaitingapproval = get_string('waitingapproval', 'glossary');
231 /// If we are in approval mode, prit special header
232 $PAGE->set_title(format_string($glossary->name));
233 $PAGE->set_heading($course->fullname);
234 $url = new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id));
235 if (isset($mode)) {
236     $url->param('mode', $mode);
238 $PAGE->set_url($url);
240 if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds)
241     && $glossary->rsstype && $glossary->rssarticles) {
243     $rsstitle = format_string($course->shortname) . ': %fullname%';
244     rss_add_http_header($context, 'mod_glossary', $glossary, $rsstitle);
247 if ($tab == GLOSSARY_APPROVAL_VIEW) {
248     require_capability('mod/glossary:approve', $context);
249     $PAGE->navbar->add($strwaitingapproval);
250     echo $OUTPUT->header();
251     echo $OUTPUT->heading($strwaitingapproval);
252 } else { /// Print standard header
253     echo $OUTPUT->header();
256 /// All this depends if whe have $showcommonelements
257 if ($showcommonelements) {
258 /// To calculate available options
259     $availableoptions = '';
261 /// Decide about to print the import link
262     /*if (has_capability('mod/glossary:import', $context)) {
263         $availableoptions = '<span class="helplink">' .
264                             '<a href="' . $CFG->wwwroot . '/mod/glossary/import.php?id=' . $cm->id . '"' .
265                             '  title="' . s(get_string('importentries', 'glossary')) . '">' .
266                             get_string('importentries', 'glossary') . '</a>' .
267                             '</span>';
268     }
269 /// Decide about to print the export link
270     if (has_capability('mod/glossary:export', $context)) {
271         if ($availableoptions) {
272             $availableoptions .= '&nbsp;/&nbsp;';
273         }
274         $availableoptions .='<span class="helplink">' .
275                             '<a href="' . $CFG->wwwroot . '/mod/glossary/export.php?id=' . $cm->id .
276                             '&amp;mode='.$mode . '&amp;hook=' . urlencode($hook) . '"' .
277                             '  title="' . s(get_string('exportentries', 'glossary')) . '">' .
278                             get_string('exportentries', 'glossary') . '</a>' .
279                             '</span>';
280     }*/
282 /// Decide about to print the approval link
283     if (has_capability('mod/glossary:approve', $context)) {
284     /// Check we have pending entries
285         if ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$glossary->id, 'approved'=>0))) {
286             if ($availableoptions) {
287                 $availableoptions .= '<br />';
288             }
289             $availableoptions .='<span class="helplink">' .
290                                 '<a href="' . $CFG->wwwroot . '/mod/glossary/view.php?id=' . $cm->id .
291                                 '&amp;mode=approval' . '"' .
292                                 '  title="' . s(get_string('waitingapproval', 'glossary')) . '">' .
293                                 get_string('waitingapproval', 'glossary') . ' ('.$hiddenentries.')</a>' .
294                                 '</span>';
295         }
296     }
298 /// Start to print glossary controls
299 //        print_box_start('glossarycontrol clearfix');
300     echo '<div class="glossarycontrol" style="text-align: right">';
301     echo $availableoptions;
303 /// The print icon
304     if ( $showcommonelements and $mode != 'search') {
305         if (has_capability('mod/glossary:manageentries', $context) or $glossary->allowprintview) {
306 //                print_box_start('printicon');
307             echo '<span class="wrap printicon">';
308             echo " <a title =\"". get_string("printerfriendly","glossary") ."\" href=\"print.php?id=$cm->id&amp;mode=$mode&amp;hook=".urlencode($hook)."&amp;sortkey=$sortkey&amp;sortorder=$sortorder&amp;offset=$offset\"><img class=\"icon\" src=\"".$OUTPUT->pix_url('print', 'glossary')."\" alt=\"". get_string("printerfriendly","glossary") . "\" /></a>";
309             echo '</span>';
310 //                print_box_end();
311         }
312     }
313 /// End glossary controls
314 //        print_box_end(); /// glossarycontrol
315     echo '</div>';
317 //        print_box('&nbsp;', 'clearer');
320 /// Info box
321 if ($glossary->intro && $showcommonelements) {
322     echo $OUTPUT->box(format_module_intro('glossary', $glossary, $cm->id), 'generalbox', 'intro');
325 /// Search box
326 if ($showcommonelements ) {
327     echo '<form method="post" action="view.php">';
329     echo '<table class="boxaligncenter" width="70%" border="0">';
330     echo '<tr><td align="center" class="glossarysearchbox">';
332     echo '<input type="submit" value="'.$strsearch.'" name="searchbutton" /> ';
333     if ($mode == 'search') {
334         echo '<input type="text" name="hook" size="20" value="'.s($hook).'" alt="'.$strsearch.'" /> ';
335     } else {
336         echo '<input type="text" name="hook" size="20" value="" alt="'.$strsearch.'" /> ';
337     }
338     if ($fullsearch || $mode != 'search') {
339         $fullsearchchecked = 'checked="checked"';
340     } else {
341         $fullsearchchecked = '';
342     }
343     echo '<input type="checkbox" name="fullsearch" id="fullsearch" value="1" '.$fullsearchchecked.' />';
344     echo '<input type="hidden" name="mode" value="search" />';
345     echo '<input type="hidden" name="id" value="'.$cm->id.'" />';
346     echo '<label for="fullsearch">'.$strsearchindefinition.'</label>';
347     echo '</td></tr></table>';
349     echo '</form>';
351     echo '<br />';
354 /// Show the add entry button if allowed
355 if (has_capability('mod/glossary:write', $context) && $showcommonelements ) {
356     echo '<div class="singlebutton glossaryaddentry">';
357     echo "<form id=\"newentryform\" method=\"get\" action=\"$CFG->wwwroot/mod/glossary/edit.php\">";
358     echo '<div>';
359     echo "<input type=\"hidden\" name=\"cmid\" value=\"$cm->id\" />";
360     echo '<input type="submit" value="'.get_string('addentry', 'glossary').'" />';
361     echo '</div>';
362     echo '</form>';
363     echo "</div>\n";
366 echo '<br />';
368 require("tabs.php");
370 require("sql.php");
372 /// printing the entries
373 $entriesshown = 0;
374 $currentpivot = '';
375 $paging = NULL;
377 if ($allentries) {
379     //Decide if we must show the ALL link in the pagebar
380     $specialtext = '';
381     if ($glossary->showall) {
382         $specialtext = get_string("allentries","glossary");
383     }
385     //Build paging bar
386     $paging = glossary_get_paging_bar($count, $page, $entriesbypage, "view.php?id=$id&amp;mode=$mode&amp;hook=".urlencode($hook)."&amp;sortkey=$sortkey&amp;sortorder=$sortorder&amp;fullsearch=$fullsearch&amp;",9999,10,'&nbsp;&nbsp;', $specialtext, -1);
388     echo '<div class="paging">';
389     echo $paging;
390     echo '</div>';
393     //load ratings
394     require_once($CFG->dirroot.'/rating/lib.php');
395     if ($glossary->assessed!=RATING_AGGREGATE_NONE) {
396         $ratingoptions = new stdclass();
397         $ratingoptions->context = $cm->context;
398         $ratingoptions->items = $allentries;
399         $ratingoptions->aggregate = $glossary->assessed;//the aggregation method
400         $ratingoptions->scaleid = $glossary->scale;
401         $ratingoptions->userid = $USER->id;
402         $ratingoptions->returnurl = $CFG->wwwroot.'/mod/glossary/view.php?id='.$cm->id;
403         $ratingoptions->assesstimestart = $glossary->assesstimestart;
404         $ratingoptions->assesstimefinish = $glossary->assesstimefinish;
405         $ratingoptions->plugintype = 'mod';
406         $ratingoptions->pluginname = 'glossary';
408         $rm = new rating_manager();
409         $allentries = $rm->get_ratings($ratingoptions);
410     }
412     foreach ($allentries as $entry) {
414         // Setting the pivot for the current entry
415         $pivot = $entry->glossarypivot;
416         $upperpivot = $textlib->strtoupper($pivot);
417         // Reduce pivot to 1cc if necessary
418         if ( !$fullpivot ) {
419             $upperpivot = $textlib->substr($upperpivot, 0, 1);
420         }
422         // if there's a group break
423         if ( $currentpivot != $upperpivot ) {
425             // print the group break if apply
426             if ( $printpivot )  {
427                 $currentpivot = $upperpivot;
429                 echo '<div>';
430                 echo '<table cellspacing="0" class="glossarycategoryheader">';
432                 echo '<tr>';
433                 $pivottoshow = $currentpivot;
434                 if ( isset($entry->userispivot) ) {
435                 // printing the user icon if defined (only when browsing authors)
436                     echo '<th align="left">';
438                     $user = $DB->get_record("user", array("id"=>$entry->userid));
439                     echo $OUTPUT->user_picture($user, array('courseid'=>$course->id));
440                     $pivottoshow = fullname($user, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
441                 } else {
442                     echo '<th >';
443                 }
445                 echo $OUTPUT->heading($pivottoshow);
446                 echo "</th></tr></table></div>\n";
448             }
449         }
451         /// highlight the term if necessary
452         if ($mode == 'search') {
453             //We have to strip any word starting by + and take out words starting by -
454             //to make highlight works properly
455             $searchterms = explode(' ', $hook);    // Search for words independently
456             foreach ($searchterms as $key => $searchterm) {
457                 if (preg_match('/^\-/',$searchterm)) {
458                     unset($searchterms[$key]);
459                 } else {
460                     $searchterms[$key] = preg_replace('/^\+/','',$searchterm);
461                 }
462                 //Avoid highlight of <2 len strings. It's a well known hilight limitation.
463                 if (strlen($searchterm) < 2) {
464                     unset($searchterms[$key]);
465                 }
466             }
467             $strippedsearch = implode(' ', $searchterms);    // Rebuild the string
468             $entry->highlight = $strippedsearch;
469         }
471         /// and finally print the entry.
472         glossary_print_entry($course, $cm, $glossary, $entry, $mode, $hook,1,$displayformat);
473         $entriesshown++;
474     }
476 if ( !$entriesshown ) {
477     echo $OUTPUT->box(get_string("noentries","glossary"), "generalbox boxaligncenter boxwidthwide");
480 if (!empty($formsent)) {
481     // close the form properly if used
482     echo "</div>";
483     echo "</form>";
486 if ( $paging ) {
487     echo '<hr />';
488     echo '<div class="paging">';
489     echo $paging;
490     echo '</div>';
492 echo '<br />';
493 glossary_print_tabbed_table_end();
495 /// Finish the page
496 echo $OUTPUT->footer();
498 /// Mark as viewed
499 $completion=new completion_info($course);
500 $completion->set_module_viewed($cm);