~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/database.py

  • Committer: William Grant
  • Date: 2009-04-29 04:58:42 UTC
  • Revision ID: grantw@unimelb.edu.au-20090429045842-upijb1ybcbz1zg6u
Kill --nosvnrevno from setup.install - we don't use Subversion now.

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
 
18
18
# Author: Matt Giuca, Will Grant
19
19
 
20
 
"""Database utilities and content classes.
 
20
"""
 
21
Database Classes and Utilities for Storm ORM
21
22
 
22
23
This module provides all of the classes which map to database tables.
23
24
It also provides miscellaneous utility functions for database interaction.
25
26
 
26
27
import hashlib
27
28
import datetime
28
 
import os
29
29
 
30
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
31
                         Reference, ReferenceSet, Bool, Storm, Desc
32
 
from storm.expr import Select, Max
33
32
from storm.exceptions import NotOneError, IntegrityError
34
33
 
35
34
from ivle.worksheet.rst import rst
81
80
# USERS #
82
81
 
83
82
class User(Storm):
84
 
    """An IVLE user account."""
 
83
    """
 
84
    Represents an IVLE user.
 
85
    """
85
86
    __storm_table__ = "login"
86
87
 
87
88
    id = Int(primary=True, name="loginid")
118
119
 
119
120
    @property
120
121
    def display_name(self):
121
 
        """Returns the "nice name" of the user or group."""
122
122
        return self.fullname
123
123
 
124
124
    @property
125
 
    def short_name(self):
126
 
        """Returns the database "identifier" name of the user or group."""
127
 
        return self.login
128
 
 
129
 
    @property
130
125
    def password_expired(self):
131
126
        fieldval = self.pass_exp
132
127
        return fieldval is not None and datetime.datetime.now() > fieldval
169
164
 
170
165
    # TODO: Invitations should be listed too?
171
166
    def get_groups(self, offering=None):
172
 
        """Get groups of which this user is a member.
173
 
 
174
 
        @param offering: An optional offering to restrict the search to.
175
 
        """
