group/index.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 /**
  19  * The main group management user interface.
  20  *
  21  * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
  22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  * @package   core_group
  24  */
  25 require_once('../config.php');
  26 require_once('lib.php');
  27
  28 $courseid = required_param('id', PARAM_INT);
  29 $groupid  = optional_param('group', false, PARAM_INT);
  30 $userid   = optional_param('user', false, PARAM_INT);
  31 $action   = groups_param_action();
  32 // Support either single group= parameter, or array groups[]
  33 if ($groupid) {
  34     $groupids = array($groupid);
  35 } else {
  36     $groupids = optional_param_array('groups', array(), PARAM_INT);
  37 }
  38 $singlegroup = (count($groupids) == 1);
  39
  40 $returnurl = $CFG->wwwroot.'/group/index.php?id='.$courseid;
  41
  42 // Get the course information so we can print the header and
  43 // check the course id is valid
  44
  45 $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
  46
  47 $url = new moodle_url('/group/index.php', array('id'=>$courseid));
  48 if ($userid) {
  49     $url->param('user', $userid);
  50 }
  51 if ($groupid) {
  52     $url->param('group', $groupid);
  53 }
  54 $PAGE->set_url($url);
  55
  56 // Make sure that the user has permissions to manage groups.
  57 require_login($course);
  58
  59 $context = context_course::instance($course->id);
  60 require_capability('moodle/course:managegroups', $context);
  61
  62 $PAGE->requires->js('/group/clientlib.js');
  63
  64 // Check for multiple/no group errors
  65 if (!$singlegroup) {
  66     switch($action) {
  67         case 'ajax_getmembersingroup':
  68         case 'showgroupsettingsform':
  69         case 'showaddmembersform':
  70         case 'updatemembers':
  71             print_error('errorselectone', 'group', $returnurl);
  72     }
  73 }
  74
  75 switch ($action) {
  76     case false: //OK, display form.
  77         break;
  78
  79     case 'ajax_getmembersingroup':
  80         $roles = array();
  81         if ($groupmemberroles = groups_get_members_by_role($groupids[0], $courseid, 'u.id, ' . get_all_user_name_fields(true, 'u'))) {
  82             foreach($groupmemberroles as $roleid=>$roledata) {
  83                 $shortroledata = new stdClass();
  84                 $shortroledata->name = $roledata->name;
  85                 $shortroledata->users = array();
  86                 foreach($roledata->users as $member) {
  87                     $shortmember = new stdClass();
  88                     $shortmember->id = $member->id;
  89                     $shortmember->name = fullname($member, true);
  90                     $shortroledata->users[] = $shortmember;
  91                 }
  92                 $roles[] = $shortroledata;
  93             }
  94         }
  95         echo json_encode($roles);
  96         die;  // Client side JavaScript takes it from here.
  97
  98     case 'deletegroup':
  99         if (count($groupids) == 0) {
 100             print_error('errorselectsome','group',$returnurl);
 101         }
 102         $groupidlist = implode(',', $groupids);
 103         redirect(new moodle_url('/group/delete.php', array('courseid'=>$courseid, 'groups'=>$groupidlist)));
 104         break;
 105
 106     case 'showcreateorphangroupform':
 107         redirect(new moodle_url('/group/group.php', array('courseid'=>$courseid)));
 108         break;
 109
 110     case 'showautocreategroupsform':
 111         redirect(new moodle_url('/group/autogroup.php', array('courseid'=>$courseid)));
 112         break;
 113
 114     case 'showimportgroups':
 115         redirect(new moodle_url('/group/import.php', array('id'=>$courseid)));
 116         break;
 117
 118     case 'showgroupsettingsform':
 119         redirect(new moodle_url('/group/group.php', array('courseid'=>$courseid, 'id'=>$groupids[0])));
 120         break;
 121
 122     case 'updategroups': //Currently reloading.
 123         break;
 124
 125     case 'removemembers':
 126         break;
 127
 128     case 'showaddmembersform':
 129         redirect(new moodle_url('/group/members.php', array('group'=>$groupids[0])));
 130         break;
 131
 132     case 'updatemembers': //Currently reloading.
 133         break;
 134
 135     default: //ERROR.
 136         print_error('unknowaction', '', $returnurl);
 137         break;
 138 }
 139
 140 // Print the page and form
 141 $strgroups = get_string('groups');
 142 $strparticipants = get_string('participants');
 143
 144 /// Print header
 145 $PAGE->set_title($strgroups);
 146 $PAGE->set_heading($course->fullname);
 147 $PAGE->set_pagelayout('admin');
 148 echo $OUTPUT->header();
 149
 150 // Add tabs
 151 $currenttab = 'groups';
 152 require('tabs.php');
 153
 154 $disabled = 'disabled="disabled"';
 155 $ajaxenabled = ajaxenabled();
 156 if ($ajaxenabled) {
 157     // Some buttons are enabled if single group selected
 158     $showaddmembersform_disabled = $singlegroup ? '' : $disabled;
 159     $showeditgroupsettingsform_disabled = $singlegroup ? '' : $disabled;
 160     $deletegroup_disabled = count($groupids)>0 ? '' : $disabled;
 161 } else {
 162     // Do not disable buttons. The buttons work based on the selected group,
 163     // which you can change without reloading the page, so it is not appropriate
 164     // to disable them if no group is selected.
 165     $showaddmembersform_disabled = '';
 166     $showeditgroupsettingsform_disabled = '';
 167     $deletegroup_disabled = '';
 168 }
 169
 170 echo $OUTPUT->heading(format_string($course->shortname, true, array('context' => $context)) .' '.$strgroups, 3);
 171 echo '<form id="groupeditform" action="index.php" method="post">'."\n";
 172 echo '<div>'."\n";
 173 echo '<input type="hidden" name="id" value="' . $courseid . '" />'."\n";
 174
 175 echo '<table cellpadding="6" class="generaltable generalbox groupmanagementtable boxaligncenter" summary="">'."\n";
 176 echo '<tr>'."\n";
 177
 178
 179 echo "<td>\n";
 180 echo '<p><label for="groups"><span id="groupslabel">'.get_string('groups').':</span><span id="thegrouping">&nbsp;</span></label></p>'."\n";
 181
 182 if ($ajaxenabled) { // TODO: move this to JS init!
 183     $onchange = 'M.core_group.membersCombo.refreshMembers();';
 184 } else {
 185     $onchange = '';
 186 }
 187
 188 echo '<select name="groups[]" multiple="multiple" id="groups" size="15" class="select" onchange="'.$onchange.'"'."\n";
 189 echo ' onclick="window.status=this.selectedIndex==-1 ? \'\' : this.options[this.selectedIndex].title;" onmouseout="window.status=\'\';">'."\n";
 190
 191 $groups = groups_get_all_groups($courseid);
 192 $selectedname = '&nbsp;';
 193 $preventgroupremoval = array();
 194
 195 if ($groups) {
 196     // Print out the HTML
 197     foreach ($groups as $group) {
 198         $select = '';
 199         $usercount = $DB->count_records('groups_members', array('groupid'=>$group->id));
 200         $groupname = format_string($group->name).' ('.$usercount.')';
 201         if (in_array($group->id,$groupids)) {
 202             $select = ' selected="selected"';
 203             if ($singlegroup) {
 204                 // Only keep selected name if there is one group selected
 205                 $selectedname = $groupname;
 206             }
 207         }
 208         if (!empty($group->idnumber) && !has_capability('moodle/course:changeidnumber', $context)) {
 209             $preventgroupremoval[$group->id] = true;
 210         }
 211
 212         echo "<option value=\"{$group->id}\"$select title=\"$groupname\">$groupname</option>\n";
 213     }
 214 } else {
 215     // Print an empty option to avoid the XHTML error of having an empty select element
 216     echo '<option>&nbsp;</option>';
 217 }
 218
 219 echo '</select>'."\n";
 220 echo '<p><input type="submit" name="act_updatemembers" id="updatemembers" value="'
 221         . get_string('showmembersforgroup', 'group') . '" /></p>'."\n";
 222 echo '<p><input type="submit" '. $showeditgroupsettingsform_disabled . ' name="act_showgroupsettingsform" id="showeditgroupsettingsform" value="'
 223         . get_string('editgroupsettings', 'group') . '" /></p>'."\n";
 224 echo '<p><input type="submit" '. $deletegroup_disabled . ' name="act_deletegroup" id="deletegroup" value="'
 225         . get_string('deleteselectedgroup', 'group') . '" /></p>'."\n";
 226
 227 echo '<p><input type="submit" name="act_showcreateorphangroupform" id="showcreateorphangroupform" value="'
 228         . get_string('creategroup', 'group') . '" /></p>'."\n";
 229
 230 echo '<p><input type="submit" name="act_showautocreategroupsform" id="showautocreategroupsform" value="'
 231         . get_string('autocreategroups', 'group') . '" /></p>'."\n";
 232
 233 echo '<p><input type="submit" name="act_showimportgroups" id="showimportgroups" value="'
 234         . get_string('importgroups', 'core_group') . '" /></p>'."\n";
 235
 236 echo '</td>'."\n";
 237 echo '<td>'."\n";
 238
 239 echo '<p><label for="members"><span id="memberslabel">'.
 240     get_string('membersofselectedgroup', 'group').
 241     ' </span><span id="thegroup">'.$selectedname.'</span></label></p>'."\n";
 242 //NOTE: the SELECT was, multiple="multiple" name="user[]" - not used and breaks onclick.
 243 echo '<select name="user" id="members" size="15" class="select"'."\n";
 244 echo ' onclick="window.status=this.options[this.selectedIndex].title;" onmouseout="window.status=\'\';">'."\n";
 245
 246 $member_names = array();
 247
 248 $atleastonemember = false;
 249 if ($singlegroup) {
 250     if ($groupmemberroles = groups_get_members_by_role($groupids[0], $courseid, 'u.id, ' . get_all_user_name_fields(true, 'u'))) {
 251         foreach($groupmemberroles as $roleid=>$roledata) {
 252             echo '<optgroup label="'.s($roledata->name).'">';
 253             foreach($roledata->users as $member) {
 254                 echo '<option value="'.$member->id.'">'.fullname($member, true).'</option>';
 255                 $atleastonemember = true;
 256             }
 257             echo '</optgroup>';
 258         }
 259     }
 260 }
 261
 262 if (!$atleastonemember) {
 263     // Print an empty option to avoid the XHTML error of having an empty select element
 264     echo '<option>&nbsp;</option>';
 265 }
 266
 267 echo '</select>'."\n";
 268
 269 echo '<p><input type="submit" ' . $showaddmembersform_disabled . ' name="act_showaddmembersform" '
 270         . 'id="showaddmembersform" value="' . get_string('adduserstogroup', 'group'). '" /></p>'."\n";
 271 echo '</td>'."\n";
 272 echo '</tr>'."\n";
 273 echo '</table>'."\n";
 274
 275 //<input type="hidden" name="rand" value="om" />
 276 echo '</div>'."\n";
 277 echo '</form>'."\n";
 278
 279 if ($ajaxenabled) {
 280     $PAGE->requires->js_init_call('M.core_group.init_index', array($CFG->wwwroot, $courseid));
 281     $PAGE->requires->js_init_call('M.core_group.groupslist', array($preventgroupremoval));
 282 }
 283
 284 echo $OUTPUT->footer();
 285
 286 /**
 287  * Returns the first button action with the given prefix, taken from
 288  * POST or GET, otherwise returns false.
 289  * @see /lib/moodlelib.php function optional_param().
 290  * @param string $prefix 'act_' as in 'action'.
 291  * @return string The action without the prefix, or false if no action found.
 292  */
 293 function groups_param_action($prefix = 'act_') {
 294     $action = false;
 295 //($_SERVER['QUERY_STRING'] && preg_match("/$prefix(.+?)=(.+)/", $_SERVER['QUERY_STRING'], $matches)) { //b_(.*?)[&;]{0,1}/
 296
 297     if ($_POST) {
 298         $form_vars = $_POST;
 299     }
 300     elseif ($_GET) {
 301         $form_vars = $_GET;
 302     }
 303     if ($form_vars) {
 304         foreach ($form_vars as $key => $value) {
 305             if (preg_match("/$prefix(.+)/", $key, $matches)) {
 306                 $action = $matches[1];
 307                 break;
 308             }
 309         }
 310     }
 311     if ($action && !preg_match('/^\w+$/', $action)) {
 312         $action = false;
 313         print_error('unknowaction');
 314     }
 315     ///if (debugging()) echo 'Debug: '.$action;
 316     return $action;
 317 }