~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-15 09:15:14 UTC
  • Revision ID: grantw@unimelb.edu.au-20100215091514-gexaupx4e6ref0tm
Sort subjects and semesters sanely in the offering new form too.

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
 
import ivle.conf
35
34
from ivle.worksheet.rst import rst
36
35
 
37
36
__all__ = ['get_store',
51
50
                % (self.__class__.__name__, k))
52
51
        setattr(self, k, v)
53
52
 
54
 
def get_conn_string():
55
 
    """
56
 
    Returns the Storm connection string, generated from the conf file.
 
53
def get_conn_string(config):
 
54
    """Create a Storm connection string to the IVLE database
 
55
 
 
56
    @param config: The IVLE configuration.
57
57
    """
58
58
 
59
59
    clusterstr = ''
60
 
    if ivle.conf.db_user:
61
 
        clusterstr += ivle.conf.db_user
62
 
        if ivle.conf.db_password:
63
 
            clusterstr += ':' + ivle.conf.db_password
 
60
    if config['database']['username']:
 
61
        clusterstr += config['database']['username']
 
62
        if config['database']['password']:
 
63
            clusterstr += ':' + config['database']['password']
64
64
        clusterstr += '@'
65
65
 
66
 
    host = ivle.conf.db_host or 'localhost'
67
 
    port = ivle.conf.db_port or 5432
 
66
    host = config['database']['host'] or 'localhost'
 
67
    port = config['database']['port'] or 5432
68
68
 
69
69
    clusterstr += '%s:%d' % (host, port)
70
70
 
71
 
    return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
72
 
 
73
 
def get_store():
74
 
    """
75
 
    Open a database connection and transaction. Return a storm.store.Store
76
 
    instance connected to the configured IVLE database.
77
 
    """
78
 
    return Store(create_database(get_conn_string()))
 
71
    return "postgres://%s/%s" % (clusterstr, config['database']['name'])
 
72
 
 
73
def get_store(config):
 
74
    """Create a Storm store connected to the IVLE database.
 
75
 
 
76
    @param config: The IVLE configuration.
 
77
    """
 
78
    return Store(create_database(get_conn_string(config)))
79
79
 
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
 
359
428
class Enrolment(Storm):
 
429
    """An enrolment of a user in an offering.
 
430
 
 
431
    This represents the roles of both staff and students.
 
432
    """
 
433
 
360
434
    __storm_table__ = "enrolment"
361
435
    __storm_primary__ = "user_id", "offering_id"
362
436
 
385
459
# PROJECTS #
386
460
 
387
461
class ProjectSet(Storm):
 
462
    """A set of projects that share common groups.
 
463
 
 
464
    Each student project group is attached to a project set. The group is
 
465
    valid for all projects in the group's set.
 
466
    """
 
467
 
388
468
    __storm_table__ = "project_set"
389
469
 
390
470
    id = Int(name="projectsetid", primary=True)
401
481
        return "<%s %d in %r>" % (type(self).__name__, self.id,
402
482
                                  self.offering)
403
483
 
 
484
    def get_permissions(self, user, config):
 
485
        return self.offering.get_permissions(user, config)
 
486
 
 
487
    def get_groups_for_user(self, user):
 
488
        """List all groups in this offering of which the user is a member."""
 
489
        assert self.is_group
 
490
        return Store.of(self).find(
 
491
            ProjectGroup,
 
492
            ProjectGroupMembership.user_id == user.id,
 
493
            ProjectGroupMembership.project_group_id == ProjectGroup.id,
 
494
            ProjectGroup.project_set_id == self.id)
 
495
 
 
496
    def get_submission_principal(self, user):
 
497
        """Get the principal on behalf of which the user can submit.
 
498
 
 
499
        If this is a solo project set, the given user is returned. If
 
500
        the user is a member of exactly one group, all the group is
 
501
        returned. Otherwise, None is returned.
 
