~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-08 12:01:31 UTC
  • Revision ID: matt.giuca@gmail.com-20091208120131-1mz8aj9t2w56ij6y
Sample data: Added a new user, Terry Tutor, enrolled as a tutor in one of the subject, to test tutor permissions as distinct from lecturer permissions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2009 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Author: Matt Giuca, Will Grant
 
19
 
 
20
"""Database utilities and content classes.
 
21
 
 
22
This module provides all of the classes which map to database tables.
 
23
It also provides miscellaneous utility functions for database interaction.
 
24
"""
 
25
 
 
26
import hashlib
 
27
import datetime
 
28
 
 
29
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
 
30
                         Reference, ReferenceSet, Bool, Storm, Desc
 
31
from storm.expr import Select, Max
 
32
from storm.exceptions import NotOneError, IntegrityError
 
33
 
 
34
from ivle.worksheet.rst import rst
 
35
 
 
36
__all__ = ['get_store',
 
37
            'User',
 
38
            'Subject', 'Semester', 'Offering', 'Enrolment',
 
39
            'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
 
40
            'Assessed', 'ProjectSubmission', 'ProjectExtension',
 
41
            'Exercise', 'Worksheet', 'WorksheetExercise',
 
42
            'ExerciseSave', 'ExerciseAttempt',
 
43
            'TestCase', 'TestSuite', 'TestSuiteVar'
 
44
        ]
 
45
 
 
46
def _kwarg_init(self, **kwargs):
 
47
    for k,v in kwargs.items():
 
48
        if k.startswith('_') or not hasattr(self.__class__, k):
 
49
            raise TypeError("%s got an unexpected keyword argument '%s'"
 
50
                % (self.__class__.__name__, k))
 
51
        setattr(self, k, v)
 
52
 
 
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)))
 
79
 
 
80
# USERS #
 
81
 
 
82
class User(Storm):
 
83
    """An IVLE user account."""
 
84
    __storm_table__ = "login"
 
85
 
 
86
    id = Int(primary=True, name="loginid")
 
87
    login = Unicode()
 
88
    passhash = Unicode()
 
89
    state = Unicode()
 
90
    admin = Bool()
 
91
    unixid = Int()
 
92
    nick = Unicode()
 
93
    pass_exp = DateTime()
 
94
    acct_exp = DateTime()
 
95
    last_login = DateTime()
 
96
    svn_pass = Unicode()
 
97
    email = Unicode()
 
98
    fullname = Unicode()
 
99
    studentid = Unicode()
 
100
    settings = Unicode()
 
101
 
 
102
    __init__ = _kwarg_init
 
103
 
 
104
    def __repr__(self):
 
105
        return "<%s '%s'>" % (type(self).__name__, self.login)
 
106
 
 
107
    def authenticate(self, password):
 
108
        """Validate a given password against this user.
 
109
 
 
110
        Returns True if the given password matches the password hash for this
 
111
        User, False if it doesn't match, and None if there is no hash for the
 
112
        user.
 
113
        """
 
114
        if self.passhash is None:
 
115
            return None
 
116
        return self.hash_password(password) == self.passhash
 
117
 
 
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
 
127
 
 
128
    @property
 
129
    def password_expired(self):
 
130
        fieldval = self.pass_exp
 
131
        return fieldval is not None and datetime.datetime.now() > fieldval
 
132
 
 
133
    @property
 
134
    def account_expired(self):
 
135
        fieldval = self.acct_exp
 
136
        return fieldval is not None and datetime.datetime.now() > fieldval
 
137
 
 
138
    @property
 
139
    def valid(self):
 
140
        return self.state == 'enabled' and not self.account_expired
 
141
 
 
142
    def _get_enrolments(self, justactive):
 
143
        return Store.of(self).find(Enrolment,
 
144
            Enrolment.user_id == self.id,
 
145
            (Enrolment.active == True) if justactive else True,
 
146
            Enrolment.offering_id == Offering.id,
 
147
            Offering.semester_id == Semester.id,
 
148
            Offering.subject_id == Subject.id).order_by(
 
149
                Desc(Semester.year),
 
150
                Desc(Semester.semester),
 
151
                Desc(Subject.code)
 
152
            )
 
