1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Author: Matt Giuca, Will Grant
20
"""Database utilities and content classes.
22
This module provides all of the classes which map to database tables.
23
It also provides miscellaneous utility functions for database interaction.
32
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
33
Reference, ReferenceSet, Bool, Storm, Desc
34
from storm.expr import Select, Max
35
from storm.exceptions import NotOneError, IntegrityError
37
from ivle.worksheet.rst import rst
39
__all__ = ['get_store',
41
'Subject', 'Semester', 'Offering', 'Enrolment',
42
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
43
'Assessed', 'ProjectSubmission', 'ProjectExtension',
44
'Exercise', 'Worksheet', 'WorksheetExercise',
45
'ExerciseSave', 'ExerciseAttempt',
46
'TestCase', 'TestSuite', 'TestSuiteVar'
49
def _kwarg_init(self, **kwargs):
50
for k,v in kwargs.items():
51
if k.startswith('_') or not hasattr(self.__class__, k):
52
raise TypeError("%s got an unexpected keyword argument '%s'"
53
% (self.__class__.__name__, k))
56
def get_conn_string(config):
57
"""Create a Storm connection string to the IVLE database
59
@param config: The IVLE configuration.
63
if config['database']['username']:
64
clusterstr += config['database']['username']
65
if config['database']['password']:
66
clusterstr += ':' + config['database']['password']
69
host = config['database']['host'] or 'localhost'
70
port = config['database']['port'] or 5432
72
clusterstr += '%s:%d' % (host, port)
74
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
76
def get_store(config):
77
"""Create a Storm store connected to the IVLE database.
79
@param config: The IVLE configuration.
81
return Store(create_database(get_conn_string(config)))
86
"""An IVLE user account."""
87
__storm_table__ = "login"
89
id = Int(primary=True, name="loginid")
98
last_login = DateTime()
102
studentid = Unicode()
105
__init__ = _kwarg_init
108
return "<%s '%s'>" % (type(self).__name__, self.login)
110
def authenticate(self, password):
111
"""Validate a given password against this user.
113
Returns True if the given password matches the password hash for this
114
User, False if it doesn't match, and None if there is no hash for the
117
if self.passhash is None:
119
return self.hash_password(password) == self.passhash
122
def display_name(self):
123
"""Returns the "nice name" of the user or group."""
127
def short_name(self):
128
"""Returns the database "identifier" name of the user or group."""
132
def password_expired(self):
133
fieldval = self.pass_exp
134
return fieldval is not None and datetime.datetime.now() > fieldval
137
def account_expired(self):
138
fieldval = self.acct_exp
139
return fieldval is not None and datetime.datetime.now() > fieldval
143
return self.state == 'enabled' and not self.account_expired
145
def _get_enrolments(self, justactive):
146
return Store.of(self).find(Enrolment,
147
Enrolment.user_id == self.id,
148
(Enrolment.active == True) if justactive else True,
149
Enrolment.offering_id == Offering.id,
150
Offering.semester_id == Semester.id,
151
Offering.subject_id == Subject.id).order_by(
153
Desc(Semester.semester),
157
def _set_password(self, password):
161
self.passhash = unicode(User.hash_password(password))
162
password = property(fset=_set_password)
166
return Store.of(self).find(Subject,
167
Enrolment.user_id == self.id,
168
Enrolment.active == True,
169
Offering.id == Enrolment.offering_id,
170
Subject.id == Offering.subject_id).config(distinct=True)
172
# TODO: Invitations should be listed too?
173
def get_groups(self, offering=None):
174
"""Get groups of which this user is a member.
176
@param offering: An optional offering to restrict the search to.
179
ProjectGroupMembership.user_id == self.id,
180
ProjectGroup.id == ProjectGroupMembership.project_group_id,
184
ProjectSet.offering_id == offering.id,
185
ProjectGroup.project_set_id == ProjectSet.id,
187
return Store.of(self).find(ProjectGroup, *preds)
191
return self.get_groups()
194
def active_enrolments(self):
195
'''A sanely ordered list of the user's active enrolments.'''
196
return self._get_enrolments(True)
199
def enrolments(self):
200
'''A sanely ordered list of all of the user's enrolments.'''
201
return self._get_enrolments(False)
203
def get_projects(self, offering=None, active_only=True):
204
"""Find projects that the user can submit.
206
This will include projects for offerings in which the user is
207
enrolled, as long as the project is not in a project set which has
208
groups (ie. if maximum number of group members is 0).
210
@param active_only: Whether to only search active offerings.
211
@param offering: An optional offering to restrict the search to.
213
return Store.of(self).find(Project,
214
Project.project_set_id == ProjectSet.id,
215
ProjectSet.max_students_per_group == None,
216
ProjectSet.offering_id == Offering.id,
217
(offering is None) or (Offering.id == offering.id),
218
Semester.id == Offering.semester_id,
219
(not active_only) or (Semester.state == u'current'),
220
Enrolment.offering_id == Offering.id,
221
Enrolment.user_id == self.id,
222
Enrolment.active == True)
225
def hash_password(password):
226
"""Hash a password with MD5."""
227
return hashlib.md5(password).hexdigest()
230
def get_by_login(cls, store, login):
231
"""Find a user in a store by login name."""
232
return store.find(cls, cls.login == unicode(login)).one()
234
def get_svn_url(self, config, req):
235
"""Get the subversion repository URL for this user or group."""
236
login = req.user.login
237
url = urlparse.urlsplit(config['urls']['svn_addr'])
238
url = urlparse.urlunsplit(url[:1] + (login+'@'+url[1],) + url[2:])
239
path = 'users/%s' % self.login
240
return urlparse.urljoin(url, path)
242
def get_permissions(self, user, config):
243
"""Determine privileges held by a user over this object.
245
If the user requesting privileges is this user or an admin,
246
they may do everything. Otherwise they may do nothing.
248
if user and user.admin or user is self:
249
return set(['view_public', 'view', 'edit', 'submit_project'])
251
return set(['view_public'])
253
# SUBJECTS AND ENROLMENTS #
255
class Subject(Storm):
256
"""A subject (or course) which is run in some semesters."""
258
__storm_table__ = "subject"
260
id = Int(primary=True, name="subjectid")
261
code = Unicode(name="subj_code")
262
name = Unicode(name="subj_name")
263
short_name = Unicode(name="subj_short_name")
265
offerings = ReferenceSet(id, 'Offering.subject_id')
267
__init__ = _kwarg_init
270
return "<%s '%s'>" % (type(self).__name__, self.short_name)
272
def get_permissions(self, user, config):
273
"""Determine privileges held by a user over this object.
275
If the user requesting privileges is an admin, they may edit.
276
Otherwise they may only read.
285
def active_offerings(self):
286
"""Find active offerings for this subject.
288
Return a sequence of currently active offerings for this subject
289
(offerings whose semester.state is "current"). There should be 0 or 1
290
elements in this sequence, but it's possible there are more.
292
return self.offerings.find(Offering.semester_id == Semester.id,
293
Semester.state == u'current')
295
def offering_for_semester(self, year, semester):
296
"""Get the offering for the given year/semester, or None.
298
@param year: A string representation of the year.
299
@param semester: A string representation of the semester.
301
return self.offerings.find(Offering.semester_id == Semester.id,
302
Semester.year == unicode(year),
303
Semester.semester == unicode(semester)).one()
305
class Semester(Storm):
306
"""A semester in which subjects can be run."""
308
__storm_table__ = "semester"
310
id = Int(primary=True, name="semesterid")
315
offerings = ReferenceSet(id, 'Offering.semester_id')
316
enrolments = ReferenceSet(id,
317
'Offering.semester_id',
319
'Enrolment.offering_id')
321
__init__ = _kwarg_init
324
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
326
class Offering(Storm):
327
"""An offering of a subject in a particular semester."""
329
__storm_table__ = "offering"
331
id = Int(primary=True, name="offeringid")
332
subject_id = Int(name="subject")
333
subject = Reference(subject_id, Subject.id)
334
semester_id = Int(name="semesterid")
335
semester = Reference(semester_id, Semester.id)
336
description = Unicode()
338
show_worksheet_marks = Bool()
339
worksheet_cutoff = DateTime()
340
groups_student_permissions = Unicode()
342
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
343
members = ReferenceSet(id,
344
'Enrolment.offering_id',
347
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
348
projects = ReferenceSet(id,
349
'ProjectSet.offering_id',
351
'Project.project_set_id')
353
worksheets = ReferenceSet(id,
354
'Worksheet.offering_id',
358
__init__ = _kwarg_init
361
return "<%s %r in %r>" % (type(self).__name__, self.subject,
364
def enrol(self, user, role=u'student'):
365
"""Enrol a user in this offering.
367
Enrolments handle both the staff and student cases. The role controls
368
the privileges granted by this enrolment.
370
enrolment = Store.of(self).find(Enrolment,
371
Enrolment.user_id == user.id,
372
Enrolment.offering_id == self.id).one()
374
if enrolment is None:
375
enrolment = Enrolment(user=user, offering=self)
376
self.enrolments.add(enrolment)
378
enrolment.active = True
379
enrolment.role = role
381
def unenrol(self, user):
382
'''Unenrol a user from this offering.'''
383
enrolment = Store.of(self).find(Enrolment,
384
Enrolment.user_id == user.id,
385
Enrolment.offering_id == self.id).one()
386
Store.of(enrolment).remove(enrolment)
388
def get_permissions(self, user, config):
391
enrolment = self.get_enrolment(user)
392
if enrolment or user.admin:
394
if enrolment and enrolment.role == u'tutor':
395
perms.add('view_project_submissions')
396
# Site-specific policy on the role of tutors
397
if config['policy']['tutors_can_enrol_students']:
399
perms.add('enrol_student')
400
if config['policy']['tutors_can_edit_worksheets']:
401
perms.add('edit_worksheets')
402
if config['policy']['tutors_can_admin_groups']:
403
perms.add('admin_groups')
404
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
405
perms.add('view_project_submissions')
406
perms.add('admin_groups')
407
perms.add('edit_worksheets')
408
perms.add('view_worksheet_marks')
409
perms.add('edit') # Can edit projects & details
410
perms.add('enrol') # Can see enrolment screen at all
411
perms.add('enrol_student') # Can enrol students
412
perms.add('enrol_tutor') # Can enrol tutors
414
perms.add('enrol_lecturer') # Can enrol lecturers
417
def get_enrolment(self, user):
418
"""Find the user's enrolment in this offering."""
420
enrolment = self.enrolments.find(user=user).one()
426
def get_members_by_role(self, role):
427
return Store.of(self).find(User,
428
Enrolment.user_id == User.id,
429
Enrolment.offering_id == self.id,
430
Enrolment.role == role
431
).order_by(User.login)
435
return self.get_members_by_role(u'student')
437
def get_open_projects_for_user(self, user):
438
"""Find all projects currently open to submissions by a user."""
439
# XXX: Respect extensions.
440
return self.projects.find(Project.deadline > datetime.datetime.now())
442
def has_worksheet_cutoff_passed(self, user):
443
"""Check whether the worksheet cutoff has passed.
444
A user is required, in case we support extensions.
446
if self.worksheet_cutoff is None:
449
return self.worksheet_cutoff < datetime.datetime.now()
451
def clone_worksheets(self, source):
452
"""Clone all worksheets from the specified source to this offering."""
453
import ivle.worksheet.utils
454
for worksheet in source.worksheets:
456
newws.seq_no = worksheet.seq_no
457
newws.identifier = worksheet.identifier
458
newws.name = worksheet.name
459
newws.assessable = worksheet.assessable
460
newws.published = worksheet.published
461
newws.data = worksheet.data
462
newws.format = worksheet.format
463
newws.offering = self
464
Store.of(self).add(newws)
465
ivle.worksheet.utils.update_exerciselist(newws)
468
class Enrolment(Storm):
469
"""An enrolment of a user in an offering.
471
This represents the roles of both staff and students.
474
__storm_table__ = "enrolment"
475
__storm_primary__ = "user_id", "offering_id"
477
user_id = Int(name="loginid")
478
user = Reference(user_id, User.id)
479
offering_id = Int(name="offeringid")
480
offering = Reference(offering_id, Offering.id)
487
return Store.of(self).find(ProjectGroup,
488
ProjectSet.offering_id == self.offering.id,
489
ProjectGroup.project_set_id == ProjectSet.id,
490
ProjectGroupMembership.project_group_id == ProjectGroup.id,
491
ProjectGroupMembership.user_id == self.user.id)
493
__init__ = _kwarg_init
496
return "<%s %r in %r>" % (type(self).__name__, self.user,
499
def get_permissions(self, user, config):
500
# A user can edit any enrolment that they could have created.
502
if ('enrol_' + str(self.role)) in self.offering.get_permissions(
508
"""Delete this enrolment."""
509
Store.of(self).remove(self)
514
class ProjectSet(Storm):
515
"""A set of projects that share common groups.
517
Each student project group is attached to a project set. The group is
518
valid for all projects in the group's set.
521
__storm_table__ = "project_set"
523
id = Int(name="projectsetid", primary=True)
524
offering_id = Int(name="offeringid")
525
offering = Reference(offering_id, Offering.id)
526
max_students_per_group = Int()
528
projects = ReferenceSet(id, 'Project.project_set_id')
529
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
531
__init__ = _kwarg_init
534
return "<%s %d in %r>" % (type(self).__name__, self.id,
537
def get_permissions(self, user, config):
538
return self.offering.get_permissions(user, config)
540
def get_groups_for_user(self, user):
541
"""List all groups in this offering of which the user is a member."""
543
return Store.of(self).find(
545
ProjectGroupMembership.user_id == user.id,
546
ProjectGroupMembership.project_group_id == ProjectGroup.id,
547
ProjectGroup.project_set_id == self.id)
549
def get_submission_principal(self, user):
550
"""Get the principal on behalf of which the user can submit.
552
If this is a solo project set, the given user is returned. If
553
the user is a member of exactly one group, all the group is
554
returned. Otherwise, None is returned.
557
groups = self.get_groups_for_user(user)
558
if groups.count() == 1:
567
return self.max_students_per_group is not None
571
"""Get the entities (groups or users) assigned to submit this project.
573
This will be a Storm ResultSet.
575
#If its a solo project, return everyone in offering
577
return self.project_groups
579
return self.offering.students
581
class DeadlinePassed(Exception):
582
"""An exception indicating that a project cannot be submitted because the
583
deadline has passed."""
587
return "The project deadline has passed"
589
class Project(Storm):
590
"""A student project for which submissions can be made."""
592
__storm_table__ = "project"
594
id = Int(name="projectid", primary=True)
596
short_name = Unicode()
599
project_set_id = Int(name="projectsetid")
600
project_set = Reference(project_set_id, ProjectSet.id)
601
deadline = DateTime()
603
assesseds = ReferenceSet(id, 'Assessed.project_id')
604
submissions = ReferenceSet(id,
605
'Assessed.project_id',
607
'ProjectSubmission.assessed_id')
609
__init__ = _kwarg_init
612
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
613
self.project_set.offering)
615
def can_submit(self, principal, user):
616
return (self in principal.get_projects() and
617
not self.has_deadline_passed(user))
619
def submit(self, principal, path, revision, who):
620
"""Submit a Subversion path and revision to a project.
622
@param principal: The owner of the Subversion repository, and the
623
entity on behalf of whom the submission is being made
624
@param path: A path within that repository to submit.
625
@param revision: The revision of that path to submit.
626
@param who: The user who is actually making the submission.
629
if not self.can_submit(principal, who):
630
raise DeadlinePassed()
632
a = Assessed.get(Store.of(self), principal, self)
633
ps = ProjectSubmission()
634
# Raise SubmissionError if the path is illegal
635
ps.path = ProjectSubmission.test_and_normalise_path(path)
636
ps.revision = revision
637
ps.date_submitted = datetime.datetime.now()
643
def get_permissions(self, user, config):
644
return self.project_set.offering.get_permissions(user, config)
647
def latest_submissions(self):
648
"""Return the latest submission for each Assessed."""
649
return Store.of(self).find(ProjectSubmission,
650
Assessed.project_id == self.id,
651
ProjectSubmission.assessed_id == Assessed.id,
652
ProjectSubmission.date_submitted == Select(
653
Max(ProjectSubmission.date_submitted),
654
ProjectSubmission.assessed_id == Assessed.id,
655
tables=ProjectSubmission
659
def has_deadline_passed(self, user):
660
"""Check whether the deadline has passed."""
661
# XXX: Need to respect extensions.
662
return self.deadline < datetime.datetime.now()
664
def get_submissions_for_principal(self, principal):
665
"""Fetch a ResultSet of all submissions by a particular principal."""
666
assessed = Assessed.get(Store.of(self), principal, self)
669
return assessed.submissions
672
def can_delete(self):
673
"""Can only delete if there are no submissions."""
674
return self.submissions.count() == 0
677
"""Delete the project. Fails if can_delete is False."""
678
if not self.can_delete:
679
raise IntegrityError()
680
for assessed in self.assesseds:
682
Store.of(self).remove(self)
684
class ProjectGroup(Storm):
685
"""A group of students working together on a project."""
687
__storm_table__ = "project_group"
689
id = Int(name="groupid", primary=True)
690
name = Unicode(name="groupnm")
691
project_set_id = Int(name="projectsetid")
692
project_set = Reference(project_set_id, ProjectSet.id)
694
created_by_id = Int(name="createdby")
695
created_by = Reference(created_by_id, User.id)
698
members = ReferenceSet(id,
699
"ProjectGroupMembership.project_group_id",
700
"ProjectGroupMembership.user_id",
703
__init__ = _kwarg_init
706
return "<%s %s in %r>" % (type(self).__name__, self.name,
707
self.project_set.offering)
710
def display_name(self):
711
"""Returns the "nice name" of the user or group."""
715
def short_name(self):
716
"""Returns the database "identifier" name of the user or group."""
719
def get_projects(self, offering=None, active_only=True):
720
'''Find projects that the group can submit.
722
This will include projects in the project set which owns this group,
723
unless the project set disallows groups (in which case none will be
726
@param active_only: Whether to only search active offerings.
727
@param offering: An optional offering to restrict the search to.
729
return Store.of(self).find(Project,
730
Project.project_set_id == ProjectSet.id,
731
ProjectSet.id == self.project_set.id,
732
ProjectSet.max_students_per_group != None,
733
ProjectSet.offering_id == Offering.id,
734
(offering is None) or (Offering.id == offering.id),
735
Semester.id == Offering.semester_id,
736
(not active_only) or (Semester.state == u'current'))
738
def get_svn_url(self, config, req):
739
"""Get the subversion repository URL for this user or group."""
740
login = req.user.login
741
url = urlparse.urlsplit(config['urls']['svn_addr'])
742
url = urlparse.urlunsplit(url[:1] + (login+'@'+url[1],) + url[2:])
743
path = 'groups/%s_%s_%s_%s' % (
744
self.project_set.offering.subject.short_name,
745
self.project_set.offering.semester.year,
746
self.project_set.offering.semester.semester,
749
return urlparse.urljoin(url, path)
751
def get_permissions(self, user, config):
752
if user.admin or user in self.members:
753
return set(['submit_project'])
757
class ProjectGroupMembership(Storm):
758
"""A student's membership in a project group."""
760
__storm_table__ = "group_member"
761
__storm_primary__ = "user_id", "project_group_id"
763
user_id = Int(name="loginid")
764
user = Reference(user_id, User.id)
765
project_group_id = Int(name="groupid")
766
project_group = Reference(project_group_id, ProjectGroup.id)
768
__init__ = _kwarg_init
771
return "<%s %r in %r>" % (type(self).__name__, self.user,
774
class Assessed(Storm):
775
"""A composite of a user or group combined with a project.
777
Each project submission and extension refers to an Assessed. It is the
778
sole specifier of the repository and project.
781
__storm_table__ = "assessed"
783
id = Int(name="assessedid", primary=True)
784
user_id = Int(name="loginid")
785
user = Reference(user_id, User.id)
786
project_group_id = Int(name="groupid")
787
project_group = Reference(project_group_id, ProjectGroup.id)
789
project_id = Int(name="projectid")
790
project = Reference(project_id, Project.id)
792
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
793
submissions = ReferenceSet(
794
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
797
return "<%s %r in %r>" % (type(self).__name__,
798
self.user or self.project_group, self.project)
802
"""True if the Assessed is a group, False if it is a user."""
803
return self.project_group is not None
807
return self.project_group or self.user
810
def checkout_location(self):
811
"""Returns the location of the Subversion workspace for this piece of
812
assessment, relative to each group member's home directory."""
813
subjectname = self.project.project_set.offering.subject.short_name
815
checkout_dir_name = self.principal.short_name
817
checkout_dir_name = "mywork"
818
return subjectname + "/" + checkout_dir_name
821
def get(cls, store, principal, project):
822
"""Find or create an Assessed for the given user or group and project.
824
@param principal: The user or group.
825
@param project: The project.
828
if t not in (User, ProjectGroup):
829
raise AssertionError('principal must be User or ProjectGroup')
832
(t is User) or (cls.project_group_id == principal.id),
833
(t is ProjectGroup) or (cls.user_id == principal.id),
834
cls.project_id == project.id).one()
841
a.project_group = principal
848
"""Delete the assessed. Fails if there are any submissions. Deletes
850
if self.submissions.count() > 0:
851
raise IntegrityError()
852
for extension in self.extensions:
854
Store.of(self).remove(self)
856
class ProjectExtension(Storm):
857
"""An extension granted to a user or group on a particular project.
859
The user or group and project are specified by the Assessed.
862
__storm_table__ = "project_extension"
864
id = Int(name="extensionid", primary=True)
865
assessed_id = Int(name="assessedid")
866
assessed = Reference(assessed_id, Assessed.id)
867
deadline = DateTime()
868
approver_id = Int(name="approver")
869
approver = Reference(approver_id, User.id)
873
"""Delete the extension."""
874
Store.of(self).remove(self)
876
class SubmissionError(Exception):
877
"""Denotes a validation error during submission."""
880
class ProjectSubmission(Storm):
881
"""A submission from a user or group repository to a particular project.
883
The content of a submission is a single path and revision inside a
884
repository. The repository is that owned by the submission's user and
885
group, while the path and revision are explicit.
887
The user or group and project are specified by the Assessed.
890
__storm_table__ = "project_submission"
892
id = Int(name="submissionid", primary=True)
893
assessed_id = Int(name="assessedid")
894
assessed = Reference(assessed_id, Assessed.id)
897
submitter_id = Int(name="submitter")
898
submitter = Reference(submitter_id, User.id)
899
date_submitted = DateTime()
901
def get_verify_url(self, user):
902
"""Get the URL for verifying this submission, within the account of
904
# If this is a solo project, then self.path will be prefixed with the
905
# subject name. Remove the first path segment.
906
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
907
if not self.assessed.is_group:
908
if '/' in submitpath:
909
submitpath = submitpath.split('/', 1)[1]
912
return "/files/%s/%s/%s?r=%d" % (user.login,
913
self.assessed.checkout_location, submitpath, self.revision)
915
def get_svn_url(self, req):
916
"""Get subversion URL for this submission"""
917
princ = self.assessed.principal
918
base = princ.get_svn_url(req.config, req)
919
if self.path.startswith(os.sep):
920
return os.path.join(base,
921
urllib.quote(self.path[1:].encode('utf-8')))
923
return os.path.join(base, urllib.quote(self.path.encode('utf-8')))
925
def get_svn_checkout_command(self, req):
926
svn_url = self.get_svn_url(req)
927
return "svn export -r%d '%s'"%(self.revision, svn_url)
930
def test_and_normalise_path(path):
931
"""Test that path is valid, and normalise it. This prevents possible
932
injections using malicious paths.
933
Returns the updated path, if successful.
934
Raises SubmissionError if invalid.
936
# Ensure the path is absolute to prevent being tacked onto working
938
# Prevent '\n' because it will break all sorts of things.
939
# Prevent '[' and ']' because they can be used to inject into the
941
# Normalise to avoid resulting in ".." path segments.
942
if not os.path.isabs(path):
943
raise SubmissionError("Path is not absolute")
944
if any(c in path for c in "\n[]"):
945
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
946
return os.path.normpath(path)
948
# WORKSHEETS AND EXERCISES #
950
class Exercise(Storm):
951
"""An exercise for students to complete in a worksheet.
953
An exercise may be present in any number of worksheets.
956
__storm_table__ = "exercise"
957
id = Unicode(primary=True, name="identifier")
959
description = Unicode()
960
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
966
worksheet_exercises = ReferenceSet(id,
967
'WorksheetExercise.exercise_id')
969
worksheets = ReferenceSet(id,
970
'WorksheetExercise.exercise_id',
971
'WorksheetExercise.worksheet_id',
975
test_suites = ReferenceSet(id,
976
'TestSuite.exercise_id',
979
__init__ = _kwarg_init
982
return "<%s %s>" % (type(self).__name__, self.name)
984
def get_permissions(self, user, config):
985
return self.global_permissions(user, config)
988
def global_permissions(user, config):
989
"""Gets the set of permissions this user has over *all* exercises.
990
This is used to determine who may view the exercises list, and create
998
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
1001
elif (config['policy']['tutors_can_edit_worksheets']
1002
and u'tutor' in set((e.role for e in user.active_enrolments))):
1003
# Site-specific policy on the role of tutors
1009
def _cache_description_xhtml(self, invalidate=False):
1010
# Don't regenerate an existing cache unless forced.
1011
if self._description_xhtml_cache is not None and not invalidate:
1014
if self.description:
1015
self._description_xhtml_cache = rst(self.description)
1017
self._description_xhtml_cache = None
1020
def description_xhtml(self):
1021
"""The XHTML exercise description, converted from reStructuredText."""
1022
self._cache_description_xhtml()
1023
return self._description_xhtml_cache
1025
def set_description(self, description):
1026
self.description = description
1027
self._cache_description_xhtml(invalidate=True)
1030
"""Deletes the exercise, providing it has no associated worksheets."""
1031
if (self.worksheet_exercises.count() > 0):
1032
raise IntegrityError()
1033
for suite in self.test_suites:
1035
Store.of(self).remove(self)
1037
class Worksheet(Storm):
1038
"""A worksheet with exercises for students to complete.
1040
Worksheets are owned by offerings.
1043
__storm_table__ = "worksheet"
1045
id = Int(primary=True, name="worksheetid")
1046
offering_id = Int(name="offeringid")
1047
identifier = Unicode()
1052
_data_xhtml_cache = Unicode(name='data_xhtml_cache')
1056
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
1057
offering = Reference(offering_id, 'Offering.id')
1059
all_worksheet_exercises = ReferenceSet(id,
1060
'WorksheetExercise.worksheet_id')
1062
# Use worksheet_exercises to get access to the *active* WorksheetExercise
1063
# objects binding worksheets to exercises. This is required to access the
1067
def worksheet_exercises(self):
1068
return self.all_worksheet_exercises.find(active=True)
1070
__init__ = _kwarg_init
1073
return "<%s %s>" % (type(self).__name__, self.name)
1075
def remove_all_exercises(self):
1076
"""Remove all exercises from this worksheet.
1078
This does not delete the exercises themselves. It just removes them
1081
store = Store.of(self)
1082
for ws_ex in self.all_worksheet_exercises:
1083
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1084
raise IntegrityError()
1085
store.find(WorksheetExercise,
1086
WorksheetExercise.worksheet == self).remove()
1088
def get_permissions(self, user, config):
1089
offering_perms = self.offering.get_permissions(user, config)
1093
# Anybody who can view an offering can view a published
1095
if 'view' in offering_perms and self.published:
1098
# Any worksheet editors can both view and edit.
1099
if 'edit_worksheets' in offering_perms:
1105
def _cache_data_xhtml(self, invalidate=False):
1106
# Don't regenerate an existing cache unless forced.
1107
if self._data_xhtml_cache is not None and not invalidate:
1110
if self.format == u'rst':
1111
self._data_xhtml_cache = rst(self.data)
1113
self._data_xhtml_cache = None
1116
def data_xhtml(self):
1117
"""The XHTML of this worksheet, converted from rST if required."""
1118
# Update the rST -> XHTML cache, if required.
1119
self._cache_data_xhtml()
1121
if self.format == u'rst':
1122
return self._data_xhtml_cache
1126
def set_data(self, data):
1128
self._cache_data_xhtml(invalidate=True)
1131
"""Deletes the worksheet, provided it has no attempts on any exercises.
1133
Returns True if delete succeeded, or False if this worksheet has
1134
attempts attached."""
1135
for ws_ex in self.all_worksheet_exercises:
1136
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1137
raise IntegrityError()
1139
self.remove_all_exercises()
1140
Store.of(self).remove(self)
1142
class WorksheetExercise(Storm):
1143
"""A link between a worksheet and one of its exercises.
1145
These may be marked optional, in which case the exercise does not count
1146
for marking purposes. The sequence number is used to order the worksheet
1150
__storm_table__ = "worksheet_exercise"
1152
id = Int(primary=True, name="ws_ex_id")
1154
worksheet_id = Int(name="worksheetid")
1155
worksheet = Reference(worksheet_id, Worksheet.id)
1156
exercise_id = Unicode(name="exerciseid")
1157
exercise = Reference(exercise_id, Exercise.id)
1162
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
1163
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
1165
__init__ = _kwarg_init
1168
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1169
self.worksheet.identifier)
1171
def get_permissions(self, user, config):
1172
return self.worksheet.get_permissions(user, config)
1175
class ExerciseSave(Storm):
1176
"""A potential exercise solution submitted by a user for storage.
1178
This is not an actual tested attempt at an exercise, it's just a save of
1179
the editing session.
1182
__storm_table__ = "exercise_save"
1183
__storm_primary__ = "ws_ex_id", "user_id"
1185
ws_ex_id = Int(name="ws_ex_id")
1186
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
1188
user_id = Int(name="loginid")
1189
user = Reference(user_id, User.id)
1193
__init__ = _kwarg_init
1196
return "<%s %s by %s at %s>" % (type(self).__name__,
1197
self.worksheet_exercise.exercise.name, self.user.login,
1198
self.date.strftime("%c"))
1200
class ExerciseAttempt(ExerciseSave):
1201
"""An attempt at solving an exercise.
1203
This is a special case of ExerciseSave, used when the user submits a
1204
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1207
In addition, it contains information about the result of the submission:
1209
- complete - True if this submission was successful, rendering this
1210
exercise complete for this user in this worksheet.
1211
- active - True if this submission is "active" (usually true).
1212
Submissions may be de-activated by privileged users for
1213
special reasons, and then they won't count (either as a
1214
penalty or success), but will still be stored.
1217
__storm_table__ = "exercise_attempt"
1218
__storm_primary__ = "ws_ex_id", "user_id", "date"
1220
# The "text" field is the same but has a different name in the DB table
1222
text = Unicode(name="attempt")
1226
def get_permissions(self, user, config):
1227
return set(['view']) if user is self.user else set()
1229
class TestSuite(Storm):
1230
"""A container to group an exercise's test cases.
1232
The test suite contains some information on how to test. The function to
1233
test, variables to set and stdin data are stored here.
1236
__storm_table__ = "test_suite"
1237
__storm_primary__ = "exercise_id", "suiteid"
1240
exercise_id = Unicode(name="exerciseid")
1241
description = Unicode()
1243
function = Unicode()
1245
exercise = Reference(exercise_id, Exercise.id)
1246
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1247
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1250
"""Delete this suite, without asking questions."""
1251
for variable in self.variables:
1253
for test_case in self.test_cases:
1255
Store.of(self).remove(self)
1257
class TestCase(Storm):
1258
"""A container for actual tests (see TestCasePart), inside a test suite.
1260
It is the lowest level shown to students on their pass/fail status."""
1262
__storm_table__ = "test_case"
1263
__storm_primary__ = "testid", "suiteid"
1267
suite = Reference(suiteid, "TestSuite.suiteid")
1270
test_default = Unicode() # Currently unused - only used for file matching.
1273
parts = ReferenceSet(testid, "TestCasePart.testid")
1275
__init__ = _kwarg_init
1278
for part in self.parts:
1280
Store.of(self).remove(self)
1282
class TestSuiteVar(Storm):
1283
"""A variable used by an exercise test suite.
1285
This may represent a function argument or a normal variable.
1288
__storm_table__ = "suite_variable"
1289
__storm_primary__ = "varid"
1293
var_name = Unicode()
1294
var_value = Unicode()
1295
var_type = Unicode()
1298
suite = Reference(suiteid, "TestSuite.suiteid")
1300
__init__ = _kwarg_init
1303
Store.of(self).remove(self)
1305
class TestCasePart(Storm):
1306
"""An actual piece of code to test an exercise solution."""
1308
__storm_table__ = "test_case_part"
1309
__storm_primary__ = "partid"
1314
part_type = Unicode()
1315
test_type = Unicode()
1317
filename = Unicode()
1319
test = Reference(testid, "TestCase.testid")
1321
__init__ = _kwarg_init
1324
Store.of(self).remove(self)
added
removed
ivle/database.py