502
        """
 
503
        if self.is_group:
 
504
            groups = self.get_groups_for_user(user)
 
505
            if groups.count() == 1:
 
506
                return groups.one()
 
507
            else:
 
508
                return None
 
509
        else:
 
510
            return user
 
511
 
 
512
    @property
 
513
    def is_group(self):
 
514
        return self.max_students_per_group is not None
 
515
 
 
516
    @property
 
517
    def assigned(self):
 
518
        """Get the entities (groups or users) assigned to submit this project.
 
519
 
 
520
        This will be a Storm ResultSet.
 
521
        """
 
522
        #If its a solo project, return everyone in offering
 
523
        if self.is_group:
 
524
            return self.project_groups
 
525
        else:
 
526
            return self.offering.students
 
527
 
 
528
class DeadlinePassed(Exception):
 
529
    """An exception indicating that a project cannot be submitted because the
 
530
    deadline has passed."""
 
531
    def __init__(self):
 
532
        pass
 
533
    def __str__(self):
 
534
        return "The project deadline has passed"
 
535
 
404
536
class Project(Storm):
 
537
    """A student project for which submissions can be made."""
 
538
 
405
539
    __storm_table__ = "project"
406
540
 
407
541
    id = Int(name="projectid", primary=True)
425
559
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
426
560
                                  self.project_set.offering)
427
561
 
428
 
    def can_submit(self, principal):
 
562
    def can_submit(self, principal, user):
429
563
        return (self in principal.get_projects() and
430
 
                self.deadline > datetime.datetime.now())
 
564
                not self.has_deadline_passed(user))
431
565
 
432
566
    def submit(self, principal, path, revision, who):
433
567
        """Submit a Subversion path and revision to a project.
434
568
 
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.
 
569
        @param principal: The owner of the Subversion repository, and the
 
570
                          entity on behalf of whom the submission is being made
 
571
        @param path: A path within that repository to submit.
 
572
        @param revision: The revision of that path to submit.
 
573
        @param who: The user who is actually making the submission.
439
574
        """
440
575
 
441
 
        if not self.can_submit(principal):
442
 
            raise Exception('cannot submit')
 
576
        if not self.can_submit(principal, who):
 
577
            raise DeadlinePassed()
443
578
 
444
579
        a = Assessed.get(Store.of(self), principal, self)
445
580
        ps = ProjectSubmission()
451
586
 
452
587
        return ps
453
588
 
 
589
    def get_permissions(self, user, config):
 
590
        return self.project_set.offering.get_permissions(user, config)
 
591
 
 
592
    @property
 
593
    def latest_submissions(self):
 
594
        """Return the latest submission for each Assessed."""
 
595
        return Store.of(self).find(ProjectSubmission,
 
596
            Assessed.project_id == self.id,
 
597
            ProjectSubmission.assessed_id == Assessed.id,
 
598
            ProjectSubmission.date_submitted == Select(
 
599
                    Max(ProjectSubmission.date_submitted),
 
600
                    ProjectSubmission.assessed_id == Assessed.id,
 
601
                    tables=ProjectSubmission
 
602
            )
 
603
        )
 
604
 
 
605
    def has_deadline_passed(self, user):
 
606
        """Check whether the deadline has passed."""
 
607
        # XXX: Need to respect extensions.
 
608
        return self.deadline < datetime.datetime.now()
 
609
 
 
610
    def get_submissions_for_principal(self, principal):
 
611
        """Fetch a ResultSet of all submissions by a particular principal."""
 
612
        assessed = Assessed.get(Store.of(self), principal, self)
 
613
        if assessed is None:
 
614
            return
 
615
        return assessed.submissions
 
616
 
 
617
 
454
618
 
455
619
class ProjectGroup(Storm):
 
620
    """A group of students working together on a project."""
 
621
 
456
622
    __storm_table__ = "project_group"
457
623
 
458
624
    id = Int(name="groupid", primary=True)
477
643
 
478
644
    @property
479
645
    def display_name(self):
480
 
        return '%s (%s)' % (self.nick, self.name)
 
646
        """Returns the "nice name" of the user or group."""
 
647
        return self.nick
 
648
 
 
649
    @property
 
650
    def short_name(self):
 
651
        """Returns the database "identifier" name of the user or group."""
 
652
        return self.name
481
653
 
482
654
    def get_projects(self, offering=None, active_only=True):
483
 
        '''Return Projects that the group can submit.
 
655
        '''Find projects that the group can submit.
484
656
 
485
657
        This will include projects in the project set which owns this group,
486
658
        unless the project set disallows groups (in which case none will be
487
659
        returned).
488
660
 
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.
 
661
        @param active_only: Whether to only search active offerings.
 
662
        @param offering: An optional offering to restrict the search to.
494
663
        '''
495
664
        return Store.of(self).find(Project,
496
665
            Project.project_set_id == ProjectSet.id,
502
671
            (not active_only) or (Semester.state == u'current'))
503
672
 
504
673
 
505
 
    def get_permissions(self, user):
 
674
    def get_permissions(self, user, config):
506
675
        if user.admin or user in self.members:
507
676
            return set(['submit_project'])
508
677
        else:
509
678
            return set()
510
679
 
511
680
class ProjectGroupMembership(Storm):
 
681
    """A student's membership in a project group."""
 
