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

« back to all changes in this revision

Viewing changes to ivle/database.py

MergedĀ fromĀ trunk

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
 
 
33
import ivle.conf
34
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',
41
40
            'Exercise', 'Worksheet', 'WorksheetExercise',
42
41
            'ExerciseSave', 'ExerciseAttempt',
43
42
            'TestCase', 'TestSuite', 'TestSuiteVar'
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")
116
116
        return self.hash_password(password) == self.passhash
117
117
 
118
118
    @property
119
 
    def display_name(self):
120
 
        """Returns the "nice name" of the user or group."""
121
 
        return self.fullname
122
 
 
123
 
    @property
124
 
    def short_name(self):
125
 
        """Returns the database "identifier" name of the user or group."""
126
 
        return self.login
127
 
 
128
 
    @property
129
119
    def password_expired(self):
130
120
        fieldval = self.pass_exp
131
121
        return fieldval is not None and datetime.datetime.now() > fieldval
168
158
 
169
159
    # TODO: Invitations should be listed too?
170
160
    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
161
        preds = [
176
162
            ProjectGroupMembership.user_id == self.id,
177
163
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
197
183
        '''A sanely ordered list of all of the user's enrolments.'''
198
184
        return self._get_enrolments(False) 
199
185
 
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
 
            Enrolment.active == True)
220
 
 
221
186
    @staticmethod
222
187
    def hash_password(password):
223
 
        """Hash a password with MD5."""
224
 
        return hashlib.md5(password).hexdigest()
 
188
        return md5.md5(password).hexdigest()
225
189
 
226
190
    @classmethod
227
191
    def get_by_login(cls, store, login):
228
 
        """Find a user in a store by login name."""
 
192
        """
 
193
        Get the User from the db associated with a given store and
 
194
        login.
 
195
        """
229
196
        return store.find(cls, cls.login == unicode(login)).one()
230
197
 
231
 
    def get_permissions(self, user, config):
232
 
        """Determine privileges held by a user over this object.
233
 
 
234
 
        If the user requesting privileges is this user or an admin,
235
 
        they may do everything. Otherwise they may do nothing.
236
 
        """
 
198
    def get_permissions(self, user):
237
199
        if user and user.admin or user is self:
238
 
            return set(['view_public', 'view', 'edit', 'submit_project'])
 
200
            return set(['view', 'edit'])
239
201
        else:
240
 
            return set(['view_public'])
 
202
            return set()
241
203
 
242
204
# SUBJECTS AND ENROLMENTS #
243
205
 
244
206
class Subject(Storm):
245
 
    """A subject (or course) which is run in some semesters."""
246
 
 
247
207
    __storm_table__ = "subject"
248
208
 
249
209
    id = Int(primary=True, name="subjectid")
250
210
    code = Unicode(name="subj_code")
251
211
    name = Unicode(name="subj_name")
252
212
    short_name = Unicode(name="subj_short_name")
 
213
    url = Unicode()
253
214
 
254
215
    offerings = ReferenceSet(id, 'Offering.subject_id')
255
216
 
258
219
    def __repr__(self):
259
220
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
260
221
 
261
 
    def get_permissions(self, user, config):
262
 
        """Determine privileges held by a user over this object.
263
 
 
264
 
        If the user requesting privileges is an admin, they may edit.
265
 
        Otherwise they may only read.
266
 
        """
 
222
    def get_permissions(self, user):
267
223
        perms = set()
268
224
        if user is not None:
269
225
            perms.add('view')
271
227
                perms.add('edit')
272
228
        return perms
273
229
 
274
 
    def active_offerings(self):
275
 
        """Find active offerings for this subject.
276
 
 
277
 
        Return a sequence of currently active offerings for this subject
278
 
        (offerings whose semester.state is "current"). There should be 0 or 1
279
 
        elements in this sequence, but it's possible there are more.
280
 
        """
281
 
        return self.offerings.find(Offering.semester_id == Semester.id,
282
 
                                   Semester.state == u'current')
283
 
 
284
 
    def offering_for_semester(self, year, semester):
285
 
        """Get the offering for the given year/semester, or None.
286
 
 
287
 
        @param year: A string representation of the year.
288
 
        @param semester: A string representation of the semester.
289
 
        """
290
 
        return self.offerings.find(Offering.semester_id == Semester.id,
291
 
                               Semester.year == unicode(year),
292
 
                               Semester.semester == unicode(semester)).one()
293
 
 
294
230
class Semester(Storm):
295
 
    """A semester in which subjects can be run."""
296
 
 
297
231
    __storm_table__ = "semester"
298
232
 
