MDL-60579 enrolments: Applied filters lost on certain actions
[moodle.git] / user / renderer.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Provides user rendering functionality such as printing private files tree and displaying a search utility
19  *
20  * @package    core_user
21  * @copyright  2010 Dongsheng Cai <dongsheng@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * Provides user rendering functionality such as printing private files tree and displaying a search utility
29  * @copyright  2010 Dongsheng Cai <dongsheng@moodle.com>
30  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
31  */
32 class core_user_renderer extends plugin_renderer_base {
34     /**
35      * Prints user files tree view
36      * @return string
37      */
38     public function user_files_tree() {
39         return $this->render(new user_files_tree);
40     }
42     /**
43      * Render user files tree
44      *
45      * @param user_files_tree $tree
46      * @return string HTML
47      */
48     public function render_user_files_tree(user_files_tree $tree) {
49         if (empty($tree->dir['subdirs']) && empty($tree->dir['files'])) {
50             $html = $this->output->box(get_string('nofilesavailable', 'repository'));
51         } else {
52             $htmlid = 'user_files_tree_'.uniqid();
53             $module = array('name' => 'core_user', 'fullpath' => '/user/module.js');
54             $this->page->requires->js_init_call('M.core_user.init_tree', array(false, $htmlid), false, $module);
55             $html = '<div id="'.$htmlid.'">';
56             $html .= $this->htmllize_tree($tree, $tree->dir);
57             $html .= '</div>';
58         }
59         return $html;
60     }
62     /**
63      * Internal function - creates htmls structure suitable for YUI tree.
64      * @param user_files_tree $tree
65      * @param array $dir
66      * @return string HTML
67      */
68     protected function htmllize_tree($tree, $dir) {
69         global $CFG;
70         $yuiconfig = array();
71         $yuiconfig['type'] = 'html';
73         if (empty($dir['subdirs']) and empty($dir['files'])) {
74             return '';
75         }
76         $result = '<ul>';
77         foreach ($dir['subdirs'] as $subdir) {
78             $image = $this->output->pix_icon(file_folder_icon(), $subdir['dirname'], 'moodle', array('class' => 'icon'));
79             $result .= '<li yuiConfig=\''.json_encode($yuiconfig).'\'><div>'.$image.' '.s($subdir['dirname']).'</div> '.
80                 $this->htmllize_tree($tree, $subdir).'</li>';
81         }
82         foreach ($dir['files'] as $file) {
83             $url = file_encode_url("$CFG->wwwroot/pluginfile.php", '/'.$tree->context->id.'/user/private'.
84                 $file->get_filepath().$file->get_filename(), true);
85             $filename = $file->get_filename();
86             $image = $this->output->pix_icon(file_file_icon($file), $filename, 'moodle', array('class' => 'icon'));
87             $result .= '<li yuiConfig=\''.json_encode($yuiconfig).'\'><div>'.$image.' '.html_writer::link($url, $filename).
88                 '</div></li>';
89         }
90         $result .= '</ul>';
92         return $result;
93     }
95     /**
96      * Prints user search utility that can search user by first initial of firstname and/or first initial of lastname
97      * Prints a header with a title and the number of users found within that subset
98      * @param string $url the url to return to, complete with any parameters needed for the return
99      * @param string $firstinitial the first initial of the firstname
100      * @param string $lastinitial the first initial of the lastname
101      * @param int $usercount the amount of users meeting the search criteria
102      * @param int $totalcount the amount of users of the set/subset being searched
103      * @param string $heading heading of the subset being searched, default is All Participants
104      * @return string html output
105      */
106     public function user_search($url, $firstinitial, $lastinitial, $usercount, $totalcount, $heading = null) {
107         global $OUTPUT;
109         if ($firstinitial !== 'all') {
110             set_user_preference('ifirst', $firstinitial);
111         }
112         if ($lastinitial !== 'all') {
113             set_user_preference('ilast', $lastinitial);
114         }
116         if (!isset($heading)) {
117             $heading = get_string('allparticipants');
118         }
120         $content = html_writer::start_tag('form', array('action' => new moodle_url($url)));
121         $content .= html_writer::start_tag('div');
123         // Search utility heading.
124         $content .= $OUTPUT->heading($heading.get_string('labelsep', 'langconfig').$usercount.'/'.$totalcount, 3);
126         // Initials bar.
127         $prefixfirst = 'sifirst';
128         $prefixlast = 'silast';
129         $content .= $OUTPUT->initials_bar($firstinitial, 'firstinitial', get_string('firstname'), $prefixfirst, $url);
130         $content .= $OUTPUT->initials_bar($lastinitial, 'lastinitial', get_string('lastname'), $prefixlast, $url);
132         $content .= html_writer::end_tag('div');
133         $content .= html_writer::tag('div', '&nbsp;');
134         $content .= html_writer::end_tag('form');
136         return $content;
137     }
139     /**
140      * Displays the list of tagged users
141      *
142      * @param array $userlist
143      * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
144      *             are displayed on the page and the per-page limit may be bigger
145      * @return string
146      */
147     public function user_list($userlist, $exclusivemode) {
148         $tagfeed = new core_tag\output\tagfeed();
149         foreach ($userlist as $user) {
150             $userpicture = $this->output->user_picture($user, array('size' => $exclusivemode ? 100 : 35));
151             $fullname = fullname($user);
152             if (user_can_view_profile($user)) {
153                 $profilelink = new moodle_url('/user/view.php', array('id' => $user->id));
154                 $fullname = html_writer::link($profilelink, $fullname);
155             }
156             $tagfeed->add($userpicture, $fullname);
157         }
159         $items = $tagfeed->export_for_template($this->output);
161         if ($exclusivemode) {
162             $output = '<div><ul class="inline-list">';
163             foreach ($items['items'] as $item) {
164                 $output .= '<li><div class="user-box">'. $item['img'] . $item['heading'] ."</div></li>\n";
165             }
166             $output .= "</ul></div>\n";
167             return $output;
168         }
170         return $this->output->render_from_template('core_tag/tagfeed', $items);
171     }
173     /**
174      * Renders the unified filter element for the course participants page.
175      *
176      * @param stdClass $course The course object.
177      * @param context $context The context object.
178      * @param array $filtersapplied Array of currently applied filters.
179      * @return bool|string
180      */
181     public function unified_filter($course, $context, $filtersapplied) {
182         global $CFG, $DB, $USER;
184         $filteroptions = [];
185         $isfrontpage = ($course->id == SITEID);
187         // Get the list of fields we have to hide.
188         $hiddenfields = array();
189         if (!has_capability('moodle/course:viewhiddenuserfields', $context)) {
190             $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
191         }
192         $haslastaccess = !isset($hiddenfields['lastaccess']);
193         // Filter options for last access.
194         if ($haslastaccess) {
195             // Get minimum lastaccess for this course and display a dropbox to filter by lastaccess going back this far.
196             // We need to make it diferently for normal courses and site course.
197             if (!$isfrontpage) {
198                 $params = ['courseid' => $course->id, 'timeaccess' => 0];
199                 $select = 'courseid = :courseid AND timeaccess != :timeaccess';
200                 $minlastaccess = $DB->get_field_select('user_lastaccess', 'MIN(timeaccess)', $select, $params);
201                 $lastaccess0exists = $DB->record_exists('user_lastaccess', $params);
202             } else {
203                 $params = ['lastaccess' => 0];
204                 $select = 'lastaccess != :lastaccess';
205                 $minlastaccess = $DB->get_field_select('user', 'MIN(lastaccess)', $select, $params);
206                 $lastaccess0exists = $DB->record_exists('user', $params);
207             }
208             $now = usergetmidnight(time());
209             $timeoptions = [];
210             $criteria = get_string('usersnoaccesssince');
212             // Days.
213             for ($i = 1; $i < 7; $i++) {
214                 $timestamp = strtotime('-' . $i . ' days', $now);
215                 if ($timestamp < $minlastaccess) {
216                     break;
217                 }
218                 $value = get_string('numdays', 'moodle', $i);
219                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
220             }
221             // Weeks.
222             for ($i = 1; $i < 10; $i++) {
223                 $timestamp = strtotime('-'.$i.' weeks', $now);
224                 if ($timestamp < $minlastaccess) {
225                     break;
226                 }
227                 $value = get_string('numweeks', 'moodle', $i);
228                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
229             }
230             // Months.
231             for ($i = 2; $i < 12; $i++) {
232                 $timestamp = strtotime('-'.$i.' months', $now);
233                 if ($timestamp < $minlastaccess) {
234                     break;
235                 }
236                 $value = get_string('nummonths', 'moodle', $i);
237                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
238             }
239             // Try a year.
240             $timestamp = strtotime('-1 year', $now);
241             if ($timestamp >= $minlastaccess) {
242                 $value = get_string('numyear', 'moodle', 1);
243                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
244             }
245             if (!empty($lastaccess0exists)) {
246                 $value = get_string('never', 'moodle');
247                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
248             }
249             if (count($timeoptions) > 1) {
250                 $filteroptions += $timeoptions;
251             }
252         }
254         require_once($CFG->dirroot . '/enrol/locallib.php');
255         $manager = new course_enrolment_manager($this->page, $course);
257         $canreviewenrol = has_capability('moodle/course:enrolreview', $context);
259         // Filter options for enrolment methods.
260         if ($canreviewenrol && $enrolmentmethods = $manager->get_enrolment_instance_names(true)) {
261             $criteria = get_string('enrolmentinstances', 'enrol');
262             $enroloptions = [];
263             foreach ($enrolmentmethods as $id => $enrolname) {
264                 $enroloptions += $this->format_filter_option(USER_FILTER_ENROLMENT, $criteria, $id, $enrolname);
265             }
266             $filteroptions += $enroloptions;
267         }
269         // Filter options for groups, if available.
270         if ($course->groupmode != NOGROUPS) {
271             if (has_capability('moodle/site:accessallgroups', $context) || $course->groupmode == VISIBLEGROUPS) {
272                 // List all groups if the user can access all groups, or we are in visible group mode.
273                 $groups = $manager->get_all_groups();
274             } else {
275                 // Otherwise, just list the groups the user belongs to.
276                 $groups = groups_get_all_groups($course->id, $USER->id);
277             }
278             $criteria = get_string('group');
279             $groupoptions = [];
280             foreach ($groups as $id => $group) {
281                 $groupoptions += $this->format_filter_option(USER_FILTER_GROUP, $criteria, $id, $group->name);
282             }
283             $filteroptions += $groupoptions;
284         }
286         // Filter options for role.
287         $roles = role_fix_names(get_profile_roles($context), $context, ROLENAME_ALIAS, true);
288         $criteria = get_string('role');
289         $roleoptions = [];
290         foreach ($roles as $id => $role) {
291             $roleoptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $id, $role);
292         }
293         $filteroptions += $roleoptions;
295         // Filter options for status.
296         if ($canreviewenrol) {
297             $criteria = get_string('status');
298             // Add statuses.
299             $filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_ACTIVE, get_string('active'));
300             $filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_SUSPENDED,
301                 get_string('inactive'));
302         }
304         // Add missing applied filters to the filter options.
305         $filteroptions = $this->handle_missing_applied_filters($filtersapplied, $filteroptions);
307         $indexpage = new \core_user\output\unified_filter($filteroptions, $filtersapplied);
308         $context = $indexpage->export_for_template($this->output);
310         return $this->output->render_from_template('core_user/unified_filter', $context);
311     }
313     /**
314      * Returns a formatted filter option.
315      *
316      * @param int $filtertype The filter type (e.g. status, role, group, enrolment, last access).
317      * @param string $criteria The string label of the filter type.
318      * @param int $value The value for the filter option.
319      * @param string $label The string representation of the filter option's value.
320      * @return array The formatted option with the ['filtertype:value' => 'criteria: label'] format.
321      */
322     protected function format_filter_option($filtertype, $criteria, $value, $label) {
323         $optionlabel = get_string('filteroption', 'moodle', (object)['criteria' => $criteria, 'value' => $label]);
324         $optionvalue = "$filtertype:$value";
325         return [$optionvalue => $optionlabel];
326     }
328     /**
329      * Handles cases when after reloading the applied filters are missing in the filter options.
330      *
331      * @param array $filtersapplied The applied filters.
332      * @param array $filteroptions The filter options.
333      * @return array The formatted options with the ['filtertype:value' => 'criteria: label'] format.
334      */
335     private function handle_missing_applied_filters($filtersapplied, $filteroptions) {
336         global $DB;
338         foreach ($filtersapplied as $filter) {
339             if (!array_key_exists($filter, $filteroptions)) {
340                 $filtervalue = explode(':', $filter);
341                 $key = $filtervalue[0];
342                 $value = $filtervalue[1];
344                 switch($key) {
345                     case USER_FILTER_LAST_ACCESS:
346                         $now = usergetmidnight(time());
347                         $criteria = get_string('usersnoaccesssince');
348                         // Days.
349                         for ($i = 1; $i < 7; $i++) {
350                             $timestamp = strtotime('-' . $i . ' days', $now);
351                             if ($timestamp < $value) {
352                                 break;
353                             }
354                             $val = get_string('numdays', 'moodle', $i);
355                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
356                         }
357                         // Weeks.
358                         for ($i = 1; $i < 10; $i++) {
359                             $timestamp = strtotime('-'.$i.' weeks', $now);
360                             if ($timestamp < $value) {
361                                 break;
362                             }
363                             $val = get_string('numweeks', 'moodle', $i);
364                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
365                         }
366                         // Months.
367                         for ($i = 2; $i < 12; $i++) {
368                             $timestamp = strtotime('-'.$i.' months', $now);
369                             if ($timestamp < $value) {
370                                 break;
371                             }
372                             $val = get_string('nummonths', 'moodle', $i);
373                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
374                         }
375                         // Try a year.
376                         $timestamp = strtotime('-1 year', $now);
377                         if ($timestamp >= $value) {
378                             $val = get_string('numyear', 'moodle', 1);
379                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
380                         }
381                     case USER_FILTER_ROLE:
382                         $criteria = get_string('role');
383                         if ($role = $DB->get_record('role', array('id' => $value))) {
384                             $role = role_get_name($role);
385                             $filteroptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $value, $role);
386                         }
387                 }
388             }
389         }
390         return $filteroptions;
391     }
394 /**
395  * User files tree
396  * @copyright  2010 Dongsheng Cai <dongsheng@moodle.com>
397  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
398  */
399 class user_files_tree implements renderable {
401     /**
402      * @var context_user $context
403      */
404     public $context;
406     /**
407      * @var array $dir
408      */
409     public $dir;
411     /**
412      * Create user files tree object
413      */
414     public function __construct() {
415         global $USER;
416         $this->context = context_user::instance($USER->id);
417         $fs = get_file_storage();
418         $this->dir = $fs->get_area_tree($this->context->id, 'user', 'private', 0);
419     }