153
 
 
154
    def _set_password(self, password):
 
155
        if password is None:
 
156
            self.passhash = None
 
157
        else:
 
158
            self.passhash = unicode(User.hash_password(password))
 
159
    password = property(fset=_set_password)
 
160
 
 
161
    @property
 
162
    def subjects(self):
 
163
        return Store.of(self).find(Subject,
 
164
            Enrolment.user_id == self.id,
 
165
            Enrolment.active == True,
 
166
            Offering.id == Enrolment.offering_id,
 
167
            Subject.id == Offering.subject_id).config(distinct=True)
 
168
 
 
169
    # TODO: Invitations should be listed too?
 
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
        """
 
175
        preds = [
 
176
            ProjectGroupMembership.user_id == self.id,
 
177
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
 
178
        ]
 
179
        if offering:
 
180
            preds.extend([
 
181
                ProjectSet.offering_id == offering.id,
 
182
                ProjectGroup.project_set_id == ProjectSet.id,
 
183
            ])
 
184
        return Store.of(self).find(ProjectGroup, *preds)
 
185
 
 
186
    @property
 
187
    def groups(self):
 
188
        return self.get_groups()
 
189
 
 
190
    @property
 
191
    def active_enrolments(self):
 
192
        '''A sanely ordered list of the user's active enrolments.'''
 
193
        return self._get_enrolments(True)
 
194
 
 
195
    @property
 
196
    def enrolments(self):
 
197
        '''A sanely ordered list of all of the user's enrolments.'''
 
198
        return self._get_enrolments(False) 
 
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
 
 
220
    @staticmethod
 
221
    def hash_password(password):
 
222
        """Hash a password with MD5."""
 
223
        return hashlib.md5(password).hexdigest()
 
224
 
 
225
    @classmethod
 
226
    def get_by_login(cls, store, login):
 
227
        """Find a user in a store by login name."""
 
228
        return store.find(cls, cls.login == unicode(login)).one()
 
229
 
 
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
# SUBJECTS AND ENROLMENTS #
 
242
 
 
243
class Subject(Storm):
 
244
    """A subject (or course) which is run in some semesters."""
 
245
 
 
246
    __storm_table__ = "subject"
 
247
 
 
248
    id = Int(primary=True, name="subjectid")
 
249
    code = Unicode(name="subj_code")
 
250
    name = Unicode(name="subj_name")
 
251
    short_name = Unicode(name="subj_short_name")
 
252
    url = Unicode()
 
253
 
 
254
    offerings = ReferenceSet(id, 'Offering.subject_id')
 
255
 
 
256
    __init__ = _kwarg_init
 
257
 
 
258
    def __repr__(self):
 
259
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
 
260
 
 
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
class Semester(Storm):
 
295
    """A semester in which subjects can be run."""
 
296
 
 
297
    __storm_table__ = "semester"
 
298
 
 
299
    id = Int(primary=True, name="semesterid")
 
300
    year = Unicode()
 
301
    semester = Unicode()
 
302
    state = Unicode()
 
303
 
 
304
    offerings = ReferenceSet(id, 'Offering.semester_id')
 
305
    enrolments = ReferenceSet(id,
 
306
                              'Offering.semester_id',
 
307
                              'Offering.id',
 
308
                              'Enrolment.offering_id')
 
309
 
 
310
    __init__ = _kwarg_init
 
311
 
 
312
    def __repr__(self):
 
313
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
 
314
 
 
315
class Offering(Storm):
 
316
    """An offering of a subject in a particular semester."""
 
317
 
 
318
    __storm_table__ = "offering"
 
319
 
 
320
    id = Int(primary=True, name="offeringid")
 
321
    subject_id = Int(name="subject")
 
322
    subject = Reference(subject_id, Subject.id)
 
323
    semester_id = Int(name="semesterid")
 
324
    semester = Reference(semester_id, Semester.id)
 
325
    groups_student_permissions = Unicode()
 
326
 
 
327
    enrolments = ReferenceSet(id, 'Enrolment.offering_id')
 
328
    members = ReferenceSet(id,
 
329
                           'Enrolment.offering_id',
 
330
                           'Enrolment.user_id',
 
331
                           'User.id')
 
332
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
 
333
 
 
334
    worksheets = ReferenceSet(id, 
 
335
        'Worksheet.offering_id', 
 
336
        order_by="seq_no"
 
337
    )
 
338
 
 
339
    __init__ = _kwarg_init
 
340
 
 
341
    def __repr__(self):
 
342
        return "<%s %r in %r>" % (type(self).__name__, self.subject,
 
343
                                  self.semester)
 
344
 
 
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')
 
407
 
 
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
 
 
414
    __storm_table__ = "enrolment"
 
415
    __storm_primary__ = "user_id", "offering_id"
 
416
 
 
417
    user_id = Int(name="loginid")
 
418
    user = Reference(user_id, User.id)
 
419
    offering_id = Int(name="offeringid")
 
420
    offering = Reference(offering_id, Offering.id)
 
421
    role = Unicode()
 
422
    notes = Unicode()
 
423
    active = Bool()
 
424
 
 
425
    @property
 
426
    def groups(self):
 
427
        return Store.of(self).find(ProjectGroup,
 
428
                ProjectSet.offering_id == self.offering.id,
 
429
                ProjectGroup.project_set_id == ProjectSet.id,
 
430
                ProjectGroupMembership.project_group_id == ProjectGroup.id,
 
431
                ProjectGroupMembership.user_id == self.user.id)
 
432
 
 
433
    __init__ = _kwarg_init
 
434
 
 
435
    def __repr__(self):
 
436
        return "<%s %r in %r>" % (type(self).__name__, self.user,
 
437
                                  self.offering)
 
438
 
 
439
# PROJECTS #
 
440
 
 
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
 
 
448
    __storm_table__ = "project_set"
 
449
 
 
450
    id = Int(name="projectsetid", primary=True)
 
451
    offering_id = Int(name="offeringid")
 
452
    offering = Reference(offering_id, Offering.id)
 
453
    max_students_per_group = Int()
 
454
 
 
455
    projects = ReferenceSet(id, 'Project.project_set_id')
 
456
    project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
 
457
 
 
458
    __init__ = _kwarg_init
 
459
 
 
460
    def __repr__(self):
 
461
        return "<%s %d in %r>" % (type(self).__name__, self.id,
 
462
                                  self.offering)
 
463
 
 
464
    def get_permissions(self, user):
 
465
        return self.offering.get_permissions(user)
 
466
 
 
467
    @property
 
468
    def assigned(self):
 
469
        """Get the entities (groups or users) assigned to submit this project.
 