176
167
        preds = [
177
168
            ProjectGroupMembership.user_id == self.id,
178
169
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
199
190
        return self._get_enrolments(False) 
200
191
 
201
192
    def get_projects(self, offering=None, active_only=True):
202
 
        """Find projects that the user can submit.
 
193
        '''Return Projects that the user can submit.
203
194
 
204
195
        This will include projects for offerings in which the user is
205
196
        enrolled, as long as the project is not in a project set which has
206
197
        groups (ie. if maximum number of group members is 0).
207
198
 
208
 
        @param active_only: Whether to only search active offerings.
209
 
        @param offering: An optional offering to restrict the search to.
210
 
        """
 
199
        Unless active_only is False, only projects for active offerings will
 
200
        be returned.
 
201
 
 
202
        If an offering is specified, returned projects will be limited to
 
203
        those for that offering.
 
204
        '''
211
205
        return Store.of(self).find(Project,
212
206
            Project.project_set_id == ProjectSet.id,
213
207
            ProjectSet.max_students_per_group == None,
216
210
            Semester.id == Offering.semester_id,
217
211
            (not active_only) or (Semester.state == u'current'),
218
212
            Enrolment.offering_id == Offering.id,
219
 
            Enrolment.user_id == self.id,
220
 
            Enrolment.active == True)
 
213
            Enrolment.user_id == self.id)
221
214
 
222
215
    @staticmethod
223
216
    def hash_password(password):
224
 
        """Hash a password with MD5."""
225
217
        return hashlib.md5(password).hexdigest()
226
218
 
227
219
    @classmethod
228
220
    def get_by_login(cls, store, login):
229
 
        """Find a user in a store by login name."""
 
221
        """
 
222
        Get the User from the db associated with a given store and
 
223
        login.
 
224
        """
230
225
        return store.find(cls, cls.login == unicode(login)).one()
231
226
 
232
 
    def get_permissions(self, user, config):
233
 
        """Determine privileges held by a user over this object.
234
 
 
235
 
        If the user requesting privileges is this user or an admin,
236
 
        they may do everything. Otherwise they may do nothing.
237
 
        """
 
227
    def get_permissions(self, user):
238
228
        if user and user.admin or user is self:
239
 
            return set(['view_public', 'view', 'edit', 'submit_project'])
 
229
            return set(['view', 'edit', 'submit_project'])
240
230
        else:
241
 
            return set(['view_public'])
 
231
            return set()
242
232
 
243
233
# SUBJECTS AND ENROLMENTS #
244
234
 
245
235
class Subject(Storm):
246
 
    """A subject (or course) which is run in some semesters."""
247
 
 
248
236
    __storm_table__ = "subject"
249
237
 
250
238
    id = Int(primary=True, name="subjectid")
251
239
    code = Unicode(name="subj_code")
252
240
    name = Unicode(name="subj_name")
253
241
    short_name = Unicode(name="subj_short_name")
 
242
    url = Unicode()
254
243
 
255
244
    offerings = ReferenceSet(id, 'Offering.subject_id')
256
245
 
259
248
    def __repr__(self):
260
249
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
261
250
 
262
 
    def get_permissions(self, user, config):
263
 
        """Determine privileges held by a user over this object.
264
 
 
265
 
        If the user requesting privileges is an admin, they may edit.
266
 
        Otherwise they may only read.
267
 
        """
 
251
    def get_permissions(self, user):
268
252
        perms = set()
269
253
        if user is not None:
270
254
            perms.add('view')
273
257
        return perms
274
258
 
275
259
    def active_offerings(self):
276
 
        """Find active offerings for this subject.
277
 
 
278
 
        Return a sequence of currently active offerings for this subject
 
260
        """Return a sequence of currently active offerings for this subject
279
261
        (offerings whose semester.state is "current"). There should be 0 or 1
280
262
        elements in this sequence, but it's possible there are more.
281
263
        """
283
265
                                   Semester.state == u'current')
284
266
 
285
267
    def offering_for_semester(self, year, semester):
286
 
        """Get the offering for the given year/semester, or None.
287
 
 
288
 
        @param year: A string representation of the year.
289
 
        @param semester: A string representation of the semester.
290
 
        """
 
268
        """Get the offering for the given year/semester, or None."""
291
269
        return self.offerings.find(Offering.semester_id == Semester.id,
292
270
                               Semester.year == unicode(year),
293
271
                               Semester.semester == unicode(semester)).one()
294
272
 
295
273
class Semester(Storm):
296
 
    """A semester in which subjects can be run."""
297
 
 
298
274
    __storm_table__ = "semester"
299
275
 
300
276
    id = Int(primary=True, name="semesterid")
314
290
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
315
291
 
316
292
class Offering(Storm):
317
 
    """An offering of a subject in a particular semester."""
318
 
 
319
293
    __storm_table__ = "offering"
320
294
 
321
295
    id = Int(primary=True, name="offeringid")
323
297
    subject = Reference(subject_id, Subject.id)
324
298
    semester_id = Int(name="semesterid")
325
299
    semester = Reference(semester_id, Semester.id)
326
 
    description = Unicode()
327
 
    url = Unicode()
328
300
    groups_student_permissions = Unicode()
329
301
 
330
302
    enrolments = ReferenceSet(id, 'Enrolment.offering_id')
333
305
                           'Enrolment.user_id',
334
306
                           'User.id')
335
307
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
336
 
    projects = ReferenceSet(id,
337
 
                            'ProjectSet.offering_id',
338
 
                            'ProjectSet.id',
339
 
                            'Project.project_set_id')
340
308
 
341
309
    worksheets = ReferenceSet(id, 
342
310
        'Worksheet.offering_id', 
350
318
                                  self.semester)
351
319
 
352
320
    def enrol(self, user, role=u'student'):
353
 
        """Enrol a user in this offering.
354
 
 
355
 
        Enrolments handle both the staff and student cases. The role controls
356
 
        the privileges granted by this enrolment.
357
 
        """
 
321
        '''Enrol a user in this offering.'''
358
322
        enrolment = Store.of(self).find(Enrolment,
359
323
                               Enrolment.user_id == user.id,
360
324
                               Enrolment.offering_id == self.id).one()
373
337
                               Enrolment.offering_id == self.id).one()
374
338
        Store.of(enrolment).remove(enrolment)
375
339
 
376
 
    def get_permissions(self, user, config):
 
340
    def get_permissions(self, user):
377
341
        perms = set()
378
342
        if user is not None:
379
343
            enrolment = self.get_enrolment(user)
380
344
            if enrolment or user.admin:
381
345
                perms.add('view')
382
 
            if enrolment and enrolment.role == u'tutor':
383
 
                perms.add('view_project_submissions')
384
 
                # Site-specific policy on the role of tutors
385
 
                if config['policy']['tutors_can_enrol_students']:
386
 
                    perms.add('enrol')
387
 
                    perms.add('enrol_student')
388
 
                if config['policy']['tutors_can_edit_worksheets']:
389
 
                    perms.add('edit_worksheets')
390
 
                if config['policy']['tutors_can_admin_groups']:
391
 
                    perms.add('admin_groups')
392
 
            if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
393
 
                perms.add('view_project_submissions')
394
 
                perms.add('admin_groups')
395
 
                perms.add('edit_worksheets')
396
 
                perms.add('edit')           # Can edit projects & details
397
 
                perms.add('enrol')          # Can see enrolment screen at all
398
 
                perms.add('enrol_student')  # Can enrol students
399
 
                perms.add('enrol_tutor')    # Can enrol tutors
400
 
            if user.admin:
401
 
                perms.add('enrol_lecturer') # Can enrol lecturers
 
346
            if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
 
347
               or user.admin:
 
348
                perms.add('edit')
402
349
        return perms
403
350
 
404
351
    def get_enrolment(self, user):
405
 
        """Find the user's enrolment in this offering."""
406
352
        try:
407
353
            enrolment = self.enrolments.find(user=user).one()
408
354
        except NotOneError:
410
356
 
411
357
        return enrolment
412
358
 
413
 
    def get_members_by_role(self, role):
414
 
        return Store.of(self).find(User,
415
 
                Enrolment.user_id == User.id,
416
 
                Enrolment.offering_id == self.id,
417
 
                Enrolment.role == role
418
 
                ).order_by(User.login)
419
 
 
420
 
    @property
421
 
    def students(self):
422
 
        return self.get_members_by_role(u'student')
423
 
 
424
 
    def get_open_projects_for_user(self, user):
425
 
        """Find all projects currently open to submissions by a user."""
426
 
        # XXX: Respect extensions.
427
 
        return self.projects.find(Project.deadline > datetime.datetime.now())
428
 
 
429
 
    def clone_worksheets(self, source):
430
 
        """Clone all worksheets from the specified source to this offering."""
431
 
        import ivle.worksheet.utils
432
 
        for worksheet in source.worksheets:
433
 
            newws = Worksheet()
434
 
            newws.seq_no = worksheet.seq_no
435
 
            newws.identifier = worksheet.identifier
436
 
            newws.name = worksheet.name
437
 
            newws.assessable = worksheet.assessable
438
 
            newws.data = worksheet.data
439
 
            newws.format = worksheet.format
440
 
            newws.offering = self
441
 
            Store.of(self).add(newws)
442
 
            ivle.worksheet.utils.update_exerciselist(newws)
443
 
 
444
 
 
445
359
class Enrolment(Storm):
446
 
    """An enrolment of a user in an offering.
447
 
 
448
 
    This represents the roles of both staff and students.
449
 
    """
450
 
 
451
360
    __storm_table__ = "enrolment"
452
361
    __storm_primary__ = "user_id", "offering_id"
453
362
 
473
382
        return "<%s %r in %r>" % (type(self).__name__, self.user,
474
383
                                  self.offering)
475
384
 
476
 
    def get_permissions(self, user, config):
477
 
        # A user can edit any enrolment that they could have created.
478
 
        perms = set()
479
 
        if ('enrol_' + str(self.role)) in self.offering.get_permissions(
480
 
            user, config):
481
 
            perms.add('edit')
482
 
        return perms
483
 
 
484
 
    def delete(self):
485
 
        """Delete this enrolment."""
486
 
        Store.of(self).remove(self)
487
 
 
488
 
 
489
385
# PROJECTS #
490
386
 
491
387
class ProjectSet(Storm):
492
 
    """A set of projects that share common groups.
493
 
 
494
 
    Each student project group is attached to a project set. The group is
495
 
    valid for all projects in the group's set.
496
 
    """
497
 
 
498
388
    __storm_table__ = "project_set"
499
389
 
500
390
    id = Int(name="projectsetid", primary=True)
511
401
        return "<%s %d in %r>" % (type(self).__name__, self.id,
512
402
                                  self.offering)
513
403
 
514
 
    def get_permissions(self, user, config):
515
 
        return self.offering.get_permissions(user, config)
516
 
 
517
 
    def get_groups_for_user(self, user):
518
 
        """List all groups in this offering of which the user is a member."""
519
 
        assert self.is_group
520
 
        return Store.of(self).find(
521
 
            ProjectGroup,
522
 
            ProjectGroupMembership.user_id == user.id,
523
 
            ProjectGroupMembership.project_group_id == ProjectGroup.id,
524
 
            ProjectGroup.project_set_id == self.id)
525
 
 
526
 
    def get_submission_principal(self, user):
527
 
        """Get the principal on behalf of which the user can submit.
528
 
 
529
 
        If this is a solo project set, the given user is returned. If
530
 
        the user is a member of exactly one group, all the group is
531
 
        returned. Otherwise, None is returned.
532
 
        """
533
 
        if self.is_group:
534
 
            groups = self.get_groups_for_user(user)
535
 
            if groups.count() == 1:
536
 
                return groups.one()
537
 
            else:
538
 
                return None
539
 
        else:
540
 
            return user
541
 
 
542
 
    @property
543
 
    def is_group(self):
544
 
        return self.max_students_per_group is not None
545
 
 
546
 
    @property
547
 
    def assigned(self):
548
 
        """Get the entities (groups or users) assigned to submit this project.
549
 
 
550
 
        This will be a Storm ResultSet.
551
 
        """
552
 
        #If its a solo project, return everyone in offering
553
 
        if self.is_group:
554
 
            return self.project_groups
555
 
        else:
556
 
            return self.offering.students
557
 
 
558
 
class DeadlinePassed(Exception):
559
 
    """An exception indicating that a project cannot be submitted because the
560
 
    deadline has passed."""
561
 
    def __init__(self):
562
 
        pass
563
 
    def __str__(self):
564
 
        return "The project deadline has passed"
565
 
 
566
404
class Project(Storm):
567
 
    """A student project for which submissions can be made."""
568
 
 
569
405
    __storm_table__ = "project"
570
406
 
571
407
    id = Int(name="projectid", primary=True)
589
425
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
590
426
                                  self.project_set.offering)
591
427
 
592
 
    def can_submit(self, principal, user):
 
428
    def can_submit(self, principal):
593
429
        return (self in principal.get_projects() and
594
 
                not self.has_deadline_passed(user))
 
430
                self.deadline > datetime.datetime.now())
595
431
 
596
432
    def submit(self, principal, path, revision, who):
597
433
        """Submit a Subversion path and revision to a project.
598
434
 
599
 
        @param principal: The owner of the Subversion repository, and the
600
 
                          entity on behalf of whom the submission is being made
601
 
        @param path: A path within that repository to submit.
602
 
        @param revision: The revision of that path to submit.
603
 
        @param who: The user who is actually making the submission.
 
435
        'principal' is the owner of the Subversion repository, and the
 
436
        entity on behalf of whom the submission is being made. 'path' is
 
437
        a path within that repository, and 'revision' specifies which
 
438
        revision of that path. 'who' is the person making the submission.
604
439
        """
605
440
 
606
 
        if not self.can_submit(principal, who):
607
 
            raise DeadlinePassed()
 
441
        if not self.can_submit(principal):
 
442
            raise Exception('cannot submit')
608
443
 
609
444
        a = Assessed.get(Store.of(self), principal, self)
610
445
        ps = ProjectSubmission()
611
 
        # Raise SubmissionError if the path is illegal
612
 
        ps.path = ProjectSubmission.test_and_normalise_path(path)
 
446
        ps.path = path
613
447
        ps.revision = revision
614
448
        ps.date_submitted = datetime.datetime.now()
615
449
        ps.assessed = a
617
451
 
618
452
        return ps
619
453
 
620
 
    def get_permissions(self, user, config):
621
 
        return self.project_set.offering.get_permissions(user, config)
622
 
 
623
 
    @property
624
 
    def latest_submissions(self):
625
 
        """Return the latest submission for each Assessed."""
626
 
        return Store.of(self).find(ProjectSubmission,
627
 
            Assessed.project_id == self.id,
628
 
            ProjectSubmission.assessed_id == Assessed.id,
629
 
            ProjectSubmission.date_submitted == Select(
630
 
                    Max(ProjectSubmission.date_submitted),
631
 
                    ProjectSubmission.assessed_id == Assessed.id,
632
 
                    tables=ProjectSubmission
633
 
            )
634
 
        )
635
 
 
636
 
    def has_deadline_passed(self, user):
637
 
        """Check whether the deadline has passed."""
638
 
        # XXX: Need to respect extensions.
639
 
        return self.deadline < datetime.datetime.now()
640
 
 
641
 
    def get_submissions_for_principal(self, principal):
642
 
        """Fetch a ResultSet of all submissions by a particular principal."""
643
 
        assessed = Assessed.get(Store.of(self), principal, self)
644
 
        if assessed is None:
645
 
            return
646
 
        return assessed.submissions
647
 
 
648
 
 
649
454
 
650
455
class ProjectGroup(Storm):
651
 
    """A group of students working together on a project."""
652
 
 
653
456
    __storm_table__ = "project_group"
654
457
 
655
458
    id = Int(name="groupid", primary=True)
674
477
 
675
478
    @property
676
479
    def display_name(self):
677
 
        """Returns the "nice name" of the user or group."""
678
 
        return self.nick
679
 
 
680
 
    @property
681
 
    def short_name(self):
682
 
        """Returns the database "identifier" name of the user or group."""
683
 
        return self.name
 
480
        return '%s (%s)' % (self.nick, self.name)
684
481
 
685
482
    def get_projects(self, offering=None, active_only=True):
686
 
        '''Find projects that the group can submit.
 
483
        '''Return Projects that the group can submit.
687
484
 
688
485
        This will include projects in the project set which owns this group,
689
486
        unless the project set disallows groups (in which case none will be
690
487
        returned).
691
488
 
692
 
        @param active_only: Whether to only search active offerings.
693
 
        @param offering: An optional offering to restrict the search to.
 
489
        Unless active_only is False, projects will only be returned if the
 
490
        group's offering is active.
 
491
 
 
492
        If an offering is specified, projects will only be returned if it
 
493
        matches the group's.
694
494
        '''
695
495
        return Store.of(self).find(Project,
696
496
            Project.project_set_id == ProjectSet.id,
702
502
            (not active_only) or (Semester.state == u'current'))
703
503
 
704
504
 
705
 
    def get_permissions(self, user, config):
 
505
    def get_permissions(self, user):
706
506
        if user.admin or user in self.members:
707
507
            return set(['submit_project'])
708
508
        else:
709
509
            return set()
710
510
 
711
511
class ProjectGroupMembership(Storm):
712
 
    """A student's membership in a project group."""
713
 
 
714
512
    __storm_table__ = "group_member"
715
513
    __storm_primary__ = "user_id", "project_group_id"
716
514
 
726
524
                                  self.project_group)
