081ec40f4c325ce64ddf9efca2ccf70f2a54f9a9
[moodle.git] / grade / edit / tree / 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/>.
17 /**
18  * The Gradebook setup page.
19  *
20  * @package   core_grades
21  * @copyright 2008 Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once '../../../config.php';
26 require_once $CFG->dirroot.'/grade/lib.php';
27 require_once $CFG->dirroot.'/grade/report/lib.php'; // for preferences
28 require_once $CFG->dirroot.'/grade/edit/tree/lib.php';
30 $courseid        = required_param('id', PARAM_INT);
31 $action          = optional_param('action', 0, PARAM_ALPHA);
32 $eid             = optional_param('eid', 0, PARAM_ALPHANUM);
33 $category        = optional_param('category', null, PARAM_INT);
34 $aggregationtype = optional_param('aggregationtype', null, PARAM_INT);
36 $url = new moodle_url('/grade/edit/tree/index.php', array('id' => $courseid));
37 $PAGE->set_url($url);
38 $PAGE->set_pagelayout('admin');
40 /// Make sure they can even access this course
41 if (!$course = $DB->get_record('course', array('id' => $courseid))) {
42     print_error('nocourseid');
43 }
45 require_login($course);
46 $context = context_course::instance($course->id);
47 require_capability('moodle/grade:manage', $context);
49 // todo $PAGE->requires->js_module() should be used here instead
50 $PAGE->requires->js('/grade/edit/tree/functions.js');
52 /// return tracking object
53 $gpr = new grade_plugin_return(array('type'=>'edit', 'plugin'=>'tree', 'courseid'=>$courseid));
54 $returnurl = $gpr->get_return_url(null);
56 // Change category aggregation if requested
57 if (!is_null($category) && !is_null($aggregationtype) && confirm_sesskey()) {
58     if (!$grade_category = grade_category::fetch(array('id'=>$category, 'courseid'=>$courseid))) {
59         print_error('invalidcategoryid');
60     }
62     $data = new stdClass();
63     $data->aggregation = $aggregationtype;
64     grade_category::set_properties($grade_category, $data);
65     $grade_category->update();
66 }
68 //first make sure we have proper final grades - we need it for locking changes
69 $normalisationmessage = null;
71 $originalweights = grade_helper::fetch_all_natural_weights_for_course($courseid);
73 $alteredweights = grade_helper::fetch_all_natural_weights_for_course($courseid);
75 if (array_diff($originalweights, $alteredweights)) {
76     $normalisationmessage = get_string('weightsadjusted', 'grades');
77 }
79 // get the grading tree object
80 // note: total must be first for moving to work correctly, if you want it last moving code must be rewritten!
81 $gtree = new grade_tree($courseid, false, false);
83 if (empty($eid)) {
84     $element = null;
85     $object  = null;
87 } else {
88     if (!$element = $gtree->locate_element($eid)) {
89         print_error('invalidelementid', '', $returnurl);
90     }
91     $object = $element['object'];
92 }
94 $switch = grade_get_setting($course->id, 'aggregationposition', $CFG->grade_aggregationposition);
96 $strgrades             = get_string('grades');
97 $strgraderreport       = get_string('graderreport', 'grades');
99 $moving = false;
100 $movingeid = false;
102 if ($action == 'moveselect') {
103     if ($eid and confirm_sesskey()) {
104         $movingeid = $eid;
105         $moving=true;
106     }
109 $grade_edit_tree = new grade_edit_tree($gtree, $movingeid, $gpr);
111 switch ($action) {
112     case 'delete':
113         if ($eid && confirm_sesskey()) {
114             if (!$grade_edit_tree->element_deletable($element)) {
115                 // no deleting of external activities - they would be recreated anyway!
116                 // exception is activity without grading or misconfigured activities
117                 break;
118             }
119             $confirm = optional_param('confirm', 0, PARAM_BOOL);
121             if ($confirm) {
122                 $object->delete('grade/report/grader/category');
123                 redirect($returnurl);
125             } else {
126                 $PAGE->set_title($strgrades . ': ' . $strgraderreport);
127                 $PAGE->set_heading($course->fullname);
128                 echo $OUTPUT->header();
129                 $strdeletecheckfull = get_string('deletecheck', '', $object->get_name());
130                 $optionsyes = array('eid'=>$eid, 'confirm'=>1, 'sesskey'=>sesskey(), 'id'=>$course->id, 'action'=>'delete');
131                 $optionsno  = array('id'=>$course->id);
132                 $formcontinue = new single_button(new moodle_url('index.php', $optionsyes), get_string('yes'));
133                 $formcancel = new single_button(new moodle_url('index.php', $optionsno), get_string('no'), 'get');
134                 echo $OUTPUT->confirm($strdeletecheckfull, $formcontinue, $formcancel);
135                 echo $OUTPUT->footer();
136                 die;
137             }
138         }
139         break;
141     case 'autosort':
142         //TODO: implement autosorting based on order of mods on course page, categories first, manual items last
143         break;
145     case 'move':
146         if ($eid and confirm_sesskey()) {
147             $moveafter = required_param('moveafter', PARAM_ALPHANUM);
148             $first = optional_param('first', false,  PARAM_BOOL); // If First is set to 1, it means the target is the first child of the category $moveafter
150             if(!$after_el = $gtree->locate_element($moveafter)) {
151                 print_error('invalidelementid', '', $returnurl);
152             }
154             $after = $after_el['object'];
155             $sortorder = $after->get_sortorder();
157             if (!$first) {
158                 $parent = $after->get_parent_category();
159                 $object->set_parent($parent->id);
160             } else {
161                 $object->set_parent($after->id);
162             }
164             $object->move_after_sortorder($sortorder);
166             redirect($returnurl);
167         }
168         break;
170     default:
171         break;
174 //if we go straight to the db to update an element we need to recreate the tree as
175 // $grade_edit_tree has already been constructed.
176 //Ideally we could do the updates through $grade_edit_tree to avoid recreating it
177 $recreatetree = false;
179 if ($data = data_submitted() and confirm_sesskey()) {
180     // Perform bulk actions first
181     if (!empty($data->bulkmove)) {
182         $elements = array();
184         foreach ($data as $key => $value) {
185             if (preg_match('/select_(ig[0-9]*)/', $key, $matches)) {
186                 $elements[] = $matches[1];
187             }
188         }
190         $grade_edit_tree->move_elements($elements, $returnurl);
191     }
193     // Update weights (extra credits) on categories and items.
194     foreach ($data as $key => $value) {
195         if (preg_match('/^weight_([0-9]+)$/', $key, $matches)) {
196             $aid   = $matches[1];
198             $value = unformat_float($value);
199             $value = clean_param($value, PARAM_FLOAT);
201             $grade_item = grade_item::fetch(array('id' => $aid, 'courseid' => $courseid));
203             // Convert weight to aggregation coef2.
204             $aggcoef = $grade_item->get_coefstring();
205             if ($aggcoef == 'aggregationcoefextraweightsum') {
206                 // The field 'weight' should only be sent when the checkbox 'weighoverride' is checked,
207                 // so there is not need to set weightoverride here, it is done below.
208                 $value = $value / 100.0;
209                 $grade_item->aggregationcoef2 = $value;
210             } else if ($aggcoef == 'aggregationcoefweight' || $aggcoef == 'aggregationcoefextraweight') {
211                 $grade_item->aggregationcoef = $value;
212             }
214             $grade_item->update();
216             $recreatetree = true;
218         // Grade item checkbox inputs.
219         } elseif (preg_match('/^(weightoverride)_([0-9]+)$/', $key, $matches)) {
220             $param   = $matches[1];
221             $aid     = $matches[2];
222             $value   = clean_param($value, PARAM_BOOL);
224             $grade_item = grade_item::fetch(array('id' => $aid, 'courseid' => $courseid));
225             $grade_item->$param = $value;
227             $grade_item->update();
229             $recreatetree = true;
230         }
231     }
233     $originalweights = grade_helper::fetch_all_natural_weights_for_course($courseid);
235     $alteredweights = grade_helper::fetch_all_natural_weights_for_course($courseid);
236     if (array_diff($originalweights, $alteredweights)) {
237         $normalisationmessage = get_string('weightsadjusted', 'grades');
238     }
241 // Do this check just before printing the grade header (and only do it once).
242 if (grade_needs_regrade_final_grades($courseid)) {
243     $PAGE->set_heading($course->fullname);
244     echo $OUTPUT->header();
245     echo $OUTPUT->heading(get_string('recalculatinggrades', 'grades'));
246     $progress = new \core\progress\display(true);
247     grade_regrade_final_grades($courseid, null, null, $progress);
248     echo $OUTPUT->continue_button($PAGE->url);
249     echo $OUTPUT->footer();
250     die();
253 print_grade_page_head($courseid, 'settings', 'setup', get_string('gradebooksetup', 'grades'));
255 // Print Table of categories and items
256 echo $OUTPUT->box_start('gradetreebox generalbox');
258 echo '<form id="gradetreeform" method="post" action="'.$returnurl.'">';
259 echo '<div>';
260 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
262 //did we update something in the db and thus invalidate $grade_edit_tree?
263 if ($recreatetree) {
264     $grade_edit_tree = new grade_edit_tree($gtree, $movingeid, $gpr);
266 // Check to see if we have a normalisation message to send.
267 if (!empty($normalisationmessage)) {
268     echo $OUTPUT->notification($normalisationmessage, 'notifymessage');
271 echo html_writer::table($grade_edit_tree->table);
273 echo '<div id="gradetreesubmit">';
274 if (!$moving) {
275     echo '<input class="advanced" type="submit" value="'.get_string('savechanges').'" />';
278 // We don't print a bulk move menu if there are no other categories than course category
279 if (!$moving && count($grade_edit_tree->categories) > 1) {
280     echo '<br /><br />';
281     echo '<input type="hidden" name="bulkmove" value="0" id="bulkmoveinput" />';
282     $attributes = array('id'=>'menumoveafter', 'class' => 'ignoredirty');
283     echo html_writer::label(get_string('moveselectedto', 'grades'), 'menumoveafter');
284     echo html_writer::select($grade_edit_tree->categories, 'moveafter', '', array(''=>'choosedots'), $attributes);
285     $OUTPUT->add_action_handler(new component_action('change', 'submit_bulk_move'), 'menumoveafter');
286     echo '<div id="noscriptgradetreeform" class="hiddenifjs">
287             <input type="submit" value="'.get_string('go').'" />
288           </div>';
291 echo '</div>';
293 echo '</div></form>';
295 echo $OUTPUT->box_end();
297 // Print action buttons
298 echo $OUTPUT->container_start('buttons mdl-align');
300 if ($moving) {
301     echo $OUTPUT->single_button(new moodle_url('index.php', array('id'=>$course->id)), get_string('cancel'), 'get');
302 } else {
303     echo $OUTPUT->single_button(new moodle_url('category.php', array('courseid'=>$course->id)), get_string('addcategory', 'grades'), 'get');
304     echo $OUTPUT->single_button(new moodle_url('item.php', array('courseid'=>$course->id)), get_string('additem', 'grades'), 'get');
306     if (!empty($CFG->enableoutcomes)) {
307         echo $OUTPUT->single_button(new moodle_url('outcomeitem.php', array('courseid'=>$course->id)), get_string('addoutcomeitem', 'grades'), 'get');
308     }
310     //echo $OUTPUT->(new moodle_url('index.php', array('id'=>$course->id, 'action'=>'autosort')), get_string('autosort', 'grades'), 'get');
313 echo $OUTPUT->container_end();
315 $PAGE->requires->yui_module('moodle-core-formchangechecker',
316     'M.core_formchangechecker.init',
317     array(array(
318         'formid' => 'gradetreeform'
319     ))
320 );
321 $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
323 echo $OUTPUT->footer();
324 die;