group/index.php

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