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

« back to all changes in this revision

Viewing changes to ivle/database.py

  • Committer: Matt Giuca
  • Date: 2010-02-12 10:27:55 UTC
  • Revision ID: matt.giuca@gmail.com-20100212102755-ifsyo4qaqa2myvl5
docs: Added a new help page, Running and Serving.

Show diffs side-by-side

added added

removed removed

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