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