18
18
# Author: Matt Giuca, Will Grant
21
Database Classes and Utilities for Storm ORM
20
"""Database utilities and content classes.
23
22
This module provides all of the classes which map to database tables.
24
23
It also provides miscellaneous utility functions for database interaction.
30
29
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
30
Reference, ReferenceSet, Bool, Storm, Desc
31
from storm.expr import Select, Max
32
from storm.exceptions import NotOneError, IntegrityError
34
from ivle.worksheet.rst import rst
36
36
__all__ = ['get_store',
38
38
'Subject', 'Semester', 'Offering', 'Enrolment',
39
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
41
'Exercise', 'Worksheet', 'WorksheetExercise',
41
42
'ExerciseSave', 'ExerciseAttempt',
42
'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
43
'TestCase', 'TestSuite', 'TestSuiteVar'
45
46
def _kwarg_init(self, **kwargs):
49
50
% (self.__class__.__name__, k))
50
51
setattr(self, k, v)
52
def get_conn_string():
54
Returns the Storm connection string, generated from the conf file.
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
59
clusterstr += ivle.conf.db_user
60
if ivle.conf.db_password:
61
clusterstr += ':' + ivle.conf.db_password
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
64
host = ivle.conf.db_host or 'localhost'
65
port = ivle.conf.db_port or 5432
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
67
69
clusterstr += '%s:%d' % (host, port)
69
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
73
Open a database connection and transaction. Return a storm.store.Store
74
instance connected to the configured IVLE database.
76
return Store(create_database(get_conn_string()))
71
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
73
def get_store(config):
74
"""Create a Storm store connected to the IVLE database.
76
@param config: The IVLE configuration.
78
return Store(create_database(get_conn_string(config)))
82
Represents an IVLE user.
83
"""An IVLE user account."""
84
84
__storm_table__ = "login"
86
86
id = Int(primary=True, name="loginid")
88
88
passhash = Unicode()
93
93
pass_exp = DateTime()
199
197
'''A sanely ordered list of all of the user's enrolments.'''
200
198
return self._get_enrolments(False)
200
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
203
This will include projects for offerings in which the user is
204
enrolled, as long as the project is not in a project set which has
205
groups (ie. if maximum number of group members is 0).
207
@param active_only: Whether to only search active offerings.
208
@param offering: An optional offering to restrict the search to.
210
return Store.of(self).find(Project,
211
Project.project_set_id == ProjectSet.id,
212
ProjectSet.max_students_per_group == None,
213
ProjectSet.offering_id == Offering.id,
214
(offering is None) or (Offering.id == offering.id),
215
Semester.id == Offering.semester_id,
216
(not active_only) or (Semester.state == u'current'),
217
Enrolment.offering_id == Offering.id,
218
Enrolment.user_id == self.id,
219
Enrolment.active == True)
203
222
def hash_password(password):
204
return md5.md5(password).hexdigest()
223
"""Hash a password with MD5."""
224
return hashlib.md5(password).hexdigest()
207
227
def get_by_login(cls, store, login):
209
Get the User from the db associated with a given store and
228
"""Find a user in a store by login name."""
212
229
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'])
231
def get_permissions(self, user, config):
232
"""Determine privileges held by a user over this object.
234
If the user requesting privileges is this user or an admin,
235
they may do everything. Otherwise they may do nothing.
237
if user and user.admin or user is self:
238
return set(['view_public', 'view', 'edit', 'submit_project'])
240
return set(['view_public'])
220
242
# SUBJECTS AND ENROLMENTS #
222
244
class Subject(Storm):
245
"""A subject (or course) which is run in some semesters."""
223
247
__storm_table__ = "subject"
225
249
id = Int(primary=True, name="subjectid")
226
250
code = Unicode(name="subj_code")
227
251
name = Unicode(name="subj_name")
228
252
short_name = Unicode(name="subj_short_name")
231
254
offerings = ReferenceSet(id, 'Offering.subject_id')
235
258
def __repr__(self):
236
259
return "<%s '%s'>" % (type(self).__name__, self.short_name)
238
def get_permissions(self, user):
261
def get_permissions(self, user, config):
262
"""Determine privileges held by a user over this object.
264
If the user requesting privileges is an admin, they may edit.
265
Otherwise they may only read.
240
268
if user is not None:
241
269
perms.add('view')
242
if user.rolenm == 'admin':
243
271
perms.add('edit')
274
def active_offerings(self):
275
"""Find active offerings for this subject.
277
Return a sequence of currently active offerings for this subject
278
(offerings whose semester.state is "current"). There should be 0 or 1
279
elements in this sequence, but it's possible there are more.
281
return self.offerings.find(Offering.semester_id == Semester.id,
282
Semester.state == u'current')
284
def offering_for_semester(self, year, semester):
285
"""Get the offering for the given year/semester, or None.
287
@param year: A string representation of the year.
288
@param semester: A string representation of the semester.
290
return self.offerings.find(Offering.semester_id == Semester.id,
291
Semester.year == unicode(year),
292
Semester.semester == unicode(semester)).one()
246
294
class Semester(Storm):
295
"""A semester in which subjects can be run."""
247
297
__storm_table__ = "semester"
249
299
id = Int(primary=True, name="semesterid")
251
301
semester = Unicode()
254
304
offerings = ReferenceSet(id, 'Offering.semester_id')
305
enrolments = ReferenceSet(id,
306
'Offering.semester_id',
308
'Enrolment.offering_id')
256
310
__init__ = _kwarg_init
286
348
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):
351
def enrol(self, user, role=u'student'):
352
"""Enrol a user in this offering.
354
Enrolments handle both the staff and student cases. The role controls
355
the privileges granted by this enrolment.
357
enrolment = Store.of(self).find(Enrolment,
358
Enrolment.user_id == user.id,
359
Enrolment.offering_id == self.id).one()
361
if enrolment is None:
362
enrolment = Enrolment(user=user, offering=self)
363
self.enrolments.add(enrolment)
365
enrolment.active = True
366
enrolment.role = role
368
def unenrol(self, user):
369
'''Unenrol a user from this offering.'''
370
enrolment = Store.of(self).find(Enrolment,
371
Enrolment.user_id == user.id,
372
Enrolment.offering_id == self.id).one()
373
Store.of(enrolment).remove(enrolment)
375
def get_permissions(self, user, config):
303
377
if user is not None:
305
if user.rolenm == 'admin':
378
enrolment = self.get_enrolment(user)
379
if enrolment or user.admin:
381
if enrolment and enrolment.role == u'tutor':
382
perms.add('view_project_submissions')
383
# Site-specific policy on the role of tutors
384
if config['policy']['tutors_can_enrol_students']:
386
perms.add('enrol_student')
387
if config['policy']['tutors_can_edit_worksheets']:
388
perms.add('edit_worksheets')
389
if config['policy']['tutors_can_admin_groups']:
390
perms.add('admin_groups')
391
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
392
perms.add('view_project_submissions')
393
perms.add('admin_groups')
394
perms.add('edit_worksheets')
395
perms.add('edit') # Can edit projects & details
396
perms.add('enrol') # Can see enrolment screen at all
397
perms.add('enrol_student') # Can enrol students
398
perms.add('enrol_tutor') # Can enrol tutors
400
perms.add('enrol_lecturer') # Can enrol lecturers
403
def get_enrolment(self, user):
404
"""Find the user's enrolment in this offering."""
406
enrolment = self.enrolments.find(user=user).one()
412
def get_members_by_role(self, role):
413
return Store.of(self).find(User,
414
Enrolment.user_id == User.id,
415
Enrolment.offering_id == self.id,
416
Enrolment.role == role
417
).order_by(User.login)
421
return self.get_members_by_role(u'student')
423
def get_open_projects_for_user(self, user):
424
"""Find all projects currently open to submissions by a user."""
425
# XXX: Respect extensions.
426
return self.projects.find(Project.deadline > datetime.datetime.now())
428
def clone_worksheets(self, source):
429
"""Clone all worksheets from the specified source to this offering."""
430
import ivle.worksheet.utils
431
for worksheet in source.worksheets:
433
newws.seq_no = worksheet.seq_no
434
newws.identifier = worksheet.identifier
435
newws.name = worksheet.name
436
newws.assessable = worksheet.assessable
437
newws.data = worksheet.data
438
newws.format = worksheet.format
439
newws.offering = self
440
Store.of(self).add(newws)
441
ivle.worksheet.utils.update_exerciselist(newws)
309
444
class Enrolment(Storm):
445
"""An enrolment of a user in an offering.
447
This represents the roles of both staff and students.
310
450
__storm_table__ = "enrolment"
311
451
__storm_primary__ = "user_id", "offering_id"
353
510
return "<%s %d in %r>" % (type(self).__name__, self.id,
513
def get_permissions(self, user, config):
514
return self.offering.get_permissions(user, config)
516
def get_groups_for_user(self, user):
517
"""List all groups in this offering of which the user is a member."""
519
return Store.of(self).find(
521
ProjectGroupMembership.user_id == user.id,
522
ProjectGroupMembership.project_group_id == ProjectGroup.id,
523
ProjectGroup.project_set_id == self.id)
525
def get_submission_principal(self, user):
526
"""Get the principal on behalf of which the user can submit.
528
If this is a solo project set, the given user is returned. If
529
the user is a member of exactly one group, all the group is
530
returned. Otherwise, None is returned.
533
groups = self.get_groups_for_user(user)
534
if groups.count() == 1:
543
return self.max_students_per_group is not None
547
"""Get the entities (groups or users) assigned to submit this project.
549
This will be a Storm ResultSet.
551
#If its a solo project, return everyone in offering
553
return self.project_groups
555
return self.offering.students
557
class DeadlinePassed(Exception):
558
"""An exception indicating that a project cannot be submitted because the
559
deadline has passed."""
563
return "The project deadline has passed"
356
565
class Project(Storm):
566
"""A student project for which submissions can be made."""
357
568
__storm_table__ = "project"
359
570
id = Int(name="projectid", primary=True)
572
short_name = Unicode()
360
573
synopsis = Unicode()
362
575
project_set_id = Int(name="projectsetid")
363
576
project_set = Reference(project_set_id, ProjectSet.id)
364
577
deadline = DateTime()
579
assesseds = ReferenceSet(id, 'Assessed.project_id')
580
submissions = ReferenceSet(id,
581
'Assessed.project_id',
583
'ProjectSubmission.assessed_id')
366
585
__init__ = _kwarg_init
368
587
def __repr__(self):
369
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
588
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
370
589
self.project_set.offering)
591
def can_submit(self, principal, user):
592
return (self in principal.get_projects() and
593
not self.has_deadline_passed(user))
595
def submit(self, principal, path, revision, who):
596
"""Submit a Subversion path and revision to a project.
598
@param principal: The owner of the Subversion repository, and the
599
entity on behalf of whom the submission is being made
600
@param path: A path within that repository to submit.
601
@param revision: The revision of that path to submit.
602
@param who: The user who is actually making the submission.
605
if not self.can_submit(principal, who):
606
raise DeadlinePassed()
608
a = Assessed.get(Store.of(self), principal, self)
609
ps = ProjectSubmission()
611
ps.revision = revision
612
ps.date_submitted = datetime.datetime.now()
618
def get_permissions(self, user, config):
619
return self.project_set.offering.get_permissions(user, config)
622
def latest_submissions(self):
623
"""Return the latest submission for each Assessed."""
624
return Store.of(self).find(ProjectSubmission,
625
Assessed.project_id == self.id,
626
ProjectSubmission.assessed_id == Assessed.id,
627
ProjectSubmission.date_submitted == Select(
628
Max(ProjectSubmission.date_submitted),
629
ProjectSubmission.assessed_id == Assessed.id,
630
tables=ProjectSubmission
634
def has_deadline_passed(self, user):
635
"""Check whether the deadline has passed."""
636
# XXX: Need to respect extensions.
637
return self.deadline < datetime.datetime.now()
639
def get_submissions_for_principal(self, principal):
640
"""Fetch a ResultSet of all submissions by a particular principal."""
641
assessed = Assessed.get(Store.of(self), principal, self)
644
return assessed.submissions
372
648
class ProjectGroup(Storm):
649
"""A group of students working together on a project."""
373
651
__storm_table__ = "project_group"
375
653
id = Int(name="groupid", primary=True)
392
670
return "<%s %s in %r>" % (type(self).__name__, self.name,
393
671
self.project_set.offering)
674
def display_name(self):
675
"""Returns the "nice name" of the user or group."""
679
def short_name(self):
680
"""Returns the database "identifier" name of the user or group."""
683
def get_projects(self, offering=None, active_only=True):
684
'''Find projects that the group can submit.
686
This will include projects in the project set which owns this group,
687
unless the project set disallows groups (in which case none will be
690
@param active_only: Whether to only search active offerings.
691
@param offering: An optional offering to restrict the search to.
693
return Store.of(self).find(Project,
694
Project.project_set_id == ProjectSet.id,
695
ProjectSet.id == self.project_set.id,
696
ProjectSet.max_students_per_group != None,
697
ProjectSet.offering_id == Offering.id,
698
(offering is None) or (Offering.id == offering.id),
699
Semester.id == Offering.semester_id,
700
(not active_only) or (Semester.state == u'current'))
703
def get_permissions(self, user, config):
704
if user.admin or user in self.members:
705
return set(['submit_project'])
395
709
class ProjectGroupMembership(Storm):
710
"""A student's membership in a project group."""
396
712
__storm_table__ = "group_member"
397
713
__storm_primary__ = "user_id", "project_group_id"
407
723
return "<%s %r in %r>" % (type(self).__name__, self.user,
408
724
self.project_group)
726
class Assessed(Storm):
727
"""A composite of a user or group combined with a project.
729
Each project submission and extension refers to an Assessed. It is the
730
sole specifier of the repository and project.
733
__storm_table__ = "assessed"
735
id = Int(name="assessedid", primary=True)
736
user_id = Int(name="loginid")
737
user = Reference(user_id, User.id)
738
project_group_id = Int(name="groupid")
739
project_group = Reference(project_group_id, ProjectGroup.id)
741
project_id = Int(name="projectid")
742
project = Reference(project_id, Project.id)
744
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
745
submissions = ReferenceSet(
746
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
749
return "<%s %r in %r>" % (type(self).__name__,
750
self.user or self.project_group, self.project)
754
"""True if the Assessed is a group, False if it is a user."""
755
return self.project_group is not None
759
return self.project_group or self.user
762
def checkout_location(self):
763
"""Returns the location of the Subversion workspace for this piece of
764
assessment, relative to each group member's home directory."""
765
subjectname = self.project.project_set.offering.subject.short_name
767
checkout_dir_name = self.principal.short_name
769
checkout_dir_name = "mywork"
770
return subjectname + "/" + checkout_dir_name
773
def get(cls, store, principal, project):
774
"""Find or create an Assessed for the given user or group and project.
776
@param principal: The user or group.
777
@param project: The project.
780
if t not in (User, ProjectGroup):
781
raise AssertionError('principal must be User or ProjectGroup')
784
(t is User) or (cls.project_group_id == principal.id),
785
(t is ProjectGroup) or (cls.user_id == principal.id),
786
cls.project_id == project.id).one()
793
a.project_group = principal
800
class ProjectExtension(Storm):
801
"""An extension granted to a user or group on a particular project.
803
The user or group and project are specified by the Assessed.
806
__storm_table__ = "project_extension"
808
id = Int(name="extensionid", primary=True)
809
assessed_id = Int(name="assessedid")
810
assessed = Reference(assessed_id, Assessed.id)
811
deadline = DateTime()
812
approver_id = Int(name="approver")
813
approver = Reference(approver_id, User.id)
816
class ProjectSubmission(Storm):
817
"""A submission from a user or group repository to a particular project.
819
The content of a submission is a single path and revision inside a
820
repository. The repository is that owned by the submission's user and
821
group, while the path and revision are explicit.
823
The user or group and project are specified by the Assessed.
826
__storm_table__ = "project_submission"
828
id = Int(name="submissionid", primary=True)
829
assessed_id = Int(name="assessedid")
830
assessed = Reference(assessed_id, Assessed.id)
833
submitter_id = Int(name="submitter")
834
submitter = Reference(submitter_id, User.id)
835
date_submitted = DateTime()
837
def get_verify_url(self, user):
838
"""Get the URL for verifying this submission, within the account of
840
# If this is a solo project, then self.path will be prefixed with the
841
# subject name. Remove the first path segment.
842
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
843
if not self.assessed.is_group:
844
if '/' in submitpath:
845
submitpath = submitpath.split('/', 1)[1]
848
return "/files/%s/%s/%s?r=%d" % (user.login,
849
self.assessed.checkout_location, submitpath, self.revision)
410
851
# WORKSHEETS AND EXERCISES #
412
853
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"
854
"""An exercise for students to complete in a worksheet.
856
An exercise may be present in any number of worksheets.
859
__storm_table__ = "exercise"
416
860
id = Unicode(primary=True, name="identifier")
418
862
description = Unicode()
421
865
include = Unicode()
868
worksheet_exercises = ReferenceSet(id,
869
'WorksheetExercise.exercise_id')
424
871
worksheets = ReferenceSet(id,
425
872
'WorksheetExercise.exercise_id',
426
873
'WorksheetExercise.worksheet_id',
430
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
877
test_suites = ReferenceSet(id,
878
'TestSuite.exercise_id',
432
881
__init__ = _kwarg_init
434
883
def __repr__(self):
435
884
return "<%s %s>" % (type(self).__name__, self.name)
886
def get_permissions(self, user, config):
887
return self.global_permissions(user, config)
890
def global_permissions(user, config):
891
"""Gets the set of permissions this user has over *all* exercises.
892
This is used to determine who may view the exercises list, and create
900
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
903
elif (config['policy']['tutors_can_edit_worksheets']
904
and u'tutor' in set((e.role for e in user.active_enrolments))):
905
# Site-specific policy on the role of tutors
911
def get_description(self):
912
"""Return the description interpreted as reStructuredText."""
913
return rst(self.description)
916
"""Deletes the exercise, providing it has no associated worksheets."""
917
if (self.worksheet_exercises.count() > 0):
918
raise IntegrityError()
919
for suite in self.test_suites:
921
Store.of(self).remove(self)
438
923
class Worksheet(Storm):
924
"""A worksheet with exercises for students to complete.
926
Worksheets are owned by offerings.
439
929
__storm_table__ = "worksheet"
441
931
id = Int(primary=True, name="worksheetid")
450
940
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
451
941
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
943
all_worksheet_exercises = ReferenceSet(id,
944
'WorksheetExercise.worksheet_id')
946
# Use worksheet_exercises to get access to the *active* WorksheetExercise
947
# objects binding worksheets to exercises. This is required to access the
455
948
# "optional" field.
456
worksheet_exercises = ReferenceSet(id,
457
'WorksheetExercise.worksheet_id')
951
def worksheet_exercises(self):
952
return self.all_worksheet_exercises.find(active=True)
460
954
__init__ = _kwarg_init
462
956
def __repr__(self):
463
957
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()
959
def remove_all_exercises(self):
960
"""Remove all exercises from this worksheet.
477
def remove_all_exercises(self, store):
479
Remove all exercises from this worksheet.
480
962
This does not delete the exercises themselves. It just removes them
481
963
from the worksheet.
965
store = Store.of(self)
966
for ws_ex in self.all_worksheet_exercises:
967
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
968
raise IntegrityError()
483
969
store.find(WorksheetExercise,
484
970
WorksheetExercise.worksheet == self).remove()
486
def get_permissions(self, user):
487
return self.offering.get_permissions(user)
972
def get_permissions(self, user, config):
973
# Almost the same permissions as for the offering itself
974
perms = self.offering.get_permissions(user, config)
975
# However, "edit" permission is derived from the "edit_worksheets"
976
# permission of the offering
977
if 'edit_worksheets' in perms:
980
perms.discard('edit')
984
"""Returns the xml of this worksheet, converts from rst if required."""
985
if self.format == u'rst':
986
ws_xml = rst(self.data)
992
"""Deletes the worksheet, provided it has no attempts on any exercises.
994
Returns True if delete succeeded, or False if this worksheet has
995
attempts attached."""
996
for ws_ex in self.all_worksheet_exercises:
997
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
998
raise IntegrityError()
1000
self.remove_all_exercises()
1001
Store.of(self).remove(self)
489
1003
class WorksheetExercise(Storm):
490
__storm_table__ = "worksheet_problem"
492
id = Int(primary=True, name="ws_prob_id")
1004
"""A link between a worksheet and one of its exercises.
1006
These may be marked optional, in which case the exercise does not count
1007
for marking purposes. The sequence number is used to order the worksheet
1011
__storm_table__ = "worksheet_exercise"
1013
id = Int(primary=True, name="ws_ex_id")
494
1015
worksheet_id = Int(name="worksheetid")
495
1016
worksheet = Reference(worksheet_id, Worksheet.id)
496
exercise_id = Unicode(name="problemid")
1017
exercise_id = Unicode(name="exerciseid")
497
1018
exercise = Reference(exercise_id, Exercise.id)
498
1019
optional = Bool()
502
1023
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
503
1024
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
508
1029
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
509
1030
self.worksheet.identifier)
1032
def get_permissions(self, user, config):
1033
return self.worksheet.get_permissions(user, config)
511
1036
class ExerciseSave(Storm):
513
Represents a potential solution to an exercise that a user has submitted
514
to the server for storage.
515
A basic ExerciseSave is just the current saved text for this exercise for
516
this user (doesn't count towards their attempts).
517
ExerciseSave may be extended with additional semantics (such as
520
__storm_table__ = "problem_save"
1037
"""A potential exercise solution submitted by a user for storage.
1039
This is not an actual tested attempt at an exercise, it's just a save of
1040
the editing session.
1043
__storm_table__ = "exercise_save"
521
1044
__storm_primary__ = "ws_ex_id", "user_id"
523
ws_ex_id = Int(name="ws_prob_id")
1046
ws_ex_id = Int(name="ws_ex_id")
524
1047
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
526
1049
user_id = Int(name="loginid")
535
1058
self.exercise.name, self.user.login, self.date.strftime("%c"))
537
1060
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"
1061
"""An attempt at solving an exercise.
1063
This is a special case of ExerciseSave, used when the user submits a
1064
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1067
In addition, it contains information about the result of the submission:
1069
- complete - True if this submission was successful, rendering this
1070
exercise complete for this user in this worksheet.
1071
- active - True if this submission is "active" (usually true).
1072
Submissions may be de-activated by privileged users for
1073
special reasons, and then they won't count (either as a
1074
penalty or success), but will still be stored.
1077
__storm_table__ = "exercise_attempt"
551
1078
__storm_primary__ = "ws_ex_id", "user_id", "date"
553
1080
# The "text" field is the same but has a different name in the DB table
555
1082
text = Unicode(name="attempt")
556
1083
complete = Bool()
559
def get_permissions(self, user):
1086
def get_permissions(self, user, config):
560
1087
return set(['view']) if user is self.user else set()
562
1089
class TestSuite(Storm):
563
"""A Testsuite acts as a container for the test cases of an exercise."""
1090
"""A container to group an exercise's test cases.
1092
The test suite contains some information on how to test. The function to
1093
test, variables to set and stdin data are stored here.
564
1096
__storm_table__ = "test_suite"
565
1097
__storm_primary__ = "exercise_id", "suiteid"
568
exercise_id = Unicode(name="problemid")
1100
exercise_id = Unicode(name="exerciseid")
569
1101
description = Unicode()
571
1103
function = Unicode()
572
1104
stdin = Unicode()
573
1105
exercise = Reference(exercise_id, Exercise.id)
574
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
575
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1106
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1107
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1110
"""Delete this suite, without asking questions."""
1111
for variable in self.variables:
1113
for test_case in self.test_cases:
1115
Store.of(self).remove(self)
577
1117
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"""
1118
"""A container for actual tests (see TestCasePart), inside a test suite.
1120
It is the lowest level shown to students on their pass/fail status."""
581
1122
__storm_table__ = "test_case"
582
1123
__storm_primary__ = "testid", "suiteid"
586
1127
suite = Reference(suiteid, "TestSuite.suiteid")
587
1128
passmsg = Unicode()
588
1129
failmsg = Unicode()
589
test_default = Unicode()
1130
test_default = Unicode() # Currently unused - only used for file matching.
592
1133
parts = ReferenceSet(testid, "TestCasePart.testid")
594
1135
__init__ = _kwarg_init
1138
for part in self.parts:
1140
Store.of(self).remove(self)
596
1142
class TestSuiteVar(Storm):
597
"""A container for the arguments of a Test Suite"""
598
__storm_table__ = "suite_variables"
1143
"""A variable used by an exercise test suite.
1145
This may represent a function argument or a normal variable.
1148
__storm_table__ = "suite_variable"
599
1149
__storm_primary__ = "varid"
603
1153
var_name = Unicode()
604
1154
var_value = Unicode()
605
1155
var_type = Unicode()
608
1158
suite = Reference(suiteid, "TestSuite.suiteid")
610
1160
__init__ = _kwarg_init
1163
Store.of(self).remove(self)
612
1165
class TestCasePart(Storm):
613
"""A container for the test elements of a Test Case"""
614
__storm_table__ = "test_case_parts"
1166
"""An actual piece of code to test an exercise solution."""
1168
__storm_table__ = "test_case_part"
615
1169
__storm_primary__ = "partid"
620
1174
part_type = Unicode()
621
1175
test_type = Unicode()
622
1176
data = Unicode()
623
1177
filename = Unicode()
625
1179
test = Reference(testid, "TestCase.testid")
627
1181
__init__ = _kwarg_init
1184
Store.of(self).remove(self)
added
removed
ivle/database.py