682
 
512
683
    __storm_table__ = "group_member"
513
684
    __storm_primary__ = "user_id", "project_group_id"
514
685
 
524
695
                                  self.project_group)
525
696
 
526
697
class Assessed(Storm):
 
698
    """A composite of a user or group combined with a project.
 
699
 
 
700
    Each project submission and extension refers to an Assessed. It is the
 
701
    sole specifier of the repository and project.
 
702
    """
 
703
 
527
704
    __storm_table__ = "assessed"
528
705
 
529
706
    id = Int(name="assessedid", primary=True)
536
713
    project = Reference(project_id, Project.id)
537
714
 
538
715
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
539
 
    submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
 
716
    submissions = ReferenceSet(
 
717
        id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
540
718
 
541
719
    def __repr__(self):
542
720
        return "<%s %r in %r>" % (type(self).__name__,
543
721
            self.user or self.project_group, self.project)
544
722
 
 
723
    @property
 
724
    def is_group(self):
 
725
        """True if the Assessed is a group, False if it is a user."""
 
726
        return self.project_group is not None
 
727
 
 
728
    @property
 
729
    def principal(self):
 
730
        return self.project_group or self.user
 
731
 
 
732
    @property
 
733
    def checkout_location(self):
 
734
        """Returns the location of the Subversion workspace for this piece of
 
735
        assessment, relative to each group member's home directory."""
 
736
        subjectname = self.project.project_set.offering.subject.short_name
 
737
        if self.is_group:
 
738
            checkout_dir_name = self.principal.short_name
 
739
        else:
 
740
            checkout_dir_name = "mywork"
 
741
        return subjectname + "/" + checkout_dir_name
 
742
 
545
743
    @classmethod
546
744
    def get(cls, store, principal, project):
 
745
        """Find or create an Assessed for the given user or group and project.
 
746
 
 
747
        @param principal: The user or group.
 
748
        @param project: The project.
 
749
        """
547
750
        t = type(principal)
548
751
        if t not in (User, ProjectGroup):
549
752
            raise AssertionError('principal must be User or ProjectGroup')
551
754
        a = store.find(cls,
552
755
            (t is User) or (cls.project_group_id == principal.id),
553
756
            (t is ProjectGroup) or (cls.user_id == principal.id),
554
 
            Project.id == project.id).one()
 
757
            cls.project_id == project.id).one()
555
758
 
556
759
        if a is None:
557
760
            a = cls()
566
769
 
567
770
 
568
771
class ProjectExtension(Storm):
 
772
    """An extension granted to a user or group on a particular project.
 
773
 
 
774
    The user or group and project are specified by the Assessed.
 
775
    """
 
776
 
569
777
    __storm_table__ = "project_extension"
570
778
 
571
779
    id = Int(name="extensionid", primary=True)
577
785
    notes = Unicode()
578
786
 
579
787
class ProjectSubmission(Storm):
 
788
    """A submission from a user or group repository to a particular project.
 
789
 
 
790
    The content of a submission is a single path and revision inside a
 
791
    repository. The repository is that owned by the submission's user and
 
792
    group, while the path and revision are explicit.
 
793
 
 
794
    The user or group and project are specified by the Assessed.
 
795
    """
 
