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'
49
45
def _kwarg_init(self, **kwargs):
200
184
'''A sanely ordered list of all of the user's enrolments.'''
201
185
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
188
def hash_password(password):
226
"""Hash a password with MD5."""
227
return hashlib.md5(password).hexdigest()
189
return md5.md5(password).hexdigest()
230
192
def get_by_login(cls, store, login):
231
"""Find a user in a store by login name."""
194
Get the User from the db associated with a given store and
232
197
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'])
249
return set(['view_public'])
251
199
# SUBJECTS AND ENROLMENTS #
253
201
class Subject(Storm):
254
"""A subject (or course) which is run in some semesters."""
256
202
__storm_table__ = "subject"
258
204
id = Int(primary=True, name="subjectid")
259
205
code = Unicode(name="subj_code")
260
206
name = Unicode(name="subj_name")
261
207
short_name = Unicode(name="subj_short_name")
263
210
offerings = ReferenceSet(id, 'Offering.subject_id')
267
214
def __repr__(self):
268
215
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.
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.semester == unicode(semester)).one()
303
217
class Semester(Storm):
304
"""A semester in which subjects can be run."""
306
218
__storm_table__ = "semester"
308
220
id = Int(primary=True, name="semesterid")
310
222
semester = Unicode()
313
225
offerings = ReferenceSet(id, 'Offering.semester_id')
314
enrolments = ReferenceSet(id,
315
'Offering.semester_id',
317
'Enrolment.offering_id')
319
227
__init__ = _kwarg_init
359
252
return "<%s %r in %r>" % (type(self).__name__, self.subject,
362
def enrol(self, user, role=u'student'):
363
"""Enrol a user in this offering.
365
Enrolments handle both the staff and student cases. The role controls
366
the privileges granted by this enrolment.
368
enrolment = Store.of(self).find(Enrolment,
369
Enrolment.user_id == user.id,
370
Enrolment.offering_id == self.id).one()
372
if enrolment is None:
373
enrolment = Enrolment(user=user, offering=self)
374
self.enrolments.add(enrolment)
376
enrolment.active = True
377
enrolment.role = role
379
def unenrol(self, user):
380
'''Unenrol a user from this offering.'''
381
enrolment = Store.of(self).find(Enrolment,
382
Enrolment.user_id == user.id,
383
Enrolment.offering_id == self.id).one()
384
Store.of(enrolment).remove(enrolment)
386
def get_permissions(self, user, config):
389
enrolment = self.get_enrolment(user)
390
if enrolment or user.admin:
392
if enrolment and enrolment.role == u'tutor':
393
perms.add('view_project_submissions')
394
# Site-specific policy on the role of tutors
395
if config['policy']['tutors_can_enrol_students']:
397
perms.add('enrol_student')
398
if config['policy']['tutors_can_edit_worksheets']:
399
perms.add('edit_worksheets')
400
if config['policy']['tutors_can_admin_groups']:
401
perms.add('admin_groups')
402
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
403
perms.add('view_project_submissions')
404
perms.add('admin_groups')
405
perms.add('edit_worksheets')
406
perms.add('view_worksheet_marks')
407
perms.add('edit') # Can edit projects & details
408
perms.add('enrol') # Can see enrolment screen at all
409
perms.add('enrol_student') # Can enrol students
410
perms.add('enrol_tutor') # Can enrol tutors
412
perms.add('enrol_lecturer') # Can enrol lecturers
415
def get_enrolment(self, user):
416
"""Find the user's enrolment in this offering."""
418
enrolment = self.enrolments.find(user=user).one()
424
def get_members_by_role(self, role):
425
return Store.of(self).find(User,
426
Enrolment.user_id == User.id,
427
Enrolment.offering_id == self.id,
428
Enrolment.role == role
429
).order_by(User.login)
433
return self.get_members_by_role(u'student')
435
def get_open_projects_for_user(self, user):
436
"""Find all projects currently open to submissions by a user."""
437
# XXX: Respect extensions.
438
return self.projects.find(Project.deadline > datetime.datetime.now())
440
def has_worksheet_cutoff_passed(self, user):
441
"""Check whether the worksheet cutoff has passed.
442
A user is required, in case we support extensions.
444
if self.worksheet_cutoff is None:
447
return self.worksheet_cutoff < datetime.datetime.now()
449
def clone_worksheets(self, source):
450
"""Clone all worksheets from the specified source to this offering."""
451
import ivle.worksheet.utils
452
for worksheet in source.worksheets:
454
newws.seq_no = worksheet.seq_no
455
newws.identifier = worksheet.identifier
456
newws.name = worksheet.name
457
newws.assessable = worksheet.assessable
458
newws.published = worksheet.published
459
newws.data = worksheet.data
460
newws.format = worksheet.format
461
newws.offering = self
462
Store.of(self).add(newws)
463
ivle.worksheet.utils.update_exerciselist(newws)
255
def enrol(self, user):
256
'''Enrol a user in this offering.'''
257
# We'll get a horrible database constraint violation error if we try
258
# to add a second enrolment.
259
if Store.of(self).find(Enrolment,
260
Enrolment.user_id == user.id,
261
Enrolment.offering_id == self.id).count() == 1:
262
raise AlreadyEnrolledError()
264
e = Enrolment(user=user, offering=self, active=True)
265
self.enrolments.add(e)
466
267
class Enrolment(Storm):
467
"""An enrolment of a user in an offering.
469
This represents the roles of both staff and students.
472
268
__storm_table__ = "enrolment"
473
269
__storm_primary__ = "user_id", "offering_id"
532
311
return "<%s %d in %r>" % (type(self).__name__, self.id,
535
def get_permissions(self, user, config):
536
return self.offering.get_permissions(user, config)
538
def get_groups_for_user(self, user):
539
"""List all groups in this offering of which the user is a member."""
541
return Store.of(self).find(
543
ProjectGroupMembership.user_id == user.id,
544
ProjectGroupMembership.project_group_id == ProjectGroup.id,
545
ProjectGroup.project_set_id == self.id)
547
def get_submission_principal(self, user):
548
"""Get the principal on behalf of which the user can submit.
550
If this is a solo project set, the given user is returned. If
551
the user is a member of exactly one group, all the group is
552
returned. Otherwise, None is returned.
555
groups = self.get_groups_for_user(user)
556
if groups.count() == 1:
565
return self.max_students_per_group is not None
569
"""Get the entities (groups or users) assigned to submit this project.
571
This will be a Storm ResultSet.
573
#If its a solo project, return everyone in offering
575
return self.project_groups
577
return self.offering.students
579
class DeadlinePassed(Exception):
580
"""An exception indicating that a project cannot be submitted because the
581
deadline has passed."""
585
return "The project deadline has passed"
587
314
class Project(Storm):
588
"""A student project for which submissions can be made."""
590
315
__storm_table__ = "project"
592
317
id = Int(name="projectid", primary=True)
594
short_name = Unicode()
595
318
synopsis = Unicode()
597
320
project_set_id = Int(name="projectsetid")
598
321
project_set = Reference(project_set_id, ProjectSet.id)
599
322
deadline = DateTime()
601
assesseds = ReferenceSet(id, 'Assessed.project_id')
602
submissions = ReferenceSet(id,
603
'Assessed.project_id',
605
'ProjectSubmission.assessed_id')
607
324
__init__ = _kwarg_init
609
326
def __repr__(self):
610
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
327
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
611
328
self.project_set.offering)
613
def can_submit(self, principal, user):
614
return (self in principal.get_projects() and
615
not self.has_deadline_passed(user))
617
def submit(self, principal, path, revision, who):
618
"""Submit a Subversion path and revision to a project.
620
@param principal: The owner of the Subversion repository, and the
621
entity on behalf of whom the submission is being made
622
@param path: A path within that repository to submit.
623
@param revision: The revision of that path to submit.
624
@param who: The user who is actually making the submission.
627
if not self.can_submit(principal, who):
628
raise DeadlinePassed()
630
a = Assessed.get(Store.of(self), principal, self)
631
ps = ProjectSubmission()
632
# Raise SubmissionError if the path is illegal
633
ps.path = ProjectSubmission.test_and_normalise_path(path)
634
ps.revision = revision
635
ps.date_submitted = datetime.datetime.now()
641
def get_permissions(self, user, config):
642
return self.project_set.offering.get_permissions(user, config)
645
def latest_submissions(self):
646
"""Return the latest submission for each Assessed."""
647
return Store.of(self).find(ProjectSubmission,
648
Assessed.project_id == self.id,
649
ProjectSubmission.assessed_id == Assessed.id,
650
ProjectSubmission.date_submitted == Select(
651
Max(ProjectSubmission.date_submitted),
652
ProjectSubmission.assessed_id == Assessed.id,
653
tables=ProjectSubmission
657
def has_deadline_passed(self, user):
658
"""Check whether the deadline has passed."""
659
# XXX: Need to respect extensions.
660
return self.deadline < datetime.datetime.now()
662
def get_submissions_for_principal(self, principal):
663
"""Fetch a ResultSet of all submissions by a particular principal."""
664
assessed = Assessed.get(Store.of(self), principal, self)
667
return assessed.submissions
670
def can_delete(self):
671
"""Can only delete if there are no submissions."""
672
return self.submissions.count() == 0
675
"""Delete the project. Fails if can_delete is False."""
676
if not self.can_delete:
677
raise IntegrityError()
678
for assessed in self.assesseds:
680
Store.of(self).remove(self)
682
330
class ProjectGroup(Storm):
683
"""A group of students working together on a project."""
685
331
__storm_table__ = "project_group"
687
333
id = Int(name="groupid", primary=True)
704
350
return "<%s %s in %r>" % (type(self).__name__, self.name,
705
351
self.project_set.offering)
708
def display_name(self):
709
"""Returns the "nice name" of the user or group."""
713
def short_name(self):
714
"""Returns the database "identifier" name of the user or group."""
717
def get_projects(self, offering=None, active_only=True):
718
'''Find projects that the group can submit.
720
This will include projects in the project set which owns this group,
721
unless the project set disallows groups (in which case none will be
724
@param active_only: Whether to only search active offerings.
725
@param offering: An optional offering to restrict the search to.
727
return Store.of(self).find(Project,
728
Project.project_set_id == ProjectSet.id,
729
ProjectSet.id == self.project_set.id,
730
ProjectSet.max_students_per_group != None,
731
ProjectSet.offering_id == Offering.id,
732
(offering is None) or (Offering.id == offering.id),
733
Semester.id == Offering.semester_id,
734
(not active_only) or (Semester.state == u'current'))
736
def get_svn_url(self, config):
737
"""Get the subversion repository URL for this user or group."""
738
url = config['urls']['svn_addr']
739
path = 'groups/%s_%s_%s_%s' % (
740
self.project_set.offering.subject.short_name,
741
self.project_set.offering.semester.year,
742
self.project_set.offering.semester.semester,
745
return urlparse.urljoin(url, path)
747
def get_permissions(self, user, config):
748
if user.admin or user in self.members:
749
return set(['submit_project'])
753
353
class ProjectGroupMembership(Storm):
754
"""A student's membership in a project group."""
756
354
__storm_table__ = "group_member"
757
355
__storm_primary__ = "user_id", "project_group_id"
767
365
return "<%s %r in %r>" % (type(self).__name__, self.user,
768
366
self.project_group)
770
class Assessed(Storm):
771
"""A composite of a user or group combined with a project.
773
Each project submission and extension refers to an Assessed. It is the
774
sole specifier of the repository and project.
777
__storm_table__ = "assessed"
779
id = Int(name="assessedid", primary=True)
780
user_id = Int(name="loginid")
781
user = Reference(user_id, User.id)
782
project_group_id = Int(name="groupid")
783
project_group = Reference(project_group_id, ProjectGroup.id)
785
project_id = Int(name="projectid")
786
project = Reference(project_id, Project.id)
788
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
789
submissions = ReferenceSet(
790
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
793
return "<%s %r in %r>" % (type(self).__name__,
794
self.user or self.project_group, self.project)
798
"""True if the Assessed is a group, False if it is a user."""
799
return self.project_group is not None
803
return self.project_group or self.user
806
def checkout_location(self):
807
"""Returns the location of the Subversion workspace for this piece of
808
assessment, relative to each group member's home directory."""
809
subjectname = self.project.project_set.offering.subject.short_name
811
checkout_dir_name = self.principal.short_name
813
checkout_dir_name = "mywork"
814
return subjectname + "/" + checkout_dir_name
817
def get(cls, store, principal, project):
818
"""Find or create an Assessed for the given user or group and project.
820
@param principal: The user or group.
821
@param project: The project.
824
if t not in (User, ProjectGroup):
825
raise AssertionError('principal must be User or ProjectGroup')
828
(t is User) or (cls.project_group_id == principal.id),
829
(t is ProjectGroup) or (cls.user_id == principal.id),
830
cls.project_id == project.id).one()
837
a.project_group = principal
844
"""Delete the assessed. Fails if there are any submissions. Deletes
846
if self.submissions.count() > 0:
847
raise IntegrityError()
848
for extension in self.extensions:
850
Store.of(self).remove(self)
852
class ProjectExtension(Storm):
853
"""An extension granted to a user or group on a particular project.
855
The user or group and project are specified by the Assessed.
858
__storm_table__ = "project_extension"
860
id = Int(name="extensionid", primary=True)
861
assessed_id = Int(name="assessedid")
862
assessed = Reference(assessed_id, Assessed.id)
863
deadline = DateTime()
864
approver_id = Int(name="approver")
865
approver = Reference(approver_id, User.id)
869
"""Delete the extension."""
870
Store.of(self).remove(self)
872
class SubmissionError(Exception):
873
"""Denotes a validation error during submission."""
876
class ProjectSubmission(Storm):
877
"""A submission from a user or group repository to a particular project.
879
The content of a submission is a single path and revision inside a
880
repository. The repository is that owned by the submission's user and
881
group, while the path and revision are explicit.
883
The user or group and project are specified by the Assessed.
886
__storm_table__ = "project_submission"
888
id = Int(name="submissionid", primary=True)
889
assessed_id = Int(name="assessedid")
890
assessed = Reference(assessed_id, Assessed.id)
893
submitter_id = Int(name="submitter")
894
submitter = Reference(submitter_id, User.id)
895
date_submitted = DateTime()
897
def get_verify_url(self, user):
898
"""Get the URL for verifying this submission, within the account of
900
# If this is a solo project, then self.path will be prefixed with the
901
# subject name. Remove the first path segment.
902
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
903
if not self.assessed.is_group:
904
if '/' in submitpath:
905
submitpath = submitpath.split('/', 1)[1]
908
return "/files/%s/%s/%s?r=%d" % (user.login,
909
self.assessed.checkout_location, submitpath, self.revision)
911
def get_svn_url(self, config):
912
"""Get subversion URL for this submission"""
913
princ = self.assessed.principal
914
base = princ.get_svn_url(config)
915
if self.path.startswith(os.sep):
916
return os.path.join(base,
917
urllib.quote(self.path[1:].encode('utf-8')))
919
return os.path.join(base, urllib.quote(self.path.encode('utf-8')))
921
def get_svn_export_command(self, req):
922
"""Returns a Unix shell command to export a submission"""
923
svn_url = self.get_svn_url(req.config)
924
username = (req.user.login if req.user.login.isalnum() else
925
"'%s'"%req.user.login)
926
export_dir = self.assessed.principal.short_name
927
return "svn export --username %s -r%d '%s' %s"%(req.user.login,
928
self.revision, svn_url, export_dir)
931
def test_and_normalise_path(path):
932
"""Test that path is valid, and normalise it. This prevents possible
933
injections using malicious paths.
934
Returns the updated path, if successful.
935
Raises SubmissionError if invalid.
937
# Ensure the path is absolute to prevent being tacked onto working
939
# Prevent '\n' because it will break all sorts of things.
940
# Prevent '[' and ']' because they can be used to inject into the
942
# Normalise to avoid resulting in ".." path segments.
943
if not os.path.isabs(path):
944
raise SubmissionError("Path is not absolute")
945
if any(c in path for c in "\n[]"):
946
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
947
return os.path.normpath(path)
949
368
# WORKSHEETS AND EXERCISES #
951
370
class Exercise(Storm):
952
"""An exercise for students to complete in a worksheet.
954
An exercise may be present in any number of worksheets.
957
__storm_table__ = "exercise"
958
id = Unicode(primary=True, name="identifier")
960
description = Unicode()
961
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
967
worksheet_exercises = ReferenceSet(id,
968
'WorksheetExercise.exercise_id')
371
# Note: Table "problem" is called "Exercise" in the Object layer, since
372
# it's called that everywhere else.
373
__storm_table__ = "problem"
375
id = Int(primary=True, name="problemid")
376
name = Unicode(name="identifier")
970
379
worksheets = ReferenceSet(id,
971
380
'WorksheetExercise.exercise_id',
976
test_suites = ReferenceSet(id,
977
'TestSuite.exercise_id',
980
385
__init__ = _kwarg_init
982
387
def __repr__(self):
983
388
return "<%s %s>" % (type(self).__name__, self.name)
985
def get_permissions(self, user, config):
986
return self.global_permissions(user, config)
989
def global_permissions(user, config):
990
"""Gets the set of permissions this user has over *all* exercises.
991
This is used to determine who may view the exercises list, and create
999
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
1002
elif (config['policy']['tutors_can_edit_worksheets']
1003
and u'tutor' in set((e.role for e in user.active_enrolments))):
1004
# Site-specific policy on the role of tutors
1010
def _cache_description_xhtml(self, invalidate=False):
1011
# Don't regenerate an existing cache unless forced.
1012
if self._description_xhtml_cache is not None and not invalidate:
1015
if self.description:
1016
self._description_xhtml_cache = rst(self.description)
1018
self._description_xhtml_cache = None
1021
def description_xhtml(self):
1022
"""The XHTML exercise description, converted from reStructuredText."""
1023
self._cache_description_xhtml()
1024
return self._description_xhtml_cache
1026
def set_description(self, description):
1027
self.description = description
1028
self._cache_description_xhtml(invalidate=True)
1031
"""Deletes the exercise, providing it has no associated worksheets."""
1032
if (self.worksheet_exercises.count() > 0):
1033
raise IntegrityError()
1034
for suite in self.test_suites:
1036
Store.of(self).remove(self)
391
def get_by_name(cls, store, name):
393
Get the Exercise from the db associated with a given store and name.
394
If the exercise is not in the database, creates it and inserts it
397
ex = store.find(cls, cls.name == unicode(name)).one()
400
ex = Exercise(name=unicode(name))
1038
405
class Worksheet(Storm):
1039
"""A worksheet with exercises for students to complete.
1041
Worksheets are owned by offerings.
1044
406
__storm_table__ = "worksheet"
1046
408
id = Int(primary=True, name="worksheetid")
1047
offering_id = Int(name="offeringid")
1048
identifier = Unicode()
409
# XXX subject is not linked to a Subject object. This is a property of
410
# the database, and will be refactored.
412
name = Unicode(name="identifier")
1050
413
assessable = Bool()
1053
_data_xhtml_cache = Unicode(name='data_xhtml_cache')
1057
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
1058
offering = Reference(offering_id, 'Offering.id')
1060
all_worksheet_exercises = ReferenceSet(id,
416
exercises = ReferenceSet(id,
417
'WorksheetExercise.worksheet_id',
418
'WorksheetExercise.exercise_id',
420
# Use worksheet_exercises to get access to the WorksheetExercise objects
421
# binding worksheets to exercises. This is required to access the
423
worksheet_exercises = ReferenceSet(id,
1061
424
'WorksheetExercise.worksheet_id')
1063
# Use worksheet_exercises to get access to the *active* WorksheetExercise
1064
# objects binding worksheets to exercises. This is required to access the
1068
def worksheet_exercises(self):
1069
return self.all_worksheet_exercises.find(active=True)
1071
426
__init__ = _kwarg_init
1073
428
def __repr__(self):
1074
429
return "<%s %s>" % (type(self).__name__, self.name)
1076
def remove_all_exercises(self):
1077
"""Remove all exercises from this worksheet.
431
# XXX Refactor this - make it an instance method of Subject rather than a
432
# class method of Worksheet. Can't do that now because Subject isn't
433
# linked referentially to the Worksheet.
435
def get_by_name(cls, store, subjectname, worksheetname):
437
Get the Worksheet from the db associated with a given store, subject
438
name and worksheet name.
440
return store.find(cls, cls.subject == unicode(subjectname),
441
cls.name == unicode(worksheetname)).one()
443
def remove_all_exercises(self, store):
445
Remove all exercises from this worksheet.
1079
446
This does not delete the exercises themselves. It just removes them
1080
447
from the worksheet.
1082
store = Store.of(self)
1083
for ws_ex in self.all_worksheet_exercises:
1084
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1085
raise IntegrityError()
1086
449
store.find(WorksheetExercise,
1087
450
WorksheetExercise.worksheet == self).remove()
1089
def get_permissions(self, user, config):
1090
offering_perms = self.offering.get_permissions(user, config)
1094
# Anybody who can view an offering can view a published
1096
if 'view' in offering_perms and self.published:
1099
# Any worksheet editors can both view and edit.
1100
if 'edit_worksheets' in offering_perms:
1106
def _cache_data_xhtml(self, invalidate=False):
1107
# Don't regenerate an existing cache unless forced.
1108
if self._data_xhtml_cache is not None and not invalidate:
1111
if self.format == u'rst':
1112
self._data_xhtml_cache = rst(self.data)
1114
self._data_xhtml_cache = None
1117
def data_xhtml(self):
1118
"""The XHTML of this worksheet, converted from rST if required."""
1119
# Update the rST -> XHTML cache, if required.
1120
self._cache_data_xhtml()
1122
if self.format == u'rst':
1123
return self._data_xhtml_cache
1127
def set_data(self, data):
1129
self._cache_data_xhtml(invalidate=True)
1132
"""Deletes the worksheet, provided it has no attempts on any exercises.
1134
Returns True if delete succeeded, or False if this worksheet has
1135
attempts attached."""
1136
for ws_ex in self.all_worksheet_exercises:
1137
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1138
raise IntegrityError()
1140
self.remove_all_exercises()
1141
Store.of(self).remove(self)
1143
452
class WorksheetExercise(Storm):
1144
"""A link between a worksheet and one of its exercises.
1146
These may be marked optional, in which case the exercise does not count
1147
for marking purposes. The sequence number is used to order the worksheet
1151
__storm_table__ = "worksheet_exercise"
1153
id = Int(primary=True, name="ws_ex_id")
453
__storm_table__ = "worksheet_problem"
454
__storm_primary__ = "worksheet_id", "exercise_id"
1155
456
worksheet_id = Int(name="worksheetid")
1156
457
worksheet = Reference(worksheet_id, Worksheet.id)
1157
exercise_id = Unicode(name="exerciseid")
458
exercise_id = Int(name="problemid")
1158
459
exercise = Reference(exercise_id, Exercise.id)
1159
460
optional = Bool()
1163
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
1164
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
1166
462
__init__ = _kwarg_init
1168
464
def __repr__(self):
1169
465
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1170
self.worksheet.identifier)
1172
def get_permissions(self, user, config):
1173
return self.worksheet.get_permissions(user, config)
1176
468
class ExerciseSave(Storm):
1177
"""A potential exercise solution submitted by a user for storage.
1179
This is not an actual tested attempt at an exercise, it's just a save of
1180
the editing session.
1183
__storm_table__ = "exercise_save"
1184
__storm_primary__ = "ws_ex_id", "user_id"
1186
ws_ex_id = Int(name="ws_ex_id")
1187
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
470
Represents a potential solution to an exercise that a user has submitted
471
to the server for storage.
472
A basic ExerciseSave is just the current saved text for this exercise for
473
this user (doesn't count towards their attempts).
474
ExerciseSave may be extended with additional semantics (such as
477
__storm_table__ = "problem_save"
478
__storm_primary__ = "exercise_id", "user_id", "date"
480
exercise_id = Int(name="problemid")
481
exercise = Reference(exercise_id, Exercise.id)
1189
482
user_id = Int(name="loginid")
1190
483
user = Reference(user_id, User.id)
1191
484
date = DateTime()
1196
489
def __repr__(self):
1197
490
return "<%s %s by %s at %s>" % (type(self).__name__,
1198
self.worksheet_exercise.exercise.name, self.user.login,
1199
self.date.strftime("%c"))
491
self.exercise.name, self.user.login, self.date.strftime("%c"))
1201
493
class ExerciseAttempt(ExerciseSave):
1202
"""An attempt at solving an exercise.
1204
This is a special case of ExerciseSave, used when the user submits a
1205
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1208
In addition, it contains information about the result of the submission:
1210
- complete - True if this submission was successful, rendering this
1211
exercise complete for this user in this worksheet.
1212
- active - True if this submission is "active" (usually true).
1213
Submissions may be de-activated by privileged users for
1214
special reasons, and then they won't count (either as a
1215
penalty or success), but will still be stored.
1218
__storm_table__ = "exercise_attempt"
1219
__storm_primary__ = "ws_ex_id", "user_id", "date"
495
An ExerciseAttempt is a special case of an ExerciseSave. Like an
496
ExerciseSave, it constitutes exercise solution data that the user has
497
submitted to the server for storage.
498
In addition, it contains additional information about the submission.
499
complete - True if this submission was successful, rendering this exercise
500
complete for this user.
501
active - True if this submission is "active" (usually true). Submissions
502
may be de-activated by privileged users for special reasons, and then
503
they won't count (either as a penalty or success), but will still be
506
__storm_table__ = "problem_attempt"
507
__storm_primary__ = "exercise_id", "user_id", "date"
1221
509
# The "text" field is the same but has a different name in the DB table
1222
510
# for some reason.
1223
511
text = Unicode(name="attempt")
1224
512
complete = Bool()
1227
def get_permissions(self, user, config):
1228
return set(['view']) if user is self.user else set()
1230
class TestSuite(Storm):
1231
"""A container to group an exercise's test cases.
1233
The test suite contains some information on how to test. The function to
1234
test, variables to set and stdin data are stored here.
1237
__storm_table__ = "test_suite"
1238
__storm_primary__ = "exercise_id", "suiteid"
1241
exercise_id = Unicode(name="exerciseid")
1242
description = Unicode()
1244
function = Unicode()
1246
exercise = Reference(exercise_id, Exercise.id)
1247
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1248
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1251
"""Delete this suite, without asking questions."""
1252
for variable in self.variables:
1254
for test_case in self.test_cases:
1256
Store.of(self).remove(self)
1258
class TestCase(Storm):
1259
"""A container for actual tests (see TestCasePart), inside a test suite.
1261
It is the lowest level shown to students on their pass/fail status."""
1263
__storm_table__ = "test_case"
1264
__storm_primary__ = "testid", "suiteid"
1268
suite = Reference(suiteid, "TestSuite.suiteid")
1271
test_default = Unicode() # Currently unused - only used for file matching.
1274
parts = ReferenceSet(testid, "TestCasePart.testid")
1276
__init__ = _kwarg_init
1279
for part in self.parts:
1281
Store.of(self).remove(self)
1283
class TestSuiteVar(Storm):
1284
"""A variable used by an exercise test suite.
1286
This may represent a function argument or a normal variable.
1289
__storm_table__ = "suite_variable"
1290
__storm_primary__ = "varid"
1294
var_name = Unicode()
1295
var_value = Unicode()
1296
var_type = Unicode()
1299
suite = Reference(suiteid, "TestSuite.suiteid")
1301
__init__ = _kwarg_init
1304
Store.of(self).remove(self)
1306
class TestCasePart(Storm):
1307
"""An actual piece of code to test an exercise solution."""
1309
__storm_table__ = "test_case_part"
1310
__storm_primary__ = "partid"
1315
part_type = Unicode()
1316
test_type = Unicode()
1318
filename = Unicode()
1320
test = Reference(testid, "TestCase.testid")
1322
__init__ = _kwarg_init
1325
Store.of(self).remove(self)
added
removed
ivle/database.py
