~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-28 06:02:41 UTC
  • Revision ID: grantw@unimelb.edu.au-20090428060241-t4gnwl35maukfvfg
Move ivle.conf.mimetypes to ivle.mimetypes, and rename things in it.

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.
28
29
 
29
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
30
31
                         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
 
    """An IVLE user account."""
 
83
    """
 
84
    Represents an IVLE user.
 
85
    """
84
86
    __storm_table__ = "login"
85
87
 
86
88
    id = Int(primary=True, name="loginid")
117
119
 
118
120
    @property
119
121
    def display_name(self):
120
 
        """Returns the "nice name" of the user or group."""
121
122
        return self.fullname
122
123
 
123
124
    @property
124
 
    def short_name(self):
125
 
        """Returns the database "identifier" name of the user or group."""
126
 
        return self.login
127
 
 
128
 
    @property
129
125
    def password_expired(self):
130
126
        fieldval = self.pass_exp
131
127
        return fieldval is not None and datetime.datetime.now() > fieldval
168
164
 
169
165
    # TODO: Invitations should be listed too?
170
166
    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
 
        """
175
167
        preds = [
176
168
            ProjectGroupMembership.user_id == self.id,
177
169
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
198
190
        return self._get_enrolments(False) 
199
191
 
200
192
    def get_projects(self, offering=None, active_only=True):
201
 
        """Find projects that the user can submit.
 
193
        '''Return Projects that the user can submit.
202
194
 
203
195
        This will include projects for offerings in which the user is
204
196
        enrolled, as long as the project is not in a project set which has
205
197
        groups (ie. if maximum number of group members is 0).
206
198
 
207
 
        @param active_only: Whether to only search active offerings.
208
 
        @param offering: An optional offering to restrict the search to.
209
 
        """
 
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
        '''
210
205
        return Store.of(self).find(Project,
211
206
            Project.project_set_id == ProjectSet.id,
212
207
            ProjectSet.max_students_per_group == None,
215
210
            Semester.id == Offering.semester_id,
216
211
            (not active_only) or (Semester.state == u'current'),
217
212
            Enrolment.offering_id == Offering.id,
218
 
            Enrolment.user_id == self.id,
219
 
            Enrolment.active == True)
 
213
            Enrolment.user_id == self.id)
220
214
 
221
215
    @staticmethod
222
216
    def hash_password(password):
223
 
        """Hash a password with MD5."""
224
217
        return hashlib.md5(password).hexdigest()
225
218
 
226
219
    @classmethod
227
220
    def get_by_login(cls, store, login):
228
 
        """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
        """
229
225
        return store.find(cls, cls.login == unicode(login)).one()
230
226
 
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
 
        """
 
227
    def get_permissions(self, user):
237
228
        if user and user.admin or user is self:
238
 
            return set(['view_public', 'view', 'edit', 'submit_project'])
 
229
            return set(['view', 'edit', 'submit_project'])
239
230
        else:
240
 
            return set(['view_public'])
 
231
            return set()
241
232
 
242
233
# SUBJECTS AND ENROLMENTS #
243
234
 
244
235
class Subject(Storm):
245
 
    """A subject (or course) which is run in some semesters."""
246
 
 
247
236
    __storm_table__ = "subject"
248
237
 
249
238
    id = Int(primary=True, name="subjectid")
250
239
    code = Unicode(name="subj_code")
251
240
    name = Unicode(name="subj_name")
252
241
    short_name = Unicode(name="subj_short_name")
 
242
    url = Unicode()
253
243
 
254
244
    offerings = ReferenceSet(id, 'Offering.subject_id')
255
245
 
258
248
    def __repr__(self):
259
249
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
260
250
 
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
 
        """
 
251
    def get_permissions(self, user):
267
252
        perms = set()
268
253
        if user is not None:
269
254
            perms.add('view')
272
257
        return perms
273
258
 
274
259
    def active_offerings(self):
275
 
        """Find active offerings for this subject.
276
 
 
277
 
        Return a sequence of currently active offerings for this subject
 
260
        """Return a sequence of currently active offerings for this subject
278
261
        (offerings whose semester.state is "current"). There should be 0 or 1
