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

« back to all changes in this revision

Viewing changes to ivle/database.py

Remove Request.title.

Show diffs side-by-side

added added

removed removed

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