299
233
    id = Int(primary=True, name="semesterid")
302
236
    state = Unicode()
303
237
 
304
238
    offerings = ReferenceSet(id, 'Offering.semester_id')
305
 
    enrolments = ReferenceSet(id,
306
 
                              'Offering.semester_id',
307
 
                              'Offering.id',
308
 
                              'Enrolment.offering_id')
309
239
 
310
240
    __init__ = _kwarg_init
311
241
 
313
243
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
314
244
 
315
245
class Offering(Storm):
316
 
    """An offering of a subject in a particular semester."""
317
 
 
318
246
    __storm_table__ = "offering"
319
247
 
320
248
    id = Int(primary=True, name="offeringid")
322
250
    subject = Reference(subject_id, Subject.id)
323
251
    semester_id = Int(name="semesterid")
324
252
    semester = Reference(semester_id, Semester.id)
325
 
    description = Unicode()
326
 
    url = Unicode()
327
253
    groups_student_permissions = Unicode()
328
254
 
329
255
    enrolments = ReferenceSet(id, 'Enrolment.offering_id')
332
258
                           'Enrolment.user_id',
333
259
                           'User.id')
334
260
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
335
 
    projects = ReferenceSet(id,
336
 
                            'ProjectSet.offering_id',
337
 
                            'ProjectSet.id',
338
 
                            'Project.project_set_id')
339
261
 
340
262
    worksheets = ReferenceSet(id, 
341
263
        'Worksheet.offering_id', 
349
271
                                  self.semester)
350
272
 
351
273
    def enrol(self, user, role=u'student'):
352
 
        """Enrol a user in this offering.
353
 
 
354
 
        Enrolments handle both the staff and student cases. The role controls
355
 
        the privileges granted by this enrolment.
356
 
        """
 
274
        '''Enrol a user in this offering.'''
357
275
        enrolment = Store.of(self).find(Enrolment,
358
276
                               Enrolment.user_id == user.id,
359
277
                               Enrolment.offering_id == self.id).one()
365
283
        enrolment.active = True
366
284
        enrolment.role = role
367
285
 
368
 
    def unenrol(self, user):
369
 
        '''Unenrol a user from this offering.'''
370
 
        enrolment = Store.of(self).find(Enrolment,
371
 
                               Enrolment.user_id == user.id,
372
 
                               Enrolment.offering_id == self.id).one()
373
 
        Store.of(enrolment).remove(enrolment)
374
 
 
375
 
    def get_permissions(self, user, config):
 
286
    def get_permissions(self, user):
376
287
        perms = set()
377
288
        if user is not None:
378
 
            enrolment = self.get_enrolment(user)
379
 
            if enrolment or user.admin:
380
 
                perms.add('view')
381
 
            if enrolment and enrolment.role == u'tutor':
382
 
                perms.add('view_project_submissions')
383
 
                # Site-specific policy on the role of tutors
384
 
                if config['policy']['tutors_can_enrol_students']:
385
 
                    perms.add('enrol')
386
 
                    perms.add('enrol_student')
387
 
                if config['policy']['tutors_can_edit_worksheets']:
388
 
                    perms.add('edit_worksheets')
389
 
                if config['policy']['tutors_can_admin_groups']:
390
 
                    perms.add('admin_groups')
391
 
            if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
392
 
                perms.add('view_project_submissions')
393
 
                perms.add('admin_groups')
394
 
                perms.add('edit_worksheets')
395
 
                perms.add('edit')           # Can edit projects & details
396
 
                perms.add('enrol')          # Can see enrolment screen at all
397
 
                perms.add('enrol_student')  # Can enrol students
398
 
                perms.add('enrol_tutor')    # Can enrol tutors
 
289
            perms.add('view')
399
290
            if user.admin:
400
 
                perms.add('enrol_lecturer') # Can enrol lecturers
 
291
                perms.add('edit')
401
292
        return perms
402
293
 
403
 
    def get_enrolment(self, user):
404
 
        """Find the user's enrolment in this offering."""
405
 
        try:
406
 
            enrolment = self.enrolments.find(user=user).one()
407
 
        except NotOneError:
408
 
            enrolment = None
409
 
 
410
 
        return enrolment
411
 
 
412
 
    def get_members_by_role(self, role):
413
 
        return Store.of(self).find(User,
414
 
                Enrolment.user_id == User.id,
415
 
                Enrolment.offering_id == self.id,
416
 
                Enrolment.role == role
417
 
                ).order_by(User.login)
418
 
 
419
 
    @property
420
 
    def students(self):
421
 
        return self.get_members_by_role(u'student')