727
525
 
728
526
class Assessed(Storm):
729
 
    """A composite of a user or group combined with a project.
730
 
 
731
 
    Each project submission and extension refers to an Assessed. It is the
732
 
    sole specifier of the repository and project.
733
 
    """
734
 
 
735
527
    __storm_table__ = "assessed"
736
528
 
737
529
    id = Int(name="assessedid", primary=True)
744
536
    project = Reference(project_id, Project.id)
745
537
 
746
538
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
747
 
    submissions = ReferenceSet(
748
 
        id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
 
539
    submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
749
540
 
750
541
    def __repr__(self):
751
542
        return "<%s %r in %r>" % (type(self).__name__,
752
543
            self.user or self.project_group, self.project)
753
544
 
754
 
    @property
755
 
    def is_group(self):
756
 
        """True if the Assessed is a group, False if it is a user."""
757
 
        return self.project_group is not None
758
 
 
759
 
    @property
760
 
    def principal(self):
761
 
        return self.project_group or self.user
762
 
 
763
 
    @property
764
 
    def checkout_location(self):
765
 
        """Returns the location of the Subversion workspace for this piece of
766
 
        assessment, relative to each group member's home directory."""
767
 
        subjectname = self.project.project_set.offering.subject.short_name
768
 
        if self.is_group:
769
 
            checkout_dir_name = self.principal.short_name
770
 
        else:
771
 
            checkout_dir_name = "mywork"
772
 
        return subjectname + "/" + checkout_dir_name
773
 
 
774
545
    @classmethod
775
546
    def get(cls, store, principal, project):
776
 
        """Find or create an Assessed for the given user or group and project.
777
 
 
778
 
        @param principal: The user or group.
779
 
        @param project: The project.
780
 
        """
781
547
        t = type(principal)
782
548
        if t not in (User, ProjectGroup):
783
549
            raise AssertionError('principal must be User or ProjectGroup')
785
551
        a = store.find(cls,
786
552
            (t is User) or (cls.project_group_id == principal.id),
787
553
            (t is ProjectGroup) or (cls.user_id == principal.id),
788
 
            cls.project_id == project.id).one()
 
554
            Project.id == project.id).one()
