Merge branch 'MDL-31510_group_activities' of git://github.com/andyjdavis/moodle
[moodle.git] / mod / feedback / complete.php
blob7fee6412d83337de067044091e5770beabe12a6f
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.
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 * prints the form so the user can fill out the feedback
20 * @author Andreas Grabs
21 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
22 * @package feedback
25 require_once("../../config.php");
26 require_once("lib.php");
27 require_once($CFG->libdir . '/completionlib.php');
29 feedback_init_feedback_session();
31 $id = required_param('id', PARAM_INT);
32 $completedid = optional_param('completedid', false, PARAM_INT);
33 $preservevalues = optional_param('preservevalues', 0, PARAM_INT);
34 $courseid = optional_param('courseid', false, PARAM_INT);
35 $gopage = optional_param('gopage', -1, PARAM_INT);
36 $lastpage = optional_param('lastpage', false, PARAM_INT);
37 $startitempos = optional_param('startitempos', 0, PARAM_INT);
38 $lastitempos = optional_param('lastitempos', 0, PARAM_INT);
39 $anonymous_response = optional_param('anonymous_response', 0, PARAM_INT); //arb
41 $highlightrequired = false;
43 if (($formdata = data_submitted()) AND !confirm_sesskey()) {
44 print_error('invalidsesskey');
47 //if the use hit enter into a textfield so the form should not submit
48 if (isset($formdata->sesskey) AND
49 !isset($formdata->savevalues) AND
50 !isset($formdata->gonextpage) AND
51 !isset($formdata->gopreviouspage)) {
53 $gopage = $formdata->lastpage;
56 if (isset($formdata->savevalues)) {
57 $savevalues = true;
58 } else {
59 $savevalues = false;
62 if ($gopage < 0 AND !$savevalues) {
63 if (isset($formdata->gonextpage)) {
64 $gopage = $lastpage + 1;
65 $gonextpage = true;
66 $gopreviouspage = false;
67 } else if (isset($formdata->gopreviouspage)) {
68 $gopage = $lastpage - 1;
69 $gonextpage = false;
70 $gopreviouspage = true;
71 } else {
72 print_error('missingparameter');
74 } else {
75 $gonextpage = $gopreviouspage = false;
78 if (! $cm = get_coursemodule_from_id('feedback', $id)) {
79 print_error('invalidcoursemodule');
82 if (! $course = $DB->get_record("course", array("id"=>$cm->course))) {
83 print_error('coursemisconf');
86 if (! $feedback = $DB->get_record("feedback", array("id"=>$cm->instance))) {
87 print_error('invalidcoursemodule');
90 if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
91 print_error('badcontext');
94 $feedback_complete_cap = false;
96 if (has_capability('mod/feedback:complete', $context)) {
97 $feedback_complete_cap = true;
100 //check whether the feedback is located and! started from the mainsite
101 if ($course->id == SITEID AND !$courseid) {
102 $courseid = SITEID;
105 //check whether the feedback is mapped to the given courseid
106 if ($course->id == SITEID AND !has_capability('mod/feedback:edititems', $context)) {
107 if ($DB->get_records('feedback_sitecourse_map', array('feedbackid'=>$feedback->id))) {
108 $params = array('feedbackid'=>$feedback->id, 'courseid'=>$courseid);
109 if (!$DB->get_record('feedback_sitecourse_map', $params)) {
110 print_error('notavailable', 'feedback');
115 if ($feedback->anonymous != FEEDBACK_ANONYMOUS_YES) {
116 if ($course->id == SITEID) {
117 require_login($course, true);
118 } else {
119 require_login($course, true, $cm);
121 } else {
122 if ($course->id == SITEID) {
123 require_course_login($course, true);
124 } else {
125 require_course_login($course, true, $cm);
129 //check whether the given courseid exists
130 if ($courseid AND $courseid != SITEID) {
131 if ($course2 = $DB->get_record('course', array('id'=>$courseid))) {
132 require_course_login($course2); //this overwrites the object $course :-(
133 $course = $DB->get_record("course", array("id"=>$cm->course)); // the workaround
134 } else {
135 print_error('invalidcourseid');
139 if (!$feedback_complete_cap) {
140 print_error('error');
143 // Mark activity viewed for completion-tracking
144 $completion = new completion_info($course);
145 $completion->set_module_viewed($cm);
147 /// Print the page header
148 $strfeedbacks = get_string("modulenameplural", "feedback");
149 $strfeedback = get_string("modulename", "feedback");
151 if ($course->id == SITEID) {
152 $PAGE->set_cm($cm, $course); // set's up global $COURSE
153 $PAGE->set_pagelayout('incourse');
156 $PAGE->navbar->add(get_string('feedback:complete', 'feedback'));
157 $urlparams = array('id'=>$cm->id, 'gopage'=>$gopage, 'courseid'=>$course->id);
158 $PAGE->set_url('/mod/feedback/complete.php', $urlparams);
159 $PAGE->set_heading(format_string($course->fullname));
160 $PAGE->set_title(format_string($feedback->name));
161 echo $OUTPUT->header();
163 //ishidden check.
164 //feedback in courses
165 if ((empty($cm->visible) AND
166 !has_capability('moodle/course:viewhiddenactivities', $context)) AND
167 $course->id != SITEID) {
168 notice(get_string("activityiscurrentlyhidden"));
171 //ishidden check.
172 //feedback on mainsite
173 if ((empty($cm->visible) AND
174 !has_capability('moodle/course:viewhiddenactivities', $context)) AND
175 $courseid == SITEID) {
176 notice(get_string("activityiscurrentlyhidden"));
179 //check, if the feedback is open (timeopen, timeclose)
180 $checktime = time();
181 $feedback_is_closed = ($feedback->timeopen > $checktime) OR
182 ($feedback->timeclose < $checktime AND
183 $feedback->timeclose > 0);
185 if ($feedback_is_closed) {
186 echo $OUTPUT->box_start('generalbox boxaligncenter');
187 echo '<h2><font color="red">';
188 echo get_string('feedback_is_not_open', 'feedback');
189 echo '</font></h2>';
190 echo $OUTPUT->continue_button($CFG->wwwroot.'/course/view.php?id='.$course->id);
191 echo $OUTPUT->box_end();
192 echo $OUTPUT->footer();
193 exit;
196 //additional check for multiple-submit (prevent browsers back-button).
197 //the main-check is in view.php
198 $feedback_can_submit = true;
199 if ($feedback->multiple_submit == 0 ) {
200 if (feedback_is_already_submitted($feedback->id, $courseid)) {
201 $feedback_can_submit = false;
204 if ($feedback_can_submit) {
205 //preserving the items
206 if ($preservevalues == 1) {
207 if (!isset($SESSION->feedback->is_started) OR !$SESSION->feedback->is_started == true) {
208 print_error('error', '', $CFG->wwwroot.'/course/view.php?id='.$course->id);
210 //checken, ob alle required items einen wert haben
211 if (feedback_check_values($startitempos, $lastitempos)) {
212 $userid = $USER->id; //arb
213 if ($completedid = feedback_save_values($USER->id, true)) {
214 if ($userid > 0) {
215 add_to_log($course->id,
216 'feedback',
217 'startcomplete',
218 'view.php?id='.$cm->id,
219 $feedback->id,
220 $cm->id,
221 $userid);
223 if (!$gonextpage AND !$gopreviouspage) {
224 $preservevalues = false;//es kann gespeichert werden
227 } else {
228 $savereturn = 'failed';
229 if (isset($lastpage)) {
230 $gopage = $lastpage;
231 } else {
232 print_error('missingparameter');
235 } else {
236 $savereturn = 'missing';
237 $highlightrequired = true;
238 if (isset($lastpage)) {
239 $gopage = $lastpage;
240 } else {
241 print_error('missingparameter');
247 //saving the items
248 if ($savevalues AND !$preservevalues) {
249 //exists there any pagebreak, so there are values in the feedback_valuetmp
250 $userid = $USER->id; //arb
252 if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO) {
253 $feedbackcompleted = feedback_get_current_completed($feedback->id, false, $courseid);
254 } else {
255 $feedbackcompleted = false;
257 $params = array('id' => $completedid);
258 $feedbackcompletedtmp = $DB->get_record('feedback_completedtmp', $params);
259 //fake saving for switchrole
260 $is_switchrole = feedback_check_is_switchrole();
261 if ($is_switchrole) {
262 $savereturn = 'saved';
263 feedback_delete_completedtmp($completedid);
264 } else {
265 $new_completed_id = feedback_save_tmp_values($feedbackcompletedtmp,
266 $feedbackcompleted,
267 $userid);
268 if ($new_completed_id) {
269 $savereturn = 'saved';
270 if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO) {
271 add_to_log($course->id,
272 'feedback',
273 'submit',
274 'view.php?id='.$cm->id,
275 $feedback->id,
276 $cm->id,
277 $userid);
279 feedback_send_email($cm, $feedback, $course, $userid);
280 } else {
281 feedback_send_email_anonym($cm, $feedback, $course, $userid);
283 //tracking the submit
284 $tracking = new stdClass();
285 $tracking->userid = $USER->id;
286 $tracking->feedback = $feedback->id;
287 $tracking->completed = $new_completed_id;
288 $DB->insert_record('feedback_tracking', $tracking);
289 unset($SESSION->feedback->is_started);
291 // Update completion state
292 $completion = new completion_info($course);
293 if ($completion->is_enabled($cm) && $feedback->completionsubmit) {
294 $completion->update_state($cm, COMPLETION_COMPLETE);
297 } else {
298 $savereturn = 'failed';
305 if ($allbreaks = feedback_get_all_break_positions($feedback->id)) {
306 if ($gopage <= 0) {
307 $startposition = 0;
308 } else {
309 if (!isset($allbreaks[$gopage - 1])) {
310 $gopage = count($allbreaks);
312 $startposition = $allbreaks[$gopage - 1];
314 $ispagebreak = true;
315 } else {
316 $startposition = 0;
317 $newpage = 0;
318 $ispagebreak = false;
321 //get the feedbackitems after the last shown pagebreak
322 $select = 'feedback = ? AND position > ?';
323 $params = array($feedback->id, $startposition);
324 $feedbackitems = $DB->get_records_select('feedback_item', $select, $params, 'position');
326 //get the first pagebreak
327 $params = array('feedback' => $feedback->id, 'typ' => 'pagebreak');
328 if ($pagebreaks = $DB->get_records('feedback_item', $params, 'position')) {
329 $pagebreaks = array_values($pagebreaks);
330 $firstpagebreak = $pagebreaks[0];
331 } else {
332 $firstpagebreak = false;
334 $maxitemcount = $DB->count_records('feedback_item', array('feedback'=>$feedback->id));
336 //get the values of completeds before done. Anonymous user can not get these values.
337 if ((!isset($SESSION->feedback->is_started)) AND
338 (!isset($savereturn)) AND
339 ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO)) {
341 $feedbackcompletedtmp = feedback_get_current_completed($feedback->id, true, $courseid);
342 if (!$feedbackcompletedtmp) {
343 $feedbackcompleted = feedback_get_current_completed($feedback->id, false, $courseid);
344 if ($feedbackcompleted) {
345 //copy the values to feedback_valuetmp create a completedtmp
346 $feedbackcompletedtmp = feedback_set_tmp_values($feedbackcompleted);
349 } else {
350 $feedbackcompletedtmp = feedback_get_current_completed($feedback->id, true, $courseid);
353 /// Print the main part of the page
354 ///////////////////////////////////////////////////////////////////////////
355 ///////////////////////////////////////////////////////////////////////////
356 ///////////////////////////////////////////////////////////////////////////
357 $analysisurl = new moodle_url('/mod/feedback/analysis.php', array('id'=>$id));
358 if ($courseid > 0) {
359 $analysisurl->param('courseid', $courseid);
361 echo $OUTPUT->heading(format_text($feedback->name));
363 if ( (intval($feedback->publish_stats) == 1) AND
364 ( has_capability('mod/feedback:viewanalysepage', $context)) AND
365 !( has_capability('mod/feedback:viewreports', $context)) ) {
367 $params = array('userid' => $USER->id, 'feedback' => $feedback->id);
368 if ($multiple_count = $DB->count_records('feedback_tracking', $params)) {
369 echo $OUTPUT->box_start('mdl-align');
370 echo '<a href="'.$analysisurl->out().'">';
371 echo get_string('completed_feedbacks', 'feedback').'</a>';
372 echo $OUTPUT->box_end();
376 if (isset($savereturn) && $savereturn == 'saved') {
377 if ($feedback->page_after_submit) {
379 require_once($CFG->libdir . '/filelib.php');
381 $page_after_submit_output = file_rewrite_pluginfile_urls($feedback->page_after_submit,
382 'pluginfile.php',
383 $context->id,
384 'mod_feedback',
385 'page_after_submit',
388 echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
389 echo format_text($page_after_submit_output,
390 $feedback->page_after_submitformat,
391 array('overflowdiv' => true));
392 echo $OUTPUT->box_end();
393 } else {
394 echo '<p align="center">';
395 echo '<b><font color="green">';
396 echo get_string('entries_saved', 'feedback');
397 echo '</font></b>';
398 echo '</p>';
399 if ( intval($feedback->publish_stats) == 1) {
400 echo '<p align="center"><a href="'.$analysisurl->out().'">';
401 echo get_string('completed_feedbacks', 'feedback').'</a>';
402 echo '</p>';
406 if ($feedback->site_after_submit) {
407 $url = feedback_encode_target_url($feedback->site_after_submit);
408 } else {
409 if ($courseid) {
410 if ($courseid == SITEID) {
411 $url = $CFG->wwwroot;
412 } else {
413 $url = $CFG->wwwroot.'/course/view.php?id='.$courseid;
415 } else {
416 if ($course->id == SITEID) {
417 $url = $CFG->wwwroot;
418 } else {
419 $url = $CFG->wwwroot.'/course/view.php?id='.$course->id;
423 echo $OUTPUT->continue_button($url);
424 } else {
425 if (isset($savereturn) && $savereturn == 'failed') {
426 echo $OUTPUT->box_start('mform error');
427 echo get_string('saving_failed', 'feedback');
428 echo $OUTPUT->box_end();
431 if (isset($savereturn) && $savereturn == 'missing') {
432 echo $OUTPUT->box_start('mform error');
433 echo get_string('saving_failed_because_missing_or_false_values', 'feedback');
434 echo $OUTPUT->box_end();
437 //print the items
438 if (is_array($feedbackitems)) {
439 echo $OUTPUT->box_start('feedback_form');
440 echo '<form action="complete.php" method="post" onsubmit=" ">';
441 echo '<fieldset>';
442 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
443 echo $OUTPUT->box_start('feedback_anonymousinfo');
444 switch ($feedback->anonymous) {
445 case FEEDBACK_ANONYMOUS_YES:
446 echo '<input type="hidden" name="anonymous" value="1" />';
447 $inputvalue = 'value="'.FEEDBACK_ANONYMOUS_YES.'"';
448 echo '<input type="hidden" name="anonymous_response" '.$inputvalue.' />';
449 echo get_string('mode', 'feedback').': '.get_string('anonymous', 'feedback');
450 break;
451 case FEEDBACK_ANONYMOUS_NO:
452 echo '<input type="hidden" name="anonymous" value="0" />';
453 $inputvalue = 'value="'.FEEDBACK_ANONYMOUS_NO.'"';
454 echo '<input type="hidden" name="anonymous_response" '.$inputvalue.' />';
455 echo get_string('mode', 'feedback').': ';
456 echo get_string('non_anonymous', 'feedback');
457 break;
459 echo $OUTPUT->box_end();
460 //check, if there exists required-elements
461 $params = array('feedback' => $feedback->id, 'required' => 1);
462 $countreq = $DB->count_records('feedback_item', $params);
463 if ($countreq > 0) {
464 echo '<span class="feedback_required_mark">(*)';
465 echo get_string('items_are_required', 'feedback');
466 echo '</span>';
468 echo $OUTPUT->box_start('feedback_items');
470 unset($startitem);
471 $select = 'feedback = ? AND hasvalue = 1 AND position < ?';
472 $params = array($feedback->id, $startposition);
473 $itemnr = $DB->count_records_select('feedback_item', $select, $params);
474 $lastbreakposition = 0;
475 $align = right_to_left() ? 'right' : 'left';
477 foreach ($feedbackitems as $feedbackitem) {
478 if (!isset($startitem)) {
479 //avoid showing double pagebreaks
480 if ($feedbackitem->typ == 'pagebreak') {
481 continue;
483 $startitem = $feedbackitem;
486 if ($feedbackitem->dependitem > 0) {
487 //chech if the conditions are ok
488 $fb_compare_value = feedback_compare_item_value($feedbackcompletedtmp->id,
489 $feedbackitem->dependitem,
490 $feedbackitem->dependvalue,
491 true);
492 if (!isset($feedbackcompletedtmp->id) OR !$fb_compare_value) {
493 $lastitem = $feedbackitem;
494 $lastbreakposition = $feedbackitem->position;
495 continue;
499 if ($feedbackitem->dependitem > 0) {
500 $dependstyle = ' feedback_complete_depend';
501 } else {
502 $dependstyle = '';
505 echo $OUTPUT->box_start('feedback_item_box_'.$align.$dependstyle);
506 $value = '';
507 //get the value
508 $frmvaluename = $feedbackitem->typ . '_'. $feedbackitem->id;
509 if (isset($savereturn)) {
510 if (isset($formdata->{$frmvaluename})) {
511 $value = $formdata->{$frmvaluename};
512 } else {
513 $value = null;
515 } else {
516 if (isset($feedbackcompletedtmp->id)) {
517 $value = feedback_get_item_value($feedbackcompletedtmp->id,
518 $feedbackitem->id,
519 true);
522 if ($feedbackitem->hasvalue == 1 AND $feedback->autonumbering) {
523 $itemnr++;
524 echo $OUTPUT->box_start('feedback_item_number_'.$align);
525 echo $itemnr;
526 echo $OUTPUT->box_end();
528 if ($feedbackitem->typ != 'pagebreak') {
529 echo $OUTPUT->box_start('box generalbox boxalign_'.$align);
530 feedback_print_item_complete($feedbackitem, $value, $highlightrequired);
531 echo $OUTPUT->box_end();
533 echo $OUTPUT->box_end();
535 $lastbreakposition = $feedbackitem->position; //last item-pos (item or pagebreak)
536 if ($feedbackitem->typ == 'pagebreak') {
537 break;
538 } else {
539 $lastitem = $feedbackitem;
542 echo $OUTPUT->box_end();
543 echo '<input type="hidden" name="id" value="'.$id.'" />';
544 echo '<input type="hidden" name="feedbackid" value="'.$feedback->id.'" />';
545 echo '<input type="hidden" name="lastpage" value="'.$gopage.'" />';
546 if (isset($feedbackcompletedtmp->id)) {
547 $inputvalue = 'value="'.$feedbackcompletedtmp->id.'"';
548 } else {
549 $inputvalue = 'value=""';
551 echo '<input type="hidden" name="completedid" '.$inputvalue.' />';
552 echo '<input type="hidden" name="courseid" value="'. $courseid . '" />';
553 echo '<input type="hidden" name="preservevalues" value="1" />';
554 if (isset($startitem)) {
555 echo '<input type="hidden" name="startitempos" value="'.$startitem->position.'" />';
556 echo '<input type="hidden" name="lastitempos" value="'.$lastitem->position.'" />';
559 if ( $ispagebreak AND $lastbreakposition > $firstpagebreak->position) {
560 $inputvalue = 'value="'.get_string('previous_page', 'feedback').'"';
561 echo '<input name="gopreviouspage" type="submit" '.$inputvalue.' />';
563 if ($lastbreakposition < $maxitemcount) {
564 $inputvalue = 'value="'.get_string('next_page', 'feedback').'"';
565 echo '<input name="gonextpage" type="submit" '.$inputvalue.' />';
567 if ($lastbreakposition >= $maxitemcount) { //last page
568 $inputvalue = 'value="'.get_string('save_entries', 'feedback').'"';
569 echo '<input name="savevalues" type="submit" '.$inputvalue.' />';
572 echo '</fieldset>';
573 echo '</form>';
574 echo $OUTPUT->box_end();
576 echo $OUTPUT->box_start('feedback_complete_cancel');
577 if ($courseid) {
578 $action = 'action="'.$CFG->wwwroot.'/course/view.php?id='.$courseid.'"';
579 } else {
580 if ($course->id == SITEID) {
581 $action = 'action="'.$CFG->wwwroot.'"';
582 } else {
583 $action = 'action="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'"';
586 echo '<form '.$action.' method="post" onsubmit=" ">';
587 echo '<fieldset>';
588 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
589 echo '<input type="hidden" name="courseid" value="'. $courseid . '" />';
590 echo '<button type="submit">'.get_string('cancel').'</button>';
591 echo '</fieldset>';
592 echo '</form>';
593 echo $OUTPUT->box_end();
594 $SESSION->feedback->is_started = true;
597 } else {
598 echo $OUTPUT->box_start('generalbox boxaligncenter');
599 echo '<h2>';
600 echo '<font color="red">';
601 echo get_string('this_feedback_is_already_submitted', 'feedback');
602 echo '</font>';
603 echo '</h2>';
604 echo $OUTPUT->continue_button($CFG->wwwroot.'/course/view.php?id='.$course->id);
605 echo $OUTPUT->box_end();
607 /// Finish the page
608 ///////////////////////////////////////////////////////////////////////////
609 ///////////////////////////////////////////////////////////////////////////
610 ///////////////////////////////////////////////////////////////////////////
612 echo $OUTPUT->footer();