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