789
555
 
790
556
        if a is None:
791
557
            a = cls()
800
566
 
801
567
 
802
568
class ProjectExtension(Storm):
803
 
    """An extension granted to a user or group on a particular project.
804
 
 
805
 
    The user or group and project are specified by the Assessed.
806
 
    """
807
 
 
808
569
    __storm_table__ = "project_extension"
809
570
 
810
571
    id = Int(name="extensionid", primary=True)
815
576
    approver = Reference(approver_id, User.id)
816
577
    notes = Unicode()
817
578
 
818
 
class SubmissionError(Exception):
819
 
    """Denotes a validation error during submission."""
820
 
    pass
821
 
 
822
579
class ProjectSubmission(Storm):
823
 
    """A submission from a user or group repository to a particular project.
824
 
 
825
 
    The content of a submission is a single path and revision inside a
826
 
    repository. The repository is that owned by the submission's user and
827
 
    group, while the path and revision are explicit.
828
 
 
829
 
    The user or group and project are specified by the Assessed.
830
 
    """
831
 
 
832
580
    __storm_table__ = "project_submission"
833
581
 
834
582
    id = Int(name="submissionid", primary=True)
840
588
    submitter = Reference(submitter_id, User.id)
841
589
    date_submitted = DateTime()
842
590
 