470
 
 
471
        This will be a Storm ResultSet.
 
472
        """
 
473
        #If its a solo project, return everyone in offering
 
474
        if self.max_students_per_group is None:
 
475
            return self.offering.students
 
476
        else:
 
477
            return self.project_groups
 
478
 
 
479
class Project(Storm):
 
480
    """A student project for which submissions can be made."""
 
481
 
 
482
    __storm_table__ = "project"
 
483
 
 
484
    id = Int(name="projectid", primary=True)
 
485
    name = Unicode()
 
486
    short_name = Unicode()
 
487
    synopsis = Unicode()
 
488
    url = Unicode()
 
489
    project_set_id = Int(name="projectsetid")
 
490
    project_set = Reference(project_set_id, ProjectSet.id)
 
491
    deadline = DateTime()
 
492
 
 
493
    assesseds = ReferenceSet(id, 'Assessed.project_id')
 
494
    submissions = ReferenceSet(id,
 
495
                               'Assessed.project_id',
 
496
                               'Assessed.id',
 
497
                               'ProjectSubmission.assessed_id')
 
498
 
 
499
    __init__ = _kwarg_init
 
500
 
 
501
    def __repr__(self):
 
502
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
 
503
                                  self.project_set.offering)
 
504
 
 
505
    def can_submit(self, principal):
 
506
        return (self in principal.get_projects() and
 
507
                self.deadline > datetime.datetime.now())
 
508
 
 
509
    def submit(self, principal, path, revision, who):
 
510
        """Submit a Subversion path and revision to a project.
 