422
 
 
423
 
    def get_open_projects_for_user(self, user):
424
 
        """Find all projects currently open to submissions by a user."""
425
 
        # XXX: Respect extensions.
426
 
        return self.projects.find(Project.deadline > datetime.datetime.now())
427
 
 
428
 
    def clone_worksheets(self, source):
429
 
        """Clone all worksheets from the specified source to this offering."""
430
 
        import ivle.worksheet.utils
431
 
        for worksheet in source.worksheets:
432
 
            newws = Worksheet()
433
 
            newws.seq_no = worksheet.seq_no
434
 
            newws.identifier = worksheet.identifier
435
 
            newws.name = worksheet.name
436
 
            newws.assessable = worksheet.assessable
437
 
            newws.data = worksheet.data
438
 
            newws.format = worksheet.format
439
 
            newws.offering = self
440
 
            Store.of(self).add(newws)
441
 
            ivle.worksheet.utils.update_exerciselist(newws)
442
 
 
443
 
 
444
294
class Enrolment(Storm):
445
 
    """An enrolment of a user in an offering.
446
 
 
447
 
    This represents the roles of both staff and students.
448
 
    """
449
 
 
450
295
    __storm_table__ = "enrolment"
451
296
    __storm_primary__ = "user_id", "offering_id"
452
297
 
475
320
# PROJECTS #
476
321
 
477
322
class ProjectSet(Storm):
478
 
    """A set of projects that share common groups.
479
 
 
480
 
    Each student project group is attached to a project set. The group is
481
 
    valid for all projects in the group's set.
482
 
    """
483
 
 
484
323
    __storm_table__ = "project_set"
485
324
 
486
325
    id = Int(name="projectsetid", primary=True)
497
336
        return "<%s %d in %r>" % (type(self).__name__, self.id,
498
337
                                  self.offering)
499
338
 
500
 
    def get_permissions(self, user, config):
501
 
        return self.offering.get_permissions(user, config)
502
 
 
503
 
    def get_groups_for_user(self, user):
504
 
        """List all groups in this offering of which the user is a member."""
505
 
        assert self.is_group
506
 
        return Store.of(self).find(
507
 
            ProjectGroup,
508
 
            ProjectGroupMembership.user_id == user.id,
509
 
            ProjectGroupMembership.project_group_id == ProjectGroup.id,
510
 
            ProjectGroup.project_set_id == self.id)
511
 
 
512
 
    def get_submission_principal(self, user):
513
 
        """Get the principal on behalf of which the user can submit.
514
 
 
515
 
        If this is a solo project set, the given user is returned. If
516
 
        the user is a member of exactly one group, all the group is
517
 
        returned. Otherwise, None is returned.
518
 
        """
519
 
        if self.is_group:
520
 
            groups = self.get_groups_for_user(user)
521
 
            if groups.count() == 1:
522
 
                return groups.one()
523
 
            else:
524
 
                return None
525
 
        else:
526
 
            return user
527
 
 
528
 
    @property
529
 
    def is_group(self):
530
 
        return self.max_students_per_group is not None
531
 
 
532
 
    @property
533
 
    def assigned(self):
534
 
        """Get the entities (groups or users) assigned to submit this project.
535
 
 
536
 
        This will be a Storm ResultSet.
537
 
        """
538
 
        #If its a solo project, return everyone in offering
539
 
        if self.is_group:
540
 
            return self.project_groups
541
 
        else:
542
 
            return self.offering.students
543
 
 
544
 
class DeadlinePassed(Exception):
545
 
    """An exception indicating that a project cannot be submitted because the
546
 
    deadline has passed."""
547
 
    def __init__(self):
548
 
        pass
549
 
    def __str__(self):
550
 
        return "The project deadline has passed"
551
 
 
552
339
class Project(Storm):
553
 
    """A student project for which submissions can be made."""
554
 
 
555
340
    __storm_table__ = "project"
556
341
 
557
342
    id = Int(name="projectid", primary=True)
558
 
    name = Unicode()
559
 
    short_name = Unicode()
560
343
    synopsis = Unicode()
561
344
    url = Unicode()
562
345
    project_set_id = Int(name="projectsetid")
563
346
    project_set = Reference(project_set_id, ProjectSet.id)
564
347
    deadline = DateTime()
565
348
 
566
 
    assesseds = ReferenceSet(id, 'Assessed.project_id')
567
 
    submissions = ReferenceSet(id,
568
 
                               'Assessed.project_id',
569
 
                               'Assessed.id',
570
 
                               'ProjectSubmission.assessed_id')
571
 
 
572
349
    __init__ = _kwarg_init
573
350
 
