60b351da731f426e7a13a4d7798dfac9fb41dc56
[moodle.git] / 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');
14 ini_set('include_path', $CFG->libdir.'/pear'.PATH_SEPARATOR.ini_get('include_path'));
16 $PAGE->requires->yui_lib('connection');
17 $PAGE->requires->js('group/clientlib.js');
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;
31 $returnurl = $CFG->wwwroot.'/group/index.php?id='.$courseid;
33 // Get the course information so we can print the header and
34 // check the course id is valid
36 if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
37     $success = false;
38     print_error('invalidcourse'); //'The course ID is invalid'
39 }
41 // Make sure that the user has permissions to manage groups.
42 require_login($course);
44 $context = get_context_instance(CONTEXT_COURSE, $courseid);
45 if (! has_capability('moodle/course:managegroups', $context)) {
46     redirect(); //"group.php?id=$course->id");   // Not allowed to see all groups
47 }
49 // Check for multiple/no group errors
50 if(!$singlegroup) {
51     switch($action) {
52         case 'ajax_getmembersingroup':
53         case 'showgroupsettingsform':
54         case 'showaddmembersform':
55         case 'updatemembers':
56             print_error('errorselectone','group',$returnurl);
57     }
58 }
60 switch ($action) {
61     case false: //OK, display form.
62         break;
64     case 'ajax_getmembersingroup':
65         $roles = array();
66         if ($groupmemberroles = groups_get_members_by_role($groupids[0],$courseid,'u.id,u.firstname,u.lastname')) {
67             foreach($groupmemberroles as $roleid=>$roledata) {
68                 $shortroledata=new StdClass;
69                 $shortroledata->name=$roledata->name;
70                 $shortroledata->users=array();
71                 foreach($roledata->users as $member) {
72                     $shortmember=new StdClass;
73                     $shortmember->id=$member->id;
74                     $shortmember->name=fullname($member, true);
75                     $shortroledata->users[]=$shortmember;
76                 }
77                 $roles[]=$shortroledata;
78             }
79         }
80         echo json_encode($roles);
81         die;  // Client side JavaScript takes it from here.
83     case 'deletegroup':
84         if(count($groupids)==0) {
85             print_error('errorselectsome','group',$returnurl);
86         }
87         $groupidlist=implode(',',$groupids);
88         redirect('delete.php?courseid='.$courseid.'&groups='.$groupidlist);
89         break;
91     case 'showcreateorphangroupform':
92         redirect('group.php?courseid='.$courseid);
93         break;
95     case 'showautocreategroupsform':
96         redirect('autogroup.php?courseid='.$courseid);
97         break;
99     case 'showgroupsettingsform':
100         redirect('group.php?courseid='.$courseid.'&amp;id='.$groupids[0]);
101         break;
103     case 'updategroups': //Currently reloading.
104         break;
106     case 'removemembers':
107         break;
109     case 'showaddmembersform':
110         redirect('members.php?group='.$groupids[0]);
111         break;
113     case 'updatemembers': //Currently reloading.
114         break;
116     default: //ERROR.
117         if (debugging()) {
118             print_error('unknowaction', '', $returnurl);
119         break;
120     }
123 // Print the page and form
124 $strgroups = get_string('groups');
125 $strparticipants = get_string('participants');
127 $navlinks = array(array('name'=>$strparticipants, 'link'=>$CFG->wwwroot.'/user/index.php?id='.$courseid, 'type'=>'misc'),
128                   array('name'=>$strgroups, 'link'=>'', 'type'=>'misc'));
129 $navigation = build_navigation($navlinks);
131 /// Print header
132 print_header_simple($strgroups, ': '.$strgroups, $navigation, '', '', true, '', navmenu($course));
133 // Add tabs
134 $currenttab = 'groups';
135 require('tabs.php');
137 $disabled = 'disabled="disabled"';
138 if (ajaxenabled()) {
139     // Some buttons are enabled if single group selected
140     $showaddmembersform_disabled = $singlegroup ? '' : $disabled;
141     $showeditgroupsettingsform_disabled = $singlegroup ? '' : $disabled;
142     $deletegroup_disabled = count($groupids)>0 ? '' : $disabled;
143 } else {
144     // Do not disable buttons. The buttons work based on the selected group,
145     // which you can change without reloading the page, so it is not appropriate
146     // to disable them if no group is selected.
147     $showaddmembersform_disabled = '';
148     $showeditgroupsettingsform_disabled = '';
149     $deletegroup_disabled = '';
152 echo $OUTPUT->heading(format_string($course->shortname) .' '.$strgroups, 3);
153 echo '<form id="groupeditform" action="index.php" method="post">'."\n";
154 echo '<div>'."\n";
155 echo '<input type="hidden" name="id" value="' . $courseid . '" />'."\n";
157 echo '<table cellpadding="6" class="generaltable generalbox groupmanagementtable boxaligncenter" summary="">'."\n";
158 echo '<tr>'."\n";
161 echo "<td>\n";
162 echo '<p><label for="groups"><span id="groupslabel">'.get_string('groups').':</span><span id="thegrouping">&nbsp;</span></label></p>'."\n";
164 if (ajaxenabled()) {
165     $onchange = 'membersCombo.refreshMembers();';
166 } else {
167     $onchange = '';
170 echo '<select name="groups[]" multiple="multiple" id="groups" size="15" class="select" onchange="'.$onchange.'"'."\n";
171 echo ' onclick="window.status=this.selectedIndex==-1 ? \'\' : this.options[this.selectedIndex].title;" onmouseout="window.status=\'\';">'."\n";
173 $groups = groups_get_all_groups($courseid);
174 $selectedname = '&nbsp;';
176 if ($groups) {
177     // Print out the HTML
178     foreach ($groups as $group) {
179         $select = '';
180         $usercount = $DB->count_records('groups_members', array('groupid'=>$group->id));
181         $groupname = format_string($group->name).' ('.$usercount.')';
182         if (in_array($group->id,$groupids)) {
183             $select = ' selected="selected"';
184             if ($singlegroup) {
185                 // Only keep selected name if there is one group selected
186                 $selectedname = $groupname;
187             }
188         }
189         
190         echo "<option value=\"{$group->id}\"$select title=\"$groupname\">$groupname</option>\n";
191     }
192 } else {
193     // Print an empty option to avoid the XHTML error of having an empty select element
194     echo '<option>&nbsp;</option>';
197 echo '</select>'."\n";
198 echo '<p><input type="submit" name="act_updatemembers" id="updatemembers" value="'
199         . get_string('showmembersforgroup', 'group') . '" /></p>'."\n";
200 echo '<p><input type="submit" '. $showeditgroupsettingsform_disabled . ' name="act_showgroupsettingsform" id="showeditgroupsettingsform" value="'
201         . get_string('editgroupsettings', 'group') . '" /></p>'."\n";
202 echo '<p><input type="submit" '. $deletegroup_disabled . ' name="act_deletegroup" onclick="onDeleteGroup()" id="deletegroup" value="'
203         . get_string('deleteselectedgroup', 'group') . '" /></p>'."\n";
205 echo '<p><input type="submit" name="act_showcreateorphangroupform" id="showcreateorphangroupform" value="'
206         . get_string('creategroup', 'group') . '" /></p>'."\n";
208 echo '<p><input type="submit" name="act_showautocreategroupsform" id="showautocreategroupsform" value="'
209         . get_string('autocreategroups', 'group') . '" /></p>'."\n";
211 echo '</td>'."\n";
212 echo '<td>'."\n";
214 echo '<p><label for="members"><span id="memberslabel">'.
215     get_string('membersofselectedgroup', 'group').
216     ' </span><span id="thegroup">'.$selectedname.'</span></label></p>'."\n";
217 //NOTE: the SELECT was, multiple="multiple" name="user[]" - not used and breaks onclick.
218 echo '<select name="user" id="members" size="15" class="select"'."\n";
219 echo ' onclick="window.status=this.options[this.selectedIndex].title;" onmouseout="window.status=\'\';">'."\n";
221 $member_names = array();
223 $atleastonemember = false;
224 if ($singlegroup) {
225     if ($groupmemberroles = groups_get_members_by_role($groupids[0],$courseid,'u.id,u.firstname,u.lastname')) {
226         foreach($groupmemberroles as $roleid=>$roledata) {
227             echo '<optgroup label="'.s($roledata->name).'">';
228             foreach($roledata->users as $member) {
229                 echo '<option value="'.$member->id.'">'.fullname($member, true).'</option>';
230                 $atleastonemember = true;
231             }
232             echo '</optgroup>';
233         }
234     }
237 if (!$atleastonemember) {
238     // Print an empty option to avoid the XHTML error of having an empty select element
239     echo '<option>&nbsp;</option>';
242 echo '</select>'."\n";
244 echo '<p><input type="submit" ' . $showaddmembersform_disabled . ' name="act_showaddmembersform" '
245         . 'id="showaddmembersform" value="' . get_string('adduserstogroup', 'group'). '" /></p>'."\n";
246 echo '</td>'."\n";
247 echo '</tr>'."\n";
248 echo '</table>'."\n";
250 //<input type="hidden" name="rand" value="om" />
251 echo '</div>'."\n";
252 echo '</form>'."\n";
254 if (ajaxenabled()) {
255     $PAGE->requires->js_function_call('var groupsCombo = new UpdatableGroupsCombo',
256             array($CFG->httpswwwroot, $course->id));
257     $PAGE->requires->js_function_call('var membersCombo = new UpdatableMembersCombo',
258             array($CFG->httpswwwroot, $course->id));
261 echo $OUTPUT->footer();
263 /**
264  * Returns the first button action with the given prefix, taken from
265  * POST or GET, otherwise returns false.
266  * See /lib/moodlelib.php function optional_param.
267  * @param $prefix 'act_' as in 'action'.
268  * @return string The action without the prefix, or false if no action found.
269  */
270 function groups_param_action($prefix = 'act_') {
271     $action = false;
272 //($_SERVER['QUERY_STRING'] && preg_match("/$prefix(.+?)=(.+)/", $_SERVER['QUERY_STRING'], $matches)) { //b_(.*?)[&;]{0,1}/
274     if ($_POST) {
275         $form_vars = $_POST;
276     }
277     elseif ($_GET) {
278         $form_vars = $_GET;
279     }
280     if ($form_vars) {
281         foreach ($form_vars as $key => $value) {
282             if (preg_match("/$prefix(.+)/", $key, $matches)) {
283                 $action = $matches[1];
284                 break;
285             }
286         }
287     }
288     if ($action && !preg_match('/^\w+$/', $action)) {
289         $action = false;
290         print_error('unknowaction');
291     }
292     ///if (debugging()) echo 'Debug: '.$action;
293     return $action;
296 ?>