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

« back to all changes in this revision

Viewing changes to ivle/database.py

  • Committer: Matt Giuca
  • Date: 2009-12-15 05:25:57 UTC
  • Revision ID: matt.giuca@gmail.com-20091215052557-p737rn9ewk0m156z
ivle.svn: Now provides the option of not saving credentials for Subversion. create_auth_svn_client_autopass does NOT save by default, as this is undesirable in the jail.

Show diffs side-by-side

added added

removed removed

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