18
18
# Author: Matt Giuca, Will Grant
20
"""Database utilities and content classes.
21
Database Classes and Utilities for Storm ORM
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.
32
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
33
31
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
36
__all__ = ['get_store',
41
38
'Subject', 'Semester', 'Offering', 'Enrolment',
42
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
43
'Assessed', 'ProjectSubmission', 'ProjectExtension',
44
40
'Exercise', 'Worksheet', 'WorksheetExercise',
45
41
'ExerciseSave', 'ExerciseAttempt',
46
'TestCase', 'TestSuite', 'TestSuiteVar'
42
'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
49
45
def _kwarg_init(self, **kwargs):
53
49
% (self.__class__.__name__, k))
54
50
setattr(self, k, v)
56
def get_conn_string(config):
57
"""Create a Storm connection string to the IVLE database
59
@param config: The IVLE configuration.
52
def get_conn_string():
54
Returns the Storm connection string, generated from the conf file.
63
if config['database']['username']:
64
clusterstr += config['database']['username']
65
if config['database']['password']:
66
clusterstr += ':' + config['database']['password']
59
clusterstr += ivle.conf.db_user
60
if ivle.conf.db_password:
61
clusterstr += ':' + ivle.conf.db_password
69
host = config['database']['host'] or 'localhost'
70
port = config['database']['port'] or 5432
64
host = ivle.conf.db_host or 'localhost'
65
port = ivle.conf.db_port or 5432
72
67
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)))
69
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
73
Open a database connection and transaction. Return a storm.store.Store
74
instance connected to the configured IVLE database.
76
return Store(create_database(get_conn_string()))
86
"""An IVLE user account."""
82
Represents an IVLE user.
87
84
__storm_table__ = "login"
89
86
id = Int(primary=True, name="loginid")
91
88
passhash = Unicode()
96
93
pass_exp = DateTime()
200
199
'''A sanely ordered list of all of the user's enrolments.'''
201
200
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
203
def hash_password(password):
226
"""Hash a password with MD5."""
227
return hashlib.md5(password).hexdigest()
204
return md5.md5(password).hexdigest()
230
207
def get_by_login(cls, store, login):
231
"""Find a user in a store by login name."""
209
Get the User from the db associated with a given store and
232
212
return store.find(cls, cls.login == unicode(login)).one()
234
def get_svn_url(self, config):
235
"""Get the subversion repository URL for this user or group."""
236
url = config['urls']['svn_addr']
237
path = 'users/%s' % self.login
238
return urlparse.urljoin(url, path)
240
def get_permissions(self, user, config):
241
"""Determine privileges held by a user over this object.
243
If the user requesting privileges is this user or an admin,
244
they may do everything. Otherwise they may do nothing.
246
if user and user.admin or user is self:
247
return set(['view_public', 'view', 'edit', 'submit_project'])
214
def get_permissions(self, user):
215
if user and user.rolenm == 'admin' or user is self:
216
return set(['view', 'edit'])
249
return set(['view_public'])
251
220
# SUBJECTS AND ENROLMENTS #
253
222
class Subject(Storm):
254
"""A subject (or course) which is run in some semesters."""
256
223
__storm_table__ = "subject"
258
225
id = Int(primary=True, name="subjectid")
259
226
code = Unicode(name="subj_code")
260
227
name = Unicode(name="subj_name")
261
228
short_name = Unicode(name="subj_short_name")
263
231
offerings = ReferenceSet(id, 'Offering.subject_id')
267
235
def __repr__(self):
268
236
return "<%s '%s'>" % (type(self).__name__, self.short_name)
270
def get_permissions(self, user, config):
271
"""Determine privileges held by a user over this object.
273
If the user requesting privileges is an admin, they may edit.
274
Otherwise they may only read.
238
def get_permissions(self, user):
277
240
if user is not None:
278
241
perms.add('view')
242
if user.rolenm == 'admin':
280
243
perms.add('edit')
283
def active_offerings(self):
284
"""Find active offerings for this subject.
286
Return a sequence of currently active offerings for this subject
287
(offerings whose semester.state is "current"). There should be 0 or 1
288
elements in this sequence, but it's possible there are more.
290
return self.offerings.find(Offering.semester_id == Semester.id,
291
Semester.state == u'current')
293
def offering_for_semester(self, year, semester):
294
"""Get the offering for the given year/semester, or None.
296
@param year: A string representation of the year.
297
@param semester: A string representation of the semester.
299
return self.offerings.find(Offering.semester_id == Semester.id,
300
Semester.year == unicode(year),
301
Semester.url_name == unicode(semester)).one()
303
246
class Semester(Storm):
304
"""A semester in which subjects can be run."""
306
247
__storm_table__ = "semester"
308
249
id = Int(primary=True, name="semesterid")
312
display_name = Unicode()
315
254
offerings = ReferenceSet(id, 'Offering.semester_id')
316
enrolments = ReferenceSet(id,
317
'Offering.semester_id',
319
'Enrolment.offering_id')
321
256
__init__ = _kwarg_init
323
258
def __repr__(self):
324
return "<%s %s/%s>" % (type(self).__name__, self.year, self.code)
259
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
326
261
class Offering(Storm):
327
"""An offering of a subject in a particular semester."""
329
262
__storm_table__ = "offering"
331
264
id = Int(primary=True, name="offeringid")
361
286
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):
289
def enrol(self, user):
290
'''Enrol a user in this offering.'''
291
# We'll get a horrible database constraint violation error if we try
292
# to add a second enrolment.
293
if Store.of(self).find(Enrolment,
294
Enrolment.user_id == user.id,
295
Enrolment.offering_id == self.id).count() == 1:
296
raise AlreadyEnrolledError()
298
e = Enrolment(user=user, offering=self, active=True)
299
self.enrolments.add(e)
301
def get_permissions(self, user):
390
303
if user is not None:
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
305
if user.rolenm in ('admin', 'lecturer'):
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
309
class Enrolment(Storm):
469
"""An enrolment of a user in an offering.
471
This represents the roles of both staff and students.
474
310
__storm_table__ = "enrolment"
475
311
__storm_primary__ = "user_id", "offering_id"
534
353
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
356
class Project(Storm):
590
"""A student project for which submissions can be made."""
592
357
__storm_table__ = "project"
594
359
id = Int(name="projectid", primary=True)
596
short_name = Unicode()
597
360
synopsis = Unicode()
599
362
project_set_id = Int(name="projectsetid")
600
363
project_set = Reference(project_set_id, ProjectSet.id)
601
364
deadline = DateTime()
603
assesseds = ReferenceSet(id, 'Assessed.project_id')
604
submissions = ReferenceSet(id,
605
'Assessed.project_id',
607
'ProjectSubmission.assessed_id')
609
366
__init__ = _kwarg_init
611
368
def __repr__(self):
612
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
369
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
613
370
self.project_set.offering)
615
def can_submit(self, principal, user, late=False):
617
@param late: If True, does not take the deadline into account.
619
return (self in principal.get_projects() and
620
(late or not self.has_deadline_passed(user)))
622
def submit(self, principal, path, revision, who, late=False):
623
"""Submit a Subversion path and revision to a project.
625
@param principal: The owner of the Subversion repository, and the
626
entity on behalf of whom the submission is being made
627
@param path: A path within that repository to submit.
628
@param revision: The revision of that path to submit.
629
@param who: The user who is actually making the submission.
630
@param late: If True, will not raise a DeadlinePassed exception even
631
after the deadline. (Default False.)
634
if not self.can_submit(principal, who, late=late):
635
raise DeadlinePassed()
637
a = Assessed.get(Store.of(self), principal, self)
638
ps = ProjectSubmission()
639
# Raise SubmissionError if the path is illegal
640
ps.path = ProjectSubmission.test_and_normalise_path(path)
641
ps.revision = revision
642
ps.date_submitted = datetime.datetime.now()
648
def get_permissions(self, user, config):
649
return self.project_set.offering.get_permissions(user, config)
652
def latest_submissions(self):
653
"""Return the latest submission for each Assessed."""
654
return Store.of(self).find(ProjectSubmission,
655
Assessed.project_id == self.id,
656
ProjectSubmission.assessed_id == Assessed.id,
657
ProjectSubmission.date_submitted == Select(
658
Max(ProjectSubmission.date_submitted),
659
ProjectSubmission.assessed_id == Assessed.id,
660
tables=ProjectSubmission
664
def has_deadline_passed(self, user):
665
"""Check whether the deadline has passed."""
666
# XXX: Need to respect extensions.
667
return self.deadline < datetime.datetime.now()
669
def get_submissions_for_principal(self, principal):
670
"""Fetch a ResultSet of all submissions by a particular principal."""
671
assessed = Assessed.get(Store.of(self), principal, self)
674
return assessed.submissions
677
def can_delete(self):
678
"""Can only delete if there are no submissions."""
679
return self.submissions.count() == 0
682
"""Delete the project. Fails if can_delete is False."""
683
if not self.can_delete:
684
raise IntegrityError()
685
for assessed in self.assesseds:
687
Store.of(self).remove(self)
689
372
class ProjectGroup(Storm):
690
"""A group of students working together on a project."""
692
373
__storm_table__ = "project_group"
694
375
id = Int(name="groupid", primary=True)
711
392
return "<%s %s in %r>" % (type(self).__name__, self.name,
712
393
self.project_set.offering)
715
def display_name(self):
716
"""Returns the "nice name" of the user or group."""
720
def short_name(self):
721
"""Returns the database "identifier" name of the user or group."""
724
def get_projects(self, offering=None, active_only=True):
725
'''Find projects that the group can submit.
727
This will include projects in the project set which owns this group,
728
unless the project set disallows groups (in which case none will be
731
@param active_only: Whether to only search active offerings.
732
@param offering: An optional offering to restrict the search to.
734
return Store.of(self).find(Project,
735
Project.project_set_id == ProjectSet.id,
736
ProjectSet.id == self.project_set.id,
737
ProjectSet.max_students_per_group != None,
738
ProjectSet.offering_id == Offering.id,
739
(offering is None) or (Offering.id == offering.id),
740
Semester.id == Offering.semester_id,
741
(not active_only) or (Semester.state == u'current'))
743
def get_svn_url(self, config):
744
"""Get the subversion repository URL for this user or group."""
745
url = config['urls']['svn_addr']
746
path = 'groups/%s_%s_%s_%s' % (
747
self.project_set.offering.subject.short_name,
748
self.project_set.offering.semester.year,
749
self.project_set.offering.semester.url_name,
752
return urlparse.urljoin(url, path)
754
def get_permissions(self, user, config):
755
if user.admin or user in self.members:
756
return set(['submit_project'])
760
395
class ProjectGroupMembership(Storm):
761
"""A student's membership in a project group."""
763
396
__storm_table__ = "group_member"
764
397
__storm_primary__ = "user_id", "project_group_id"
774
407
return "<%s %r in %r>" % (type(self).__name__, self.user,
775
408
self.project_group)
777
class Assessed(Storm):
778
"""A composite of a user or group combined with a project.
780
Each project submission and extension refers to an Assessed. It is the
781
sole specifier of the repository and project.
784
__storm_table__ = "assessed"
786
id = Int(name="assessedid", primary=True)
787
user_id = Int(name="loginid")
788
user = Reference(user_id, User.id)
789
project_group_id = Int(name="groupid")
790
project_group = Reference(project_group_id, ProjectGroup.id)
792
project_id = Int(name="projectid")
793
project = Reference(project_id, Project.id)
795
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
796
submissions = ReferenceSet(
797
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
800
return "<%s %r in %r>" % (type(self).__name__,
801
self.user or self.project_group, self.project)
805
"""True if the Assessed is a group, False if it is a user."""
806
return self.project_group is not None
810
return self.project_group or self.user
813
def checkout_location(self):
814
"""Returns the location of the Subversion workspace for this piece of
815
assessment, relative to each group member's home directory."""
816
subjectname = self.project.project_set.offering.subject.short_name
818
checkout_dir_name = self.principal.short_name
820
checkout_dir_name = "mywork"
821
return subjectname + "/" + checkout_dir_name
824
def get(cls, store, principal, project):
825
"""Find or create an Assessed for the given user or group and project.
827
@param principal: The user or group.
828
@param project: The project.
831
if t not in (User, ProjectGroup):
832
raise AssertionError('principal must be User or ProjectGroup')
835
(t is User) or (cls.project_group_id == principal.id),
836
(t is ProjectGroup) or (cls.user_id == principal.id),
837
cls.project_id == project.id).one()
844
a.project_group = principal
851
"""Delete the assessed. Fails if there are any submissions. Deletes
853
if self.submissions.count() > 0:
854
raise IntegrityError()
855
for extension in self.extensions:
857
Store.of(self).remove(self)
859
class ProjectExtension(Storm):
860
"""An extension granted to a user or group on a particular project.
862
The user or group and project are specified by the Assessed.
865
__storm_table__ = "project_extension"
867
id = Int(name="extensionid", primary=True)
868
assessed_id = Int(name="assessedid")
869
assessed = Reference(assessed_id, Assessed.id)
871
approver_id = Int(name="approver")
872
approver = Reference(approver_id, User.id)
876
"""Delete the extension."""
877
Store.of(self).remove(self)
879
class SubmissionError(Exception):
880
"""Denotes a validation error during submission."""
883
class ProjectSubmission(Storm):
884
"""A submission from a user or group repository to a particular project.
886
The content of a submission is a single path and revision inside a
887
repository. The repository is that owned by the submission's user and
888
group, while the path and revision are explicit.
890
The user or group and project are specified by the Assessed.
893
__storm_table__ = "project_submission"
895
id = Int(name="submissionid", primary=True)
896
assessed_id = Int(name="assessedid")
897
assessed = Reference(assessed_id, Assessed.id)
900
submitter_id = Int(name="submitter")
901
submitter = Reference(submitter_id, User.id)
902
date_submitted = DateTime()
904
def get_verify_url(self, user):
905
"""Get the URL for verifying this submission, within the account of
907
# If this is a solo project, then self.path will be prefixed with the
908
# subject name. Remove the first path segment.
909
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
910
if not self.assessed.is_group:
911
if '/' in submitpath:
912
submitpath = submitpath.split('/', 1)[1]
915
return "/files/%s/%s/%s?r=%d" % (user.login,
916
self.assessed.checkout_location, submitpath, self.revision)
918
def get_svn_url(self, config):
919
"""Get subversion URL for this submission"""
920
princ = self.assessed.principal
921
base = princ.get_svn_url(config)
922
if self.path.startswith(os.sep):
923
return os.path.join(base,
924
urllib.quote(self.path[1:].encode('utf-8')))
926
return os.path.join(base, urllib.quote(self.path.encode('utf-8')))
928
def get_svn_export_command(self, req):
929
"""Returns a Unix shell command to export a submission"""
930
svn_url = self.get_svn_url(req.config)
931
username = (req.user.login if req.user.login.isalnum() else
932
"'%s'"%req.user.login)
933
export_dir = self.assessed.principal.short_name
934
return "svn export --username %s -r%d '%s' %s"%(req.user.login,
935
self.revision, svn_url, export_dir)
938
def test_and_normalise_path(path):
939
"""Test that path is valid, and normalise it. This prevents possible
940
injections using malicious paths.
941
Returns the updated path, if successful.
942
Raises SubmissionError if invalid.
944
# Ensure the path is absolute to prevent being tacked onto working
946
# Prevent '\n' because it will break all sorts of things.
947
# Prevent '[' and ']' because they can be used to inject into the
949
# Normalise to avoid resulting in ".." path segments.
950
if not os.path.isabs(path):
951
raise SubmissionError("Path is not absolute")
952
if any(c in path for c in "\n[]"):
953
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
954
return os.path.normpath(path)
958
"""True if the project was submitted late."""
959
return self.days_late > 0
963
"""The number of days the project was submitted late (rounded up), or
965
# XXX: Need to respect extensions.
967
(self.date_submitted - self.assessed.project.deadline).days + 1)
969
410
# WORKSHEETS AND EXERCISES #
971
412
class Exercise(Storm):
972
"""An exercise for students to complete in a worksheet.
974
An exercise may be present in any number of worksheets.
977
413
__storm_table__ = "exercise"
978
414
id = Unicode(primary=True, name="identifier")
980
416
description = Unicode()
981
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
982
417
partial = Unicode()
983
418
solution = Unicode()
984
419
include = Unicode()
987
worksheet_exercises = ReferenceSet(id,
988
'WorksheetExercise.exercise_id')
990
422
worksheets = ReferenceSet(id,
991
423
'WorksheetExercise.exercise_id',
992
424
'WorksheetExercise.worksheet_id',
996
428
test_suites = ReferenceSet(id,
997
429
'TestSuite.exercise_id',
998
430
order_by='seq_no')
1002
434
def __repr__(self):
1003
435
return "<%s %s>" % (type(self).__name__, self.name)
1005
def get_permissions(self, user, config):
1006
return self.global_permissions(user, config)
1009
def global_permissions(user, config):
1010
"""Gets the set of permissions this user has over *all* exercises.
1011
This is used to determine who may view the exercises list, and create
437
def get_permissions(self, user):
1015
439
if user is not None:
1019
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
1022
elif (config['policy']['tutors_can_edit_worksheets']
1023
and u'tutor' in set((e.role for e in user.active_enrolments))):
1024
# Site-specific policy on the role of tutors
440
if user.rolenm in ('admin', 'lecturer'):
1030
def _cache_description_xhtml(self, invalidate=False):
1031
# Don't regenerate an existing cache unless forced.
1032
if self._description_xhtml_cache is not None and not invalidate:
1035
if self.description:
1036
self._description_xhtml_cache = rst(self.description)
1038
self._description_xhtml_cache = None
1041
def description_xhtml(self):
1042
"""The XHTML exercise description, converted from reStructuredText."""
1043
self._cache_description_xhtml()
1044
return self._description_xhtml_cache
1046
def set_description(self, description):
1047
self.description = description
1048
self._cache_description_xhtml(invalidate=True)
1051
"""Deletes the exercise, providing it has no associated worksheets."""
1052
if (self.worksheet_exercises.count() > 0):
1053
raise IntegrityError()
1054
for suite in self.test_suites:
1056
Store.of(self).remove(self)
1058
445
class Worksheet(Storm):
1059
"""A worksheet with exercises for students to complete.
1061
Worksheets are owned by offerings.
1064
446
__storm_table__ = "worksheet"
1066
448
id = Int(primary=True, name="worksheetid")
1068
450
identifier = Unicode()
1069
451
name = Unicode()
1070
452
assessable = Bool()
1072
453
data = Unicode()
1073
_data_xhtml_cache = Unicode(name='data_xhtml_cache')
1075
455
format = Unicode()
1077
457
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
1078
458
offering = Reference(offering_id, 'Offering.id')
1080
all_worksheet_exercises = ReferenceSet(id,
460
# Use worksheet_exercises to get access to the WorksheetExercise objects
461
# binding worksheets to exercises. This is required to access the
463
worksheet_exercises = ReferenceSet(id,
1081
464
'WorksheetExercise.worksheet_id')
1083
# Use worksheet_exercises to get access to the *active* WorksheetExercise
1084
# objects binding worksheets to exercises. This is required to access the
1088
def worksheet_exercises(self):
1089
return self.all_worksheet_exercises.find(active=True)
1091
466
__init__ = _kwarg_init
1093
468
def __repr__(self):
1094
469
return "<%s %s>" % (type(self).__name__, self.name)
1096
def remove_all_exercises(self):
1097
"""Remove all exercises from this worksheet.
471
# XXX Refactor this - make it an instance method of Subject rather than a
472
# class method of Worksheet. Can't do that now because Subject isn't
473
# linked referentially to the Worksheet.
475
def get_by_name(cls, store, subjectname, worksheetname):
477
Get the Worksheet from the db associated with a given store, subject
478
name and worksheet name.
480
return store.find(cls, cls.subject == unicode(subjectname),
481
cls.name == unicode(worksheetname)).one()
483
def remove_all_exercises(self, store):
485
Remove all exercises from this worksheet.
1099
486
This does not delete the exercises themselves. It just removes them
1100
487
from the worksheet.
1102
store = Store.of(self)
1103
for ws_ex in self.all_worksheet_exercises:
1104
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1105
raise IntegrityError()
1106
489
store.find(WorksheetExercise,
1107
490
WorksheetExercise.worksheet == self).remove()
1109
def get_permissions(self, user, config):
1110
offering_perms = self.offering.get_permissions(user, config)
1114
# Anybody who can view an offering can view a published
1116
if 'view' in offering_perms and self.published:
1119
# Any worksheet editors can both view and edit.
1120
if 'edit_worksheets' in offering_perms:
1126
def _cache_data_xhtml(self, invalidate=False):
1127
# Don't regenerate an existing cache unless forced.
1128
if self._data_xhtml_cache is not None and not invalidate:
1131
if self.format == u'rst':
1132
self._data_xhtml_cache = rst(self.data)
1134
self._data_xhtml_cache = None
1137
def data_xhtml(self):
1138
"""The XHTML of this worksheet, converted from rST if required."""
1139
# Update the rST -> XHTML cache, if required.
1140
self._cache_data_xhtml()
1142
if self.format == u'rst':
1143
return self._data_xhtml_cache
1147
def set_data(self, data):
1149
self._cache_data_xhtml(invalidate=True)
1152
"""Deletes the worksheet, provided it has no attempts on any exercises.
1154
Returns True if delete succeeded, or False if this worksheet has
1155
attempts attached."""
1156
for ws_ex in self.all_worksheet_exercises:
1157
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1158
raise IntegrityError()
1160
self.remove_all_exercises()
1161
Store.of(self).remove(self)
492
def get_permissions(self, user):
493
return self.offering.get_permissions(user)
1163
495
class WorksheetExercise(Storm):
1164
"""A link between a worksheet and one of its exercises.
1166
These may be marked optional, in which case the exercise does not count
1167
for marking purposes. The sequence number is used to order the worksheet
1171
496
__storm_table__ = "worksheet_exercise"
1173
498
id = Int(primary=True, name="ws_ex_id")
1175
500
worksheet_id = Int(name="worksheetid")
1216
539
def __repr__(self):
1217
540
return "<%s %s by %s at %s>" % (type(self).__name__,
1218
self.worksheet_exercise.exercise.name, self.user.login,
1219
self.date.strftime("%c"))
541
self.exercise.name, self.user.login, self.date.strftime("%c"))
1221
543
class ExerciseAttempt(ExerciseSave):
1222
"""An attempt at solving an exercise.
1224
This is a special case of ExerciseSave, used when the user submits a
1225
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1228
In addition, it contains information about the result of the submission:
1230
- complete - True if this submission was successful, rendering this
1231
exercise complete for this user in this worksheet.
1232
- active - True if this submission is "active" (usually true).
1233
Submissions may be de-activated by privileged users for
1234
special reasons, and then they won't count (either as a
1235
penalty or success), but will still be stored.
545
An ExerciseAttempt is a special case of an ExerciseSave. Like an
546
ExerciseSave, it constitutes exercise solution data that the user has
547
submitted to the server for storage.
548
In addition, it contains additional information about the submission.
549
complete - True if this submission was successful, rendering this exercise
550
complete for this user.
551
active - True if this submission is "active" (usually true). Submissions
552
may be de-activated by privileged users for special reasons, and then
553
they won't count (either as a penalty or success), but will still be
1238
556
__storm_table__ = "exercise_attempt"
1239
557
__storm_primary__ = "ws_ex_id", "user_id", "date"
1267
580
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1268
581
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1271
"""Delete this suite, without asking questions."""
1272
for variable in self.variables:
1274
for test_case in self.test_cases:
1276
Store.of(self).remove(self)
1278
583
class TestCase(Storm):
1279
"""A container for actual tests (see TestCasePart), inside a test suite.
1281
It is the lowest level shown to students on their pass/fail status."""
584
"""A TestCase is a member of a TestSuite.
586
It contains the data necessary to check if an exercise is correct"""
1283
587
__storm_table__ = "test_case"
1284
588
__storm_primary__ = "testid", "suiteid"
1288
592
suite = Reference(suiteid, "TestSuite.suiteid")
1289
593
passmsg = Unicode()
1290
594
failmsg = Unicode()
1291
test_default = Unicode() # Currently unused - only used for file matching.
595
test_default = Unicode()
1294
598
parts = ReferenceSet(testid, "TestCasePart.testid")
1296
600
__init__ = _kwarg_init
1299
for part in self.parts:
1301
Store.of(self).remove(self)
1303
602
class TestSuiteVar(Storm):
1304
"""A variable used by an exercise test suite.
1306
This may represent a function argument or a normal variable.
603
"""A container for the arguments of a Test Suite"""
1309
604
__storm_table__ = "suite_variable"
1310
605
__storm_primary__ = "varid"
1314
609
var_name = Unicode()
1315
610
var_value = Unicode()
1316
611
var_type = Unicode()
1319
614
suite = Reference(suiteid, "TestSuite.suiteid")
1321
616
__init__ = _kwarg_init
1324
Store.of(self).remove(self)
1326
618
class TestCasePart(Storm):
1327
"""An actual piece of code to test an exercise solution."""
619
"""A container for the test elements of a Test Case"""
1329
620
__storm_table__ = "test_case_part"
1330
621
__storm_primary__ = "partid"
1335
626
part_type = Unicode()
1336
627
test_type = Unicode()
1337
628
data = Unicode()
1338
629
filename = Unicode()
1340
631
test = Reference(testid, "TestCase.testid")
1342
633
__init__ = _kwarg_init
1345
Store.of(self).remove(self)
added
removed
ivle/database.py
