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

« back to all changes in this revision

Viewing changes to ivle/database.py

  • Committer: Matt Giuca
  • Date: 2010-02-12 02:49:17 UTC
  • Revision ID: matt.giuca@gmail.com-20100212024917-z9g1d5v4utr0u2zm
Fixed policy on who is able to view the list of exercises and create a new one. Rather than being 'if you can edit any offering', it is now the same rule as determining whether you can edit exercises.

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.
25
24
"""
26
25
 
27
 
import md5
 
26
import hashlib
28
27
import datetime
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
from storm.exceptions import NotOneError, IntegrityError
32
33
 
33
 
import ivle.conf
34
 
import ivle.caps
 
34
from ivle.worksheet.rst import rst
35
35
 
36
36
__all__ = ['get_store',
37
37
            'User',
38
38
            'Subject', 'Semester', 'Offering', 'Enrolment',
39
39
            'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
 
40
            'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
41
            'Exercise', 'Worksheet', 'WorksheetExercise',
41
42
            'ExerciseSave', 'ExerciseAttempt',
42
 
            'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
 
43
            'TestCase', 'TestSuite', 'TestSuiteVar'
43
44
        ]
44
45
 
45
46
def _kwarg_init(self, **kwargs):
49
50
                % (self.__class__.__name__, k))
50
51
        setattr(self, k, v)
51
52
 
52
 
def get_conn_string():
53
 
    """
54
 
    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.
55
57
    """
56
58
 
57
59
    clusterstr = ''
58
 
    if ivle.conf.db_user:
59
 
        clusterstr += ivle.conf.db_user
60
 
        if ivle.conf.db_password:
61
 
            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']
62
64
        clusterstr += '@'
63
65
 
64
 
    host = ivle.conf.db_host or 'localhost'
65
 
    port = ivle.conf.db_port or 5432
 
66
    host = config['database']['host'] or 'localhost'
 
67
    port = config['database']['port'] or 5432
66
68
 
67
69
    clusterstr += '%s:%d' % (host, port)
68
70
 
69
 
    return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
70
 
 
71
 
def get_store():
72
 
    """
73
 
    Open a database connection and transaction. Return a storm.store.Store
74
 
    instance connected to the configured IVLE database.
75
 
    """
76
 
    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)))
77
79
 
78
80
# USERS #
79
81
 
80
82
class User(Storm):
81
 
    """
82
 
    Represents an IVLE user.
83
 
    """
 
83
    """An IVLE user account."""
84
84
    __storm_table__ = "login"
85
85
 
86
86
    id = Int(primary=True, name="loginid")
87
87
    login = Unicode()
88
88
    passhash = Unicode()
89
89
    state = Unicode()
90
 
    rolenm = Unicode()
 
90
    admin = Bool()
91
91
    unixid = Int()
92
92
    nick = Unicode()
93
93
    pass_exp = DateTime()
99
99
    studentid = Unicode()
100
100
    settings = Unicode()
101
101
 
102
 
    def _get_role(self):
103
 
        if self.rolenm is None:
104
 
            return None
105
 
        return ivle.caps.Role(self.rolenm)
106
 
    def _set_role(self, value):
107
 
        if not isinstance(value, ivle.caps.Role):
108
 
            raise TypeError("role must be an ivle.caps.Role")
109
 
        self.rolenm = unicode(value)
110
 
    role = property(_get_role, _set_role)
111
 
 
112
102
    __init__ = _kwarg_init
113
103
 
114
104
    def __repr__(self):
125
115
            return None
126
116
        return self.hash_password(password) == self.passhash
127
117
 
128
 
    def hasCap(self, capability):
129
 
        """Given a capability (which is a Role object), returns True if this
130
 
        User has that capability, False otherwise.
131
 
        """
132
 
        return self.role.hasCap(capability)
 
118
    @property
 
119
    def display_name(self):
 
120
        """Returns the "nice name" of the user or group."""
 
121
        return self.fullname
 
122
 
 
123
    @property
 
124
    def short_name(self):
 
125
        """Returns the database "identifier" name of the user or group."""
 
126
        return self.login
133
127
 
134
128
    @property
135
129
    def password_expired(self):
174
168
 
175
169
    # TODO: Invitations should be listed too?
176
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
        """