796
 
580
797
    __storm_table__ = "project_submission"
581
798
 
582
799
    id = Int(name="submissionid", primary=True)
588
805
    submitter = Reference(submitter_id, User.id)
589
806
    date_submitted = DateTime()
590
807
 
 
808
    def get_verify_url(self, user):
 
809
        """Get the URL for verifying this submission, within the account of
 
810
        the given user."""
 
811
        # If this is a solo project, then self.path will be prefixed with the
 
812
        # subject name. Remove the first path segment.
 
813
        submitpath = self.path[1:] if self.path[:1] == '/' else self.path
 
814
        if not self.assessed.is_group:
 
815
            if '/' in submitpath:
 
816
                submitpath = submitpath.split('/', 1)[1]
 
817
            else:
 
818
                submitpath = ''
 
819
        return "/files/%s/%s/%s?r=%d" % (user.login,
 
820
            self.assessed.checkout_location, submitpath, self.revision)
591
821
 
592
822
# WORKSHEETS AND EXERCISES #
593
823
 
594
824
class Exercise(Storm):
 
825
    """An exercise for students to complete in a worksheet.
 
826
 
 
827
    An exercise may be present in any number of worksheets.
 
828
    """
 
829
 
595
830
    __storm_table__ = "exercise"
596
831
    id = Unicode(primary=True, name="identifier")
597
832
    name = Unicode()
609
844
        'WorksheetExercise.worksheet_id',
610
845
        'Worksheet.id'
611
846
    )
612
 
    
 
847
 
613
848
    test_suites = ReferenceSet(id, 
614
849
        'TestSuite.exercise_id',
615
850
        order_by='seq_no')
619
854
    def __repr__(self):
620
855
        return "<%s %s>" % (type(self).__name__, self.name)
621
856
 
622
 
    def get_permissions(self, user):
 
857
    def get_permissions(self, user, config):
 
858
        return self.global_permissions(user, config)
 
859
 
 
860
    @staticmethod
 
861
    def global_permissions(user, config):
 
862
        """Gets the set of permissions this user has over *all* exercises.
 
863
        This is used to determine who may view the exercises list, and create
 
864
        new exercises."""
623
865
        perms = set()
624
866
        roles = set()
625
867
        if user is not None:
626
868
            if user.admin:
627
869
                perms.add('edit')
628
870
                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
 
            
 
871
            elif u'lecturer' in set((e.role for e in user.active_enrolments)):
 
872
                perms.add('edit')
 
873
                perms.add('view')
 
874
            elif (config['policy']['tutors_can_edit_worksheets']
 
875
            and u'tutor' in set((e.role for e in user.active_enrolments))):
 
876
                # Site-specific policy on the role of tutors
 
877
                perms.add('edit')
 
878
                perms.add('view')
 
879
 
633
880
        return perms
634
 
    
 
881
 
635
882
    def get_description(self):
 
883
        """Return the description interpreted as reStructuredText."""
636
884
        return rst(self.description)
637
885
 
638
886
    def delete(self):
644
892
        Store.of(self).remove(self)
645
893
 
646
894
class Worksheet(Storm):
 
895
    """A worksheet with exercises for students to complete.
 
896
 
 
897
    Worksheets are owned by offerings.
 
898
    """
 
899
 
647
900
    __storm_table__ = "worksheet"
648
901
 
649
902
    id = Int(primary=True, name="worksheetid")
675
928
        return "<%s %s>" % (type(self).__name__, self.name)
676
929
 
677
930
    def remove_all_exercises(self):
678
 
        """
679
 
        Remove all exercises from this worksheet.
 
931
        """Remove all exercises from this worksheet.
 
932
 
680
933
        This does not delete the exercises themselves. It just removes them
681
934
        from the worksheet.