574
351
    def __repr__(self):
575
 
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
 
352
        return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
576
353
                                  self.project_set.offering)
577
354
 
578
 
    def can_submit(self, principal, user):
579
 
        return (self in principal.get_projects() and
580
 
                not self.has_deadline_passed(user))
581
 
 
582
 
    def submit(self, principal, path, revision, who):
583
 
        """Submit a Subversion path and revision to a project.
584
 
 
585
 
        @param principal: The owner of the Subversion repository, and the
586
 
                          entity on behalf of whom the submission is being made
587
 
        @param path: A path within that repository to submit.
588
 
        @param revision: The revision of that path to submit.
589
 
        @param who: The user who is actually making the submission.
590
 
        """
591
 
 
592
 
        if not self.can_submit(principal, who):
593
 
            raise DeadlinePassed()
594
 
 
595
 
        a = Assessed.get(Store.of(self), principal, self)
596
 
        ps = ProjectSubmission()
597
 
        ps.path = path
598
 
        ps.revision = revision
599
 
        ps.date_submitted = datetime.datetime.now()
600
 
        ps.assessed = a
601
 
        ps.submitter = who
602
 
 
603
 
        return ps
604
 
 
605
 
    def get_permissions(self, user, config):
606
 
        return self.project_set.offering.get_permissions(user, config)
607
 
 
608
 
    @property
609
 
    def latest_submissions(self):
610
 
        """Return the latest submission for each Assessed."""
611
 
        return Store.of(self).find(ProjectSubmission,
612
 
            Assessed.project_id == self.id,
613
 
            ProjectSubmission.assessed_id == Assessed.id,
614
 
            ProjectSubmission.date_submitted == Select(
615
 
                    Max(ProjectSubmission.date_submitted),
616
 
                    ProjectSubmission.assessed_id == Assessed.id,
617
 
                    tables=ProjectSubmission
618
 
            )
619
 
        )
620
 
 
621
 
    def has_deadline_passed(self, user):
622
 
        """Check whether the deadline has passed."""
623
 
        # XXX: Need to respect extensions.
624
 
        return self.deadline < datetime.datetime.now()
625
 
 
626
 
    def get_submissions_for_principal(self, principal):
627
 
        """Fetch a ResultSet of all submissions by a particular principal."""
628
 
        assessed = Assessed.get(Store.of(self), principal, self)
629
 
        if assessed is None:
630
 
            return
631
 
        return assessed.submissions
632
 
 
633
 
 
634
 
 
635
355
class ProjectGroup(Storm):
636
 
    """A group of students working together on a project."""
637
 
 
638
356
    __storm_table__ = "project_group"
639
357
 
640
358
    id = Int(name="groupid", primary=True)
657
375
        return "<%s %s in %r>" % (type(self).__name__, self.name,
658
376
                                  self.project_set.offering)
659
377
 
660
 
    @property
661
 
    def display_name(self):
662
 
        """Returns the "nice name" of the user or group."""
663
 
        return self.nick
664
 
 
665
 
    @property
666
 
    def short_name(self):
667
 
        """Returns the database "identifier" name of the user or group."""
668
 
        return self.name
669
 
 
670
 
    def get_projects(self, offering=None, active_only=True):
671
 
        '''Find projects that the group can submit.
672
 
 
673
 
        This will include projects in the project set which owns this group,
674
 
        unless the project set disallows groups (in which case none will be
675
 
        returned).
676
 
 
677
 
        @param active_only: Whether to only search active offerings.
678
 
        @param offering: An optional offering to restrict the search to.
679
 
        '''
680
 
        return Store.of(self).find(Project,
681
 
            Project.project_set_id == ProjectSet.id,
682
 
            ProjectSet.id == self.project_set.id,
683
 
            ProjectSet.max_students_per_group != None,
684
 
            ProjectSet.offering_id == Offering.id,
685
 
            (offering is None) or (Offering.id == offering.id),
686
 
            Semester.id == Offering.semester_id,
687
 
            (not active_only) or (Semester.state == u'current'))
688
 
 
689
 
 
690
 
    def get_permissions(self, user, config):
691
 
        if user.admin or user in self.members:
692
 
            return set(['submit_project'])
693
 
        else:
694
 
            return set()
695
 
 
696
378
class ProjectGroupMembership(Storm):
697
 
    """A student's membership in a project group."""
698
 
 
699
379
    __storm_table__ = "group_member"
700
380
    __storm_primary__ = "user_id", "project_group_id"
701
381
 
710
390
        return "<%s %r in %r>" % (type(self).__name__, self.user,
711
391
                                  self.project_group)
712
392
 
713
 