177
175
        preds = [
178
176
            ProjectGroupMembership.user_id == self.id,
179
177
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
199
197
        '''A sanely ordered list of all of the user's enrolments.'''
200
198
        return self._get_enrolments(False) 
201
199
 
 
200
    def get_projects(self, offering=None, active_only=True):
 
201
        """Find projects that the user can submit.
 
202
 
 
203
        This will include projects for offerings in which the user is
 
204
        enrolled, as long as the project is not in a project set which has
 
205
        groups (ie. if maximum number of group members is 0).
 
206
 
 
207
        @param active_only: Whether to only search active offerings.
 
208
        @param offering: An optional offering to restrict the search to.
 
209
        """
 
210
        return Store.of(self).find(Project,
 
211
            Project.project_set_id == ProjectSet.id,
 
212
            ProjectSet.max_students_per_group == None,
 
213
            ProjectSet.offering_id == Offering.id,
 
214
            (offering is None) or (Offering.id == offering.id),
 
215
            Semester.id == Offering.semester_id,
 
216
            (not active_only) or (Semester.state == u'current'),
 
217
            Enrolment.offering_id == Offering.id,
 
218
            Enrolment.user_id == self.id)
 
219
 
202
220
    @staticmethod
203
221
    def hash_password(password):
204
 
        return md5.md5(password).hexdigest()
 
222
        """Hash a password with MD5."""
 
223
        return hashlib.md5(password).hexdigest()
205
224
 
206
225
    @classmethod
207
226
    def get_by_login(cls, store, login):
208
 
        """
209
 
        Get the User from the db associated with a given store and
210
 
        login.
211
 
        """
 
227
        """Find a user in a store by login name."""
212
228
        return store.find(cls, cls.login == unicode(login)).one()
213
229
 
214
230
    def get_permissions(self, user):
215
 
        if user and user.rolenm == 'admin' or user is self:
216
 
            return set(['view', 'edit'])
 
231
        """Determine privileges held by a user over this object.
 
232
 
 
233
        If the user requesting privileges is this user or an admin,
 
234
        they may do everything. Otherwise they may do nothing.
 
235
        """
 
236
        if user and user.admin or user is self:
 
237
            return set(['view_public', 'view', 'edit', 'submit_project'])
217
238
        else:
218
 
            return set()
 
239
            return set(['view_public'])
219
240
 
220
241
# SUBJECTS AND ENROLMENTS #
221
242
 
222
243
class Subject(Storm):
 
244
    """A subject (or course) which is run in some semesters."""
 
245
 
223
246
    __storm_table__ = "subject"
224
247
 
225
248
    id = Int(primary=True, name="subjectid")
226
249
    code = Unicode(name="subj_code")
227
250
    name = Unicode(name="subj_name")
228
251
    short_name = Unicode(name="subj_short_name")
229
 
    url = Unicode()
230
252
 
231
253
    offerings = ReferenceSet(id, 'Offering.subject_id')
232
254
 
236
258
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
237
259
 
238
260
    def get_permissions(self, user):
 
261
        """Determine privileges held by a user over this object.
 
262
 
 
263
        If the user requesting privileges is an admin, they may edit.
 
264
        Otherwise they may only read.
 
265
        """
239
266
        perms = set()
240
267
        if user is not None:
241
268
            perms.add('view')
242
 
            if user.rolenm == 'admin':
 
269
            if user.admin:
243
270
                perms.add('edit')
244
271
        return perms
245
272
 
 
273
    def active_offerings(self):
 
274
        """Find active offerings for this subject.
 
275
 
 
276
        Return a sequence of currently active offerings for this subject
 
277
        (offerings whose semester.state is "current"). There should be 0 or 1
 
278
        elements in this sequence, but it's possible there are more.
 
279
        """
 
280
        return self.offerings.find(Offering.semester_id == Semester.id,
 
281
                                   Semester.state == u'current')
 
282
 
 
283
    def offering_for_semester(self, year, semester):
 
284
        """Get the offering for the given year/semester, or None.
 
285
 
 
286
        @param year: A string representation of the year.
 
287
        @param semester: A string representation of the semester.
 
288
        """
 
289
        return self.offerings.find(Offering.semester_id == Semester.id,
 
290
                               Semester.year == unicode(year),
 
291
                               Semester.semester == unicode(semester)).one()
 
292
 
246
293
class Semester(Storm):
 
294
    """A semester in which subjects can be run."""
 
295
 
247
296
    __storm_table__ = "semester"
248
297
 
249
298
    id = Int(primary=True, name="semesterid")
250
299
    year = Unicode()
251
300
    semester = Unicode()
252
 
    active = Bool()
 
301
    state = Unicode()
253
302
 
254
303
    offerings = ReferenceSet(id, 'Offering.semester_id')
 
304
    enrolments = ReferenceSet(id,
 
305
                              'Offering.semester_id',
 
306
                              'Offering.id',
 
307
                              'Enrolment.offering_id')
255
308
 
256
309
    __init__ = _kwarg_init
257
310
 
259
312
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
260
313
 
261
314
class Offering(Storm):
 
315
    """An offering of a subject in a particular semester."""
 
316
 
262
317
    __storm_table__ = "offering"
263
318
 
264
319
    id = Int(primary=True, name="offeringid")
266
321
    subject = Reference(subject_id, Subject.id)
267
322
    semester_id = Int(name="semesterid")
268
323
    semester = Reference(semester_id, Semester.id)
 
324
    description = Unicode()
 
325
    url = Unicode()
269
326
    groups_student_permissions = Unicode()
270
327
 
271
328
    enrolments = ReferenceSet(id, 'Enrolment.offering_id')
274
331
                           'Enrolment.user_id',
275
332
                           'User.id')
276
333
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
 
334
    projects = ReferenceSet(id,
 
335
                            'ProjectSet.offering_id',
 
336
                            'ProjectSet.id',
 
337
                            'Project.project_set_id')
277
338
 
278
339
    worksheets = ReferenceSet(id, 
279
340
        'Worksheet.offering_id', 
280
 
        order_by="Worksheet.seq_no"
 
341
        order_by="seq_no"
281
342
    )
