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.
31
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
32
Reference, ReferenceSet, Bool, Storm, Desc
33
from storm.expr import Select, Max
34
from storm.exceptions import NotOneError, IntegrityError
36
from ivle.worksheet.rst import rst
38
__all__ = ['get_store',
40
'Subject', 'Semester', 'Offering', 'Enrolment',
41
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
42
'Assessed', 'ProjectSubmission', 'ProjectExtension',
43
'Exercise', 'Worksheet', 'WorksheetExercise',
44
'ExerciseSave', 'ExerciseAttempt',
45
'TestCase', 'TestSuite', 'TestSuiteVar'
48
def _kwarg_init(self, **kwargs):
49
for k,v in kwargs.items():
50
if k.startswith('_') or not hasattr(self.__class__, k):
51
raise TypeError("%s got an unexpected keyword argument '%s'"
52
% (self.__class__.__name__, k))
55
def get_conn_string(config):
56
"""Create a Storm connection string to the IVLE database
58
@param config: The IVLE configuration.
62
if config['database']['username']:
63
clusterstr += config['database']['username']
64
if config['database']['password']:
65
clusterstr += ':' + config['database']['password']
68
host = config['database']['host'] or 'localhost'
69
port = config['database']['port'] or 5432
71
clusterstr += '%s:%d' % (host, port)
73
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
75
def get_store(config):
76
"""Create a Storm store connected to the IVLE database.
78
@param config: The IVLE configuration.
80
return Store(create_database(get_conn_string(config)))
85
"""An IVLE user account."""
86
__storm_table__ = "login"
88
id = Int(primary=True, name="loginid")
97
last_login = DateTime()
101
studentid = Unicode()
104
__init__ = _kwarg_init
107
return "<%s '%s'>" % (type(self).__name__, self.login)
109
def authenticate(self, password):
110
"""Validate a given password against this user.
112
Returns True if the given password matches the password hash for this
113
User, False if it doesn't match, and None if there is no hash for the
116
if self.passhash is None:
118
return self.hash_password(password) == self.passhash
121
def display_name(self):
122
"""Returns the "nice name" of the user or group."""
126
def short_name(self):
127
"""Returns the database "identifier" name of the user or group."""
131
def password_expired(self):
132
fieldval = self.pass_exp
133
return fieldval is not None and datetime.datetime.now() > fieldval
136
def account_expired(self):
137
fieldval = self.acct_exp
138
return fieldval is not None and datetime.datetime.now() > fieldval
142
return self.state == 'enabled' and not self.account_expired
144
def _get_enrolments(self, justactive):
145
return Store.of(self).find(Enrolment,
146
Enrolment.user_id == self.id,
147
(Enrolment.active == True) if justactive else True,
148
Enrolment.offering_id == Offering.id,
149
Offering.semester_id == Semester.id,
150
Offering.subject_id == Subject.id).order_by(
152
Desc(Semester.semester),
156
def _set_password(self, password):
160
self.passhash = unicode(User.hash_password(password))
161
password = property(fset=_set_password)
165
return Store.of(self).find(Subject,
166
Enrolment.user_id == self.id,
167
Enrolment.active == True,
168
Offering.id == Enrolment.offering_id,
169
Subject.id == Offering.subject_id).config(distinct=True)
171
# TODO: Invitations should be listed too?
172
def get_groups(self, offering=None):
173
"""Get groups of which this user is a member.
175
@param offering: An optional offering to restrict the search to.
178
ProjectGroupMembership.user_id == self.id,
179
ProjectGroup.id == ProjectGroupMembership.project_group_id,
183
ProjectSet.offering_id == offering.id,
184
ProjectGroup.project_set_id == ProjectSet.id,
186
return Store.of(self).find(ProjectGroup, *preds)
190
return self.get_groups()
193
def active_enrolments(self):
194
'''A sanely ordered list of the user's active enrolments.'''
195
return self._get_enrolments(True)
198
def enrolments(self):
199
'''A sanely ordered list of all of the user's enrolments.'''
200
return self._get_enrolments(False)
202
def get_projects(self, offering=None, active_only=True):
203
"""Find projects that the user can submit.
205
This will include projects for offerings in which the user is
206
enrolled, as long as the project is not in a project set which has
207
groups (ie. if maximum number of group members is 0).
209
@param active_only: Whether to only search active offerings.
210
@param offering: An optional offering to restrict the search to.
212
return Store.of(self).find(Project,
213
Project.project_set_id == ProjectSet.id,
214
ProjectSet.max_students_per_group == None,
215
ProjectSet.offering_id == Offering.id,
216
(offering is None) or (Offering.id == offering.id),
217
Semester.id == Offering.semester_id,
218
(not active_only) or (Semester.state == u'current'),
219
Enrolment.offering_id == Offering.id,
220
Enrolment.user_id == self.id,
221
Enrolment.active == True)
224
def hash_password(password):
225
"""Hash a password with MD5."""
226
return hashlib.md5(password).hexdigest()
229
def get_by_login(cls, store, login):
230
"""Find a user in a store by login name."""
231
return store.find(cls, cls.login == unicode(login)).one()
233
def get_svn_url(self, config, req):
234
"""Get the subversion repository URL for this user or group."""
235
login = req.user.login
236
url = urlparse.urlsplit(config['urls']['svn_addr'])
237
url = urlparse.urlunsplit(url[:1] + (login+'@'+url[1],) + url[2:])
238
path = 'users/%s' % self.login
239
return urlparse.urljoin(url, path)
241
def get_permissions(self, user, config):
242
"""Determine privileges held by a user over this object.
244
If the user requesting privileges is this user or an admin,
245
they may do everything. Otherwise they may do nothing.
247
if user and user.admin or user is self:
248
return set(['view_public', 'view', 'edit', 'submit_project'])
250
return set(['view_public'])
252
# SUBJECTS AND ENROLMENTS #
254
class Subject(Storm):
255
"""A subject (or course) which is run in some semesters."""
257
__storm_table__ = "subject"
259
id = Int(primary=True, name="subjectid")
260
code = Unicode(name="subj_code")
261
name = Unicode(name="subj_name")
262
short_name = Unicode(name="subj_short_name")
264
offerings = ReferenceSet(id, 'Offering.subject_id')
266
__init__ = _kwarg_init
269
return "<%s '%s'>" % (type(self).__name__, self.short_name)
271
def get_permissions(self, user, config):
272
"""Determine privileges held by a user over this object.
274
If the user requesting privileges is an admin, they may edit.
275
Otherwise they may only read.
284
def active_offerings(self):
285
"""Find active offerings for this subject.
287
Return a sequence of currently active offerings for this subject
288
(offerings whose semester.state is "current"). There should be 0 or 1
289
elements in this sequence, but it's possible there are more.
291
return self.offerings.find(Offering.semester_id == Semester.id,
292
Semester.state == u'current')
294
def offering_for_semester(self, year, semester):
295
"""Get the offering for the given year/semester, or None.
297
@param year: A string representation of the year.
298
@param semester: A string representation of the semester.
300
return self.offerings.find(Offering.semester_id == Semester.id,
301
Semester.year == unicode(year),
302
Semester.semester == unicode(semester)).one()
304
class Semester(Storm):
305
"""A semester in which subjects can be run."""
307
__storm_table__ = "semester"
309
id = Int(primary=True, name="semesterid")
314
offerings = ReferenceSet(id, 'Offering.semester_id')
315
enrolments = ReferenceSet(id,
316
'Offering.semester_id',
318
'Enrolment.offering_id')
320
__init__ = _kwarg_init
323
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
325
class Offering(Storm):
326
"""An offering of a subject in a particular semester."""
328
__storm_table__ = "offering"
330
id = Int(primary=True, name="offeringid")
331
subject_id = Int(name="subject")
332
subject = Reference(subject_id, Subject.id)
333
semester_id = Int(name="semesterid")
334
semester = Reference(semester_id, Semester.id)
335
description = Unicode()
337
show_worksheet_marks = Bool()
338
worksheet_cutoff = DateTime()
339
groups_student_permissions = Unicode()
341
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
342
members = ReferenceSet(id,
343
'Enrolment.offering_id',
346
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
347
projects = ReferenceSet(id,
348
'ProjectSet.offering_id',
350
'Project.project_set_id')
352
worksheets = ReferenceSet(id,
353
'Worksheet.offering_id',
357
__init__ = _kwarg_init
360
return "<%s %r in %r>" % (type(self).__name__, self.subject,
363
def enrol(self, user, role=u'student'):
364
"""Enrol a user in this offering.
366
Enrolments handle both the staff and student cases. The role controls
367
the privileges granted by this enrolment.
369
enrolment = Store.of(self).find(Enrolment,
370
Enrolment.user_id == user.id,
371
Enrolment.offering_id == self.id).one()
373
if enrolment is None:
374
enrolment = Enrolment(user=user, offering=self)
375
self.enrolments.add(enrolment)
377
enrolment.active = True
378
enrolment.role = role
380
def unenrol(self, user):
381
'''Unenrol a user from this offering.'''
382
enrolment = Store.of(self).find(Enrolment,
383
Enrolment.user_id == user.id,
384
Enrolment.offering_id == self.id).one()
385
Store.of(enrolment).remove(enrolment)
387
def get_permissions(self, user, config):
390
enrolment = self.get_enrolment(user)
391
if enrolment or user.admin:
393
if enrolment and enrolment.role == u'tutor':
394
perms.add('view_project_submissions')
395
# Site-specific policy on the role of tutors
396
if config['policy']['tutors_can_enrol_students']:
398
perms.add('enrol_student')
399
if config['policy']['tutors_can_edit_worksheets']:
400
perms.add('edit_worksheets')
401
if config['policy']['tutors_can_admin_groups']:
402
perms.add('admin_groups')
403
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
404
perms.add('view_project_submissions')
405
perms.add('admin_groups')
406
perms.add('edit_worksheets')
407
perms.add('view_worksheet_marks')
408
perms.add('edit') # Can edit projects & details
409
perms.add('enrol') # Can see enrolment screen at all
410
perms.add('enrol_student') # Can enrol students
411
perms.add('enrol_tutor') # Can enrol tutors
413
perms.add('enrol_lecturer') # Can enrol lecturers
416
def get_enrolment(self, user):
417
"""Find the user's enrolment in this offering."""
419
enrolment = self.enrolments.find(user=user).one()
425
def get_members_by_role(self, role):
426
return Store.of(self).find(User,
427
Enrolment.user_id == User.id,
428
Enrolment.offering_id == self.id,
429
Enrolment.role == role
430
).order_by(User.login)
434
return self.get_members_by_role(u'student')
436
def get_open_projects_for_user(self, user):
437
"""Find all projects currently open to submissions by a user."""
438
# XXX: Respect extensions.
439
return self.projects.find(Project.deadline > datetime.datetime.now())
441
def has_worksheet_cutoff_passed(self, user):
442
"""Check whether the worksheet cutoff has passed.
443
A user is required, in case we support extensions.
445
if self.worksheet_cutoff is None:
448
return self.worksheet_cutoff < datetime.datetime.now()
450
def clone_worksheets(self, source):
451
"""Clone all worksheets from the specified source to this offering."""
452
import ivle.worksheet.utils
453
for worksheet in source.worksheets:
455
newws.seq_no = worksheet.seq_no
456
newws.identifier = worksheet.identifier
457
newws.name = worksheet.name
458
newws.assessable = worksheet.assessable
459
newws.published = worksheet.published
460
newws.data = worksheet.data
461
newws.format = worksheet.format
462
newws.offering = self
463
Store.of(self).add(newws)
464
ivle.worksheet.utils.update_exerciselist(newws)
467
class Enrolment(Storm):
468
"""An enrolment of a user in an offering.
470
This represents the roles of both staff and students.
473
__storm_table__ = "enrolment"
474
__storm_primary__ = "user_id", "offering_id"
476
user_id = Int(name="loginid")
477
user = Reference(user_id, User.id)
478
offering_id = Int(name="offeringid")
479
offering = Reference(offering_id, Offering.id)
486
return Store.of(self).find(ProjectGroup,
487
ProjectSet.offering_id == self.offering.id,
488
ProjectGroup.project_set_id == ProjectSet.id,
489
ProjectGroupMembership.project_group_id == ProjectGroup.id,
490
ProjectGroupMembership.user_id == self.user.id)
492
__init__ = _kwarg_init
495
return "<%s %r in %r>" % (type(self).__name__, self.user,
498
def get_permissions(self, user, config):
499
# A user can edit any enrolment that they could have created.
501
if ('enrol_' + str(self.role)) in self.offering.get_permissions(
507
"""Delete this enrolment."""
508
Store.of(self).remove(self)
513
class ProjectSet(Storm):
514
"""A set of projects that share common groups.
516
Each student project group is attached to a project set. The group is
517
valid for all projects in the group's set.
520
__storm_table__ = "project_set"
522
id = Int(name="projectsetid", primary=True)
523
offering_id = Int(name="offeringid")
524
offering = Reference(offering_id, Offering.id)
525
max_students_per_group = Int()
527
projects = ReferenceSet(id, 'Project.project_set_id')
528
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
530
__init__ = _kwarg_init
533
return "<%s %d in %r>" % (type(self).__name__, self.id,
536
def get_permissions(self, user, config):
537
return self.offering.get_permissions(user, config)
539
def get_groups_for_user(self, user):
540
"""List all groups in this offering of which the user is a member."""
542
return Store.of(self).find(
544
ProjectGroupMembership.user_id == user.id,
545
ProjectGroupMembership.project_group_id == ProjectGroup.id,
546
ProjectGroup.project_set_id == self.id)
548
def get_submission_principal(self, user):
549
"""Get the principal on behalf of which the user can submit.
551
If this is a solo project set, the given user is returned. If
552
the user is a member of exactly one group, all the group is
553
returned. Otherwise, None is returned.
556
groups = self.get_groups_for_user(user)
557
if groups.count() == 1:
566
return self.max_students_per_group is not None
570
"""Get the entities (groups or users) assigned to submit this project.
572
This will be a Storm ResultSet.
574
#If its a solo project, return everyone in offering
576
return self.project_groups
578
return self.offering.students
580
class DeadlinePassed(Exception):
581
"""An exception indicating that a project cannot be submitted because the
582
deadline has passed."""
586
return "The project deadline has passed"
588
class Project(Storm):
589
"""A student project for which submissions can be made."""
591
__storm_table__ = "project"
593
id = Int(name="projectid", primary=True)
595
short_name = Unicode()
598
project_set_id = Int(name="projectsetid")
599
project_set = Reference(project_set_id, ProjectSet.id)
600
deadline = DateTime()
602
assesseds = ReferenceSet(id, 'Assessed.project_id')
603
submissions = ReferenceSet(id,
604
'Assessed.project_id',
606
'ProjectSubmission.assessed_id')
608
__init__ = _kwarg_init
611
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
612
self.project_set.offering)
614
def can_submit(self, principal, user):
615
return (self in principal.get_projects() and
616
not self.has_deadline_passed(user))
618
def submit(self, principal, path, revision, who):
619
"""Submit a Subversion path and revision to a project.
621
@param principal: The owner of the Subversion repository, and the
622
entity on behalf of whom the submission is being made
623
@param path: A path within that repository to submit.
624
@param revision: The revision of that path to submit.
625
@param who: The user who is actually making the submission.
628
if not self.can_submit(principal, who):
629
raise DeadlinePassed()
631
a = Assessed.get(Store.of(self), principal, self)
632
ps = ProjectSubmission()
633
# Raise SubmissionError if the path is illegal
634
ps.path = ProjectSubmission.test_and_normalise_path(path)
635
ps.revision = revision
636
ps.date_submitted = datetime.datetime.now()
642
def get_permissions(self, user, config):
643
return self.project_set.offering.get_permissions(user, config)
646
def latest_submissions(self):
647
"""Return the latest submission for each Assessed."""
648
return Store.of(self).find(ProjectSubmission,
649
Assessed.project_id == self.id,
650
ProjectSubmission.assessed_id == Assessed.id,
651
ProjectSubmission.date_submitted == Select(
652
Max(ProjectSubmission.date_submitted),
653
ProjectSubmission.assessed_id == Assessed.id,
654
tables=ProjectSubmission
658
def has_deadline_passed(self, user):
659
"""Check whether the deadline has passed."""
660
# XXX: Need to respect extensions.
661
return self.deadline < datetime.datetime.now()
663
def get_submissions_for_principal(self, principal):
664
"""Fetch a ResultSet of all submissions by a particular principal."""
665
assessed = Assessed.get(Store.of(self), principal, self)
668
return assessed.submissions
671
def can_delete(self):
672
"""Can only delete if there are no submissions."""
673
return self.submissions.count() == 0
676
"""Delete the project. Fails if can_delete is False."""
677
if not self.can_delete:
678
raise IntegrityError()
679
for assessed in self.assesseds:
681
Store.of(self).remove(self)
683
class ProjectGroup(Storm):
684
"""A group of students working together on a project."""
686
__storm_table__ = "project_group"
688
id = Int(name="groupid", primary=True)
689
name = Unicode(name="groupnm")
690
project_set_id = Int(name="projectsetid")
691
project_set = Reference(project_set_id, ProjectSet.id)
693
created_by_id = Int(name="createdby")
694
created_by = Reference(created_by_id, User.id)
697
members = ReferenceSet(id,
698
"ProjectGroupMembership.project_group_id",
699
"ProjectGroupMembership.user_id",
702
__init__ = _kwarg_init
705
return "<%s %s in %r>" % (type(self).__name__, self.name,
706
self.project_set.offering)
709
def display_name(self):
710
"""Returns the "nice name" of the user or group."""
714
def short_name(self):
715
"""Returns the database "identifier" name of the user or group."""
718
def get_projects(self, offering=None, active_only=True):
719
'''Find projects that the group can submit.
721
This will include projects in the project set which owns this group,
722
unless the project set disallows groups (in which case none will be
725
@param active_only: Whether to only search active offerings.
726
@param offering: An optional offering to restrict the search to.
728
return Store.of(self).find(Project,
729
Project.project_set_id == ProjectSet.id,
730
ProjectSet.id == self.project_set.id,
731
ProjectSet.max_students_per_group != None,
732
ProjectSet.offering_id == Offering.id,
733
(offering is None) or (Offering.id == offering.id),
734
Semester.id == Offering.semester_id,
735
(not active_only) or (Semester.state == u'current'))
737
def get_svn_url(self, config, req):
738
"""Get the subversion repository URL for this user or group."""
739
login = req.user.login
740
url = urlparse.urlsplit(config['urls']['svn_addr'])
741
url = urlparse.urlunsplit(url[:1] + (login+'@'+url[1],) + url[2:])
742
path = 'groups/%s_%s_%s_%s' % (
743
self.project_set.offering.subject.short_name,
744
self.project_set.offering.semester.year,
745
self.project_set.offering.semester.semester,
748
return urlparse.urljoin(url, path)
750
def get_permissions(self, user, config):
751
if user.admin or user in self.members:
752
return set(['submit_project'])
756
class ProjectGroupMembership(Storm):
757
"""A student's membership in a project group."""
759
__storm_table__ = "group_member"
760
__storm_primary__ = "user_id", "project_group_id"
762
user_id = Int(name="loginid")
763
user = Reference(user_id, User.id)
764
project_group_id = Int(name="groupid")
765
project_group = Reference(project_group_id, ProjectGroup.id)
767
__init__ = _kwarg_init
770
return "<%s %r in %r>" % (type(self).__name__, self.user,
773
class Assessed(Storm):
774
"""A composite of a user or group combined with a project.
776
Each project submission and extension refers to an Assessed. It is the
777
sole specifier of the repository and project.
780
__storm_table__ = "assessed"
782
id = Int(name="assessedid", primary=True)
783
user_id = Int(name="loginid")
784
user = Reference(user_id, User.id)
785
project_group_id = Int(name="groupid")
786
project_group = Reference(project_group_id, ProjectGroup.id)
788
project_id = Int(name="projectid")
789
project = Reference(project_id, Project.id)
791
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
792
submissions = ReferenceSet(
793
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
796
return "<%s %r in %r>" % (type(self).__name__,
797
self.user or self.project_group, self.project)
801
"""True if the Assessed is a group, False if it is a user."""
802
return self.project_group is not None
806
return self.project_group or self.user
809
def checkout_location(self):
810
"""Returns the location of the Subversion workspace for this piece of
811
assessment, relative to each group member's home directory."""
812
subjectname = self.project.project_set.offering.subject.short_name
814
checkout_dir_name = self.principal.short_name
816
checkout_dir_name = "mywork"
817
return subjectname + "/" + checkout_dir_name
820
def get(cls, store, principal, project):
821
"""Find or create an Assessed for the given user or group and project.
823
@param principal: The user or group.
824
@param project: The project.
827
if t not in (User, ProjectGroup):
828
raise AssertionError('principal must be User or ProjectGroup')
831
(t is User) or (cls.project_group_id == principal.id),
832
(t is ProjectGroup) or (cls.user_id == principal.id),
833
cls.project_id == project.id).one()
840
a.project_group = principal
847
"""Delete the assessed. Fails if there are any submissions. Deletes
849
if self.submissions.count() > 0:
850
raise IntegrityError()
851
for extension in self.extensions:
853
Store.of(self).remove(self)
855
class ProjectExtension(Storm):
856
"""An extension granted to a user or group on a particular project.
858
The user or group and project are specified by the Assessed.
861
__storm_table__ = "project_extension"
863
id = Int(name="extensionid", primary=True)
864
assessed_id = Int(name="assessedid")
865
assessed = Reference(assessed_id, Assessed.id)
866
deadline = DateTime()
867
approver_id = Int(name="approver")
868
approver = Reference(approver_id, User.id)
872
"""Delete the extension."""
873
Store.of(self).remove(self)
875
class SubmissionError(Exception):
876
"""Denotes a validation error during submission."""
879
class ProjectSubmission(Storm):
880
"""A submission from a user or group repository to a particular project.
882
The content of a submission is a single path and revision inside a
883
repository. The repository is that owned by the submission's user and
884
group, while the path and revision are explicit.
886
The user or group and project are specified by the Assessed.
889
__storm_table__ = "project_submission"
891
id = Int(name="submissionid", primary=True)
892
assessed_id = Int(name="assessedid")
893
assessed = Reference(assessed_id, Assessed.id)
896
submitter_id = Int(name="submitter")
897
submitter = Reference(submitter_id, User.id)
898
date_submitted = DateTime()
900
def get_verify_url(self, user):
901
"""Get the URL for verifying this submission, within the account of
903
# If this is a solo project, then self.path will be prefixed with the
904
# subject name. Remove the first path segment.
905
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
906
if not self.assessed.is_group:
907
if '/' in submitpath:
908
submitpath = submitpath.split('/', 1)[1]
911
return "/files/%s/%s/%s?r=%d" % (user.login,
912
self.assessed.checkout_location, submitpath, self.revision)
915
def test_and_normalise_path(path):
916
"""Test that path is valid, and normalise it. This prevents possible
917
injections using malicious paths.
918
Returns the updated path, if successful.
919
Raises SubmissionError if invalid.
921
# Ensure the path is absolute to prevent being tacked onto working
923
# Prevent '\n' because it will break all sorts of things.
924
# Prevent '[' and ']' because they can be used to inject into the
926
# Normalise to avoid resulting in ".." path segments.
927
if not os.path.isabs(path):
928
raise SubmissionError("Path is not absolute")
929
if any(c in path for c in "\n[]"):
930
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
931
return os.path.normpath(path)
933
# WORKSHEETS AND EXERCISES #
935
class Exercise(Storm):
936
"""An exercise for students to complete in a worksheet.
938
An exercise may be present in any number of worksheets.
941
__storm_table__ = "exercise"
942
id = Unicode(primary=True, name="identifier")
944
description = Unicode()
945
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
951
worksheet_exercises = ReferenceSet(id,
952
'WorksheetExercise.exercise_id')
954
worksheets = ReferenceSet(id,
955
'WorksheetExercise.exercise_id',
956
'WorksheetExercise.worksheet_id',
960
test_suites = ReferenceSet(id,
961
'TestSuite.exercise_id',
964
__init__ = _kwarg_init
967
return "<%s %s>" % (type(self).__name__, self.name)
969
def get_permissions(self, user, config):
970
return self.global_permissions(user, config)
973
def global_permissions(user, config):
974
"""Gets the set of permissions this user has over *all* exercises.
975
This is used to determine who may view the exercises list, and create
983
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
986
elif (config['policy']['tutors_can_edit_worksheets']
987
and u'tutor' in set((e.role for e in user.active_enrolments))):
988
# Site-specific policy on the role of tutors
994
def _cache_description_xhtml(self, invalidate=False):
995
# Don't regenerate an existing cache unless forced.
996
if self._description_xhtml_cache is not None and not invalidate:
1000
self._description_xhtml_cache = rst(self.description)
1002
self._description_xhtml_cache = None
1005
def description_xhtml(self):
1006
"""The XHTML exercise description, converted from reStructuredText."""
1007
self._cache_description_xhtml()
1008
return self._description_xhtml_cache
1010
def set_description(self, description):
1011
self.description = description
1012
self._cache_description_xhtml(invalidate=True)
1015
"""Deletes the exercise, providing it has no associated worksheets."""
1016
if (self.worksheet_exercises.count() > 0):
1017
raise IntegrityError()
1018
for suite in self.test_suites:
1020
Store.of(self).remove(self)
1022
class Worksheet(Storm):
1023
"""A worksheet with exercises for students to complete.
1025
Worksheets are owned by offerings.
1028
__storm_table__ = "worksheet"
1030
id = Int(primary=True, name="worksheetid")
1031
offering_id = Int(name="offeringid")
1032
identifier = Unicode()
1037
_data_xhtml_cache = Unicode(name='data_xhtml_cache')
1041
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
1042
offering = Reference(offering_id, 'Offering.id')
1044
all_worksheet_exercises = ReferenceSet(id,
1045
'WorksheetExercise.worksheet_id')
1047
# Use worksheet_exercises to get access to the *active* WorksheetExercise
1048
# objects binding worksheets to exercises. This is required to access the
1052
def worksheet_exercises(self):
1053
return self.all_worksheet_exercises.find(active=True)
1055
__init__ = _kwarg_init
1058
return "<%s %s>" % (type(self).__name__, self.name)
1060
def remove_all_exercises(self):
1061
"""Remove all exercises from this worksheet.
1063
This does not delete the exercises themselves. It just removes them
1066
store = Store.of(self)
1067
for ws_ex in self.all_worksheet_exercises:
1068
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1069
raise IntegrityError()
1070
store.find(WorksheetExercise,
1071
WorksheetExercise.worksheet == self).remove()
1073
def get_permissions(self, user, config):
1074
offering_perms = self.offering.get_permissions(user, config)
1078
# Anybody who can view an offering can view a published
1080
if 'view' in offering_perms and self.published:
1083
# Any worksheet editors can both view and edit.
1084
if 'edit_worksheets' in offering_perms:
1090
def _cache_data_xhtml(self, invalidate=False):
1091
# Don't regenerate an existing cache unless forced.
1092
if self._data_xhtml_cache is not None and not invalidate:
1095
if self.format == u'rst':
1096
self._data_xhtml_cache = rst(self.data)
1098
self._data_xhtml_cache = None
1101
def data_xhtml(self):
1102
"""The XHTML of this worksheet, converted from rST if required."""
1103
# Update the rST -> XHTML cache, if required.
1104
self._cache_data_xhtml()
1106
if self.format == u'rst':
1107
return self._data_xhtml_cache
1111
def set_data(self, data):
1113
self._cache_data_xhtml(invalidate=True)
1116
"""Deletes the worksheet, provided it has no attempts on any exercises.
1118
Returns True if delete succeeded, or False if this worksheet has
1119
attempts attached."""
1120
for ws_ex in self.all_worksheet_exercises:
1121
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1122
raise IntegrityError()
1124
self.remove_all_exercises()
1125
Store.of(self).remove(self)
1127
class WorksheetExercise(Storm):
1128
"""A link between a worksheet and one of its exercises.
1130
These may be marked optional, in which case the exercise does not count
1131
for marking purposes. The sequence number is used to order the worksheet
1135
__storm_table__ = "worksheet_exercise"
1137
id = Int(primary=True, name="ws_ex_id")
1139
worksheet_id = Int(name="worksheetid")
1140
worksheet = Reference(worksheet_id, Worksheet.id)
1141
exercise_id = Unicode(name="exerciseid")
1142
exercise = Reference(exercise_id, Exercise.id)
1147
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
1148
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
1150
__init__ = _kwarg_init
1153
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1154
self.worksheet.identifier)
1156
def get_permissions(self, user, config):
1157
return self.worksheet.get_permissions(user, config)
1160
class ExerciseSave(Storm):
1161
"""A potential exercise solution submitted by a user for storage.
1163
This is not an actual tested attempt at an exercise, it's just a save of
1164
the editing session.
1167
__storm_table__ = "exercise_save"
1168
__storm_primary__ = "ws_ex_id", "user_id"
1170
ws_ex_id = Int(name="ws_ex_id")
1171
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
1173
user_id = Int(name="loginid")
1174
user = Reference(user_id, User.id)
1178
__init__ = _kwarg_init
1181
return "<%s %s by %s at %s>" % (type(self).__name__,
1182
self.worksheet_exercise.exercise.name, self.user.login,
1183
self.date.strftime("%c"))
1185
class ExerciseAttempt(ExerciseSave):
1186
"""An attempt at solving an exercise.
1188
This is a special case of ExerciseSave, used when the user submits a
1189
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1192
In addition, it contains information about the result of the submission:
1194
- complete - True if this submission was successful, rendering this
1195
exercise complete for this user in this worksheet.
1196
- active - True if this submission is "active" (usually true).
1197
Submissions may be de-activated by privileged users for
1198
special reasons, and then they won't count (either as a
1199
penalty or success), but will still be stored.
1202
__storm_table__ = "exercise_attempt"
1203
__storm_primary__ = "ws_ex_id", "user_id", "date"
1205
# The "text" field is the same but has a different name in the DB table
1207
text = Unicode(name="attempt")
1211
def get_permissions(self, user, config):
1212
return set(['view']) if user is self.user else set()
1214
class TestSuite(Storm):
1215
"""A container to group an exercise's test cases.
1217
The test suite contains some information on how to test. The function to
1218
test, variables to set and stdin data are stored here.
1221
__storm_table__ = "test_suite"
1222
__storm_primary__ = "exercise_id", "suiteid"
1225
exercise_id = Unicode(name="exerciseid")
1226
description = Unicode()
1228
function = Unicode()
1230
exercise = Reference(exercise_id, Exercise.id)
1231
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1232
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1235
"""Delete this suite, without asking questions."""
1236
for variable in self.variables:
1238
for test_case in self.test_cases:
1240
Store.of(self).remove(self)
1242
class TestCase(Storm):
1243
"""A container for actual tests (see TestCasePart), inside a test suite.
1245
It is the lowest level shown to students on their pass/fail status."""
1247
__storm_table__ = "test_case"
1248
__storm_primary__ = "testid", "suiteid"
1252
suite = Reference(suiteid, "TestSuite.suiteid")
1255
test_default = Unicode() # Currently unused - only used for file matching.
1258
parts = ReferenceSet(testid, "TestCasePart.testid")
1260
__init__ = _kwarg_init
1263
for part in self.parts:
1265
Store.of(self).remove(self)
1267
class TestSuiteVar(Storm):
1268
"""A variable used by an exercise test suite.
1270
This may represent a function argument or a normal variable.
1273
__storm_table__ = "suite_variable"
1274
__storm_primary__ = "varid"
1278
var_name = Unicode()
1279
var_value = Unicode()
1280
var_type = Unicode()
1283
suite = Reference(suiteid, "TestSuite.suiteid")
1285
__init__ = _kwarg_init
1288
Store.of(self).remove(self)
1290
class TestCasePart(Storm):
1291
"""An actual piece of code to test an exercise solution."""
1293
__storm_table__ = "test_case_part"
1294
__storm_primary__ = "partid"
1299
part_type = Unicode()
1300
test_type = Unicode()
1302
filename = Unicode()
1304
test = Reference(testid, "TestCase.testid")
1306
__init__ = _kwarg_init
1309
Store.of(self).remove(self)
added
removed
ivle/database.py