279
262
        elements in this sequence, but it's possible there are more.
280
263
        """
282
265
                                   Semester.state == u'current')
283
266
 
284
267
    def offering_for_semester(self, year, semester):
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
 
        """
 
268
        """Get the offering for the given year/semester, or None."""
290
269
        return self.offerings.find(Offering.semester_id == Semester.id,
291
270
                               Semester.year == unicode(year),
292
271
                               Semester.semester == unicode(semester)).one()
293
272
 
294
273
class Semester(Storm):
295
 
    """A semester in which subjects can be run."""
296
 
 
297
274
    __storm_table__ = "semester"
298
275
 
299
276
    id = Int(primary=True, name="semesterid")
313
290
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
314
291
 
315
292
class Offering(Storm):
316
 
    """An offering of a subject in a particular semester."""
317
 
 
318
293
    __storm_table__ = "offering"
319
294
 
320
295
    id = Int(primary=True, name="offeringid")
322
297
    subject = Reference(subject_id, Subject.id)
323
298
    semester_id = Int(name="semesterid")
324
299
    semester = Reference(semester_id, Semester.id)
325
 
    description = Unicode()
326
 
    url = Unicode()
327
300
    groups_student_permissions = Unicode()
328
301
 
329
302
    enrolments = ReferenceSet(id, 'Enrolment.offering_id')
332
305
                           'Enrolment.user_id',
333
306
                           'User.id')
334
307
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
335
 
    projects = ReferenceSet(id,
336
 
                            'ProjectSet.offering_id',
337
 
                            'ProjectSet.id',
338
 
                            'Project.project_set_id')
339
308
 
340
309
    worksheets = ReferenceSet(id, 
341
310
        'Worksheet.offering_id', 
349
318
                                  self.semester)
350
319
 
351
320
    def enrol(self, user, role=u'student'):
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
 
        """
 
321
        '''Enrol a user in this offering.'''
357
322
        enrolment = Store.of(self).find(Enrolment,
358
323
                               Enrolment.user_id == user.id,
359
324
                               Enrolment.offering_id == self.id).one()
372
337
                               Enrolment.offering_id == self.id).one()
373
338
        Store.of(enrolment).remove(enrolment)
374
339
 
375
 
    def get_permissions(self, user, config):
 
340
    def get_permissions(self, user):
376
341
        perms = set()
377
342
        if user is not None:
378
343
            enrolment = self.get_enrolment(user)
379
344
            if enrolment or user.admin:
380
345
                perms.add('view')
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
 
346
            if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
 
347
               or user.admin:
 
348
                perms.add('edit')
401
349
        return perms
402
350
 
403
351
    def get_enrolment(self, user):
404
 
        """Find the user's enrolment in this offering."""
405
352
        try:
406
353
            enrolment = self.enrolments.find(user=user).one()
407
354
        except NotOneError:
409
356
 
410
357
        return enrolment
411
358
 
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
 
 
444
359
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
 
 
450
360
    __storm_table__ = "enrolment"
451
361
    __storm_primary__ = "user_id", "offering_id"
452
362
 
472
382
        return "<%s %r in %r>" % (type(self).__name__, self.user,
473
383
                                  self.offering)
474
384
 
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
 
 
488
385
# PROJECTS #
489
386
 
490
387
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
 
 
497
388
    __storm_table__ = "project_set"
498
389
 
499
390
    id = Int(name="projectsetid", primary=True)
510
401
        return "<%s %d in %r>" % (type(self).__name__, self.id,
511
402
                                  self.offering)
512
403
 
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
 
 
565
404
class Project(Storm):
566
 
    """A student project for which submissions can be made."""
567
 
 
568
405
    __storm_table__ = "project"
569
406
 
570
407
    id = Int(name="projectid", primary=True)
588
425
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
589
426
                                  self.project_set.offering)
590
427
 
591
 
    def can_submit(self, principal, user):
 
428
    def can_submit(self, principal):
592
429
        return (self in principal.get_projects() and
593
 
                not self.has_deadline_passed(user))
 
430
                self.deadline > datetime.datetime.now())
594
431
 
