~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-26 09:06:48 UTC
  • Revision ID: grantw@unimelb.edu.au-20100226090648-z4fucu6maytam4f8
Add upgrade docs.

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
 
28
import os
29
29
 
30
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
31
                         Reference, ReferenceSet, Bool, Storm, Desc
 
32
from storm.expr import Select, Max
 
33
from storm.exceptions import NotOneError, IntegrityError
32
34
 
33
 
import ivle.conf
34
 
import ivle.caps
 
35
from ivle.worksheet.rst import rst
35
36
 
36
37
__all__ = ['get_store',
37
38
            'User',
38
39
            'Subject', 'Semester', 'Offering', 'Enrolment',
39
40
            'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
 
41
            'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
42
            'Exercise', 'Worksheet', 'WorksheetExercise',
41
43
            'ExerciseSave', 'ExerciseAttempt',
42
 
            'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
 
44
            'TestCase', 'TestSuite', 'TestSuiteVar'
43
45
        ]
44
46
 
45
47
def _kwarg_init(self, **kwargs):
49
51
                % (self.__class__.__name__, k))
50
52
        setattr(self, k, v)
51
53
 
52
 
def get_conn_string():
53
 
    """
54
 
    Returns the Storm connection string, generated from the conf file.
 
54
def get_conn_string(config):
 
55
    """Create a Storm connection string to the IVLE database
 
56
 
 
57
    @param config: The IVLE configuration.
55
58
    """
56
59
 
57
60
    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
 
61
    if config['database']['username']:
 
62
        clusterstr += config['database']['username']
 
63
        if config['database']['password']:
 
64
            clusterstr += ':' + config['database']['password']
62
65
        clusterstr += '@'
63
66
 
64
 
    host = ivle.conf.db_host or 'localhost'
65
 
    port = ivle.conf.db_port or 5432
 
67
    host = config['database']['host'] or 'localhost'
 
68
    port = config['database']['port'] or 5432
66
69
 
67
70
    clusterstr += '%s:%d' % (host, port)
68
71
 
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()))
 
72
    return "postgres://%s/%s" % (clusterstr, config['database']['name'])
 
73
 
 
74
def get_store(config):
 
75
    """Create a Storm store connected to the IVLE database.
 
76
 
 
77
    @param config: The IVLE configuration.
 
78
    """
 
79
    return Store(create_database(get_conn_string(config)))
77
80
 
78
81
# USERS #
79
82
 
80
83
class User(Storm):
81
 
    """
82
 
    Represents an IVLE user.
83
 
    """
 
84
    """An IVLE user account."""
84
85
    __storm_table__ = "login"
85
86
 
86
87
    id = Int(primary=True, name="loginid")
87
88
    login = Unicode()
88
89
    passhash = Unicode()
89
90
    state = Unicode()
90
 
    rolenm = Unicode()
 
91
    admin = Bool()
91
92
    unixid = Int()
92
93
    nick = Unicode()
93
94
    pass_exp = DateTime()
99
100
    studentid = Unicode()
100
101
    settings = Unicode()
101
102
 
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
103
    __init__ = _kwarg_init
113
104
 
114
105
    def __repr__(self):
125
116
            return None
126
117
        return self.hash_password(password) == self.passhash
127
118
 
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)
 
119
    @property
 
120
    def display_name(self):
 
121
        """Returns the "nice name" of the user or group."""
 
122
        return self.fullname
 
123
 
 
124
    @property
 
125
    def short_name(self):
 
126
        """Returns the database "identifier" name of the user or group."""
 
127
        return self.login
133
128
 
134
129
    @property
135
130
    def password_expired(self):
174
169
 
175
170
    # TODO: Invitations should be listed too?
176
171
    def get_groups(self, offering=None):
 
172
        """Get groups of which this user is a member.
 
173
 
 
174
        @param offering: An optional offering to restrict the search to.
 
175
        """
177
176
        preds = [
178
177
            ProjectGroupMembership.user_id == self.id,
179
178
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
199
198
        '''A sanely ordered list of all of the user's enrolments.'''
200
199
        return self._get_enrolments(False) 
201
200
 
 
201
    def get_projects(self, offering=None, active_only=True):
 
202
        """Find projects that the user can submit.
 
203
 
 
204
        This will include projects for offerings in which the user is
 
205
        enrolled, as long as the project is not in a project set which has
 
206
        groups (ie. if maximum number of group members is 0).
 
207
 
 
208
        @param active_only: Whether to only search active offerings.
 
209
        @param offering: An optional offering to restrict the search to.
 
210
        """
 
211
        return Store.of(self).find(Project,
 
212
            Project.project_set_id == ProjectSet.id,
 
213
            ProjectSet.max_students_per_group == None,
 
214
            ProjectSet.offering_id == Offering.id,
 
215
            (offering is None) or (Offering.id == offering.id),
 
216
            Semester.id == Offering.semester_id,
 
217
            (not active_only) or (Semester.state == u'current'),
 
218
            Enrolment.offering_id == Offering.id,
 
219
            Enrolment.user_id == self.id,
 
220
            Enrolment.active == True)
 
221
 
202
222
    @staticmethod
203
223
    def hash_password(password):
204
 
        return md5.md5(password).hexdigest()
 
224
        """Hash a password with MD5."""
 
225
        return hashlib.md5(password).hexdigest()
205
226
 
206
227
    @classmethod
207
228
    def get_by_login(cls, store, login):
208
 
        """
209
 
        Get the User from the db associated with a given store and
210
 
        login.
211
 
        """
 
229
        """Find a user in a store by login name."""
212
230
        return store.find(cls, cls.login == unicode(login)).one()
213
231
 
214
 
    def get_permissions(self, user):
215
 
        if user and user.rolenm == 'admin' or user is self:
216
 
            return set(['view', 'edit'])
 
232
    def get_permissions(self, user, config):
 
233
        """Determine privileges held by a user over this object.
 
234
 
 
235
        If the user requesting privileges is this user or an admin,
 
236
        they may do everything. Otherwise they may do nothing.
 
