admin/roles/assign.php

   1 <?php // $Id$
   2       // Script to assign users to contexts
   3
   4     require_once('../../config.php');
   5     require_once($CFG->dirroot.'/mod/forum/lib.php');
   6     require_once($CFG->libdir.'/adminlib.php');
   7
   8     define("MAX_USERS_PER_PAGE", 5000);
   9     define("MAX_USERS_TO_LIST_PER_ROLE", 10);
  10
  11     $contextid      = required_param('contextid',PARAM_INT); // context id
  12     $roleid         = optional_param('roleid', 0, PARAM_INT); // required role id
  13     $add            = optional_param('add', 0, PARAM_BOOL);
  14     $remove         = optional_param('remove', 0, PARAM_BOOL);
  15     $showall        = optional_param('showall', 0, PARAM_BOOL);
  16     $searchtext     = optional_param('searchtext', '', PARAM_RAW); // search string
  17     $previoussearch = optional_param('previoussearch', 0, PARAM_BOOL);
  18     $hidden         = optional_param('hidden', 0, PARAM_BOOL); // whether this assignment is hidden
  19     $extendperiod   = optional_param('extendperiod', 0, PARAM_INT);
  20     $extendbase     = optional_param('extendbase', 0, PARAM_INT);
  21     $userid         = optional_param('userid', 0, PARAM_INT); // needed for user tabs
  22     $courseid       = optional_param('courseid', 0, PARAM_INT); // needed for user tabs
  23
  24     $errors = array();
  25
  26     $previoussearch = ($searchtext != '') or ($previoussearch) ? 1:0;
  27
  28     $baseurl = 'assign.php?contextid='.$contextid;
  29     if (!empty($userid)) {
  30         $baseurl .= '&amp;userid='.$userid;
  31     }
  32     if (!empty($courseid)) {
  33         $baseurl .= '&amp;courseid='.$courseid;
  34     }
  35
  36     if (! $context = get_context_instance_by_id($contextid)) {
  37         error("Context ID was incorrect (can't find it)");
  38     }
  39
  40     $inmeta = 0;
  41     if ($context->contextlevel == CONTEXT_COURSE) {
  42         $courseid = $context->instanceid;
  43         if ($course = get_record('course', 'id', $courseid)) {
  44             $inmeta = $course->metacourse;
  45         } else {
  46             error('Invalid course id');
  47         }
  48
  49     } else if (!empty($courseid)){ // we need this for user tabs in user context
  50         if (!$course = get_record('course', 'id', $courseid)) {
  51             error('Invalid course id');
  52         }
  53
  54     } else {
  55         $courseid = SITEID;
  56         $course = clone($SITE);
  57     }
  58
  59     require_login($course);
  60
  61     require_capability('moodle/role:assign', $context);
  62
  63 /// needed for tabs.php
  64
  65     $overridableroles = get_overridable_roles($context, 'name', ROLENAME_BOTH);
  66     $assignableroles  = get_assignable_roles($context, 'name', ROLENAME_BOTH);
  67
  68 /// Get some language strings
  69
  70     $strpotentialusers = get_string('potentialusers', 'role');
  71     $strexistingusers = get_string('existingusers', 'role');
  72     $straction = get_string('assignroles', 'role');
  73     $strroletoassign = get_string('roletoassign', 'role');
  74     $strsearch = get_string('search');
  75     $strshowall = get_string('showall');
  76     $strparticipants = get_string('participants');
  77     $strsearchresults = get_string('searchresults');
  78
  79     $unlimitedperiod = get_string('unlimited');
  80     $defaultperiod = $course->enrolperiod;
  81     for ($i=1; $i<=365; $i++) {
  82         $seconds = $i * 86400;
  83         $periodmenu[$seconds] = get_string('numdays', '', $i);
  84     }
  85
  86     $timeformat = get_string('strftimedate');
  87     $today = time();
  88     $today = make_timestamp(date('Y', $today), date('m', $today), date('d', $today), 0, 0, 0);
  89
  90     // MDL-12420, preventing course start date showing up as an option at system context and front page roles.
  91     if ($course->startdate > 0) {
  92         $basemenu[0] = get_string('startdate') . ' (' . userdate($course->startdate, $timeformat) . ')';
  93     }
  94     if ($course->enrollable != 2 || ($course->enrolstartdate == 0 || $course->enrolstartdate <= $today) && ($course->enrolenddate == 0 || $course->enrolenddate > $today)) {
  95         $basemenu[3] = get_string('today') . ' (' . userdate($today, $timeformat) . ')' ;
  96     }
  97     if($course->enrollable == 2) {
  98         if($course->enrolstartdate > 0) {
  99             $basemenu[4] = get_string('courseenrolstartdate') . ' (' . userdate($course->enrolstartdate, $timeformat) . ')';
 100         }
 101         if($course->enrolenddate > 0) {
 102             $basemenu[5] = get_string('courseenrolenddate') . ' (' . userdate($course->enrolenddate, $timeformat) . ')';
 103         }
 104     }
 105
 106 /// Make sure this user can assign that role
 107
 108     if ($roleid) {
 109         if (!isset($assignableroles[$roleid])) {
 110             error ('you can not override this role in this context');
 111         }
 112     }
 113
 114     if ($userid) {
 115         $user = get_record('user', 'id', $userid);
 116         $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $context));
 117     }
 118
 119
 120 /// Print the header and tabs
 121
 122     if ($context->contextlevel == CONTEXT_USER) {
 123         /// course header
 124         $navlinks = array();
 125         if ($courseid != SITEID) {
 126             if (has_capability('moodle/course:viewparticipants', get_context_instance(CONTEXT_COURSE, $course->id))) {
 127                 $navlinks[] = array('name' => $strparticipants, 'link' => "$CFG->wwwroot/user/index.php?id=$course->id", 'type' => 'misc');
 128             }
 129             $navlinks[] = array('name' => $fullname, 'link' => "$CFG->wwwroot/user/view.php?id=$userid&amp;course=$courseid", 'type' => 'misc');
 130             $navlinks[] = array('name' => $straction, 'link' => null, 'type' => 'misc');
 131             $navigation = build_navigation($navlinks);
 132
 133             print_header("$fullname", "$fullname", $navigation, "", "", true, "&nbsp;", navmenu($course));
 134
 135         /// site header
 136         } else {
 137             $navlinks[] = array('name' => $fullname, 'link' => "$CFG->wwwroot/user/view.php?id=$userid&amp;course=$courseid", 'type' => 'misc');
 138             $navlinks[] = array('name' => $straction, 'link' => null, 'type' => 'misc');
 139             $navigation = build_navigation($navlinks);
 140             print_header("$course->fullname: $fullname", $course->fullname, $navigation, "", "", true, "&nbsp;", navmenu($course));
 141         }
 142
 143         $showroles = 1;
 144         $currenttab = 'assign';
 145         include_once($CFG->dirroot.'/user/tabs.php');
 146     } else if ($context->contextlevel == CONTEXT_SYSTEM) {
 147         admin_externalpage_setup('assignroles');
 148         admin_externalpage_print_header();
 149     } else if ($context->contextlevel==CONTEXT_COURSE and $context->instanceid == SITEID) {
 150         admin_externalpage_setup('frontpageroles');
 151         admin_externalpage_print_header();
 152         $currenttab = 'assign';
 153         include_once('tabs.php');
 154     } else {
 155         $currenttab = 'assign';
 156         include_once('tabs.php');
 157     }
 158
 159
 160
 161 /// Process incoming role assignment
 162
 163     if ($frm = data_submitted()) {
 164
 165         if ($add and !empty($frm->addselect) and confirm_sesskey()) {
 166
 167             foreach ($frm->addselect as $adduser) {
 168                 if (!$adduser = clean_param($adduser, PARAM_INT)) {
 169                     continue;
 170                 }
 171                 $allow = true;
 172                 if ($inmeta) {
 173                     if (has_capability('moodle/course:managemetacourse', $context, $adduser)) {
 174                         //ok
 175                     } else {
 176                         $managerroles = get_roles_with_capability('moodle/course:managemetacourse', CAP_ALLOW, $context);
 177                         if (!empty($managerroles) and !array_key_exists($roleid, $managerroles)) {
 178                             $erruser = get_record('user', 'id', $adduser, '','','','', 'id, firstname, lastname');
 179                             $errors[] = get_string('metaassignerror', 'role', fullname($erruser));
 180                             $allow = false;
 181                         }
 182                     }
 183                 }
 184                 if ($allow) {
 185                     switch($extendbase) {
 186                         case 0:
 187                             $timestart = $course->startdate;
 188                             break;
 189                         case 3:
 190                             $timestart = $today;
 191                             break;
 192                         case 4:
 193                             $timestart = $course->enrolstartdate;
 194                             break;
 195                         case 5:
 196                             $timestart = $course->enrolenddate;
 197                             break;
 198                     }
 199
 200                     if($extendperiod > 0) {
 201                         $timeend = $timestart + $extendperiod;
 202                     } else {
 203                         $timeend = 0;
 204                     }
 205                     if (! role_assign($roleid, $adduser, 0, $context->id, $timestart, $timeend, $hidden)) {
 206                         $errors[] = "Could not add user with id $adduser to this role!";
 207                     }
 208                 }
 209             }
 210
 211             $rolename = get_field('role', 'name', 'id', $roleid);
 212             add_to_log($course->id, 'role', 'assign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);
 213         } else if ($remove and !empty($frm->removeselect) and confirm_sesskey()) {
 214
 215             $sitecontext = get_context_instance(CONTEXT_SYSTEM);
 216             $topleveladmin = false;
 217
 218             // we only worry about this if the role has doanything capability at site level
 219             if ($context->id == $sitecontext->id && $adminroles = get_roles_with_capability('moodle/site:doanything', CAP_ALLOW, $sitecontext)) {
 220                 foreach ($adminroles as $adminrole) {
 221                     if ($adminrole->id == $roleid) {
 222                         $topleveladmin = true;
 223                     }
 224                 }
 225             }
 226
 227             foreach ($frm->removeselect as $removeuser) {
 228                 $removeuser = clean_param($removeuser, PARAM_INT);
 229
 230                 if ($topleveladmin && ($removeuser == $USER->id)) {   // Prevent unassigning oneself from being admin
 231                     continue;
 232                 }
 233
 234                 if (! role_unassign($roleid, $removeuser, 0, $context->id)) {
 235                     $errors[] = "Could not remove user with id $removeuser from this role!";
 236                 } else if ($inmeta) {
 237                     sync_metacourse($courseid);
 238                     $newroles = get_user_roles($context, $removeuser, false);
 239                     if (!empty($newroles) and !array_key_exists($roleid, $newroles)) {
 240                         $erruser = get_record('user', 'id', $removeuser, '','','','', 'id, firstname, lastname');
 241                         $errors[] = get_string('metaunassignerror', 'role', fullname($erruser));
 242                         $allow = false;
 243                     }
 244                 }
 245             }
 246
 247             $rolename = get_field('role', 'name', 'id', $roleid);
 248             add_to_log($course->id, 'role', 'unassign', 'admin/roles/assign.php?contextid='.$context->id.'&roleid='.$roleid, $rolename, '', $USER->id);
 249         } else if ($showall) {
 250             $searchtext = '';
 251             $previoussearch = 0;
 252         }
 253
 254
 255
 256     }
 257
 258     if ($context->contextlevel==CONTEXT_COURSE and $context->instanceid == SITEID) {
 259         print_heading_with_help(get_string('frontpageroles', 'admin'), 'assignroles');
 260     } else {
 261         print_heading_with_help(get_string('assignrolesin', 'role', print_context_name($context)), 'assignroles');
 262     }
 263
 264     if ($context->contextlevel==CONTEXT_SYSTEM) {
 265         print_box(get_string('globalroleswarning', 'role'));
 266     }
 267
 268     if ($roleid) {        /// prints a form to swap roles
 269
 270     /// Get all existing participants in this context.
 271         // Why is this not done with get_users???
 272
 273         if (!$contextusers = get_role_users($roleid, $context, false, 'u.id, u.firstname, u.lastname, u.email, ra.hidden')) {
 274             $contextusers = array();
 275         }
 276
 277         $select  = "username <> 'guest' AND deleted = 0 AND confirmed = 1";
 278
 279         $usercount = count_records_select('user', $select) - count($contextusers);
 280
 281         $searchtext = trim($searchtext);
 282
 283         if ($searchtext !== '') {   // Search for a subset of remaining users
 284             $LIKE      = sql_ilike();
 285             $FULLNAME  = sql_fullname();
 286
 287             $selectsql = " AND ($FULLNAME $LIKE '%$searchtext%' OR email $LIKE '%$searchtext%') ";
 288             $select  .= $selectsql;
 289         } else {
 290             $selectsql = "";
 291         }
 292
 293         if ($context->contextlevel > CONTEXT_COURSE) { // mod or block (or group?)
 294
 295             /************************************************************************
 296              *                                                                      *
 297              * context level is above or equal course context level                 *
 298              * in this case we pull out all users matching search criteria (if any) *
 299              *                                                                      *
 300              * MDL-11324                                                            *
 301              * a mini get_users_by_capability() call here, this is done instead of  *
 302              * get_users_by_capability() because                                    *
 303              * 1) get_users_by_capability() does not deal with searching by name    *
 304              * 2) exceptions array can be potentially large for large courses       *
 305              * 3) get_recordset_sql() is more efficient                             *
 306              *                                                                      *
 307              ************************************************************************/
 308
 309             if ($possibleroles = get_roles_with_capability('moodle/course:view', CAP_ALLOW, $context)) {
 310
 311                 $doanythingroles = get_roles_with_capability('moodle/site:doanything', CAP_ALLOW, get_context_instance(CONTEXT_SYSTEM));
 312
 313                 $validroleids = array();
 314                 foreach ($possibleroles as $possiblerole) {
 315                     if (isset($doanythingroles[$possiblerole->id])) {  // We don't want these included
 316                             continue;
 317                     }
 318                     if ($caps = role_context_capabilities($possiblerole->id, $context, 'moodle/course:view')) { // resolved list
 319                         if (isset($caps['moodle/course:view']) && $caps['moodle/course:view'] > 0) { // resolved capability > 0
 320                             $validroleids[] = $possiblerole->id;
 321                         }
 322                     }
 323                 }
 324
 325                 if ($validroleids) {
 326                     $roleids =  '('.implode(',', $validroleids).')';
 327
 328                     $select = " SELECT u.id, u.firstname, u.lastname, u.email";
 329                     $countselect = "SELECT COUNT(u.id)";
 330                     $from   = " FROM {$CFG->prefix}user u
 331                                 INNER JOIN {$CFG->prefix}role_assignments ra ON ra.userid = u.id
 332                                 INNER JOIN {$CFG->prefix}role r ON r.id = ra.roleid";
 333                     $where  = " WHERE ra.contextid ".get_related_contexts_string($context)."
 334                                 AND u.deleted = 0
 335                                 AND ra.roleid in $roleids";
 336                     $excsql = " AND u.id NOT IN (
 337                                     SELECT u.id
 338                                     FROM {$CFG->prefix}role_assignments r,
 339                                     {$CFG->prefix}user u
 340                                     WHERE r.contextid = $contextid
 341                                     AND u.id = r.userid
 342                                     AND r.roleid = $roleid
 343                                     $selectsql)";
 344
 345                     $availableusers = get_recordset_sql($select . $from . $where . $selectsql . $excsql);
 346                 }
 347
 348                 $usercount =  $availableusers->_numOfRows;
 349             }
 350
 351         } else {
 352
 353             /************************************************************************
 354              *                                                                      *
 355              * context level is above or equal course context level                 *
 356              * in this case we pull out all users matching search criteria (if any) *
 357              *                                                                      *
 358              ************************************************************************/
 359
 360             /// MDL-11111 do not include user already assigned this role in this context as available users
 361             /// so that the number of available users is right and we save time looping later
 362             $availableusers = get_recordset_sql('SELECT id, firstname, lastname, email
 363                                                 FROM '.$CFG->prefix.'user
 364                                                 WHERE '.$select.'
 365                                                 AND id NOT IN (
 366                                                     SELECT u.id
 367                                                     FROM '.$CFG->prefix.'role_assignments r,
 368                                                     '.$CFG->prefix.'user u
 369                                                     WHERE r.contextid = '.$contextid.'
 370                                                     AND u.id = r.userid
 371                                                     AND r.roleid = '.$roleid.'
 372                                                     '.$selectsql.')
 373                                                 ORDER BY lastname ASC, firstname ASC');
 374
 375             $usercount = $availableusers->_numOfRows;
 376         }
 377
 378         echo '<div class="selector">';
 379         $assignableroles = array('0'=>get_string('listallroles', 'role').'...') + $assignableroles;
 380         popup_form("$CFG->wwwroot/$CFG->admin/roles/assign.php?userid=$userid&amp;courseid=$courseid&amp;contextid=$contextid&amp;roleid=",
 381             $assignableroles, 'switchrole', $roleid, '', '', '', false, 'self', $strroletoassign);
 382         echo '</div>';
 383
 384         print_simple_box_start('center');
 385         include('assign.html');
 386         print_simple_box_end();
 387
 388         if (!empty($errors)) {
 389             $msg = '<p>';
 390             foreach ($errors as $e) {
 391                 $msg .= $e.'<br />';
 392             }
 393             $msg .= '</p>';
 394             print_simple_box_start('center');
 395             notify($msg);
 396             print_simple_box_end();
 397         }
 398
 399     } else {   // Print overview table
 400
 401         // sync metacourse enrolments if needed
 402         if ($inmeta) {
 403             sync_metacourse($course);
 404         }
 405
 406         // Get the names of role holders for roles with between 1 and MAX_USERS_TO_LIST_PER_ROLE users,
 407         // and so determine whether to show the extra column.
 408         $rolehodlercount = array();
 409         $rolehodlernames = array();
 410         $strmorethanten = get_string('morethan', 'role', MAX_USERS_TO_LIST_PER_ROLE);
 411         $showroleholders = false;
 412         foreach ($assignableroles as $roleid => $rolename) {
 413             $countusers = count_role_users($roleid, $context);
 414             $rolehodlercount[$roleid] = $countusers;
 415             $roleusers = '';
 416             if (0 < $countusers && $countusers <= MAX_USERS_TO_LIST_PER_ROLE) {
 417                 $roleusers = get_role_users($roleid, $context, false, 'u.id, u.lastname, u.firstname');
 418                 if (!empty($roleusers)) {
 419                     $strroleusers = array();
 420                     foreach ($roleusers as $user) {
 421                         $strroleusers[] = '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $user->id . '" >' . fullname($user) . '</a>';
 422                     }
 423                     $rolehodlernames[$roleid] = implode('<br />', $strroleusers);
 424                     $showroleholders = true;
 425                 }
 426             } else if ($countusers > MAX_USERS_TO_LIST_PER_ROLE) {
 427                 $rolehodlernames[$roleid] = '<a href="'.$baseurl.'&amp;roleid='.$roleid.'">'.$strmorethanten.'</a>';
 428             } else {
 429                 $rolehodlernames[$roleid] = '';
 430             }
 431         }
 432
 433         // Print overview table
 434         $table->tablealign = 'center';
 435         $table->cellpadding = 5;
 436         $table->cellspacing = 0;
 437         $table->width = '60%';
 438         $table->head = array(get_string('roles', 'role'), get_string('description'), get_string('users'));
 439         $table->wrap = array('nowrap', '', 'nowrap');
 440         $table->align = array('right', 'left', 'center');
 441         if ($showroleholders) {
 442             $table->head[] = '';
 443             $table->wrap[] = 'nowrap';
 444             $table->align[] = 'left';
 445         }
 446
 447         foreach ($assignableroles as $roleid => $rolename) {
 448             $description = format_string(get_field('role', 'description', 'id', $roleid));
 449             $row = array('<a href="'.$baseurl.'&amp;roleid='.$roleid.'">'.$rolename.'</a>',$description, $rolehodlercount[$roleid]);
 450             if ($showroleholders) {
 451                 $row[] = $rolehodlernames[$roleid];
 452             }
 453             $table->data[] = $row;
 454         }
 455
 456         print_table($table);
 457     }
 458
 459     print_footer($course);
 460
 461 ?>