595
432
    def submit(self, principal, path, revision, who):
596
433
        """Submit a Subversion path and revision to a project.
597
434
 
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.
 
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.
603
439
        """
604
440
 
605
 
        if not self.can_submit(principal, who):
606
 
            raise DeadlinePassed()
 
441
        if not self.can_submit(principal):
 
442
            raise Exception('cannot submit')
607
443
 
608
444
        a = Assessed.get(Store.of(self), principal, self)
609
445
        ps = ProjectSubmission()
615
451
 
616
452
        return ps
617
453
 
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
 
 
647
454
 
648
455
class ProjectGroup(Storm):
649
 
    """A group of students working together on a project."""
650
 
 
651
456
    __storm_table__ = "project_group"
652
457
 
653
458
    id = Int(name="groupid", primary=True)
672
477
 
673
478
    @property
674
479
    def display_name(self):
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
 
480
        return '%s (%s)' % (self.nick, self.name)
682
481
 
683
482
    def get_projects(self, offering=None, active_only=True):
684
 
        '''Find projects that the group can submit.
 
483
        '''Return Projects that the group can submit.
685
484
 
686
485
        This will include projects in the project set which owns this group,
687
486
        unless the project set disallows groups (in which case none will be
688
487
        returned).
689
488
 
690
 
        @param active_only: Whether to only search active offerings.
691
 
        @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.