282
343
 
283
344
    __init__ = _kwarg_init
286
347
        return "<%s %r in %r>" % (type(self).__name__, self.subject,
287
348
                                  self.semester)
288
349
 
289
 
    def enrol(self, user):
290
 
        '''Enrol a user in this offering.'''
291
 
        # We'll get a horrible database constraint violation error if we try
292
 
        # to add a second enrolment.
293
 
        if Store.of(self).find(Enrolment,
294
 
                               Enrolment.user_id == user.id,
295
 
                               Enrolment.offering_id == self.id).count() == 1:
296
 
            raise AlreadyEnrolledError()
297
 
 
298
 
        e = Enrolment(user=user, offering=self, active=True)
299
 
        self.enrolments.add(e)
 
350
    def enrol(self, user, role=u'student'):
 
351
        """Enrol a user in this offering.
 
352
 
 
353
        Enrolments handle both the staff and student cases. The role controls
 
354
        the privileges granted by this enrolment.
 
355
        """
 
356
        enrolment = Store.of(self).find(Enrolment,
 
357
                               Enrolment.user_id == user.id,
 
358
                               Enrolment.offering_id == self.id).one()
 
359
 
 
360
        if enrolment is None:
 
361
            enrolment = Enrolment(user=user, offering=self)
 
362
            self.enrolments.add(enrolment)
 
363
 
 
364
        enrolment.active = True
 
365
        enrolment.role = role
 
366
 
 
367
    def unenrol(self, user):
 
368
        '''Unenrol a user from this offering.'''
 
369
        enrolment = Store.of(self).find(Enrolment,
 
370
                               Enrolment.user_id == user.id,
 
371
                               Enrolment.offering_id == self.id).one()
 
372
        Store.of(enrolment).remove(enrolment)
300
373
 
301
374
    def get_permissions(self, user):
302
375
        perms = set()
303
376
        if user is not None:
304
 
            perms.add('view')
305
 
            if user.rolenm == 'admin':
 
377
            enrolment = self.get_enrolment(user)
 
378
            if enrolment or user.admin:
 
379
                perms.add('view')
 
380
            if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
 
381
               or user.admin:
306
382
                perms.add('edit')
 
383
            if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
 
384
                perms.add('enrol')          # Can see enrolment screen at all
 
385
                perms.add('enrol_student')  # Can enrol students
 
386
                perms.add('enrol_tutor')    # Can enrol tutors
 
387
            if user.admin:
 
388
                perms.add('enrol_lecturer') # Can enrol lecturers
307
389
        return perms
308
390
 
 
391
    def get_enrolment(self, user):
 
392
        """Find the user's enrolment in this offering."""
 
393
        try:
 
394
            enrolment = self.enrolments.find(user=user).one()
 
395
        except NotOneError:
 
396
            enrolment = None
 
397
 
 
398
        return enrolment
 
399
 
 
400
    def get_members_by_role(self, role):
 
401
        return Store.of(self).find(User,
 
402
                Enrolment.user_id == User.id,
 
403
                Enrolment.offering_id == self.id,
 
404
                Enrolment.role == role
 
405
                ).order_by(User.login)
 
406
 
 
407
    @property
 
408
    def students(self):
 
409
        return self.get_members_by_role(u'student')
 
410
 
 
411
    def get_open_projects_for_user(self, user):
 
412
        """Find all projects currently open to submissions by a user."""
 
413
        # XXX: Respect extensions.
 
414
        return self.projects.find(Project.deadline > datetime.datetime.now())
 
415
 
309
416
class Enrolment(Storm):
 
417
    """An enrolment of a user in an offering.
 
418
 
 
419
    This represents the roles of both staff and students.
 
420
    """
 
421
 
310
422
    __storm_table__ = "enrolment"
311
423
    __storm_primary__ = "user_id", "offering_id"
312
424
 
314
426
    user = Reference(user_id, User.id)
315
427
    offering_id = Int(name="offeringid")
316
428
    offering = Reference(offering_id, Offering.id)
 
429
    role = Unicode()
317
430
    notes = Unicode()
318
431
    active = Bool()
319
432
 
331
444
        return "<%s %r in %r>" % (type(self).__name__, self.user,
332
445
                                  self.offering)
333
446
 
334
 
class AlreadyEnrolledError(Exception):
335
 
    pass
336
 
 
337
447
# PROJECTS #
338
448
 
339
449
class ProjectSet(Storm):
 
450
    """A set of projects that share common groups.
 
451
 
 
452
    Each student project group is attached to a project set. The group is
 
453
    valid for all projects in the group's set.
 
454
    """
 
455
 
340
456
    __storm_table__ = "project_set"
341
457
 
342
458
    id = Int(name="projectsetid", primary=True)
353
469
        return "<%s %d in %r>" % (type(self).__name__, self.id,
354
470
                                  self.offering)
355
471
 
 
472
    def get_permissions(self, user):
 
473
        return self.offering.get_permissions(user)
 
474
 
 
475
    def get_groups_for_user(self, user):
 
476
        """List all groups in this offering of which the user is a member."""
 
477
        assert self.is_group
 