682
935
        """
686
939
                raise IntegrityError()
687
940
        store.find(WorksheetExercise,
688
941
            WorksheetExercise.worksheet == self).remove()
689
 
            
690
 
    def get_permissions(self, user):
691
 
        return self.offering.get_permissions(user)
692
 
    
 
942
 
 
943
    def get_permissions(self, user, config):
 
944
        # Almost the same permissions as for the offering itself
 
945
        perms = self.offering.get_permissions(user, config)
 
946
        # However, "edit" permission is derived from the "edit_worksheets"
 
947
        # permission of the offering
 
948
        if 'edit_worksheets' in perms:
 
949
            perms.add('edit')
 
950
        else:
 
951
            perms.discard('edit')
 
952
        return perms
 
953
 
693
954
    def get_xml(self):
694
955
        """Returns the xml of this worksheet, converts from rst if required."""
695
956
        if self.format == u'rst':
697
958
            return ws_xml
698
959
        else:
699
960
            return self.data
700
 
    
 
961
 
701
962
    def delete(self):
702
963
        """Deletes the worksheet, provided it has no attempts on any exercises.
703
 
        
 
964
 
704
965
        Returns True if delete succeeded, or False if this worksheet has
705
966
        attempts attached."""
706
967
        for ws_ex in self.all_worksheet_exercises:
707
968
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
708
969
                raise IntegrityError()
709
 
        
 
970
 
710
971
        self.remove_all_exercises()
711
972
        Store.of(self).remove(self)
712
 
        
 
973
 
713
974
class WorksheetExercise(Storm):
 
975
    """A link between a worksheet and one of its exercises.
 
976
 
 
977
    These may be marked optional, in which case the exercise does not count
 
978
    for marking purposes. The sequence number is used to order the worksheet
 
979
    ToC.
 
980
    """
 
981
 
714
982
    __storm_table__ = "worksheet_exercise"
715
 
    
 
983
 
716
984
    id = Int(primary=True, name="ws_ex_id")
717
985
 
718
986
    worksheet_id = Int(name="worksheetid")
722
990
    optional = Bool()
723
991
    active = Bool()
724
992
    seq_no = Int()
725
 
    
 
993
 
726
994
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
727
995
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
728
996
 
732
1000
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
733
1001
                                  self.worksheet.identifier)
734
1002
 
735
 
    def get_permissions(self, user):
736
 
        return self.worksheet.get_permissions(user)
737
 
    
 
1003
    def get_permissions(self, user, config):
 
1004
        return self.worksheet.get_permissions(user, config)
 
1005
 
738
1006
 
739
1007
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
 
    """
 
1008
    """A potential exercise solution submitted by a user for storage.
 
1009
 
 
1010
    This is not an actual tested attempt at an exercise, it's just a save of
 
1011
    the editing session.
 
1012
    """
 
1013
 
748
1014
    __storm_table__ = "exercise_save"
749
1015
    __storm_primary__ = "ws_ex_id", "user_id"
750
1016
 
763
1029
            self.exercise.name, self.user.login, self.date.strftime("%c"))
764
1030
 
765
1031
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
 
    """
 
1032
    """An attempt at solving an exercise.
 
1033
 
 
1034
    This is a special case of ExerciseSave, used when the user submits a
 
1035
    candidate solution. Like an ExerciseSave, it constitutes exercise solution
 
1036
    data.
 
1037
 
 
1038
    In addition, it contains information about the result of the submission:
 
1039
 
 
1040
     - complete - True if this submission was successful, rendering this
 
1041
                  exercise complete for this user in this worksheet.
 
1042
     - active   - True if this submission is "active" (usually true).
 
1043
                  Submissions may be de-activated by privileged users for
 
1044
                  special reasons, and then they won't count (either as a
 
1045
                  penalty or success), but will still be stored.
 
1046
    """
 
1047
 
778
1048
    __storm_table__ = "exercise_attempt"
779
1049
    __storm_primary__ = "ws_ex_id", "user_id", "date"
780
1050
 
783
1053
    text = Unicode(name="attempt")
784
1054
    complete = Bool()
785
1055
    active = Bool()
786
 
    
787
 
    def get_permissions(self, user):
 
1056
 
 
1057
    def get_permissions(self, user, config):
788
1058
        return set(['view']) if user is self.user else set()
789
 
  
 
1059
 
790
1060
class TestSuite(Storm):
791
 
    """A Testsuite acts as a container for the test cases of an exercise."""
 
1061
    """A container to group an exercise's test cases.
 
