mod/feedback/complete.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  * prints the form so the user can fill out the feedback
  19  *
  20  * @author Andreas Grabs
  21  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  22  * @package mod_feedback
  23  */
  24
  25 require_once("../../config.php");
  26 require_once("lib.php");
  27 require_once($CFG->libdir . '/completionlib.php');
  28
  29 feedback_init_feedback_session();
  30
  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
  40
  41 $highlightrequired = false;
  42
  43 if (($formdata = data_submitted()) AND !confirm_sesskey()) {
  44     print_error('invalidsesskey');
  45 }
  46
  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)) {
  52
  53     $gopage = $formdata->lastpage;
  54 }
  55
  56 if (isset($formdata->savevalues)) {
  57     $savevalues = true;
  58 } else {
  59     $savevalues = false;
  60 }
  61
  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');
  73     }
  74 } else {
  75     $gonextpage = $gopreviouspage = false;
  76 }
  77
  78 list($course, $cm) = get_course_and_cm_from_cmid($id, 'feedback');
  79 $feedback = $DB->get_record("feedback", array("id" => $cm->instance), '*', MUST_EXIST);
  80
  81 $context = context_module::instance($cm->id);
  82
  83 $feedback_complete_cap = false;
  84
  85 if (has_capability('mod/feedback:complete', $context)) {
  86     $feedback_complete_cap = true;
  87 }
  88
  89 if (!empty($CFG->feedback_allowfullanonymous)
  90         AND $course->id == SITEID
  91         AND $feedback->anonymous == FEEDBACK_ANONYMOUS_YES
  92         AND (!isloggedin() OR isguestuser())) {
  93     // Guests are allowed to complete fully anonymous feedback without having 'mod/feedback:complete' capability.
  94     $feedback_complete_cap = true;
  95 }
  96
  97 //check whether the feedback is located and! started from the mainsite
  98 if ($course->id == SITEID AND !$courseid) {
  99     $courseid = SITEID;
 100 }
 101
 102 //check whether the feedback is mapped to the given courseid
 103 if ($course->id == SITEID AND !has_capability('mod/feedback:edititems', $context)) {
 104     if ($DB->get_records('feedback_sitecourse_map', array('feedbackid'=>$feedback->id))) {
 105         $params = array('feedbackid'=>$feedback->id, 'courseid'=>$courseid);
 106         if (!$DB->get_record('feedback_sitecourse_map', $params)) {
 107             print_error('notavailable', 'feedback');
 108         }
 109     }
 110 }
 111
 112 require_course_login($course, true, $cm);
 113 $PAGE->set_activity_record($feedback);
 114
 115 //check whether the given courseid exists
 116 if ($courseid AND $courseid != SITEID) {
 117     if ($course2 = $DB->get_record('course', array('id'=>$courseid))) {
 118         require_course_login($course2); //this overwrites the object $course :-(
 119         $course = $DB->get_record("course", array("id"=>$cm->course)); // the workaround
 120     } else {
 121         print_error('invalidcourseid');
 122     }
 123 }
 124
 125 if (!$feedback_complete_cap) {
 126     print_error('error');
 127 }
 128
 129 // Mark activity viewed for completion-tracking
 130 $completion = new completion_info($course);
 131 if (isloggedin() && !isguestuser()) {
 132     $completion->set_module_viewed($cm);
 133 }
 134
 135 /// Print the page header
 136 $strfeedbacks = get_string("modulenameplural", "feedback");
 137 $strfeedback  = get_string("modulename", "feedback");
 138
 139 if ($course->id == SITEID) {
 140     $PAGE->set_cm($cm, $course); // set's up global $COURSE
 141     $PAGE->set_pagelayout('incourse');
 142 }
 143
 144 $PAGE->navbar->add(get_string('feedback:complete', 'feedback'));
 145 $urlparams = array('id'=>$cm->id, 'gopage'=>$gopage, 'courseid'=>$course->id);
 146 $PAGE->set_url('/mod/feedback/complete.php', $urlparams);
 147 $PAGE->set_heading($course->fullname);
 148 $PAGE->set_title($feedback->name);
 149 echo $OUTPUT->header();
 150
 151 //check, if the feedback is open (timeopen, timeclose)
 152 $checktime = time();
 153 $feedback_is_closed = ($feedback->timeopen > $checktime) ||
 154                       ($feedback->timeclose < $checktime &&
 155                             $feedback->timeclose > 0);
 156
 157 if ($feedback_is_closed) {
 158     echo $OUTPUT->heading(format_string($feedback->name));
 159     echo $OUTPUT->box_start('generalbox boxaligncenter');
 160     echo $OUTPUT->notification(get_string('feedback_is_not_open', 'feedback'));
 161     echo $OUTPUT->continue_button($CFG->wwwroot.'/course/view.php?id='.$course->id);
 162     echo $OUTPUT->box_end();
 163     echo $OUTPUT->footer();
 164     exit;
 165 }
 166
 167 //additional check for multiple-submit (prevent browsers back-button).
 168 //the main-check is in view.php
 169 $feedback_can_submit = true;
 170 if ($feedback->multiple_submit == 0 ) {
 171     if (feedback_is_already_submitted($feedback->id, $courseid)) {
 172         $feedback_can_submit = false;
 173     }
 174 }
 175 if ($feedback_can_submit) {
 176     //preserving the items
 177     if ($preservevalues == 1) {
 178         if (!isset($SESSION->feedback->is_started) OR !$SESSION->feedback->is_started == true) {
 179             print_error('error', '', $CFG->wwwroot.'/course/view.php?id='.$course->id);
 180         }
 181         // Check if all required items have a value.
 182         if (feedback_check_values($startitempos, $lastitempos)) {
 183             $userid = $USER->id; //arb
 184             if (isloggedin() && !isguestuser()) {
 185                 $completedid = feedback_save_values($USER->id, true);
 186             } else {
 187                 $completedid = feedback_save_guest_values(sesskey());
 188             }
 189             if ($completedid) {
 190                 if (!$gonextpage AND !$gopreviouspage) {
 191                     $preservevalues = false;// It can be stored.
 192                 }
 193
 194             } else {
 195                 $savereturn = 'failed';
 196                 if (isset($lastpage)) {
 197                     $gopage = $lastpage;
 198                 } else {
 199                     print_error('missingparameter');
 200                 }
 201             }
 202         } else {
 203             $savereturn = 'missing';
 204             $highlightrequired = true;
 205             if (isset($lastpage)) {
 206                 $gopage = $lastpage;
 207             } else {
 208                 print_error('missingparameter');
 209             }
 210
 211         }
 212     }
 213
 214     //saving the items
 215     if ($savevalues AND !$preservevalues) {
 216         //exists there any pagebreak, so there are values in the feedback_valuetmp
 217         $userid = $USER->id; //arb
 218
 219         if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO) {
 220             $feedbackcompleted = feedback_get_current_completed($feedback->id, false, $courseid);
 221         } else {
 222             $feedbackcompleted = false;
 223         }
 224         $params = array('id' => $completedid);
 225         $feedbackcompletedtmp = $DB->get_record('feedback_completedtmp', $params);
 226         //fake saving for switchrole
 227         $is_switchrole = feedback_check_is_switchrole();
 228         if ($is_switchrole) {
 229             $savereturn = 'saved';
 230             feedback_delete_completedtmp($completedid);
 231         } else {
 232             $new_completed_id = feedback_save_tmp_values($feedbackcompletedtmp,
 233                                                          $feedbackcompleted,
 234                                                          $userid);
 235             if ($new_completed_id) {
 236                 $savereturn = 'saved';
 237                 if ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO) {
 238                     feedback_send_email($cm, $feedback, $course, $userid);
 239                 } else {
 240                     feedback_send_email_anonym($cm, $feedback, $course, $userid);
 241                 }
 242                 if (isloggedin() && !isguestuser()) {
 243                     // Tracking the submit.
 244                     $tracking = new stdClass();
 245                     $tracking->userid = $USER->id;
 246                     $tracking->feedback = $feedback->id;
 247                     $tracking->completed = $new_completed_id;
 248                     $DB->insert_record('feedback_tracking', $tracking);
 249                 }
 250                 unset($SESSION->feedback->is_started);
 251
 252                 // Update completion state
 253                 $completion = new completion_info($course);
 254                 if (isloggedin() && !isguestuser() && $completion->is_enabled($cm) && $feedback->completionsubmit) {
 255                     $completion->update_state($cm, COMPLETION_COMPLETE);
 256                 }
 257
 258             } else {
 259                 $savereturn = 'failed';
 260             }
 261         }
 262
 263     }
 264
 265
 266     if ($allbreaks = feedback_get_all_break_positions($feedback->id)) {
 267         if ($gopage <= 0) {
 268             $startposition = 0;
 269         } else {
 270             if (!isset($allbreaks[$gopage - 1])) {
 271                 $gopage = count($allbreaks);
 272             }
 273             $startposition = $allbreaks[$gopage - 1];
 274         }
 275         $ispagebreak = true;
 276     } else {
 277         $startposition = 0;
 278         $newpage = 0;
 279         $ispagebreak = false;
 280     }
 281
 282     //get the feedbackitems after the last shown pagebreak
 283     $select = 'feedback = ? AND position > ?';
 284     $params = array($feedback->id, $startposition);
 285     $feedbackitems = $DB->get_records_select('feedback_item', $select, $params, 'position');
 286
 287     //get the first pagebreak
 288     $params = array('feedback' => $feedback->id, 'typ' => 'pagebreak');
 289     if ($pagebreaks = $DB->get_records('feedback_item', $params, 'position')) {
 290         $pagebreaks = array_values($pagebreaks);
 291         $firstpagebreak = $pagebreaks[0];
 292     } else {
 293         $firstpagebreak = false;
 294     }
 295     $maxitemcount = $DB->count_records('feedback_item', array('feedback'=>$feedback->id));
 296
 297     //get the values of completeds before done. Anonymous user can not get these values.
 298     if ((!isset($SESSION->feedback->is_started)) AND
 299                           (!isset($savereturn)) AND
 300                           ($feedback->anonymous == FEEDBACK_ANONYMOUS_NO)) {
 301
 302         $feedbackcompletedtmp = feedback_get_current_completed($feedback->id, true, $courseid);
 303         if (!$feedbackcompletedtmp) {
 304             $feedbackcompleted = feedback_get_current_completed($feedback->id, false, $courseid);
 305             if ($feedbackcompleted) {
 306                 //copy the values to feedback_valuetmp create a completedtmp
 307                 $feedbackcompletedtmp = feedback_set_tmp_values($feedbackcompleted);
 308             }
 309         }
 310     } else if (isloggedin() && !isguestuser()) {
 311         $feedbackcompletedtmp = feedback_get_current_completed($feedback->id, true, $courseid);
 312     } else {
 313         $feedbackcompletedtmp = feedback_get_current_completed($feedback->id, true, $courseid, sesskey());
 314     }
 315
 316     /// Print the main part of the page
 317     ///////////////////////////////////////////////////////////////////////////
 318     ///////////////////////////////////////////////////////////////////////////
 319     ///////////////////////////////////////////////////////////////////////////
 320     $analysisurl = new moodle_url('/mod/feedback/analysis.php', array('id'=>$id));
 321     if ($courseid > 0) {
 322         $analysisurl->param('courseid', $courseid);
 323     }
 324     echo $OUTPUT->heading(format_string($feedback->name));
 325
 326     if (isset($savereturn) && $savereturn == 'saved') {
 327         if ($feedback->page_after_submit) {
 328
 329             require_once($CFG->libdir . '/filelib.php');
 330
 331             $page_after_submit_output = file_rewrite_pluginfile_urls($feedback->page_after_submit,
 332                                                                     'pluginfile.php',
 333                                                                     $context->id,
 334                                                                     'mod_feedback',
 335                                                                     'page_after_submit',
 336                                                                     0);
 337
 338             echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
 339             echo format_text($page_after_submit_output,
 340                              $feedback->page_after_submitformat,
 341                              array('overflowdiv' => true));
 342             echo $OUTPUT->box_end();
 343         } else {
 344             echo '<p align="center">';
 345             echo '<b><font color="green">';
 346             echo get_string('entries_saved', 'feedback');
 347             echo '</font></b>';
 348             echo '</p>';
 349         }
 350         if (feedback_can_view_analysis($feedback, $context, $courseid)) {
 351             echo '<p align="center"><a href="'.$analysisurl->out().'">';
 352             echo get_string('completed_feedbacks', 'feedback').'</a>';
 353             echo '</p>';
 354         }
 355
 356         if ($feedback->site_after_submit) {
 357             $url = feedback_encode_target_url($feedback->site_after_submit);
 358         } else {
 359             if ($courseid) {
 360                 if ($courseid == SITEID) {
 361                     $url = $CFG->wwwroot;
 362                 } else {
 363                     $url = $CFG->wwwroot.'/course/view.php?id='.$courseid;
 364                 }
 365             } else {
 366                 if ($course->id == SITEID) {
 367                     $url = $CFG->wwwroot;
 368                 } else {
 369                     $url = $CFG->wwwroot.'/course/view.php?id='.$course->id;
 370                 }
 371             }
 372         }
 373         echo $OUTPUT->continue_button($url);
 374     } else {
 375         if (isset($savereturn) && $savereturn == 'failed') {
 376             echo $OUTPUT->box_start('mform');
 377             echo '<span class="error">'.get_string('saving_failed', 'feedback').'</span>';
 378             echo $OUTPUT->box_end();
 379         }
 380
 381         if (isset($savereturn) && $savereturn == 'missing') {
 382             echo $OUTPUT->box_start('mform');
 383             echo '<span class="error">'.get_string('saving_failed_because_missing_or_false_values', 'feedback').'</span>';
 384             echo $OUTPUT->box_end();
 385         }
 386
 387         //print the items
 388         if (is_array($feedbackitems)) {
 389             echo $OUTPUT->box_start('feedback_form');
 390             echo '<form action="complete.php" class="feedback_complete" method="post">';
 391             echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
 392             $anonymousmodeinfo = '';
 393             switch ($feedback->anonymous) {
 394                 case FEEDBACK_ANONYMOUS_YES:
 395                     echo '<input type="hidden" name="anonymous" value="1" />';
 396                     $inputvalue = 'value="'.FEEDBACK_ANONYMOUS_YES.'"';
 397                     echo '<input type="hidden" name="anonymous_response" '.$inputvalue.' />';
 398                     $anonymousmodeinfo = get_string('anonymous', 'feedback');
 399                     break;
 400                 case FEEDBACK_ANONYMOUS_NO:
 401                     echo '<input type="hidden" name="anonymous" value="0" />';
 402                     $inputvalue = 'value="'.FEEDBACK_ANONYMOUS_NO.'"';
 403                     echo '<input type="hidden" name="anonymous_response" '.$inputvalue.' />';
 404                     $anonymousmodeinfo = get_string('non_anonymous', 'feedback');
 405                     break;
 406             }
 407             if (isloggedin() && !isguestuser()) {
 408                 echo $OUTPUT->box(get_string('mode', 'feedback') . ': ' . $anonymousmodeinfo, 'feedback_anonymousinfo');
 409             }
 410             //check, if there exists required-elements
 411             $params = array('feedback' => $feedback->id, 'required' => 1);
 412             $countreq = $DB->count_records('feedback_item', $params);
 413             if ($countreq > 0) {
 414                 echo '<span class="fdescription required">';
 415                 echo get_string('somefieldsrequired', 'form', '<img alt="'.get_string('requiredelement', 'form').
 416                     '" src="'.$OUTPUT->pix_url('req') .'" class="req" />');
 417                 echo '</span>';
 418             }
 419             echo $OUTPUT->box_start('feedback_items');
 420
 421             unset($startitem);
 422             $select = 'feedback = ? AND hasvalue = 1 AND position < ?';
 423             $params = array($feedback->id, $startposition);
 424             $itemnr = $DB->count_records_select('feedback_item', $select, $params);
 425             $lastbreakposition = 0;
 426             $align = right_to_left() ? 'right' : 'left';
 427
 428             foreach ($feedbackitems as $feedbackitem) {
 429                 if (!isset($startitem)) {
 430                     //avoid showing double pagebreaks
 431                     if ($feedbackitem->typ == 'pagebreak') {
 432                         continue;
 433                     }
 434                     $startitem = $feedbackitem;
 435                 }
 436
 437                 if ($feedbackitem->dependitem > 0) {
 438                     //chech if the conditions are ok
 439                     $fb_compare_value = feedback_compare_item_value($feedbackcompletedtmp->id,
 440                                                                     $feedbackitem->dependitem,
 441                                                                     $feedbackitem->dependvalue,
 442                                                                     true);
 443                     if (!isset($feedbackcompletedtmp->id) OR !$fb_compare_value) {
 444                         $lastitem = $feedbackitem;
 445                         $lastbreakposition = $feedbackitem->position;
 446                         continue;
 447                     }
 448                 }
 449
 450                 if ($feedbackitem->dependitem > 0) {
 451                     $dependstyle = ' feedback_complete_depend';
 452                 } else {
 453                     $dependstyle = '';
 454                 }
 455
 456                 echo $OUTPUT->box_start('feedback_item_box_'.$align.$dependstyle);
 457                 $value = '';
 458                 //get the value
 459                 $frmvaluename = $feedbackitem->typ . '_'. $feedbackitem->id;
 460                 if (isset($savereturn)) {
 461                     $value = isset($formdata->{$frmvaluename}) ? $formdata->{$frmvaluename} : null;
 462                     $value = feedback_clean_input_value($feedbackitem, $value);
 463                 } else {
 464                     if (isset($feedbackcompletedtmp->id)) {
 465                         $value = feedback_get_item_value($feedbackcompletedtmp->id,
 466                                                          $feedbackitem->id,
 467                                                          true);
 468                     }
 469                 }
 470                 if ($feedbackitem->hasvalue == 1 AND $feedback->autonumbering) {
 471                     $itemnr++;
 472                     echo $OUTPUT->box_start('feedback_item_number_'.$align);
 473                     echo $itemnr;
 474                     echo $OUTPUT->box_end();
 475                 }
 476                 if ($feedbackitem->typ != 'pagebreak') {
 477                     echo $OUTPUT->box_start('box generalbox boxalign_'.$align);
 478                     feedback_print_item_complete($feedbackitem, $value, $highlightrequired);
 479                     echo $OUTPUT->box_end();
 480                 }
 481
 482                 echo $OUTPUT->box_end();
 483
 484                 $lastbreakposition = $feedbackitem->position; //last item-pos (item or pagebreak)
 485                 if ($feedbackitem->typ == 'pagebreak') {
 486                     break;
 487                 } else {
 488                     $lastitem = $feedbackitem;
 489                 }
 490             }
 491             echo $OUTPUT->box_end();
 492             echo '<input type="hidden" name="id" value="'.$id.'" />';
 493             echo '<input type="hidden" name="feedbackid" value="'.$feedback->id.'" />';
 494             echo '<input type="hidden" name="lastpage" value="'.$gopage.'" />';
 495             if (isset($feedbackcompletedtmp->id)) {
 496                 $inputvalue = 'value="'.$feedbackcompletedtmp->id.'"';
 497             } else {
 498                 $inputvalue = 'value=""';
 499             }
 500             echo '<input type="hidden" name="completedid" '.$inputvalue.' />';
 501             echo '<input type="hidden" name="courseid" value="'. $courseid . '" />';
 502             echo '<input type="hidden" name="preservevalues" value="1" />';
 503             if (isset($startitem)) {
 504                 echo '<input type="hidden" name="startitempos" value="'.$startitem->position.'" />';
 505                 echo '<input type="hidden" name="lastitempos" value="'.$lastitem->position.'" />';
 506             }
 507
 508             if ( $ispagebreak AND $lastbreakposition > $firstpagebreak->position) {
 509                 $inputvalue = 'value="'.get_string('previous_page', 'feedback').'"';
 510                 echo '<input name="gopreviouspage" type="submit" '.$inputvalue.' />';
 511             }
 512             if ($lastbreakposition < $maxitemcount) {
 513                 $inputvalue = 'value="'.get_string('next_page', 'feedback').'"';
 514                 echo '<input name="gonextpage" type="submit" '.$inputvalue.' />';
 515             }
 516             if ($lastbreakposition >= $maxitemcount) { //last page
 517                 $inputvalue = 'value="'.get_string('save_entries', 'feedback').'"';
 518                 echo '<input name="savevalues" type="submit" '.$inputvalue.' />';
 519             }
 520
 521             echo '</form>';
 522             echo $OUTPUT->box_end();
 523
 524             echo $OUTPUT->box_start('feedback_complete_cancel');
 525             if ($courseid) {
 526                 $action = 'action="'.$CFG->wwwroot.'/course/view.php?id='.$courseid.'"';
 527             } else {
 528                 if ($course->id == SITEID) {
 529                     $action = 'action="'.$CFG->wwwroot.'"';
 530                 } else {
 531                     $action = 'action="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'"';
 532                 }
 533             }
 534             echo '<form '.$action.' method="post" onsubmit=" ">';
 535             echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
 536             echo '<input type="hidden" name="courseid" value="'. $courseid . '" />';
 537             echo '<button type="submit">'.get_string('cancel').'</button>';
 538             echo '</form>';
 539             echo $OUTPUT->box_end();
 540             $SESSION->feedback->is_started = true;
 541         }
 542     }
 543 } else {
 544     echo $OUTPUT->heading(format_string($feedback->name));
 545     echo $OUTPUT->box_start('generalbox boxaligncenter');
 546     echo $OUTPUT->notification(get_string('this_feedback_is_already_submitted', 'feedback'));
 547     echo $OUTPUT->continue_button($CFG->wwwroot.'/course/view.php?id='.$course->id);
 548     echo $OUTPUT->box_end();
 549 }
 550 /// Finish the page
 551 ///////////////////////////////////////////////////////////////////////////
 552 ///////////////////////////////////////////////////////////////////////////
 553 ///////////////////////////////////////////////////////////////////////////
 554
 555 echo $OUTPUT->footer();