692
494
        '''
693
495
        return Store.of(self).find(Project,
694
496
            Project.project_set_id == ProjectSet.id,
700
502
            (not active_only) or (Semester.state == u'current'))
701
503
 
702
504
 
703
 
    def get_permissions(self, user, config):
 
505
    def get_permissions(self, user):
704
506
        if user.admin or user in self.members:
705
507
            return set(['submit_project'])
706
508
        else:
707
509
            return set()
708
510
 
709
511
class ProjectGroupMembership(Storm):
710
 
    """A student's membership in a project group."""
711
 
 
712
512
    __storm_table__ = "group_member"
713
513
    __storm_primary__ = "user_id", "project_group_id"
714
514
 
724
524
                                  self.project_group)
725
525
 
726
526
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
 
 
733
527
    __storm_table__ = "assessed"
734
528
 
735
529
    id = Int(name="assessedid", primary=True)
742
536
    project = Reference(project_id, Project.id)
743
537
 
744
538
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
745
 
    submissions = ReferenceSet(
746
 
        id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
 
539
    submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
747
540
 
748
541
    def __repr__(self):
749
542
        return "<%s %r in %r>" % (type(self).__name__,
750
543
            self.user or self.project_group, self.project)
751
544
 
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
 
 
772
545
    @classmethod
773
546
    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
 
        """
779
547
        t = type(principal)
780
548
        if t not in (User, ProjectGroup):
781
549
            raise AssertionError('principal must be User or ProjectGroup')
783
551
        a = store.find(cls,
784
552
            (t is User) or (cls.project_group_id == principal.id),
785
553
            (t is ProjectGroup) or (cls.user_id == principal.id),
786
 
            cls.project_id == project.id).one()
 
554
            Project.id == project.id).one()
787
555
 
788
556
        if a is None:
789
557
            a = cls()
798
566
 
799
567
 
800
568
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
 
 
806
569
    __storm_table__ = "project_extension"
807
570
 
808
571
    id = Int(name="extensionid", primary=True)
814
577
    notes = Unicode()
815
578
 
816
579
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
 
 
826
580
    __storm_table__ = "project_submission"
827
581
 
828
582
    id = Int(name="submissionid", primary=True)
834
588
    submitter = Reference(submitter_id, User.id)
835
589
    date_submitted = DateTime()
836
590
 
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)
850
591
 
851
592
# WORKSHEETS AND EXERCISES #
852
593
 
853
594
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
 
 
859
595
    __storm_table__ = "exercise"
860
596
    id = Unicode(primary=True, name="identifier")
861
597
    name = Unicode()
873
609
        'WorksheetExercise.worksheet_id',
874
610
        'Worksheet.id'
875
611
    )
876
 
 
 
612
    
877
613
    test_suites = ReferenceSet(id, 
878
614
        'TestSuite.exercise_id',
879
615
        order_by='seq_no')
883
619
    def __repr__(self):
884
620
        return "<%s %s>" % (type(self).__name__, self.name)
885
621
 
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."""
 
622
    def get_permissions(self, user):
894
623
        perms = set()
895
624
        roles = set()
896
625
        if user is not None:
897
626
            if user.admin:
898
627
                perms.add('edit')
899
628
                perms.add('view')
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
 
 
 
629
            elif 'lecturer' in set((e.role for e in user.active_enrolments)):
 
630
                perms.add('edit')
 
631
                perms.add('view')
 
632
            
909
633
        return perms
910
 
 
 
634
    
911
635
    def get_description(self):
912
 
        """Return the description interpreted as reStructuredText."""
913
636
        return rst(self.description)
914
637
 
915
638
    def delete(self):
921
644
        Store.of(self).remove(self)
922
645
 
923
646
class Worksheet(Storm):
924
 
    """A worksheet with exercises for students to complete.
925
 
 
926
 
    Worksheets are owned by offerings.
927
 
    """
928
 
 
929
647
    __storm_table__ = "worksheet"
930
648
 
931
649
    id = Int(primary=True, name="worksheetid")
957
675
        return "<%s %s>" % (type(self).__name__, self.name)
958
676
 
959
677
    def remove_all_exercises(self):
960
 
        """Remove all exercises from this worksheet.
961
 
 
 
678
        """
 
679
        Remove all exercises from this worksheet.
962
680
        This does not delete the exercises themselves. It just removes them
963
681
        from the worksheet.
964
682
        """
968
686
                raise IntegrityError()
969
687
        store.find(WorksheetExercise,
970
688
            WorksheetExercise.worksheet == self).remove()
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
 
 
 
689
            
 
690
    def get_permissions(self, user):
 
691
        return self.offering.get_permissions(user)
 
692
    
983
693
    def get_xml(self):
984
694
        """Returns the xml of this worksheet, converts from rst if required."""
985
695
        if self.format == u'rst':
987
697
            return ws_xml
988
698
        else:
989
699
            return self.data
990
 
 
 
700
    
991
701
    def delete(self):
992
702
        """Deletes the worksheet, provided it has no attempts on any exercises.
993
 
 
 
703
        
994
704
        Returns True if delete succeeded, or False if this worksheet has
995
705
        attempts attached."""
996
706
        for ws_ex in self.all_worksheet_exercises:
997
707
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
998
708
                raise IntegrityError()
999
 
 
 
709
        
1000
710
        self.remove_all_exercises()
1001
711
        Store.of(self).remove(self)
1002
 
 
 
712
        
1003
713
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
 
 
1011
714
    __storm_table__ = "worksheet_exercise"
1012
 
 
 
715
    
1013
716
    id = Int(primary=True, name="ws_ex_id")
1014
717
 
1015
718
    worksheet_id = Int(name="worksheetid")
1019
722
    optional = Bool()
1020
723
    active = Bool()
1021
724
    seq_no = Int()
1022
 
 
 
725
    
1023
726
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
1024
727
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
1025
728
 
1029
732
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1030
733
                                  self.worksheet.identifier)
1031
734
 
1032
 
    def get_permissions(self, user, config):
1033
 
        return self.worksheet.get_permissions(user, config)
1034
 
 
 
735
    def get_permissions(self, user):
 
736
        return self.worksheet.get_permissions(user)
 
737
    
1035
738
 
1036
739
class ExerciseSave(Storm):
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
 
 
 
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
    """
1043
748
    __storm_table__ = "exercise_save"
1044
749
    __storm_primary__ = "ws_ex_id", "user_id"
1045
750
 
1058
763
            self.exercise.name, self.user.login, self.date.strftime("%c"))
1059
764
 
1060
765
class ExerciseAttempt(ExerciseSave):
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
 
 
 
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
    """
1077
778
    __storm_table__ = "exercise_attempt"
1078
779
    __storm_primary__ = "ws_ex_id", "user_id", "date"
1079
780
 
1082
783
    text = Unicode(name="attempt")
1083
784
    complete = Bool()
1084
785
    active = Bool()
1085
 
 
1086
 
    def get_permissions(self, user, config):
 
786
    
 
787
    def get_permissions(self, user):
1087
788
        return set(['view']) if user is self.user else set()
1088
 
 
 
789
  
1089
790
class TestSuite(Storm):
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
 
 
 
791
    """A Testsuite acts as a container for the test cases of an exercise."""
1096
792
    __storm_table__ = "test_suite"
1097
793
    __storm_primary__ = "exercise_id", "suiteid"
1098
 
 
 
794
    
1099
795
    suiteid = Int()
1100
796
    exercise_id = Unicode(name="exerciseid")
1101
797
    description = Unicode()
1105
801
    exercise = Reference(exercise_id, Exercise.id)
1106
802
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1107
803
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1108
 
 
 
804
    
1109
805
    def delete(self):
1110
806
        """Delete this suite, without asking questions."""
1111
 
        for variable in self.variables:
 
807
        for vaariable in self.variables:
1112
808
            variable.delete()
1113
809
        for test_case in self.test_cases:
1114
810
            test_case.delete()
1115
811
        Store.of(self).remove(self)
1116
812
 
1117
813
class TestCase(Storm):
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
 
 
 
814
    """A TestCase is a member of a TestSuite.
 
815
    
 
816
    It contains the data necessary to check if an exercise is correct"""
1122
817
    __storm_table__ = "test_case"
1123
818
    __storm_primary__ = "testid", "suiteid"
1124
 
 
 
819
    
1125
820
    testid = Int()
1126
821
    suiteid = Int()
1127
822
    suite = Reference(suiteid, "TestSuite.suiteid")
1128
823
    passmsg = Unicode()
1129
824
    failmsg = Unicode()
1130
 
    test_default = Unicode() # Currently unused - only used for file matching.
 
825
    test_default = Unicode()
1131
826
    seq_no = Int()
1132
 
 
 
827
    
1133
828
    parts = ReferenceSet(testid, "TestCasePart.testid")
1134
 
 
 
829
    
1135
830
    __init__ = _kwarg_init
1136
 
 
 
831
    
1137
832
    def delete(self):
1138
833
        for part in self.parts:
1139
834
            part.delete()
1140
835
        Store.of(self).remove(self)
1141
836
 
1142
837
class TestSuiteVar(Storm):
1143
 
    """A variable used by an exercise test suite.
1144
 
 
1145
 
    This may represent a function argument or a normal variable.
1146
 
    """
1147
 
 
 
838
    """A container for the arguments of a Test Suite"""
1148
839
    __storm_table__ = "suite_variable"
1149
840
    __storm_primary__ = "varid"
1150
 
 
 
841
    
1151
842
    varid = Int()
1152
843
    suiteid = Int()
1153
844
    var_name = Unicode()
1154
845
    var_value = Unicode()
1155
846
    var_type = Unicode()
1156
847
    arg_no = Int()
1157
 
 
 
848
    
1158
849
    suite = Reference(suiteid, "TestSuite.suiteid")
1159
 
 
 
850
    
1160
851
    __init__ = _kwarg_init
1161
 
 
 
852
    
1162
853
    def delete(self):
1163
854
        Store.of(self).remove(self)
1164
 
 
 
855
    
1165
856
class TestCasePart(Storm):
1166
 
    """An actual piece of code to test an exercise solution."""
1167
 
 
 
857
    """A container for the test elements of a Test Case"""
1168
858
    __storm_table__ = "test_case_part"
1169
859
    __storm_primary__ = "partid"
1170
 
 
 
860
    
1171
861
    partid = Int()
1172
862
    testid = Int()
1173
 
 
 
863
    
1174
864
    part_type = Unicode()
1175
865
    test_type = Unicode()
1176
866
    data = Unicode()
1177
867
    filename = Unicode()
1178
 
 
 
868
    
1179
869
    test = Reference(testid, "TestCase.testid")
1180
 
 
 
870
    
1181
871
    __init__ = _kwarg_init
1182
 
 
 
872
    
1183
873
    def delete(self):
1184
874
        Store.of(self).remove(self)