199
200
'''A sanely ordered list of all of the user's enrolments.'''
200
201
return self._get_enrolments(False)
203
def get_projects(self, offering=None, active_only=True):
204
"""Find projects that the user can submit.
206
This will include projects for offerings in which the user is
207
enrolled, as long as the project is not in a project set which has
208
groups (ie. if maximum number of group members is 0).
210
@param active_only: Whether to only search active offerings.
211
@param offering: An optional offering to restrict the search to.
213
return Store.of(self).find(Project,
214
Project.project_set_id == ProjectSet.id,
215
ProjectSet.max_students_per_group == None,
216
ProjectSet.offering_id == Offering.id,
217
(offering is None) or (Offering.id == offering.id),
218
Semester.id == Offering.semester_id,
219
(not active_only) or (Semester.state == u'current'),
220
Enrolment.offering_id == Offering.id,
221
Enrolment.user_id == self.id,
222
Enrolment.active == True)
203
225
def hash_password(password):
204
return md5.md5(password).hexdigest()
226
"""Hash a password with MD5."""
227
return hashlib.md5(password).hexdigest()
207
230
def get_by_login(cls, store, login):
209
Get the User from the db associated with a given store and
231
"""Find a user in a store by login name."""
212
232
return store.find(cls, cls.login == unicode(login)).one()
214
def get_permissions(self, user):
215
if user and user.rolenm == 'admin' or user is self:
216
return set(['view', 'edit'])
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'])
220
251
# SUBJECTS AND ENROLMENTS #
222
253
class Subject(Storm):
254
"""A subject (or course) which is run in some semesters."""
223
256
__storm_table__ = "subject"
225
258
id = Int(primary=True, name="subjectid")
226
259
code = Unicode(name="subj_code")
227
260
name = Unicode(name="subj_name")
228
261
short_name = Unicode(name="subj_short_name")
231
263
offerings = ReferenceSet(id, 'Offering.subject_id')
286
359
return "<%s %r in %r>" % (type(self).__name__, self.subject,
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):
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):
303
388
if user is not None:
305
if user.rolenm == 'admin':
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)
309
466
class Enrolment(Storm):
467
"""An enrolment of a user in an offering.
469
This represents the roles of both staff and students.
310
472
__storm_table__ = "enrolment"
311
473
__storm_primary__ = "user_id", "offering_id"
353
532
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"
356
587
class Project(Storm):
588
"""A student project for which submissions can be made."""
357
590
__storm_table__ = "project"
359
592
id = Int(name="projectid", primary=True)
594
short_name = Unicode()
360
595
synopsis = Unicode()
362
597
project_set_id = Int(name="projectsetid")
363
598
project_set = Reference(project_set_id, ProjectSet.id)
364
599
deadline = DateTime()
601
assesseds = ReferenceSet(id, 'Assessed.project_id')
602
submissions = ReferenceSet(id,
603
'Assessed.project_id',
605
'ProjectSubmission.assessed_id')
366
607
__init__ = _kwarg_init
368
609
def __repr__(self):
369
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
610
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
370
611
self.project_set.offering)
613
def can_submit(self, principal, user, late=False):
615
@param late: If True, does not take the deadline into account.
617
return (self in principal.get_projects() and
618
(late or not self.has_deadline_passed(user)))
620
def submit(self, principal, path, revision, who, late=False):
621
"""Submit a Subversion path and revision to a project.
623
@param principal: The owner of the Subversion repository, and the
624
entity on behalf of whom the submission is being made
625
@param path: A path within that repository to submit.
626
@param revision: The revision of that path to submit.
627
@param who: The user who is actually making the submission.
628
@param late: If True, will not raise a DeadlinePassed exception even
629
after the deadline. (Default False.)
632
if not self.can_submit(principal, who, late=late):
633
raise DeadlinePassed()
635
a = Assessed.get(Store.of(self), principal, self)
636
ps = ProjectSubmission()
637
# Raise SubmissionError if the path is illegal
638
ps.path = ProjectSubmission.test_and_normalise_path(path)
639
ps.revision = revision
640
ps.date_submitted = datetime.datetime.now()
646
def get_permissions(self, user, config):
647
return self.project_set.offering.get_permissions(user, config)
650
def latest_submissions(self):
651
"""Return the latest submission for each Assessed."""
652
return Store.of(self).find(ProjectSubmission,
653
Assessed.project_id == self.id,
654
ProjectSubmission.assessed_id == Assessed.id,
655
ProjectSubmission.date_submitted == Select(
656
Max(ProjectSubmission.date_submitted),
657
ProjectSubmission.assessed_id == Assessed.id,
658
tables=ProjectSubmission
662
def has_deadline_passed(self, user):
663
"""Check whether the deadline has passed."""
664
# XXX: Need to respect extensions.
665
return self.deadline < datetime.datetime.now()
667
def get_submissions_for_principal(self, principal):
668
"""Fetch a ResultSet of all submissions by a particular principal."""
669
assessed = Assessed.get(Store.of(self), principal, self)
672
return assessed.submissions
675
def can_delete(self):
676
"""Can only delete if there are no submissions."""
677
return self.submissions.count() == 0
680
"""Delete the project. Fails if can_delete is False."""
681
if not self.can_delete:
682
raise IntegrityError()
683
for assessed in self.assesseds:
685
Store.of(self).remove(self)
372
687
class ProjectGroup(Storm):
688
"""A group of students working together on a project."""
373
690
__storm_table__ = "project_group"
375
692
id = Int(name="groupid", primary=True)
392
709
return "<%s %s in %r>" % (type(self).__name__, self.name,
393
710
self.project_set.offering)
713
def display_name(self):
714
"""Returns the "nice name" of the user or group."""
718
def short_name(self):
719
"""Returns the database "identifier" name of the user or group."""
722
def get_projects(self, offering=None, active_only=True):
723
'''Find projects that the group can submit.
725
This will include projects in the project set which owns this group,
726
unless the project set disallows groups (in which case none will be
729
@param active_only: Whether to only search active offerings.
730
@param offering: An optional offering to restrict the search to.
732
return Store.of(self).find(Project,
733
Project.project_set_id == ProjectSet.id,
734
ProjectSet.id == self.project_set.id,
735
ProjectSet.max_students_per_group != None,
736
ProjectSet.offering_id == Offering.id,
737
(offering is None) or (Offering.id == offering.id),
738
Semester.id == Offering.semester_id,
739
(not active_only) or (Semester.state == u'current'))
741
def get_svn_url(self, config):
742
"""Get the subversion repository URL for this user or group."""
743
url = config['urls']['svn_addr']
744
path = 'groups/%s_%s_%s_%s' % (
745
self.project_set.offering.subject.short_name,
746
self.project_set.offering.semester.year,
747
self.project_set.offering.semester.semester,
750
return urlparse.urljoin(url, path)
752
def get_permissions(self, user, config):
753
if user.admin or user in self.members:
754
return set(['submit_project'])
395
758
class ProjectGroupMembership(Storm):
759
"""A student's membership in a project group."""
396
761
__storm_table__ = "group_member"
397
762
__storm_primary__ = "user_id", "project_group_id"
407
772
return "<%s %r in %r>" % (type(self).__name__, self.user,
408
773
self.project_group)
775
class Assessed(Storm):
776
"""A composite of a user or group combined with a project.
778
Each project submission and extension refers to an Assessed. It is the
779
sole specifier of the repository and project.
782
__storm_table__ = "assessed"
784
id = Int(name="assessedid", primary=True)
785
user_id = Int(name="loginid")
786
user = Reference(user_id, User.id)
787
project_group_id = Int(name="groupid")
788
project_group = Reference(project_group_id, ProjectGroup.id)
790
project_id = Int(name="projectid")
791
project = Reference(project_id, Project.id)
793
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
794
submissions = ReferenceSet(
795
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
798
return "<%s %r in %r>" % (type(self).__name__,
799
self.user or self.project_group, self.project)
803
"""True if the Assessed is a group, False if it is a user."""
804
return self.project_group is not None
808
return self.project_group or self.user
811
def checkout_location(self):
812
"""Returns the location of the Subversion workspace for this piece of
813
assessment, relative to each group member's home directory."""
814
subjectname = self.project.project_set.offering.subject.short_name
816
checkout_dir_name = self.principal.short_name
818
checkout_dir_name = "mywork"
819
return subjectname + "/" + checkout_dir_name
822
def get(cls, store, principal, project):
823
"""Find or create an Assessed for the given user or group and project.
825
@param principal: The user or group.
826
@param project: The project.
829
if t not in (User, ProjectGroup):
830
raise AssertionError('principal must be User or ProjectGroup')
833
(t is User) or (cls.project_group_id == principal.id),
834
(t is ProjectGroup) or (cls.user_id == principal.id),
835
cls.project_id == project.id).one()
842
a.project_group = principal
849
"""Delete the assessed. Fails if there are any submissions. Deletes
851
if self.submissions.count() > 0:
852
raise IntegrityError()
853
for extension in self.extensions:
855
Store.of(self).remove(self)
857
class ProjectExtension(Storm):
858
"""An extension granted to a user or group on a particular project.
860
The user or group and project are specified by the Assessed.
863
__storm_table__ = "project_extension"
865
id = Int(name="extensionid", primary=True)
866
assessed_id = Int(name="assessedid")
867
assessed = Reference(assessed_id, Assessed.id)
869
approver_id = Int(name="approver")
870
approver = Reference(approver_id, User.id)
874
"""Delete the extension."""
875
Store.of(self).remove(self)
877
class SubmissionError(Exception):
878
"""Denotes a validation error during submission."""
881
class ProjectSubmission(Storm):
882
"""A submission from a user or group repository to a particular project.
884
The content of a submission is a single path and revision inside a
885
repository. The repository is that owned by the submission's user and
886
group, while the path and revision are explicit.
888
The user or group and project are specified by the Assessed.
891
__storm_table__ = "project_submission"
893
id = Int(name="submissionid", primary=True)
894
assessed_id = Int(name="assessedid")
895
assessed = Reference(assessed_id, Assessed.id)
898
submitter_id = Int(name="submitter")
899
submitter = Reference(submitter_id, User.id)
900
date_submitted = DateTime()
902
def get_verify_url(self, user):
903
"""Get the URL for verifying this submission, within the account of
905
# If this is a solo project, then self.path will be prefixed with the
906
# subject name. Remove the first path segment.
907
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
908
if not self.assessed.is_group:
909
if '/' in submitpath:
910
submitpath = submitpath.split('/', 1)[1]
913
return "/files/%s/%s/%s?r=%d" % (user.login,
914
self.assessed.checkout_location, submitpath, self.revision)
916
def get_svn_url(self, config):
917
"""Get subversion URL for this submission"""
918
princ = self.assessed.principal
919
base = princ.get_svn_url(config)
920
if self.path.startswith(os.sep):
921
return os.path.join(base,
922
urllib.quote(self.path[1:].encode('utf-8')))
924
return os.path.join(base, urllib.quote(self.path.encode('utf-8')))
926
def get_svn_export_command(self, req):
927
"""Returns a Unix shell command to export a submission"""
928
svn_url = self.get_svn_url(req.config)
929
username = (req.user.login if req.user.login.isalnum() else
930
"'%s'"%req.user.login)
931
export_dir = self.assessed.principal.short_name
932
return "svn export --username %s -r%d '%s' %s"%(req.user.login,
933
self.revision, svn_url, export_dir)
936
def test_and_normalise_path(path):
937
"""Test that path is valid, and normalise it. This prevents possible
938
injections using malicious paths.
939
Returns the updated path, if successful.
940
Raises SubmissionError if invalid.
942
# Ensure the path is absolute to prevent being tacked onto working
944
# Prevent '\n' because it will break all sorts of things.
945
# Prevent '[' and ']' because they can be used to inject into the
947
# Normalise to avoid resulting in ".." path segments.
948
if not os.path.isabs(path):
949
raise SubmissionError("Path is not absolute")
950
if any(c in path for c in "\n[]"):
951
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
952
return os.path.normpath(path)
956
"""True if the project was submitted late."""
957
return self.days_late > 0
961
"""The number of days the project was submitted late (rounded up), or
963
# XXX: Need to respect extensions.
965
(self.date_submitted - self.assessed.project.deadline).days + 1)
410
967
# WORKSHEETS AND EXERCISES #
412
969
class Exercise(Storm):
413
# Note: Table "problem" is called "Exercise" in the Object layer, since
414
# it's called that everywhere else.
415
__storm_table__ = "problem"
970
"""An exercise for students to complete in a worksheet.
972
An exercise may be present in any number of worksheets.
975
__storm_table__ = "exercise"
416
976
id = Unicode(primary=True, name="identifier")
418
978
description = Unicode()
979
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
419
980
partial = Unicode()
420
981
solution = Unicode()
421
982
include = Unicode()
985
worksheet_exercises = ReferenceSet(id,
986
'WorksheetExercise.exercise_id')
424
988
worksheets = ReferenceSet(id,
425
989
'WorksheetExercise.exercise_id',
426
990
'WorksheetExercise.worksheet_id',
430
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
994
test_suites = ReferenceSet(id,
995
'TestSuite.exercise_id',
432
998
__init__ = _kwarg_init
434
1000
def __repr__(self):
435
1001
return "<%s %s>" % (type(self).__name__, self.name)
1003
def get_permissions(self, user, config):
1004
return self.global_permissions(user, config)
1007
def global_permissions(user, config):
1008
"""Gets the set of permissions this user has over *all* exercises.
1009
This is used to determine who may view the exercises list, and create
1013
if user is not None:
1017
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
1020
elif (config['policy']['tutors_can_edit_worksheets']
1021
and u'tutor' in set((e.role for e in user.active_enrolments))):
1022
# Site-specific policy on the role of tutors
1028
def _cache_description_xhtml(self, invalidate=False):
1029
# Don't regenerate an existing cache unless forced.
1030
if self._description_xhtml_cache is not None and not invalidate:
1033
if self.description:
1034
self._description_xhtml_cache = rst(self.description)
1036
self._description_xhtml_cache = None
1039
def description_xhtml(self):
1040
"""The XHTML exercise description, converted from reStructuredText."""
1041
self._cache_description_xhtml()
1042
return self._description_xhtml_cache
1044
def set_description(self, description):
1045
self.description = description
1046
self._cache_description_xhtml(invalidate=True)
1049
"""Deletes the exercise, providing it has no associated worksheets."""
1050
if (self.worksheet_exercises.count() > 0):
1051
raise IntegrityError()
1052
for suite in self.test_suites:
1054
Store.of(self).remove(self)
438
1056
class Worksheet(Storm):
1057
"""A worksheet with exercises for students to complete.
1059
Worksheets are owned by offerings.
439
1062
__storm_table__ = "worksheet"
441
1064
id = Int(primary=True, name="worksheetid")
443
1066
identifier = Unicode()
444
1067
name = Unicode()
445
1068
assessable = Bool()
446
1070
data = Unicode()
1071
_data_xhtml_cache = Unicode(name='data_xhtml_cache')
448
1073
format = Unicode()
450
1075
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
451
1076
offering = Reference(offering_id, 'Offering.id')
453
# Use worksheet_exercises to get access to the WorksheetExercise objects
454
# binding worksheets to exercises. This is required to access the
1078
all_worksheet_exercises = ReferenceSet(id,
1079
'WorksheetExercise.worksheet_id')
1081
# Use worksheet_exercises to get access to the *active* WorksheetExercise
1082
# objects binding worksheets to exercises. This is required to access the
455
1083
# "optional" field.
456
worksheet_exercises = ReferenceSet(id,
457
'WorksheetExercise.worksheet_id')
1086
def worksheet_exercises(self):
1087
return self.all_worksheet_exercises.find(active=True)
460
1089
__init__ = _kwarg_init
462
1091
def __repr__(self):
463
1092
return "<%s %s>" % (type(self).__name__, self.name)
465
# XXX Refactor this - make it an instance method of Subject rather than a
466
# class method of Worksheet. Can't do that now because Subject isn't
467
# linked referentially to the Worksheet.
469
def get_by_name(cls, store, subjectname, worksheetname):
471
Get the Worksheet from the db associated with a given store, subject
472
name and worksheet name.
474
return store.find(cls, cls.subject == unicode(subjectname),
475
cls.name == unicode(worksheetname)).one()
1094
def remove_all_exercises(self):
1095
"""Remove all exercises from this worksheet.
477
def remove_all_exercises(self, store):
479
Remove all exercises from this worksheet.
480
1097
This does not delete the exercises themselves. It just removes them
481
1098
from the worksheet.
1100
store = Store.of(self)
1101
for ws_ex in self.all_worksheet_exercises:
1102
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1103
raise IntegrityError()
483
1104
store.find(WorksheetExercise,
484
1105
WorksheetExercise.worksheet == self).remove()
486
def get_permissions(self, user):
487
return self.offering.get_permissions(user)
1107
def get_permissions(self, user, config):
1108
offering_perms = self.offering.get_permissions(user, config)
1112
# Anybody who can view an offering can view a published
1114
if 'view' in offering_perms and self.published:
1117
# Any worksheet editors can both view and edit.
1118
if 'edit_worksheets' in offering_perms:
1124
def _cache_data_xhtml(self, invalidate=False):
1125
# Don't regenerate an existing cache unless forced.
1126
if self._data_xhtml_cache is not None and not invalidate:
1129
if self.format == u'rst':
1130
self._data_xhtml_cache = rst(self.data)
1132
self._data_xhtml_cache = None
1135
def data_xhtml(self):
1136
"""The XHTML of this worksheet, converted from rST if required."""
1137
# Update the rST -> XHTML cache, if required.
1138
self._cache_data_xhtml()
1140
if self.format == u'rst':
1141
return self._data_xhtml_cache
1145
def set_data(self, data):
1147
self._cache_data_xhtml(invalidate=True)
1150
"""Deletes the worksheet, provided it has no attempts on any exercises.
1152
Returns True if delete succeeded, or False if this worksheet has
1153
attempts attached."""
1154
for ws_ex in self.all_worksheet_exercises:
1155
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1156
raise IntegrityError()
1158
self.remove_all_exercises()
1159
Store.of(self).remove(self)
489
1161
class WorksheetExercise(Storm):
490
__storm_table__ = "worksheet_problem"
492
id = Int(primary=True, name="ws_prob_id")
1162
"""A link between a worksheet and one of its exercises.
1164
These may be marked optional, in which case the exercise does not count
1165
for marking purposes. The sequence number is used to order the worksheet
1169
__storm_table__ = "worksheet_exercise"
1171
id = Int(primary=True, name="ws_ex_id")
494
1173
worksheet_id = Int(name="worksheetid")
495
1174
worksheet = Reference(worksheet_id, Worksheet.id)
496
exercise_id = Unicode(name="problemid")
1175
exercise_id = Unicode(name="exerciseid")
497
1176
exercise = Reference(exercise_id, Exercise.id)
498
1177
optional = Bool()
502
1181
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
503
1182
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
533
1214
def __repr__(self):
534
1215
return "<%s %s by %s at %s>" % (type(self).__name__,
535
self.exercise.name, self.user.login, self.date.strftime("%c"))
1216
self.worksheet_exercise.exercise.name, self.user.login,
1217
self.date.strftime("%c"))
537
1219
class ExerciseAttempt(ExerciseSave):
539
An ExerciseAttempt is a special case of an ExerciseSave. Like an
540
ExerciseSave, it constitutes exercise solution data that the user has
541
submitted to the server for storage.
542
In addition, it contains additional information about the submission.
543
complete - True if this submission was successful, rendering this exercise
544
complete for this user.
545
active - True if this submission is "active" (usually true). Submissions
546
may be de-activated by privileged users for special reasons, and then
547
they won't count (either as a penalty or success), but will still be
550
__storm_table__ = "problem_attempt"
1220
"""An attempt at solving an exercise.
1222
This is a special case of ExerciseSave, used when the user submits a
1223
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1226
In addition, it contains information about the result of the submission:
1228
- complete - True if this submission was successful, rendering this
1229
exercise complete for this user in this worksheet.
1230
- active - True if this submission is "active" (usually true).
1231
Submissions may be de-activated by privileged users for
1232
special reasons, and then they won't count (either as a
1233
penalty or success), but will still be stored.
1236
__storm_table__ = "exercise_attempt"
551
1237
__storm_primary__ = "ws_ex_id", "user_id", "date"
553
1239
# The "text" field is the same but has a different name in the DB table
555
1241
text = Unicode(name="attempt")
556
1242
complete = Bool()
559
def get_permissions(self, user):
1245
def get_permissions(self, user, config):
560
1246
return set(['view']) if user is self.user else set()
562
1248
class TestSuite(Storm):
563
"""A Testsuite acts as a container for the test cases of an exercise."""
1249
"""A container to group an exercise's test cases.
1251
The test suite contains some information on how to test. The function to
1252
test, variables to set and stdin data are stored here.
564
1255
__storm_table__ = "test_suite"
565
1256
__storm_primary__ = "exercise_id", "suiteid"
568
exercise_id = Unicode(name="problemid")
1259
exercise_id = Unicode(name="exerciseid")
569
1260
description = Unicode()
571
1262
function = Unicode()
572
1263
stdin = Unicode()
573
1264
exercise = Reference(exercise_id, Exercise.id)
574
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
575
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1265
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1266
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1269
"""Delete this suite, without asking questions."""
1270
for variable in self.variables:
1272
for test_case in self.test_cases:
1274
Store.of(self).remove(self)
577
1276
class TestCase(Storm):
578
"""A TestCase is a member of a TestSuite.
580
It contains the data necessary to check if an exercise is correct"""
1277
"""A container for actual tests (see TestCasePart), inside a test suite.
1279
It is the lowest level shown to students on their pass/fail status."""
581
1281
__storm_table__ = "test_case"
582
1282
__storm_primary__ = "testid", "suiteid"
586
1286
suite = Reference(suiteid, "TestSuite.suiteid")
587
1287
passmsg = Unicode()
588
1288
failmsg = Unicode()
589
test_default = Unicode()
1289
test_default = Unicode() # Currently unused - only used for file matching.
592
1292
parts = ReferenceSet(testid, "TestCasePart.testid")
594
1294
__init__ = _kwarg_init
1297
for part in self.parts:
1299
Store.of(self).remove(self)
596
1301
class TestSuiteVar(Storm):
597
"""A container for the arguments of a Test Suite"""
598
__storm_table__ = "suite_variables"
1302
"""A variable used by an exercise test suite.
1304
This may represent a function argument or a normal variable.
1307
__storm_table__ = "suite_variable"
599
1308
__storm_primary__ = "varid"
603
1312
var_name = Unicode()
604
1313
var_value = Unicode()
605
1314
var_type = Unicode()
608
1317
suite = Reference(suiteid, "TestSuite.suiteid")
610
1319
__init__ = _kwarg_init
1322
Store.of(self).remove(self)
612
1324
class TestCasePart(Storm):
613
"""A container for the test elements of a Test Case"""
614
__storm_table__ = "test_case_parts"
1325
"""An actual piece of code to test an exercise solution."""
1327
__storm_table__ = "test_case_part"
615
1328
__storm_primary__ = "partid"
620
1333
part_type = Unicode()
621
1334
test_type = Unicode()
622
1335
data = Unicode()
623
1336
filename = Unicode()
625
1338
test = Reference(testid, "TestCase.testid")
627
1340
__init__ = _kwarg_init
1343
Store.of(self).remove(self)
added
removed
ivle/database.py
