Merge lp:~ivle-dev/ivle/late-submit into lp:ivle

[Matt Giuca]

Students can now submit projects after the deadline (with a red submission field and warning).
- Submitting late requires an extra confirmation step.
- Lecturer project view clearly shows late submissions, and how many days late.
(LP: #598346)

Everything described in bug #598346:
- Students can now submit projects after the deadline (with a red submission field and warning).
- Submitting late requires an extra confirmation step.
- Lecturer project view clearly shows late submissions, and how many days late.

[lp:~ivle-dev/ivle/late-submit]

1821. By Matt Giuca on 2010-07-21

Merge from trunk.

1822. By Matt Giuca on 2010-07-21

doc/man/tour: Updated the tour page to discuss late submissions.

[David Coles (dcoles)]

"The project has not yet been submitted" on the 'Submit project - late' page is slightly confusing if you have already made a submission. I assume you're just trying to warn students that the late screen is not a confirmation screen and they still have to click "Submit Late".

The example would be if you submitted 5 minutes before the deadline and then tried 2 minutes after. You may interpret this line to mean that you have _nothing_ submitted.

[David Coles (dcoles)]

Is that 'else:' on line #205 of the diff is to only run that code if no exception occurs during submission.

[David Coles (dcoles)]

Do we want to highlight late submissions more than just a '*'? Put those lines in red perhaps?

[Matt Giuca (mgiuca)]

> "The project has not yet been submitted" on the 'Submit project - late' page
> is slightly confusing if you have already made a submission. I assume you're
> just trying to warn students that the late screen is not a confirmation screen
> and they still have to click "Submit Late".

I see the confusion. I'll reword the message.

[Matt Giuca (mgiuca)]

> Is that 'else:' on line #205 of the diff is to only run that code if no
> exception occurs during submission.

Yes. It's a bit unfortunate, but it has to now go in the 'else' clause because if the project is submitted late, it no longer raises an exception, it continues running the code but doesn't follow the same code path.

> Do we want to highlight late submissions more than just a '*'? Put those lines
> in red perhaps?

It is also italicised. Is that sufficient, or should it be changed to red?

[David Coles (dcoles)]

>
>
> > Do we want to highlight late submissions more than just a '*'? Put those
> lines
> > in red perhaps?
>

I missed the italics since I only had one submission. But I think it would
flow on nicely from the red used for showing late submissions and really
make it stand out.

[William Grant (wgrant)]

I think the late submission confirmation page is insufficiently clear about the lateness. It should be a lot more obvious.

Also, I am a little suspicious of using '*' in HTML like that. That's a bit too plaintexty for my liking.

Apart from those, it looks good.

review: Approve

[lp:~ivle-dev/ivle/late-submit]

1823. By Matt Giuca on 2010-07-22

Project page: Late submissions are now shown in red (the whole line, not just the date), rather than italics.
Required a bit of CSS hackery (see comments in coremedia/ivle.css).

1824. By Matt Giuca on 2010-07-22

Project page: Removed the space before the '*'.

1825. By Matt Giuca on 2010-07-22

Late submission confirmation: Reworded so it is much clearer that a) the previous submission has not yet been overwritten, b) this is a late submission.
Also use more red/bold as a warning.

[Matt Giuca (mgiuca)]

> I missed the italics since I only had one submission. But I think it would
> flow on nicely from the red used for showing late submissions and really
> make it stand out.

Done.

> I think the late submission confirmation page is insufficiently clear about
> the lateness. It should be a lot more obvious.

OK I have rewritten it. It now reads:

"<red-bold>This submission has not yet been completed.</red-bold>

You are about to submit *project* for *subject*.

The project deadline has already passed. If you choose to continue, <red-bold>your submission will be considered late</red-bold>. This may incur a late penalty, at the discretion of the subject coordinator, even if you have already submitted on time.

You may resubmit this project again at any time, but a new submission will overwrite any made earlier, and further submissions may incur an increased penalty."

> Also, I am a little suspicious of using '*' in HTML like that. That's a bit
> too plaintexty for my liking.

I tried making it ^*, but it takes up more vertical space which isn't good in a list like that. Think of it as a * on the side of a cereal box.

[David Coles (dcoles)]

*thumbs up*

review: Approve

[Matt Giuca (mgiuca)]

Cheers :) But I merged this like 5 hours ago...

=== modified file 'doc/man/tour.rst'
--- doc/man/tour.rst	2010-07-21 04:33:55 +0000
+++ doc/man/tour.rst	2010-07-22 01:56:43 +0000
@@ -93,11 +93,16 @@
 any submitted project from the subject page.
 
 If you go into the *Intermediate IVLE ‣ group1* directory, you will be able
