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      * @param string|moodle_url $baseurl The url with params needed to call up this page.
 119      * @return bool|string
 120      */
 121     public function unified_filter($course, $context, $filtersapplied, $baseurl = null) {
 122         global $CFG, $DB, $USER;
 123
 124         require_once($CFG->dirroot . '/enrol/locallib.php');
 125         require_once($CFG->dirroot . '/lib/grouplib.php');
 126         $manager = new course_enrolment_manager($this->page, $course);
 127
 128         $filteroptions = [];
 129
 130         // Filter options for role.
 131         $roleseditable = has_capability('moodle/role:assign', $context);
 132         $roles = get_viewable_roles($context);
 133         if ($roleseditable) {
 134             $roles += get_assignable_roles($context, ROLENAME_ALIAS);
 135         }
 136
 137         $criteria = get_string('role');
 138         $roleoptions = [];
 139         foreach ($roles as $id => $role) {
 140             $roleoptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $id, $role);
 141         }
 142         $filteroptions += $roleoptions;
 143
 144         // Filter options for groups, if available.
 145         if (has_capability('moodle/site:accessallgroups', $context) || $course->groupmode != SEPARATEGROUPS) {
 146             // List all groups if the user can access all groups, or we are in visible group mode or no groups mode.
 147             $groups = $manager->get_all_groups();
 148         } else {
 149             // Otherwise, just list the groups the user belongs to.
 150             $groups = groups_get_all_groups($course->id, $USER->id);
 151         }
 152         $criteria = get_string('group');
 153         $groupoptions = [];
 154         foreach ($groups as $id => $group) {
 155             $groupoptions += $this->format_filter_option(USER_FILTER_GROUP, $criteria, $id, $group->name);
 156         }
 157         $filteroptions += $groupoptions;
 158
 159         $canreviewenrol = has_capability('moodle/course:enrolreview', $context);
 160
 161         // Filter options for status.
 162         if ($canreviewenrol) {
 163             $criteria = get_string('status');
 164             // Add statuses.
 165             $filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_ACTIVE, get_string('active'));
 166             $filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_SUSPENDED,
 167                 get_string('inactive'));
 168         }
 169
 170         // Filter options for enrolment methods.
 171         if ($canreviewenrol && $enrolmentmethods = $manager->get_enrolment_instance_names(true)) {
 172             $criteria = get_string('enrolmentinstances', 'enrol');
 173             $enroloptions = [];
 174             foreach ($enrolmentmethods as $id => $enrolname) {
 175                 $enroloptions += $this->format_filter_option(USER_FILTER_ENROLMENT, $criteria, $id, $enrolname);
 176             }
 177             $filteroptions += $enroloptions;
 178         }
 179
 180         $isfrontpage = ($course->id == SITEID);
 181
 182         // Get the list of fields we have to hide.
 183         $hiddenfields = array();
 184         if (!has_capability('moodle/course:viewhiddenuserfields', $context)) {
 185             $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
 186         }
 187         $haslastaccess = !isset($hiddenfields['lastaccess']);
 188         // Filter options for last access.
 189         if ($haslastaccess) {
 190             // Get minimum lastaccess for this course and display a dropbox to filter by lastaccess going back this far.
 191             // We need to make it diferently for normal courses and site course.
 192             if (!$isfrontpage) {
 193                 $params = ['courseid' => $course->id, 'timeaccess' => 0];
 194                 $select = 'courseid = :courseid AND timeaccess != :timeaccess';
 195                 $minlastaccess = $DB->get_field_select('user_lastaccess', 'MIN(timeaccess)', $select, $params);
 196                 $lastaccess0exists = $DB->record_exists('user_lastaccess', $params);
 197             } else {
 198                 $params = ['lastaccess' => 0];
 199                 $select = 'lastaccess != :lastaccess';
 200                 $minlastaccess = $DB->get_field_select('user', 'MIN(lastaccess)', $select, $params);
 201                 $lastaccess0exists = $DB->record_exists('user', $params);
 202             }
 203             $now = usergetmidnight(time());
 204             $timeoptions = [];
 205             $criteria = get_string('usersnoaccesssince');
 206
 207             // Days.
 208             for ($i = 1; $i < 7; $i++) {
 209                 $timestamp = strtotime('-' . $i . ' days', $now);
 210                 if ($timestamp < $minlastaccess) {
 211                     break;
 212                 }
 213                 $value = get_string('numdays', 'moodle', $i);
 214                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 215             }
 216             // Weeks.
 217             for ($i = 1; $i < 10; $i++) {
 218                 $timestamp = strtotime('-'.$i.' weeks', $now);
 219                 if ($timestamp < $minlastaccess) {
 220                     break;
 221                 }
 222                 $value = get_string('numweeks', 'moodle', $i);
 223                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 224             }
 225             // Months.
 226             for ($i = 2; $i < 12; $i++) {
 227                 $timestamp = strtotime('-'.$i.' months', $now);
 228                 if ($timestamp < $minlastaccess) {
 229                     break;
 230                 }
 231                 $value = get_string('nummonths', 'moodle', $i);
 232                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 233             }
 234             // Try a year.
 235             $timestamp = strtotime('-1 year', $now);
 236             if ($timestamp >= $minlastaccess) {
 237                 $value = get_string('numyear', 'moodle', 1);
 238                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 239             }
 240             if (!empty($lastaccess0exists)) {
 241                 $value = get_string('never', 'moodle');
 242                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 243             }
 244             if (count($timeoptions) > 1) {
 245                 $filteroptions += $timeoptions;
 246             }
 247         }
 248
 249         // Add missing applied filters to the filter options.
 250         $filteroptions = $this->handle_missing_applied_filters($filtersapplied, $filteroptions);
 251
 252         $indexpage = new \core_user\output\unified_filter($filteroptions, $filtersapplied, $baseurl);
 253         $context = $indexpage->export_for_template($this->output);
 254
 255         return $this->output->render_from_template('core_user/unified_filter', $context);
 256     }
 257
 258     /**
 259      * Returns a formatted filter option.
 260      *
 261      * @param int $filtertype The filter type (e.g. status, role, group, enrolment, last access).
 262      * @param string $criteria The string label of the filter type.
 263      * @param int $value The value for the filter option.
 264      * @param string $label The string representation of the filter option's value.
 265      * @return array The formatted option with the ['filtertype:value' => 'criteria: label'] format.
 266      */
 267     protected function format_filter_option($filtertype, $criteria, $value, $label) {
 268         $optionlabel = get_string('filteroption', 'moodle', (object)['criteria' => $criteria, 'value' => $label]);
 269         $optionvalue = "$filtertype:$value";
 270         return [$optionvalue => $optionlabel];
 271     }
 272
 273     /**
 274      * Handles cases when after reloading the applied filters are missing in the filter options.
 275      *
 276      * @param array $filtersapplied The applied filters.
 277      * @param array $filteroptions The filter options.
 278      * @return array The formatted options with the ['filtertype:value' => 'criteria: label'] format.
 279      */
 280     private function handle_missing_applied_filters($filtersapplied, $filteroptions) {
 281         global $DB;
 282
 283         foreach ($filtersapplied as $filter) {
 284             if (!array_key_exists($filter, $filteroptions)) {
 285                 $filtervalue = explode(':', $filter);
 286                 if (count($filtervalue) !== 2) {
 287                     continue;
 288                 }
 289                 $key = $filtervalue[0];
 290                 $value = $filtervalue[1];
 291
 292                 switch($key) {
 293                     case USER_FILTER_LAST_ACCESS:
 294                         $now = usergetmidnight(time());
 295                         $criteria = get_string('usersnoaccesssince');
 296                         // Days.
 297                         for ($i = 1; $i < 7; $i++) {
 298                             $timestamp = strtotime('-' . $i . ' days', $now);
 299                             if ($timestamp < $value) {
 300                                 break;
 301                             }
 302                             $val = get_string('numdays', 'moodle', $i);
 303                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 304                         }
 305                         // Weeks.
 306                         for ($i = 1; $i < 10; $i++) {
 307                             $timestamp = strtotime('-'.$i.' weeks', $now);
 308                             if ($timestamp < $value) {
 309                                 break;
 310                             }
 311                             $val = get_string('numweeks', 'moodle', $i);
 312                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 313                         }
 314                         // Months.
 315                         for ($i = 2; $i < 12; $i++) {
 316                             $timestamp = strtotime('-'.$i.' months', $now);
 317                             if ($timestamp < $value) {
 318                                 break;
 319                             }
 320                             $val = get_string('nummonths', 'moodle', $i);
 321                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 322                         }
 323                         // Try a year.
 324                         $timestamp = strtotime('-1 year', $now);
 325                         if ($timestamp >= $value) {
 326                             $val = get_string('numyear', 'moodle', 1);
 327                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 328                         }
 329                         break;
 330                     case USER_FILTER_ROLE:
 331                         $criteria = get_string('role');
 332                         if ($role = $DB->get_record('role', array('id' => $value))) {
 333                             $role = role_get_name($role);
 334                             $filteroptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $value, $role);
 335                         }
 336                         break;
 337                 }
 338             }
 339         }
 340         return $filteroptions;
 341     }
 342 }