511
 
 
512
        @param principal: The owner of the Subversion repository, and the
 
513
                          entity on behalf of whom the submission is being made
 
514
        @param path: A path within that repository to submit.
 
515
        @param revision: The revision of that path to submit.
 
516
        @param who: The user who is actually making the submission.
 
517
        """
 
518
 
 
519
        if not self.can_submit(principal):
 
520
            raise Exception('cannot submit')
 
521
 
 
522
        a = Assessed.get(Store.of(self), principal, self)
 
523
        ps = ProjectSubmission()
 
524
        ps.path = path
 
525
        ps.revision = revision
 
526
        ps.date_submitted = datetime.datetime.now()
 
527
        ps.assessed = a
 
528
        ps.submitter = who
 
529
 
 
530
        return ps
 
531
 
 
532
    def get_permissions(self, user):
 
533
        return self.project_set.offering.get_permissions(user)
 
534
 
 
535
    @property
 
536
    def latest_submissions(self):
 
537
        """Return the latest submission for each Assessed."""
 
538
        return Store.of(self).find(ProjectSubmission,
 
539
            Assessed.project_id == self.id,
 
540
            ProjectSubmission.assessed_id == Assessed.id,
 
541
            ProjectSubmission.date_submitted == Select(
 
542
                    Max(ProjectSubmission.date_submitted),
 
543
                    ProjectSubmission.assessed_id == Assessed.id,
 
544
                    tables=ProjectSubmission
 
545
            )
 
546
        )
 
547
 
 
548
 
 
549
class ProjectGroup(Storm):
 
550
    """A group of students working together on a project."""
 
551
 
 
552
    __storm_table__ = "project_group"
 
553
 
 
554
    id = Int(name="groupid", primary=True)
 
555
    name = Unicode(name="groupnm")
 
556
    project_set_id = Int(name="projectsetid")
 
557
    project_set = Reference(project_set_id, ProjectSet.id)
 
558
    nick = Unicode()
 
559
    created_by_id = Int(name="createdby")
 
560
    created_by = Reference(created_by_id, User.id)
 
561
    epoch = DateTime()
 
562
 
 
563
    members = ReferenceSet(id,
 
564
                           "ProjectGroupMembership.project_group_id",
 
565
                           "ProjectGroupMembership.user_id",
 
566
                           "User.id")
 
567
 
 
568
    __init__ = _kwarg_init
 
569
 
 
570
    def __repr__(self):
 
571
        return "<%s %s in %r>" % (type(self).__name__, self.name,
 
572
                                  self.project_set.offering)
 
573
 
 
574
    @property
 
575
    def display_name(self):
 
576
        """Returns the "nice name" of the user or group."""
 
577
        return self.nick
 
578
 
 
579
    @property
 
580
    def short_name(self):
 
581
        """Returns the database "identifier" name of the user or group."""
 
582
        return self.name
 
583
 
 
584
    def get_projects(self, offering=None, active_only=True):
 
585
        '''Find projects that the group can submit.
 
586
 
 
587
        This will include projects in the project set which owns this group,
 
588
        unless the project set disallows groups (in which case none will be
 
589
        returned).
 
590
 
 
591
        @param active_only: Whether to only search active offerings.
 
592
        @param offering: An optional offering to restrict the search to.
 
593
        '''
 
594
        return Store.of(self).find(Project,
 
595
            Project.project_set_id == ProjectSet.id,
 
596
            ProjectSet.id == self.project_set.id,
 
597
            ProjectSet.max_students_per_group != None,
 
598
            ProjectSet.offering_id == Offering.id,
 
599
            (offering is None) or (Offering.id == offering.id),
 
600
            Semester.id == Offering.semester_id,
 
601
            (not active_only) or (Semester.state == u'current'))
 
602
 
 
603
 
 
604
    def get_permissions(self, user):
 
605
        if user.admin or user in self.members:
 
606
            return set(['submit_project'])
 
607
        else:
 
608
            return set()
 
609
 
 
610
class ProjectGroupMembership(Storm):
 
611
    """A student's membership in a project group."""
 
