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

« back to all changes in this revision

Viewing changes to ivle/database.py

  • Committer: William Grant
  • Date: 2010-02-18 06:43:57 UTC
  • Revision ID: grantw@unimelb.edu.au-20100218064357-a43eajvau1gpzw29
Add ivle.tests, move ivle.test_chat into there, and be slightly more idiomatic.

Show diffs side-by-side

added added

removed removed

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