-to make a group submission to Phase 2 (which is a group project). Note that
-the Phase 3 submission has already closed.
-Also note that the file here (``phase2.html``) was edited by studenta and
+to make a group submission to Phase 2 (which is a group project). Also note
+that the file here (``phase2.html``) was edited by studenta and
 studentb collaboratively, as you can see in the project's revision log.
 
+Note that the Phase 3 submission has already closed. You can still make a
+"late submission" to a project that has closed, but there is an extra
+confirmation step. Lecturers are given details on late submissions and may
+deduct marks accordingly.
+
+
 Worksheets
 ----------
 
@@ -213,6 +218,12 @@
 
 This will download the student's work into the current directory, to inspect.
 
+.. note::
+   This page shows late submissions in red, with a "*", and the number of
+   days late, rounded upwards. Therefore, a submission which is 1 second late
+   is shown with a "(1)", while a submission that is 24 hours and 1 second
+   late is shown with a "(2)".
+
 You can also try to check out the group submission from Phase 2.
 
 Managing worksheets and exercises

=== modified file 'ivle/database.py'
--- ivle/database.py	2010-07-20 08:24:32 +0000
+++ ivle/database.py	2010-07-22 01:56:43 +0000
@@ -610,11 +610,14 @@
         return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
                                   self.project_set.offering)
 
-    def can_submit(self, principal, user):
+    def can_submit(self, principal, user, late=False):
+        """
+        @param late: If True, does not take the deadline into account.
+        """
         return (self in principal.get_projects() and
-                not self.has_deadline_passed(user))
+                (late or not self.has_deadline_passed(user)))
 
-    def submit(self, principal, path, revision, who):
+    def submit(self, principal, path, revision, who, late=False):
         """Submit a Subversion path and revision to a project.
 
         @param principal: The owner of the Subversion repository, and the
@@ -622,9 +625,11 @@
         @param path: A path within that repository to submit.
         @param revision: The revision of that path to submit.
         @param who: The user who is actually making the submission.
+        @param late: If True, will not raise a DeadlinePassed exception even
+            after the deadline. (Default False.)
         """
 
-        if not self.can_submit(principal, who):
+        if not self.can_submit(principal, who, late=late):
             raise DeadlinePassed()
 
         a = Assessed.get(Store.of(self), principal, self)
@@ -946,6 +951,19 @@
             raise SubmissionError("Path must not contain '\\n', '[' or ']'")
         return os.path.normpath(path)
 
+    @property
+    def late(self):
+        """True if the project was submitted late."""
+        return self.days_late > 0
+
+    @property
+    def days_late(self):
+        """The number of days the project was submitted late (rounded up), or
+        0 if on-time."""
+        # XXX: Need to respect extensions.
+        return max(0,
+            (self.date_submitted - self.assessed.project.deadline).days + 1)
+
 # WORKSHEETS AND EXERCISES #
 
 class Exercise(Storm):

=== modified file 'ivle/webapp/admin/templates/project-export.sh'
--- ivle/webapp/admin/templates/project-export.sh	2010-07-20 08:31:02 +0000
+++ ivle/webapp/admin/templates/project-export.sh	2010-07-22 01:56:43 +0000
@@ -20,9 +20,10 @@
 # $ ./project-export.sh
 
 # Submissions: ${project.latest_submissions.count()}/${project.project_set.assigned.count()}
+# * Late submissions (number of days late)
 
 {% if project.latest_submissions.count() == 0 %}# There are no submissions.{% end %}{% if project.latest_submissions.count() > 0 %}# Group		Submitter		Date
-{% for submission in project.latest_submissions %}# {% choose submission.assessed.principal is submission.submitter %}{% when True %}-{% end %}{% otherwise %}${submission.assessed.principal.short_name}{% end %}{% end %}		${submission.submitter.short_name}		${submission.date_submitted.strftime("%Y-%m-%d %H:%M:%S")}
+{% for submission in project.latest_submissions %}# {% choose submission.assessed.principal is submission.submitter %}{% when True %}-{% end %}{% otherwise %}${submission.assessed.principal.short_name}{% end %}{% end %}		${submission.submitter.short_name}		${submission.date_submitted.strftime("%Y-%m-%d %H:%M:%S")}{% if submission.late %}* (${submission.days_late}){% end %}
 ${submission.get_svn_export_command(req)}
 {% end %}
 {% end %}

=== modified file 'ivle/webapp/admin/templates/project.html'
--- ivle/webapp/admin/templates/project.html	2010-07-21 04:21:50 +0000
+++ ivle/webapp/admin/templates/project.html	2010-07-22 01:56:43 +0000
@@ -33,6 +33,7 @@
            Bash script for exporting submitted projects
         </a>
       </p>