478
        return Store.of(self).find(
 
479
            ProjectGroup,
 
480
            ProjectGroupMembership.user_id == user.id,
 
481
            ProjectGroupMembership.project_group_id == ProjectGroup.id,
 
482
            ProjectGroup.project_set_id == self.id)
 
483
 
 
484
    def get_submission_principal(self, user):
 
485
        """Get the principal on behalf of which the user can submit.
 
486
 
 
487
        If this is a solo project set, the given user is returned. If
 
488
        the user is a member of exactly one group, all the group is
 
489
        returned. Otherwise, None is returned.
 
490
        """
 
491
        if self.is_group:
 
492
            groups = self.get_groups_for_user(user)
 
493
            if groups.count() == 1:
 
494
                return groups.one()
 
495
            else:
 
496
                return None
 
497
        else:
 
498
            return user
 
499
 
 
500
    @property
 
501
    def is_group(self):
 
502
        return self.max_students_per_group is not None
 
503
 
 
504
    @property
 
505
    def assigned(self):
 
506
        """Get the entities (groups or users) assigned to submit this project.
 
507
 
 
508
        This will be a Storm ResultSet.
 
509
        """
 
510
        #If its a solo project, return everyone in offering
 
511
        if self.is_group:
 
512
            return self.project_groups
 
513
        else:
 
514
            return self.offering.students
 
515
 
 
516
class DeadlinePassed(Exception):
 
517
    """An exception indicating that a project cannot be submitted because the
 
518
    deadline has passed."""
 
519
    def __init__(self):
 
520
        pass
 
521
    def __str__(self):
 
522
        return "The project deadline has passed"
 
523
 
356
524
class Project(Storm):
 
525
    """A student project for which submissions can be made."""
 
526
 
357
527
    __storm_table__ = "project"
358
528
 
359
529
    id = Int(name="projectid", primary=True)
 
530
    name = Unicode()
 
531
    short_name = Unicode()
360
532
    synopsis = Unicode()
361
533
    url = Unicode()
362
534
    project_set_id = Int(name="projectsetid")
363
535
    project_set = Reference(project_set_id, ProjectSet.id)
364
536
    deadline = DateTime()
365
537
 
 
538
    assesseds = ReferenceSet(id, 'Assessed.project_id')
 
539
    submissions = ReferenceSet(id,
 
540
                               'Assessed.project_id',
 
541
                               'Assessed.id',
 
542
                               'ProjectSubmission.assessed_id')
 
543
 
366
544
    __init__ = _kwarg_init
367
545
 
368
546
    def __repr__(self):
369
 
        return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
 
547
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
370
548
                                  self.project_set.offering)
371
549
 
 
550
    def can_submit(self, principal, user):
 
551
        return (self in principal.get_projects() and
 
552
                not self.has_deadline_passed(user))
 
553
 
 
554
    def submit(self, principal, path, revision, who):
 
555
        """Submit a Subversion path and revision to a project.
 
556
 
 
557
        @param principal: The owner of the Subversion repository, and the
 
558
                          entity on behalf of whom the submission is being made
 
559
        @param path: A path within that repository to submit.
 
560
        @param revision: The revision of that path to submit.
 
561
        @param who: The user who is actually making the submission.
 
562
        """
 
563
 
 
564
        if not self.can_submit(principal, who):
 
565
            raise DeadlinePassed()
 
566
 
 
567
        a = Assessed.get(Store.of(self), principal, self)
 
568
        ps = ProjectSubmission()
 
569
        ps.path = path
 
570
        ps.revision = revision
 
571
        ps.date_submitted = datetime.datetime.now()
 
572
        ps.assessed = a
 
573
        ps.submitter = who
 
574
 
 
575
        return ps
 
576
 
 
577
    def get_permissions(self, user):
 
578
        return self.project_set.offering.get_permissions(user)
 
579
 
 
580
    @property
 
581
    def latest_submissions(self):
 
582
        """Return the latest submission for each Assessed."""
 
583
        return Store.of(self).find(ProjectSubmission,
 
584
            Assessed.project_id == self.id,
 
585
            ProjectSubmission.assessed_id == Assessed.id,
 
586
            ProjectSubmission.date_submitted == Select(
 
587
                    Max(ProjectSubmission.date_submitted),
 
588
                    ProjectSubmission.assessed_id == Assessed.id,
 
589
                    tables=ProjectSubmission
 
590
            )
 
591
        )
 
592
 
 
593
    def has_deadline_passed(self, user):
 
594
        """Check whether the deadline has passed."""
 
595
        # XXX: Need to respect extensions.
 
596
        return self.deadline < datetime.datetime.now()
 
597
 
 
598
    def get_submissions_for_principal(self, principal):
 
599
        """Fetch a ResultSet of all submissions by a particular principal."""
 
600
        assessed = Assessed.get(Store.of(self), principal, self)
 
601
        if assessed is None:
 
602
            return
 
603
        return assessed.submissions
 
604
 
 
605
 
 
606
 
372
607
class ProjectGroup(Storm):
 
608
    """A group of students working together on a project."""
 
609
 
373
610
    __storm_table__ = "project_group"
374
611
 
