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

« back to all changes in this revision

Viewing changes to ivle/database.py

  • Committer: Matt Giuca
  • Date: 2009-02-24 02:02:03 UTC
  • mto: This revision was merged to the branch mainline in revision 1119.
  • Revision ID: matt.giuca@gmail.com-20090224020203-aqdcjnsj6y7wl32o
Added a new look to the IVLE header bar. Mmmm... Web 2.0.
Added top-level directory image-source, containing SVG and script files for
    generating the images.
ivle/webapp/coremedia/images: Added 'chrome' directory containing the rendered
    images.
Modified ivle/webapp/base/ivle-headings.html and
    ivle/webapp/coremedia/ivle.css to support the new images.
    Note that the H1 and H2 at the top of the page are no longer displayed
    (and their custom styles have been removed). There is a heading image
    instead.

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