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

« back to all changes in this revision

Viewing changes to ivle/database.py

ivle.webapp.testing: Add, with fake request and user.
ivle.webapp.base.test: Add! Test the JSONRESTView, using the new mocks.

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
29
 
29
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
30
31
                         Reference, ReferenceSet, Bool, Storm, Desc
31
 
from storm.expr import Select, Max
32
 
from storm.exceptions import NotOneError, IntegrityError
33
32
 
34
 
from ivle.worksheet.rst import rst
 
33
import ivle.conf
 
34
import ivle.caps
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',
41
40
            'Exercise', 'Worksheet', 'WorksheetExercise',
42
41
            'ExerciseSave', 'ExerciseAttempt',
43
 
            'TestCase', 'TestSuite', 'TestSuiteVar'
 
42
            'AlreadyEnrolledError'
44
43
        ]
45
44
 
46
45
def _kwarg_init(self, **kwargs):
50
49
                % (self.__class__.__name__, k))
51
50
        setattr(self, k, v)
52
51
 
53
 
def get_conn_string(config):
54
 
    """Create a Storm connection string to the IVLE database
55
 
 
56
 
    @param config: The IVLE configuration.
57
 
    """
58
 
 
59
 
    clusterstr = ''
60
 
    if config['database']['username']:
61
 
        clusterstr += config['database']['username']
62
 
        if config['database']['password']:
63
 
            clusterstr += ':' + config['database']['password']
64
 
        clusterstr += '@'
65
 
 
66
 
    host = config['database']['host'] or 'localhost'
67
 
    port = config['database']['port'] or 5432
68
 
 
69
 
    clusterstr += '%s:%d' % (host, port)
70
 
 
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)))
 
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()))
79
66
 
80
67
# USERS #
81
68
 
82
69
class User(Storm):
83
 
    """An IVLE user account."""
 
70
    """
 
71
    Represents an IVLE user.
 
72
    """
84
73
    __storm_table__ = "login"
85
74
 
86
75
    id = Int(primary=True, name="loginid")
87
76
    login = Unicode()
88
77
    passhash = Unicode()
89
78
    state = Unicode()
90
 
    admin = Bool()
 
79
    rolenm = Unicode()
91
80
    unixid = Int()
92
81
    nick = Unicode()
93
82
    pass_exp = DateTime()
99
88
    studentid = Unicode()
100
89
    settings = Unicode()
101
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
 
102
101
    __init__ = _kwarg_init
103
102
 
104
103
    def __repr__(self):
115
114
            return None
116
115
        return self.hash_password(password) == self.passhash
117
116
 
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
 
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)
127
122
 
128
123
    @property
129
124
    def password_expired(self):
135
130
        fieldval = self.acct_exp
136
131
        return fieldval is not None and datetime.datetime.now() > fieldval
137
132
 
138
 
    @property
139
 
    def valid(self):
140
 
        return self.state == 'enabled' and not self.account_expired
141
 
 
142
133
    def _get_enrolments(self, justactive):
