Merge branch 'w05_MDL-26196_20_tags' of git://github.com/skodak/moodle
[moodle.git] / course / togglecompletion.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Toggles the manual completion flag for a particular activity or course completion
20  * and the current user.
21  *
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package course
24  */
26 require_once('../config.php');
27 require_once($CFG->libdir.'/completionlib.php');
29 // Parameters
30 $cmid = optional_param('id', 0, PARAM_INT);
31 $courseid = optional_param('course', 0, PARAM_INT);
32 $confirm = optional_param('confirm', 0, PARAM_BOOL);
34 if (!$cmid && !$courseid) {
35     print_error('invalidarguments');
36 }
38 // Process self completion
39 if ($courseid) {
40     $PAGE->set_url(new moodle_url('/course/togglecompletion.php', array('course'=>$courseid)));
41     
42     // Check user is logged in
43     $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
44     require_login($course);
46     $completion = new completion_info($course);
48     // Check if we are marking a user complete via the completion report
49     $user = optional_param('user', 0, PARAM_INT);
50     $rolec = optional_param('rolec', 0, PARAM_INT);
52     if ($user && $rolec) {
54         $criteria = completion_criteria::factory((object) array('id'=>$rolec, 'criteriatype'=>COMPLETION_CRITERIA_TYPE_ROLE));
55         $criteria_completions = $completion->get_completions($user, COMPLETION_CRITERIA_TYPE_ROLE);
57         foreach ($criteria_completions as $criteria_completion) {
58             if ($criteria_completion->criteriaid == $rolec) {
59                 $criteria->complete($criteria_completion);
60                 break;
61             }
62         }
64         // Return to previous page
65         if (!empty($_SERVER['HTTP_REFERER'])) {
66             redirect($_SERVER['HTTP_REFERER']);
67         } else {
68             redirect('view.php?id='.$course->id);
69         }
71     } else {
73         // Confirm with user
74         if ($confirm) {
75             $completion = $completion->get_completion($USER->id, COMPLETION_CRITERIA_TYPE_SELF);
77             if (!$completion) {
78                 print_error('noselfcompletioncriteria', 'completion');
79             }
81             // Check if the user has already marked themselves as complete
82             if ($completion->is_complete()) {
83                 print_error('useralreadymarkedcomplete', 'completion');
84             }
86             $completion->mark_complete();
88             redirect($CFG->wwwroot.'/course/view.php?id='.$courseid);
89             return;
90         }
92         $strconfirm = get_string('confirmselfcompletion', 'completion');
93         $PAGE->set_title($strconfirm);
94         $PAGE->set_heading($course->fullname);
95         $PAGE->navbar->add($strconfirm);
96         echo $OUTPUT->header();
97         $buttoncontinue = new single_button(new moodle_url('/course/togglecompletion.php', array('course'=>$courseid, 'confirm'=>1)), get_string('yes'), 'post');
98         $buttoncancel   = new single_button(new moodle_url('/course/view.php', array('id'=>$courseid)), get_string('no'), 'get');
99         echo $OUTPUT->confirm($strconfirm, $buttoncontinue, $buttoncancel);
100         echo $OUTPUT->footer();
101         exit;
102     }
106 $targetstate = required_param('completionstate', PARAM_INT);
107 $fromajax    = optional_param('fromajax', 0, PARAM_INT);
109 $PAGE->set_url('/course/togglecompletion.php', array('id'=>$cmid, 'completionstate'=>$targetstate));
111 switch($targetstate) {
112     case COMPLETION_COMPLETE:
113     case COMPLETION_INCOMPLETE:
114         break;
115     default:
116         print_error('unsupportedstate');
119 // Get course-modules entry
120 $cm = get_coursemodule_from_id(null, $cmid, null, false, MUST_EXIST);
121 $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
123 // Check user is logged in
124 require_login($course, false, $cm);
126 if (isguestuser() or !confirm_sesskey()) {
127     print_error('error');
130 // Now change state
131 $completion = new completion_info($course);
132 if (!$completion->is_enabled()) {
133     die;
136 // Check completion state is manual
137 if($cm->completion != COMPLETION_TRACKING_MANUAL) {
138     error_or_ajax('cannotmanualctrack', $fromajax);
141 $completion->update_state($cm, $targetstate);
143 // And redirect back to course
144 if ($fromajax) {
145     print 'OK';
146 } else {
147     // In case of use in other areas of code we allow a 'backto' parameter,
148     // otherwise go back to course page
149     $backto = optional_param('backto', 'view.php?id='.$course->id, PARAM_URL);
150     redirect($backto);
153 // utility functions
155 function error_or_ajax($message, $fromajax) {
156     if ($fromajax) {
157         print get_string($message, 'error');
158         exit;
159     } else {
160         print_error($message);
161     }