237
        """
 
238
        if user and user.admin or user is self:
 
239
            return set(['view_public', 'view', 'edit', 'submit_project'])
217
240
        else:
218
 
            return set()
 
241
            return set(['view_public'])
219
242
 
220
243
# SUBJECTS AND ENROLMENTS #
221
244
 
222
245
class Subject(Storm):
 
246
    """A subject (or course) which is run in some semesters."""
 
247
 
223
248
    __storm_table__ = "subject"
224
249
 
225
250
    id = Int(primary=True, name="subjectid")
226
251
    code = Unicode(name="subj_code")
227
252
    name = Unicode(name="subj_name")
228
253
    short_name = Unicode(name="subj_short_name")
229
 
    url = Unicode()
230
254
 
231
255
    offerings = ReferenceSet(id, 'Offering.subject_id')
232
256
 
235
259
    def __repr__(self):
236
260
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
237
261
 
238
 
    def get_permissions(self, user):
 
262
    def get_permissions(self, user, config):
 
263
        """Determine privileges held by a user over this object.
 
264
 
 
265
        If the user requesting privileges is an admin, they may edit.
 
266
        Otherwise they may only read.
 
267
        """
239
268
        perms = set()
240
269
        if user is not None:
241
270
            perms.add('view')
242
 
            if user.rolenm == 'admin':
 
271
            if user.admin:
243
272
                perms.add('edit')
244
273
        return perms
245
274
 
 
275
    def active_offerings(self):
 
276
        """Find active offerings for this subject.
 
277
 
 
278
        Return a sequence of currently active offerings for this subject
 
279
        (offerings whose semester.state is "current"). There should be 0 or 1
 
280
        elements in this sequence, but it's possible there are more.
 
281
        """
 
282
        return self.offerings.find(Offering.semester_id == Semester.id,
 
283
                                   Semester.state == u'current')
 
284
 
 
285
    def offering_for_semester(self, year, semester):
 
286
        """Get the offering for the given year/semester, or None.
 
287
 
 
288
        @param year: A string representation of the year.
 
289
        @param semester: A string representation of the semester.
 
290
        """
 
291
        return self.offerings.find(Offering.semester_id == Semester.id,
 
292
                               Semester.year == unicode(year),
 
293
                               Semester.semester == unicode(semester)).one()
 
294
 
246
295
class Semester(Storm):
 
296
    """A semester in which subjects can be run."""
 
297
 
247
298
    __storm_table__ = "semester"
248
299
 
249
300
    id = Int(primary=True, name="semesterid")
250
301
    year = Unicode()
251
302
    semester = Unicode()
252
 
    active = Bool()
 
303
    state = Unicode()
253
304
 
254
305
    offerings = ReferenceSet(id, 'Offering.semester_id')
 
306
    enrolments = ReferenceSet(id,
 
307
                              'Offering.semester_id',
 
308
                              'Offering.id',
 
309
                              'Enrolment.offering_id')
255
310
 
256
311
    __init__ = _kwarg_init
257
312
 
259
314
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
260
315
 
261
316
class Offering(Storm):
 
317
    """An offering of a subject in a particular semester."""
 
318
 
262
319
    __storm_table__ = "offering"
263
320
 
264
321
    id = Int(primary=True, name="offeringid")
266
323
    subject = Reference(subject_id, Subject.id)
267
324
    semester_id = Int(name="semesterid")
268
325
    semester = Reference(semester_id, Semester.id)
 
326
    description = Unicode()
 
327
    url = Unicode()
 
328
    show_worksheet_marks = Bool()
 
329
    worksheet_cutoff = DateTime()
269
330
    groups_student_permissions = Unicode()
270
331
 
271
332
    enrolments = ReferenceSet(id, 'Enrolment.offering_id')
274
335
                           'Enrolment.user_id',
275
336
                           'User.id')
276
337
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
 
338
    projects = ReferenceSet(id,
 
339
                            'ProjectSet.offering_id',
 
340
                            'ProjectSet.id',
 
341
                            'Project.project_set_id')
277
342
 
278
 
    worksheets = ReferenceSet(id, 'Worksheet.offering_id')
 
343
    worksheets = ReferenceSet(id, 
 
344
        'Worksheet.offering_id', 
 
345
        order_by="seq_no"
 
346
    )
279
347
 
280
348
    __init__ = _kwarg_init
281
349
 
283
351
        return "<%s %r in %r>" % (type(self).__name__, self.subject,
284
352
                                  self.semester)
285
353
 
286
 
    def enrol(self, user):
287
 
        '''Enrol a user in this offering.'''
288
 
        # We'll get a horrible database constraint violation error if we try
289
 
        # to add a second enrolment.
290
 
        if Store.of(self).find(Enrolment,
291
 
                               Enrolment.user_id == user.id,
292
 
                               Enrolment.offering_id == self.id).count() == 1:
293
 
            raise AlreadyEnrolledError()
294
 
 
295
 
        e = Enrolment(user=user, offering=self, active=True)
296
 
        self.enrolments.add(e)
297
 
 
298
 
    def get_permissions(self, user):
 
354
    def enrol(self, user, role=u'student'):
 
355
        """Enrol a user in this offering.
 
356
 
 
357
        Enrolments handle both the staff and student cases. The role controls
 
358
        the privileges granted by this enrolment.
 
359
        """
 
360
        enrolment = Store.of(self).find(Enrolment,
 
361
                               Enrolment.user_id == user.id,
 
362
                               Enrolment.offering_id == self.id).one()
 
363
 
 
364
        if enrolment is None:
 
365
            enrolment = Enrolment(user=user, offering=self)
 
366
            self.enrolments.add(enrolment)
 
367
 
 
368
        enrolment.active = True
 
369
        enrolment.role = role
 
370
 
 
371
    def unenrol(self, user):
 
372
        '''Unenrol a user from this offering.'''
 
373
        enrolment = Store.of(self).find(Enrolment,
 
374
                               Enrolment.user_id == user.id,
 
375
                               Enrolment.offering_id == self.id).one()
 
376
        Store.of(enrolment).remove(enrolment)
 
377
 
 
378
    def get_permissions(self, user, config):
299
379
        perms = set()
300
380
        if user is not None:
301
 
            perms.add('view')
302
 
            if user.rolenm == 'admin':
303
 
                perms.add('edit')
 
381
            enrolment = self.get_enrolment(user)
 
382
            if enrolment or user.admin:
 
383
                perms.add('view')
 
384
            if enrolment and enrolment.role == u'tutor':
 
385
                perms.add('view_project_submissions')
 
386
                # Site-specific policy on the role of tutors
 
387
                if config['policy']['tutors_can_enrol_students']:
 
388
                    perms.add('enrol')
 
389
                    perms.add('enrol_student')
 
390
                if config['policy']['tutors_can_edit_worksheets']:
 
391
                    perms.add('edit_worksheets')
 
392
                if config['policy']['tutors_can_admin_groups']:
 
393
                    perms.add('admin_groups')
 
394
            if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
 
395
                perms.add('view_project_submissions')
 
396
                perms.add('admin_groups')
 
397
                perms.add('edit_worksheets')
 
398
                perms.add('view_worksheet_marks')
 
399
                perms.add('edit')           # Can edit projects & details
 
400
                perms.add('enrol')          # Can see enrolment screen at all
 
401
                perms.add('enrol_student')  # Can enrol students
 
402
                perms.add('enrol_tutor')    # Can enrol tutors
 
403
            if user.admin:
 
404
                perms.add('enrol_lecturer') # Can enrol lecturers
304
405
        return perms
305
406
 
 
407
    def get_enrolment(self, user):
 
408
        """Find the user's enrolment in this offering."""
 