143
134
        return Store.of(self).find(Enrolment,
144
135
            Enrolment.user_id == self.id,
168
159
 
169
160
    # TODO: Invitations should be listed too?
170
161
    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
 
        """
175
162
        preds = [
176
163
            ProjectGroupMembership.user_id == self.id,
177
164
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
197
184
        '''A sanely ordered list of all of the user's enrolments.'''
198
185
        return self._get_enrolments(False) 
199
186
 
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
 
 
220
187
    @staticmethod
221
188
    def hash_password(password):
222
 
        """Hash a password with MD5."""
223
 
        return hashlib.md5(password).hexdigest()
 
189
        return md5.md5(password).hexdigest()
224
190
 
225
191
    @classmethod
226
192
    def get_by_login(cls, store, login):
227
 
        """Find a user in a store by login name."""
 
193
        """
 
194
        Get the User from the db associated with a given store and
 
195
        login.
 
196
        """
228
197
        return store.find(cls, cls.login == unicode(login)).one()
229
198
 
230
 
    def get_permissions(self, user):
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'])
238
 
        else:
239
 
            return set(['view_public'])
240
 
 
241
199
# SUBJECTS AND ENROLMENTS #
242
200
 
243
201
class Subject(Storm):
244
 
    """A subject (or course) which is run in some semesters."""
245
 
 
246
202
    __storm_table__ = "subject"
247
203
 
248
204
    id = Int(primary=True, name="subjectid")
258
214
    def __repr__(self):
259
215
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
260
216
 
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
 
        """
267
 
        perms = set()
268
 
        if user is not None:
269
 
            perms.add('view')
270
 
            if user.admin:
271
 
                perms.add('edit')
272
 
        return perms
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
 
 
294
217
class Semester(Storm):
295
 
    """A semester in which subjects can be run."""
296
 
 
297
218
    __storm_table__ = "semester"
298
219
 
299
220
    id = Int(primary=True, name="semesterid")
300
221
    year = Unicode()
301
222
    semester = Unicode()
302
 
    state = Unicode()
 
223
    active = Bool()
303
224
 
304
225
    offerings = ReferenceSet(id, 'Offering.semester_id')
305
 
    enrolments = ReferenceSet(id,
306
 
                              'Offering.semester_id',
307
 
                              'Offering.id',
308
 
                              'Enrolment.offering_id')
309
226
 
310
227
    __init__ = _kwarg_init
311
228
 
313
230
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
314
231
 
315
232
class Offering(Storm):
316
 
    """An offering of a subject in a particular semester."""
317
 
 
318
233
    __storm_table__ = "offering"
319
234
 
320
235
    id = Int(primary=True, name="offeringid")
331
246
                           'User.id')
332
247
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
333
248
 
334
 
    worksheets = ReferenceSet(id, 
335
 
        'Worksheet.offering_id', 
336
 
        order_by="seq_no"
337
 
    )
338
 
 
339
249
    __init__ = _kwarg_init
340
250
 
341
251
    def __repr__(self):
342
252
        return "<%s %r in %r>" % (type(self).__name__, self.subject,
343
253
                                  self.semester)
344
254
 
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)
368
 
 
369
 
    def get_permissions(self, user):
370
 
        perms = set()
371
 
        if user is not None:
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:
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
386
 
        return perms
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')
 
255
    def enrol(self, user):
 
256
        '''Enrol a user in this offering.'''
 
257
        # We'll get a horrible database constraint violation error if we try
 
258
        # to add a second enrolment.
 
259
        if Store.of(self).find(Enrolment,
 
260
                               Enrolment.user_id == user.id,
 
261
                               Enrolment.offering_id == self.id).count() == 1:
 
262
            raise AlreadyEnrolledError()
 
263
 
 
264
        e = Enrolment(user=user, offering=self, active=True)
 
265
        self.enrolments.add(e)
407
266
 
408
267
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
 
 
414
268
    __storm_table__ = "enrolment"
415
269
    __storm_primary__ = "user_id", "offering_id"
416
270
 
418
272
    user = Reference(user_id, User.id)
419
273
    offering_id = Int(name="offeringid")
420
274
    offering = Reference(offering_id, Offering.id)
421
 
    role = Unicode()
422
275
    notes = Unicode()
423
276
    active = Bool()
424
277
 
436
289
        return "<%s %r in %r>" % (type(self).__name__, self.user,
437
290
                                  self.offering)
438
291
 
 
292
class AlreadyEnrolledError(Exception):
 
293
    pass
 
294
 
439
295
# PROJECTS #
440
296
 
441
297
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
 
 
448
298
    __storm_table__ = "project_set"
449
299
 
450
300
    id = Int(name="projectsetid", primary=True)
461
311
        return "<%s %d in %r>" % (type(self).__name__, self.id,
462
312
                                  self.offering)
463
313
 
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
 
 
483
314
class Project(Storm):
484
 
    """A student project for which submissions can be made."""
485
 
 
486
315
    __storm_table__ = "project"
487
316
 
488
317
    id = Int(name="projectid", primary=True)
489
 
    name = Unicode()
490
 
    short_name = Unicode()
491
318
    synopsis = Unicode()
492
319
    url = Unicode()
493
320
    project_set_id = Int(name="projectsetid")