612
 
 
613
    __storm_table__ = "group_member"
 
614
    __storm_primary__ = "user_id", "project_group_id"
 
615
 
 
616
    user_id = Int(name="loginid")
 
617
    user = Reference(user_id, User.id)
 
618
    project_group_id = Int(name="groupid")
 
619
    project_group = Reference(project_group_id, ProjectGroup.id)
 
620
 
 
621
    __init__ = _kwarg_init
 
622
 
 
623
    def __repr__(self):
 
624
        return "<%s %r in %r>" % (type(self).__name__, self.user,
 
625
                                  self.project_group)
 
626
 
 
627
class Assessed(Storm):
 
628
    """A composite of a user or group combined with a project.
 
629
 
 
630
    Each project submission and extension refers to an Assessed. It is the
 
631
    sole specifier of the repository and project.
 
632
    """
 
633
 
 
634
    __storm_table__ = "assessed"
 
635
 
 
636
    id = Int(name="assessedid", primary=True)
 
637
    user_id = Int(name="loginid")
 
638
    user = Reference(user_id, User.id)
 
639
    project_group_id = Int(name="groupid")
 
640
    project_group = Reference(project_group_id, ProjectGroup.id)
 
641
 
 
642
    project_id = Int(name="projectid")
 
643
    project = Reference(project_id, Project.id)
 
644
 
 
645
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
 
646
    submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
 
647
 
 
648
    def __repr__(self):
 
649
        return "<%s %r in %r>" % (type(self).__name__,
 
650
            self.user or self.project_group, self.project)
 
651
 
 
652
    @property
 
653
    def is_group(self):
 
654
        """True if the Assessed is a group, False if it is a user."""
 
655
        return self.project_group is not None
 
656
 
 
657
    @property
 
658
    def principal(self):
 
659
        return self.project_group or self.user
 
660
 
 
661
    @classmethod
 
662
    def get(cls, store, principal, project):
 
663
        """Find or create an Assessed for the given user or group and project.
 
664
 
 
665
        @param principal: The user or group.
 
666
        @param project: The project.
 
667
        """
 
668
        t = type(principal)
 
669
        if t not in (User, ProjectGroup):
 
670
            raise AssertionError('principal must be User or ProjectGroup')
 
671
 
 
672
        a = store.find(cls,
 
673
            (t is User) or (cls.project_group_id == principal.id),
 
674
            (t is ProjectGroup) or (cls.user_id == principal.id),
 
675
            Project.id == project.id).one()
 
676
 
 
677
        if a is None:
 
678
            a = cls()
 
679
            if t is User:
 
680
                a.user = principal
 
681
            else:
 
682
                a.project_group = principal
 
683
            a.project = project
 
684
            store.add(a)
 
685
 
 
686
        return a
 
687
 
 
688
 
 
689
class ProjectExtension(Storm):
 
690
    """An extension granted to a user or group on a particular project.
 
691
 
 
692
    The user or group and project are specified by the Assessed.
 
693
    """
 
694
 
 
695
    __storm_table__ = "project_extension"
 
696
 
 
697
    id = Int(name="extensionid", primary=True)
 
698
    assessed_id = Int(name="assessedid")
 
699
    assessed = Reference(assessed_id, Assessed.id)
 
700
    deadline = DateTime()
 
701
    approver_id = Int(name="approver")
 
702
    approver = Reference(approver_id, User.id)
 
703
    notes = Unicode()
 
704
 
 
705
class ProjectSubmission(Storm):
 
706
    """A submission from a user or group repository to a particular project.
 
707
 
 
708
    The content of a submission is a single path and revision inside a
 
709
    repository. The repository is that owned by the submission's user and
 
710
    group, while the path and revision are explicit.
 
711
 
 
712
    The user or group and project are specified by the Assessed.
 
713
    """
 
714
 
 
715
    __storm_table__ = "project_submission"
 
716
 
 
717
    id = Int(name="submissionid", primary=True)
 
718
    assessed_id = Int(name="assessedid")
 
