19a27290af14a4f879d6257f475c3130a0ee58ca
[moodle.git] / group / autogroup.php
1 <?php // $Id$
2 /**
3  * Create and allocate users go groups
4  *
5  * @author  Matt Clarkson mattc@catalyst.net.nz
6  * @version 0.0.1
7  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
8  * @package groups
9  */
11 require_once('../config.php');
12 require_once('lib.php');
13 require_once('autogroup_form.php');
15 if (!defined('AUTOGROUP_MIN_RATIO')) {
16     define('AUTOGROUP_MIN_RATIO', 0.7); // means minimum member count is 70% in the smallest group
17 }
19 $courseid = required_param('courseid', PARAM_INT);
20 $PAGE->set_url('/group/autogroup.php', array('courseid' => $courseid));
22 if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
23     print_error('invalidcourseid');
24 }
26 // Make sure that the user has permissions to manage groups.
27 require_login($course);
29 $context       = get_context_instance(CONTEXT_COURSE, $courseid);
30 $systemcontext = get_context_instance(CONTEXT_SYSTEM);
31 require_capability('moodle/course:managegroups', $context);
33 $returnurl = $CFG->wwwroot.'/group/index.php?id='.$course->id;
35 $strgroups           = get_string('groups');
36 $strparticipants     = get_string('participants');
37 $strautocreategroups = get_string('autocreategroups', 'group');
39 // Print the page and form
40 $navlinks = array(array('name'=>$strparticipants, 'link'=>$CFG->wwwroot.'/user/index.php?id='.$courseid, 'type'=>'misc'),
41                   array('name' => $strgroups, 'link' => "$CFG->wwwroot/group/index.php?id=$courseid", 'type' => 'misc'),
42                   array('name' => $strautocreategroups, 'link' => null, 'type' => 'misc'));
43 $navigation = build_navigation($navlinks);
45 $preview = '';
46 $error = '';
48 /// Get applicable roles
49 $rolenames = array();
50 if ($roles = get_roles_used_in_context($context, true)) {
51     $canviewroles    = get_roles_with_capability('moodle/course:view', CAP_ALLOW, $context);
52     $doanythingroles = get_roles_with_capability('moodle/site:doanything', CAP_ALLOW, $systemcontext);
54     foreach ($roles as $role) {
55         if (!isset($canviewroles[$role->id])) {   // Avoid this role (eg course creator)
56             continue;
57         }
58         if (isset($doanythingroles[$role->id])) {   // Avoid this role (ie admin)
59             continue;
60         }
61         $rolenames[$role->id] = strip_tags(role_get_name($role, $context));   // Used in menus etc later on
62     }
63 }
65 /// Create the form
66 $editform = new autogroup_form(null, array('roles' => $rolenames));
67 $editform->set_data(array('courseid' => $courseid, 'seed' => time()));
69 /// Handle form submission
70 if ($editform->is_cancelled()) {
71     redirect($returnurl);
73 } elseif ($data = $editform->get_data()) {
75     /// Allocate members from the selected role to groups
76     switch ($data->allocateby) {
77         case 'no':
78         case 'random':
79         case 'lastname':
80             $orderby = 'lastname, firstname'; break;
81         case 'firstname':
82             $orderby = 'firstname, lastname'; break;
83         case 'idnumber':
84             $orderby = 'idnumber'; break;
85         default:
86             print_error('unknoworder');
87     }
88     $users = groups_get_potential_members($data->courseid, $data->roleid, $orderby);
89     $usercnt = count($users);
91     if ($data->allocateby == 'random') {
92         srand($data->seed);
93         shuffle($users);
94     }
96     $groups = array();
98     // Plan the allocation
99     if ($data->groupby == 'groups') {
100         $numgrps    = $data->number;
101         $userpergrp = floor($usercnt/$numgrps);
103     } else { // members
104         $numgrps    = ceil($usercnt/$data->number);
105         $userpergrp = $data->number;
107         if (!empty($data->nosmallgroups) and $usercnt % $data->number != 0) {
108             // If there would be one group with a small number of member reduce the number of groups
109             $missing = $userpergrp * $numgrps - $usercnt;
110             if ($missing > $userpergrp * (1-AUTOGROUP_MIN_RATIO)) {
111                 // spread the users from the last small group
112                 $numgrps--;
113                 $userpergrp = floor($usercnt/$numgrps);
114             }
115         }
116     }
118     // allocate the users - all groups equal count first
119     for ($i=0; $i<$numgrps; $i++) {
120         $groups[$i] = array();
121         $groups[$i]['name']    = groups_parse_name(trim($data->namingscheme), $i);
122         $groups[$i]['members'] = array();
123         if ($data->allocateby == 'no') {
124             continue; // do not allocate users
125         }
126         for ($j=0; $j<$userpergrp; $j++) {
127             if (empty($users)) {
128                 break 2;
129             }
130             $user = array_shift($users);
131             $groups[$i]['members'][$user->id] = $user;
132         }
133     }
134     // now distribute the rest
135     if ($data->allocateby != 'no') {
136         for ($i=0; $i<$numgrps; $i++) {
137             if (empty($users)) {
138                 break 1;
139             }
140             $user = array_shift($users);
141             $groups[$i]['members'][$user->id] = $user;
142         }
143     }
145     if (isset($data->preview)) {
146         $table = new object();
147         if ($data->allocateby == 'no') {
148             $table->head  = array(get_string('groupscount', 'group', $numgrps));
149             $table->size  = array('100%');
150             $table->align = array('left');
151             $table->width = '40%';
152         } else {
153             $table->head  = array(get_string('groupscount', 'group', $numgrps), get_string('groupmembers', 'group'), get_string('usercounttotal', 'group', $usercnt));
154             $table->size  = array('20%', '70%', '10%');
155             $table->align = array('left', 'left', 'center');
156             $table->width = '90%';
157         }
158         $table->data  = array();
160         foreach ($groups as $group) {
161             $line = array();
162             if (groups_get_group_by_name($courseid, $group['name'])) {
163                 $line[] = '<span class="notifyproblem">'.get_string('groupnameexists', 'group', $group['name']).'</span>';
164                 $error = get_string('groupnameexists', 'group', $group['name']);
165             } else {
166                 $line[] = $group['name'];
167             }
168             if ($data->allocateby != 'no') {
169                 $unames = array();
170                 foreach ($group['members'] as $user) {
171                     $unames[] = fullname($user, true);
172                 }
173                 $line[] = implode(', ', $unames);
174                 $line[] = count($group['members']);
175             }
176             $table->data[] = $line;
177         }
179         $preview .= print_table($table, true);
181     } else {
182         $grouping = null;
183         $createdgrouping = null;
184         $createdgroups = array();
185         $failed = false;
187         // prepare grouping
188         if (!empty($data->grouping)) {
189             $groupingname = trim($data->groupingname);
190             if ($data->grouping < 0) {
191                 $grouping = new object();
192                 $grouping->courseid = $COURSE->id;
193                 $grouping->name     = $groupingname;
194                 $grouping->id = groups_create_grouping($grouping);
195                 $createdgrouping = $grouping->id;
196             } else {
197                 $grouping = groups_get_grouping($data->grouping);
198             }
199         }
201         // Save the groups data
202         foreach ($groups as $key=>$group) {
203             if (groups_get_group_by_name($courseid, $group['name'])) {
204                 $error = get_string('groupnameexists', 'group', $group['name']);
205                 $failed = true;
206                 break;
207             }
208             $newgroup = new object();
209             $newgroup->courseid = $data->courseid;
210             $newgroup->name     = $group['name'];
211             $groupid = groups_create_group($newgroup);
212             $createdgroups[] = $groupid;
213             foreach($group['members'] as $user) {
214                 groups_add_member($groupid, $user->id);
215             }
216             if ($grouping) {
217                 groups_assign_grouping($grouping->id, $groupid);
218             }
219         }
221         if ($failed) {
222             foreach ($createdgroups as $groupid) {
223                 groups_delete_group($groupid);
224             }
225             if ($createdgrouping) {
226                 groups_delete_grouping($createdgrouping);
227             }
228         } else {
229             redirect($returnurl);
230         }
231     }
234 /// Print header
235 print_header_simple($strgroups, ': '.$strgroups, $navigation, '', '', true, '', navmenu($course));
236 print_heading($strautocreategroups);
238 if ($error != '') {
239     notify($error);
242 /// Display the form
243 $editform->display();
245 if($preview !== '') {
246         print_heading(get_string('groupspreview', 'group'));
248     echo $preview;
251 print_footer($course);
252 ?>