494
321
    project_set = Reference(project_set_id, ProjectSet.id)
495
322
    deadline = DateTime()
496
323
 
497
 
    assesseds = ReferenceSet(id, 'Assessed.project_id')
498
 
    submissions = ReferenceSet(id,
499
 
                               'Assessed.project_id',
500
 
                               'Assessed.id',
501
 
                               'ProjectSubmission.assessed_id')
502
 
 
503
324
    __init__ = _kwarg_init
504
325
 
505
326
    def __repr__(self):
506
 
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
 
327
        return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
507
328
                                  self.project_set.offering)
508
329
 
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
 
 
553
330
class ProjectGroup(Storm):
554
 
    """A group of students working together on a project."""
555
 
 
556
331
    __storm_table__ = "project_group"
557
332
 
558
333
    id = Int(name="groupid", primary=True)
575
350
        return "<%s %s in %r>" % (type(self).__name__, self.name,
576
351
                                  self.project_set.offering)
577
352
 
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
 
 
614
353
class ProjectGroupMembership(Storm):
615
 
    """A student's membership in a project group."""
616
 
 
617
354
    __storm_table__ = "group_member"
618
355
    __storm_primary__ = "user_id", "project_group_id"
619
356
 
628
365
        return "<%s %r in %r>" % (type(self).__name__, self.user,
629
366
                                  self.project_group)
630
367
 
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
 
 
731
368
# WORKSHEETS AND EXERCISES #
732
369
 
733
370
class Exercise(Storm):
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"
740
 
    id = Unicode(primary=True, name="identifier")
741
 
    name = Unicode()
742
 
    description = Unicode()
743
 
    partial = Unicode()
744
 
    solution = Unicode()
745
 
    include = Unicode()
746
 
    num_rows = Int()
747
 
 
748
 
    worksheet_exercises =  ReferenceSet(id,
749
 
        'WorksheetExercise.exercise_id')
 
371
    # Note: Table "problem" is called "Exercise" in the Object layer, since
 
372
    # it's called that everywhere else.
 
373
    __storm_table__ = "problem"
 
374
 
 
375
    id = Int(primary=True, name="problemid")
 
376
    name = Unicode(name="identifier")
 
377
    spec = Unicode()
750
378
 
751
379
    worksheets = ReferenceSet(id,
752
380
        'WorksheetExercise.exercise_id',
754
382
        'Worksheet.id'
755
383
    )
756
384
 
757
 
    test_suites = ReferenceSet(id, 
758
 
        'TestSuite.exercise_id',
759
 
        order_by='seq_no')
760
 
 
761
385
    __init__ = _kwarg_init
762
386
 
763
387
    def __repr__(self):
764
388
        return "<%s %s>" % (type(self).__name__, self.name)
765
389
 
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)
 
390
    @classmethod
 
391
    def get_by_name(cls, store, name):
 
392
        """
 
393
        Get the Exercise from the db associated with a given store and name.
 
394
        If the exercise is not in the database, creates it and inserts it
 
395
        automatically.
 
396
        """
 
397
        ex = store.find(cls, cls.name == unicode(name)).one()
 
398
        if ex is not None:
 
399
            return ex
 
400
        ex = Exercise(name=unicode(name))
 
401
        store.add(ex)
 
402
        store.commit()
 
403
        return ex
793
404
 
794
405
class Worksheet(Storm):
795
 
    """A worksheet with exercises for students to complete.
796
 
 
797
 
    Worksheets are owned by offerings.
798
 
    """
799
 
 
800
406
    __storm_table__ = "worksheet"
801
407
 
802
408
    id = Int(primary=True, name="worksheetid")
803
 
    offering_id = Int(name="offeringid")
804
 
    identifier = Unicode()
805
 
    name = Unicode()
 
409
    # XXX subject is not linked to a Subject object. This is a property of
 
410
    # the database, and will be refactored.
 
411
    subject = Unicode()
 
412
    name = Unicode(name="identifier")
806
413
    assessable = Bool()
807
 
    data = Unicode()
808
 
    seq_no = Int()
809
 
    format = Unicode()
810
 
 
811
 
    attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
