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

« back to all changes in this revision

Viewing changes to ivle/database.py

Fix ProjectView's total assigned count by dealing with ResultSets only.

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