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

« back to all changes in this revision

Viewing changes to ivle/database.py

Display an informative view on submission success.

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
 
import os
29
29
 
30
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
31
                         Reference, ReferenceSet, Bool, Storm, Desc
32
 
from storm.expr import Select, Max
33
32
from storm.exceptions import NotOneError, IntegrityError
34
33
 
 
34
import ivle.conf
35
35
from ivle.worksheet.rst import rst
36
36
 
37
37
__all__ = ['get_store',
51
51
                % (self.__class__.__name__, k))
52
52
        setattr(self, k, v)
53
53
 
54
 
def get_conn_string(config):
55
 
    """Create a Storm connection string to the IVLE database
56
 
 
57
 
    @param config: The IVLE configuration.
 
54
def get_conn_string():
 
55
    """
 
56
    Returns the Storm connection string, generated from the conf file.
58
57
    """
59
58
 
60
59
    clusterstr = ''
61
 
    if config['database']['username']:
62
 
        clusterstr += config['database']['username']
63
 
        if config['database']['password']:
64
 
            clusterstr += ':' + config['database']['password']
 
60
    if ivle.conf.db_user:
 
61
        clusterstr += ivle.conf.db_user
 
62
        if ivle.conf.db_password:
 
63
            clusterstr += ':' + ivle.conf.db_password
65
64
        clusterstr += '@'
66
65
 
67
 
    host = config['database']['host'] or 'localhost'
68
 
    port = config['database']['port'] or 5432
 
66
    host = ivle.conf.db_host or 'localhost'
 
67
    port = ivle.conf.db_port or 5432
69
68
 
70
69
    clusterstr += '%s:%d' % (host, port)
71
70
 
72
 
    return "postgres://%s/%s" % (clusterstr, config['database']['name'])
73
 
 
74
 
def get_store(config):
75
 
    """Create a Storm store connected to the IVLE database.
76
 
 
77
 
    @param config: The IVLE configuration.
78
 
    """
79
 
    return Store(create_database(get_conn_string(config)))
 
71
    return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
 
72
 
 
73
def get_store():
 
74
    """
 
75
    Open a database connection and transaction. Return a storm.store.Store
 
76
    instance connected to the configured IVLE database.
 
77
    """
 
78
    return Store(create_database(get_conn_string()))
80
79
 
81
80
# USERS #
82
81
 
83
82
class User(Storm):
84
 
    """An IVLE user account."""
 
83
    """
 
84
    Represents an IVLE user.
 
85
    """
85
86
    __storm_table__ = "login"
86
87
 
87
88
    id = Int(primary=True, name="loginid")
118
119
 
119
120
    @property
120
121
    def display_name(self):
121
 
        """Returns the "nice name" of the user or group."""
122
122
        return self.fullname
123
123
 
124
124
    @property
125
 
    def short_name(self):
126
 
        """Returns the database "identifier" name of the user or group."""
127
 
        return self.login
128
 
 
129
 
    @property
130
125
    def password_expired(self):
131
126
        fieldval = self.pass_exp
132
127
        return fieldval is not None and datetime.datetime.now() > fieldval
169
164
 
170
165
    # TODO: Invitations should be listed too?
171
166
    def get_groups(self, offering=None):
172
 
        """Get groups of which this user is a member.
173
 
 
174
 
        @param offering: An optional offering to restrict the search to.
175
 
        """
176
167
        preds = [
177
168
            ProjectGroupMembership.user_id == self.id,
178
169
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
199
190
        return self._get_enrolments(False) 
200
191
 
201
192
    def get_projects(self, offering=None, active_only=True):
202
 
        """Find projects that the user can submit.
 
193
        '''Return Projects that the user can submit.
203
194
 
204
195
        This will include projects for offerings in which the user is
205
196
        enrolled, as long as the project is not in a project set which has
206
197
        groups (ie. if maximum number of group members is 0).
207
198
 
208
 
        @param active_only: Whether to only search active offerings.
209
 
        @param offering: An optional offering to restrict the search to.
210
 
        """
 
199
        Unless active_only is False, only projects for active offerings will
 
200
        be returned.
 
201
 
 
202
        If an offering is specified, returned projects will be limited to
 
203
        those for that offering.
 
204
        '''
211
205
        return Store.of(self).find(Project,
212
206
            Project.project_set_id == ProjectSet.id,
213
 
            ProjectSet.max_students_per_group == None,
 
207
            ProjectSet.max_students_per_group == 0,
214
208
            ProjectSet.offering_id == Offering.id,
215
209
            (offering is None) or (Offering.id == offering.id),
216
210
            Semester.id == Offering.semester_id,
217
211
            (not active_only) or (Semester.state == u'current'),
218
212
            Enrolment.offering_id == Offering.id,
219
 
            Enrolment.user_id == self.id,
220
 
            Enrolment.active == True)
 
213
            Enrolment.user_id == self.id)
221
214
 
222
215
    @staticmethod
223
216
    def hash_password(password):
224
 
        """Hash a password with MD5."""
225
 
        return hashlib.md5(password).hexdigest()
 
217
        return md5.md5(password).hexdigest()
226
218
 