843
 
    def get_verify_url(self, user):
844
 
        """Get the URL for verifying this submission, within the account of
845
 
        the given user."""
846
 
        # If this is a solo project, then self.path will be prefixed with the
847
 
        # subject name. Remove the first path segment.
848
 
        submitpath = self.path[1:] if self.path[:1] == '/' else self.path
849
 
        if not self.assessed.is_group:
850
 
            if '/' in submitpath:
851
 
                submitpath = submitpath.split('/', 1)[1]
852
 
            else:
853
 
                submitpath = ''
854
 
        return "/files/%s/%s/%s?r=%d" % (user.login,
855
 
            self.assessed.checkout_location, submitpath, self.revision)
856
 
 
857
 
    @staticmethod
858
 
    def test_and_normalise_path(path):
859
 
        """Test that path is valid, and normalise it. This prevents possible
860
 
        injections using malicious paths.
861
 
        Returns the updated path, if successful.
862
 
        Raises SubmissionError if invalid.
863
 
        """
864
 
        # Ensure the path is absolute to prevent being tacked onto working
865
 
        # directories.
866
 
        # Prevent '\n' because it will break all sorts of things.
867
 
        # Prevent '[' and ']' because they can be used to inject into the
868
 
        # svn.conf.
869
 
        # Normalise to avoid resulting in ".." path segments.