409
        try:
 
410
            enrolment = self.enrolments.find(user=user).one()
 
411
        except NotOneError:
 
412
            enrolment = None
 
413
 
 
414
        return enrolment
 
415
 
 
416
    def get_members_by_role(self, role):
 
417
        return Store.of(self).find(User,
 
418
                Enrolment.user_id == User.id,
 
419
                Enrolment.offering_id == self.id,
 
420
                Enrolment.role == role
 
421
                ).order_by(User.login)
 
422
 
 
423
    @property
 
424
    def students(self):
 
425
        return self.get_members_by_role(u'student')
 
426
 
 
427
    def get_open_projects_for_user(self, user):
 
428
        """Find all projects currently open to submissions by a user."""
 
429
        # XXX: Respect extensions.
 
430
        return self.projects.find(Project.deadline > datetime.datetime.now())
 
431
 
 
432
    def has_worksheet_cutoff_passed(self, user):
 
433
        """Check whether the worksheet cutoff has passed.
 
434
        A user is required, in case we support extensions.
 
435
        """
 
436
        if self.worksheet_cutoff is None:
 
437
            return False
 
438
        else:
 
439
            return self.worksheet_cutoff < datetime.datetime.now()
 
440
 
 
441
    def clone_worksheets(self, source):
 
442
        """Clone all worksheets from the specified source to this offering."""
 
443
        import ivle.worksheet.utils
 
444
        for worksheet in source.worksheets:
 
445
            newws = Worksheet()
 
446
            newws.seq_no = worksheet.seq_no
 
447
            newws.identifier = worksheet.identifier
 
448
            newws.name = worksheet.name
 
449
            newws.assessable = worksheet.assessable
 
450
            newws.published = worksheet.published
 
451
            newws.data = worksheet.data
 
452
            newws.format = worksheet.format
 
453
            newws.offering = self
 
454
            Store.of(self).add(newws)
 
455
            ivle.worksheet.utils.update_exerciselist(newws)
 
456
 
 
457
 
306
458
class Enrolment(Storm):
 
459
    """An enrolment of a user in an offering.
 
460
 
 
461
    This represents the roles of both staff and students.
 
462
    """
 
463
 
307
464
    __storm_table__ = "enrolment"
308
465
    __storm_primary__ = "user_id", "offering_id"
309
466
 
311
468
    user = Reference(user_id, User.id)
312
469
    offering_id = Int(name="offeringid")
313
470
    offering = Reference(offering_id, Offering.id)
 
471
    role = Unicode()
314
472
    notes = Unicode()
315
473
    active = Bool()
316
474
 
328
486
        return "<%s %r in %r>" % (type(self).__name__, self.user,
329
487
                                  self.offering)
330
488
 
331
 
class AlreadyEnrolledError(Exception):
332
 
    pass
 
489
    def get_permissions(self, user, config):
 
490
        # A user can edit any enrolment that they could have created.
 
491
        perms = set()
 
492
        if ('enrol_' + str(self.role)) in self.offering.get_permissions(
 
493
            user, config):
 
494
            perms.add('edit')
 
495
        return perms
 
496
 
 
497
    def delete(self):
 
498
        """Delete this enrolment."""
 
499
        Store.of(self).remove(self)
 
500
 
333
501
 
334
502
# PROJECTS #
335
503
 
336
504
class ProjectSet(Storm):
 
505
    """A set of projects that share common groups.
 
506
 
 
507
    Each student project group is attached to a project set. The group is
 
508
    valid for all projects in the group's set.
 
509
    """
 
510
 
337
511
    __storm_table__ = "project_set"
338
512
 
339
513
    id = Int(name="projectsetid", primary=True)
350
524
        return "<%s %d in %r>" % (type(self).__name__, self.id,
351
525
                                  self.offering)
352
526
 
 
527
    def get_permissions(self, user, config):
 
528
        return self.offering.get_permissions(user, config)
 
529
 
 
530
    def get_groups_for_user(self, user):
 
531
        """List all groups in this offering of which the user is a member."""
 
532
        assert self.is_group
 
533
        return Store.of(self).find(
 
534
            ProjectGroup,
 
535
            ProjectGroupMembership.user_id == user.id,
 
536
            ProjectGroupMembership.project_group_id == ProjectGroup.id,
 
537
            ProjectGroup.project_set_id == self.id)
 
538
 
 
539
    def get_submission_principal(self, user):
 
540
        """Get the principal on behalf of which the user can submit.
 
541
 
 
542
        If this is a solo project set, the given user is returned. If
 
543
        the user is a member of exactly one group, all the group is
 
544
        returned. Otherwise, None is returned.
 
545
        """
 
546
        if self.is_group:
 
547
            groups = self.get_groups_for_user(user)
 
548
            if groups.count() == 1:
 
549
                return groups.one()
 
550
            else:
 
551
                return None
 
552
        else:
 
553
            return user
 
554
 
 
555
    @property
 
556
    def is_group(self):
 
557
        return self.max_students_per_group is not None
 
558
 
 
559
    @property
 
560
    def assigned(self):
 
561
        """Get the entities (groups or users) assigned to submit this project.
 
562
 
 
563
        This will be a Storm ResultSet.
 
564
        """
 
565
        #If its a solo project, return everyone in offering
 
566
        if self.is_group:
 
567
            return self.project_groups
 
568
        else:
 
569
            return self.offering.students
 
570
 
 
571
class DeadlinePassed(Exception):
 