227
219
    @classmethod
228
220
    def get_by_login(cls, store, login):
229
 
        """Find a user in a store by login name."""
 
221
        """
 
222
        Get the User from the db associated with a given store and
 
223
        login.
 
224
        """
230
225
        return store.find(cls, cls.login == unicode(login)).one()
231
226
 
232
 
    def get_permissions(self, user, config):
233
 
        """Determine privileges held by a user over this object.
234
 
 
235
 
        If the user requesting privileges is this user or an admin,
236
 
        they may do everything. Otherwise they may do nothing.
237
 
        """
 
227
    def get_permissions(self, user):
238
228
        if user and user.admin or user is self:
239
 
            return set(['view_public', 'view', 'edit', 'submit_project'])
 
229
            return set(['view', 'edit', 'submit_project'])
240
230
        else:
241
 
            return set(['view_public'])
 
231
            return set()
242
232
 
243
233
# SUBJECTS AND ENROLMENTS #
244
234
 
245
235
class Subject(Storm):
246
 
    """A subject (or course) which is run in some semesters."""
247
 
 
248
236
    __storm_table__ = "subject"
249
237
 
250
238
    id = Int(primary=True, name="subjectid")
251
239
    code = Unicode(name="subj_code")
252
240
    name = Unicode(name="subj_name")
253
241
    short_name = Unicode(name="subj_short_name")
 
242
    url = Unicode()
254
243
 
255
244
    offerings = ReferenceSet(id, 'Offering.subject_id')
256
245
 
259
248
    def __repr__(self):
260
249
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
261
250
 
262
 
    def get_permissions(self, user, config):
263
 
        """Determine privileges held by a user over this object.
264
 
 
265
 
        If the user requesting privileges is an admin, they may edit.
266
 
        Otherwise they may only read.
267
 
        """
 
251
    def get_permissions(self, user):
268
252
        perms = set()
269
253
        if user is not None:
270
254
            perms.add('view')
272
256
                perms.add('edit')
273
257
        return perms
274
258
 
275
 
    def active_offerings(self):
276
 
        """Find active offerings for this subject.
277
 
 
278
 
        Return a sequence of currently active offerings for this subject
279
 
        (offerings whose semester.state is "current"). There should be 0 or 1
280
 
        elements in this sequence, but it's possible there are more.
281
 
        """
282
 
        return self.offerings.find(Offering.semester_id == Semester.id,
283
 
                                   Semester.state == u'current')
284
 
 
285
 
    def offering_for_semester(self, year, semester):
286
 
        """Get the offering for the given year/semester, or None.
287
 
 
288
 
        @param year: A string representation of the year.
289
 
        @param semester: A string representation of the semester.
290
 
        """
291
 
        return self.offerings.find(Offering.semester_id == Semester.id,
292
 
                               Semester.year == unicode(year),
293
 
                               Semester.semester == unicode(semester)).one()
294
 
 
295
259
class Semester(Storm):
296
 
    """A semester in which subjects can be run."""
297
 
 
298
260
    __storm_table__ = "semester"
299
261
 
300
262
    id = Int(primary=True, name="semesterid")
314
276
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
315
277
 
316
278
class Offering(Storm):
317
 
    """An offering of a subject in a particular semester."""
318
 
 
319
279
    __storm_table__ = "offering"
320
280
 
321
281
    id = Int(primary=True, name="offeringid")
323
283
    subject = Reference(subject_id, Subject.id)
324
284
    semester_id = Int(name="semesterid")
325
285
    semester = Reference(semester_id, Semester.id)
326
 
    description = Unicode()
327
 
    url = Unicode()
328
 
    show_worksheet_marks = Bool()
329
 
    worksheet_cutoff = DateTime()
330
286
    groups_student_permissions = Unicode()
331
287
 
332
288
    enrolments = ReferenceSet(id, 'Enrolment.offering_id')
335
291
                           'Enrolment.user_id',
336
292
                           'User.id')
337
293
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
338
 
    projects = ReferenceSet(id,
339
 
                            'ProjectSet.offering_id',
340
 
                            'ProjectSet.id',
341
 
                            'Project.project_set_id')
342
294
 
343
295
    worksheets = ReferenceSet(id, 
344
296
        'Worksheet.offering_id', 
352
304
                                  self.semester)
353
305
 
354
306
    def enrol(self, user, role=u'student'):
355
 
        """Enrol a user in this offering.
356
 
 
357
 
        Enrolments handle both the staff and student cases. The role controls
358
 
        the privileges granted by this enrolment.
359
 
        """
 
307
        '''Enrol a user in this offering.'''
360
308
        enrolment = Store.of(self).find(Enrolment,
361
309
                               Enrolment.user_id == user.id,
362
310
                               Enrolment.offering_id == self.id).one()
375
323
                               Enrolment.offering_id == self.id).one()
376
324
        Store.of(enrolment).remove(enrolment)
377
325
 
378
 
    def get_permissions(self, user, config):
 
326
    def get_permissions(self, user):
379
327
        perms = set()
380
328
        if user is not None:
381
329
            enrolment = self.get_enrolment(user)
382
330
            if enrolment or user.admin:
383
331
                perms.add('view')
384
 
            if enrolment and enrolment.role == u'tutor':
385
 
                perms.add('view_project_submissions')
386
 
                # Site-specific policy on the role of tutors
387
 
                if config['policy']['tutors_can_enrol_students']:
388
 
                    perms.add('enrol')
389
 
                    perms.add('enrol_student')
390
 
                if config['policy']['tutors_can_edit_worksheets']:
391
 
                    perms.add('edit_worksheets')
392
 
                if config['policy']['tutors_can_admin_groups']:
393
 
                    perms.add('admin_groups')
394
 
            if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
395
 
                perms.add('view_project_submissions')
396
 
                perms.add('admin_groups')
397
 
                perms.add('edit_worksheets')
398
 
                perms.add('view_worksheet_marks')
399
 
                perms.add('edit')           # Can edit projects & details
400
 
                perms.add('enrol')          # Can see enrolment screen at all
401
 
                perms.add('enrol_student')  # Can enrol students
402
 
                perms.add('enrol_tutor')    # Can enrol tutors
403
 
            if user.admin:
404
 
                perms.add('enrol_lecturer') # Can enrol lecturers
 
332
            if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
 
333
               or user.admin:
 
334
                perms.add('edit')
405
335
        return perms
406
336
 
407
337
    def get_enrolment(self, user):
408
 
        """Find the user's enrolment in this offering."""
409
338
        try:
410
339
            enrolment = self.enrolments.find(user=user).one()
411
340
        except NotOneError:
413
342
 
414
343
        return enrolment
415
344
 
416
 
    def get_members_by_role(self, role):
417
 
        return Store.of(self).find(User,
418
 
                Enrolment.user_id == User.id,
419
 
                Enrolment.offering_id == self.id,
420
 
                Enrolment.role == role
421
 
                ).order_by(User.login)
422
 
 
423
 
    @property
424
 
    def students(self):
425
 
        return self.get_members_by_role(u'student')
426
 
 
427
 
    def get_open_projects_for_user(self, user):
428
 
        """Find all projects currently open to submissions by a user."""
429
 
        # XXX: Respect extensions.
430
 
        return self.projects.find(Project.deadline > datetime.datetime.now())
431
 
 
432
 
    def clone_worksheets(self, source):
433
 
        """Clone all worksheets from the specified source to this offering."""
434
 
        import ivle.worksheet.utils
435
 
        for worksheet in source.worksheets:
436
 
            newws = Worksheet()
437
 
            newws.seq_no = worksheet.seq_no
438
 
            newws.identifier = worksheet.identifier
439
 
            newws.name = worksheet.name
440
 
            newws.assessable = worksheet.assessable
441
 
            newws.published = worksheet.published
442
 
            newws.data = worksheet.data
443
 
            newws.format = worksheet.format
444
 
            newws.offering = self
445
 
            Store.of(self).add(newws)
446
 
            ivle.worksheet.utils.update_exerciselist(newws)
447
 
 
448
 
 
449
345
class Enrolment(Storm):
450
 
    """An enrolment of a user in an offering.
451
 
 
452
 
    This represents the roles of both staff and students.
453
 
    """
454
 
 
455
346
    __storm_table__ = "enrolment"
456
347
    __storm_primary__ = "user_id", "offering_id"
457
348
 
477
368
        return "<%s %r in %r>" % (type(self).__name__, self.user,
478
369
                                  self.offering)
479
370
 
480
 
    def get_permissions(self, user, config):
481
 
        # A user can edit any enrolment that they could have created.
482
 
        perms = set()
483
 
        if ('enrol_' + str(self.role)) in self.offering.get_permissions(
484
 
            user, config):
485
 
            perms.add('edit')
486
 
        return perms
487
 
 
488
 
    def delete(self):
489
 
        """Delete this enrolment."""
490
 
        Store.of(self).remove(self)
491
 
 
492
 
 
493
371
# PROJECTS #
494
372
 
495
373
class ProjectSet(Storm):
496
 
    """A set of projects that share common groups.
497
 
 
498
 
    Each student project group is attached to a project set. The group is
499
 
    valid for all projects in the group's set.
500
 
    """
501
 
 
502
374
    __storm_table__ = "project_set"
503
375
 
504
376
    id = Int(name="projectsetid", primary=True)
515
387
        return "<%s %d in %r>" % (type(self).__name__, self.id,
516
388
                                  self.offering)
517
389
 
518
 
    def get_permissions(self, user, config):
519
 
        return self.offering.get_permissions(user, config)
520
 
 
521
 
    def get_groups_for_user(self, user):
522
 
        """List all groups in this offering of which the user is a member."""
523
 
        assert self.is_group
524
 
        return Store.of(self).find(
525
 
            ProjectGroup,
526
 
            ProjectGroupMembership.user_id == user.id,
527
 
            ProjectGroupMembership.project_group_id == ProjectGroup.id,
528
 
            ProjectGroup.project_set_id == self.id)
529
 
 
530
 
    def get_submission_principal(self, user):