+      <p class="late_submission">* Late submissions (number of days late)</p>
       <div py:if="project.latest_submissions.count() == 0">
         There are no submissions.
       </div>
@@ -48,13 +49,13 @@
         </thead>
         <tbody>
         <py:for each="submission in project.latest_submissions">
-          <tr>
+          <tr py:attrs="{'class': 'late_submission'} if submission.late else {}">
           <py:choose test="submission.assessed.principal is submission.submitter">
             <td py:when="True">-</td>
             <td py:otherwise=""><span title="${submission.assessed.principal.display_name}">${submission.assessed.principal.short_name}</span></td>
           </py:choose>
             <td><span title="${submission.submitter.display_name}">${submission.submitter.short_name}</span></td>
-            <td>${submission.date_submitted.strftime("%Y-%m-%d %H:%M:%S")}</td>
+            <td>${submission.date_submitted.strftime("%Y-%m-%d %H:%M:%S")}<py:if test="submission.late">* (${submission.days_late})</py:if></td>
             <td>${submission.get_svn_export_command(req)}</td>
           </tr>
         </py:for>

=== modified file 'ivle/webapp/coremedia/ivle.css'
--- ivle/webapp/coremedia/ivle.css	2010-03-05 06:30:38 +0000
+++ ivle/webapp/coremedia/ivle.css	2010-07-22 01:56:43 +0000
@@ -366,8 +366,11 @@
   margin-bottom: 0.3em;
 }
 