class Assessed(Storm):
714
 
    """A composite of a user or group combined with a project.
715
 
 
716
 
    Each project submission and extension refers to an Assessed. It is the
717
 
    sole specifier of the repository and project.
718
 
    """
719
 
 
720
 
    __storm_table__ = "assessed"
721
 
 
722
 
    id = Int(name="assessedid", primary=True)
723
 
    user_id = Int(name="loginid")
724
 
    user = Reference(user_id, User.id)
725
 
    project_group_id = Int(name="groupid")
726
 
    project_group = Reference(project_group_id, ProjectGroup.id)
727
 
 
728
 
    project_id = Int(name="projectid")
729
 
    project = Reference(project_id, Project.id)
730
 
 
731
 
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
732
 
    submissions = ReferenceSet(
733
 
        id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
734
 
 
735
 
    def __repr__(self):
736
 
        return "<%s %r in %r>" % (type(self).__name__,
737
 
            self.user or self.project_group, self.project)
738
 
 
739
 
    @property
740
 
    def is_group(self):
741
 
        """True if the Assessed is a group, False if it is a user."""
742
 
        return self.project_group is not None
743
 
 
744
 
    @property
745
 
    def principal(self):
746
 
        return self.project_group or self.user
747
 
 
748
 
    @property
749
 
    def checkout_location(self):
750
 
        """Returns the location of the Subversion workspace for this piece of
751
 
        assessment, relative to each group member's home directory."""
752
 
        subjectname = self.project.project_set.offering.subject.short_name
753
 
        if self.is_group:
754
 
            checkout_dir_name = self.principal.short_name
755
 
        else:
756
 
            checkout_dir_name = "mywork"
757
 
        return subjectname + "/" + checkout_dir_name
758
 
 
759
 
    @classmethod
760
 
    def get(cls, store, principal, project):
761
 
        """Find or create an Assessed for the given user or group and project.
762
 
 
763
 
        @param principal: The user or group.
764
 
        @param project: The project.
765
 
        """
766
 
        t = type(principal)
767
 
        if t not in (User, ProjectGroup):
768
 
            raise AssertionError('principal must be User or ProjectGroup')
769
 
 
770
 
        a = store.find(cls,
771
 
            (t is User) or (cls.project_group_id == principal.id),
772
 
            (t is ProjectGroup) or (cls.user_id == principal.id),
773
 
            cls.project_id == project.id).one()
774
 
 
775
 
        if a is None:
776
 
            a = cls()
777
 
            if t is User:
778
 
                a.user = principal
779
 
            else:
780
 
                a.project_group = principal
781
 
            a.project = project
782
 
            store.add(a)
783
 
 
784
 
        return a
785
 
 
786
 
 
787
 
class ProjectExtension(Storm):
788
 
    """An extension granted to a user or group on a particular project.
789
 
 
790
 
    The user or group and project are specified by the Assessed.
791
 
    """
792
 
 
793
 
    __storm_table__ = "project_extension"
794
 
 
795
 
    id = Int(name="extensionid", primary=True)
796
 
    assessed_id = Int(name="assessedid")
797
 
    assessed = Reference(assessed_id, Assessed.id)
798
 
    deadline = DateTime()
799
 
    approver_id = Int(name="approver")
800
 
    approver = Reference(approver_id, User.id)
801
 
    notes = Unicode()
802
 
 
803
 
class ProjectSubmission(Storm):
804
 
    """A submission from a user or group repository to a particular project.
805
 
 
806
 
    The content of a submission is a single path and revision inside a
807
 
    repository. The repository is that owned by the submission's user and
808
 
    group, while the path and revision are explicit.
809
 
 
810
 
    The user or group and project are specified by the Assessed.
811
 
    """
812
 
 
813
 
    __storm_table__ = "project_submission"
814
 
 
815
 
    id = Int(name="submissionid", primary=True)
816
 
    assessed_id = Int(name="assessedid")
817
 
    assessed = Reference(assessed_id, Assessed.id)
818
 
    path = Unicode()
819
 
    revision = Int()
820
 
    submitter_id = Int(name="submitter")
821
 
    submitter = Reference(submitter_id, User.id)
822
 
    date_submitted = DateTime()
823
 
 
824
 
    def get_verify_url(self, user):
825
 
        """Get the URL for verifying this submission, within the account of
826
 
        the given user."""
827
 
        # If this is a solo project, then self.path will be prefixed with the
828
 
        # subject name. Remove the first path segment.
829
 
        submitpath = self.path[1:] if self.path[:1] == '/' else self.path
830
 
        if not self.assessed.is_group:
831
 
            if '/' in submitpath:
832
 
                submitpath = submitpath.split('/', 1)[1]
833
 
            else:
834
 
                submitpath = ''
835
 
        return "/files/%s/%s/%s?r=%d" % (user.login,
836
 
            self.assessed.checkout_location, submitpath, self.revision)
837
 
 
838
393
# WORKSHEETS AND EXERCISES #
839
394
 
840
395
class Exercise(Storm):
841
 
    """An exercise for students to complete in a worksheet.
842
 
 
843
 
    An exercise may be present in any number of worksheets.
844
 
    """
845
 
 
846
396
    __storm_table__ = "exercise"
847
397
    id = Unicode(primary=True, name="identifier")
848
398
    name = Unicode()
852
402
    include = Unicode()
853
403
    num_rows = Int()
854
404
 
855
 
    worksheet_exercises =  ReferenceSet(id,
856
 
        'WorksheetExercise.exercise_id')
857
 
 
858
405
    worksheets = ReferenceSet(id,
859
406
        'WorksheetExercise.exercise_id',
860
407
        'WorksheetExercise.worksheet_id',
861
408
        'Worksheet.id'
862
409
    )
863
 
 
 
410
    
864
411
    test_suites = ReferenceSet(id, 
865
412
        'TestSuite.exercise_id',
866
413
        order_by='seq_no')
870
417
    def __repr__(self):
871
418
        return "<%s %s>" % (type(self).__name__, self.name)
872
419
 
873
 
    def get_permissions(self, user, config):
874
 
        return self.global_permissions(user, config)
875
 
 
876
 
    @staticmethod
877
 
    def global_permissions(user, config):
878
 
        """Gets the set of permissions this user has over *all* exercises.
879
 
        This is used to determine who may view the exercises list, and create
880
 
        new exercises."""
 
420
    def get_permissions(self, user):
881
421
        perms = set()
882
 
        roles = set()
883
422
        if user is not None:
884
423
            if user.admin:
885
424
                perms.add('edit')
886
425
                perms.add('view')
887
 
            elif u'lecturer' in set((e.role for e in user.active_enrolments)):
888
 
                perms.add('edit')
889
 
                perms.add('view')
890
 
            elif (config['policy']['tutors_can_edit_worksheets']
891
 
            and u'tutor' in set((e.role for e in user.active_enrolments))):
892
 
                # Site-specific policy on the role of tutors
893
 
                perms.add('edit')
894
 
                perms.add('view')
895
 
 
896
426
        return perms
897
427
 
898
 
    def get_description(self):
899
 
        """Return the description interpreted as reStructuredText."""
900
 
        return rst(self.description)
901
 
 
902
 
    def delete(self):
903
 
        """Deletes the exercise, providing it has no associated worksheets."""
904
 
        if (self.worksheet_exercises.count() > 0):
905
 
            raise IntegrityError()
906
 
        for suite in self.test_suites:
907
 
            suite.delete()
908
 
        Store.of(self).remove(self)
909
 
 
910
428
class Worksheet(Storm):
911
 
    """A worksheet with exercises for students to complete.
912
 
 
913
 
    Worksheets are owned by offerings.
914
 
    """
915
 
 
916
429
    __storm_table__ = "worksheet"
917
430
 
918
431
    id = Int(primary=True, name="worksheetid")
943
456
    def __repr__(self):
944
457
        return "<%s %s>" % (type(self).__name__, self.name)
945
458
 
946
 
    def remove_all_exercises(self):
947
 
        """Remove all exercises from this worksheet.
 
459
    # XXX Refactor this - make it an instance method of Subject rather than a
 
460
    # class method of Worksheet. Can't do that now because Subject isn't
 
461
    # linked referentially to the Worksheet.
 
462
    @classmethod
 
463
    def get_by_name(cls, store, subjectname, worksheetname):
 
464
        """
 
465
        Get the Worksheet from the db associated with a given store, subject
 
466
        name and worksheet name.
 
467
        """
 
468
        return store.find(cls, cls.subject == unicode(subjectname),
 
469
            cls.name == unicode(worksheetname)).one()
948
470
 
 
471
    def remove_all_exercises(self, store):
 
472
        """
 
473
        Remove all exercises from this worksheet.
949
474
        This does not delete the exercises themselves. It just removes them
950
475
        from the worksheet.
951
476
        """
952
 
        store = Store.of(self)
953
 
        for ws_ex in self.all_worksheet_exercises:
954
 
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
955
 
                raise IntegrityError()
956
477
        store.find(WorksheetExercise,
957
478
            WorksheetExercise.worksheet == self).remove()
958
 
 
959
 
    def get_permissions(self, user, config):
960
 
        # Almost the same permissions as for the offering itself
961
 
        perms = self.offering.get_permissions(user, config)
962
 
        # However, "edit" permission is derived from the "edit_worksheets"
963
 
        # permission of the offering
964
 
        if 'edit_worksheets' in perms:
965
 
            perms.add('edit')
966
 
        else:
967
 
            perms.discard('edit')
968
 
        return perms
969
 
 
 
479
            
 
480
    def get_permissions(self, user):
 
481
        return self.offering.get_permissions(user)
 
482
    
970
483
    def get_xml(self):
971
484
        """Returns the xml of this worksheet, converts from rst if required."""
972
485
        if self.format == u'rst':
973
 
            ws_xml = rst(self.data)
 
486
            ws_xml = '<worksheet>' + rst(self.data) + '</worksheet>'
974
487
            return ws_xml
975
488
        else:
976
489
            return self.data
977
490
 
978
 
    def delete(self):
979
 
        """Deletes the worksheet, provided it has no attempts on any exercises.
980
 
 
981
 
        Returns True if delete succeeded, or False if this worksheet has
982
 
        attempts attached."""
983
 
        for ws_ex in self.all_worksheet_exercises:
984
 
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
985
 
                raise IntegrityError()
986
 
 
987
 
        self.remove_all_exercises()
988
 
        Store.of(self).remove(self)
989
 
 
990
491
class WorksheetExercise(Storm):
991
 
    """A link between a worksheet and one of its exercises.
992
 
 
993
 
    These may be marked optional, in which case the exercise does not count
994
 
    for marking purposes. The sequence number is used to order the worksheet
995
 
    ToC.
996
 
    """
997
 
 
998
492
    __storm_table__ = "worksheet_exercise"
999
 
 
 
493
    
1000
494
    id = Int(primary=True, name="ws_ex_id")
1001
495
 
1002
496
    worksheet_id = Int(name="worksheetid")
1006
500
    optional = Bool()
1007
501
    active = Bool()
1008
502
    seq_no = Int()
1009
 
 
 
503
    
1010
504
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
1011
505
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
1012
506
 
1016
510
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1017
511
                                  self.worksheet.identifier)
1018
512
 
1019
 
    def get_permissions(self, user, config):
1020
 
        return self.worksheet.get_permissions(user, config)
1021
 
 
1022
 
 
1023
513
class ExerciseSave(Storm):
1024
 
    """A potential exercise solution submitted by a user for storage.
1025
 
 
1026
 
    This is not an actual tested attempt at an exercise, it's just a save of
1027
 
    the editing session.
1028
 
    """
1029
 
 
 
514
    """
 
515
    Represents a potential solution to an exercise that a user has submitted
 
516
    to the server for storage.
 
517
    A basic ExerciseSave is just the current saved text for this exercise for
 
518
    this user (doesn't count towards their attempts).
 
519
    ExerciseSave may be extended with additional semantics (such as
 
520
    ExerciseAttempt).
 
521
    """
1030
522
    __storm_table__ = "exercise_save"
1031
523
    __storm_primary__ = "ws_ex_id", "user_id"
1032
524
 
1045
537
            self.exercise.name, self.user.login, self.date.strftime("%c"))
1046
538
 
1047
539
class ExerciseAttempt(ExerciseSave):
1048
 
    """An attempt at solving an exercise.
1049
 
 
1050
 
    This is a special case of ExerciseSave, used when the user submits a
1051
 
    candidate solution. Like an ExerciseSave, it constitutes exercise solution
1052
 
    data.
1053
 
 
1054
 
    In addition, it contains information about the result of the submission:
1055
 
 
1056
 
     - complete - True if this submission was successful, rendering this
1057
 
                  exercise complete for this user in this worksheet.
1058
 
     - active   - True if this submission is "active" (usually true).
1059
 
                  Submissions may be de-activated by privileged users for
1060
 
                  special reasons, and then they won't count (either as a
1061
 
                  penalty or success), but will still be stored.
1062
 
    """
1063
 
 
 
540
    """
 
541
    An ExerciseAttempt is a special case of an ExerciseSave. Like an
 
542
    ExerciseSave, it constitutes exercise solution data that the user has
 
543
    submitted to the server for storage.
 
544
    In addition, it contains additional information about the submission.
 
545
    complete - True if this submission was successful, rendering this exercise
 
546
        complete for this user.
 
547
    active - True if this submission is "active" (usually true). Submissions
 
548
        may be de-activated by privileged users for special reasons, and then
 
549
        they won't count (either as a penalty or success), but will still be
 
550
        stored.
 
551
    """
1064
552
    __storm_table__ = "exercise_attempt"
1065
553
    __storm_primary__ = "ws_ex_id", "user_id", "date"
1066
554
 
1069
557
    text = Unicode(name="attempt")
1070
558
    complete = Bool()
1071
559
    active = Bool()
1072
 
 
1073
 
    def get_permissions(self, user, config):
 
560
    
 
561
    def get_permissions(self, user):
1074
562
        return set(['view']) if user is self.user else set()
1075
 
 
 
563
  
1076
564
class TestSuite(Storm):
1077
 
    """A container to group an exercise's test cases.
1078
 
 
1079
 
    The test suite contains some information on how to test. The function to
1080
 
    test, variables to set and stdin data are stored here.
1081
 
    """
1082
 
 
 
565
    """A Testsuite acts as a container for the test cases of an exercise."""
1083
566
    __storm_table__ = "test_suite"
1084
567
    __storm_primary__ = "exercise_id", "suiteid"
1085
 
 
 
568
    
1086
569
    suiteid = Int()
1087
570
    exercise_id = Unicode(name="exerciseid")
1088
571
    description = Unicode()
1093
576
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1094
577
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1095
578
 
1096
 
    def delete(self):
1097
 
        """Delete this suite, without asking questions."""
1098
 
        for variable in self.variables:
1099
 
            variable.delete()
1100
 
        for test_case in self.test_cases:
1101
 
            test_case.delete()
1102
 
        Store.of(self).remove(self)
1103
 
 
1104
579
class TestCase(Storm):
1105
 
    """A container for actual tests (see TestCasePart), inside a test suite.
1106
 
 
1107
 
    It is the lowest level shown to students on their pass/fail status."""
1108
 
 
 
580
    """A TestCase is a member of a TestSuite.
 
581
    
 
582
    It contains the data necessary to check if an exercise is correct"""
1109
583
    __storm_table__ = "test_case"
1110
584
    __storm_primary__ = "testid", "suiteid"
1111
 
 
 
585
    
1112
586
    testid = Int()
1113
587
    suiteid = Int()
1114
588
    suite = Reference(suiteid, "TestSuite.suiteid")
1115
589
    passmsg = Unicode()
1116
590
    failmsg = Unicode()
1117
 
    test_default = Unicode() # Currently unused - only used for file matching.
 
591
    test_default = Unicode()
1118
592
    seq_no = Int()
1119
 
 
 
593
    
1120
594
    parts = ReferenceSet(testid, "TestCasePart.testid")
1121
 
 
 
595
    
1122
596
    __init__ = _kwarg_init
1123
597
 
1124
 
    def delete(self):
1125
 
        for part in self.parts:
1126
 
            part.delete()
1127
 
        Store.of(self).remove(self)
1128
 
 
1129
598
class TestSuiteVar(Storm):
1130
 
    """A variable used by an exercise test suite.
1131
 
 
1132
 
    This may represent a function argument or a normal variable.
1133
 
    """
1134
 
 
 
599
    """A container for the arguments of a Test Suite"""
1135
600
    __storm_table__ = "suite_variable"
1136
601
    __storm_primary__ = "varid"
1137
 
 
 
602
    
1138
603
    varid = Int()
1139
604
    suiteid = Int()
1140
605
    var_name = Unicode()
1141
606
    var_value = Unicode()
1142
607
    var_type = Unicode()
1143
608
    arg_no = Int()
1144
 
 
 
609
    
1145
610
    suite = Reference(suiteid, "TestSuite.suiteid")
1146
 
 
 
611
    
1147
612
    __init__ = _kwarg_init
1148
 
 
1149
 
    def delete(self):
1150
 
        Store.of(self).remove(self)
1151
 
 
 
613
    
1152
614
class TestCasePart(Storm):
1153
 
    """An actual piece of code to test an exercise solution."""
1154
 
 
 
615
    """A container for the test elements of a Test Case"""
1155
616
    __storm_table__ = "test_case_part"
1156
617
    __storm_primary__ = "partid"
1157
 
 
 
618
    
1158
619
    partid = Int()
1159
620
    testid = Int()
1160
 
 
 
621
    
1161
622
    part_type = Unicode()
1162
623
    test_type = Unicode()
1163
624
    data = Unicode()
1164
625
    filename = Unicode()
1165
 
 
 
626
    
1166
627
    test = Reference(testid, "TestCase.testid")
1167
 
 
 
628
    
1168
629
    __init__ = _kwarg_init
1169
 
 
1170
 
    def delete(self):
1171
 
        Store.of(self).remove(self)