719
    assessed = Reference(assessed_id, Assessed.id)
 
720
    path = Unicode()
 
721
    revision = Int()
 
722
    submitter_id = Int(name="submitter")
 
723
    submitter = Reference(submitter_id, User.id)
 
724
    date_submitted = DateTime()
 
725
 
 
726
 
 
727
# WORKSHEETS AND EXERCISES #
 
728
 
 
729
class Exercise(Storm):
 
730
    """An exercise for students to complete in a worksheet.
 
731
 
 
732
    An exercise may be present in any number of worksheets.
 
733
    """
 
734
 
 
735
    __storm_table__ = "exercise"
 
736
    id = Unicode(primary=True, name="identifier")
 
737
    name = Unicode()
 
738
    description = Unicode()
 
739
    partial = Unicode()
 
740
    solution = Unicode()
 
741
    include = Unicode()
 
742
    num_rows = Int()
 
743
 
 
744
    worksheet_exercises =  ReferenceSet(id,
 
745
        'WorksheetExercise.exercise_id')
 
746
 
 
747
    worksheets = ReferenceSet(id,
 
748
        'WorksheetExercise.exercise_id',
 
749
        'WorksheetExercise.worksheet_id',
 
750
        'Worksheet.id'
 
751
    )
 
752
 
 
753
    test_suites = ReferenceSet(id, 
 
754
        'TestSuite.exercise_id',
 
755
        order_by='seq_no')
 
756
 
 
757
    __init__ = _kwarg_init
 
758
 
 
759
    def __repr__(self):
 
760
        return "<%s %s>" % (type(self).__name__, self.name)
 
761
 
 
762
    def get_permissions(self, user):
 
763
        perms = set()
 
764
        roles = set()
 
765
        if user is not None:
 
766
            if user.admin:
 
767
                perms.add('edit')
 
768
                perms.add('view')
 
769
            elif u'lecturer' in set((e.role for e in user.active_enrolments)):
 
770
                perms.add('edit')
 
771
                perms.add('view')
 
772
            elif u'tutor' in set((e.role for e in user.active_enrolments)):
 
773
                perms.add('edit')
 
774
                perms.add('view')
 
775
 
 
776
        return perms
 
777
 
 
778
    def get_description(self):
 
779
        """Return the description interpreted as reStructuredText."""
 
780
        return rst(self.description)
 
781
 
 
782
    def delete(self):
 
783
        """Deletes the exercise, providing it has no associated worksheets."""
 
784
        if (self.worksheet_exercises.count() > 0):
 
785
            raise IntegrityError()
 
786
        for suite in self.test_suites:
 
787
            suite.delete()
 
788
        Store.of(self).remove(self)
 
789
 
 
790
class Worksheet(Storm):
 
791
    """A worksheet with exercises for students to complete.
 
792
 
 
793
    Worksheets are owned by offerings.
 
794
    """
 
795
 
 
796
    __storm_table__ = "worksheet"
 
797
 
 
798
    id = Int(primary=True, name="worksheetid")
 
799
    offering_id = Int(name="offeringid")
 
800
    identifier = Unicode()
 
801
    name = Unicode()
 
802
    assessable = Bool()
 
803
    data = Unicode()
 
804
    seq_no = Int()
 
805
    format = Unicode()
 
806
 
 
807
    attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
 
808
    offering = Reference(offering_id, 'Offering.id')
 
809
 
 
810
    all_worksheet_exercises = ReferenceSet(id,
 
811
        'WorksheetExercise.worksheet_id')
 
812
 
 
813
    # Use worksheet_exercises to get access to the *active* WorksheetExercise
 
814
    # objects binding worksheets to exercises. This is required to access the
 
815
    # "optional" field.
 
816
 
 
817
    @property
 
818
    def worksheet_exercises(self):
 
819
        return self.all_worksheet_exercises.find(active=True)
 
820
 
 
821
    __init__ = _kwarg_init
 
822
 
 
823
    def __repr__(self):
 
824
        return "<%s %s>" % (type(self).__name__, self.name)
 
825
 
 
826
    def remove_all_exercises(self):
 
