30
31
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
32
Reference, ReferenceSet, Bool, Storm, Desc
33
from storm.expr import Select, Max
32
34
from storm.exceptions import NotOneError, IntegrityError
35
36
from ivle.worksheet.rst import rst
37
38
__all__ = ['get_store',
51
52
% (self.__class__.__name__, k))
52
53
setattr(self, k, v)
54
def get_conn_string():
56
Returns the Storm connection string, generated from the conf file.
55
def get_conn_string(config):
56
"""Create a Storm connection string to the IVLE database
58
@param config: The IVLE configuration.
61
clusterstr += ivle.conf.db_user
62
if ivle.conf.db_password:
63
clusterstr += ':' + ivle.conf.db_password
62
if config['database']['username']:
63
clusterstr += config['database']['username']
64
if config['database']['password']:
65
clusterstr += ':' + config['database']['password']
66
host = ivle.conf.db_host or 'localhost'
67
port = ivle.conf.db_port or 5432
68
host = config['database']['host'] or 'localhost'
69
port = config['database']['port'] or 5432
69
71
clusterstr += '%s:%d' % (host, port)
71
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
75
Open a database connection and transaction. Return a storm.store.Store
76
instance connected to the configured IVLE database.
78
return Store(create_database(get_conn_string()))
73
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
75
def get_store(config):
76
"""Create a Storm store connected to the IVLE database.
78
@param config: The IVLE configuration.
80
return Store(create_database(get_conn_string(config)))
84
Represents an IVLE user.
85
"""An IVLE user account."""
86
86
__storm_table__ = "login"
88
88
id = Int(primary=True, name="loginid")
165
171
# TODO: Invitations should be listed too?
166
172
def get_groups(self, offering=None):
173
"""Get groups of which this user is a member.
175
@param offering: An optional offering to restrict the search to.
168
178
ProjectGroupMembership.user_id == self.id,
169
179
ProjectGroup.id == ProjectGroupMembership.project_group_id,
190
200
return self._get_enrolments(False)
192
202
def get_projects(self, offering=None, active_only=True):
193
'''Return Projects that the user can submit.
203
"""Find projects that the user can submit.
195
205
This will include projects for offerings in which the user is
196
206
enrolled, as long as the project is not in a project set which has
197
207
groups (ie. if maximum number of group members is 0).
199
Unless active_only is False, only projects for active offerings will
202
If an offering is specified, returned projects will be limited to
203
those for that offering.
209
@param active_only: Whether to only search active offerings.
210
@param offering: An optional offering to restrict the search to.
205
212
return Store.of(self).find(Project,
206
213
Project.project_set_id == ProjectSet.id,
207
214
ProjectSet.max_students_per_group == None,
210
217
Semester.id == Offering.semester_id,
211
218
(not active_only) or (Semester.state == u'current'),
212
219
Enrolment.offering_id == Offering.id,
213
Enrolment.user_id == self.id)
220
Enrolment.user_id == self.id,
221
Enrolment.active == True)
216
224
def hash_password(password):
225
"""Hash a password with MD5."""
217
226
return hashlib.md5(password).hexdigest()
220
229
def get_by_login(cls, store, login):
222
Get the User from the db associated with a given store and
230
"""Find a user in a store by login name."""
225
231
return store.find(cls, cls.login == unicode(login)).one()
227
def get_permissions(self, user):
233
def get_svn_url(self, config, req):
234
"""Get the subversion repository URL for this user or group."""
235
login = req.user.login
236
url = urlparse.urlsplit(config['urls']['svn_addr'])
237
url = urlparse.urlunsplit(url[:1] + (login+'@'+url[1],) + url[2:])
238
path = 'users/%s' % self.login
239
return urlparse.urljoin(url, path)
241
def get_permissions(self, user, config):
242
"""Determine privileges held by a user over this object.
244
If the user requesting privileges is this user or an admin,
245
they may do everything. Otherwise they may do nothing.
228
247
if user and user.admin or user is self:
229
return set(['view', 'edit', 'submit_project'])
248
return set(['view_public', 'view', 'edit', 'submit_project'])
250
return set(['view_public'])
233
252
# SUBJECTS AND ENROLMENTS #
235
254
class Subject(Storm):
255
"""A subject (or course) which is run in some semesters."""
236
257
__storm_table__ = "subject"
238
259
id = Int(primary=True, name="subjectid")
239
260
code = Unicode(name="subj_code")
240
261
name = Unicode(name="subj_name")
241
262
short_name = Unicode(name="subj_short_name")
244
264
offerings = ReferenceSet(id, 'Offering.subject_id')
248
268
def __repr__(self):
249
269
return "<%s '%s'>" % (type(self).__name__, self.short_name)
251
def get_permissions(self, user):
271
def get_permissions(self, user, config):
272
"""Determine privileges held by a user over this object.
274
If the user requesting privileges is an admin, they may edit.
275
Otherwise they may only read.
253
278
if user is not None:
254
279
perms.add('view')
259
284
def active_offerings(self):
260
"""Return a sequence of currently active offerings for this subject
285
"""Find active offerings for this subject.
287
Return a sequence of currently active offerings for this subject
261
288
(offerings whose semester.state is "current"). There should be 0 or 1
262
289
elements in this sequence, but it's possible there are more.
265
292
Semester.state == u'current')
267
294
def offering_for_semester(self, year, semester):
268
"""Get the offering for the given year/semester, or None."""
295
"""Get the offering for the given year/semester, or None.
297
@param year: A string representation of the year.
298
@param semester: A string representation of the semester.
269
300
return self.offerings.find(Offering.semester_id == Semester.id,
270
301
Semester.year == unicode(year),
271
302
Semester.semester == unicode(semester)).one()
273
304
class Semester(Storm):
305
"""A semester in which subjects can be run."""
274
307
__storm_table__ = "semester"
276
309
id = Int(primary=True, name="semesterid")
297
332
subject = Reference(subject_id, Subject.id)
298
333
semester_id = Int(name="semesterid")
299
334
semester = Reference(semester_id, Semester.id)
335
description = Unicode()
337
show_worksheet_marks = Bool()
338
worksheet_cutoff = DateTime()
300
339
groups_student_permissions = Unicode()
302
341
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
305
344
'Enrolment.user_id',
307
346
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
347
projects = ReferenceSet(id,
348
'ProjectSet.offering_id',
350
'Project.project_set_id')
309
352
worksheets = ReferenceSet(id,
310
353
'Worksheet.offering_id',
320
363
def enrol(self, user, role=u'student'):
321
'''Enrol a user in this offering.'''
364
"""Enrol a user in this offering.
366
Enrolments handle both the staff and student cases. The role controls
367
the privileges granted by this enrolment.
322
369
enrolment = Store.of(self).find(Enrolment,
323
370
Enrolment.user_id == user.id,
324
371
Enrolment.offering_id == self.id).one()
337
384
Enrolment.offering_id == self.id).one()
338
385
Store.of(enrolment).remove(enrolment)
340
def get_permissions(self, user):
387
def get_permissions(self, user, config):
342
389
if user is not None:
343
390
enrolment = self.get_enrolment(user)
344
391
if enrolment or user.admin:
345
392
perms.add('view')
346
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
393
if enrolment and enrolment.role == u'tutor':
394
perms.add('view_project_submissions')
395
# Site-specific policy on the role of tutors
396
if config['policy']['tutors_can_enrol_students']:
398
perms.add('enrol_student')
399
if config['policy']['tutors_can_edit_worksheets']:
400
perms.add('edit_worksheets')
401
if config['policy']['tutors_can_admin_groups']:
402
perms.add('admin_groups')
403
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
404
perms.add('view_project_submissions')
405
perms.add('admin_groups')
406
perms.add('edit_worksheets')
407
perms.add('view_worksheet_marks')
408
perms.add('edit') # Can edit projects & details
409
perms.add('enrol') # Can see enrolment screen at all
410
perms.add('enrol_student') # Can enrol students
411
perms.add('enrol_tutor') # Can enrol tutors
413
perms.add('enrol_lecturer') # Can enrol lecturers
351
416
def get_enrolment(self, user):
417
"""Find the user's enrolment in this offering."""
353
419
enrolment = self.enrolments.find(user=user).one()
354
420
except NotOneError:
425
def get_members_by_role(self, role):
426
return Store.of(self).find(User,
427
Enrolment.user_id == User.id,
428
Enrolment.offering_id == self.id,
429
Enrolment.role == role
430
).order_by(User.login)
434
return self.get_members_by_role(u'student')
436
def get_open_projects_for_user(self, user):
437
"""Find all projects currently open to submissions by a user."""
438
# XXX: Respect extensions.
439
return self.projects.find(Project.deadline > datetime.datetime.now())
441
def has_worksheet_cutoff_passed(self, user):
442
"""Check whether the worksheet cutoff has passed.
443
A user is required, in case we support extensions.
445
if self.worksheet_cutoff is None:
448
return self.worksheet_cutoff < datetime.datetime.now()
450
def clone_worksheets(self, source):
451
"""Clone all worksheets from the specified source to this offering."""
452
import ivle.worksheet.utils
453
for worksheet in source.worksheets:
455
newws.seq_no = worksheet.seq_no
456
newws.identifier = worksheet.identifier
457
newws.name = worksheet.name
458
newws.assessable = worksheet.assessable
459
newws.published = worksheet.published
460
newws.data = worksheet.data
461
newws.format = worksheet.format
462
newws.offering = self
463
Store.of(self).add(newws)
464
ivle.worksheet.utils.update_exerciselist(newws)
359
467
class Enrolment(Storm):
468
"""An enrolment of a user in an offering.
470
This represents the roles of both staff and students.
360
473
__storm_table__ = "enrolment"
361
474
__storm_primary__ = "user_id", "offering_id"
382
495
return "<%s %r in %r>" % (type(self).__name__, self.user,
498
def get_permissions(self, user, config):
499
# A user can edit any enrolment that they could have created.
501
if ('enrol_' + str(self.role)) in self.offering.get_permissions(
507
"""Delete this enrolment."""
508
Store.of(self).remove(self)
387
513
class ProjectSet(Storm):
514
"""A set of projects that share common groups.
516
Each student project group is attached to a project set. The group is
517
valid for all projects in the group's set.
388
520
__storm_table__ = "project_set"
390
522
id = Int(name="projectsetid", primary=True)
401
533
return "<%s %d in %r>" % (type(self).__name__, self.id,
536
def get_permissions(self, user, config):
537
return self.offering.get_permissions(user, config)
539
def get_groups_for_user(self, user):
540
"""List all groups in this offering of which the user is a member."""
542
return Store.of(self).find(
544
ProjectGroupMembership.user_id == user.id,
545
ProjectGroupMembership.project_group_id == ProjectGroup.id,
546
ProjectGroup.project_set_id == self.id)
548
def get_submission_principal(self, user):
549
"""Get the principal on behalf of which the user can submit.
551
If this is a solo project set, the given user is returned. If
552
the user is a member of exactly one group, all the group is
553
returned. Otherwise, None is returned.
556
groups = self.get_groups_for_user(user)
557
if groups.count() == 1:
566
return self.max_students_per_group is not None
570
"""Get the entities (groups or users) assigned to submit this project.
572
This will be a Storm ResultSet.
574
#If its a solo project, return everyone in offering
576
return self.project_groups
578
return self.offering.students
580
class DeadlinePassed(Exception):
581
"""An exception indicating that a project cannot be submitted because the
582
deadline has passed."""
586
return "The project deadline has passed"
404
588
class Project(Storm):
589
"""A student project for which submissions can be made."""
405
591
__storm_table__ = "project"
407
593
id = Int(name="projectid", primary=True)
425
611
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
426
612
self.project_set.offering)
428
def can_submit(self, principal):
614
def can_submit(self, principal, user):
429
615
return (self in principal.get_projects() and
430
self.deadline > datetime.datetime.now())
616
not self.has_deadline_passed(user))
432
618
def submit(self, principal, path, revision, who):
433
619
"""Submit a Subversion path and revision to a project.
435
'principal' is the owner of the Subversion repository, and the
436
entity on behalf of whom the submission is being made. 'path' is
437
a path within that repository, and 'revision' specifies which
438
revision of that path. 'who' is the person making the submission.
621
@param principal: The owner of the Subversion repository, and the
622
entity on behalf of whom the submission is being made
623
@param path: A path within that repository to submit.
624
@param revision: The revision of that path to submit.
625
@param who: The user who is actually making the submission.
441
if not self.can_submit(principal):
442
raise Exception('cannot submit')
628
if not self.can_submit(principal, who):
629
raise DeadlinePassed()
444
631
a = Assessed.get(Store.of(self), principal, self)
445
632
ps = ProjectSubmission()
633
# Raise SubmissionError if the path is illegal
634
ps.path = ProjectSubmission.test_and_normalise_path(path)
447
635
ps.revision = revision
448
636
ps.date_submitted = datetime.datetime.now()
642
def get_permissions(self, user, config):
643
return self.project_set.offering.get_permissions(user, config)
646
def latest_submissions(self):
647
"""Return the latest submission for each Assessed."""
648
return Store.of(self).find(ProjectSubmission,
649
Assessed.project_id == self.id,
650
ProjectSubmission.assessed_id == Assessed.id,
651
ProjectSubmission.date_submitted == Select(
652
Max(ProjectSubmission.date_submitted),
653
ProjectSubmission.assessed_id == Assessed.id,
654
tables=ProjectSubmission
658
def has_deadline_passed(self, user):
659
"""Check whether the deadline has passed."""
660
# XXX: Need to respect extensions.
661
return self.deadline < datetime.datetime.now()
663
def get_submissions_for_principal(self, principal):
664
"""Fetch a ResultSet of all submissions by a particular principal."""
665
assessed = Assessed.get(Store.of(self), principal, self)
668
return assessed.submissions
671
def can_delete(self):
672
"""Can only delete if there are no submissions."""
673
return self.submissions.count() == 0
676
"""Delete the project. Fails if can_delete is False."""
677
if not self.can_delete:
678
raise IntegrityError()
679
for assessed in self.assesseds:
681
Store.of(self).remove(self)
455
683
class ProjectGroup(Storm):
684
"""A group of students working together on a project."""
456
686
__storm_table__ = "project_group"
458
688
id = Int(name="groupid", primary=True)
479
709
def display_name(self):
480
return '%s (%s)' % (self.nick, self.name)
710
"""Returns the "nice name" of the user or group."""
714
def short_name(self):
715
"""Returns the database "identifier" name of the user or group."""
482
718
def get_projects(self, offering=None, active_only=True):
483
'''Return Projects that the group can submit.
719
'''Find projects that the group can submit.
485
721
This will include projects in the project set which owns this group,
486
722
unless the project set disallows groups (in which case none will be
489
Unless active_only is False, projects will only be returned if the
490
group's offering is active.
492
If an offering is specified, projects will only be returned if it
725
@param active_only: Whether to only search active offerings.
726
@param offering: An optional offering to restrict the search to.
495
728
return Store.of(self).find(Project,
496
729
Project.project_set_id == ProjectSet.id,
501
734
Semester.id == Offering.semester_id,
502
735
(not active_only) or (Semester.state == u'current'))
737
def get_svn_url(self, config, req):
738
"""Get the subversion repository URL for this user or group."""
739
login = req.user.login
740
url = urlparse.urlsplit(config['urls']['svn_addr'])
741
url = urlparse.urlunsplit(url[:1] + (login+'@'+url[1],) + url[2:])
742
path = 'groups/%s_%s_%s_%s' % (
743
self.project_set.offering.subject.short_name,
744
self.project_set.offering.semester.year,
745
self.project_set.offering.semester.semester,
748
return urlparse.urljoin(url, path)
505
def get_permissions(self, user):
750
def get_permissions(self, user, config):
506
751
if user.admin or user in self.members:
507
752
return set(['submit_project'])
511
756
class ProjectGroupMembership(Storm):
757
"""A student's membership in a project group."""
512
759
__storm_table__ = "group_member"
513
760
__storm_primary__ = "user_id", "project_group_id"
536
789
project = Reference(project_id, Project.id)
538
791
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
539
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
792
submissions = ReferenceSet(
793
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
541
795
def __repr__(self):
542
796
return "<%s %r in %r>" % (type(self).__name__,
543
797
self.user or self.project_group, self.project)
801
"""True if the Assessed is a group, False if it is a user."""
802
return self.project_group is not None
806
return self.project_group or self.user
809
def checkout_location(self):
810
"""Returns the location of the Subversion workspace for this piece of
811
assessment, relative to each group member's home directory."""
812
subjectname = self.project.project_set.offering.subject.short_name
814
checkout_dir_name = self.principal.short_name
816
checkout_dir_name = "mywork"
817
return subjectname + "/" + checkout_dir_name
546
820
def get(cls, store, principal, project):
821
"""Find or create an Assessed for the given user or group and project.
823
@param principal: The user or group.
824
@param project: The project.
547
826
t = type(principal)
548
827
if t not in (User, ProjectGroup):
549
828
raise AssertionError('principal must be User or ProjectGroup')
847
"""Delete the assessed. Fails if there are any submissions. Deletes
849
if self.submissions.count() > 0:
850
raise IntegrityError()
851
for extension in self.extensions:
853
Store.of(self).remove(self)
568
855
class ProjectExtension(Storm):
856
"""An extension granted to a user or group on a particular project.
858
The user or group and project are specified by the Assessed.
569
861
__storm_table__ = "project_extension"
571
863
id = Int(name="extensionid", primary=True)
576
868
approver = Reference(approver_id, User.id)
577
869
notes = Unicode()
872
"""Delete the extension."""
873
Store.of(self).remove(self)
875
class SubmissionError(Exception):
876
"""Denotes a validation error during submission."""
579
879
class ProjectSubmission(Storm):
880
"""A submission from a user or group repository to a particular project.
882
The content of a submission is a single path and revision inside a
883
repository. The repository is that owned by the submission's user and
884
group, while the path and revision are explicit.
886
The user or group and project are specified by the Assessed.
580
889
__storm_table__ = "project_submission"
582
891
id = Int(name="submissionid", primary=True)
588
897
submitter = Reference(submitter_id, User.id)
589
898
date_submitted = DateTime()
900
def get_verify_url(self, user):
901
"""Get the URL for verifying this submission, within the account of
903
# If this is a solo project, then self.path will be prefixed with the
904
# subject name. Remove the first path segment.
905
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
906
if not self.assessed.is_group:
907
if '/' in submitpath:
908
submitpath = submitpath.split('/', 1)[1]
911
return "/files/%s/%s/%s?r=%d" % (user.login,
912
self.assessed.checkout_location, submitpath, self.revision)
915
def test_and_normalise_path(path):
916
"""Test that path is valid, and normalise it. This prevents possible
917
injections using malicious paths.
918
Returns the updated path, if successful.
919
Raises SubmissionError if invalid.
921
# Ensure the path is absolute to prevent being tacked onto working
923
# Prevent '\n' because it will break all sorts of things.
924
# Prevent '[' and ']' because they can be used to inject into the
926
# Normalise to avoid resulting in ".." path segments.
927
if not os.path.isabs(path):
928
raise SubmissionError("Path is not absolute")
929
if any(c in path for c in "\n[]"):
930
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
931
return os.path.normpath(path)
592
933
# WORKSHEETS AND EXERCISES #
594
935
class Exercise(Storm):
936
"""An exercise for students to complete in a worksheet.
938
An exercise may be present in any number of worksheets.
595
941
__storm_table__ = "exercise"
596
942
id = Unicode(primary=True, name="identifier")
598
944
description = Unicode()
945
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
599
946
partial = Unicode()
600
947
solution = Unicode()
601
948
include = Unicode()
619
966
def __repr__(self):
620
967
return "<%s %s>" % (type(self).__name__, self.name)
622
def get_permissions(self, user):
969
def get_permissions(self, user, config):
970
return self.global_permissions(user, config)
973
def global_permissions(user, config):
974
"""Gets the set of permissions this user has over *all* exercises.
975
This is used to determine who may view the exercises list, and create
625
979
if user is not None:
627
981
perms.add('edit')
628
982
perms.add('view')
629
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
983
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
986
elif (config['policy']['tutors_can_edit_worksheets']
987
and u'tutor' in set((e.role for e in user.active_enrolments))):
988
# Site-specific policy on the role of tutors
635
def get_description(self):
636
return rst(self.description)
994
def _cache_description_xhtml(self, invalidate=False):
995
# Don't regenerate an existing cache unless forced.
996
if self._description_xhtml_cache is not None and not invalidate:
1000
self._description_xhtml_cache = rst(self.description)
1002
self._description_xhtml_cache = None
1005
def description_xhtml(self):
1006
"""The XHTML exercise description, converted from reStructuredText."""
1007
self._cache_description_xhtml()
1008
return self._description_xhtml_cache
1010
def set_description(self, description):
1011
self.description = description
1012
self._cache_description_xhtml(invalidate=True)
638
1014
def delete(self):
639
1015
"""Deletes the exercise, providing it has no associated worksheets."""
686
1069
raise IntegrityError()
687
1070
store.find(WorksheetExercise,
688
1071
WorksheetExercise.worksheet == self).remove()
690
def get_permissions(self, user):
691
return self.offering.get_permissions(user)
694
"""Returns the xml of this worksheet, converts from rst if required."""
695
if self.format == u'rst':
696
ws_xml = rst(self.data)
1073
def get_permissions(self, user, config):
1074
offering_perms = self.offering.get_permissions(user, config)
1078
# Anybody who can view an offering can view a published
1080
if 'view' in offering_perms and self.published:
1083
# Any worksheet editors can both view and edit.
1084
if 'edit_worksheets' in offering_perms:
1090
def _cache_data_xhtml(self, invalidate=False):
1091
# Don't regenerate an existing cache unless forced.
1092
if self._data_xhtml_cache is not None and not invalidate:
1095
if self.format == u'rst':
1096
self._data_xhtml_cache = rst(self.data)
1098
self._data_xhtml_cache = None
1101
def data_xhtml(self):
1102
"""The XHTML of this worksheet, converted from rST if required."""
1103
# Update the rST -> XHTML cache, if required.
1104
self._cache_data_xhtml()
1106
if self.format == u'rst':
1107
return self._data_xhtml_cache
699
1109
return self.data
1111
def set_data(self, data):
1113
self._cache_data_xhtml(invalidate=True)
701
1115
def delete(self):
702
1116
"""Deletes the worksheet, provided it has no attempts on any exercises.
704
1118
Returns True if delete succeeded, or False if this worksheet has
705
1119
attempts attached."""
706
1120
for ws_ex in self.all_worksheet_exercises:
707
1121
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
708
1122
raise IntegrityError()
710
1124
self.remove_all_exercises()
711
1125
Store.of(self).remove(self)
713
1127
class WorksheetExercise(Storm):
1128
"""A link between a worksheet and one of its exercises.
1130
These may be marked optional, in which case the exercise does not count
1131
for marking purposes. The sequence number is used to order the worksheet
714
1135
__storm_table__ = "worksheet_exercise"
716
1137
id = Int(primary=True, name="ws_ex_id")
718
1139
worksheet_id = Int(name="worksheetid")
732
1153
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
733
1154
self.worksheet.identifier)
735
def get_permissions(self, user):
736
return self.worksheet.get_permissions(user)
1156
def get_permissions(self, user, config):
1157
return self.worksheet.get_permissions(user, config)
739
1160
class ExerciseSave(Storm):
741
Represents a potential solution to an exercise that a user has submitted
742
to the server for storage.
743
A basic ExerciseSave is just the current saved text for this exercise for
744
this user (doesn't count towards their attempts).
745
ExerciseSave may be extended with additional semantics (such as
1161
"""A potential exercise solution submitted by a user for storage.
1163
This is not an actual tested attempt at an exercise, it's just a save of
1164
the editing session.
748
1167
__storm_table__ = "exercise_save"
749
1168
__storm_primary__ = "ws_ex_id", "user_id"
761
1180
def __repr__(self):
762
1181
return "<%s %s by %s at %s>" % (type(self).__name__,
763
self.exercise.name, self.user.login, self.date.strftime("%c"))
1182
self.worksheet_exercise.exercise.name, self.user.login,
1183
self.date.strftime("%c"))
765
1185
class ExerciseAttempt(ExerciseSave):
767
An ExerciseAttempt is a special case of an ExerciseSave. Like an
768
ExerciseSave, it constitutes exercise solution data that the user has
769
submitted to the server for storage.
770
In addition, it contains additional information about the submission.
771
complete - True if this submission was successful, rendering this exercise
772
complete for this user.
773
active - True if this submission is "active" (usually true). Submissions
774
may be de-activated by privileged users for special reasons, and then
775
they won't count (either as a penalty or success), but will still be
1186
"""An attempt at solving an exercise.
1188
This is a special case of ExerciseSave, used when the user submits a
1189
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1192
In addition, it contains information about the result of the submission:
1194
- complete - True if this submission was successful, rendering this
1195
exercise complete for this user in this worksheet.
1196
- active - True if this submission is "active" (usually true).
1197
Submissions may be de-activated by privileged users for
1198
special reasons, and then they won't count (either as a
1199
penalty or success), but will still be stored.
778
1202
__storm_table__ = "exercise_attempt"
779
1203
__storm_primary__ = "ws_ex_id", "user_id", "date"
783
1207
text = Unicode(name="attempt")
784
1208
complete = Bool()
787
def get_permissions(self, user):
1211
def get_permissions(self, user, config):
788
1212
return set(['view']) if user is self.user else set()
790
1214
class TestSuite(Storm):
791
"""A Testsuite acts as a container for the test cases of an exercise."""
1215
"""A container to group an exercise's test cases.
1217
The test suite contains some information on how to test. The function to
1218
test, variables to set and stdin data are stored here.
792
1221
__storm_table__ = "test_suite"
793
1222
__storm_primary__ = "exercise_id", "suiteid"
796
1225
exercise_id = Unicode(name="exerciseid")
797
1226
description = Unicode()
801
1230
exercise = Reference(exercise_id, Exercise.id)
802
1231
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
803
1232
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
805
1234
def delete(self):
806
1235
"""Delete this suite, without asking questions."""
807
for vaariable in self.variables:
1236
for variable in self.variables:
808
1237
variable.delete()
809
1238
for test_case in self.test_cases:
810
1239
test_case.delete()
811
1240
Store.of(self).remove(self)
813
1242
class TestCase(Storm):
814
"""A TestCase is a member of a TestSuite.
816
It contains the data necessary to check if an exercise is correct"""
1243
"""A container for actual tests (see TestCasePart), inside a test suite.
1245
It is the lowest level shown to students on their pass/fail status."""
817
1247
__storm_table__ = "test_case"
818
1248
__storm_primary__ = "testid", "suiteid"
822
1252
suite = Reference(suiteid, "TestSuite.suiteid")
823
1253
passmsg = Unicode()
824
1254
failmsg = Unicode()
825
test_default = Unicode()
1255
test_default = Unicode() # Currently unused - only used for file matching.
828
1258
parts = ReferenceSet(testid, "TestCasePart.testid")
830
1260
__init__ = _kwarg_init
832
1262
def delete(self):
833
1263
for part in self.parts:
835
1265
Store.of(self).remove(self)
837
1267
class TestSuiteVar(Storm):
838
"""A container for the arguments of a Test Suite"""
1268
"""A variable used by an exercise test suite.
1270
This may represent a function argument or a normal variable.
839
1273
__storm_table__ = "suite_variable"
840
1274
__storm_primary__ = "varid"
844
1278
var_name = Unicode()
845
1279
var_value = Unicode()
846
1280
var_type = Unicode()
849
1283
suite = Reference(suiteid, "TestSuite.suiteid")
851
1285
__init__ = _kwarg_init
853
1287
def delete(self):
854
1288
Store.of(self).remove(self)
856
1290
class TestCasePart(Storm):
857
"""A container for the test elements of a Test Case"""
1291
"""An actual piece of code to test an exercise solution."""
858
1293
__storm_table__ = "test_case_part"
859
1294
__storm_primary__ = "partid"
864
1299
part_type = Unicode()
865
1300
test_type = Unicode()
866
1301
data = Unicode()
867
1302
filename = Unicode()
869
1304
test = Reference(testid, "TestCase.testid")
871
1306
__init__ = _kwarg_init
873
1308
def delete(self):
874
1309
Store.of(self).remove(self)
added
removed
ivle/database.py