870
 
        if not os.path.isabs(path):
871
 
            raise SubmissionError("Path is not absolute")
872
 
        if any(c in path for c in "\n[]"):
873
 
            raise SubmissionError("Path must not contain '\\n', '[' or ']'")
874
 
        return os.path.normpath(path)
875
591
 
876
592
# WORKSHEETS AND EXERCISES #
877
593
 
878
594
class Exercise(Storm):
879
 
    """An exercise for students to complete in a worksheet.
880
 
 
881
 
    An exercise may be present in any number of worksheets.
882
 
    """
883
 
 
884
595
    __storm_table__ = "exercise"
885
596
    id = Unicode(primary=True, name="identifier")
886
597
    name = Unicode()
898
609
        'WorksheetExercise.worksheet_id',
899
610
        'Worksheet.id'
900
611
    )
901
 
 
 
612
    
902
613
    test_suites = ReferenceSet(id, 
903
614
        'TestSuite.exercise_id',
904
615
        order_by='seq_no')
908
619
    def __repr__(self):
909
620
        return "<%s %s>" % (type(self).__name__, self.name)
910
621
 
911
 
    def get_permissions(self, user, config):
912
 
        return self.global_permissions(user, config)
913
 
 
914
 
    @staticmethod
915
 
    def global_permissions(user, config):
916
 
        """Gets the set of permissions this user has over *all* exercises.
917
 
        This is used to determine who may view the exercises list, and create
918
 
        new exercises."""
 
622
    def get_permissions(self, user):
919
623
        perms = set()
920
624
        roles = set()
921
625
        if user is not None:
922
626
            if user.admin:
923
627
                perms.add('edit')
924
628
                perms.add('view')
925
 
            elif u'lecturer' in set((e.role for e in user.active_enrolments)):
926
 
                perms.add('edit')
927
 
                perms.add('view')
928
 
            elif (config['policy']['tutors_can_edit_worksheets']
929
 
            and u'tutor' in set((e.role for e in user.active_enrolments))):
930
 
                # Site-specific policy on the role of tutors
931
 
                perms.add('edit')
932
 
                perms.add('view')
933
 
 
 
629
            elif 'lecturer' in set((e.role for e in user.active_enrolments)):
 
630
                perms.add('edit')
 
631
                perms.add('view')
 
632
            
934
633
        return perms
935
 
 
 
634
    
936
635
    def get_description(self):
937
 
        """Return the description interpreted as reStructuredText."""
938
636
        return rst(self.description)
939
637
 
940
638
    def delete(self):
946
644
        Store.of(self).remove(self)
947
645
 
948
646
class Worksheet(Storm):
949
 
    """A worksheet with exercises for students to complete.
950
 
 
951
 
    Worksheets are owned by offerings.
952
 
    """
953
 
 
954
647
    __storm_table__ = "worksheet"
955
648
 
956
649
    id = Int(primary=True, name="worksheetid")
982
675
        return "<%s %s>" % (type(self).__name__, self.name)
983
676
 
984
677
    def remove_all_exercises(self):
985
 
        """Remove all exercises from this worksheet.
986
 
 
 
678
        """
 
679
        Remove all exercises from this worksheet.
987
680
        This does not delete the exercises themselves. It just removes them
988
681
        from the worksheet.