827
        """Remove all exercises from this worksheet.
 
828
 
 
829
        This does not delete the exercises themselves. It just removes them
 
830
        from the worksheet.
 
831
        """
 
832
        store = Store.of(self)
 
833
        for ws_ex in self.all_worksheet_exercises:
 
834
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
835
                raise IntegrityError()
 
836
        store.find(WorksheetExercise,
 
837
            WorksheetExercise.worksheet == self).remove()
 
838
 
 
839
    def get_permissions(self, user):
 
840
        return self.offering.get_permissions(user)
 
841
 
 
842
    def get_xml(self):
 
843
        """Returns the xml of this worksheet, converts from rst if required."""
 
844
        if self.format == u'rst':
 
845
            ws_xml = rst(self.data)
 
846
            return ws_xml
 
847
        else:
 
848
            return self.data
 
849
 
 
850
    def delete(self):
 
851
        """Deletes the worksheet, provided it has no attempts on any exercises.
 
852
 
 
853
        Returns True if delete succeeded, or False if this worksheet has
 
854
        attempts attached."""
 
855
        for ws_ex in self.all_worksheet_exercises:
 
856
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
857
                raise IntegrityError()
 
858
 
 
859
        self.remove_all_exercises()
 
860
        Store.of(self).remove(self)
 
861
 
 
862
class WorksheetExercise(Storm):
 
863
    """A link between a worksheet and one of its exercises.
 
864
 
 
865
    These may be marked optional, in which case the exercise does not count
 
866
    for marking purposes. The sequence number is used to order the worksheet
 
867
    ToC.
 
868
    """
 
869
 
 
870
    __storm_table__ = "worksheet_exercise"
 
871
 
 
872
    id = Int(primary=True, name="ws_ex_id")
 
873
 
 
874
    worksheet_id = Int(name="worksheetid")
 
875
    worksheet = Reference(worksheet_id, Worksheet.id)
 
876
    exercise_id = Unicode(name="exerciseid")
 
877
    exercise = Reference(exercise_id, Exercise.id)
 
878
    optional = Bool()
 
879
    active = Bool()
 
880
    seq_no = Int()
 
881
 
 
882
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
 
883
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
 
884
 
 
885
    __init__ = _kwarg_init
 
886
 
 
887
    def __repr__(self):
 
888
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
 
889
                                  self.worksheet.identifier)
 
890
 
 
891
    def get_permissions(self, user):
 
892
        return self.worksheet.get_permissions(user)
 
893
 
 
894
 
 
895
class ExerciseSave(Storm):
 
896
    """A potential exercise solution submitted by a user for storage.
 
897
 
 
898
    This is not an actual tested attempt at an exercise, it's just a save of
 
899
    the editing session.
 
900
    """
 
901
 
 
902
    __storm_table__ = "exercise_save"
 
903
    __storm_primary__ = "ws_ex_id", "user_id"
 
904
 
 
905
    ws_ex_id = Int(name="ws_ex_id")
 
906
    worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
 
907
 
 
908
    user_id = Int(name="loginid")
 
909
    user = Reference(user_id, User.id)
 
910
    date = DateTime()
 
911
    text = Unicode()
 
912
 
 
913
    __init__ = _kwarg_init
 
914
 
 
915
    def __repr__(self):
 
916
        return "<%s %s by %s at %s>" % (type(self).__name__,
 
917
            self.exercise.name, self.user.login, self.date.strftime("%c"))
 
918
 
 
919
class ExerciseAttempt(ExerciseSave):
 
920
    """An attempt at solving an exercise.
 
921
 
 
922
    This is a special case of ExerciseSave, used when the user submits a
 
923
    candidate solution. Like an ExerciseSave, it constitutes exercise solution
 
924
    data.
 
925
 
 
926
    In addition, it contains information about the result of the submission:
 
927
 
 
928
     - complete - True if this submission was successful, rendering this
 
929
                  exercise complete for this user in this worksheet.
 
930
     - active   - True if this submission is "active" (usually true).
 
931
                  Submissions may be de-activated by privileged users for
 
932
                  special reasons, and then they won't count (either as a
 
933
                  penalty or success), but will still be stored.
 
934
    """
 
