mod/workshop/submissions.php

   1 <?php  // $Id$
   2
   3 /*************************************************
   4     ACTIONS handled are:
   5
   6     adminamendtitle
   7     confirmdelete
   8     delete
   9     adminlist
  10     editsubmission
  11     listallsubmissions
  12     listforassessmentstudent
  13     listforassessmentteacher
  14     showsubmission
  15     updatesubmission
  16
  17
  18 ************************************************/
  19
  20     require("../../config.php");
  21     require("lib.php");
  22     require("locallib.php");
  23
  24     $id          = required_param('id', PARAM_INT);    // Course Module ID
  25     $action      = optional_param('action', '', PARAM_ALPHA);
  26     $sid         = optional_param('sid', 0, PARAM_INT); //submission id
  27     $order       = optional_param('order', 'name', PARAM_ALPHA);
  28     $title       = optional_param('title', '', PARAM_CLEAN);
  29     $nentries    = optional_param('nentries', '', PARAM_ALPHANUM);
  30     $anonymous   = optional_param('anonymous', '', PARAM_CLEAN);
  31     $description = optional_param('description', '', PARAM_CLEAN);
  32
  33     $timenow = time();
  34
  35     // get some useful stuff...
  36     if (! $cm = get_coursemodule_from_id('workshop', $id)) {
  37         error("Course Module ID was incorrect");
  38     }
  39     if (! $course = get_record("course", "id", $cm->course)) {
  40         error("Course is misconfigured");
  41     }
  42     if (! $workshop = get_record("workshop", "id", $cm->instance)) {
  43         error("Course module is incorrect");
  44     }
  45
  46     require_login($course->id, false, $cm);
  47     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
  48
  49     $strworkshops = get_string("modulenameplural", "workshop");
  50     $strworkshop  = get_string("modulename", "workshop");
  51     $strsubmissions = get_string("submissions", "workshop");
  52
  53     // ... print the header and...
  54     $navigation = build_navigation($strsubmissions, $cm);
  55     print_header_simple(format_string($workshop->name), "", $navigation,
  56                   "", "", true);
  57
  58     //...get the action or set up an suitable default
  59     if (empty($action)) {
  60         $action = "listallsubmissions";
  61     }
  62
  63
  64 /******************* admin amend title ************************************/
  65     elseif ($action == 'adminamendtitle' ) {
  66
  67         require_capability('mod/workshop:manage', $context);
  68         if (empty($sid)) {
  69             error("Admin Amend Title: submission id missing");
  70         }
  71
  72         $submission = get_record("workshop_submissions", "id", $sid);
  73         print_heading(get_string("amendtitle", "workshop"));
  74         ?>
  75         <form id="amendtitleform" action="submissions.php" method="post">
  76         <fieldset class="invisiblefieldset">
  77         <input type="hidden" name="action" value="adminupdatetitle" />
  78         <input type="hidden" name="id" value="<?php echo $cm->id ?>" />
  79         <input type="hidden" name="sid" value="<?php echo $sid ?>" />
  80         <div class="boxaligncenter">
  81         <table cellpadding="5" border="1">
  82         <?php
  83
  84         // now get the comment
  85         echo "<tr valign=\"top\">\n";
  86         echo "  <td align=\"right\"><p><b>". get_string("title", "workshop").":</b></p></td>\n";
  87         echo "  <td>\n";
  88         echo "      <input type=\"text\" name=\"title\" size=\"60\" maxlength=\"100\" value=\"$submission->title\" />\n";
  89         echo "  </td></tr></table>\n";
  90         echo "<input type=\"submit\" value=\"".get_string("amendtitle", "workshop")."\" />\n";
  91         echo "</div></fieldset></form>\n";
  92
  93         print_heading("<a $CFG->frametarget href=\"view.php?id=$cm->id#sid=$submission->id\">".get_string("cancel")."</a>");
  94     }
  95
  96
  97     /******************* admin clear late (flag) ************************************/
  98     elseif ($action == 'adminclearlate' ) {
  99
 100         require_capability('mod/workshop:manage', $context);
 101         if (empty($sid)) {
 102             error("Admin clear late flag: submission id missing");
 103         }
 104
 105         if (!$submission = get_record("workshop_submissions", "id", $sid)) {
 106             error("Admin clear late flag: can not get submission record");
 107         }
 108         if (set_field("workshop_submissions", "late", 0, "id", $sid)) {
 109             print_heading(get_string("clearlateflag", "workshop")." ".get_string("ok"));
 110         }
 111
 112         add_to_log($course->id, "workshop", "late flag cleared", "view.php?id=$cm->id", "submission $submission->id");
 113
 114         redirect("view.php?id=$cm->id");
 115     }
 116
 117
 118     /******************* confirm delete ************************************/
 119     elseif ($action == 'confirmdelete' ) {
 120
 121         if (empty($sid)) {
 122             error("Confirm delete: submission id missing");
 123             }
 124         notice_yesno(get_string("confirmdeletionofthisitem","workshop", get_string("submission", "workshop")),
 125              "submissions.php?action=delete&amp;id=$cm->id&amp;sid=$sid", "view.php?id=$cm->id#sid=$sid");
 126         }
 127
 128
 129     /******************* delete ************************************/
 130     elseif ($action == 'delete' ) {
 131
 132         if (empty($sid)) {
 133             error("Delete: submission id missing");
 134         }
 135
 136         if (!$submission = get_record("workshop_submissions", "id", $sid)) {
 137             error("Admin delete: can not get submission record");
 138         }
 139
 140         // students are only allowed to delete their own submission and only up to the deadline
 141         if (!(workshop_is_teacher($workshop) or
 142                (($USER->id = $submission->userid) and ($timenow < $workshop->submissionend)
 143                    and (($timenow < $workshop->assessmentstart) or ($timenow < $submission->timecreated + $CFG->maxeditingtime))))) {
 144             error("You are not authorized to delete this submission");
 145         }
 146
 147         print_string("deleting", "workshop");
 148         // first get any assessments...
 149         if ($assessments = workshop_get_assessments($submission, 'ALL')) {
 150             foreach($assessments as $assessment) {
 151                 // ...and all the associated records...
 152                 delete_records("workshop_comments", "assessmentid", $assessment->id);
 153                 delete_records("workshop_grades", "assessmentid", $assessment->id);
 154                 echo ".";
 155             }
 156             // ...now delete the assessments...
 157             delete_records("workshop_assessments", "submissionid", $submission->id);
 158         }
 159         // ...and the submission record...
 160         delete_records("workshop_submissions", "id", $submission->id);
 161         // ..and finally the submitted file
 162         workshop_delete_submitted_files($workshop, $submission);
 163
 164         redirect("view.php?id=$cm->id");
 165     }
 166
 167
 168     /******************* admin (confirm) late flag ************************************/
 169     elseif ($action == 'adminlateflag' ) {
 170
 171         require_capability('mod/workshop:manage', $context);
 172         if (empty($sid)) {
 173             error("Admin confirm late flag: submission id missing");
 174         }
 175         if (!$submission = get_record("workshop_submissions", "id", $sid)) {
 176             error("Admin confirm late flag: can not get submission record");
 177         }
 178
 179         notice_yesno(get_string("clearlateflag","workshop")."?",
 180              "submissions.php?action=adminclearlate&amp;id=$cm->id&amp;sid=$sid",
 181              "view.php?id=$cm->id");
 182     }
 183
 184
 185     /******************* list all submissions ************************************/
 186     elseif ($action == 'adminlist' ) {
 187
 188         require_capability('mod/workshop:manage', $context);
 189
 190         workshop_list_submissions_for_admin($workshop, $order);
 191         print_continue("view.php?id=$cm->id");
 192
 193     }
 194
 195
 196     /******************* admin update title ************************************/
 197     elseif ($action == 'adminupdatetitle' ) {
 198
 199         require_capability('mod/workshop:manage', $context);
 200         if (empty($sid)) {
 201             error("Admin Update Title: submission id missing");
 202         }
 203
 204         if (set_field("workshop_submissions", "title", $title, "id", $sid)) {
 205             print_heading(get_string("amendtitle", "workshop")." ".get_string("ok"));
 206         }
 207         print_continue("view.php?id=$cm->id");
 208     }
 209
 210
 211     /******************* confirm remove attachments ************************************/
 212     elseif ($action == 'confirmremoveattachments' ) {
 213
 214         if (empty($sid)) {
 215             error("Admin confirm delete: submission id missing");
 216         }
 217         if (!$submission = get_record("workshop_submissions", "id", $sid)) {
 218             error("Admin delete: can not get submission record");
 219         }
 220
 221         notice_yesno(get_string("confirmremoveattachments","workshop"),
 222              "submissions.php?action=removeattachments&amp;id=$cm->id&amp;sid=$sid",
 223              "view.php?id=$cm->id");
 224     }
 225
 226
 227     /******************* edit submission ************************************/
 228     elseif ($action == 'editsubmission' ) {
 229
 230         if (empty($sid)) {
 231             error("Edit submission: submission id missing");
 232         }
 233         $usehtmleditor = can_use_html_editor();
 234
 235         $submission = get_record("workshop_submissions", "id", $sid);
 236         print_heading(get_string("editsubmission", "workshop"));
 237         if ($submission->userid <> $USER->id) {
 238             error("Edit submission: Userids do not match");
 239         }
 240         if (($submission->timecreated < ($timenow - $CFG->maxeditingtime)) and ($workshop->assessmentstart < $timenow)) {
 241             print_error('notallowed', 'workshop');
 242         }
 243         ?>
 244         <form id="editform" enctype="multipart/form-data" action="submissions.php" method="post">
 245         <fieldset class="invisiblefieldset">
 246         <input type="hidden" name="action" value="updatesubmission" />
 247         <input type="hidden" name="id" value="<?php echo $cm->id ?>" />
 248         <input type="hidden" name="sid" value="<?php echo $sid ?>" />
 249         <div class="boxaligncenter">
 250         <table cellpadding="5" border="1">
 251         <?php
 252         echo "<tr valign=\"top\"><td><b>". get_string("title", "workshop").":</b>\n";
 253         echo "<input type=\"text\" name=\"title\" size=\"60\" maxlength=\"100\" value=\"$submission->title\" />\n";
 254         echo "</td></tr><tr><td><b>".get_string("submission", "workshop").":</b><br />\n";
 255         print_textarea($usehtmleditor, 25,70, 630, 400, "description", $submission->description);
 256         use_html_editor("description");
 257         echo "</td></tr>\n";
 258         if ($workshop->nattachments) {
 259             $filearea = workshop_file_area_name($workshop, $submission);
 260             if ($basedir = workshop_file_area($workshop, $submission)) {
 261                 if ($files = get_directory_list($basedir)) {
 262                     echo "<tr><td><b>".get_string("attachments", "workshop").
 263                         "</b><div style=\"text-align:right;\"><input type=\"button\" value=\"".get_string("removeallattachments",
 264                         "workshop")."\" onclick=\"getElementById('editform').action.value='removeattachments';
 265                         getElementById('editform').submit();\"/></div></td></tr>\n";
 266                     $n = 1;
 267                     foreach ($files as $file) {
 268                         $icon = mimeinfo("icon", $file);
 269                         if ($CFG->slasharguments) {
 270                             $ffurl = "file.php/$filearea/$file";
 271                         } else {
 272                             $ffurl = "file.php?file=/$filearea/$file";
 273                         }
 274                         // removed target=\"uploadedfile\"
 275                         // as it does not validate MDL_7861
 276                         echo "<tr><td>".get_string("attachment", "workshop")." $n: <img src=\"$CFG->pixpath/f/$icon\"
 277                             class=\"icon\" alt=\"".get_string('file')."\" />".
 278                             "&nbsp;<a href=\"$CFG->wwwroot/$ffurl\">$file</a></td></tr>\n";
 279                     }
 280                 } else {
 281                     echo "<tr><td><b>".get_string("noattachments", "workshop")."</b></td></tr>\n";
 282                 }
 283             }
 284             echo "<tr><td>\n";
 285             require_once($CFG->dirroot.'/lib/uploadlib.php');
 286             for ($i=0; $i < $workshop->nattachments; $i++) {
 287                 $iplus1 = $i + 1;
 288                 $tag[$i] = get_string("newattachment", "workshop")." $iplus1:";
 289             }
 290             upload_print_form_fragment($workshop->nattachments,null,$tag,false,null,$course->maxbytes,
 291                 $workshop->maxbytes,false);
 292             echo "</td></tr>\n";
 293         }
 294
 295         echo "</table>\n";
 296         echo "<input type=\"submit\" value=\"".get_string("savemysubmission", "workshop")."\" />\n";
 297         echo "</div></fieldset></form>\n";
 298     }
 299
 300
 301     /******************* list all submissions ************************************/
 302     elseif ($action == 'listallsubmissions' ) {
 303         if (!$users = workshop_get_students($workshop)) {
 304             print_heading(get_string("nostudentsyet"));
 305             print_footer($course);
 306             exit;
 307         }
 308         print_heading(get_string("listofallsubmissions", "workshop").":", "CENTER");
 309         workshop_list_all_submissions($workshop, $USER);
 310         print_continue("view.php?id=$cm->id");
 311
 312     }
 313
 314
 315     /******************* list for assessment student (submissions) ************************************/
 316     elseif ($action == 'listforassessmentstudent' ) {
 317         if (!$users = workshop_get_students($workshop)) {
 318             print_heading(get_string("nostudentsyet"));
 319             print_footer($course);
 320             exit;
 321         }
 322         workshop_list_unassessed_student_submissions($workshop, $USER);
 323         print_continue("view.php?id=$cm->id");
 324
 325     }
 326
 327
 328     /******************* list for assessment teacher (submissions) ************************************/
 329     elseif ($action == 'listforassessmentteacher' ) {
 330
 331         require_capability('mod/workshop:manage', $context);
 332
 333         workshop_list_unassessed_teacher_submissions($workshop, $USER);
 334         print_continue("view.php?id=$cm->id");
 335
 336     }
 337
 338
 339     /******************* remove (all) attachments ************************************/
 340     elseif ($action == 'removeattachments' ) {
 341
 342         $form = data_submitted();
 343
 344         if (empty($form->sid)) {
 345             error("Update submission: submission id missing");
 346         }
 347
 348         $submission = get_record("workshop_submissions", "id", $form->sid);
 349
 350         // students are only allowed to remove their own attachments and only up to the deadline
 351         if (!(workshop_is_teacher($workshop) or
 352                (($USER->id = $submission->userid) and ($timenow < $workshop->submissionend)
 353                    and (($timenow < $workshop->assessmentstart) or ($timenow < $submission->timecreated + $CFG->maxeditingtime))))) {
 354             error("You are not authorized to delete these attachments");
 355         }
 356
 357         // amend title... just in case they were modified
 358         // check existence of title
 359         if (empty($form->title)) {
 360             notify(get_string("notitlegiven", "workshop"));
 361         } else {
 362             set_field("workshop_submissions", "title", $form->title, "id", $submission->id);
 363             set_field("workshop_submissions", "description", trim($form->description), "id", $submission->id);
 364         }
 365         print_string("removeallattachments", "workshop");
 366         workshop_delete_submitted_files($workshop, $submission);
 367         add_to_log($course->id, "workshop", "removeattachments", "view.php?id=$cm->id", "submission $submission->id");
 368
 369         print_continue("view.php?id=$cm->id#sid=$submission->id");
 370     }
 371
 372
 373     /******************* show submission ************************************/
 374     elseif ($action == 'showsubmission' ) {
 375
 376         if (empty($sid)) {
 377             error("Show submission: submission id missing");
 378         }
 379
 380         $submission = get_record("workshop_submissions", "id", $sid);
 381         $title = '"'.$submission->title.'" ';
 382         if (workshop_is_teacher($workshop)) {
 383             $title .= get_string('by', 'workshop').' '.workshop_fullname($submission->userid, $course->id);
 384         }
 385         print_heading($title);
 386         echo '<div style="text-align:center">'.get_string('submitted', 'workshop').': '.userdate($submission->timecreated).'</div><br />';
 387         workshop_print_submission($workshop, $submission);
 388         print_continue(htmlentities($_SERVER['HTTP_REFERER'].'#sid='.$submission->id));
 389     }
 390
 391
 392     /*************** update (league table options teacher) ***************************/
 393     elseif ($action == 'updateleaguetable') {
 394
 395         require_capability('mod/workshop:manage', $context);
 396
 397         // save number of entries in showleaguetable option
 398         if ($nentries == 'All') {
 399             $nentries = 99;
 400         }
 401         set_field("workshop", "showleaguetable", $nentries, "id", "$workshop->id");
 402
 403         // save the anonymous option
 404         set_field("workshop", "anonymous", $anonymous, "id", "$workshop->id");
 405         add_to_log($course->id, "workshop", "league table", "view.php?id=$cm->id", $nentries, $cm->id);
 406
 407         redirect("view.php?id=$cm->id");
 408     }
 409
 410
 411     /*************** update submission ***************************/
 412     elseif ($action == 'updatesubmission') {
 413
 414         if (empty($sid)) {
 415             error("Update submission: submission id missing");
 416         }
 417         $submission = get_record("workshop_submissions", "id", $sid);
 418
 419         // students are only allowed to update their own submission and only up to the deadline
 420         if (!(workshop_is_teacher($workshop) or
 421                (($USER->id = $submission->userid) and ($timenow < $workshop->submissionend)
 422                    and (($timenow < $workshop->assessmentstart) or ($timenow < $submission->timecreated + $CFG->maxeditingtime))))) {
 423             error("You are not authorized to update your submission");
 424         }
 425
 426         // check existence of title
 427         if (empty($title)) {
 428             $title = get_string("notitle", "workshop");
 429         }
 430         set_field("workshop_submissions", "title", $title, "id", $submission->id);
 431         set_field("workshop_submissions", "description", trim($description), "id", $submission->id);
 432         set_field("workshop_submissions", "timecreated", $timenow, "id", $submission->id);
 433         if ($workshop->nattachments) {
 434             require_once($CFG->dirroot.'/lib/uploadlib.php');
 435             $um = new upload_manager(null,false,false,$course,false,$workshop->maxbytes);
 436             if ($um->preprocess_files()) {
 437                 $dir = workshop_file_area_name($workshop, $submission);
 438                 if ($um->save_files($dir)) {
 439                     add_to_log($course->id, "workshop", "newattachment", "view.php?id=$cm->id", "$workshop->id");
 440                     print_heading(get_string("uploadsuccess", "workshop"));
 441                 }
 442                 // upload manager will print errors.
 443             }
 444             print_continue("view.php?id=$cm->id");
 445         } else {
 446             echo '</div>'; // close <div id='page'>
 447             redirect("view.php?id=$cm->id#sid=$submission->id");
 448         }
 449     }
 450
 451
 452     /*************** no man's land **************************************/
 453
 454     else {
 455
 456         error("Fatal Error: Unknown Action: ".$action."\n");
 457
 458     }
 459
 460
 461     print_footer($course);
 462
 463 ?>