Merge branch 'MDL-70100-310' of git://github.com/bmbrands/moodle into MOODLE_310_STABLE
[moodle.git] / grade / grading / manage.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  * A single gradable area management page
19  *
20  * This page alows the user to set the current active method in the given
21  * area, provides access to the plugin editor and allows user to save the
22  * current form as a template or re-use some existing form.
23  *
24  * @package    core_grading
25  * @copyright  2011 David Mudrak <david@moodle.com>
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 require(__DIR__.'/../../config.php');
30 require_once($CFG->dirroot.'/grade/grading/lib.php');
32 // identify gradable area by its id
33 $areaid     = optional_param('areaid', null, PARAM_INT);
34 // alternatively the context, component and areaname must be provided
35 $contextid  = optional_param('contextid', null, PARAM_INT);
36 $component  = optional_param('component', null, PARAM_COMPONENT);
37 $area       = optional_param('area', null, PARAM_AREA);
38 // keep the caller's URL so that we know where to send the user finally
39 $returnurl  = optional_param('returnurl', null, PARAM_LOCALURL);
40 // active method selector
41 $setmethod  = optional_param('setmethod', null, PARAM_PLUGIN);
42 // publish the given form definition as a new template in the forms bank
43 $shareform  = optional_param('shareform', null, PARAM_INT);
44 // delete the given form definition
45 $deleteform = optional_param('deleteform', null, PARAM_INT);
46 // consider the required action as confirmed
47 $confirmed  = optional_param('confirmed', false, PARAM_BOOL);
48 // a message to display, typically a previous action's result
49 $message    = optional_param('message', null, PARAM_NOTAGS);
51 if (!is_null($areaid)) {
52     // get manager by id
53     $manager = get_grading_manager($areaid);
54 } else {
55     // get manager by context and component
56     if (is_null($contextid) or is_null($component) or is_null($area)) {
57         throw new coding_exception('The caller script must identify the gradable area.');
58     }
59     $context = context::instance_by_id($contextid, MUST_EXIST);
60     $manager = get_grading_manager($context, $component, $area);
61 }
63 if ($manager->get_context()->contextlevel < CONTEXT_COURSE) {
64     throw new coding_exception('Unsupported gradable area context level');
65 }
67 // get the currently active method
68 $method = $manager->get_active_method();
70 list($context, $course, $cm) = get_context_info_array($manager->get_context()->id);
72 require_login($course, true, $cm);
73 require_capability('moodle/grade:managegradingforms', $context);
75 if (!empty($returnurl)) {
76     $returnurl = new moodle_url($returnurl);
77 } else {
78     $returnurl = null;
79 }
81 $PAGE->set_url($manager->get_management_url($returnurl));
82 navigation_node::override_active_url($manager->get_management_url());
83 $PAGE->set_title(get_string('gradingmanagement', 'core_grading'));
84 $PAGE->set_heading(get_string('gradingmanagement', 'core_grading'));
85 $output = $PAGE->get_renderer('core_grading');
87 // process the eventual change of the active grading method
88 if (!empty($setmethod)) {
89     require_sesskey();
90     if ($setmethod == 'none') {
91         // here we expect that noone would actually want to call their plugin as 'none'
92         $setmethod = null;
93     }
94     $manager->set_active_method($setmethod);
95     redirect($PAGE->url);
96 }
98 // publish the form as a template
99 if (!empty($shareform)) {
100     require_capability('moodle/grade:sharegradingforms', context_system::instance());
101     $controller = $manager->get_controller($method);
102     $definition = $controller->get_definition();
103     if (!$confirmed) {
104         // let the user confirm they understand what they are doing (haha ;-)
105         echo $output->header();
106         echo $output->confirm(get_string('manageactionshareconfirm', 'core_grading', s($definition->name)),
107             new moodle_url($PAGE->url, array('shareform' => $shareform, 'confirmed' => 1)),
108             $PAGE->url);
109         echo $output->footer();
110         die();
111     } else {
112         require_sesskey();
113         $newareaid = $manager->create_shared_area($method);
114         $targetarea = get_grading_manager($newareaid);
115         $targetcontroller = $targetarea->get_controller($method);
116         $targetcontroller->update_definition($controller->get_definition_copy($targetcontroller));
117         $DB->set_field('grading_definitions', 'timecopied', time(), array('id' => $definition->id));
118         redirect(new moodle_url($PAGE->url, array('message' => get_string('manageactionsharedone', 'core_grading'))));
119     }
122 // delete the form definition
123 if (!empty($deleteform)) {
124     $controller = $manager->get_controller($method);
125     $definition = $controller->get_definition();
126     if (!$confirmed) {
127         // let the user confirm they understand the consequences (also known as WTF-effect)
128         echo $output->header();
129         echo $output->confirm(markdown_to_html(get_string('manageactiondeleteconfirm', 'core_grading', array(
130             'formname'  => s($definition->name),
131             'component' => $manager->get_component_title(),
132             'area'      => $manager->get_area_title()))),
133             new moodle_url($PAGE->url, array('deleteform' => $deleteform, 'confirmed' => 1)), $PAGE->url);
134         echo $output->footer();
135         die();
136     } else {
137         require_sesskey();
138         $controller->delete_definition();
139         redirect(new moodle_url($PAGE->url, array('message' => get_string('manageactiondeletedone', 'core_grading'))));
140     }
143 echo $output->header();
145 if (!empty($message)) {
146     echo $output->management_message($message);
149 echo $output->heading(get_string('gradingmanagementtitle', 'core_grading', array(
150     'component' => $manager->get_component_title(), 'area' => $manager->get_area_title())));
152 // display the active grading method information and selector
153 echo $output->management_method_selector($manager, $PAGE->url);
155 // get the currently active method's controller
156 if (!empty($method)) {
157     $controller = $manager->get_controller($method);
158     // display relevant actions
159     echo $output->container_start('actions');
160     if ($controller->is_form_defined()) {
161         $definition = $controller->get_definition();
162         // icon to edit the form definition
163         echo $output->management_action_icon($controller->get_editor_url($returnurl),
164             get_string('manageactionedit', 'core_grading'), 'b/document-edit');
165         // icon to delete the current form definition
166         echo $output->management_action_icon(new moodle_url($PAGE->url, array('deleteform' => $definition->id)),
167             get_string('manageactiondelete', 'core_grading'), 'b/edit-delete');
168         // icon to save the form as a new template
169         if (has_capability('moodle/grade:sharegradingforms', context_system::instance())) {
170             if (empty($definition->copiedfromid)) {
171                 $hasoriginal = false;
172             } else {
173                 $hasoriginal = $DB->record_exists('grading_definitions', array('id' => $definition->copiedfromid));
174             }
175             if (!$controller->is_form_available()) {
176                 // drafts can not be shared
177                 $allowshare = false;
178             } else if (!$hasoriginal) {
179                 // was created from scratch or is orphaned
180                 if (empty($definition->timecopied)) {
181                     // was never shared before
182                     $allowshare = true;
183                 } else if ($definition->timemodified > $definition->timecopied) {
184                     // was modified since last time shared
185                     $allowshare = true;
186                 } else {
187                     // was not modified since last time shared
188                     $allowshare = false;
189                 }
190             } else {
191                 // was created from a template and the template still exists
192                 if ($definition->timecreated == $definition->timemodified) {
193                     // was not modified since created
194                     $allowshare = false;
195                 } else if (empty($definition->timecopied)) {
196                     // was modified but was not re-shared yet
197                     $allowshare = true;
198                 } else if ($definition->timemodified > $definition->timecopied) {
199                     // was modified since last time re-shared
200                     $allowshare = true;
201                 } else {
202                     // was not modified since last time re-shared
203                     $allowshare = false;
204                 }
205             }
206             if ($allowshare) {
207                 echo $output->management_action_icon(new moodle_url($PAGE->url, array('shareform' => $definition->id)),
208                     get_string('manageactionshare', 'core_grading'), 'b/bookmark-new');
209             }
210         }
211     } else {
212         echo $output->management_action_icon($controller->get_editor_url($returnurl),
213             get_string('manageactionnew', 'core_grading'), 'b/document-new');
214         $pickurl = new moodle_url('/grade/grading/pick.php', array('targetid' => $controller->get_areaid()));
215         if (!is_null($returnurl)) {
216             $pickurl->param('returnurl', $returnurl->out(false));
217         }
218         echo $output->management_action_icon($pickurl,
219             get_string('manageactionclone', 'core_grading'), 'b/edit-copy');
220     }
221     echo $output->container_end();
223     // display the message if the form is currently not available (if applicable)
224     if ($message = $controller->form_unavailable_notification()) {
225         echo $output->notification($message);
226     }
227     // display the grading form preview
228     if ($controller->is_form_defined()) {
229         if ($definition->status == gradingform_controller::DEFINITION_STATUS_READY) {
230             $tag = html_writer::tag('span', get_string('statusready', 'core_grading'), array('class' => 'status ready'));
231         } else {
232             $tag = html_writer::tag('span', get_string('statusdraft', 'core_grading'), array('class' => 'status draft'));
233         }
234         echo $output->heading(s($definition->name) . ' ' . $tag, 3, 'definition-name');
235         echo $output->box($controller->render_preview($PAGE), 'definition-preview');
236     }
240 echo $output->footer();