572
    """An exception indicating that a project cannot be submitted because the
 
573
    deadline has passed."""
 
574
    def __init__(self):
 
575
        pass
 
576
    def __str__(self):
 
577
        return "The project deadline has passed"
 
578
 
353
579
class Project(Storm):
 
580
    """A student project for which submissions can be made."""
 
581
 
354
582
    __storm_table__ = "project"
355
583
 
356
584
    id = Int(name="projectid", primary=True)
 
585
    name = Unicode()
 
586
    short_name = Unicode()
357
587
    synopsis = Unicode()
358
588
    url = Unicode()
359
589
    project_set_id = Int(name="projectsetid")
360
590
    project_set = Reference(project_set_id, ProjectSet.id)
361
591
    deadline = DateTime()
362
592
 
 
593
    assesseds = ReferenceSet(id, 'Assessed.project_id')
 
594
    submissions = ReferenceSet(id,
 
595
                               'Assessed.project_id',
 
596
                               'Assessed.id',
 
597
                               'ProjectSubmission.assessed_id')
 
598
 
363
599
    __init__ = _kwarg_init
364
600
 
365
601
    def __repr__(self):
366
 
        return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
 
602
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
367
603
                                  self.project_set.offering)
368
604
 
 
605
    def can_submit(self, principal, user):
 
606
        return (self in principal.get_projects() and
 
607
                not self.has_deadline_passed(user))
 
608
 
 
609
    def submit(self, principal, path, revision, who):
 
610
        """Submit a Subversion path and revision to a project.
 
611
 
 
612
        @param principal: The owner of the Subversion repository, and the
 
613
                          entity on behalf of whom the submission is being made
 
614
        @param path: A path within that repository to submit.
 
615
        @param revision: The revision of that path to submit.
 
616
        @param who: The user who is actually making the submission.
 
617
        """
 
618
 
 
619
        if not self.can_submit(principal, who):
 
620
            raise DeadlinePassed()
 
621
 
 
622
        a = Assessed.get(Store.of(self), principal, self)
 
623
        ps = ProjectSubmission()
 
624
        # Raise SubmissionError if the path is illegal
 
625
        ps.path = ProjectSubmission.test_and_normalise_path(path)
 
626
        ps.revision = revision
 
627
        ps.date_submitted = datetime.datetime.now()
 
628
        ps.assessed = a
 
629
        ps.submitter = who
 
630
 
 
631
        return ps
 
632
 
 
633
    def get_permissions(self, user, config):
 
634
        return self.project_set.offering.get_permissions(user, config)
 
635
 
 
636
    @property
 
637
    def latest_submissions(self):
 
638
        """Return the latest submission for each Assessed."""
 
639
        return Store.of(self).find(ProjectSubmission,
 
640
            Assessed.project_id == self.id,
 
641
            ProjectSubmission.assessed_id == Assessed.id,
 
642
            ProjectSubmission.date_submitted == Select(
 
643
                    Max(ProjectSubmission.date_submitted),
 
644
                    ProjectSubmission.assessed_id == Assessed.id,
 
645
                    tables=ProjectSubmission
 
646
            )
 
647
        )
 
648
 
 
649
    def has_deadline_passed(self, user):
 
650
        """Check whether the deadline has passed."""
 
651
        # XXX: Need to respect extensions.
 
652
        return self.deadline < datetime.datetime.now()
 
653
 
 
654
    def get_submissions_for_principal(self, principal):
 
655
        """Fetch a ResultSet of all submissions by a particular principal."""
 
656
        assessed = Assessed.get(Store.of(self), principal, self)
 
657
        if assessed is None:
 
658
            return
 
659
        return assessed.submissions
 
660
 
 
661
    @property
 
662
    def can_delete(self):
 
663
        """Can only delete if there are no submissions."""
 
664
        return self.submissions.count() == 0
 
665
 
 
666
    def delete(self):
 
667
        """Delete the project. Fails if can_delete is False."""
 
668
        if not self.can_delete:
 
669
            raise IntegrityError()
 
670
        for assessed in self.assesseds:
 
671
            assessed.delete()
 
672
        Store.of(self).remove(self)
 
673
 
369
674
class ProjectGroup(Storm):
 
675
    """A group of students working together on a project."""
 
676
 
370
677
    __storm_table__ = "project_group"
371
678
 
372
679
    id = Int(name="groupid", primary=True)
389
696
        return "<%s %s in %r>" % (type(self).__name__, self.name,
390
697
                                  self.project_set.offering)
391
698
 
 
699
    @property
 
700
    def display_name(self):
 
701
        """Returns the "nice name" of the user or group."""
 
702
        return self.nick
 
703
 
 
704
    @property
 
705
    def short_name(self):
 
706
        """Returns the database "identifier" name of the user or group."""
 
707
        return self.name
 
708
 
 
709
    def get_projects(self, offering=None, active_only=True):
 
710
        '''Find projects that the group can submit.
 
711
 
 
712
        This will include projects in the project set which owns this group,
 
713
        unless the project set disallows groups (in which case none will be
 
714
        returned).
 
715
 
 
716
        @param active_only: Whether to only search active offerings.
 
717
        @param offering: An optional offering to restrict the search to.
 
718
        '''
 
719
        return Store.of(self).find(Project,
 
720
            Project.project_set_id == ProjectSet.id,
 
721
            ProjectSet.id == self.project_set.id,
 
722
            ProjectSet.max_students_per_group != None,
 
723
            ProjectSet.offering_id == Offering.id,
 
724
            (offering is None) or (Offering.id == offering.id),
 
725
            Semester.id == Offering.semester_id,
 
726
            (not active_only) or (Semester.state == u'current'))
 
727
 
 
728
 
 
729
    def get_permissions(self, user, config):
 
730
        if user.admin or user in self.members:
 
731
            return set(['submit_project'])
 
732
        else:
 
733
            return set()
 
734
 
392
735
class ProjectGroupMembership(Storm):
 
736
    """A student's membership in a project group."""
 
737
 
393
738
    __storm_table__ = "group_member"
394
739
    __storm_primary__ = "user_id", "project_group_id"
395
740
 
404
749
        return "<%s %r in %r>" % (type(self).__name__, self.user,
405
750
                                  self.project_group)
406
751
 
 
752
class Assessed(Storm):
 
753
    """A composite of a user or group combined with a project.
 
754
 
 
755
    Each project submission and extension refers to an Assessed. It is the
 
756
    sole specifier of the repository and project.
 
757
    """
 