-.project.closed {
-    opacity: 0.6;
+/* For project view (late_submission entries in the submission list), must
+ * apply to the td (not the tr) and be !important to override the pretty_table
+ * styling of the td text colour. */
+.project.closed, .late_submission, tr.late_submission td {
+   color: darkred !important;
 }
 
 .form_error {

=== modified file 'ivle/webapp/submit/__init__.py'
--- ivle/webapp/submit/__init__.py	2010-07-20 05:22:02 +0000
+++ ivle/webapp/submit/__init__.py	2010-07-22 01:56:43 +0000
@@ -85,6 +85,9 @@
             except ValueError:
                 raise BadRequest('Project must be an integer.')
 
+            # True, if the user has confirmed to submit late
+            late = 'late' in data and data['late'] == "yes"
+
             project = req.store.find(Project, Project.id == projectid).one()
 
             # This view's offering will be the sole offering for which the
@@ -97,39 +100,46 @@
 
             try:
                 ctx['submission'] = project.submit(self.context,
-                                    unicode(self.path), revision, req.user)
-            except (database.DeadlinePassed, database.SubmissionError), e:
+                                    unicode(self.path), revision, req.user,
+                                    late=late)
+            except database.DeadlinePassed:
+                # Show late submission page
+                self.template = 'submit-late.html'
+                ctx['project'] = project
+            except database.SubmissionError, e:
                 raise BadRequest(str(e) + ".")
-
-            # The Subversion configuration needs to be updated, to grant
-            # tutors and lecturers access to this submission. We have to 
-            # commit early so usrmgt-server can see the new submission.
-            req.store.commit()
-
-            # Instruct usrmgt-server to rebuild the SVN group authz file.
-            msg = {'rebuild_svn_group_config': {}}
-            usrmgt = ivle.chat.chat(req.config['usrmgt']['host'],
-                                    req.config['usrmgt']['port'],
-                                    msg,
-                                    req.config['usrmgt']['magic'],
-                                    )
-
-            if usrmgt.get('response') in (None, 'failure'):
-                raise Exception("Failure creating repository: " + str(usrmgt))
-
-            # Instruct usrmgt-server to rebuild the SVN user authz file.
-            msg = {'rebuild_svn_config': {}}
-            usrmgt = ivle.chat.chat(req.config['usrmgt']['host'],
-                                    req.config['usrmgt']['port'],
-                                    msg,
-                                    req.config['usrmgt']['magic'],
-                                    )
-
-            if usrmgt.get('response') in (None, 'failure'):
-                raise Exception("Failure creating repository: " + str(usrmgt))
-
-            self.template = 'submitted.html'
-            ctx['project'] = project
+            else:
+                # The Subversion configuration needs to be updated, to grant
+                # tutors and lecturers access to this submission. We have to 
+                # commit early so usrmgt-server can see the new submission.
+                req.store.commit()
+
+                # Instruct usrmgt-server to rebuild the SVN group authz file.
+                msg = {'rebuild_svn_group_config': {}}
+                usrmgt = ivle.chat.chat(req.config['usrmgt']['host'],
+                                        req.config['usrmgt']['port'],
+                                        msg,
+                                        req.config['usrmgt']['magic'],
+                                        )
+
+                if usrmgt.get('response') in (None, 'failure'):
+                    raise Exception("Failure creating repository: "
+                                    + str(usrmgt))
+
+                # Instruct usrmgt-server to rebuild the SVN user authz file.
+                msg = {'rebuild_svn_config': {}}
+                usrmgt = ivle.chat.chat(req.config['usrmgt']['host'],
+                                        req.config['usrmgt']['port'],
+                                        msg,
+                                        req.config['usrmgt']['magic'],
+                                        )
+
+                if usrmgt.get('response') in (None, 'failure'):
+                    raise Exception("Failure creating repository: "
+                                    + str(usrmgt))
+
+                self.template = 'submitted.html'
+                ctx['project'] = project
 
         ctx['req'] = req
         ctx['principal'] = self.context

=== added file 'ivle/webapp/submit/submit-late.html'
--- ivle/webapp/submit/submit-late.html	1970-01-01 00:00:00 +0000
+++ ivle/webapp/submit/submit-late.html	2010-07-22 01:56:43 +0000
@@ -0,0 +1,27 @@
+<html xmlns="http://www.w3.org/1999/xhtml"
+      xmlns:py="http://genshi.edgewall.org/">
+  <head>
+    <title>Submit project - late</title>
+  </head>
+  <body>
+    <h1>Submit project - late</h1>
+    <div id="ivle_padding">
+      <form action="" method="post">
+        <input type="hidden" name="project" value="${project.id}" />
+        <input type="hidden" name="late" value="yes" />
+        <p class="late_submission"><strong>This submission has not yet been
+        completed.</strong></p>
+        <p>You are about to submit ${project.name} for ${offering.subject.name}.</p>
+        <p>The project deadline has already passed. If you choose to continue,
+        <span class="late_submission"><strong>your submission will be
+        considered late</strong></span>. This may incur a late penalty, at the
+        discretion of the subject coordinator, even if you have already
+        submitted on time.</p>
+        <p>You may resubmit this project again at any time, but a new submission
+        will overwrite any made earlier, and further submissions may incur an
+        increased penalty.</p>
+        <input type="submit" value="Submit Late" />
+      </form>
+    </div>
+  </body>
+</html>

=== modified file 'ivle/webapp/submit/submit.html'
--- ivle/webapp/submit/submit.html	2010-02-12 10:58:21 +0000
+++ ivle/webapp/submit/submit.html	2010-07-22 01:56:43 +0000
@@ -27,10 +27,9 @@
           <form action="" method="post">
             <table>
               <tr py:for="project in principal.get_projects(offering=offering)"
-                  py:with="attrs = {'disabled': 'disabled'} if project.has_deadline_passed(req.user) else {}"
                   py:attrs="{'class': 'project closed'} if project.has_deadline_passed(req.user) else {'class': 'project'}">
                 <td style="vertical-align: top">
-                  <input type="radio" name="project" id="project_${project.id}" value="${project.id}" py:attrs="attrs" />
+                  <input type="radio" name="project" id="project_${project.id}" value="${project.id}" />
                 </td>
                 <td>
                   <label for="project_${project.id}">
@@ -60,12 +59,15 @@
                     </py:if>
                     <br />
                     ${project.synopsis}
+                    <py:if test="project.has_deadline_passed(req.user)"><br />
+                      <em>Note: The deadline has passed. You may still submit late, but a penalty may be incurred.</em>
+                    </py:if>
                   </label>
                 </td>
               </tr>
             </table>
             <p>Ensure that you have committed all changes - only changes in the repository will be submitted.</p>
-            <p>You may resubmit a project again at any time until its deadline, but a new submission will overwrite any made earlier.</p>
+            <p>You may resubmit a project again at any time, but a new submission will overwrite any made earlier, and submissions after the deadline may incur a penalty.</p>
             <p><input type="submit" value="Submit Project" />
               <a class="helpaction" href="/+help/Submitting%20a%20project">Help submitting a project</a>
             </p>

=== modified file 'ivle/webapp/submit/submitted.html'
--- ivle/webapp/submit/submitted.html	2010-02-11 09:24:34 +0000
+++ ivle/webapp/submit/submitted.html	2010-07-22 01:56:43 +0000
@@ -7,8 +7,9 @@
     <h1>Project submitted</h1>
     <div id="ivle_padding">
       <p>You successfully submitted ${project.name} for ${offering.subject.name}.</p>
-      <p>You may resubmit this project again at any time until the deadline,
-      but a new submission will overwrite any made earlier.
+      <p>You may resubmit this project again at any time, but a new submission
+      will overwrite any made earlier, and submissions after the deadline may
+      incur a penalty.
       It is important to verify each submission after you make it.</p>
       <p><a class="verifyaction"
           href="${submission.get_verify_url(req.user)}">Verify this submission</a></p>