812
 
    offering = Reference(offering_id, 'Offering.id')
813
 
 
814
 
    all_worksheet_exercises = ReferenceSet(id,
 
414
    mtime = DateTime()
 
415
 
 
416
    exercises = ReferenceSet(id,
 
417
        'WorksheetExercise.worksheet_id',
 
418
        'WorksheetExercise.exercise_id',
 
419
        Exercise.id)
 
420
    # Use worksheet_exercises to get access to the WorksheetExercise objects
 
421
    # binding worksheets to exercises. This is required to access the
 
422
    # "optional" field.
 
423
    worksheet_exercises = ReferenceSet(id,
815
424
        'WorksheetExercise.worksheet_id')
816
425
 
817
 
    # Use worksheet_exercises to get access to the *active* WorksheetExercise
818
 
    # objects binding worksheets to exercises. This is required to access the
819
 
    # "optional" field.
820
 
 
821
 
    @property
822
 
    def worksheet_exercises(self):
823
 
        return self.all_worksheet_exercises.find(active=True)
824
 
 
825
426
    __init__ = _kwarg_init
826
427
 
827
428
    def __repr__(self):
828
429
        return "<%s %s>" % (type(self).__name__, self.name)
829
430
 
830
 
    def remove_all_exercises(self):
831
 
        """Remove all exercises from this worksheet.
 
431
    # XXX Refactor this - make it an instance method of Subject rather than a
 
432
    # class method of Worksheet. Can't do that now because Subject isn't
 
433
    # linked referentially to the Worksheet.
 
434
    @classmethod
 
435
    def get_by_name(cls, store, subjectname, worksheetname):
 
436
        """
 
437
        Get the Worksheet from the db associated with a given store, subject
 
438
        name and worksheet name.
 
439
        """
 
440
        return store.find(cls, cls.subject == unicode(subjectname),
 
441
            cls.name == unicode(worksheetname)).one()
832
442
 
 
443
    def remove_all_exercises(self, store):
 
444
        """
 
445
        Remove all exercises from this worksheet.
833
446
        This does not delete the exercises themselves. It just removes them
834
447
        from the worksheet.
835
448
        """
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()
840
449
        store.find(WorksheetExercise,
841
450
            WorksheetExercise.worksheet == self).remove()
842
451
 
843
 
    def get_permissions(self, user):
844
 
        return self.offering.get_permissions(user)
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
 
 
866
452
class WorksheetExercise(Storm):
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")
 
453
    __storm_table__ = "worksheet_problem"
 
454
    __storm_primary__ = "worksheet_id", "exercise_id"
877
455
 
878
456
    worksheet_id = Int(name="worksheetid")
879
457
    worksheet = Reference(worksheet_id, Worksheet.id)
880
 
    exercise_id = Unicode(name="exerciseid")
 
458
    exercise_id = Int(name="problemid")
881
459
    exercise = Reference(exercise_id, Exercise.id)
882
460
    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")
888
461
 
889
462
    __init__ = _kwarg_init
890
463
 
891
464
    def __repr__(self):
892
465
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
893
 
                                  self.worksheet.identifier)
894
 
 
895
 
    def get_permissions(self, user):
896
 
        return self.worksheet.get_permissions(user)
897
 
 
 
466
                                  self.worksheet.name)
898
467
 
899
468
class ExerciseSave(Storm):
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
 
 
 
469
    """
 
470
    Represents a potential solution to an exercise that a user has submitted
 
471
    to the server for storage.
 
472
    A basic ExerciseSave is just the current saved text for this exercise for
 
473
    this user (doesn't count towards their attempts).
 
474
    ExerciseSave may be extended with additional semantics (such as
 
475
    ExerciseAttempt).
 
476
    """
 
477
    __storm_table__ = "problem_save"
 
478
    __storm_primary__ = "exercise_id", "user_id", "date"
 
479
 
 
480
    exercise_id = Int(name="problemid")
 
481
    exercise = Reference(exercise_id, Exercise.id)
912
482
    user_id = Int(name="loginid")
913
483
    user = Reference(user_id, User.id)
914
484
    date = DateTime()
921
491
            self.exercise.name, self.user.login, self.date.strftime("%c"))
922
492
 
923
493
class ExerciseAttempt(ExerciseSave):
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"
 
494
    """
 
495
    An ExerciseAttempt is a special case of an ExerciseSave. Like an
 
496
    ExerciseSave, it constitutes exercise solution data that the user has
 
497
    submitted to the server for storage.
 
498
    In addition, it contains additional information about the submission.
 
499
    complete - True if this submission was successful, rendering this exercise
 
500
        complete for this user.
 
501
    active - True if this submission is "active" (usually true). Submissions
 
502
        may be de-activated by privileged users for special reasons, and then
 
503
        they won't count (either as a penalty or success), but will still be
 
504
        stored.
 
505
    """
 
506
    __storm_table__ = "problem_attempt"
 
507
    __storm_primary__ = "exercise_id", "user_id", "date"
942
508
 
943
509
    # The "text" field is the same but has a different name in the DB table
944
510
    # for some reason.
945
511
    text = Unicode(name="attempt")
946
512
    complete = Bool()
947
513
    active = Bool()
948
 
 
949
 
    def get_permissions(self, user):
950
 
        return set(['view']) if user is self.user else set()
951
 
 
952
 
class TestSuite(Storm):
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
 
 
959
 
    __storm_table__ = "test_suite"
960
 
    __storm_primary__ = "exercise_id", "suiteid"
961
 
 
962
 
    suiteid = Int()
963
 
    exercise_id = Unicode(name="exerciseid")
964
 
    description = Unicode()
965
 
    seq_no = Int()
966
 
    function = Unicode()
967
 
    stdin = Unicode()
968
 
    exercise = Reference(exercise_id, Exercise.id)
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 vaariable in self.variables:
975
 
            variable.delete()
976
 
        for test_case in self.test_cases:
977
 
            test_case.delete()
978
 
        Store.of(self).remove(self)
979
 
 
980
 
class TestCase(Storm):
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
 
 
985
 
    __storm_table__ = "test_case"
986
 
    __storm_primary__ = "testid", "suiteid"
987
 
 
988
 
    testid = Int()
989
 
    suiteid = Int()
990
 
    suite = Reference(suiteid, "TestSuite.suiteid")
991
 
    passmsg = Unicode()
992
 
    failmsg = Unicode()
993
 
    test_default = Unicode() # Currently unused - only used for file matching.
994
 
    seq_no = Int()
995
 
 
996
 
    parts = ReferenceSet(testid, "TestCasePart.testid")
997
 
 
998
 
    __init__ = _kwarg_init
999
 
 
1000
 
    def delete(self):
1001
 
        for part in self.parts:
1002
 
            part.delete()
1003
 
        Store.of(self).remove(self)
1004
 
 
1005
 
class TestSuiteVar(Storm):
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"
1012
 
    __storm_primary__ = "varid"
1013
 
 
1014
 
    varid = Int()
1015
 
    suiteid = Int()
1016
 
    var_name = Unicode()
1017
 
    var_value = Unicode()
1018
 
    var_type = Unicode()
1019
 
    arg_no = Int()
1020
 
 
1021
 
    suite = Reference(suiteid, "TestSuite.suiteid")
1022
 
 
1023
 
    __init__ = _kwarg_init
1024
 
 
1025
 
    def delete(self):
1026
 
        Store.of(self).remove(self)
1027
 
 
1028
 
class TestCasePart(Storm):
1029
 
    """An actual piece of code to test an exercise solution."""
1030
 
 
1031
 
    __storm_table__ = "test_case_part"
1032
 
    __storm_primary__ = "partid"
1033
 
 
1034
 
    partid = Int()
1035
 
    testid = Int()
1036
 
 
1037
 
    part_type = Unicode()
1038
 
    test_type = Unicode()
1039
 
    data = Unicode()
1040
 
    filename = Unicode()
1041
 
 
1042
 
    test = Reference(testid, "TestCase.testid")
1043
 
 
1044
 
    __init__ = _kwarg_init
1045
 
 
1046
 
    def delete(self):
1047
 
        Store.of(self).remove(self)