989
682
        """
993
686
                raise IntegrityError()
994
687
        store.find(WorksheetExercise,
995
688
            WorksheetExercise.worksheet == self).remove()
996
 
 
997
 
    def get_permissions(self, user, config):
998
 
        # Almost the same permissions as for the offering itself
999
 
        perms = self.offering.get_permissions(user, config)
1000
 
        # However, "edit" permission is derived from the "edit_worksheets"
1001
 
        # permission of the offering
1002
 
        if 'edit_worksheets' in perms:
1003
 
            perms.add('edit')
1004
 
        else:
1005
 
            perms.discard('edit')
1006
 
        return perms
1007
 
 
 
689
            
 
690
    def get_permissions(self, user):
 
691
        return self.offering.get_permissions(user)
 
692
    
1008
693
    def get_xml(self):
1009
694
        """Returns the xml of this worksheet, converts from rst if required."""
1010
695
        if self.format == u'rst':
1012
697
            return ws_xml
1013
698
        else:
1014
699
            return self.data
1015
 
 
 
700
    
1016
701
    def delete(self):
1017
702
        """Deletes the worksheet, provided it has no attempts on any exercises.
1018
 
 
 
703
        
1019
704
        Returns True if delete succeeded, or False if this worksheet has
1020
705
        attempts attached."""
1021
706
        for ws_ex in self.all_worksheet_exercises:
1022
707
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1023
708
                raise IntegrityError()
1024
 
 
 
709
        
1025
710
        self.remove_all_exercises()
1026
711
        Store.of(self).remove(self)
1027
 
 
 
712
        
1028
713
class WorksheetExercise(Storm):
1029
 
    """A link between a worksheet and one of its exercises.
1030
 
 
1031
 
    These may be marked optional, in which case the exercise does not count
1032
 
    for marking purposes. The sequence number is used to order the worksheet
1033
 
    ToC.
1034
 
    """
1035
 
 
1036
714
    __storm_table__ = "worksheet_exercise"
1037
 
 
 
715
    
1038
716
    id = Int(primary=True, name="ws_ex_id")
1039
717
 
1040
718
    worksheet_id = Int(name="worksheetid")
1044
722
    optional = Bool()
1045
723
    active = Bool()
1046
724
    seq_no = Int()
1047
 
 
 
725
    
1048
726
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
1049
727
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
1050
728
 
1054
732
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1055
733
                                  self.worksheet.identifier)
1056
734
 
1057
 
    def get_permissions(self, user, config):
1058
 
        return self.worksheet.get_permissions(user, config)
1059
 
 
 
735
    def get_permissions(self, user):
 
736
        return self.worksheet.get_permissions(user)
 
737
    
1060
738
 
1061
739
class ExerciseSave(Storm):
1062
 
    """A potential exercise solution submitted by a user for storage.
1063
 
 
1064
 
    This is not an actual tested attempt at an exercise, it's just a save of
1065
 
    the editing session.
1066
 
    """
1067
 
 
 
740
    """
 
741
    Represents a potential solution to an exercise that a user has submitted
 
742
    to the server for storage.
 
743
    A basic ExerciseSave is just the current saved text for this exercise for
 
744
    this user (doesn't count towards their attempts).
 
745
    ExerciseSave may be extended with additional semantics (such as
 
746
    ExerciseAttempt).
 
747
    """
1068
748
    __storm_table__ = "exercise_save"
1069
749
    __storm_primary__ = "ws_ex_id", "user_id"
1070
750
 
1083
763
            self.exercise.name, self.user.login, self.date.strftime("%c"))
1084
764
 
1085
765
class ExerciseAttempt(ExerciseSave):
1086
 
    """An attempt at solving an exercise.
1087
 
 
1088
 
    This is a special case of ExerciseSave, used when the user submits a
1089
 
    candidate solution. Like an ExerciseSave, it constitutes exercise solution
1090
 
    data.
1091
 
 
1092
 
    In addition, it contains information about the result of the submission:
1093
 
 
1094
 
     - complete - True if this submission was successful, rendering this
1095
 
                  exercise complete for this user in this worksheet.
1096
 
     - active   - True if this submission is "active" (usually true).
1097
 
                  Submissions may be de-activated by privileged users for
1098
 
                  special reasons, and then they won't count (either as a
1099
 
                  penalty or success), but will still be stored.
1100
 
    """
1101
 
 
 
766
    """
 
767
    An ExerciseAttempt is a special case of an ExerciseSave. Like an
 
768
    ExerciseSave, it constitutes exercise solution data that the user has
 
769
    submitted to the server for storage.
 
770
    In addition, it contains additional information about the submission.
 
771
    complete - True if this submission was successful, rendering this exercise
 
772
        complete for this user.
 
773
    active - True if this submission is "active" (usually true). Submissions
 
774
        may be de-activated by privileged users for special reasons, and then
 
775
        they won't count (either as a penalty or success), but will still be
 
776
        stored.
 
