1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Author: Matt Giuca, Will Grant
20
"""Database utilities and content classes.
22
This module provides all of the classes which map to database tables.
23
It also provides miscellaneous utility functions for database interaction.
29
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
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
__all__ = ['get_store',
38
'Subject', 'Semester', 'Offering', 'Enrolment',
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
'Exercise', 'Worksheet', 'WorksheetExercise',
42
'ExerciseSave', 'ExerciseAttempt',
43
'TestCase', 'TestSuite', 'TestSuiteVar'
46
def _kwarg_init(self, **kwargs):
47
for k,v in kwargs.items():
48
if k.startswith('_') or not hasattr(self.__class__, k):
49
raise TypeError("%s got an unexpected keyword argument '%s'"
50
% (self.__class__.__name__, k))
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)))
83
"""An IVLE user account."""
84
__storm_table__ = "login"
86
id = Int(primary=True, name="loginid")
95
last_login = DateTime()
102
__init__ = _kwarg_init
105
return "<%s '%s'>" % (type(self).__name__, self.login)
107
def authenticate(self, password):
108
"""Validate a given password against this user.
110
Returns True if the given password matches the password hash for this
111
User, False if it doesn't match, and None if there is no hash for the
114
if self.passhash is None:
116
return self.hash_password(password) == self.passhash
119
def display_name(self):
120
"""Returns the "nice name" of the user or group."""
124
def short_name(self):
125
"""Returns the database "identifier" name of the user or group."""
129
def password_expired(self):
130
fieldval = self.pass_exp
131
return fieldval is not None and datetime.datetime.now() > fieldval
134
def account_expired(self):
135
fieldval = self.acct_exp
136
return fieldval is not None and datetime.datetime.now() > fieldval
140
return self.state == 'enabled' and not self.account_expired
142
def _get_enrolments(self, justactive):
143
return Store.of(self).find(Enrolment,
144
Enrolment.user_id == self.id,
145
(Enrolment.active == True) if justactive else True,
146
Enrolment.offering_id == Offering.id,
147
Offering.semester_id == Semester.id,
148
Offering.subject_id == Subject.id).order_by(
150
Desc(Semester.semester),
154
def _set_password(self, password):
158
self.passhash = unicode(User.hash_password(password))
159
password = property(fset=_set_password)
163
return Store.of(self).find(Subject,
164
Enrolment.user_id == self.id,
165
Enrolment.active == True,
166
Offering.id == Enrolment.offering_id,
167
Subject.id == Offering.subject_id).config(distinct=True)
169
# TODO: Invitations should be listed too?
170
def get_groups(self, offering=None):
171
"""Get groups of which this user is a member.
173
@param offering: An optional offering to restrict the search to.
176
ProjectGroupMembership.user_id == self.id,
177
ProjectGroup.id == ProjectGroupMembership.project_group_id,
181
ProjectSet.offering_id == offering.id,
182
ProjectGroup.project_set_id == ProjectSet.id,
184
return Store.of(self).find(ProjectGroup, *preds)
188
return self.get_groups()
191
def active_enrolments(self):
192
'''A sanely ordered list of the user's active enrolments.'''
193
return self._get_enrolments(True)
196
def enrolments(self):
197
'''A sanely ordered list of all of the user's enrolments.'''
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)
221
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
226
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
228
return store.find(cls, cls.login == unicode(login)).one()
230
def get_permissions(self, user):
231
"""Determine privileges held by a user over this object.
233
If the user requesting privileges is this user or an admin,
234
they may do everything. Otherwise they may do nothing.
236
if user and user.admin or user is self:
237
return set(['view_public', 'view', 'edit', 'submit_project'])
239
return set(['view_public'])
241
# SUBJECTS AND ENROLMENTS #
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
__storm_table__ = "subject"
248
id = Int(primary=True, name="subjectid")
249
code = Unicode(name="subj_code")
250
name = Unicode(name="subj_name")
251
short_name = Unicode(name="subj_short_name")
253
offerings = ReferenceSet(id, 'Offering.subject_id')
255
__init__ = _kwarg_init
258
return "<%s '%s'>" % (type(self).__name__, self.short_name)
260
def get_permissions(self, user):
261
"""Determine privileges held by a user over this object.
263
If the user requesting privileges is an admin, they may edit.
264
Otherwise they may only read.
273
def active_offerings(self):
274
"""Find active offerings for this subject.
276
Return a sequence of currently active offerings for this subject
277
(offerings whose semester.state is "current"). There should be 0 or 1
278
elements in this sequence, but it's possible there are more.
280
return self.offerings.find(Offering.semester_id == Semester.id,
281
Semester.state == u'current')
283
def offering_for_semester(self, year, semester):
284
"""Get the offering for the given year/semester, or None.
286
@param year: A string representation of the year.
287
@param semester: A string representation of the semester.
289
return self.offerings.find(Offering.semester_id == Semester.id,
290
Semester.year == unicode(year),
291
Semester.semester == unicode(semester)).one()
293
class Semester(Storm):
294
"""A semester in which subjects can be run."""
296
__storm_table__ = "semester"
298
id = Int(primary=True, name="semesterid")
303
offerings = ReferenceSet(id, 'Offering.semester_id')
304
enrolments = ReferenceSet(id,
305
'Offering.semester_id',
307
'Enrolment.offering_id')
309
__init__ = _kwarg_init
312
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
314
class Offering(Storm):
315
"""An offering of a subject in a particular semester."""
317
__storm_table__ = "offering"
319
id = Int(primary=True, name="offeringid")
320
subject_id = Int(name="subject")
321
subject = Reference(subject_id, Subject.id)
322
semester_id = Int(name="semesterid")
323
semester = Reference(semester_id, Semester.id)
324
description = Unicode()
326
groups_student_permissions = Unicode()
328
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
329
members = ReferenceSet(id,
330
'Enrolment.offering_id',
333
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
334
projects = ReferenceSet(id,
335
'ProjectSet.offering_id',
337
'Project.project_set_id')
339
worksheets = ReferenceSet(id,
340
'Worksheet.offering_id',
344
__init__ = _kwarg_init
347
return "<%s %r in %r>" % (type(self).__name__, self.subject,
350
def enrol(self, user, role=u'student'):
351
"""Enrol a user in this offering.
353
Enrolments handle both the staff and student cases. The role controls
354
the privileges granted by this enrolment.
356
enrolment = Store.of(self).find(Enrolment,
357
Enrolment.user_id == user.id,
358
Enrolment.offering_id == self.id).one()
360
if enrolment is None:
361
enrolment = Enrolment(user=user, offering=self)
362
self.enrolments.add(enrolment)
364
enrolment.active = True
365
enrolment.role = role
367
def unenrol(self, user):
368
'''Unenrol a user from this offering.'''
369
enrolment = Store.of(self).find(Enrolment,
370
Enrolment.user_id == user.id,
371
Enrolment.offering_id == self.id).one()
372
Store.of(enrolment).remove(enrolment)
374
def get_permissions(self, user):
377
enrolment = self.get_enrolment(user)
378
if enrolment or user.admin:
380
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
383
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
384
perms.add('enrol') # Can see enrolment screen at all
385
perms.add('enrol_student') # Can enrol students
386
perms.add('enrol_tutor') # Can enrol tutors
388
perms.add('enrol_lecturer') # Can enrol lecturers
391
def get_enrolment(self, user):
392
"""Find the user's enrolment in this offering."""
394
enrolment = self.enrolments.find(user=user).one()
400
def get_members_by_role(self, role):
401
return Store.of(self).find(User,
402
Enrolment.user_id == User.id,
403
Enrolment.offering_id == self.id,
404
Enrolment.role == role
405
).order_by(User.login)
409
return self.get_members_by_role(u'student')
411
def get_open_projects_for_user(self, user):
412
"""Find all projects currently open to submissions by a user."""
413
# XXX: Respect extensions.
414
return self.projects.find(Project.deadline > datetime.datetime.now())
416
class Enrolment(Storm):
417
"""An enrolment of a user in an offering.
419
This represents the roles of both staff and students.
422
__storm_table__ = "enrolment"
423
__storm_primary__ = "user_id", "offering_id"
425
user_id = Int(name="loginid")
426
user = Reference(user_id, User.id)
427
offering_id = Int(name="offeringid")
428
offering = Reference(offering_id, Offering.id)
435
return Store.of(self).find(ProjectGroup,
436
ProjectSet.offering_id == self.offering.id,
437
ProjectGroup.project_set_id == ProjectSet.id,
438
ProjectGroupMembership.project_group_id == ProjectGroup.id,
439
ProjectGroupMembership.user_id == self.user.id)
441
__init__ = _kwarg_init
444
return "<%s %r in %r>" % (type(self).__name__, self.user,
449
class ProjectSet(Storm):
450
"""A set of projects that share common groups.
452
Each student project group is attached to a project set. The group is
453
valid for all projects in the group's set.
456
__storm_table__ = "project_set"
458
id = Int(name="projectsetid", primary=True)
459
offering_id = Int(name="offeringid")
460
offering = Reference(offering_id, Offering.id)
461
max_students_per_group = Int()
463
projects = ReferenceSet(id, 'Project.project_set_id')
464
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
466
__init__ = _kwarg_init
469
return "<%s %d in %r>" % (type(self).__name__, self.id,
472
def get_permissions(self, user):
473
return self.offering.get_permissions(user)
475
def get_groups_for_user(self, user):
476
"""List all groups in this offering of which the user is a member."""
478
return Store.of(self).find(
480
ProjectGroupMembership.user_id == user.id,
481
ProjectGroupMembership.project_group_id == ProjectGroup.id,
482
ProjectGroup.project_set_id == self.id)
484
def get_submission_principal(self, user):
485
"""Get the principal on behalf of which the user can submit.
487
If this is a solo project set, the given user is returned. If
488
the user is a member of exactly one group, all the group is
489
returned. Otherwise, None is returned.
492
groups = self.get_groups_for_user(user)
493
if groups.count() == 1:
502
return self.max_students_per_group is not None
506
"""Get the entities (groups or users) assigned to submit this project.
508
This will be a Storm ResultSet.
510
#If its a solo project, return everyone in offering
512
return self.project_groups
514
return self.offering.students
516
class DeadlinePassed(Exception):
517
"""An exception indicating that a project cannot be submitted because the
518
deadline has passed."""
522
return "The project deadline has passed"
524
class Project(Storm):
525
"""A student project for which submissions can be made."""
527
__storm_table__ = "project"
529
id = Int(name="projectid", primary=True)
531
short_name = Unicode()
534
project_set_id = Int(name="projectsetid")
535
project_set = Reference(project_set_id, ProjectSet.id)
536
deadline = DateTime()
538
assesseds = ReferenceSet(id, 'Assessed.project_id')
539
submissions = ReferenceSet(id,
540
'Assessed.project_id',
542
'ProjectSubmission.assessed_id')
544
__init__ = _kwarg_init
547
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
548
self.project_set.offering)
550
def can_submit(self, principal, user):
551
return (self in principal.get_projects() and
552
not self.has_deadline_passed(user))
554
def submit(self, principal, path, revision, who):
555
"""Submit a Subversion path and revision to a project.
557
@param principal: The owner of the Subversion repository, and the
558
entity on behalf of whom the submission is being made
559
@param path: A path within that repository to submit.
560
@param revision: The revision of that path to submit.
561
@param who: The user who is actually making the submission.
564
if not self.can_submit(principal, who):
565
raise DeadlinePassed()
567
a = Assessed.get(Store.of(self), principal, self)
568
ps = ProjectSubmission()
570
ps.revision = revision
571
ps.date_submitted = datetime.datetime.now()
577
def get_permissions(self, user):
578
return self.project_set.offering.get_permissions(user)
581
def latest_submissions(self):
582
"""Return the latest submission for each Assessed."""
583
return Store.of(self).find(ProjectSubmission,
584
Assessed.project_id == self.id,
585
ProjectSubmission.assessed_id == Assessed.id,
586
ProjectSubmission.date_submitted == Select(
587
Max(ProjectSubmission.date_submitted),
588
ProjectSubmission.assessed_id == Assessed.id,
589
tables=ProjectSubmission
593
def has_deadline_passed(self, user):
594
"""Check whether the deadline has passed."""
595
# XXX: Need to respect extensions.
596
return self.deadline < datetime.datetime.now()
598
def get_submissions_for_principal(self, principal):
599
"""Fetch a ResultSet of all submissions by a particular principal."""
600
assessed = Assessed.get(Store.of(self), principal, self)
603
return assessed.submissions
607
class ProjectGroup(Storm):
608
"""A group of students working together on a project."""
610
__storm_table__ = "project_group"
612
id = Int(name="groupid", primary=True)
613
name = Unicode(name="groupnm")
614
project_set_id = Int(name="projectsetid")
615
project_set = Reference(project_set_id, ProjectSet.id)
617
created_by_id = Int(name="createdby")
618
created_by = Reference(created_by_id, User.id)
621
members = ReferenceSet(id,
622
"ProjectGroupMembership.project_group_id",
623
"ProjectGroupMembership.user_id",
626
__init__ = _kwarg_init
629
return "<%s %s in %r>" % (type(self).__name__, self.name,
630
self.project_set.offering)
633
def display_name(self):
634
"""Returns the "nice name" of the user or group."""
638
def short_name(self):
639
"""Returns the database "identifier" name of the user or group."""
642
def get_projects(self, offering=None, active_only=True):
643
'''Find projects that the group can submit.
645
This will include projects in the project set which owns this group,
646
unless the project set disallows groups (in which case none will be
649
@param active_only: Whether to only search active offerings.
650
@param offering: An optional offering to restrict the search to.
652
return Store.of(self).find(Project,
653
Project.project_set_id == ProjectSet.id,
654
ProjectSet.id == self.project_set.id,
655
ProjectSet.max_students_per_group != None,
656
ProjectSet.offering_id == Offering.id,
657
(offering is None) or (Offering.id == offering.id),
658
Semester.id == Offering.semester_id,
659
(not active_only) or (Semester.state == u'current'))
662
def get_permissions(self, user):
663
if user.admin or user in self.members:
664
return set(['submit_project'])
668
class ProjectGroupMembership(Storm):
669
"""A student's membership in a project group."""
671
__storm_table__ = "group_member"
672
__storm_primary__ = "user_id", "project_group_id"
674
user_id = Int(name="loginid")
675
user = Reference(user_id, User.id)
676
project_group_id = Int(name="groupid")
677
project_group = Reference(project_group_id, ProjectGroup.id)
679
__init__ = _kwarg_init
682
return "<%s %r in %r>" % (type(self).__name__, self.user,
685
class Assessed(Storm):
686
"""A composite of a user or group combined with a project.
688
Each project submission and extension refers to an Assessed. It is the
689
sole specifier of the repository and project.
692
__storm_table__ = "assessed"
694
id = Int(name="assessedid", primary=True)
695
user_id = Int(name="loginid")
696
user = Reference(user_id, User.id)
697
project_group_id = Int(name="groupid")
698
project_group = Reference(project_group_id, ProjectGroup.id)
700
project_id = Int(name="projectid")
701
project = Reference(project_id, Project.id)
703
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
704
submissions = ReferenceSet(
705
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
708
return "<%s %r in %r>" % (type(self).__name__,
709
self.user or self.project_group, self.project)
713
"""True if the Assessed is a group, False if it is a user."""
714
return self.project_group is not None
718
return self.project_group or self.user
721
def checkout_location(self):
722
"""Returns the location of the Subversion workspace for this piece of
723
assessment, relative to each group member's home directory."""
724
subjectname = self.project.project_set.offering.subject.short_name
726
checkout_dir_name = self.principal.short_name
728
checkout_dir_name = "mywork"
729
return subjectname + "/" + checkout_dir_name
732
def get(cls, store, principal, project):
733
"""Find or create an Assessed for the given user or group and project.
735
@param principal: The user or group.
736
@param project: The project.
739
if t not in (User, ProjectGroup):
740
raise AssertionError('principal must be User or ProjectGroup')
743
(t is User) or (cls.project_group_id == principal.id),
744
(t is ProjectGroup) or (cls.user_id == principal.id),
745
cls.project_id == project.id).one()
752
a.project_group = principal
759
class ProjectExtension(Storm):
760
"""An extension granted to a user or group on a particular project.
762
The user or group and project are specified by the Assessed.
765
__storm_table__ = "project_extension"
767
id = Int(name="extensionid", primary=True)
768
assessed_id = Int(name="assessedid")
769
assessed = Reference(assessed_id, Assessed.id)
770
deadline = DateTime()
771
approver_id = Int(name="approver")
772
approver = Reference(approver_id, User.id)
775
class ProjectSubmission(Storm):
776
"""A submission from a user or group repository to a particular project.
778
The content of a submission is a single path and revision inside a
779
repository. The repository is that owned by the submission's user and
780
group, while the path and revision are explicit.
782
The user or group and project are specified by the Assessed.
785
__storm_table__ = "project_submission"
787
id = Int(name="submissionid", primary=True)
788
assessed_id = Int(name="assessedid")
789
assessed = Reference(assessed_id, Assessed.id)
792
submitter_id = Int(name="submitter")
793
submitter = Reference(submitter_id, User.id)
794
date_submitted = DateTime()
796
def get_verify_url(self, user):
797
"""Get the URL for verifying this submission, within the account of
799
# If this is a solo project, then self.path will be prefixed with the
800
# subject name. Remove the first path segment.
801
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
802
if not self.assessed.is_group:
803
if '/' in submitpath:
804
submitpath = submitpath.split('/', 1)[1]
807
return "/files/%s/%s/%s?r=%d" % (user.login,
808
self.assessed.checkout_location, submitpath, self.revision)
810
# WORKSHEETS AND EXERCISES #
812
class Exercise(Storm):
813
"""An exercise for students to complete in a worksheet.
815
An exercise may be present in any number of worksheets.
818
__storm_table__ = "exercise"
819
id = Unicode(primary=True, name="identifier")
821
description = Unicode()
827
worksheet_exercises = ReferenceSet(id,
828
'WorksheetExercise.exercise_id')
830
worksheets = ReferenceSet(id,
831
'WorksheetExercise.exercise_id',
832
'WorksheetExercise.worksheet_id',
836
test_suites = ReferenceSet(id,
837
'TestSuite.exercise_id',
840
__init__ = _kwarg_init
843
return "<%s %s>" % (type(self).__name__, self.name)
845
def get_permissions(self, user):
846
return self.global_permissions(user)
849
def global_permissions(user):
850
"""Gets the set of permissions this user has over *all* exercises.
851
This is used to determine who may view the exercises list, and create
859
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
862
elif u'tutor' in set((e.role for e in user.active_enrolments)):
868
def get_description(self):
869
"""Return the description interpreted as reStructuredText."""
870
return rst(self.description)
873
"""Deletes the exercise, providing it has no associated worksheets."""
874
if (self.worksheet_exercises.count() > 0):
875
raise IntegrityError()
876
for suite in self.test_suites:
878
Store.of(self).remove(self)
880
class Worksheet(Storm):
881
"""A worksheet with exercises for students to complete.
883
Worksheets are owned by offerings.
886
__storm_table__ = "worksheet"
888
id = Int(primary=True, name="worksheetid")
889
offering_id = Int(name="offeringid")
890
identifier = Unicode()
897
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
898
offering = Reference(offering_id, 'Offering.id')
900
all_worksheet_exercises = ReferenceSet(id,
901
'WorksheetExercise.worksheet_id')
903
# Use worksheet_exercises to get access to the *active* WorksheetExercise
904
# objects binding worksheets to exercises. This is required to access the
908
def worksheet_exercises(self):
909
return self.all_worksheet_exercises.find(active=True)
911
__init__ = _kwarg_init
914
return "<%s %s>" % (type(self).__name__, self.name)
916
def remove_all_exercises(self):
917
"""Remove all exercises from this worksheet.
919
This does not delete the exercises themselves. It just removes them
922
store = Store.of(self)
923
for ws_ex in self.all_worksheet_exercises:
924
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
925
raise IntegrityError()
926
store.find(WorksheetExercise,
927
WorksheetExercise.worksheet == self).remove()
929
def get_permissions(self, user):
930
return self.offering.get_permissions(user)
933
"""Returns the xml of this worksheet, converts from rst if required."""
934
if self.format == u'rst':
935
ws_xml = rst(self.data)
941
"""Deletes the worksheet, provided it has no attempts on any exercises.
943
Returns True if delete succeeded, or False if this worksheet has
944
attempts attached."""
945
for ws_ex in self.all_worksheet_exercises:
946
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
947
raise IntegrityError()
949
self.remove_all_exercises()
950
Store.of(self).remove(self)
952
class WorksheetExercise(Storm):
953
"""A link between a worksheet and one of its exercises.
955
These may be marked optional, in which case the exercise does not count
956
for marking purposes. The sequence number is used to order the worksheet
960
__storm_table__ = "worksheet_exercise"
962
id = Int(primary=True, name="ws_ex_id")
964
worksheet_id = Int(name="worksheetid")
965
worksheet = Reference(worksheet_id, Worksheet.id)
966
exercise_id = Unicode(name="exerciseid")
967
exercise = Reference(exercise_id, Exercise.id)
972
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
973
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
975
__init__ = _kwarg_init
978
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
979
self.worksheet.identifier)
981
def get_permissions(self, user):
982
return self.worksheet.get_permissions(user)
985
class ExerciseSave(Storm):
986
"""A potential exercise solution submitted by a user for storage.
988
This is not an actual tested attempt at an exercise, it's just a save of
992
__storm_table__ = "exercise_save"
993
__storm_primary__ = "ws_ex_id", "user_id"
995
ws_ex_id = Int(name="ws_ex_id")
996
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
998
user_id = Int(name="loginid")
999
user = Reference(user_id, User.id)
1003
__init__ = _kwarg_init
1006
return "<%s %s by %s at %s>" % (type(self).__name__,
1007
self.exercise.name, self.user.login, self.date.strftime("%c"))
1009
class ExerciseAttempt(ExerciseSave):
1010
"""An attempt at solving an exercise.
1012
This is a special case of ExerciseSave, used when the user submits a
1013
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1016
In addition, it contains information about the result of the submission:
1018
- complete - True if this submission was successful, rendering this
1019
exercise complete for this user in this worksheet.
1020
- active - True if this submission is "active" (usually true).
1021
Submissions may be de-activated by privileged users for
1022
special reasons, and then they won't count (either as a
1023
penalty or success), but will still be stored.
1026
__storm_table__ = "exercise_attempt"
1027
__storm_primary__ = "ws_ex_id", "user_id", "date"
1029
# The "text" field is the same but has a different name in the DB table
1031
text = Unicode(name="attempt")
1035
def get_permissions(self, user):
1036
return set(['view']) if user is self.user else set()
1038
class TestSuite(Storm):
1039
"""A container to group an exercise's test cases.
1041
The test suite contains some information on how to test. The function to
1042
test, variables to set and stdin data are stored here.
1045
__storm_table__ = "test_suite"
1046
__storm_primary__ = "exercise_id", "suiteid"
1049
exercise_id = Unicode(name="exerciseid")
1050
description = Unicode()
1052
function = Unicode()
1054
exercise = Reference(exercise_id, Exercise.id)
1055
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1056
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1059
"""Delete this suite, without asking questions."""
1060
for variable in self.variables:
1062
for test_case in self.test_cases:
1064
Store.of(self).remove(self)
1066
class TestCase(Storm):
1067
"""A container for actual tests (see TestCasePart), inside a test suite.
1069
It is the lowest level shown to students on their pass/fail status."""
1071
__storm_table__ = "test_case"
1072
__storm_primary__ = "testid", "suiteid"
1076
suite = Reference(suiteid, "TestSuite.suiteid")
1079
test_default = Unicode() # Currently unused - only used for file matching.
1082
parts = ReferenceSet(testid, "TestCasePart.testid")
1084
__init__ = _kwarg_init
1087
for part in self.parts:
1089
Store.of(self).remove(self)
1091
class TestSuiteVar(Storm):
1092
"""A variable used by an exercise test suite.
1094
This may represent a function argument or a normal variable.
1097
__storm_table__ = "suite_variable"
1098
__storm_primary__ = "varid"
1102
var_name = Unicode()
1103
var_value = Unicode()
1104
var_type = Unicode()
1107
suite = Reference(suiteid, "TestSuite.suiteid")
1109
__init__ = _kwarg_init
1112
Store.of(self).remove(self)
1114
class TestCasePart(Storm):
1115
"""An actual piece of code to test an exercise solution."""
1117
__storm_table__ = "test_case_part"
1118
__storm_primary__ = "partid"
1123
part_type = Unicode()
1124
test_type = Unicode()
1126
filename = Unicode()
1128
test = Reference(testid, "TestCase.testid")
1130
__init__ = _kwarg_init
1133
Store.of(self).remove(self)
added
removed
ivle/database.py