935
 
 
936
    __storm_table__ = "exercise_attempt"
 
937
    __storm_primary__ = "ws_ex_id", "user_id", "date"
 
938
 
 
939
    # The "text" field is the same but has a different name in the DB table
 
940
    # for some reason.
 
941
    text = Unicode(name="attempt")
 
942
    complete = Bool()
 
943
    active = Bool()
 
944
 
 
945
    def get_permissions(self, user):
 
946
        return set(['view']) if user is self.user else set()
 
947
 
 
948
class TestSuite(Storm):
 
949
    """A container to group an exercise's test cases.
 
950
 
 
951
    The test suite contains some information on how to test. The function to
 
952
    test, variables to set and stdin data are stored here.
 
953
    """
 
954
 
 
955
    __storm_table__ = "test_suite"
 
956
    __storm_primary__ = "exercise_id", "suiteid"
 
957
 
 
958
    suiteid = Int()
 
959
    exercise_id = Unicode(name="exerciseid")
 
960
    description = Unicode()
 
961
    seq_no = Int()
 
962
    function = Unicode()
 
963
    stdin = Unicode()
 
964
    exercise = Reference(exercise_id, Exercise.id)
 
965
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
 
966
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
 
967
 
 
968
    def delete(self):
 
969
        """Delete this suite, without asking questions."""
 
970
        for vaariable in self.variables:
 
971
            variable.delete()
 
972
        for test_case in self.test_cases:
 
973
            test_case.delete()
 
974
        Store.of(self).remove(self)
 
975
 
 
976
class TestCase(Storm):
 
977
    """A container for actual tests (see TestCasePart), inside a test suite.
 
978
 
 
979
    It is the lowest level shown to students on their pass/fail status."""
 
980
 
 
981
    __storm_table__ = "test_case"
 
982
    __storm_primary__ = "testid", "suiteid"
 
983
 
 
984
    testid = Int()
 
985
    suiteid = Int()
 
986
    suite = Reference(suiteid, "TestSuite.suiteid")
 
987
    passmsg = Unicode()
 
988
    failmsg = Unicode()
 
989
    test_default = Unicode()
 
990
    seq_no = Int()
 
991
 
 
992
    parts = ReferenceSet(testid, "TestCasePart.testid")
 
993
 
 
994
    __init__ = _kwarg_init
 
995
 
 
996
    def delete(self):
 
997
        for part in self.parts:
 
998
            part.delete()
 
999
        Store.of(self).remove(self)
 
1000
 
 
1001
class TestSuiteVar(Storm):
 
1002
    """A variable used by an exercise test suite.
 
1003
 
 
1004
    This may represent a function argument or a normal variable.
 
1005
    """
 
1006
 
 
1007
    __storm_table__ = "suite_variable"
 
1008
    __storm_primary__ = "varid"
 
1009
 
 
1010
    varid = Int()
 
1011
    suiteid = Int()
 
1012
    var_name = Unicode()
 
1013
    var_value = Unicode()
 
1014
    var_type = Unicode()
 
1015
    arg_no = Int()
 
1016
 
 
1017
    suite = Reference(suiteid, "TestSuite.suiteid")
 
1018
 
 
1019
    __init__ = _kwarg_init
 
1020
 
 
1021
    def delete(self):
 
1022
        Store.of(self).remove(self)
 
1023
 
 
1024
class TestCasePart(Storm):
 
1025
    """An actual piece of code to test an exercise solution."""
 
1026
 
 
1027
    __storm_table__ = "test_case_part"
 
1028
    __storm_primary__ = "partid"
 
1029
 
 
1030
    partid = Int()
 
1031
    testid = Int()
 
1032
 
 
1033
    part_type = Unicode()
 
1034
    test_type = Unicode()
 
1035
    data = Unicode()
 
1036
    filename = Unicode()
 
1037
 
 
1038
    test = Reference(testid, "TestCase.testid")
 
1039
 
 
1040
    __init__ = _kwarg_init
 
1041
 
 
1042
    def delete(self):
 
1043
        Store.of(self).remove(self)