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/>.
  16
  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  */
  24
  25 defined('MOODLE_INTERNAL') || die();
  26
  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 {
  33
  34     /**
  35      * Prints user search utility that can search user by first initial of firstname and/or first initial of lastname
  36      * Prints a header with a title and the number of users found within that subset
  37      * @param string $url the url to return to, complete with any parameters needed for the return
  38      * @param string $firstinitial the first initial of the firstname
  39      * @param string $lastinitial the first initial of the lastname
  40      * @param int $usercount the amount of users meeting the search criteria
  41      * @param int $totalcount the amount of users of the set/subset being searched
  42      * @param string $heading heading of the subset being searched, default is All Participants
  43      * @return string html output
  44      */
  45     public function user_search($url, $firstinitial, $lastinitial, $usercount, $totalcount, $heading = null) {
  46         global $OUTPUT;
  47
  48         if ($firstinitial !== 'all') {
  49             set_user_preference('ifirst', $firstinitial);
  50         }
  51         if ($lastinitial !== 'all') {
  52             set_user_preference('ilast', $lastinitial);
  53         }
  54
  55         if (!isset($heading)) {
  56             $heading = get_string('allparticipants');
  57         }
  58
  59         $content = html_writer::start_tag('form', array('action' => new moodle_url($url)));
  60         $content .= html_writer::start_tag('div');
  61
  62         // Search utility heading.
  63         $content .= $OUTPUT->heading($heading.get_string('labelsep', 'langconfig').$usercount.'/'.$totalcount, 3);
  64
  65         // Initials bar.
  66         $prefixfirst = 'sifirst';
  67         $prefixlast = 'silast';
  68         $content .= $OUTPUT->initials_bar($firstinitial, 'firstinitial', get_string('firstname'), $prefixfirst, $url);
  69         $content .= $OUTPUT->initials_bar($lastinitial, 'lastinitial', get_string('lastname'), $prefixlast, $url);
  70
  71         $content .= html_writer::end_tag('div');
  72         $content .= html_writer::tag('div', '&nbsp;');
  73         $content .= html_writer::end_tag('form');
  74
  75         return $content;
  76     }
  77
  78     /**
  79      * Displays the list of tagged users
  80      *
  81      * @param array $userlist
  82      * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
  83      *             are displayed on the page and the per-page limit may be bigger
  84      * @return string
  85      */
  86     public function user_list($userlist, $exclusivemode) {
  87         $tagfeed = new core_tag\output\tagfeed();
  88         foreach ($userlist as $user) {
  89             $userpicture = $this->output->user_picture($user, array('size' => $exclusivemode ? 100 : 35));
  90             $fullname = fullname($user);
  91             if (user_can_view_profile($user)) {
  92                 $profilelink = new moodle_url('/user/view.php', array('id' => $user->id));
  93                 $fullname = html_writer::link($profilelink, $fullname);
  94             }
  95             $tagfeed->add($userpicture, $fullname);
  96         }
  97
  98         $items = $tagfeed->export_for_template($this->output);
  99
 100         if ($exclusivemode) {
 101             $output = '<div><ul class="inline-list">';
 102             foreach ($items['items'] as $item) {
 103                 $output .= '<li><div class="user-box">'. $item['img'] . $item['heading'] ."</div></li>\n";
 104             }
 105             $output .= "</ul></div>\n";
 106             return $output;
 107         }
 108
 109         return $this->output->render_from_template('core_tag/tagfeed', $items);
 110     }
 111
 112     /**
 113      * Renders the unified filter element for the course participants page.
 114      *
 115      * @param stdClass $course The course object.
 116      * @param context $context The context object.
 117      * @param array $filtersapplied Array of currently applied filters.
 118      * @return bool|string
 119      */
 120     public function unified_filter($course, $context, $filtersapplied) {
 121         global $CFG, $DB, $USER;
 122
 123         require_once($CFG->dirroot . '/enrol/locallib.php');
 124         require_once($CFG->dirroot . '/lib/grouplib.php');
 125         $manager = new course_enrolment_manager($this->page, $course);
 126
 127         $filteroptions = [];
 128
 129         // Filter options for role.
 130         $roleseditable = has_capability('moodle/role:assign', $context);
 131         $roles = get_viewable_roles($context);
 132         if ($roleseditable) {
 133             $roles += get_assignable_roles($context, ROLENAME_ALIAS);
 134         }
 135
 136         $criteria = get_string('role');
 137         $roleoptions = [];
 138         foreach ($roles as $id => $role) {
 139             $roleoptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $id, $role);
 140         }
 141         $filteroptions += $roleoptions;
 142
 143         // Filter options for groups, if available.
 144         if (has_capability('moodle/site:accessallgroups', $context) || $course->groupmode != SEPARATEGROUPS) {
 145             // List all groups if the user can access all groups, or we are in visible group mode or no groups mode.
 146             $groups = $manager->get_all_groups();
 147         } else {
 148             // Otherwise, just list the groups the user belongs to.
 149             $groups = groups_get_all_groups($course->id, $USER->id);
 150         }
 151         $criteria = get_string('group');
 152         $groupoptions = [];
 153         foreach ($groups as $id => $group) {
 154             $groupoptions += $this->format_filter_option(USER_FILTER_GROUP, $criteria, $id, $group->name);
 155         }
 156         $filteroptions += $groupoptions;
 157
 158         $canreviewenrol = has_capability('moodle/course:enrolreview', $context);
 159
 160         // Filter options for status.
 161         if ($canreviewenrol) {
 162             $criteria = get_string('status');
 163             // Add statuses.
 164             $filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_ACTIVE, get_string('active'));
 165             $filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_SUSPENDED,
 166                 get_string('inactive'));
 167         }
 168
 169         // Filter options for enrolment methods.
 170         if ($canreviewenrol && $enrolmentmethods = $manager->get_enrolment_instance_names(true)) {
 171             $criteria = get_string('enrolmentinstances', 'enrol');
 172             $enroloptions = [];
 173             foreach ($enrolmentmethods as $id => $enrolname) {
 174                 $enroloptions += $this->format_filter_option(USER_FILTER_ENROLMENT, $criteria, $id, $enrolname);
 175             }
 176             $filteroptions += $enroloptions;
 177         }
 178
 179         $isfrontpage = ($course->id == SITEID);
 180
 181         // Get the list of fields we have to hide.
 182         $hiddenfields = array();
 183         if (!has_capability('moodle/course:viewhiddenuserfields', $context)) {
 184             $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
 185         }
 186         $haslastaccess = !isset($hiddenfields['lastaccess']);
 187         // Filter options for last access.
 188         if ($haslastaccess) {
 189             // Get minimum lastaccess for this course and display a dropbox to filter by lastaccess going back this far.
 190             // We need to make it diferently for normal courses and site course.
 191             if (!$isfrontpage) {
 192                 $params = ['courseid' => $course->id, 'timeaccess' => 0];
 193                 $select = 'courseid = :courseid AND timeaccess != :timeaccess';
 194                 $minlastaccess = $DB->get_field_select('user_lastaccess', 'MIN(timeaccess)', $select, $params);
 195                 $lastaccess0exists = $DB->record_exists('user_lastaccess', $params);
 196             } else {
 197                 $params = ['lastaccess' => 0];
 198                 $select = 'lastaccess != :lastaccess';
 199                 $minlastaccess = $DB->get_field_select('user', 'MIN(lastaccess)', $select, $params);
 200                 $lastaccess0exists = $DB->record_exists('user', $params);
 201             }
 202             $now = usergetmidnight(time());
 203             $timeoptions = [];
 204             $criteria = get_string('usersnoaccesssince');
 205
 206             // Days.
 207             for ($i = 1; $i < 7; $i++) {
 208                 $timestamp = strtotime('-' . $i . ' days', $now);
 209                 if ($timestamp < $minlastaccess) {
 210                     break;
 211                 }
 212                 $value = get_string('numdays', 'moodle', $i);
 213                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 214             }
 215             // Weeks.
 216             for ($i = 1; $i < 10; $i++) {
 217                 $timestamp = strtotime('-'.$i.' weeks', $now);
 218                 if ($timestamp < $minlastaccess) {
 219                     break;
 220                 }
 221                 $value = get_string('numweeks', 'moodle', $i);
 222                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 223             }
 224             // Months.
 225             for ($i = 2; $i < 12; $i++) {
 226                 $timestamp = strtotime('-'.$i.' months', $now);
 227                 if ($timestamp < $minlastaccess) {
 228                     break;
 229                 }
 230                 $value = get_string('nummonths', 'moodle', $i);
 231                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 232             }
 233             // Try a year.
 234             $timestamp = strtotime('-1 year', $now);
 235             if ($timestamp >= $minlastaccess) {
 236                 $value = get_string('numyear', 'moodle', 1);
 237                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 238             }
 239             if (!empty($lastaccess0exists)) {
 240                 $value = get_string('never', 'moodle');
 241                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 242             }
 243             if (count($timeoptions) > 1) {
 244                 $filteroptions += $timeoptions;
 245             }
 246         }
 247
 248         // Add missing applied filters to the filter options.
 249         $filteroptions = $this->handle_missing_applied_filters($filtersapplied, $filteroptions);
 250
 251         $indexpage = new \core_user\output\unified_filter($filteroptions, $filtersapplied);
 252         $context = $indexpage->export_for_template($this->output);
 253
 254         return $this->output->render_from_template('core_user/unified_filter', $context);
 255     }
 256
 257     /**
 258      * Returns a formatted filter option.
 259      *
 260      * @param int $filtertype The filter type (e.g. status, role, group, enrolment, last access).
 261      * @param string $criteria The string label of the filter type.
 262      * @param int $value The value for the filter option.
 263      * @param string $label The string representation of the filter option's value.
 264      * @return array The formatted option with the ['filtertype:value' => 'criteria: label'] format.
 265      */
 266     protected function format_filter_option($filtertype, $criteria, $value, $label) {
 267         $optionlabel = get_string('filteroption', 'moodle', (object)['criteria' => $criteria, 'value' => $label]);
 268         $optionvalue = "$filtertype:$value";
 269         return [$optionvalue => $optionlabel];
 270     }
 271
 272     /**
 273      * Handles cases when after reloading the applied filters are missing in the filter options.
 274      *
 275      * @param array $filtersapplied The applied filters.
 276      * @param array $filteroptions The filter options.
 277      * @return array The formatted options with the ['filtertype:value' => 'criteria: label'] format.
 278      */
 279     private function handle_missing_applied_filters($filtersapplied, $filteroptions) {
 280         global $DB;
 281
 282         foreach ($filtersapplied as $filter) {
 283             if (!array_key_exists($filter, $filteroptions)) {
 284                 $filtervalue = explode(':', $filter);
 285                 if (count($filtervalue) !== 2) {
 286                     continue;
 287                 }
 288                 $key = $filtervalue[0];
 289                 $value = $filtervalue[1];
 290
 291                 switch($key) {
 292                     case USER_FILTER_LAST_ACCESS:
 293                         $now = usergetmidnight(time());
 294                         $criteria = get_string('usersnoaccesssince');
 295                         // Days.
 296                         for ($i = 1; $i < 7; $i++) {
 297                             $timestamp = strtotime('-' . $i . ' days', $now);
 298                             if ($timestamp < $value) {
 299                                 break;
 300                             }
 301                             $val = get_string('numdays', 'moodle', $i);
 302                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 303                         }
 304                         // Weeks.
 305                         for ($i = 1; $i < 10; $i++) {
 306                             $timestamp = strtotime('-'.$i.' weeks', $now);
 307                             if ($timestamp < $value) {
 308                                 break;
 309                             }
 310                             $val = get_string('numweeks', 'moodle', $i);
 311                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 312                         }
 313                         // Months.
 314                         for ($i = 2; $i < 12; $i++) {
 315                             $timestamp = strtotime('-'.$i.' months', $now);
 316                             if ($timestamp < $value) {
 317                                 break;
 318                             }
 319                             $val = get_string('nummonths', 'moodle', $i);
 320                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 321                         }
 322                         // Try a year.
 323                         $timestamp = strtotime('-1 year', $now);
 324                         if ($timestamp >= $value) {
 325                             $val = get_string('numyear', 'moodle', 1);
 326                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 327                         }
 328                         break;
 329                     case USER_FILTER_ROLE:
 330                         $criteria = get_string('role');
 331                         if ($role = $DB->get_record('role', array('id' => $value))) {
 332                             $role = role_get_name($role);
 333                             $filteroptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $value, $role);
 334                         }
 335                         break;
 336                 }
 337             }
 338         }
 339         return $filteroptions;
 340     }
 341 }