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 navigation_node::override_active_url($url);
  49 if ($userid) {
  50     $url->param('user', $userid);
  51 }
  52 if ($groupid) {
  53     $url->param('group', $groupid);
  54 }
  55 $PAGE->set_url($url);
  56
  57 // Make sure that the user has permissions to manage groups.
  58 require_login($course);
  59
  60 $context = context_course::instance($course->id);
  61 require_capability('moodle/course:managegroups', $context);
  62
  63 $PAGE->requires->js('/group/clientlib.js', true);
  64 $PAGE->requires->js('/group/module.js', true);
  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, ' . get_all_user_name_fields(true, 'u'))) {
  84
  85             $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
  86
  87             foreach($groupmemberroles as $roleid=>$roledata) {
  88                 $shortroledata = new stdClass();
  89                 $shortroledata->name = $roledata->name;
  90                 $shortroledata->users = array();
  91                 foreach($roledata->users as $member) {
  92                     $shortmember = new stdClass();
  93                     $shortmember->id = $member->id;
  94                     $shortmember->name = fullname($member, $viewfullnames);
  95                     $shortroledata->users[] = $shortmember;
  96                 }
  97                 $roles[] = $shortroledata;
  98             }
  99         }
 100         echo json_encode($roles);
 101         die;  // Client side JavaScript takes it from here.
 102
 103     case 'deletegroup':
 104         if (count($groupids) == 0) {
 105             print_error('errorselectsome','group',$returnurl);
 106         }
 107         $groupidlist = implode(',', $groupids);
 108         redirect(new moodle_url('/group/delete.php', array('courseid'=>$courseid, 'groups'=>$groupidlist)));
 109         break;
 110
 111     case 'showcreateorphangroupform':
 112         redirect(new moodle_url('/group/group.php', array('courseid'=>$courseid)));
 113         break;
 114
 115     case 'showautocreategroupsform':
 116         redirect(new moodle_url('/group/autogroup.php', array('courseid'=>$courseid)));
 117         break;
 118
 119     case 'showimportgroups':
 120         redirect(new moodle_url('/group/import.php', array('id'=>$courseid)));
 121         break;
 122
 123     case 'showgroupsettingsform':
 124         redirect(new moodle_url('/group/group.php', array('courseid'=>$courseid, 'id'=>$groupids[0])));
 125         break;
 126
 127     case 'updategroups': //Currently reloading.
 128         break;
 129
 130     case 'removemembers':
 131         break;
 132
 133     case 'showaddmembersform':
 134         redirect(new moodle_url('/group/members.php', array('group'=>$groupids[0])));
 135         break;
 136
 137     case 'updatemembers': //Currently reloading.
 138         break;
 139
 140     default: //ERROR.
 141         print_error('unknowaction', '', $returnurl);
 142         break;
 143 }
 144
 145 // Print the page and form
 146 $strgroups = get_string('groups');
 147 $strparticipants = get_string('participants');
 148
 149 /// Print header
 150 $PAGE->set_title($strgroups);
 151 $PAGE->set_heading($course->fullname);
 152 $PAGE->set_pagelayout('standard');
 153 echo $OUTPUT->header();
 154
 155 // Add tabs
 156 $currenttab = 'groups';
 157 require('tabs.php');
 158
 159 echo $OUTPUT->heading(format_string($course->shortname, true, array('context' => $context)) .' '.$strgroups, 3);
 160
 161 $groups = groups_get_all_groups($courseid);
 162 $selectedname = null;
 163 $preventgroupremoval = array();
 164
 165 // Get list of groups to render.
 166 $groupoptions = array();
 167 if ($groups) {
 168     foreach ($groups as $group) {
 169         $selected = false;
 170         $usercount = $DB->count_records('groups_members', array('groupid' => $group->id));
 171         $groupname = format_string($group->name) . ' (' . $usercount . ')';
 172         if (in_array($group->id, $groupids)) {
 173             $selected = true;
 174             if ($singlegroup) {
 175                 // Only keep selected name if there is one group selected.
 176                 $selectedname = $groupname;
 177             }
 178         }
 179         if (!empty($group->idnumber) && !has_capability('moodle/course:changeidnumber', $context)) {
 180             $preventgroupremoval[$group->id] = true;
 181         }
 182
 183         $groupoptions[] = (object) [
 184             'value' => $group->id,
 185             'selected' => $selected,
 186             'text' => $groupname
 187         ];
 188     }
 189 }
 190
 191 // Get list of group members to render if there is a single selected group.
 192 $members = array();
 193 if ($singlegroup) {
 194     $usernamefields = get_all_user_name_fields(true, 'u');
 195     if ($groupmemberroles = groups_get_members_by_role(reset($groupids), $courseid, 'u.id, ' . $usernamefields)) {
 196
 197         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
 198
 199         foreach ($groupmemberroles as $roleid => $roledata) {
 200             $users = array();
 201             foreach ($roledata->users as $member) {
 202                 $users[] = (object)[
 203                     'value' => $member->id,
 204                     'text' => fullname($member, $viewfullnames)
 205                 ];
 206             }
 207             $members[] = (object)[
 208                 'role' => s($roledata->name),
 209                 'rolemembers' => $users
 210             ];
 211         }
 212     }
 213 }
 214
 215 $disableaddedit = !$singlegroup;
 216 $disabledelete = !empty($groupids);
 217 $renderable = new \core_group\output\index_page($courseid, $groupoptions, $selectedname, $members, $disableaddedit, $disabledelete,
 218         $preventgroupremoval);
 219 $output = $PAGE->get_renderer('core_group');
 220 echo $output->render($renderable);
 221
 222 echo $OUTPUT->footer();
 223
 224 /**
 225  * Returns the first button action with the given prefix, taken from
 226  * POST or GET, otherwise returns false.
 227  * @see /lib/moodlelib.php function optional_param().
 228  * @param string $prefix 'act_' as in 'action'.
 229  * @return string The action without the prefix, or false if no action found.
 230  */
 231 function groups_param_action($prefix = 'act_') {
 232     $action = false;
 233 //($_SERVER['QUERY_STRING'] && preg_match("/$prefix(.+?)=(.+)/", $_SERVER['QUERY_STRING'], $matches)) { //b_(.*?)[&;]{0,1}/
 234
 235     if ($_POST) {
 236         $form_vars = $_POST;
 237     }
 238     elseif ($_GET) {
 239         $form_vars = $_GET;
 240     }
 241     if ($form_vars) {
 242         foreach ($form_vars as $key => $value) {
 243             if (preg_match("/$prefix(.+)/", $key, $matches)) {
 244                 $action = $matches[1];
 245                 break;
 246             }
 247         }
 248     }
 249     if ($action && !preg_match('/^\w+$/', $action)) {
 250         $action = false;
 251         print_error('unknowaction');
 252     }
 253     ///if (debugging()) echo 'Debug: '.$action;
 254     return $action;
 255 }