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
# XXX Bug #493945 -- should tutors have these permissions?
384
# Potentially move into the next category (lecturer & admin)
385
perms.add('enrol') # Can see enrolment screen at all
386
perms.add('enrol_student') # Can enrol students
387
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
388
perms.add('enrol_tutor') # Can enrol tutors
390
perms.add('enrol_lecturer') # Can enrol lecturers
393
def get_enrolment(self, user):
394
"""Find the user's enrolment in this offering."""
396
enrolment = self.enrolments.find(user=user).one()
402
def get_members_by_role(self, role):
403
return Store.of(self).find(User,
404
Enrolment.user_id == User.id,
405
Enrolment.offering_id == self.id,
406
Enrolment.role == role
407
).order_by(User.login)
411
return self.get_members_by_role(u'student')
413
def get_open_projects_for_user(self, user):
414
"""Find all projects currently open to submissions by a user."""
415
# XXX: Respect extensions.
416
return self.projects.find(Project.deadline > datetime.datetime.now())
418
class Enrolment(Storm):
419
"""An enrolment of a user in an offering.
421
This represents the roles of both staff and students.
424
__storm_table__ = "enrolment"
425
__storm_primary__ = "user_id", "offering_id"
427
user_id = Int(name="loginid")
428
user = Reference(user_id, User.id)
429
offering_id = Int(name="offeringid")
430
offering = Reference(offering_id, Offering.id)
437
return Store.of(self).find(ProjectGroup,
438
ProjectSet.offering_id == self.offering.id,
439
ProjectGroup.project_set_id == ProjectSet.id,
440
ProjectGroupMembership.project_group_id == ProjectGroup.id,
441
ProjectGroupMembership.user_id == self.user.id)
443
__init__ = _kwarg_init
446
return "<%s %r in %r>" % (type(self).__name__, self.user,
451
class ProjectSet(Storm):
452
"""A set of projects that share common groups.
454
Each student project group is attached to a project set. The group is
455
valid for all projects in the group's set.
458
__storm_table__ = "project_set"
460
id = Int(name="projectsetid", primary=True)
461
offering_id = Int(name="offeringid")
462
offering = Reference(offering_id, Offering.id)
463
max_students_per_group = Int()
465
projects = ReferenceSet(id, 'Project.project_set_id')
466
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
468
__init__ = _kwarg_init
471
return "<%s %d in %r>" % (type(self).__name__, self.id,
474
def get_permissions(self, user):
475
return self.offering.get_permissions(user)
477
def get_groups_for_user(self, user):
478
"""List all groups in this offering of which the user is a member."""
480
return Store.of(self).find(
482
ProjectGroupMembership.user_id == user.id,
483
ProjectGroupMembership.project_group_id == ProjectGroup.id,
484
ProjectGroup.project_set_id == self.id)
486
def get_submission_principal(self, user):
487
"""Get the principal on behalf of which the user can submit.
489
If this is a solo project set, the given user is returned. If
490
the user is a member of exactly one group, all the group is
491
returned. Otherwise, None is returned.
494
groups = self.get_groups_for_user(user)
495
if groups.count() == 1:
504
return self.max_students_per_group is not None
508
"""Get the entities (groups or users) assigned to submit this project.
510
This will be a Storm ResultSet.
512
#If its a solo project, return everyone in offering
514
return self.project_groups
516
return self.offering.students
518
class DeadlinePassed(Exception):
519
"""An exception indicating that a project cannot be submitted because the
520
deadline has passed."""
524
return "The project deadline has passed"
526
class Project(Storm):
527
"""A student project for which submissions can be made."""
529
__storm_table__ = "project"
531
id = Int(name="projectid", primary=True)
533
short_name = Unicode()
536
project_set_id = Int(name="projectsetid")
537
project_set = Reference(project_set_id, ProjectSet.id)
538
deadline = DateTime()
540
assesseds = ReferenceSet(id, 'Assessed.project_id')
541
submissions = ReferenceSet(id,
542
'Assessed.project_id',
544
'ProjectSubmission.assessed_id')
546
__init__ = _kwarg_init
549
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
550
self.project_set.offering)
552
def can_submit(self, principal, user):
553
return (self in principal.get_projects() and
554
not self.has_deadline_passed(user))
556
def submit(self, principal, path, revision, who):
557
"""Submit a Subversion path and revision to a project.
559
@param principal: The owner of the Subversion repository, and the
560
entity on behalf of whom the submission is being made
561
@param path: A path within that repository to submit.
562
@param revision: The revision of that path to submit.
563
@param who: The user who is actually making the submission.
566
if not self.can_submit(principal, who):
567
raise DeadlinePassed()
569
a = Assessed.get(Store.of(self), principal, self)
570
ps = ProjectSubmission()
572
ps.revision = revision
573
ps.date_submitted = datetime.datetime.now()
579
def get_permissions(self, user):
580
return self.project_set.offering.get_permissions(user)
583
def latest_submissions(self):
584
"""Return the latest submission for each Assessed."""
585
return Store.of(self).find(ProjectSubmission,
586
Assessed.project_id == self.id,
587
ProjectSubmission.assessed_id == Assessed.id,
588
ProjectSubmission.date_submitted == Select(
589
Max(ProjectSubmission.date_submitted),
590
ProjectSubmission.assessed_id == Assessed.id,
591
tables=ProjectSubmission
595
def has_deadline_passed(self, user):
596
"""Check whether the deadline has passed."""
597
# XXX: Need to respect extensions.
598
return self.deadline < datetime.datetime.now()
600
def get_submissions_for_principal(self, principal):
601
"""Fetch a ResultSet of all submissions by a particular principal."""
602
assessed = Assessed.get(Store.of(self), principal, self)
605
return assessed.submissions
609
class ProjectGroup(Storm):
610
"""A group of students working together on a project."""
612
__storm_table__ = "project_group"
614
id = Int(name="groupid", primary=True)
615
name = Unicode(name="groupnm")
616
project_set_id = Int(name="projectsetid")
617
project_set = Reference(project_set_id, ProjectSet.id)
619
created_by_id = Int(name="createdby")
620
created_by = Reference(created_by_id, User.id)
623
members = ReferenceSet(id,
624
"ProjectGroupMembership.project_group_id",
625
"ProjectGroupMembership.user_id",
628
__init__ = _kwarg_init
631
return "<%s %s in %r>" % (type(self).__name__, self.name,
632
self.project_set.offering)
635
def display_name(self):
636
"""Returns the "nice name" of the user or group."""
640
def short_name(self):
641
"""Returns the database "identifier" name of the user or group."""
644
def get_projects(self, offering=None, active_only=True):
645
'''Find projects that the group can submit.
647
This will include projects in the project set which owns this group,
648
unless the project set disallows groups (in which case none will be
651
@param active_only: Whether to only search active offerings.
652
@param offering: An optional offering to restrict the search to.
654
return Store.of(self).find(Project,
655
Project.project_set_id == ProjectSet.id,
656
ProjectSet.id == self.project_set.id,
657
ProjectSet.max_students_per_group != None,
658
ProjectSet.offering_id == Offering.id,
659
(offering is None) or (Offering.id == offering.id),
660
Semester.id == Offering.semester_id,
661
(not active_only) or (Semester.state == u'current'))
664
def get_permissions(self, user):
665
if user.admin or user in self.members:
666
return set(['submit_project'])
670
class ProjectGroupMembership(Storm):
671
"""A student's membership in a project group."""
673
__storm_table__ = "group_member"
674
__storm_primary__ = "user_id", "project_group_id"
676
user_id = Int(name="loginid")
677
user = Reference(user_id, User.id)
678
project_group_id = Int(name="groupid")
679
project_group = Reference(project_group_id, ProjectGroup.id)
681
__init__ = _kwarg_init
684
return "<%s %r in %r>" % (type(self).__name__, self.user,
687
class Assessed(Storm):
688
"""A composite of a user or group combined with a project.
690
Each project submission and extension refers to an Assessed. It is the
691
sole specifier of the repository and project.
694
__storm_table__ = "assessed"
696
id = Int(name="assessedid", primary=True)
697
user_id = Int(name="loginid")
698
user = Reference(user_id, User.id)
699
project_group_id = Int(name="groupid")
700
project_group = Reference(project_group_id, ProjectGroup.id)
702
project_id = Int(name="projectid")
703
project = Reference(project_id, Project.id)
705
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
706
submissions = ReferenceSet(
707
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
710
return "<%s %r in %r>" % (type(self).__name__,
711
self.user or self.project_group, self.project)
715
"""True if the Assessed is a group, False if it is a user."""
716
return self.project_group is not None
720
return self.project_group or self.user
723
def checkout_location(self):
724
"""Returns the location of the Subversion workspace for this piece of
725
assessment, relative to each group member's home directory."""
726
subjectname = self.project.project_set.offering.subject.short_name
728
checkout_dir_name = self.principal.short_name
730
checkout_dir_name = "mywork"
731
return subjectname + "/" + checkout_dir_name
734
def get(cls, store, principal, project):
735
"""Find or create an Assessed for the given user or group and project.
737
@param principal: The user or group.
738
@param project: The project.
741
if t not in (User, ProjectGroup):
742
raise AssertionError('principal must be User or ProjectGroup')
745
(t is User) or (cls.project_group_id == principal.id),
746
(t is ProjectGroup) or (cls.user_id == principal.id),
747
cls.project_id == project.id).one()
754
a.project_group = principal
761
class ProjectExtension(Storm):
762
"""An extension granted to a user or group on a particular project.
764
The user or group and project are specified by the Assessed.
767
__storm_table__ = "project_extension"
769
id = Int(name="extensionid", primary=True)
770
assessed_id = Int(name="assessedid")
771
assessed = Reference(assessed_id, Assessed.id)
772
deadline = DateTime()
773
approver_id = Int(name="approver")
774
approver = Reference(approver_id, User.id)
777
class ProjectSubmission(Storm):
778
"""A submission from a user or group repository to a particular project.
780
The content of a submission is a single path and revision inside a
781
repository. The repository is that owned by the submission's user and
782
group, while the path and revision are explicit.
784
The user or group and project are specified by the Assessed.
787
__storm_table__ = "project_submission"
789
id = Int(name="submissionid", primary=True)
790
assessed_id = Int(name="assessedid")
791
assessed = Reference(assessed_id, Assessed.id)
794
submitter_id = Int(name="submitter")
795
submitter = Reference(submitter_id, User.id)
796
date_submitted = DateTime()
798
def get_verify_url(self, user):
799
"""Get the URL for verifying this submission, within the account of
801
# If this is a solo project, then self.path will be prefixed with the
802
# subject name. Remove the first path segment.
803
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
804
if not self.assessed.is_group:
805
if '/' in submitpath:
806
submitpath = submitpath.split('/', 1)[1]
809
return "/files/%s/%s/%s?r=%d" % (user.login,
810
self.assessed.checkout_location, submitpath, self.revision)
812
# WORKSHEETS AND EXERCISES #
814
class Exercise(Storm):
815
"""An exercise for students to complete in a worksheet.
817
An exercise may be present in any number of worksheets.
820
__storm_table__ = "exercise"
821
id = Unicode(primary=True, name="identifier")
823
description = Unicode()
829
worksheet_exercises = ReferenceSet(id,
830
'WorksheetExercise.exercise_id')
832
worksheets = ReferenceSet(id,
833
'WorksheetExercise.exercise_id',
834
'WorksheetExercise.worksheet_id',
838
test_suites = ReferenceSet(id,
839
'TestSuite.exercise_id',
842
__init__ = _kwarg_init
845
return "<%s %s>" % (type(self).__name__, self.name)
847
def get_permissions(self, user):
854
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
857
elif u'tutor' in set((e.role for e in user.active_enrolments)):
863
def get_description(self):
864
"""Return the description interpreted as reStructuredText."""
865
return rst(self.description)
868
"""Deletes the exercise, providing it has no associated worksheets."""
869
if (self.worksheet_exercises.count() > 0):
870
raise IntegrityError()
871
for suite in self.test_suites:
873
Store.of(self).remove(self)
875
class Worksheet(Storm):
876
"""A worksheet with exercises for students to complete.
878
Worksheets are owned by offerings.
881
__storm_table__ = "worksheet"
883
id = Int(primary=True, name="worksheetid")
884
offering_id = Int(name="offeringid")
885
identifier = Unicode()
892
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
893
offering = Reference(offering_id, 'Offering.id')
895
all_worksheet_exercises = ReferenceSet(id,
896
'WorksheetExercise.worksheet_id')
898
# Use worksheet_exercises to get access to the *active* WorksheetExercise
899
# objects binding worksheets to exercises. This is required to access the
903
def worksheet_exercises(self):
904
return self.all_worksheet_exercises.find(active=True)
906
__init__ = _kwarg_init
909
return "<%s %s>" % (type(self).__name__, self.name)
911
def remove_all_exercises(self):
912
"""Remove all exercises from this worksheet.
914
This does not delete the exercises themselves. It just removes them
917
store = Store.of(self)
918
for ws_ex in self.all_worksheet_exercises:
919
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
920
raise IntegrityError()
921
store.find(WorksheetExercise,
922
WorksheetExercise.worksheet == self).remove()
924
def get_permissions(self, user):
925
return self.offering.get_permissions(user)
928
"""Returns the xml of this worksheet, converts from rst if required."""
929
if self.format == u'rst':
930
ws_xml = rst(self.data)
936
"""Deletes the worksheet, provided it has no attempts on any exercises.
938
Returns True if delete succeeded, or False if this worksheet has
939
attempts attached."""
940
for ws_ex in self.all_worksheet_exercises:
941
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
942
raise IntegrityError()
944
self.remove_all_exercises()
945
Store.of(self).remove(self)
947
class WorksheetExercise(Storm):
948
"""A link between a worksheet and one of its exercises.
950
These may be marked optional, in which case the exercise does not count
951
for marking purposes. The sequence number is used to order the worksheet
955
__storm_table__ = "worksheet_exercise"
957
id = Int(primary=True, name="ws_ex_id")
959
worksheet_id = Int(name="worksheetid")
960
worksheet = Reference(worksheet_id, Worksheet.id)
961
exercise_id = Unicode(name="exerciseid")
962
exercise = Reference(exercise_id, Exercise.id)
967
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
968
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
970
__init__ = _kwarg_init
973
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
974
self.worksheet.identifier)
976
def get_permissions(self, user):
977
return self.worksheet.get_permissions(user)
980
class ExerciseSave(Storm):
981
"""A potential exercise solution submitted by a user for storage.
983
This is not an actual tested attempt at an exercise, it's just a save of
987
__storm_table__ = "exercise_save"
988
__storm_primary__ = "ws_ex_id", "user_id"
990
ws_ex_id = Int(name="ws_ex_id")
991
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
993
user_id = Int(name="loginid")
994
user = Reference(user_id, User.id)
998
__init__ = _kwarg_init
1001
return "<%s %s by %s at %s>" % (type(self).__name__,
1002
self.exercise.name, self.user.login, self.date.strftime("%c"))
1004
class ExerciseAttempt(ExerciseSave):
1005
"""An attempt at solving an exercise.
1007
This is a special case of ExerciseSave, used when the user submits a
1008
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1011
In addition, it contains information about the result of the submission:
1013
- complete - True if this submission was successful, rendering this
1014
exercise complete for this user in this worksheet.
1015
- active - True if this submission is "active" (usually true).
1016
Submissions may be de-activated by privileged users for
1017
special reasons, and then they won't count (either as a
1018
penalty or success), but will still be stored.
1021
__storm_table__ = "exercise_attempt"
1022
__storm_primary__ = "ws_ex_id", "user_id", "date"
1024
# The "text" field is the same but has a different name in the DB table
1026
text = Unicode(name="attempt")
1030
def get_permissions(self, user):
1031
return set(['view']) if user is self.user else set()
1033
class TestSuite(Storm):
1034
"""A container to group an exercise's test cases.
1036
The test suite contains some information on how to test. The function to
1037
test, variables to set and stdin data are stored here.
1040
__storm_table__ = "test_suite"
1041
__storm_primary__ = "exercise_id", "suiteid"
1044
exercise_id = Unicode(name="exerciseid")
1045
description = Unicode()
1047
function = Unicode()
1049
exercise = Reference(exercise_id, Exercise.id)
1050
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1051
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1054
"""Delete this suite, without asking questions."""
1055
for variable in self.variables:
1057
for test_case in self.test_cases:
1059
Store.of(self).remove(self)
1061
class TestCase(Storm):
1062
"""A container for actual tests (see TestCasePart), inside a test suite.
1064
It is the lowest level shown to students on their pass/fail status."""
1066
__storm_table__ = "test_case"
1067
__storm_primary__ = "testid", "suiteid"
1071
suite = Reference(suiteid, "TestSuite.suiteid")
1074
test_default = Unicode() # Currently unused - only used for file matching.
1077
parts = ReferenceSet(testid, "TestCasePart.testid")
1079
__init__ = _kwarg_init
1082
for part in self.parts:
1084
Store.of(self).remove(self)
1086
class TestSuiteVar(Storm):
1087
"""A variable used by an exercise test suite.
1089
This may represent a function argument or a normal variable.
1092
__storm_table__ = "suite_variable"
1093
__storm_primary__ = "varid"
1097
var_name = Unicode()
1098
var_value = Unicode()
1099
var_type = Unicode()
1102
suite = Reference(suiteid, "TestSuite.suiteid")
1104
__init__ = _kwarg_init
1107
Store.of(self).remove(self)
1109
class TestCasePart(Storm):
1110
"""An actual piece of code to test an exercise solution."""
1112
__storm_table__ = "test_case_part"
1113
__storm_primary__ = "partid"
1118
part_type = Unicode()
1119
test_type = Unicode()
1121
filename = Unicode()
1123
test = Reference(testid, "TestCase.testid")
1125
__init__ = _kwarg_init
1128
Store.of(self).remove(self)
added
removed
ivle/database.py