531
 
        """Get the principal on behalf of which the user can submit.
532
 
 
533
 
        If this is a solo project set, the given user is returned. If
534
 
        the user is a member of exactly one group, all the group is
535
 
        returned. Otherwise, None is returned.
536
 
        """
537
 
        if self.is_group:
538
 
            groups = self.get_groups_for_user(user)
539
 
            if groups.count() == 1:
540
 
                return groups.one()
541
 
            else:
542
 
                return None
543
 
        else:
544
 
            return user
545
 
 
546
 
    @property
547
 
    def is_group(self):
548
 
        return self.max_students_per_group is not None
549
 
 
550
 
    @property
551
 
    def assigned(self):
552
 
        """Get the entities (groups or users) assigned to submit this project.
553
 
 
554
 
        This will be a Storm ResultSet.
555
 
        """
556
 
        #If its a solo project, return everyone in offering
557
 
        if self.is_group:
558
 
            return self.project_groups
559
 
        else:
560
 
            return self.offering.students
561
 
 
562
 
class DeadlinePassed(Exception):
563
 
    """An exception indicating that a project cannot be submitted because the
564
 
    deadline has passed."""
565
 
    def __init__(self):
566
 
        pass
567
 
    def __str__(self):
568
 
        return "The project deadline has passed"
569
 
 
570
390
class Project(Storm):
571
 
    """A student project for which submissions can be made."""
572
 
 
573
391
    __storm_table__ = "project"
574
392
 
575
393
    id = Int(name="projectid", primary=True)
593
411
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
594
412
                                  self.project_set.offering)
595
413
 
596
 
    def can_submit(self, principal, user):
 
414
    def can_submit(self, principal):
597
415
        return (self in principal.get_projects() and
598
 
                not self.has_deadline_passed(user))
 
416
                self.deadline > datetime.datetime.now())
599
417
 
600
418
    def submit(self, principal, path, revision, who):
601
419
        """Submit a Subversion path and revision to a project.
602
420
 
603
 
        @param principal: The owner of the Subversion repository, and the
604
 
                          entity on behalf of whom the submission is being made
605
 
        @param path: A path within that repository to submit.
606
 
        @param revision: The revision of that path to submit.
607
 
        @param who: The user who is actually making the submission.
 
421
        'principal' is the owner of the Subversion repository, and the
 
422
        entity on behalf of whom the submission is being made. 'path' is
 
423
        a path within that repository, and 'revision' specifies which
 
424
        revision of that path. 'who' is the person making the submission.
608
425
        """
609
426
 
610
 
        if not self.can_submit(principal, who):
611
 
            raise DeadlinePassed()
 
427
        if not self.can_submit(principal):
 
428
            raise Exception('cannot submit')
612
429
 
613
430
        a = Assessed.get(Store.of(self), principal, self)
614
431
        ps = ProjectSubmission()
615
 
        # Raise SubmissionError if the path is illegal
616
 
        ps.path = ProjectSubmission.test_and_normalise_path(path)
 
432
        ps.path = path
617
433
        ps.revision = revision
618
434
        ps.date_submitted = datetime.datetime.now()
619
435
        ps.assessed = a
621
437
 
622
438
        return ps
623
439
 
624
 
    def get_permissions(self, user, config):
625
 
        return self.project_set.offering.get_permissions(user, config)
626
 
 
627
 
    @property
628
 
    def latest_submissions(self):
629
 
        """Return the latest submission for each Assessed."""
630
 
        return Store.of(self).find(ProjectSubmission,
631
 
            Assessed.project_id == self.id,
632
 
            ProjectSubmission.assessed_id == Assessed.id,
633
 
            ProjectSubmission.date_submitted == Select(
634
 
                    Max(ProjectSubmission.date_submitted),
635
 
                    ProjectSubmission.assessed_id == Assessed.id,
636
 
                    tables=ProjectSubmission
637
 
            )
638
 
        )
639
 
 
640
 
    def has_deadline_passed(self, user):
641
 
        """Check whether the deadline has passed."""
642
 
        # XXX: Need to respect extensions.
643
 
        return self.deadline < datetime.datetime.now()
644
 
 
645
 
    def get_submissions_for_principal(self, principal):
646
 
        """Fetch a ResultSet of all submissions by a particular principal."""
647
 
        assessed = Assessed.get(Store.of(self), principal, self)
648
 
        if assessed is None:
649
 
            return
650
 
        return assessed.submissions
651
 
 
652
 
 
653
440
 
654
441
class ProjectGroup(Storm):
655
 
    """A group of students working together on a project."""
656
 
 
657
442
    __storm_table__ = "project_group"
658
443
 
659
444
    id = Int(name="groupid", primary=True)
678
463
 
679
464
    @property
680
465
    def display_name(self):
681
 
        """Returns the "nice name" of the user or group."""
682
 
        return self.nick
683
 
 
684
 
    @property
685
 
    def short_name(self):
686
 
        """Returns the database "identifier" name of the user or group."""
687
 
        return self.name
 
466
        return '%s (%s)' % (self.nick, self.name)
688
467
 
689
468
    def get_projects(self, offering=None, active_only=True):
690
 
        '''Find projects that the group can submit.
 
469
        '''Return Projects that the group can submit.
691
470
 
