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.
29
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
30
31
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',
41
40
'Exercise', 'Worksheet', 'WorksheetExercise',
42
41
'ExerciseSave', 'ExerciseAttempt',
43
'TestCase', 'TestSuite', 'TestSuiteVar'
42
'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
46
45
def _kwarg_init(self, **kwargs):
50
49
% (self.__class__.__name__, k))
51
50
setattr(self, k, v)
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
69
clusterstr += '%s:%d' % (host, port)
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)))
52
def get_conn_string():
54
Returns the Storm connection string, generated from the conf file.
56
return "postgres://%s:%s@%s:%d/%s" % (ivle.conf.db_user,
57
ivle.conf.db_password, ivle.conf.db_host, ivle.conf.db_port,
62
Open a database connection and transaction. Return a storm.store.Store
63
instance connected to the configured IVLE database.
65
return Store(create_database(get_conn_string()))
83
"""An IVLE user account."""
71
Represents an IVLE user.
84
73
__storm_table__ = "login"
86
75
id = Int(primary=True, name="loginid")
88
77
passhash = Unicode()
93
82
pass_exp = DateTime()
197
188
'''A sanely ordered list of all of the user's enrolments.'''
198
189
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)
222
192
def hash_password(password):
223
"""Hash a password with MD5."""
224
return hashlib.md5(password).hexdigest()
193
return md5.md5(password).hexdigest()
227
196
def get_by_login(cls, store, login):
228
"""Find a user in a store by login name."""
198
Get the User from the db associated with a given store and
229
201
return store.find(cls, cls.login == unicode(login)).one()
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'])
203
def get_permissions(self, user):
204
if user and user.rolenm == 'admin' or user is self:
205
return set(['view', 'edit'])
240
return set(['view_public'])
242
209
# SUBJECTS AND ENROLMENTS #
244
211
class Subject(Storm):
245
"""A subject (or course) which is run in some semesters."""
247
212
__storm_table__ = "subject"
249
214
id = Int(primary=True, name="subjectid")
250
215
code = Unicode(name="subj_code")
251
216
name = Unicode(name="subj_name")
252
217
short_name = Unicode(name="subj_short_name")
254
220
offerings = ReferenceSet(id, 'Offering.subject_id')
258
224
def __repr__(self):
259
225
return "<%s '%s'>" % (type(self).__name__, self.short_name)
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.
227
def get_permissions(self, user):
268
229
if user is not None:
269
230
perms.add('view')
231
if user.rolenm == 'admin':
271
232
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()
294
235
class Semester(Storm):
295
"""A semester in which subjects can be run."""
297
236
__storm_table__ = "semester"
299
238
id = Int(primary=True, name="semesterid")
301
240
semester = Unicode()
304
243
offerings = ReferenceSet(id, 'Offering.semester_id')
305
enrolments = ReferenceSet(id,
306
'Offering.semester_id',
308
'Enrolment.offering_id')
310
245
__init__ = _kwarg_init
348
272
return "<%s %r in %r>" % (type(self).__name__, self.subject,
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):
275
def enrol(self, user):
276
'''Enrol a user in this offering.'''
277
# We'll get a horrible database constraint violation error if we try
278
# to add a second enrolment.
279
if Store.of(self).find(Enrolment,
280
Enrolment.user_id == user.id,
281
Enrolment.offering_id == self.id).count() == 1:
282
raise AlreadyEnrolledError()
284
e = Enrolment(user=user, offering=self, active=True)
285
self.enrolments.add(e)
287
def get_permissions(self, user):
377
289
if user is not None:
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
291
if user.rolenm == 'admin':
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
295
class Enrolment(Storm):
429
"""An enrolment of a user in an offering.
431
This represents the roles of both staff and students.
434
296
__storm_table__ = "enrolment"
435
297
__storm_primary__ = "user_id", "offering_id"
481
339
return "<%s %d in %r>" % (type(self).__name__, self.id,
484
def get_permissions(self, user, config):
485
return self.offering.get_permissions(user, config)
487
def get_groups_for_user(self, user):
488
"""List all groups in this offering of which the user is a member."""
490
return Store.of(self).find(
492
ProjectGroupMembership.user_id == user.id,
493
ProjectGroupMembership.project_group_id == ProjectGroup.id,
494
ProjectGroup.project_set_id == self.id)
496
def get_submission_principal(self, user):
497
"""Get the principal on behalf of which the user can submit.
499
If this is a solo project set, the given user is returned. If
500
the user is a member of exactly one group, all the group is
501
returned. Otherwise, None is returned.
504
groups = self.get_groups_for_user(user)
505
if groups.count() == 1:
514
return self.max_students_per_group is not None
518
"""Get the entities (groups or users) assigned to submit this project.
520
This will be a Storm ResultSet.
522
#If its a solo project, return everyone in offering
524
return self.project_groups
526
return self.offering.students
528
class DeadlinePassed(Exception):
529
"""An exception indicating that a project cannot be submitted because the
530
deadline has passed."""
534
return "The project deadline has passed"
536
342
class Project(Storm):
537
"""A student project for which submissions can be made."""
539
343
__storm_table__ = "project"
541
345
id = Int(name="projectid", primary=True)
543
short_name = Unicode()
544
346
synopsis = Unicode()
546
348
project_set_id = Int(name="projectsetid")
547
349
project_set = Reference(project_set_id, ProjectSet.id)
548
350
deadline = DateTime()
550
assesseds = ReferenceSet(id, 'Assessed.project_id')
551
submissions = ReferenceSet(id,
552
'Assessed.project_id',
554
'ProjectSubmission.assessed_id')
556
352
__init__ = _kwarg_init
558
354
def __repr__(self):
559
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
355
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
560
356
self.project_set.offering)
562
def can_submit(self, principal, user):
563
return (self in principal.get_projects() and
564
not self.has_deadline_passed(user))
566
def submit(self, principal, path, revision, who):
567
"""Submit a Subversion path and revision to a project.
569
@param principal: The owner of the Subversion repository, and the
570
entity on behalf of whom the submission is being made
571
@param path: A path within that repository to submit.
572
@param revision: The revision of that path to submit.
573
@param who: The user who is actually making the submission.
576
if not self.can_submit(principal, who):
577
raise DeadlinePassed()
579
a = Assessed.get(Store.of(self), principal, self)
580
ps = ProjectSubmission()
582
ps.revision = revision
583
ps.date_submitted = datetime.datetime.now()
589
def get_permissions(self, user, config):
590
return self.project_set.offering.get_permissions(user, config)
593
def latest_submissions(self):
594
"""Return the latest submission for each Assessed."""
595
return Store.of(self).find(ProjectSubmission,
596
Assessed.project_id == self.id,
597
ProjectSubmission.assessed_id == Assessed.id,
598
ProjectSubmission.date_submitted == Select(
599
Max(ProjectSubmission.date_submitted),
600
ProjectSubmission.assessed_id == Assessed.id,
601
tables=ProjectSubmission
605
def has_deadline_passed(self, user):
606
"""Check whether the deadline has passed."""
607
# XXX: Need to respect extensions.
608
return self.deadline < datetime.datetime.now()
610
def get_submissions_for_principal(self, principal):
611
"""Fetch a ResultSet of all submissions by a particular principal."""
612
assessed = Assessed.get(Store.of(self), principal, self)
615
return assessed.submissions
619
358
class ProjectGroup(Storm):
620
"""A group of students working together on a project."""
622
359
__storm_table__ = "project_group"
624
361
id = Int(name="groupid", primary=True)
641
378
return "<%s %s in %r>" % (type(self).__name__, self.name,
642
379
self.project_set.offering)
645
def display_name(self):
646
"""Returns the "nice name" of the user or group."""
650
def short_name(self):
651
"""Returns the database "identifier" name of the user or group."""
654
def get_projects(self, offering=None, active_only=True):
655
'''Find projects that the group can submit.
657
This will include projects in the project set which owns this group,
658
unless the project set disallows groups (in which case none will be
661
@param active_only: Whether to only search active offerings.
662
@param offering: An optional offering to restrict the search to.
664
return Store.of(self).find(Project,
665
Project.project_set_id == ProjectSet.id,
666
ProjectSet.id == self.project_set.id,
667
ProjectSet.max_students_per_group != None,
668
ProjectSet.offering_id == Offering.id,
669
(offering is None) or (Offering.id == offering.id),
670
Semester.id == Offering.semester_id,
671
(not active_only) or (Semester.state == u'current'))
674
def get_permissions(self, user, config):
675
if user.admin or user in self.members:
676
return set(['submit_project'])
680
381
class ProjectGroupMembership(Storm):
681
"""A student's membership in a project group."""
683
382
__storm_table__ = "group_member"
684
383
__storm_primary__ = "user_id", "project_group_id"
694
393
return "<%s %r in %r>" % (type(self).__name__, self.user,
695
394
self.project_group)
697
class Assessed(Storm):
698
"""A composite of a user or group combined with a project.
700
Each project submission and extension refers to an Assessed. It is the
701
sole specifier of the repository and project.
704
__storm_table__ = "assessed"
706
id = Int(name="assessedid", primary=True)
707
user_id = Int(name="loginid")
708
user = Reference(user_id, User.id)
709
project_group_id = Int(name="groupid")
710
project_group = Reference(project_group_id, ProjectGroup.id)
712
project_id = Int(name="projectid")
713
project = Reference(project_id, Project.id)
715
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
716
submissions = ReferenceSet(
717
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
720
return "<%s %r in %r>" % (type(self).__name__,
721
self.user or self.project_group, self.project)
725
"""True if the Assessed is a group, False if it is a user."""
726
return self.project_group is not None
730
return self.project_group or self.user
733
def checkout_location(self):
734
"""Returns the location of the Subversion workspace for this piece of
735
assessment, relative to each group member's home directory."""
736
subjectname = self.project.project_set.offering.subject.short_name
738
checkout_dir_name = self.principal.short_name
740
checkout_dir_name = "mywork"
741
return subjectname + "/" + checkout_dir_name
744
def get(cls, store, principal, project):
745
"""Find or create an Assessed for the given user or group and project.
747
@param principal: The user or group.
748
@param project: The project.
751
if t not in (User, ProjectGroup):
752
raise AssertionError('principal must be User or ProjectGroup')
755
(t is User) or (cls.project_group_id == principal.id),
756
(t is ProjectGroup) or (cls.user_id == principal.id),
757
cls.project_id == project.id).one()
764
a.project_group = principal
771
class ProjectExtension(Storm):
772
"""An extension granted to a user or group on a particular project.
774
The user or group and project are specified by the Assessed.
777
__storm_table__ = "project_extension"
779
id = Int(name="extensionid", primary=True)
780
assessed_id = Int(name="assessedid")
781
assessed = Reference(assessed_id, Assessed.id)
782
deadline = DateTime()
783
approver_id = Int(name="approver")
784
approver = Reference(approver_id, User.id)
787
class ProjectSubmission(Storm):
788
"""A submission from a user or group repository to a particular project.
790
The content of a submission is a single path and revision inside a
791
repository. The repository is that owned by the submission's user and
792
group, while the path and revision are explicit.
794
The user or group and project are specified by the Assessed.
797
__storm_table__ = "project_submission"
799
id = Int(name="submissionid", primary=True)
800
assessed_id = Int(name="assessedid")
801
assessed = Reference(assessed_id, Assessed.id)
804
submitter_id = Int(name="submitter")
805
submitter = Reference(submitter_id, User.id)
806
date_submitted = DateTime()
808
def get_verify_url(self, user):
809
"""Get the URL for verifying this submission, within the account of
811
# If this is a solo project, then self.path will be prefixed with the
812
# subject name. Remove the first path segment.
813
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
814
if not self.assessed.is_group:
815
if '/' in submitpath:
816
submitpath = submitpath.split('/', 1)[1]
819
return "/files/%s/%s/%s?r=%d" % (user.login,
820
self.assessed.checkout_location, submitpath, self.revision)
822
396
# WORKSHEETS AND EXERCISES #
824
398
class Exercise(Storm):
825
"""An exercise for students to complete in a worksheet.
827
An exercise may be present in any number of worksheets.
830
__storm_table__ = "exercise"
399
# Note: Table "problem" is called "Exercise" in the Object layer, since
400
# it's called that everywhere else.
401
__storm_table__ = "problem"
402
#TODO: Add in a field for the user-friendly identifier
831
403
id = Unicode(primary=True, name="identifier")
833
405
description = Unicode()
836
408
include = Unicode()
839
worksheet_exercises = ReferenceSet(id,
840
'WorksheetExercise.exercise_id')
842
411
worksheets = ReferenceSet(id,
843
412
'WorksheetExercise.exercise_id',
844
413
'WorksheetExercise.worksheet_id',
848
test_suites = ReferenceSet(id,
849
'TestSuite.exercise_id',
417
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
852
419
__init__ = _kwarg_init
854
421
def __repr__(self):
855
422
return "<%s %s>" % (type(self).__name__, self.name)
857
def get_permissions(self, user, config):
858
return self.global_permissions(user, config)
861
def global_permissions(user, config):
862
"""Gets the set of permissions this user has over *all* exercises.
863
This is used to determine who may view the exercises list, and create
871
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
874
elif (config['policy']['tutors_can_edit_worksheets']
875
and u'tutor' in set((e.role for e in user.active_enrolments))):
876
# Site-specific policy on the role of tutors
882
def get_description(self):
883
"""Return the description interpreted as reStructuredText."""
884
return rst(self.description)
887
"""Deletes the exercise, providing it has no associated worksheets."""
888
if (self.worksheet_exercises.count() > 0):
889
raise IntegrityError()
890
for suite in self.test_suites:
892
Store.of(self).remove(self)
894
425
class Worksheet(Storm):
895
"""A worksheet with exercises for students to complete.
897
Worksheets are owned by offerings.
900
426
__storm_table__ = "worksheet"
902
428
id = Int(primary=True, name="worksheetid")
429
# XXX subject is not linked to a Subject object. This is a property of
430
# the database, and will be refactored.
903
431
offering_id = Int(name="offeringid")
904
identifier = Unicode()
432
name = Unicode(name="identifier")
906
433
assessable = Bool()
911
436
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
912
437
offering = Reference(offering_id, 'Offering.id')
914
all_worksheet_exercises = ReferenceSet(id,
439
exercises = ReferenceSet(id,
440
'WorksheetExercise.worksheet_id',
441
'WorksheetExercise.exercise_id',
443
# Use worksheet_exercises to get access to the WorksheetExercise objects
444
# binding worksheets to exercises. This is required to access the
446
worksheet_exercises = ReferenceSet(id,
915
447
'WorksheetExercise.worksheet_id')
917
# Use worksheet_exercises to get access to the *active* WorksheetExercise
918
# objects binding worksheets to exercises. This is required to access the
922
def worksheet_exercises(self):
923
return self.all_worksheet_exercises.find(active=True)
925
450
__init__ = _kwarg_init
927
452
def __repr__(self):
928
453
return "<%s %s>" % (type(self).__name__, self.name)
930
def remove_all_exercises(self):
931
"""Remove all exercises from this worksheet.
455
# XXX Refactor this - make it an instance method of Subject rather than a
456
# class method of Worksheet. Can't do that now because Subject isn't
457
# linked referentially to the Worksheet.
459
def get_by_name(cls, store, subjectname, worksheetname):
461
Get the Worksheet from the db associated with a given store, subject
462
name and worksheet name.
464
return store.find(cls, cls.subject == unicode(subjectname),
465
cls.name == unicode(worksheetname)).one()
467
def remove_all_exercises(self, store):
469
Remove all exercises from this worksheet.
933
470
This does not delete the exercises themselves. It just removes them
934
471
from the worksheet.
936
store = Store.of(self)
937
for ws_ex in self.all_worksheet_exercises:
938
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
939
raise IntegrityError()
940
473
store.find(WorksheetExercise,
941
474
WorksheetExercise.worksheet == self).remove()
943
def get_permissions(self, user, config):
944
# Almost the same permissions as for the offering itself
945
perms = self.offering.get_permissions(user, config)
946
# However, "edit" permission is derived from the "edit_worksheets"
947
# permission of the offering
948
if 'edit_worksheets' in perms:
951
perms.discard('edit')
955
"""Returns the xml of this worksheet, converts from rst if required."""
956
if self.format == u'rst':
957
ws_xml = rst(self.data)
963
"""Deletes the worksheet, provided it has no attempts on any exercises.
965
Returns True if delete succeeded, or False if this worksheet has
966
attempts attached."""
967
for ws_ex in self.all_worksheet_exercises:
968
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
969
raise IntegrityError()
971
self.remove_all_exercises()
972
Store.of(self).remove(self)
476
def get_permissions(self, user):
477
return self.offering.get_permissions(user)
974
479
class WorksheetExercise(Storm):
975
"""A link between a worksheet and one of its exercises.
977
These may be marked optional, in which case the exercise does not count
978
for marking purposes. The sequence number is used to order the worksheet
982
__storm_table__ = "worksheet_exercise"
984
id = Int(primary=True, name="ws_ex_id")
480
__storm_table__ = "worksheet_problem"
481
__storm_primary__ = "worksheet_id", "exercise_id"
986
483
worksheet_id = Int(name="worksheetid")
987
484
worksheet = Reference(worksheet_id, Worksheet.id)
988
exercise_id = Unicode(name="exerciseid")
485
exercise_id = Unicode(name="problemid")
989
486
exercise = Reference(exercise_id, Exercise.id)
990
487
optional = Bool()
994
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
995
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
997
489
__init__ = _kwarg_init
999
491
def __repr__(self):
1000
492
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1001
self.worksheet.identifier)
1003
def get_permissions(self, user, config):
1004
return self.worksheet.get_permissions(user, config)
1007
495
class ExerciseSave(Storm):
1008
"""A potential exercise solution submitted by a user for storage.
1010
This is not an actual tested attempt at an exercise, it's just a save of
1011
the editing session.
1014
__storm_table__ = "exercise_save"
1015
__storm_primary__ = "ws_ex_id", "user_id"
1017
ws_ex_id = Int(name="ws_ex_id")
1018
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
497
Represents a potential solution to an exercise that a user has submitted
498
to the server for storage.
499
A basic ExerciseSave is just the current saved text for this exercise for
500
this user (doesn't count towards their attempts).
501
ExerciseSave may be extended with additional semantics (such as
504
__storm_table__ = "problem_save"
505
__storm_primary__ = "exercise_id", "user_id", "date"
507
exercise_id = Unicode(name="problemid")
508
exercise = Reference(exercise_id, Exercise.id)
1020
509
user_id = Int(name="loginid")
1021
510
user = Reference(user_id, User.id)
1022
511
date = DateTime()
1023
512
text = Unicode()
514
worksheet = Reference(worksheetid, Worksheet.id)
1025
516
__init__ = _kwarg_init
1029
520
self.exercise.name, self.user.login, self.date.strftime("%c"))
1031
522
class ExerciseAttempt(ExerciseSave):
1032
"""An attempt at solving an exercise.
1034
This is a special case of ExerciseSave, used when the user submits a
1035
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1038
In addition, it contains information about the result of the submission:
1040
- complete - True if this submission was successful, rendering this
1041
exercise complete for this user in this worksheet.
1042
- active - True if this submission is "active" (usually true).
1043
Submissions may be de-activated by privileged users for
1044
special reasons, and then they won't count (either as a
1045
penalty or success), but will still be stored.
1048
__storm_table__ = "exercise_attempt"
1049
__storm_primary__ = "ws_ex_id", "user_id", "date"
524
An ExerciseAttempt is a special case of an ExerciseSave. Like an
525
ExerciseSave, it constitutes exercise solution data that the user has
526
submitted to the server for storage.
527
In addition, it contains additional information about the submission.
528
complete - True if this submission was successful, rendering this exercise
529
complete for this user.
530
active - True if this submission is "active" (usually true). Submissions
531
may be de-activated by privileged users for special reasons, and then
532
they won't count (either as a penalty or success), but will still be
535
__storm_table__ = "problem_attempt"
536
__storm_primary__ = "exercise_id", "user_id", "date"
1051
538
# The "text" field is the same but has a different name in the DB table
1052
539
# for some reason.
1053
540
text = Unicode(name="attempt")
1054
541
complete = Bool()
1057
def get_permissions(self, user, config):
544
def get_permissions(self, user):
1058
545
return set(['view']) if user is self.user else set()
1060
547
class TestSuite(Storm):
1061
"""A container to group an exercise's test cases.
1063
The test suite contains some information on how to test. The function to
1064
test, variables to set and stdin data are stored here.
548
"""A Testsuite acts as a container for the test cases of an exercise."""
1067
549
__storm_table__ = "test_suite"
1068
550
__storm_primary__ = "exercise_id", "suiteid"
1071
exercise_id = Unicode(name="exerciseid")
553
exercise_id = Unicode(name="problemid")
1072
554
description = Unicode()
1074
556
function = Unicode()
1075
557
stdin = Unicode()
1076
558
exercise = Reference(exercise_id, Exercise.id)
1077
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1078
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1081
"""Delete this suite, without asking questions."""
1082
for variable in self.variables:
1084
for test_case in self.test_cases:
1086
Store.of(self).remove(self)
559
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
560
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1088
562
class TestCase(Storm):
1089
"""A container for actual tests (see TestCasePart), inside a test suite.
1091
It is the lowest level shown to students on their pass/fail status."""
563
"""A TestCase is a member of a TestSuite.
565
It contains the data necessary to check if an exercise is correct"""
1093
566
__storm_table__ = "test_case"
1094
567
__storm_primary__ = "testid", "suiteid"
1098
571
suite = Reference(suiteid, "TestSuite.suiteid")
1099
572
passmsg = Unicode()
1100
573
failmsg = Unicode()
1101
test_default = Unicode() # Currently unused - only used for file matching.
574
test_default = Unicode()
1104
577
parts = ReferenceSet(testid, "TestCasePart.testid")
1106
579
__init__ = _kwarg_init
1109
for part in self.parts:
1111
Store.of(self).remove(self)
1113
581
class TestSuiteVar(Storm):
1114
"""A variable used by an exercise test suite.
1116
This may represent a function argument or a normal variable.
1119
__storm_table__ = "suite_variable"
582
"""A container for the arguments of a Test Suite"""
583
__storm_table__ = "suite_variables"
1120
584
__storm_primary__ = "varid"
1124
588
var_name = Unicode()
1125
589
var_value = Unicode()
1126
590
var_type = Unicode()
1129
593
suite = Reference(suiteid, "TestSuite.suiteid")
1131
595
__init__ = _kwarg_init
1134
Store.of(self).remove(self)
1136
597
class TestCasePart(Storm):
1137
"""An actual piece of code to test an exercise solution."""
1139
__storm_table__ = "test_case_part"
598
"""A container for the test elements of a Test Case"""
599
__storm_table__ = "test_case_parts"
1140
600
__storm_primary__ = "partid"
1145
605
part_type = Unicode()
1146
606
test_type = Unicode()
1147
607
data = Unicode()
1148
608
filename = Unicode()
1150
610
test = Reference(testid, "TestCase.testid")
1152
612
__init__ = _kwarg_init
1155
Store.of(self).remove(self)
added
removed
ivle/database.py
