Merge branch 'MDL-27734-workshop-example-weight' of git://github.com/mudrd8mz/moodle
[moodle.git] / mod / wiki / renderer.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Moodle Wiki 2.0 Renderer
20  *
21  * @package   mod-wiki
22  * @copyright 2010 Dongsheng Cai <dongsheng@moodle.com>
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 class mod_wiki_renderer extends plugin_renderer_base {
29     public function page_index() {
30         global $CFG;
31         $output = '';
32         // Checking wiki instance
33         if (!$wiki = wiki_get_wiki($this->page->cm->instance)) {
34             return false;
35         }
37         // @TODO: Fix call to wiki_get_subwiki_by_group
38         $gid = groups_get_activity_group($this->page->cm);
39         $gid = !empty($gid) ? $gid : 0;
40         if (!$subwiki = wiki_get_subwiki_by_group($this->page->cm->instance, $gid)) {
41             return false;
42         }
43         $swid = $subwiki->id;
44         $pages = wiki_get_page_list($swid);
45         $selectoptions = array();
46         foreach ($pages as $page) {
47             $selectoptions[$page->id] = $page->title;
48         }
49         $label = get_string('pageindex', 'wiki') . ': ';
50         $select = new single_select(new moodle_url('/mod/wiki/view.php'), 'pageid', $selectoptions);
51         $select->label = $label;
52         return $this->output->container($this->output->render($select), 'wiki_index');
53     }
55     public function search_result($records, $subwiki) {
56         global $CFG, $PAGE;
57         $table = new html_table();
58         $context = get_context_instance(CONTEXT_MODULE, $PAGE->cm->id);
59         $strsearchresults = get_string('searchresult', 'wiki');
60         $totalcount = count($records);
61         $html = $this->output->heading("$strsearchresults $totalcount");
62         foreach ($records as $page) {
63             $table->head = array('title' => format_string($page->title) . ' (' . html_writer::link($CFG->wwwroot . '/mod/wiki/view.php?pageid=' . $page->id, get_string('view', 'wiki')) . ')');
64             $table->align = array('title' => 'left');
65             $table->width = '100%';
66             $table->data = array(array(file_rewrite_pluginfile_urls(format_text($page->cachedcontent, FORMAT_HTML), 'pluginfile.php', $context->id, 'mod_wiki', 'attachments', $subwiki->id)));
67             $table->colclasses = array('wikisearchresults');
68             $html .= html_writer::table($table);
69         }
70         $html = html_writer::tag('div', $html, array('class'=>'no-overflow'));
71         return $this->output->container($html);
72     }
74     public function diff($pageid, $old, $new, $options = array()) {
75         global $CFG;
76         if (!empty($options['total'])) {
77             $total = $options['total'];
78         } else {
79             $total = 0;
80         }
81         $diff1 = format_text($old->diff, FORMAT_HTML, array('overflowdiv'=>true));
82         $diff2 = format_text($new->diff, FORMAT_HTML, array('overflowdiv'=>true));
83         $strdatetime = get_string('strftimedatetime', 'langconfig');
85         $olduser = $old->user;
86         $versionlink = new moodle_url('/mod/wiki/viewversion.php', array('pageid' => $pageid, 'versionid' => $old->id));
87         $restorelink = new moodle_url('/mod/wiki/restoreversion.php', array('pageid' => $pageid, 'versionid' => $old->id));
88         $userlink = new moodle_url('/user/view.php', array('id' => $olduser->id));
89         // view version link
90         $oldversionview = ' ';
91         $oldversionview .= html_writer::link($versionlink->out(false), get_string('view', 'wiki'), array('class' => 'wiki_diffview'));
92         $oldversionview .= ' ';
93         // restore version link
94         $oldversionview .= html_writer::link($restorelink->out(false), get_string('restore', 'wiki'), array('class' => 'wiki_diffview'));
96         // userinfo container
97         $oldheading = $this->output->container_start('wiki_diffuserleft');
98         // username
99         $oldheading .= html_writer::link($CFG->wwwroot . '/user/view.php?id=' . $olduser->id, fullname($olduser)) . '&nbsp;';
100         // user picture
101         $oldheading .= html_writer::link($userlink->out(false), $this->output->user_picture($olduser, array('popup' => true)), array('class' => 'notunderlined'));
102         $oldheading .= $this->output->container_end();
104         // version number container
105         $oldheading .= $this->output->container_start('wiki_diffversion');
106         $oldheading .= get_string('version') . ' ' . $old->version . $oldversionview;
107         $oldheading .= $this->output->container_end();
108         // userdate container
109         $oldheading .= $this->output->container_start('wiki_difftime');
110         $oldheading .= userdate($old->timecreated, $strdatetime);
111         $oldheading .= $this->output->container_end();
113         $newuser = $new->user;
114         $versionlink = new moodle_url('/mod/wiki/viewversion.php', array('pageid' => $pageid, 'versionid' => $new->id));
115         $restorelink = new moodle_url('/mod/wiki/restoreversion.php', array('pageid' => $pageid, 'versionid' => $new->id));
116         $userlink = new moodle_url('/user/view.php', array('id' => $newuser->id));
118         $newversionview = ' ';
119         $newversionview .= html_writer::link($versionlink->out(false), get_string('view', 'wiki'), array('class' => 'wiki_diffview'));
120         // new user info
121         $newheading = $this->output->container_start('wiki_diffuserright');
122         $newheading .= $this->output->user_picture($newuser, array('popup' => true));
124         $newheading .= html_writer::link($userlink->out(false), fullname($newuser), array('class' => 'notunderlined'));
125         $newheading .= $this->output->container_end();
127         // version
128         $newheading .= $this->output->container_start('wiki_diffversion');
129         $newheading .= get_string('version') . '&nbsp;' . $new->version . $newversionview;
130         $newheading .= $this->output->container_end();
131         // userdate
132         $newheading .= $this->output->container_start('wiki_difftime');
133         $newheading .= userdate($new->timecreated, $strdatetime);
134         $newheading .= $this->output->container_end();
136         $oldheading = html_writer::tag('div', $oldheading, array('class'=>'wiki-diff-heading header clearfix'));
137         $newheading = html_writer::tag('div', $newheading, array('class'=>'wiki-diff-heading header  clearfix'));
139         $output  = '';
140         $output .= html_writer::start_tag('div', array('class'=>'wiki-diff-container clearfix'));
141         $output .= html_writer::tag('div', $oldheading.$diff1, array('class'=>'wiki-diff-leftside'));
142         $output .= html_writer::tag('div', $newheading.$diff2, array('class'=>'wiki-diff-rightside'));
143         $output .= html_writer::end_tag('div');
145         if (!empty($total)) {
146             $output .= '<div class="wiki_diff_paging">';
147             $output .= $this->output->container($this->diff_paging_bar(1, $new->version - 1, $old->version, $CFG->wwwroot . '/mod/wiki/diff.php?pageid=' . $pageid . '&amp;comparewith=' . $new->version . '&amp;', 'compare', false, true), 'wiki_diff_oldpaging');
148             $output .= $this->output->container($this->diff_paging_bar($old->version + 1, $total, $new->version, $CFG->wwwroot . '/mod/wiki/diff.php?pageid=' . $pageid . '&amp;compare=' . $old->version . '&amp;', 'comparewith', false, true), 'wiki_diff_newpaging');
149             $output .= '</div>';
150         }
152         return $output;
153     }
155     /**
156      * Prints a single paging bar to provide access to other versions
157      *
158      * @param int $minpage First page to be displayed in the bar
159      * @param int $maxpage Last page to be displayed in the bar
160      * @param int $page The page you are currently viewing
161      * @param mixed $baseurl If this  is a string then it is the url which will be appended with $pagevar, an equals sign and the page number.
162      *                          If this is a moodle_url object then the pagevar param will be replaced by the page no, for each page.
163      * @param string $pagevar This is the variable name that you use for the page number in your code (ie. 'tablepage', 'blogpage', etc)
164      * @param bool $nocurr do not display the current page as a link
165      * @param bool $return whether to return an output string or echo now
166      * @return bool or string
167      */
168     public function diff_paging_bar($minpage, $maxpage, $page, $baseurl, $pagevar = 'page', $nocurr = false) {
169         $totalcount = $maxpage - $minpage;
170         $maxdisplay = 2;
171         $output = '';
173         if ($totalcount > 0) {
174             $output .= '<div class="paging">';
175             $output .= get_string('version', 'wiki') . ':';
176             if ($page - $minpage > 0) {
177                 $pagenum = $page - 1;
178                 if (!is_a($baseurl, 'moodle_url')) {
179                     $output .= '&nbsp;(<a class="previous" href="' . $baseurl . $pagevar . '=' . $pagenum . '">' . get_string('previous') . '</a>)&nbsp;';
180                 } else {
181                     $output .= '&nbsp;(<a class="previous" href="' . $baseurl->out(false, array($pagevar => $pagenum)) . '">' . get_string('previous') . '</a>)&nbsp;';
182                 }
183             }
185             if ($page - $minpage > 4) {
186                 $startpage = $page - 3;
187                 if (!is_a($baseurl, 'moodle_url')) {
188                     $output .= '&nbsp;<a href="' . $baseurl . $pagevar . '=' . $minpage . '">' . $minpage . '</a>&nbsp;...';
189                 } else {
190                     $output .= '&nbsp;<a href="' . $baseurl->out(false, array($pagevar => $minpage)) . '">' . $minpage . '</a>&nbsp;...';
191                 }
192             } else {
193                 $startpage = $minpage;
194             }
195             $currpage = $startpage;
196             $displaycount = 0;
197             while ($displaycount < $maxdisplay and $currpage <= $maxpage) {
198                 if ($page == $currpage && empty($nocurr)) {
199                     $output .= '&nbsp;&nbsp;' . $currpage;
200                 } else {
201                     if (!is_a($baseurl, 'moodle_url')) {
202                         $output .= '&nbsp;&nbsp;<a href="' . $baseurl . $pagevar . '=' . $currpage . '">' . $currpage . '</a>';
203                     } else {
204                         $output .= '&nbsp;&nbsp;<a href="' . $baseurl->out(false, array($pagevar => $currpage)) . '">' . $currpage . '</a>';
205                     }
207                 }
208                 $displaycount++;
209                 $currpage++;
210             }
211             if ($currpage < $maxpage) {
212                 if (!is_a($baseurl, 'moodle_url')) {
213                     $output .= '&nbsp;...<a href="' . $baseurl . $pagevar . '=' . $maxpage . '">' . $maxpage . '</a>&nbsp;';
214                 } else {
215                     $output .= '&nbsp;...<a href="' . $baseurl->out(false, array($pagevar => $maxpage)) . '">' . $maxpage . '</a>&nbsp;';
216                 }
217             } else if ($currpage == $maxpage) {
218                 if (!is_a($baseurl, 'moodle_url')) {
219                     $output .= '&nbsp;&nbsp;<a href="' . $baseurl . $pagevar . '=' . $currpage . '">' . $currpage . '</a>';
220                 } else {
221                     $output .= '&nbsp;&nbsp;<a href="' . $baseurl->out(false, array($pagevar => $currpage)) . '">' . $currpage . '</a>';
222                 }
223             }
224             $pagenum = $page + 1;
225             if ($page != $maxpage) {
226                 if (!is_a($baseurl, 'moodle_url')) {
227                     $output .= '&nbsp;&nbsp;(<a class="next" href="' . $baseurl . $pagevar . '=' . $pagenum . '">' . get_string('next') . '</a>)';
228                 } else {
229                     $output .= '&nbsp;&nbsp;(<a class="next" href="' . $baseurl->out(false, array($pagevar => $pagenum)) . '">' . get_string('next') . '</a>)';
230                 }
231             }
232             $output .= '</div>';
233         }
235         return $output;
236     }
237     public function wiki_info() {
238         global $PAGE;
239         return $this->output->box(format_module_intro('wiki', $this->page->activityrecord, $PAGE->cm->id), 'generalbox', 'intro');
240     }
241     public function tabs($page, $tabitems, $options) {
242         global $CFG;
243         if (empty($page)) {
244             return null;
245         }
246         $tabs = array();
247         $baseurl = $CFG->wwwroot . '/mod/wiki/';
249         $pageid = null;
250         if (isset($page)) {
251             $pageid = $page->id;
252         }
254         $selected = $options['activetab'];
256         // make specific tab linked even it is active
257         if (!empty($options['linkedwhenactive'])) {
258             $linked = $options['linkedwhenactive'];
259         } else {
260             $linked = '';
261         }
263         if (!empty($options['inactivetabs'])) {
264             $inactive = $options['inactivetabs'];
265         } else {
266             $inactive = array();
267         }
269         foreach ($tabitems as $tab) {
270             $link = $baseurl . $tab . '.php?pageid=' . $pageid;
271             if ($linked == $tab) {
272                 $tabs[] = new tabobject($tab, $link, get_string($tab, 'wiki'), '', true);
273             } else {
274                 $tabs[] = new tabobject($tab, $link, get_string($tab, 'wiki'));
275             }
276         }
278         return print_tabs(array($tabs), $selected, $inactive, null, true);
279     }
281     public function prettyview_link($page) {
282         $html = '';
283         $link = new moodle_url('/mod/wiki/prettyview.php', array('pageid' => $page->id));
284         $html .= $this->output->container_start('wiki_right');
285         $html .= $this->output->action_link($link, get_string('prettyprint', 'wiki'), new popup_action('click', $link));
286         $html .= $this->output->container_end();
287         return $html;
288     }
290     public function wiki_print_subwiki_selector($wiki, $subwiki, $page) {
291         global $CFG, $USER;
292         require_once($CFG->dirroot . '/user/lib.php');
294         $cm = get_coursemodule_from_instance('wiki', $wiki->id);
295         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
296         // @TODO: A plenty of duplicated code below this lines.
297         // Create private functions.
298         switch (groups_get_activity_groupmode($cm)) {
299         case NOGROUPS:
300             if ($wiki->wikimode == 'collaborative') {
301                 // No need to print anything
302                 return;
303             } else if ($wiki->wikimode == 'individual') {
304                 // We have private wikis here
306                 $view = has_capability('mod/wiki:viewpage', $context);
307                 $manage = has_capability('mod/wiki:managewiki', $context);
309                 // Only people with these capabilities can view all wikis
310                 if ($view && $manage) {
311                     // @TODO: Print here a combo that contains all users.
312                     $users = get_enrolled_users($context);
313                     $options = array();
314                     foreach ($users as $user) {
315                         $options[$user->id] = fullname($user);
316                     }
318                     echo $this->output->container_start('wiki_right');
319                     $params = array('wid' => $wiki->id, 'title' => $page->title);
320                     $url = new moodle_url('/mod/wiki/view.php', $params);
321                     $name = 'uid';
322                     $selected = $subwiki->userid;
323                     echo $this->output->single_select($url, $name, $options, $selected);
324                     echo $this->output->container_end();
325                 }
326                 return;
327             } else {
328                 // error
329                 return;
330             }
331         case SEPARATEGROUPS:
332             if ($wiki->wikimode == 'collaborative') {
333                 // We need to print a select to choose a course group
335                 $params = 'wid=' . $wiki->id . '&amp;title=' . urlencode($page->title);
337                 echo $this->output->container_start('wiki_right');
338                 groups_print_activity_menu($cm, $CFG->wwwroot . '/mod/wiki/view.php?' . $params);
339                 echo $this->output->container_end();
340                 return;
341             } else if ($wiki->wikimode == 'individual') {
342                 //  @TODO: Print here a combo that contains all users of that subwiki.
343                 $view = has_capability('mod/wiki:viewpage', $context);
344                 $manage = has_capability('mod/wiki:managewiki', $context);
346                 // Only people with these capabilities can view all wikis
347                 if ($view && $manage) {
348                     $users = get_enrolled_users($context);
349                     $options = array();
350                     foreach ($users as $user) {
351                         $groups = groups_get_all_groups($cm->course, $user->id);
352                         if (!empty($groups)) {
353                             foreach ($groups as $group) {
354                                 $options[$group->id][$group->name][$group->id . '-' . $user->id] = fullname($user);
355                             }
356                         } else {
357                             $name = get_string('notingroup', 'wiki');
358                             $options[0][$name]['0' . '-' . $user->id] = fullname($user);
359                         }
360                     }
361                 } else {
362                     $group = groups_get_group($subwiki->groupid);
363                     $users = groups_get_members($subwiki->groupid);
364                     foreach ($users as $user) {
365                         $options[$group->id][$group->name][$group->id . '-' . $user->id] = fullname($user);
366                     }
367                 }
368                 echo $this->output->container_start('wiki_right');
369                 $params = array('wid' => $wiki->id, 'title' => $page->title);
370                 $url = new moodle_url('/mod/wiki/view.php', $params);
371                 $name = 'groupanduser';
372                 $selected = $subwiki->groupid . '-' . $subwiki->userid;
373                 echo $this->output->single_select($url, $name, $options, $selected);
374                 echo $this->output->container_end();
376                 return;
378             } else {
379                 // error
380                 return;
381             }
382         CASE VISIBLEGROUPS:
383             if ($wiki->wikimode == 'collaborative') {
384                 // We need to print a select to choose a course group
385                 $params = 'wid=' . $wiki->id . '&amp;title=' . urlencode($page->title);
387                 echo $this->output->container_start('wiki_right');
388                 groups_print_activity_menu($cm, $CFG->wwwroot . '/mod/wiki/view.php?' . $params);
389                 echo $this->output->container_end();
390                 return;
392             } else if ($wiki->wikimode == 'individual') {
393                 $users = get_enrolled_users($context);
394                 $options = array();
395                 foreach ($users as $user) {
396                     $groups = groups_get_all_groups($cm->course, $user->id);
397                     if (!empty($groups)) {
398                         foreach ($groups as $group) {
399                             $options[$group->id][$group->name][$group->id . '-' . $user->id] = fullname($user);
400                         }
401                     } else {
402                         $name = get_string('notingroup', 'wiki');
403                         $options[0][$name]['0' . '-' . $user->id] = fullname($user);
404                     }
405                 }
407                 echo $this->output->container_start('wiki_right');
408                 $params = array('wid' => $wiki->id, 'title' => $page->title);
409                 $url = new moodle_url('/mod/wiki/view.php', $params);
410                 $name = 'groupanduser';
411                 $selected = $subwiki->groupid . '-' . $subwiki->userid;
412                 echo $this->output->single_select($url, $name, $options, $selected);
413                 echo $this->output->container_end();
415                 return;
417             } else {
418                 // error
419                 return;
420             }
421         default:
422             // error
423             return;
425         }
427     }
429     function menu_map($pageid, $currentselect) {
430         $options = array('contributions', 'links', 'orphaned', 'pageindex', 'pagelist', 'updatedpages');
431         $items = array();
432         foreach ($options as $opt) {
433             $items[] = get_string($opt, 'wiki');
434         }
435         $selectoptions = array();
436         foreach ($items as $key => $item) {
437             $selectoptions[$key + 1] = $item;
438         }
439         $select = new single_select(new moodle_url('/mod/wiki/map.php', array('pageid' => $pageid)), 'option', $selectoptions, $currentselect);
440         $select->label = get_string('mapmenu', 'wiki') . ': ';
441         return $this->output->container($this->output->render($select), 'midpad');
442     }