1062
 
 
1063
    The test suite contains some information on how to test. The function to
 
1064
    test, variables to set and stdin data are stored here.
 
1065
    """
 
1066
 
792
1067
    __storm_table__ = "test_suite"
793
1068
    __storm_primary__ = "exercise_id", "suiteid"
794
 
    
 
1069
 
795
1070
    suiteid = Int()
796
1071
    exercise_id = Unicode(name="exerciseid")
797
1072
    description = Unicode()
801
1076
    exercise = Reference(exercise_id, Exercise.id)
802
1077
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
803
1078
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
804
 
    
 
1079
 
805
1080
    def delete(self):
806
1081
        """Delete this suite, without asking questions."""
807
 
        for vaariable in self.variables:
 
1082
        for variable in self.variables:
808
1083
            variable.delete()
809
1084
        for test_case in self.test_cases:
810
1085
            test_case.delete()
811
1086
        Store.of(self).remove(self)
812
1087
 
813
1088
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"""
 
1089
    """A container for actual tests (see TestCasePart), inside a test suite.
 
1090
 
 
1091
    It is the lowest level shown to students on their pass/fail status."""
 
1092
 
817
1093
    __storm_table__ = "test_case"
818
1094
    __storm_primary__ = "testid", "suiteid"
819
 
    
 
1095
 
820
1096
    testid = Int()
821
1097
    suiteid = Int()
822
1098
    suite = Reference(suiteid, "TestSuite.suiteid")
823
1099
    passmsg = Unicode()
824
1100
    failmsg = Unicode()
825
 
    test_default = Unicode()
 
1101
    test_default = Unicode() # Currently unused - only used for file matching.
826
1102
    seq_no = Int()
827
 
    
 
1103
 
828
1104
    parts = ReferenceSet(testid, "TestCasePart.testid")
829
 
    
 
1105
 
830
1106
    __init__ = _kwarg_init
831
 
    
 
1107
 
832
1108
    def delete(self):
833
1109
        for part in self.parts:
834
1110
            part.delete()
835
1111
        Store.of(self).remove(self)
836
1112
 
837
1113
class TestSuiteVar(Storm):
838
 
    """A container for the arguments of a Test Suite"""
 
1114
    """A variable used by an exercise test suite.
 
1115
 
 
1116
    This may represent a function argument or a normal variable.
 
1117
    """
 
1118
 
839
1119
    __storm_table__ = "suite_variable"
840
1120
    __storm_primary__ = "varid"
841
 
    
 
1121
 
842
1122
    varid = Int()
843
1123
    suiteid = Int()
844
1124
    var_name = Unicode()
845
1125
    var_value = Unicode()
846
1126
    var_type = Unicode()
847
1127
    arg_no = Int()
848
 
    
 
1128
 
849
1129
    suite = Reference(suiteid, "TestSuite.suiteid")
850
 
    
 
1130
 
851
1131
    __init__ = _kwarg_init
852
 
    
 
1132
 
853
1133
    def delete(self):
854
1134
        Store.of(self).remove(self)
855
 
    
 
1135
 
856
1136
class TestCasePart(Storm):
857
 
    """A container for the test elements of a Test Case"""
 
1137
    """An actual piece of code to test an exercise solution."""
 
1138
 
858
1139
    __storm_table__ = "test_case_part"
859
1140
    __storm_primary__ = "partid"
860
 
    
 
1141
 
861
1142
    partid = Int()
862
1143
    testid = Int()
863
 
    
 
1144
 
864
1145
    part_type = Unicode()
865
1146
    test_type = Unicode()
866
1147
    data = Unicode()
867
1148
    filename = Unicode()
868
 
    
 
1149
 
869
1150
    test = Reference(testid, "TestCase.testid")
870
 
    
 
1151
 
871
1152
    __init__ = _kwarg_init
872
 
    
 
1153
 
873
1154
    def delete(self):
874
1155
        Store.of(self).remove(self)