375
612
    id = Int(name="groupid", primary=True)
392
629
        return "<%s %s in %r>" % (type(self).__name__, self.name,
393
630
                                  self.project_set.offering)
394
631
 
 
632
    @property
 
633
    def display_name(self):
 
634
        """Returns the "nice name" of the user or group."""
 
635
        return self.nick
 
636
 
 
637
    @property
 
638
    def short_name(self):
 
639
        """Returns the database "identifier" name of the user or group."""
 
640
        return self.name
 
641
 
 
642
    def get_projects(self, offering=None, active_only=True):
 
643
        '''Find projects that the group can submit.
 
644
 
 
645
        This will include projects in the project set which owns this group,
 
646
        unless the project set disallows groups (in which case none will be
 
647
        returned).
 
648
 
 
649
        @param active_only: Whether to only search active offerings.
 
650
        @param offering: An optional offering to restrict the search to.
 
651
        '''
 
652
        return Store.of(self).find(Project,
 
653
            Project.project_set_id == ProjectSet.id,
 
654
            ProjectSet.id == self.project_set.id,
 
655
            ProjectSet.max_students_per_group != None,
 
656
            ProjectSet.offering_id == Offering.id,
 
657
            (offering is None) or (Offering.id == offering.id),
 
658
            Semester.id == Offering.semester_id,
 
659
            (not active_only) or (Semester.state == u'current'))
 
660
 
 
661
 
 
662
    def get_permissions(self, user):
 
663
        if user.admin or user in self.members:
 
664
            return set(['submit_project'])
 
665
        else:
 
666
            return set()
 
667
 
395
668
class ProjectGroupMembership(Storm):
 
669
    """A student's membership in a project group."""
 
670
 
396
671
    __storm_table__ = "group_member"
397
672
    __storm_primary__ = "user_id", "project_group_id"
398
673
 
407
682
        return "<%s %r in %r>" % (type(self).__name__, self.user,
408
683
                                  self.project_group)
409
684
 
 
685
class Assessed(Storm):
 
686
    """A composite of a user or group combined with a project.
 
687
 
 
688
    Each project submission and extension refers to an Assessed. It is the
 
689
    sole specifier of the repository and project.
 
690
    """
 
691
 
 
692
    __storm_table__ = "assessed"
 
693
 
 
694
    id = Int(name="assessedid", primary=True)
 
695
    user_id = Int(name="loginid")
 
696
    user = Reference(user_id, User.id)
 
697
    project_group_id = Int(name="groupid")
 
698
    project_group = Reference(project_group_id, ProjectGroup.id)
 
699
 
 
700
    project_id = Int(name="projectid")
 
701
    project = Reference(project_id, Project.id)
 
702
 
 
703
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
 