692
471
        This will include projects in the project set which owns this group,
693
472
        unless the project set disallows groups (in which case none will be
694
473
        returned).
695
474
 
696
 
        @param active_only: Whether to only search active offerings.
697
 
        @param offering: An optional offering to restrict the search to.
 
475
        Unless active_only is False, projects will only be returned if the
 
476
        group's offering is active.
 
477
 
 
478
        If an offering is specified, projects will only be returned if it
 
479
        matches the group's.
698
480
        '''
699
481
        return Store.of(self).find(Project,
700
482
            Project.project_set_id == ProjectSet.id,
701
483
            ProjectSet.id == self.project_set.id,
702
 
            ProjectSet.max_students_per_group != None,
 
484
            ProjectSet.max_students_per_group > 0,
703
485
            ProjectSet.offering_id == Offering.id,
704
486
            (offering is None) or (Offering.id == offering.id),
705
487
            Semester.id == Offering.semester_id,
706
488
            (not active_only) or (Semester.state == u'current'))
707
489
 
708
490
 
709
 
    def get_permissions(self, user, config):
 
491
    def get_permissions(self, user):
710
492
        if user.admin or user in self.members:
711
493
            return set(['submit_project'])
712
494
        else:
713
495
            return set()
714
496
 
715
497
class ProjectGroupMembership(Storm):
716
 
    """A student's membership in a project group."""
717
 
 
718
498
    __storm_table__ = "group_member"
719
499
    __storm_primary__ = "user_id", "project_group_id"
720
500
 
730
510
                                  self.project_group)
731
511
 
732
512
class Assessed(Storm):
733
 
    """A composite of a user or group combined with a project.
734
 
 
735
 
    Each project submission and extension refers to an Assessed. It is the
736
 
    sole specifier of the repository and project.
737
 
    """
738
 
 
739
513
    __storm_table__ = "assessed"
740
514
 
741
515
    id = Int(name="assessedid", primary=True)
748
522
    project = Reference(project_id, Project.id)
749
523
 
750
524
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
751
 
    submissions = ReferenceSet(
752
 
        id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
 
525
    submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
753
526
 
754
527
    def __repr__(self):
755
528
        return "<%s %r in %r>" % (type(self).__name__,
756
529
            self.user or self.project_group, self.project)
757
530
 
758
 
    @property
759
 
    def is_group(self):
760
 
        """True if the Assessed is a group, False if it is a user."""
761
 
        return self.project_group is not None
762
 
 
763
 
    @property
764
 
    def principal(self):
765
 
        return self.project_group or self.user
766
 
 
767
 
    @property
768
 
    def checkout_location(self):
769
 
        """Returns the location of the Subversion workspace for this piece of
770
 
        assessment, relative to each group member's home directory."""
771
 
        subjectname = self.project.project_set.offering.subject.short_name
772
 
        if self.is_group:
773
 
            checkout_dir_name = self.principal.short_name
774
 
        else:
775
 
            checkout_dir_name = "mywork"
776
 
        return subjectname + "/" + checkout_dir_name
777
 
 
778
531
    @classmethod
779
532
    def get(cls, store, principal, project):
780
 
        """Find or create an Assessed for the given user or group and project.
781
 
 
782
 
        @param principal: The user or group.
783
 
        @param project: The project.
784
 
        """
785
533
        t = type(principal)
786
534
        if t not in (User, ProjectGroup):
787
535
            raise AssertionError('principal must be User or ProjectGroup')
789
537
        a = store.find(cls,
790
538
            (t is User) or (cls.project_group_id == principal.id),
791
539
            (t is ProjectGroup) or (cls.user_id == principal.id),
792
 
            cls.project_id == project.id).one()
 
540
            Project.id == project.id).one()
793
541
 
794
542
        if a is None:
795
543
            a = cls()
804
552
 
805
553
 
806
554
class ProjectExtension(Storm):
807
 
    """An extension granted to a user or group on a particular project.
808
 
 
809
 
    The user or group and project are specified by the Assessed.
810
 
    """
811
 
 
812
555
    __storm_table__ = "project_extension"
813
556
 
814
557
    id = Int(name="extensionid", primary=True)
819
562
    approver = Reference(approver_id, User.id)
820
563
    notes = Unicode()
821
564
 
822
 
class SubmissionError(Exception):
823
 
    """Denotes a validation error during submission."""
824
 
    pass
825
 
 
826
565
class ProjectSubmission(Storm):
827
 
    """A submission from a user or group repository to a particular project.
828
 
 
829
 
    The content of a submission is a single path and revision inside a
830
 
    repository. The repository is that owned by the submission's user and
831
 
    group, while the path and revision are explicit.
832
 
 
833
 
    The user or group and project are specified by the Assessed.
834
 
    """
835
 
 
836
566
    __storm_table__ = "project_submission"
837
567
 
838
568
    id = Int(name="submissionid", primary=True)
844
574
    submitter = Reference(submitter_id, User.id)
845
575
    date_submitted = DateTime()
846
576
 
847
 
    def get_verify_url(self, user):
848
 
        """Get the URL for verifying this submission, within the account of
849
 
        the given user."""
850
 
        # If this is a solo project, then self.path will be prefixed with the
851
 
        # subject name. Remove the first path segment.
852
 
        submitpath = self.path[1:] if self.path[:1] == '/' else self.path
853
 
        if not self.assessed.is_group:
854
 
            if '/' in submitpath:
855
 
                submitpath = submitpath.split('/', 1)[1]
856
 
            else:
857
 
                submitpath = ''
858
 
        return "/files/%s/%s/%s?r=%d" % (user.login,
859
 
            self.assessed.checkout_location, submitpath, self.revision)
860
 
 
861
 
    @staticmethod
862
 
    def test_and_normalise_path(path):
863
 
        """Test that path is valid, and normalise it. This prevents possible
864
 
        injections using malicious paths.
865
 
        Returns the updated path, if successful.
866
 
        Raises SubmissionError if invalid.
867
 
        """
868
 
        # Ensure the path is absolute to prevent being tacked onto working
869
 
        # directories.
870
 
        # Prevent '\n' because it will break all sorts of things.
871
 
        # Prevent '[' and ']' because they can be used to inject into the
872
 
        # svn.conf.
873
 
        # Normalise to avoid resulting in ".." path segments.
874
 
        if not os.path.isabs(path):
875
 
            raise SubmissionError("Path is not absolute")
876
 
        if any(c in path for c in "\n[]"):
877
 
            raise SubmissionError("Path must not contain '\\n', '[' or ']'")
878
 
        return os.path.normpath(path)
879
577
 
880
578
# WORKSHEETS AND EXERCISES #
881
579
 
882
580
class Exercise(Storm):
883
 
    """An exercise for students to complete in a worksheet.
884
 
 
885
 
    An exercise may be present in any number of worksheets.
886
 
    """
887
 
 
888
581
    __storm_table__ = "exercise"
889
582
    id = Unicode(primary=True, name="identifier")
890
583
    name = Unicode()
902
595
        'WorksheetExercise.worksheet_id',
903
596
        'Worksheet.id'
904
597
    )
905
 
 
 
598
    
906
599
    test_suites = ReferenceSet(id, 
907
600
        'TestSuite.exercise_id',
908
601
        order_by='seq_no')
912
605
    def __repr__(self):
913
606
        return "<%s %s>" % (type(self).__name__, self.name)
914
607
 
915
 
    def get_permissions(self, user, config):
916
 
        return self.global_permissions(user, config)
917
 
 
918
 
    @staticmethod
919
 
    def global_permissions(user, config):
920
 
        """Gets the set of permissions this user has over *all* exercises.
921
 
        This is used to determine who may view the exercises list, and create
922
 
        new exercises."""
 
608
    def get_permissions(self, user):
923
609
        perms = set()
924
610
        roles = set()
925
611
        if user is not None:
926
612
            if user.admin:
927
613
                perms.add('edit')
928
614
                perms.add('view')
929
 
            elif u'lecturer' in set((e.role for e in user.active_enrolments)):
930
 
                perms.add('edit')
931
 
                perms.add('view')
932
 
            elif (config['policy']['tutors_can_edit_worksheets']
933
 
            and u'tutor' in set((e.role for e in user.active_enrolments))):
934
 
                # Site-specific policy on the role of tutors
935
 
                perms.add('edit')
936
 
                perms.add('view')
937
 
 
 
615
            elif 'lecturer' in set((e.role for e in user.active_enrolments)):
 
616
                perms.add('edit')
 
617
                perms.add('view')
 
618
            
938
619
        return perms
939
 
 
 
620
    
940
621
    def get_description(self):
941
 
        """Return the description interpreted as reStructuredText."""
942
622
        return rst(self.description)
943
623
 
944
624
    def delete(self):
950
630
        Store.of(self).remove(self)
951
631
 
952
632
class Worksheet(Storm):
953
 
    """A worksheet with exercises for students to complete.
954
 
 
955
 
    Worksheets are owned by offerings.
956
 
    """
957
 
 
958
633
    __storm_table__ = "worksheet"
959
634
 
960
635
    id = Int(primary=True, name="worksheetid")
962
637
    identifier = Unicode()
963
638
    name = Unicode()
964
639
    assessable = Bool()
965
 
    published = Bool()
966
640
    data = Unicode()
967
641
    seq_no = Int()
968
642
    format = Unicode()
986
660
    def __repr__(self):
987
661
        return "<%s %s>" % (type(self).__name__, self.name)
988
662
 
 
663
    # XXX Refactor this - make it an instance method of Subject rather than a
 
664
    # class method of Worksheet. Can't do that now because Subject isn't
 
665
    # linked referentially to the Worksheet.
 
666
    @classmethod
 
667
    def get_by_name(cls, store, subjectname, worksheetname):
 
668
        """
 
669
        Get the Worksheet from the db associated with a given store, subject
 
670
        name and worksheet name.
 
671
        """
 
672
        return store.find(cls, cls.subject == unicode(subjectname),
 
673
            cls.name == unicode(worksheetname)).one()
 
674
 
989
675
    def remove_all_exercises(self):
990
 
        """Remove all exercises from this worksheet.
991
 
 
 
676
        """
 
677
        Remove all exercises from this worksheet.
992
678
        This does not delete the exercises themselves. It just removes them
993
679
        from the worksheet.
994
680
        """
998
684
                raise IntegrityError()
999
685
        store.find(WorksheetExercise,
1000
686
            WorksheetExercise.worksheet == self).remove()
1001
 
 
1002
 
    def get_permissions(self, user, config):
1003
 
        offering_perms = self.offering.get_permissions(user, config)
1004
 
 
1005
 
        perms = set()
1006
 
 
1007
 
        # Anybody who can view an offering can view a published
1008
 
        # worksheet.
1009
 
        if 'view' in offering_perms and self.published:
1010
 
            perms.add('view')
1011
 
 
1012
 
        # Any worksheet editors can both view and edit.
1013
 
        if 'edit_worksheets' in offering_perms:
1014
 
            perms.add('view')
1015
 
            perms.add('edit')
1016
 
 
1017
 
        return perms
1018
 
 
 
687
            
 
688
    def get_permissions(self, user):
 
689
        return self.offering.get_permissions(user)
 
690
    
1019
691
    def get_xml(self):
1020
692
        """Returns the xml of this worksheet, converts from rst if required."""
1021
693
        if self.format == u'rst':
1023
695
            return ws_xml
1024
696
        else:
1025
697
            return self.data
1026
 
 
 
698
    
1027
699
    def delete(self):
1028
700
        """Deletes the worksheet, provided it has no attempts on any exercises.
1029
 
 
 
701
        
1030
702
        Returns True if delete succeeded, or False if this worksheet has
1031
703
        attempts attached."""
1032
704
        for ws_ex in self.all_worksheet_exercises:
1033
705
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1034
706
                raise IntegrityError()
1035
 
 
 
707
        
1036
708
        self.remove_all_exercises()
1037
709
        Store.of(self).remove(self)
1038
 
 
 
710
        
1039
711
class WorksheetExercise(Storm):
1040
 
    """A link between a worksheet and one of its exercises.
1041
 
 
1042
 
    These may be marked optional, in which case the exercise does not count
1043
 
    for marking purposes. The sequence number is used to order the worksheet
1044
 
    ToC.
1045
 
    """
1046
 
 
1047
712
    __storm_table__ = "worksheet_exercise"
1048
 
 
 
713
    
1049
714
    id = Int(primary=True, name="ws_ex_id")
1050
715
 
1051
716
    worksheet_id = Int(name="worksheetid")
1055
720
    optional = Bool()
1056
721
    active = Bool()
1057
722
    seq_no = Int()
1058
 
 
 
723
    
1059
724
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
1060
725
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
1061
726
 
1065
730
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1066
731
                                  self.worksheet.identifier)
1067
732
 
1068
 
    def get_permissions(self, user, config):
1069
 
        return self.worksheet.get_permissions(user, config)
1070
 
 
 
733
    def get_permissions(self, user):
 
734
        return self.worksheet.get_permissions(user)
 
735
    
1071
736
 
1072
737
class ExerciseSave(Storm):
1073
 
    """A potential exercise solution submitted by a user for storage.
1074
 
 
1075
 
    This is not an actual tested attempt at an exercise, it's just a save of
1076
 
    the editing session.
1077
 
    """
1078
 
 
 
738
    """
 
739
    Represents a potential solution to an exercise that a user has submitted
 
740
    to the server for storage.
 
741
    A basic ExerciseSave is just the current saved text for this exercise for
 
742
    this user (doesn't count towards their attempts).
 
743
    ExerciseSave may be extended with additional semantics (such as
 
744
    ExerciseAttempt).
 
745
    """
1079
746
    __storm_table__ = "exercise_save"
1080
747
    __storm_primary__ = "ws_ex_id", "user_id"
1081
748
 
1091
758
 
1092
759
    def __repr__(self):
1093
760
        return "<%s %s by %s at %s>" % (type(self).__name__,
1094
 
            self.worksheet_exercise.exercise.name, self.user.login,
1095
 
            self.date.strftime("%c"))
 
761
            self.exercise.name, self.user.login, self.date.strftime("%c"))
1096
762
 
1097
763
class ExerciseAttempt(ExerciseSave):
1098
 
    """An attempt at solving an exercise.
1099
 
 
1100
 
    This is a special case of ExerciseSave, used when the user submits a
1101
 
    candidate solution. Like an ExerciseSave, it constitutes exercise solution
1102
 
    data.
1103
 
 
1104
 
    In addition, it contains information about the result of the submission:
1105
 
 
1106
 
     - complete - True if this submission was successful, rendering this
1107
 
                  exercise complete for this user in this worksheet.
1108
 
     - active   - True if this submission is "active" (usually true).
1109
 
                  Submissions may be de-activated by privileged users for
1110
 
                  special reasons, and then they won't count (either as a
1111
 
                  penalty or success), but will still be stored.
1112
 
    """
1113
 
 
 
764
    """
 
765
    An ExerciseAttempt is a special case of an ExerciseSave. Like an
 
766
    ExerciseSave, it constitutes exercise solution data that the user has
 
767
    submitted to the server for storage.
 
768
    In addition, it contains additional information about the submission.
 
769
    complete - True if this submission was successful, rendering this exercise
 
770
        complete for this user.
 
771
    active - True if this submission is "active" (usually true). Submissions
 
772
        may be de-activated by privileged users for special reasons, and then
 
773
        they won't count (either as a penalty or success), but will still be
 
774
        stored.
 
775
    """
1114
776
    __storm_table__ = "exercise_attempt"
1115
777
    __storm_primary__ = "ws_ex_id", "user_id", "date"
1116
778
 
1119
781
    text = Unicode(name="attempt")
1120
782
    complete = Bool()
1121
783
    active = Bool()
1122
 
 
1123
 
    def get_permissions(self, user, config):
 
784
    
 
785
    def get_permissions(self, user):
1124
786
        return set(['view']) if user is self.user else set()
1125
 
 
 
787
  
1126
788
class TestSuite(Storm):
1127
 
    """A container to group an exercise's test cases.
1128
 
 
1129
 
    The test suite contains some information on how to test. The function to
1130
 
    test, variables to set and stdin data are stored here.
1131
 
    """
1132
 
 
 
789
    """A Testsuite acts as a container for the test cases of an exercise."""
1133
790
    __storm_table__ = "test_suite"
1134
791
    __storm_primary__ = "exercise_id", "suiteid"
1135
 
 
 
792
    
1136
793
    suiteid = Int()
1137
794
    exercise_id = Unicode(name="exerciseid")
1138
795
    description = Unicode()
1142
799
    exercise = Reference(exercise_id, Exercise.id)
1143
800
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1144
801
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1145
 
 
 
802
    
1146
803
    def delete(self):
1147
804
        """Delete this suite, without asking questions."""
1148
 
        for variable in self.variables:
 
805
        for vaariable in self.variables:
1149
806
            variable.delete()
1150
807
        for test_case in self.test_cases:
1151
808
            test_case.delete()
1152
809
        Store.of(self).remove(self)
1153
810
 
1154
811
class TestCase(Storm):
1155
 
    """A container for actual tests (see TestCasePart), inside a test suite.
1156
 
 
1157
 
    It is the lowest level shown to students on their pass/fail status."""
1158
 
 
 
812
    """A TestCase is a member of a TestSuite.
 
813
    
 
814
    It contains the data necessary to check if an exercise is correct"""
1159
815
    __storm_table__ = "test_case"
1160
816
    __storm_primary__ = "testid", "suiteid"
1161
 
 
 
817
    
1162
818
    testid = Int()
1163
819
    suiteid = Int()
1164
820
    suite = Reference(suiteid, "TestSuite.suiteid")
1165
821
    passmsg = Unicode()
1166
822
    failmsg = Unicode()
1167
 
    test_default = Unicode() # Currently unused - only used for file matching.
 
823
    test_default = Unicode()
1168
824
    seq_no = Int()
1169
 
 
 
825
    
1170
826
    parts = ReferenceSet(testid, "TestCasePart.testid")
1171
 
 
 
827
    
1172
828
    __init__ = _kwarg_init
1173
 
 
 
829
    
1174
830
    def delete(self):
1175
831
        for part in self.parts:
1176
832
            part.delete()
1177
833
        Store.of(self).remove(self)
1178
834
 
1179
835
class TestSuiteVar(Storm):
1180
 
    """A variable used by an exercise test suite.
1181
 
 
1182
 
    This may represent a function argument or a normal variable.
1183
 
    """
1184
 
 
 
836
    """A container for the arguments of a Test Suite"""
1185
837
    __storm_table__ = "suite_variable"
1186
838
    __storm_primary__ = "varid"
1187
 
 
 
839
    
1188
840
    varid = Int()
1189
841
    suiteid = Int()
1190
842
    var_name = Unicode()
1191
843
    var_value = Unicode()
1192
844
    var_type = Unicode()
1193
845
    arg_no = Int()
1194
 
 
 
846
    
1195
847
    suite = Reference(suiteid, "TestSuite.suiteid")
1196
 
 
 
848
    
1197
849
    __init__ = _kwarg_init
1198
 
 
 
850
    
1199
851
    def delete(self):
1200
852
        Store.of(self).remove(self)
1201
 
 
 
853
    
1202
854
class TestCasePart(Storm):
1203
 
    """An actual piece of code to test an exercise solution."""
1204
 
 
 
855
    """A container for the test elements of a Test Case"""
1205
856
    __storm_table__ = "test_case_part"
1206
857
    __storm_primary__ = "partid"
1207
 
 
 
858
    
1208
859
    partid = Int()
1209
860
    testid = Int()
1210
 
 
 
861
    
1211
862
    part_type = Unicode()
1212
863
    test_type = Unicode()
1213
864
    data = Unicode()
1214
865
    filename = Unicode()
1215
 
 
 
866
    
1216
867
    test = Reference(testid, "TestCase.testid")
1217
 
 
 
868
    
1218
869
    __init__ = _kwarg_init
1219
 
 
 
870
    
1220
871
    def delete(self):
1221
872
        Store.of(self).remove(self)