777
    """
1102
778
    __storm_table__ = "exercise_attempt"
1103
779
    __storm_primary__ = "ws_ex_id", "user_id", "date"
1104
780
 
1107
783
    text = Unicode(name="attempt")
1108
784
    complete = Bool()
1109
785
    active = Bool()
1110
 
 
1111
 
    def get_permissions(self, user, config):
 
786
    
 
787
    def get_permissions(self, user):
1112
788
        return set(['view']) if user is self.user else set()
1113
 
 
 
789
  
1114
790
class TestSuite(Storm):
1115
 
    """A container to group an exercise's test cases.
1116
 
 
1117
 
    The test suite contains some information on how to test. The function to
1118
 
    test, variables to set and stdin data are stored here.
1119
 
    """
1120
 
 
 
791
    """A Testsuite acts as a container for the test cases of an exercise."""
1121
792
    __storm_table__ = "test_suite"
1122
793
    __storm_primary__ = "exercise_id", "suiteid"
1123
 
 
 
794
    
1124
795
    suiteid = Int()
1125
796
    exercise_id = Unicode(name="exerciseid")
1126
797
    description = Unicode()
1130
801
    exercise = Reference(exercise_id, Exercise.id)
1131
802
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1132
803
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1133
 
 
 
804
    
1134
805
    def delete(self):
1135
806
        """Delete this suite, without asking questions."""
1136
 
        for variable in self.variables:
 
807
        for vaariable in self.variables:
1137
808
            variable.delete()
1138
809
        for test_case in self.test_cases:
1139
810
            test_case.delete()
1140
811
        Store.of(self).remove(self)
1141
812
 
1142
813
class TestCase(Storm):
1143
 
    """A container for actual tests (see TestCasePart), inside a test suite.
1144
 
 
1145
 
    It is the lowest level shown to students on their pass/fail status."""
1146
 
 
 
814
    """A TestCase is a member of a TestSuite.
 
815
    
 
816
    It contains the data necessary to check if an exercise is correct"""
1147
817
    __storm_table__ = "test_case"
1148
818
    __storm_primary__ = "testid", "suiteid"
1149
 
 
 
819
    
1150
820
    testid = Int()
1151
821
    suiteid = Int()
1152
822
    suite = Reference(suiteid, "TestSuite.suiteid")
1153
823
    passmsg = Unicode()
1154
824
    failmsg = Unicode()
1155
 
    test_default = Unicode() # Currently unused - only used for file matching.
 
825
    test_default = Unicode()
1156
826
    seq_no = Int()
1157
 
 
 
827
    
1158
828
    parts = ReferenceSet(testid, "TestCasePart.testid")
1159
 
 
 
829
    
1160
830
    __init__ = _kwarg_init
1161
 
 
 
831
    
1162
832
    def delete(self):
1163
833
        for part in self.parts:
1164
834
            part.delete()
1165
835
        Store.of(self).remove(self)
1166
836
 
1167
837
class TestSuiteVar(Storm):
1168
 
    """A variable used by an exercise test suite.
1169
 
 
1170
 
    This may represent a function argument or a normal variable.
1171
 
    """
1172
 
 
 
838
    """A container for the arguments of a Test Suite"""
1173
839
    __storm_table__ = "suite_variable"
1174
840
    __storm_primary__ = "varid"
1175
 
 
 
841
    
1176
842
    varid = Int()
1177
843
    suiteid = Int()
1178
844
    var_name = Unicode()
1179
845
    var_value = Unicode()
1180
846
    var_type = Unicode()
1181
847
    arg_no = Int()
1182
 
 
 
848
    
1183
849
    suite = Reference(suiteid, "TestSuite.suiteid")
1184
 
 
 
850
    
1185
851
    __init__ = _kwarg_init
1186
 
 
 
852
    
1187
853
    def delete(self):
1188
854
        Store.of(self).remove(self)
1189
 
 
 
855
    
1190
856
class TestCasePart(Storm):
1191
 
    """An actual piece of code to test an exercise solution."""
1192
 
 
 
857
    """A container for the test elements of a Test Case"""
1193
858
    __storm_table__ = "test_case_part"
1194
859
    __storm_primary__ = "partid"
1195
 
 
 
860
    
1196
861
    partid = Int()
1197
862
    testid = Int()
1198
 
 
 
863
    
1199
864
    part_type = Unicode()
1200
865
    test_type = Unicode()
1201
866
    data = Unicode()
1202
867
    filename = Unicode()
1203
 
 
 
868
    
1204
869
    test = Reference(testid, "TestCase.testid")
1205
 
 
 
870
    
1206
871
    __init__ = _kwarg_init
1207
 
 
 
872
    
1208
873
    def delete(self):
1209
874
        Store.of(self).remove(self)