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
32
from storm.exceptions import NotOneError, IntegrityError
37
35
from ivle.worksheet.rst import rst
39
37
__all__ = ['get_store',
53
51
% (self.__class__.__name__, k))
54
52
setattr(self, k, v)
56
def get_conn_string(config):
57
"""Create a Storm connection string to the IVLE database
59
@param config: The IVLE configuration.
54
def get_conn_string():
56
Returns the Storm connection string, generated from the conf file.
63
if config['database']['username']:
64
clusterstr += config['database']['username']
65
if config['database']['password']:
66
clusterstr += ':' + config['database']['password']
61
clusterstr += ivle.conf.db_user
62
if ivle.conf.db_password:
63
clusterstr += ':' + ivle.conf.db_password
69
host = config['database']['host'] or 'localhost'
70
port = config['database']['port'] or 5432
66
host = ivle.conf.db_host or 'localhost'
67
port = ivle.conf.db_port or 5432
72
69
clusterstr += '%s:%d' % (host, port)
74
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
76
def get_store(config):
77
"""Create a Storm store connected to the IVLE database.
79
@param config: The IVLE configuration.
81
return Store(create_database(get_conn_string(config)))
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()))
86
"""An IVLE user account."""
84
Represents an IVLE user.
87
86
__storm_table__ = "login"
89
88
id = Int(primary=True, name="loginid")
201
190
return self._get_enrolments(False)
203
192
def get_projects(self, offering=None, active_only=True):
204
"""Find projects that the user can submit.
193
'''Return Projects that the user can submit.
206
195
This will include projects for offerings in which the user is
207
196
enrolled, as long as the project is not in a project set which has
208
197
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.
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.
213
205
return Store.of(self).find(Project,
214
206
Project.project_set_id == ProjectSet.id,
215
ProjectSet.max_students_per_group == None,
207
ProjectSet.max_students_per_group == 0,
216
208
ProjectSet.offering_id == Offering.id,
217
209
(offering is None) or (Offering.id == offering.id),
218
210
Semester.id == Offering.semester_id,
219
211
(not active_only) or (Semester.state == u'current'),
220
212
Enrolment.offering_id == Offering.id,
221
Enrolment.user_id == self.id,
222
Enrolment.active == True)
213
Enrolment.user_id == self.id)
225
216
def hash_password(password):
226
"""Hash a password with MD5."""
227
return hashlib.md5(password).hexdigest()
217
return md5.md5(password).hexdigest()
230
220
def get_by_login(cls, store, login):
231
"""Find a user in a store by login name."""
222
Get the User from the db associated with a given store and
232
225
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.
227
def get_permissions(self, user):
246
228
if user and user.admin or user is self:
247
return set(['view_public', 'view', 'edit', 'submit_project'])
229
return set(['view', 'edit', 'submit_project'])
249
return set(['view_public'])
251
233
# SUBJECTS AND ENROLMENTS #
253
235
class Subject(Storm):
254
"""A subject (or course) which is run in some semesters."""
256
236
__storm_table__ = "subject"
258
238
id = Int(primary=True, name="subjectid")
259
239
code = Unicode(name="subj_code")
260
240
name = Unicode(name="subj_name")
261
241
short_name = Unicode(name="subj_short_name")
263
244
offerings = ReferenceSet(id, 'Offering.subject_id')
280
256
perms.add('edit')
283
def active_offerings(self):
284
"""Find active offerings for this subject.
286
Return a sequence of currently active offerings for this subject
287
(offerings whose semester.state is "current"). There should be 0 or 1
288
elements in this sequence, but it's possible there are more.
290
return self.offerings.find(Offering.semester_id == Semester.id,
291
Semester.state == u'current')
293
def offering_for_semester(self, year, semester):
294
"""Get the offering for the given year/semester, or None.
296
@param year: A string representation of the year.
297
@param semester: A string representation of the semester.
299
return self.offerings.find(Offering.semester_id == Semester.id,
300
Semester.year == unicode(year),
301
Semester.semester == unicode(semester)).one()
303
259
class Semester(Storm):
304
"""A semester in which subjects can be run."""
306
260
__storm_table__ = "semester"
308
262
id = Int(primary=True, name="semesterid")
383
323
Enrolment.offering_id == self.id).one()
384
324
Store.of(enrolment).remove(enrolment)
386
def get_permissions(self, user, config):
326
def get_permissions(self, user):
388
328
if user is not None:
389
329
enrolment = self.get_enrolment(user)
390
330
if enrolment or user.admin:
391
331
perms.add('view')
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
332
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
415
337
def get_enrolment(self, user):
416
"""Find the user's enrolment in this offering."""
418
339
enrolment = self.enrolments.find(user=user).one()
419
340
except NotOneError:
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)
466
345
class Enrolment(Storm):
467
"""An enrolment of a user in an offering.
469
This represents the roles of both staff and students.
472
346
__storm_table__ = "enrolment"
473
347
__storm_primary__ = "user_id", "offering_id"
494
368
return "<%s %r in %r>" % (type(self).__name__, self.user,
497
def get_permissions(self, user, config):
498
# A user can edit any enrolment that they could have created.
500
if ('enrol_' + str(self.role)) in self.offering.get_permissions(
506
"""Delete this enrolment."""
507
Store.of(self).remove(self)
512
373
class ProjectSet(Storm):
513
"""A set of projects that share common groups.
515
Each student project group is attached to a project set. The group is
516
valid for all projects in the group's set.
519
374
__storm_table__ = "project_set"
521
376
id = Int(name="projectsetid", primary=True)
532
387
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
390
class Project(Storm):
588
"""A student project for which submissions can be made."""
590
391
__storm_table__ = "project"
592
393
id = Int(name="projectid", primary=True)
610
411
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
611
412
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.
414
def can_submit(self, principal):
617
415
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()
416
self.deadline > datetime.datetime.now())
418
def submit(self, principal, path, revision):
419
if not self.can_submit(principal):
420
raise Exception('cannot submit')
635
422
a = Assessed.get(Store.of(self), principal, self)
636
423
ps = ProjectSubmission()
637
# Raise SubmissionError if the path is illegal
638
ps.path = ProjectSubmission.test_and_normalise_path(path)
639
425
ps.revision = revision
640
426
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)
687
432
class ProjectGroup(Storm):
688
"""A group of students working together on a project."""
690
433
__storm_table__ = "project_group"
692
435
id = Int(name="groupid", primary=True)
713
456
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."""
457
return '%s (%s)' % (self.nick, self.name)
722
459
def get_projects(self, offering=None, active_only=True):
723
'''Find projects that the group can submit.
460
'''Return Projects that the group can submit.
725
462
This will include projects in the project set which owns this group,
726
463
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.
466
Unless active_only is False, projects will only be returned if the
467
group's offering is active.
469
If an offering is specified, projects will only be returned if it
732
472
return Store.of(self).find(Project,
733
473
Project.project_set_id == ProjectSet.id,
734
474
ProjectSet.id == self.project_set.id,
735
ProjectSet.max_students_per_group != None,
475
ProjectSet.max_students_per_group > 0,
736
476
ProjectSet.offering_id == Offering.id,
737
477
(offering is None) or (Offering.id == offering.id),
738
478
Semester.id == Offering.semester_id,
739
479
(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):
482
def get_permissions(self, user):
753
483
if user.admin or user in self.members:
754
484
return set(['submit_project'])
758
488
class ProjectGroupMembership(Storm):
759
"""A student's membership in a project group."""
761
489
__storm_table__ = "group_member"
762
490
__storm_primary__ = "user_id", "project_group_id"
791
513
project = Reference(project_id, Project.id)
793
515
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
794
submissions = ReferenceSet(
795
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
516
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
797
518
def __repr__(self):
798
519
return "<%s %r in %r>" % (type(self).__name__,
799
520
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
523
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.
828
524
t = type(principal)
829
525
if t not in (User, ProjectGroup):
830
526
raise AssertionError('principal must be User or ProjectGroup')
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
545
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
546
__storm_table__ = "project_extension"
865
548
id = Int(name="extensionid", primary=True)
866
549
assessed_id = Int(name="assessedid")
867
550
assessed = Reference(assessed_id, Assessed.id)
551
deadline = DateTime()
869
552
approver_id = Int(name="approver")
870
553
approver = Reference(approver_id, User.id)
871
554
notes = Unicode()
874
"""Delete the extension."""
875
Store.of(self).remove(self)
877
class SubmissionError(Exception):
878
"""Denotes a validation error during submission."""
881
556
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
557
__storm_table__ = "project_submission"
893
559
id = Int(name="submissionid", primary=True)
895
561
assessed = Reference(assessed_id, Assessed.id)
898
submitter_id = Int(name="submitter")
899
submitter = Reference(submitter_id, User.id)
900
564
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)
967
567
# WORKSHEETS AND EXERCISES #
969
569
class Exercise(Storm):
970
"""An exercise for students to complete in a worksheet.
972
An exercise may be present in any number of worksheets.
975
570
__storm_table__ = "exercise"
976
571
id = Unicode(primary=True, name="identifier")
978
573
description = Unicode()
979
_description_xhtml_cache = Unicode(name='description_xhtml_cache')
980
574
partial = Unicode()
981
575
solution = Unicode()
982
576
include = Unicode()
1000
594
def __repr__(self):
1001
595
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
597
def get_permissions(self, user):
1013
600
if user is not None:
1015
602
perms.add('edit')
1016
603
perms.add('view')
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
604
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
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)
610
def get_description(self):
611
return rst(self.description)
1048
613
def delete(self):
1049
614
"""Deletes the exercise, providing it has no associated worksheets."""
1091
649
def __repr__(self):
1092
650
return "<%s %s>" % (type(self).__name__, self.name)
652
# XXX Refactor this - make it an instance method of Subject rather than a
653
# class method of Worksheet. Can't do that now because Subject isn't
654
# linked referentially to the Worksheet.
656
def get_by_name(cls, store, subjectname, worksheetname):
658
Get the Worksheet from the db associated with a given store, subject
659
name and worksheet name.
661
return store.find(cls, cls.subject == unicode(subjectname),
662
cls.name == unicode(worksheetname)).one()
1094
664
def remove_all_exercises(self):
1095
"""Remove all exercises from this worksheet.
666
Remove all exercises from this worksheet.
1097
667
This does not delete the exercises themselves. It just removes them
1098
668
from the worksheet.
1103
673
raise IntegrityError()
1104
674
store.find(WorksheetExercise,
1105
675
WorksheetExercise.worksheet == self).remove()
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
677
def get_permissions(self, user):
678
return self.offering.get_permissions(user)
681
"""Returns the xml of this worksheet, converts from rst if required."""
682
if self.format == u'rst':
683
ws_xml = rst(self.data)
1143
686
return self.data
1145
def set_data(self, data):
1147
self._cache_data_xhtml(invalidate=True)
1149
688
def delete(self):
1150
689
"""Deletes the worksheet, provided it has no attempts on any exercises.
1152
691
Returns True if delete succeeded, or False if this worksheet has
1153
692
attempts attached."""
1154
693
for ws_ex in self.all_worksheet_exercises:
1155
694
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
1156
695
raise IntegrityError()
1158
697
self.remove_all_exercises()
1159
698
Store.of(self).remove(self)
1161
700
class WorksheetExercise(Storm):
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
701
__storm_table__ = "worksheet_exercise"
1171
703
id = Int(primary=True, name="ws_ex_id")
1173
705
worksheet_id = Int(name="worksheetid")
1187
719
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1188
720
self.worksheet.identifier)
1190
def get_permissions(self, user, config):
1191
return self.worksheet.get_permissions(user, config)
722
def get_permissions(self, user):
723
return self.worksheet.get_permissions(user)
1194
726
class ExerciseSave(Storm):
1195
"""A potential exercise solution submitted by a user for storage.
1197
This is not an actual tested attempt at an exercise, it's just a save of
1198
the editing session.
728
Represents a potential solution to an exercise that a user has submitted
729
to the server for storage.
730
A basic ExerciseSave is just the current saved text for this exercise for
731
this user (doesn't count towards their attempts).
732
ExerciseSave may be extended with additional semantics (such as
1201
735
__storm_table__ = "exercise_save"
1202
736
__storm_primary__ = "ws_ex_id", "user_id"
1214
748
def __repr__(self):
1215
749
return "<%s %s by %s at %s>" % (type(self).__name__,
1216
self.worksheet_exercise.exercise.name, self.user.login,
1217
self.date.strftime("%c"))
750
self.exercise.name, self.user.login, self.date.strftime("%c"))
1219
752
class ExerciseAttempt(ExerciseSave):
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.
754
An ExerciseAttempt is a special case of an ExerciseSave. Like an
755
ExerciseSave, it constitutes exercise solution data that the user has
756
submitted to the server for storage.
757
In addition, it contains additional information about the submission.
758
complete - True if this submission was successful, rendering this exercise
759
complete for this user.
760
active - True if this submission is "active" (usually true). Submissions
761
may be de-activated by privileged users for special reasons, and then
762
they won't count (either as a penalty or success), but will still be
1236
765
__storm_table__ = "exercise_attempt"
1237
766
__storm_primary__ = "ws_ex_id", "user_id", "date"
1241
770
text = Unicode(name="attempt")
1242
771
complete = Bool()
1245
def get_permissions(self, user, config):
774
def get_permissions(self, user):
1246
775
return set(['view']) if user is self.user else set()
1248
777
class TestSuite(Storm):
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.
778
"""A Testsuite acts as a container for the test cases of an exercise."""
1255
779
__storm_table__ = "test_suite"
1256
780
__storm_primary__ = "exercise_id", "suiteid"
1259
783
exercise_id = Unicode(name="exerciseid")
1260
784
description = Unicode()
1264
788
exercise = Reference(exercise_id, Exercise.id)
1265
789
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1266
790
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1268
792
def delete(self):
1269
793
"""Delete this suite, without asking questions."""
1270
for variable in self.variables:
794
for vaariable in self.variables:
1271
795
variable.delete()
1272
796
for test_case in self.test_cases:
1273
797
test_case.delete()
1274
798
Store.of(self).remove(self)
1276
800
class TestCase(Storm):
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."""
801
"""A TestCase is a member of a TestSuite.
803
It contains the data necessary to check if an exercise is correct"""
1281
804
__storm_table__ = "test_case"
1282
805
__storm_primary__ = "testid", "suiteid"
1286
809
suite = Reference(suiteid, "TestSuite.suiteid")
1287
810
passmsg = Unicode()
1288
811
failmsg = Unicode()
1289
test_default = Unicode() # Currently unused - only used for file matching.
812
test_default = Unicode()
1292
815
parts = ReferenceSet(testid, "TestCasePart.testid")
1294
817
__init__ = _kwarg_init
1296
819
def delete(self):
1297
820
for part in self.parts:
1299
822
Store.of(self).remove(self)
1301
824
class TestSuiteVar(Storm):
1302
"""A variable used by an exercise test suite.
1304
This may represent a function argument or a normal variable.
825
"""A container for the arguments of a Test Suite"""
1307
826
__storm_table__ = "suite_variable"
1308
827
__storm_primary__ = "varid"
1312
831
var_name = Unicode()
1313
832
var_value = Unicode()
1314
833
var_type = Unicode()
1317
836
suite = Reference(suiteid, "TestSuite.suiteid")
1319
838
__init__ = _kwarg_init
1321
840
def delete(self):
1322
841
Store.of(self).remove(self)
1324
843
class TestCasePart(Storm):
1325
"""An actual piece of code to test an exercise solution."""
844
"""A container for the test elements of a Test Case"""
1327
845
__storm_table__ = "test_case_part"
1328
846
__storm_primary__ = "partid"
1333
851
part_type = Unicode()
1334
852
test_type = Unicode()
1335
853
data = Unicode()
1336
854
filename = Unicode()
1338
856
test = Reference(testid, "TestCase.testid")
1340
858
__init__ = _kwarg_init
1342
860
def delete(self):
1343
861
Store.of(self).remove(self)
added
removed
ivle/database.py