758
 
 
759
    __storm_table__ = "assessed"
 
760
 
 
761
    id = Int(name="assessedid", primary=True)
 
762
    user_id = Int(name="loginid")
 
763
    user = Reference(user_id, User.id)
 
764
    project_group_id = Int(name="groupid")
 
765
    project_group = Reference(project_group_id, ProjectGroup.id)
 
766
 
 
767
    project_id = Int(name="projectid")
 
768
    project = Reference(project_id, Project.id)
 
769
 
 
770
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
 
771
    submissions = ReferenceSet(
 
772
        id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
 
773
 
 
774
    def __repr__(self):
 
775
        return "<%s %r in %r>" % (type(self).__name__,
 
776
            self.user or self.project_group, self.project)
 
777
 
 
778
    @property
 
779
    def is_group(self):
 
780
        """True if the Assessed is a group, False if it is a user."""
 
781
        return self.project_group is not None
 
782
 
 
783
    @property
 
784
    def principal(self):
 
785
        return self.project_group or self.user
 
786
 
 
787
    @property
 
788
    def checkout_location(self):
 
789
        """Returns the location of the Subversion workspace for this piece of
 
790
        assessment, relative to each group member's home directory."""
 
791
        subjectname = self.project.project_set.offering.subject.short_name
 
792
        if self.is_group:
 
793
            checkout_dir_name = self.principal.short_name
 
794
        else:
 
795
            checkout_dir_name = "mywork"
 
796
        return subjectname + "/" + checkout_dir_name
 
797
 
 
798
    @classmethod
 
799
    def get(cls, store, principal, project):
 
800
        """Find or create an Assessed for the given user or group and project.
 
801
 
 
802
        @param principal: The user or group.
 
803
        @param project: The project.
 
804
        """
 
805
        t = type(principal)
 
806
        if t not in (User, ProjectGroup):
 
807
            raise AssertionError('principal must be User or ProjectGroup')
 
808
 
 
809
        a = store.find(cls,
 
810
            (t is User) or (cls.project_group_id == principal.id),
 
811
            (t is ProjectGroup) or (cls.user_id == principal.id),
 
812
            cls.project_id == project.id).one()
 
813
 
 
814
        if a is None:
 
815
            a = cls()
 
816
            if t is User:
 
817
                a.user = principal
 
818
            else:
 
819
                a.project_group = principal
 
820
            a.project = project
 
821
            store.add(a)
 
822
 
 
823
        return a
 
824
 
 
825
    def delete(self):
 
826
        """Delete the assessed. Fails if there are any submissions. Deletes
 
827
        extensions."""
 
828
        if self.submissions.count() > 0:
 
829
            raise IntegrityError()
 
830
        for extension in self.extensions:
 
831
            extension.delete()
 
832
        Store.of(self).remove(self)
 
833
 
 
834
class ProjectExtension(Storm):
 
835
    """An extension granted to a user or group on a particular project.
 
836
 
 
837
    The user or group and project are specified by the Assessed.
 
838
    """
 
839
 
 
840
    __storm_table__ = "project_extension"
 
841
 
 
842
    id = Int(name="extensionid", primary=True)
 
843
    assessed_id = Int(name="assessedid")
 
844
    assessed = Reference(assessed_id, Assessed.id)
 
845
    deadline = DateTime()
 
846
    approver_id = Int(name="approver")
 
847
    approver = Reference(approver_id, User.id)
 
848
    notes = Unicode()
 
849
 
 
850
    def delete(self):
 
851
        """Delete the extension."""
 
852
        Store.of(self).remove(self)
 
853
 
 
854
class SubmissionError(Exception):
 
855
    """Denotes a validation error during submission."""
 
856
    pass
 
857
 
 
858
class ProjectSubmission(Storm):
 
859
    """A submission from a user or group repository to a particular project.
 
860
 
 
861
    The content of a submission is a single path and revision inside a
 
862
    repository. The repository is that owned by the submission's user and
 
863
    group, while the path and revision are explicit.
 
864
 
 
865
    The user or group and project are specified by the Assessed.
 
866
    """
 
867
 
 
868
    __storm_table__ = "project_submission"
 
869
 
 
870
    id = Int(name="submissionid", primary=True)
 
871
    assessed_id = Int(name="assessedid")
 
872
    assessed = Reference(assessed_id, Assessed.id)
 
873
    path = Unicode()
 
874
    revision = Int()
 
875
    submitter_id = Int(name="submitter")
 
876
    submitter = Reference(submitter_id, User.id)
 
877
    date_submitted = DateTime()
 
878
 
 
879
    def get_verify_url(self, user):
 
880
        """Get the URL for verifying this submission, within the account of
 
881
        the given user."""
 
882
        # If this is a solo project, then self.path will be prefixed with the
 
883
        # subject name. Remove the first path segment.
 
884
        submitpath = self.path[1:] if self.path[:1] == '/' else self.path
 
885
        if not self.assessed.is_group:
 
886
            if '/' in submitpath:
 
887
                submitpath = submitpath.split('/', 1)[1]
 
888
            else:
 
889
                submitpath = ''
 
890
        return "/files/%s/%s/%s?r=%d" % (user.login,
 
891
            self.assessed.checkout_location, submitpath, self.revision)
 
892
 
 
893
    @staticmethod
 
894
    def test_and_normalise_path(path):
 
895
        """Test that path is valid, and normalise it. This prevents possible
 
896
        injections using malicious paths.
 
897
        Returns the updated path, if successful.
 
898
        Raises SubmissionError if invalid.
 
899
        """
 
900
        # Ensure the path is absolute to prevent being tacked onto working
 
901
        # directories.
 
902
        # Prevent '\n' because it will break all sorts of things.
 
903
        # Prevent '[' and ']' because they can be used to inject into the
 
904
        # svn.conf.
 
905
        # Normalise to avoid resulting in ".." path segments.
 
906
        if not os.path.isabs(path):
 
907
            raise SubmissionError("Path is not absolute")
 
908
        if any(c in path for c in "\n[]"):
 
909
            raise SubmissionError("Path must not contain '\\n', '[' or ']'")
 
910
        return os.path.normpath(path)
 
911
 
407
912
# WORKSHEETS AND EXERCISES #
408
913
 
409
914
class Exercise(Storm):
410
 
    # Note: Table "problem" is called "Exercise" in the Object layer, since
411
 
    # it's called that everywhere else.
412
 
    __storm_table__ = "problem"
413
 
#TODO: Add in a field for the user-friendly identifier
 
915
    """An exercise for students to complete in a worksheet.
 
916
 
 
917
    An exercise may be present in any number of worksheets.
 
918
    """
 
919
 
 
920
    __storm_table__ = "exercise"
414
921
    id = Unicode(primary=True, name="identifier")
415
922
    name = Unicode()
416
923
    description = Unicode()
 
924
    _description_xhtml_cache = Unicode(name='description_xhtml_cache')
417
925
    partial = Unicode()
418
926
    solution = Unicode()
419
927
    include = Unicode()
420
928
    num_rows = Int()
421
929
 
 
930
    worksheet_exercises =  ReferenceSet(id,
 
931
        'WorksheetExercise.exercise_id')
 
932
 
422
933
    worksheets = ReferenceSet(id,
423
934
        'WorksheetExercise.exercise_id',
424
935
        'WorksheetExercise.worksheet_id',
425
936
        'Worksheet.id'
426
937
    )
427
 
    
428
 
    test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
 
938
 
 
939
    test_suites = ReferenceSet(id, 
 
940
        'TestSuite.exercise_id',
 
941
        order_by='seq_no')
429
942
 
430
943
    __init__ = _kwarg_init
431
944
 
432
945
    def __repr__(self):
433
946
        return "<%s %s>" % (type(self).__name__, self.name)
434
947
 
 
948
    def get_permissions(self, user, config):
 
949
        return self.global_permissions(user, config)
 
950
 
 
951
    @staticmethod
 
952
    def global_permissions(user, config):
 
953
        """Gets the set of permissions this user has over *all* exercises.
 
954
        This is used to determine who may view the exercises list, and create
 
955
        new exercises."""
 
956
        perms = set()
 
957
        roles = set()
 
958
        if user is not None:
 
959
            if user.admin:
 
960
                perms.add('edit')
 
961
                perms.add('view')
 
962
            elif u'lecturer' in set((e.role for e in user.active_enrolments)):
 
963
                perms.add('edit')
 
964
                perms.add('view')
 
965
            elif (config['policy']['tutors_can_edit_worksheets']
 
966
            and u'tutor' in set((e.role for e in user.active_enrolments))):
 
967
                # Site-specific policy on the role of tutors
 
968
                perms.add('edit')
 
969
                perms.add('view')
 
970
 
 
971
        return perms
 
972
 
 
973
    def _cache_description_xhtml(self, invalidate=False):
 
974
        # Don't regenerate an existing cache unless forced.
 
975
        if self._description_xhtml_cache is not None and not invalidate:
 
976
            return
 
977
 
 
978
        if self.description:
 
979
            self._description_xhtml_cache = rst(self.description)
 
980
        else:
 
981
            self._description_xhtml_cache = None
 
982
 
 
983
    @property
 
984
    def description_xhtml(self):
 
985
        """The XHTML exercise description, converted from reStructuredText."""
 
986
        self._cache_description_xhtml()
 
987
        return self._description_xhtml_cache
 
988
 
 
989
    def set_description(self, description):
 
990
        self.description = description
 
991
        self._cache_description_xhtml(invalidate=True)
 
992
 
 
993
    def delete(self):
 
994
        """Deletes the exercise, providing it has no associated worksheets."""
 
995
        if (self.worksheet_exercises.count() > 0):
 
996
            raise IntegrityError()
 
997
        for suite in self.test_suites:
 
998
            suite.delete()
 
999
        Store.of(self).remove(self)
435
1000
 
436
1001
class Worksheet(Storm):
 
1002
    """A worksheet with exercises for students to complete.
 
1003
 
 
1004
    Worksheets are owned by offerings.
 
1005
    """
 
1006
 
437
1007
    __storm_table__ = "worksheet"
438
1008
 
439
1009
    id = Int(primary=True, name="worksheetid")
440
 
    # XXX subject is not linked to a Subject object. This is a property of
441
 
    # the database, and will be refactored.
442
1010
    offering_id = Int(name="offeringid")
443
 
    name = Unicode(name="identifier")
 
1011
    identifier = Unicode()
 
1012
    name = Unicode()
444
1013
    assessable = Bool()
445
 
    mtime = DateTime()
 
1014
    published = Bool()
 
1015
    data = Unicode()
 
1016
    _data_xhtml_cache = Unicode(name='data_xhtml_cache')
 
1017
    seq_no = Int()
 
1018
    format = Unicode()
446
1019
 
447
1020
    attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
448
1021
    offering = Reference(offering_id, 'Offering.id')
449
1022
 
450
 
    exercises = ReferenceSet(id,
451
 
        'WorksheetExercise.worksheet_id',
452
 
        'WorksheetExercise.exercise_id',
453
 
        Exercise.id)
454
 
    # Use worksheet_exercises to get access to the WorksheetExercise objects
455
 
    # binding worksheets to exercises. This is required to access the
 
1023
    all_worksheet_exercises = ReferenceSet(id,
 
1024
        'WorksheetExercise.worksheet_id')
 
1025
 
 
1026
    # Use worksheet_exercises to get access to the *active* WorksheetExercise
 
1027
    # objects binding worksheets to exercises. This is required to access the
456
1028
    # "optional" field.
457
 
    worksheet_exercises = ReferenceSet(id,
458
 
        'WorksheetExercise.worksheet_id')
459
 
        
 
1029
 
 
1030
    @property
 
1031
    def worksheet_exercises(self):
 
1032
        return self.all_worksheet_exercises.find(active=True)
460
1033
 
461
1034
    __init__ = _kwarg_init
462
1035
 
463
1036
    def __repr__(self):
464
1037
        return "<%s %s>" % (type(self).__name__, self.name)
465
1038
 
466
 
    # XXX Refactor this - make it an instance method of Subject rather than a
467
 
    # class method of Worksheet. Can't do that now because Subject isn't
468
 
    # linked referentially to the Worksheet.
469
 
    @classmethod
470
 
    def get_by_name(cls, store, subjectname, worksheetname):
471
 
        """
472
 
        Get the Worksheet from the db associated with a given store, subject
473
 
        name and worksheet name.
474
 
        """
475
 
        return store.find(cls, cls.subject == unicode(subjectname),
476
 
            cls.name == unicode(worksheetname)).one()
 
1039
    def remove_all_exercises(self):
 
1040
        """Remove all exercises from this worksheet.
477
1041
 
478
 
    def remove_all_exercises(self, store):
479
 
        """
480
 
        Remove all exercises from this worksheet.
481
1042
        This does not delete the exercises themselves. It just removes them
482
1043
        from the worksheet.
483
1044
        """
 
1045
        store = Store.of(self)
 
1046
        for ws_ex in self.all_worksheet_exercises:
 
1047
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
1048
                raise IntegrityError()
484
1049
        store.find(WorksheetExercise,
485
1050
            WorksheetExercise.worksheet == self).remove()
486
 
            
487
 
    def get_permissions(self, user):
488
 
        return self.offering.get_permissions(user)
 
1051
 
 
1052
    def get_permissions(self, user, config):
 
1053
        offering_perms = self.offering.get_permissions(user, config)
 
1054
 
 
1055
        perms = set()
 
1056
 
 
1057
        # Anybody who can view an offering can view a published
 
1058
        # worksheet.
 
1059
        if 'view' in offering_perms and self.published:
 
1060
            perms.add('view')
 
1061
 
 
1062
        # Any worksheet editors can both view and edit.
 
1063
        if 'edit_worksheets' in offering_perms:
 
1064
            perms.add('view')
 
1065
            perms.add('edit')
 
1066
 
 
1067
        return perms
 
1068
 
 
1069
    def _cache_data_xhtml(self, invalidate=False):
 
1070
        # Don't regenerate an existing cache unless forced.
 
1071
        if self._data_xhtml_cache is not None and not invalidate:
 
1072
            return
 
1073
 
 
1074
        if self.format == u'rst':
 
1075
            self._data_xhtml_cache = rst(self.data)
 
1076
        else:
 
1077
            self._data_xhtml_cache = None
 
1078
 
 
1079
    @property
 
1080
    def data_xhtml(self):
 
1081
        """The XHTML of this worksheet, converted from rST if required."""
 
1082
        # Update the rST -> XHTML cache, if required.
 
1083
        self._cache_data_xhtml()
 
1084
 
 
1085
        if self.format == u'rst':
 
1086
            return self._data_xhtml_cache
 
1087
        else:
 
1088
            return self.data
 
1089
 
 
1090
    def set_data(self, data):
 
1091
        self.data = data
 
1092
        self._cache_data_xhtml(invalidate=True)
 
1093
 
 
1094
    def delete(self):
 
1095
        """Deletes the worksheet, provided it has no attempts on any exercises.
 
1096
 
 
1097
        Returns True if delete succeeded, or False if this worksheet has
 
1098
        attempts attached."""
 
1099
        for ws_ex in self.all_worksheet_exercises:
 
1100
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
1101
                raise IntegrityError()
 
1102
 
 
1103
        self.remove_all_exercises()
 
1104
        Store.of(self).remove(self)
489
1105
 
490
1106
class WorksheetExercise(Storm):
491
 
    __storm_table__ = "worksheet_problem"
492
 
    __storm_primary__ = "worksheet_id", "exercise_id"
 
1107
    """A link between a worksheet and one of its exercises.
 
1108
 
 
1109
    These may be marked optional, in which case the exercise does not count
 
1110
    for marking purposes. The sequence number is used to order the worksheet
 
1111
    ToC.
 
1112
    """
 
1113
 
 
1114
    __storm_table__ = "worksheet_exercise"
 
1115
 
 
1116
    id = Int(primary=True, name="ws_ex_id")
493
1117
 
494
1118
    worksheet_id = Int(name="worksheetid")
495
1119
    worksheet = Reference(worksheet_id, Worksheet.id)
496
 
    exercise_id = Unicode(name="problemid")
 
1120
    exercise_id = Unicode(name="exerciseid")
497
1121
    exercise = Reference(exercise_id, Exercise.id)
498
1122
    optional = Bool()
 
1123
    active = Bool()
 
1124
    seq_no = Int()
 
1125
 
 
1126
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
 
1127
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
499
1128
 
500
1129
    __init__ = _kwarg_init
501
1130
 
502
1131
    def __repr__(self):
503
1132
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
504
 
                                  self.worksheet.name)
 
1133
                                  self.worksheet.identifier)
 
1134
 
 
1135
    def get_permissions(self, user, config):
 
1136
        return self.worksheet.get_permissions(user, config)
 
1137
 
505
1138
 
506
1139
class ExerciseSave(Storm):
507
 
    """
508
 
    Represents a potential solution to an exercise that a user has submitted
509
 
    to the server for storage.
510
 
    A basic ExerciseSave is just the current saved text for this exercise for
511
 
    this user (doesn't count towards their attempts).
512
 
    ExerciseSave may be extended with additional semantics (such as
513
 
    ExerciseAttempt).
514
 
    """
515
 
    __storm_table__ = "problem_save"
516
 
    __storm_primary__ = "exercise_id", "user_id", "date"
517
 
 
518
 
    exercise_id = Unicode(name="problemid")
519
 
    exercise = Reference(exercise_id, Exercise.id)
 
1140
    """A potential exercise solution submitted by a user for storage.
 
1141
 
 
1142
    This is not an actual tested attempt at an exercise, it's just a save of
 
1143
    the editing session.
 
1144
    """
 
1145
 
 
1146
    __storm_table__ = "exercise_save"
 
1147
    __storm_primary__ = "ws_ex_id", "user_id"
 
1148
 
 
1149
    ws_ex_id = Int(name="ws_ex_id")
 
1150
    worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
 
1151
 
520
1152
    user_id = Int(name="loginid")
521
1153
    user = Reference(user_id, User.id)
522
1154
    date = DateTime()
523
1155
    text = Unicode()
524
 
    worksheetid = Int()
525
 
    worksheet = Reference(worksheetid, Worksheet.id)
526
1156
 
527
1157
    __init__ = _kwarg_init
528
1158
 
529
1159
    def __repr__(self):
530
1160
        return "<%s %s by %s at %s>" % (type(self).__name__,
531
 
            self.exercise.name, self.user.login, self.date.strftime("%c"))
 
1161
            self.worksheet_exercise.exercise.name, self.user.login,
 
1162
            self.date.strftime("%c"))
532
1163
 
533
1164
class ExerciseAttempt(ExerciseSave):
534
 
    """
535
 
    An ExerciseAttempt is a special case of an ExerciseSave. Like an
536
 
    ExerciseSave, it constitutes exercise solution data that the user has
537
 
    submitted to the server for storage.
538
 
    In addition, it contains additional information about the submission.
539
 
    complete - True if this submission was successful, rendering this exercise
540
 
        complete for this user.
541
 
    active - True if this submission is "active" (usually true). Submissions
542
 
        may be de-activated by privileged users for special reasons, and then
543
 
        they won't count (either as a penalty or success), but will still be
544
 
        stored.
545
 
    """
546
 
    __storm_table__ = "problem_attempt"
547
 
    __storm_primary__ = "exercise_id", "user_id", "date"
 
1165
    """An attempt at solving an exercise.
 
1166
 
 
1167
    This is a special case of ExerciseSave, used when the user submits a
 
1168
    candidate solution. Like an ExerciseSave, it constitutes exercise solution
 
1169
    data.
 
1170
 
 
1171
    In addition, it contains information about the result of the submission:
 
1172
 
 
1173
     - complete - True if this submission was successful, rendering this
 
1174
                  exercise complete for this user in this worksheet.
 
1175
     - active   - True if this submission is "active" (usually true).
 
1176
                  Submissions may be de-activated by privileged users for
 
1177
                  special reasons, and then they won't count (either as a
 
1178
                  penalty or success), but will still be stored.
 
1179
    """
 
1180
 
 
1181
    __storm_table__ = "exercise_attempt"
 
1182
    __storm_primary__ = "ws_ex_id", "user_id", "date"
548
1183
 
549
1184
    # The "text" field is the same but has a different name in the DB table
550
1185
    # for some reason.
551
1186
    text = Unicode(name="attempt")
552
1187
    complete = Bool()
553
1188
    active = Bool()
554
 
    
555
 
    def get_permissions(self, user):
 
1189
 
 
1190
    def get_permissions(self, user, config):
556
1191
        return set(['view']) if user is self.user else set()
557
 
  
 
1192
 
558
1193
class TestSuite(Storm):
559
 
    """A Testsuite acts as a container for the test cases of an exercise."""
 
1194
    """A container to group an exercise's test cases.
 
1195
 
 
1196
    The test suite contains some information on how to test. The function to
 
1197
    test, variables to set and stdin data are stored here.
 
1198
    """
 
1199
 
560
1200
    __storm_table__ = "test_suite"
561
1201
    __storm_primary__ = "exercise_id", "suiteid"
562
 
    
 
1202
 
563
1203
    suiteid = Int()
564
 
    exercise_id = Unicode(name="problemid")
 
1204
    exercise_id = Unicode(name="exerciseid")
565
1205
    description = Unicode()
566
1206
    seq_no = Int()
567
1207
    function = Unicode()
568
1208
    stdin = Unicode()
569
1209
    exercise = Reference(exercise_id, Exercise.id)
570
 
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
571
 
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
 
1210
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
 
1211
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
 
1212
 
 
1213
    def delete(self):
 
1214
        """Delete this suite, without asking questions."""
 
1215
        for variable in self.variables:
 
1216
            variable.delete()
 
1217
        for test_case in self.test_cases:
 
1218
            test_case.delete()
 
1219
        Store.of(self).remove(self)
572
1220
 
573
1221
class TestCase(Storm):
574
 
    """A TestCase is a member of a TestSuite.
575
 
    
576
 
    It contains the data necessary to check if an exercise is correct"""
 
1222
    """A container for actual tests (see TestCasePart), inside a test suite.
 
1223
 
 
1224
    It is the lowest level shown to students on their pass/fail status."""
 
1225
 
577
1226
    __storm_table__ = "test_case"
578
1227
    __storm_primary__ = "testid", "suiteid"
579
 
    
 
1228
 
580
1229
    testid = Int()
581
1230
    suiteid = Int()
582
1231
    suite = Reference(suiteid, "TestSuite.suiteid")
583
1232
    passmsg = Unicode()
584
1233
    failmsg = Unicode()
585
 
    test_default = Unicode()
 
1234
    test_default = Unicode() # Currently unused - only used for file matching.
586
1235
    seq_no = Int()
587
 
    
 
1236
 
588
1237
    parts = ReferenceSet(testid, "TestCasePart.testid")
589
 
    
 
1238
 
590
1239
    __init__ = _kwarg_init
591
1240
 
 
1241
    def delete(self):
 
1242
        for part in self.parts:
 
1243
            part.delete()
 
1244
        Store.of(self).remove(self)
 
1245
 
592
1246
class TestSuiteVar(Storm):
593
 
    """A container for the arguments of a Test Suite"""
594
 
    __storm_table__ = "suite_variables"
 
1247
    """A variable used by an exercise test suite.
 
1248
 
 
1249
    This may represent a function argument or a normal variable.
 
1250
    """
 
1251
 
 
1252
    __storm_table__ = "suite_variable"
595
1253
    __storm_primary__ = "varid"
596
 
    
 
1254
 
597
1255
    varid = Int()
598
1256
    suiteid = Int()
599
1257
    var_name = Unicode()
600
1258
    var_value = Unicode()
601
1259
    var_type = Unicode()
602
1260
    arg_no = Int()
603
 
    
 
1261
 
604
1262
    suite = Reference(suiteid, "TestSuite.suiteid")
605
 
    
 
1263
 
606
1264
    __init__ = _kwarg_init
607
 
    
 
1265
 
 
1266
    def delete(self):
 
1267
        Store.of(self).remove(self)
 
1268
 
608
1269
class TestCasePart(Storm):
609
 
    """A container for the test elements of a Test Case"""
610
 
    __storm_table__ = "test_case_parts"
 
1270
    """An actual piece of code to test an exercise solution."""
 
1271
 
 
1272
    __storm_table__ = "test_case_part"
611
1273
    __storm_primary__ = "partid"
612
 
    
 
1274
 
613
1275
    partid = Int()
614
1276
    testid = Int()
615
 
    
 
1277
 
616
1278
    part_type = Unicode()
617
1279
    test_type = Unicode()
618
1280
    data = Unicode()
619
1281
    filename = Unicode()
620
 
    
 
1282
 
621
1283
    test = Reference(testid, "TestCase.testid")
622
 
    
 
1284
 
623
1285
    __init__ = _kwarg_init
 
1286
 
 
1287
    def delete(self):
 
1288
        Store.of(self).remove(self)