704
    submissions = ReferenceSet(
 
705
        id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
 
706
 
 
707
    def __repr__(self):
 
708
        return "<%s %r in %r>" % (type(self).__name__,
 
709
            self.user or self.project_group, self.project)
 
710
 
 
711
    @property
 
712
    def is_group(self):
 
713
        """True if the Assessed is a group, False if it is a user."""
 
714
        return self.project_group is not None
 
715
 
 
716
    @property
 
717
    def principal(self):
 
718
        return self.project_group or self.user
 
719
 
 
720
    @property
 
721
    def checkout_location(self):
 
722
        """Returns the location of the Subversion workspace for this piece of
 
723
        assessment, relative to each group member's home directory."""
 
724
        subjectname = self.project.project_set.offering.subject.short_name
 
725
        if self.is_group:
 
726
            checkout_dir_name = self.principal.short_name
 
727
        else:
 
728
            checkout_dir_name = "mywork"
 
729
        return subjectname + "/" + checkout_dir_name
 
730
 
 
731
    @classmethod
 
732
    def get(cls, store, principal, project):
 
733
        """Find or create an Assessed for the given user or group and project.
 
734
 
 
735
        @param principal: The user or group.
 
736
        @param project: The project.
 
737
        """
 
738
        t = type(principal)
 
739
        if t not in (User, ProjectGroup):
 
740
            raise AssertionError('principal must be User or ProjectGroup')
 
741
 
 
742
        a = store.find(cls,
 
743
            (t is User) or (cls.project_group_id == principal.id),
 
744
            (t is ProjectGroup) or (cls.user_id == principal.id),
 
745
            cls.project_id == project.id).one()
 
746
 
 
747
        if a is None:
 
748
            a = cls()
 
749
            if t is User:
 
750
                a.user = principal
 
751
            else:
 
752
                a.project_group = principal
 
753
            a.project = project
 
754
            store.add(a)
 
755
 
 
756
        return a
 
757
 
 
758
 
 
759
class ProjectExtension(Storm):
 
760
    """An extension granted to a user or group on a particular project.
 
761
 
 
762
    The user or group and project are specified by the Assessed.
 
763
    """
 
764
 
 
765
    __storm_table__ = "project_extension"
 
766
 
 
767
    id = Int(name="extensionid", primary=True)
 
768
    assessed_id = Int(name="assessedid")
 
769
    assessed = Reference(assessed_id, Assessed.id)
 
770
    deadline = DateTime()
 
771
    approver_id = Int(name="approver")
 
772
    approver = Reference(approver_id, User.id)
 
773
    notes = Unicode()
 
774
 
 
775
class ProjectSubmission(Storm):
 
776
    """A submission from a user or group repository to a particular project.
 
777
 
 
778
    The content of a submission is a single path and revision inside a
 
779
    repository. The repository is that owned by the submission's user and
 
780
    group, while the path and revision are explicit.
 
781
 
 
782
    The user or group and project are specified by the Assessed.
 
783
    """
 
784
 
 
785
    __storm_table__ = "project_submission"
 
786
 
 
787
    id = Int(name="submissionid", primary=True)
 
788
    assessed_id = Int(name="assessedid")
 
789
    assessed = Reference(assessed_id, Assessed.id)
 
790
    path = Unicode()
 
791
    revision = Int()
 
792
    submitter_id = Int(name="submitter")
 
793
    submitter = Reference(submitter_id, User.id)
 
794
    date_submitted = DateTime()
 
795
 
 
796
    def get_verify_url(self, user):
 
797
        """Get the URL for verifying this submission, within the account of
 
798
        the given user."""
 
799
        # If this is a solo project, then self.path will be prefixed with the
 
800
        # subject name. Remove the first path segment.
 
801
        submitpath = self.path[1:] if self.path[:1] == '/' else self.path
 
802
        if not self.assessed.is_group:
 
803
            if '/' in submitpath:
 
804
                submitpath = submitpath.split('/', 1)[1]
 
805
            else:
 
806
                submitpath = ''
 
807
        return "/files/%s/%s/%s?r=%d" % (user.login,
 
808
            self.assessed.checkout_location, submitpath, self.revision)
 
809
 
410
810
# WORKSHEETS AND EXERCISES #
411
811
 
412
812
class Exercise(Storm):
 
813
    """An exercise for students to complete in a worksheet.
 
814
 
 
815
    An exercise may be present in any number of worksheets.
 
816
    """
 
817
 
413
818
    __storm_table__ = "exercise"
414
819
    id = Unicode(primary=True, name="identifier")
415
820
    name = Unicode()
419
824
    include = Unicode()
420
825
    num_rows = Int()
421
826
 
 
827
    worksheet_exercises =  ReferenceSet(id,
 
828
        'WorksheetExercise.exercise_id')
 
829
 
422
830
    worksheets = ReferenceSet(id,
423
831
        'WorksheetExercise.exercise_id',
424
832
        'WorksheetExercise.worksheet_id',
425
833
        'Worksheet.id'
426
834
    )
427
 
    
428
 
    test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
 
835
 
 
836
    test_suites = ReferenceSet(id, 
 
837
        'TestSuite.exercise_id',
 
838
        order_by='seq_no')
429
839
 
430
840
    __init__ = _kwarg_init
431
841
 
432
842
    def __repr__(self):
433
843
        return "<%s %s>" % (type(self).__name__, self.name)
434
844
 
 
845
    def get_permissions(self, user):
 
846
        return self.global_permissions(user)
 
847
 
 
848
    @staticmethod
 
849
    def global_permissions(user):
 
850
        """Gets the set of permissions this user has over *all* exercises.
 
851
        This is used to determine who may view the exercises list, and create
 
852
        new exercises."""
 
853
        perms = set()
 
854
        roles = set()
 
855
        if user is not None:
 
856
            if user.admin:
 
857
                perms.add('edit')
 
858
                perms.add('view')
 
859
            elif u'lecturer' in set((e.role for e in user.active_enrolments)):
 
860
                perms.add('edit')
 
861
                perms.add('view')
 
862
            elif u'tutor' in set((e.role for e in user.active_enrolments)):
 
863
                perms.add('edit')
 
864
                perms.add('view')
 
865
 
 
866
        return perms
 
867
 
 
868
    def get_description(self):
 
869
        """Return the description interpreted as reStructuredText."""
 
870
        return rst(self.description)
 
871
 
 
872
    def delete(self):
 
873
        """Deletes the exercise, providing it has no associated worksheets."""
 
874
        if (self.worksheet_exercises.count() > 0):
 
875
            raise IntegrityError()
 
876
        for suite in self.test_suites:
 
877
            suite.delete()
 
878
        Store.of(self).remove(self)
435
879
 
436
880
class Worksheet(Storm):
 
881
    """A worksheet with exercises for students to complete.
 
882
 
 
883
    Worksheets are owned by offerings.
 
884
    """
 
885
 
437
886
    __storm_table__ = "worksheet"
438
887
 
439
888
    id = Int(primary=True, name="worksheetid")
448
897
    attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
449
898
    offering = Reference(offering_id, 'Offering.id')
450
899
 
451
 
    # Use worksheet_exercises to get access to the WorksheetExercise objects
452
 
    # binding worksheets to exercises. This is required to access the
 
900
    all_worksheet_exercises = ReferenceSet(id,
 
901
        'WorksheetExercise.worksheet_id')
 
902
 
 
903
    # Use worksheet_exercises to get access to the *active* WorksheetExercise
 
904
    # objects binding worksheets to exercises. This is required to access the
453
905
    # "optional" field.
454
 
    worksheet_exercises = ReferenceSet(id,
455
 
        'WorksheetExercise.worksheet_id')
456
 
        
 
906
 
 
907
    @property
 
908
    def worksheet_exercises(self):
 
909
        return self.all_worksheet_exercises.find(active=True)
457
910
 
458
911
    __init__ = _kwarg_init
459
912
 
460
913
    def __repr__(self):
461
914
        return "<%s %s>" % (type(self).__name__, self.name)
462
915
 
463
 
    # XXX Refactor this - make it an instance method of Subject rather than a
464
 
    # class method of Worksheet. Can't do that now because Subject isn't
465
 
    # linked referentially to the Worksheet.
466
 
    @classmethod
467
 
    def get_by_name(cls, store, subjectname, worksheetname):
468
 
        """
469
 
        Get the Worksheet from the db associated with a given store, subject
470
 
        name and worksheet name.
471
 
        """
472
 
        return store.find(cls, cls.subject == unicode(subjectname),
473
 
            cls.name == unicode(worksheetname)).one()
 
916
    def remove_all_exercises(self):
 
917
        """Remove all exercises from this worksheet.
474
918
 
475
 
    def remove_all_exercises(self, store):
476
 
        """
477
 
        Remove all exercises from this worksheet.
478
919
        This does not delete the exercises themselves. It just removes them
479
920
        from the worksheet.
480
921
        """
 
922
        store = Store.of(self)
 
923
        for ws_ex in self.all_worksheet_exercises:
 
924
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
925
                raise IntegrityError()
481
926
        store.find(WorksheetExercise,
482
927
            WorksheetExercise.worksheet == self).remove()
483
 
            
 
928
 
484
929
    def get_permissions(self, user):
485
930
        return self.offering.get_permissions(user)
486
931
 
 
932
    def get_xml(self):
 
933
        """Returns the xml of this worksheet, converts from rst if required."""
 
934
        if self.format == u'rst':
 
935
            ws_xml = rst(self.data)
 
936
            return ws_xml
 
937
        else:
 
938
            return self.data
 
939
 
 
940
    def delete(self):
 
941
        """Deletes the worksheet, provided it has no attempts on any exercises.
 
942
 
 
943
        Returns True if delete succeeded, or False if this worksheet has
 
944
        attempts attached."""
 
945
        for ws_ex in self.all_worksheet_exercises:
 
946
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
947
                raise IntegrityError()
 
948
 
 
949
        self.remove_all_exercises()
 
950
        Store.of(self).remove(self)
 
951
 
487
952
class WorksheetExercise(Storm):
 
953
    """A link between a worksheet and one of its exercises.
 
954
 
 
955
    These may be marked optional, in which case the exercise does not count
 
956
    for marking purposes. The sequence number is used to order the worksheet
 
957
    ToC.
 
958
    """
 
959
 
488
960
    __storm_table__ = "worksheet_exercise"
489
 
    
 
961
 
490
962
    id = Int(primary=True, name="ws_ex_id")
491
963
 
492
964
    worksheet_id = Int(name="worksheetid")
496
968
    optional = Bool()
497
969
    active = Bool()
498
970
    seq_no = Int()
499
 
    
 
971
 
500
972
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
501
973
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
502
974
 
506
978
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
507
979
                                  self.worksheet.identifier)
508
980
 
 
981
    def get_permissions(self, user):
 
982
        return self.worksheet.get_permissions(user)
 
983
 
 
984
 
509
985
class ExerciseSave(Storm):
510
 
    """
511
 
    Represents a potential solution to an exercise that a user has submitted
512
 
    to the server for storage.
513
 
    A basic ExerciseSave is just the current saved text for this exercise for
514
 
    this user (doesn't count towards their attempts).
515
 
    ExerciseSave may be extended with additional semantics (such as
516
 
    ExerciseAttempt).
517
 
    """
 
986
    """A potential exercise solution submitted by a user for storage.
 
987
 
 
988
    This is not an actual tested attempt at an exercise, it's just a save of
 
989
    the editing session.
 
990
    """
 
991
 
518
992
    __storm_table__ = "exercise_save"
519
993
    __storm_primary__ = "ws_ex_id", "user_id"
520
994
 
533
1007
            self.exercise.name, self.user.login, self.date.strftime("%c"))
534
1008
 
535
1009
class ExerciseAttempt(ExerciseSave):
536
 
    """
537
 
    An ExerciseAttempt is a special case of an ExerciseSave. Like an
538
 
    ExerciseSave, it constitutes exercise solution data that the user has
539
 
    submitted to the server for storage.
540
 
    In addition, it contains additional information about the submission.
541
 
    complete - True if this submission was successful, rendering this exercise
542
 
        complete for this user.
543
 
    active - True if this submission is "active" (usually true). Submissions
544
 
        may be de-activated by privileged users for special reasons, and then
545
 
        they won't count (either as a penalty or success), but will still be
546
 
        stored.
547
 
    """
 
1010
    """An attempt at solving an exercise.
 
1011
 
 
1012
    This is a special case of ExerciseSave, used when the user submits a
 
1013
    candidate solution. Like an ExerciseSave, it constitutes exercise solution
 
1014
    data.
 
1015
 
 
1016
    In addition, it contains information about the result of the submission:
 
1017
 
 
1018
     - complete - True if this submission was successful, rendering this
 
1019
                  exercise complete for this user in this worksheet.
 
1020
     - active   - True if this submission is "active" (usually true).
 
1021
                  Submissions may be de-activated by privileged users for
 
1022
                  special reasons, and then they won't count (either as a
 
1023
                  penalty or success), but will still be stored.
 
1024
    """
 
1025
 
548
1026
    __storm_table__ = "exercise_attempt"
549
1027
    __storm_primary__ = "ws_ex_id", "user_id", "date"
550
1028
 
553
1031
    text = Unicode(name="attempt")
554
1032
    complete = Bool()
555
1033
    active = Bool()
556
 
    
 
1034
 
557
1035
    def get_permissions(self, user):
558
1036
        return set(['view']) if user is self.user else set()
559
 
  
 
1037
 
560
1038
class TestSuite(Storm):
561
 
    """A Testsuite acts as a container for the test cases of an exercise."""
 
1039
    """A container to group an exercise's test cases.
 
1040
 
 
1041
    The test suite contains some information on how to test. The function to
 
1042
    test, variables to set and stdin data are stored here.
 
1043
    """
 
1044
 
562
1045
    __storm_table__ = "test_suite"
563
1046
    __storm_primary__ = "exercise_id", "suiteid"
564
 
    
 
1047
 
565
1048
    suiteid = Int()
566
1049
    exercise_id = Unicode(name="exerciseid")
567
1050
    description = Unicode()
569
1052
    function = Unicode()
570
1053
    stdin = Unicode()
571
1054
    exercise = Reference(exercise_id, Exercise.id)
572
 
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
573
 
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
 
1055
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
 
1056
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
 
1057
 
 
1058
    def delete(self):
 
1059
        """Delete this suite, without asking questions."""
 
1060
        for variable in self.variables:
 
1061
            variable.delete()
 
1062
        for test_case in self.test_cases:
 
1063
            test_case.delete()
 
1064
        Store.of(self).remove(self)
574
1065
 
575
1066
class TestCase(Storm):
576
 
    """A TestCase is a member of a TestSuite.
577
 
    
578
 
    It contains the data necessary to check if an exercise is correct"""
 
1067
    """A container for actual tests (see TestCasePart), inside a test suite.
 
1068
 
 
1069
    It is the lowest level shown to students on their pass/fail status."""
 
1070
 
579
1071
    __storm_table__ = "test_case"
580
1072
    __storm_primary__ = "testid", "suiteid"
581
 
    
 
1073
 
582
1074
    testid = Int()
583
1075
    suiteid = Int()
584
1076
    suite = Reference(suiteid, "TestSuite.suiteid")
585
1077
    passmsg = Unicode()
586
1078
    failmsg = Unicode()
587
 
    test_default = Unicode()
 
1079
    test_default = Unicode() # Currently unused - only used for file matching.
588
1080
    seq_no = Int()
589
 
    
 
1081
 
590
1082
    parts = ReferenceSet(testid, "TestCasePart.testid")
591
 
    
 
1083
 
592
1084
    __init__ = _kwarg_init
593
1085
 
 
1086
    def delete(self):
 
1087
        for part in self.parts:
 
1088
            part.delete()
 
1089
        Store.of(self).remove(self)
 
1090
 
594
1091
class TestSuiteVar(Storm):
595
 
    """A container for the arguments of a Test Suite"""
 
1092
    """A variable used by an exercise test suite.
 
1093
 
 
1094
    This may represent a function argument or a normal variable.
 
1095
    """
 
1096
 
596
1097
    __storm_table__ = "suite_variable"
597
1098
    __storm_primary__ = "varid"
598
 
    
 
1099
 
599
1100
    varid = Int()
600
1101
    suiteid = Int()
601
1102
    var_name = Unicode()
602
1103
    var_value = Unicode()
603
1104
    var_type = Unicode()
604
1105
    arg_no = Int()
605
 
    
 
1106
 
606
1107
    suite = Reference(suiteid, "TestSuite.suiteid")
607
 
    
 
1108
 
608
1109
    __init__ = _kwarg_init
609
 
    
 
1110
 
 
1111
    def delete(self):
 
1112
        Store.of(self).remove(self)
 
1113
 
610
1114
class TestCasePart(Storm):
611
 
    """A container for the test elements of a Test Case"""
 
1115
    """An actual piece of code to test an exercise solution."""
 
1116
 
612
1117
    __storm_table__ = "test_case_part"
613
1118
    __storm_primary__ = "partid"
614
 
    
 
1119
 
615
1120
    partid = Int()
616
1121
    testid = Int()
617
 
    
 
1122
 
618
1123
    part_type = Unicode()
619
1124
    test_type = Unicode()
620
1125
    data = Unicode()
621
1126
    filename = Unicode()
622
 
    
 
1127
 
623
1128
    test = Reference(testid, "TestCase.testid")
624
 
    
 
1129
 
625
1130
    __init__ = _kwarg_init
 
1131
 
 
1132
    def delete(self):
 
1133
        Store.of(self).remove(self)