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, config):
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, config):
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, config):
377
enrolment = self.get_enrolment(user)
378
if enrolment or user.admin:
380
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
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 (enrolment and enrolment.role in (u'lecturer')) or user.admin:
390
perms.add('view_project_submissions')
391
perms.add('edit_worksheets')
392
perms.add('edit') # Can edit projects & details
393
perms.add('enrol') # Can see enrolment screen at all
394
perms.add('enrol_student') # Can enrol students
395
perms.add('enrol_tutor') # Can enrol tutors
397
perms.add('enrol_lecturer') # Can enrol lecturers
400
def get_enrolment(self, user):
401
"""Find the user's enrolment in this offering."""
403
enrolment = self.enrolments.find(user=user).one()
409
def get_members_by_role(self, role):
410
return Store.of(self).find(User,
411
Enrolment.user_id == User.id,
412
Enrolment.offering_id == self.id,
413
Enrolment.role == role
414
).order_by(User.login)
418
return self.get_members_by_role(u'student')
420
def get_open_projects_for_user(self, user):
421
"""Find all projects currently open to submissions by a user."""
422
# XXX: Respect extensions.
423
return self.projects.find(Project.deadline > datetime.datetime.now())
425
class Enrolment(Storm):
426
"""An enrolment of a user in an offering.
428
This represents the roles of both staff and students.
431
__storm_table__ = "enrolment"
432
__storm_primary__ = "user_id", "offering_id"
434
user_id = Int(name="loginid")
435
user = Reference(user_id, User.id)
436
offering_id = Int(name="offeringid")
437
offering = Reference(offering_id, Offering.id)
444
return Store.of(self).find(ProjectGroup,
445
ProjectSet.offering_id == self.offering.id,
446
ProjectGroup.project_set_id == ProjectSet.id,
447
ProjectGroupMembership.project_group_id == ProjectGroup.id,
448
ProjectGroupMembership.user_id == self.user.id)
450
__init__ = _kwarg_init
453
return "<%s %r in %r>" % (type(self).__name__, self.user,
458
class ProjectSet(Storm):
459
"""A set of projects that share common groups.
461
Each student project group is attached to a project set. The group is
462
valid for all projects in the group's set.
465
__storm_table__ = "project_set"
467
id = Int(name="projectsetid", primary=True)
468
offering_id = Int(name="offeringid")
469
offering = Reference(offering_id, Offering.id)
470
max_students_per_group = Int()
472
projects = ReferenceSet(id, 'Project.project_set_id')
473
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
475
__init__ = _kwarg_init
478
return "<%s %d in %r>" % (type(self).__name__, self.id,
481
def get_permissions(self, user, config):
482
return self.offering.get_permissions(user, config)
484
def get_groups_for_user(self, user):
485
"""List all groups in this offering of which the user is a member."""
487
return Store.of(self).find(
489
ProjectGroupMembership.user_id == user.id,
490
ProjectGroupMembership.project_group_id == ProjectGroup.id,
491
ProjectGroup.project_set_id == self.id)
493
def get_submission_principal(self, user):
494
"""Get the principal on behalf of which the user can submit.
496
If this is a solo project set, the given user is returned. If
497
the user is a member of exactly one group, all the group is
498
returned. Otherwise, None is returned.
501
groups = self.get_groups_for_user(user)
502
if groups.count() == 1:
511
return self.max_students_per_group is not None
515
"""Get the entities (groups or users) assigned to submit this project.
517
This will be a Storm ResultSet.
519
#If its a solo project, return everyone in offering
521
return self.project_groups
523
return self.offering.students
525
class DeadlinePassed(Exception):
526
"""An exception indicating that a project cannot be submitted because the
527
deadline has passed."""
531
return "The project deadline has passed"
533
class Project(Storm):
534
"""A student project for which submissions can be made."""
536
__storm_table__ = "project"
538
id = Int(name="projectid", primary=True)
540
short_name = Unicode()
543
project_set_id = Int(name="projectsetid")
544
project_set = Reference(project_set_id, ProjectSet.id)
545
deadline = DateTime()
547
assesseds = ReferenceSet(id, 'Assessed.project_id')
548
submissions = ReferenceSet(id,
549
'Assessed.project_id',
551
'ProjectSubmission.assessed_id')
553
__init__ = _kwarg_init
556
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
557
self.project_set.offering)
559
def can_submit(self, principal, user):
560
return (self in principal.get_projects() and
561
not self.has_deadline_passed(user))
563
def submit(self, principal, path, revision, who):
564
"""Submit a Subversion path and revision to a project.
566
@param principal: The owner of the Subversion repository, and the
567
entity on behalf of whom the submission is being made
568
@param path: A path within that repository to submit.
569
@param revision: The revision of that path to submit.
570
@param who: The user who is actually making the submission.
573
if not self.can_submit(principal, who):
574
raise DeadlinePassed()
576
a = Assessed.get(Store.of(self), principal, self)
577
ps = ProjectSubmission()
579
ps.revision = revision
580
ps.date_submitted = datetime.datetime.now()
586
def get_permissions(self, user, config):
587
return self.project_set.offering.get_permissions(user, config)
590
def latest_submissions(self):
591
"""Return the latest submission for each Assessed."""
592
return Store.of(self).find(ProjectSubmission,
593
Assessed.project_id == self.id,
594
ProjectSubmission.assessed_id == Assessed.id,
595
ProjectSubmission.date_submitted == Select(
596
Max(ProjectSubmission.date_submitted),
597
ProjectSubmission.assessed_id == Assessed.id,
598
tables=ProjectSubmission
602
def has_deadline_passed(self, user):
603
"""Check whether the deadline has passed."""
604
# XXX: Need to respect extensions.
605
return self.deadline < datetime.datetime.now()
607
def get_submissions_for_principal(self, principal):
608
"""Fetch a ResultSet of all submissions by a particular principal."""
609
assessed = Assessed.get(Store.of(self), principal, self)
612
return assessed.submissions
616
class ProjectGroup(Storm):
617
"""A group of students working together on a project."""
619
__storm_table__ = "project_group"
621
id = Int(name="groupid", primary=True)
622
name = Unicode(name="groupnm")
623
project_set_id = Int(name="projectsetid")
624
project_set = Reference(project_set_id, ProjectSet.id)
626
created_by_id = Int(name="createdby")
627
created_by = Reference(created_by_id, User.id)
630
members = ReferenceSet(id,
631
"ProjectGroupMembership.project_group_id",
632
"ProjectGroupMembership.user_id",
635
__init__ = _kwarg_init
638
return "<%s %s in %r>" % (type(self).__name__, self.name,
639
self.project_set.offering)
642
def display_name(self):
643
"""Returns the "nice name" of the user or group."""
647
def short_name(self):
648
"""Returns the database "identifier" name of the user or group."""
651
def get_projects(self, offering=None, active_only=True):
652
'''Find projects that the group can submit.
654
This will include projects in the project set which owns this group,
655
unless the project set disallows groups (in which case none will be
658
@param active_only: Whether to only search active offerings.
659
@param offering: An optional offering to restrict the search to.
661
return Store.of(self).find(Project,
662
Project.project_set_id == ProjectSet.id,
663
ProjectSet.id == self.project_set.id,
664
ProjectSet.max_students_per_group != None,
665
ProjectSet.offering_id == Offering.id,
666
(offering is None) or (Offering.id == offering.id),
667
Semester.id == Offering.semester_id,
668
(not active_only) or (Semester.state == u'current'))
671
def get_permissions(self, user, config):
672
if user.admin or user in self.members:
673
return set(['submit_project'])
677
class ProjectGroupMembership(Storm):
678
"""A student's membership in a project group."""
680
__storm_table__ = "group_member"
681
__storm_primary__ = "user_id", "project_group_id"
683
user_id = Int(name="loginid")
684
user = Reference(user_id, User.id)
685
project_group_id = Int(name="groupid")
686
project_group = Reference(project_group_id, ProjectGroup.id)
688
__init__ = _kwarg_init
691
return "<%s %r in %r>" % (type(self).__name__, self.user,
694
class Assessed(Storm):
695
"""A composite of a user or group combined with a project.
697
Each project submission and extension refers to an Assessed. It is the
698
sole specifier of the repository and project.
701
__storm_table__ = "assessed"
703
id = Int(name="assessedid", primary=True)
704
user_id = Int(name="loginid")
705
user = Reference(user_id, User.id)
706
project_group_id = Int(name="groupid")
707
project_group = Reference(project_group_id, ProjectGroup.id)
709
project_id = Int(name="projectid")
710
project = Reference(project_id, Project.id)
712
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
713
submissions = ReferenceSet(
714
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
717
return "<%s %r in %r>" % (type(self).__name__,
718
self.user or self.project_group, self.project)
722
"""True if the Assessed is a group, False if it is a user."""
723
return self.project_group is not None
727
return self.project_group or self.user
730
def checkout_location(self):
731
"""Returns the location of the Subversion workspace for this piece of
732
assessment, relative to each group member's home directory."""
733
subjectname = self.project.project_set.offering.subject.short_name
735
checkout_dir_name = self.principal.short_name
737
checkout_dir_name = "mywork"
738
return subjectname + "/" + checkout_dir_name
741
def get(cls, store, principal, project):
742
"""Find or create an Assessed for the given user or group and project.
744
@param principal: The user or group.
745
@param project: The project.
748
if t not in (User, ProjectGroup):
749
raise AssertionError('principal must be User or ProjectGroup')
752
(t is User) or (cls.project_group_id == principal.id),
753
(t is ProjectGroup) or (cls.user_id == principal.id),
754
cls.project_id == project.id).one()
761
a.project_group = principal
768
class ProjectExtension(Storm):
769
"""An extension granted to a user or group on a particular project.
771
The user or group and project are specified by the Assessed.
774
__storm_table__ = "project_extension"
776
id = Int(name="extensionid", primary=True)
777
assessed_id = Int(name="assessedid")
778
assessed = Reference(assessed_id, Assessed.id)
779
deadline = DateTime()
780
approver_id = Int(name="approver")
781
approver = Reference(approver_id, User.id)
784
class ProjectSubmission(Storm):
785
"""A submission from a user or group repository to a particular project.
787
The content of a submission is a single path and revision inside a
788
repository. The repository is that owned by the submission's user and
789
group, while the path and revision are explicit.
791
The user or group and project are specified by the Assessed.
794
__storm_table__ = "project_submission"
796
id = Int(name="submissionid", primary=True)
797
assessed_id = Int(name="assessedid")
798
assessed = Reference(assessed_id, Assessed.id)
801
submitter_id = Int(name="submitter")
802
submitter = Reference(submitter_id, User.id)
803
date_submitted = DateTime()
805
def get_verify_url(self, user):
806
"""Get the URL for verifying this submission, within the account of
808
# If this is a solo project, then self.path will be prefixed with the
809
# subject name. Remove the first path segment.
810
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
811
if not self.assessed.is_group:
812
if '/' in submitpath:
813
submitpath = submitpath.split('/', 1)[1]
816
return "/files/%s/%s/%s?r=%d" % (user.login,
817
self.assessed.checkout_location, submitpath, self.revision)
819
# WORKSHEETS AND EXERCISES #
821
class Exercise(Storm):
822
"""An exercise for students to complete in a worksheet.
824
An exercise may be present in any number of worksheets.
827
__storm_table__ = "exercise"
828
id = Unicode(primary=True, name="identifier")
830
description = Unicode()
836
worksheet_exercises = ReferenceSet(id,
837
'WorksheetExercise.exercise_id')
839
worksheets = ReferenceSet(id,
840
'WorksheetExercise.exercise_id',
841
'WorksheetExercise.worksheet_id',
845
test_suites = ReferenceSet(id,
846
'TestSuite.exercise_id',
849
__init__ = _kwarg_init
852
return "<%s %s>" % (type(self).__name__, self.name)
854
def get_permissions(self, user, config):
855
return self.global_permissions(user, config)
858
def global_permissions(user, config):
859
"""Gets the set of permissions this user has over *all* exercises.
860
This is used to determine who may view the exercises list, and create
868
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
871
elif (config['policy']['tutors_can_edit_worksheets']
872
and u'tutor' in set((e.role for e in user.active_enrolments))):
873
# Site-specific policy on the role of tutors
879
def get_description(self):
880
"""Return the description interpreted as reStructuredText."""
881
return rst(self.description)
884
"""Deletes the exercise, providing it has no associated worksheets."""
885
if (self.worksheet_exercises.count() > 0):
886
raise IntegrityError()
887
for suite in self.test_suites:
889
Store.of(self).remove(self)
891
class Worksheet(Storm):
892
"""A worksheet with exercises for students to complete.
894
Worksheets are owned by offerings.
897
__storm_table__ = "worksheet"
899
id = Int(primary=True, name="worksheetid")
900
offering_id = Int(name="offeringid")
901
identifier = Unicode()
908
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
909
offering = Reference(offering_id, 'Offering.id')
911
all_worksheet_exercises = ReferenceSet(id,
912
'WorksheetExercise.worksheet_id')
914
# Use worksheet_exercises to get access to the *active* WorksheetExercise
915
# objects binding worksheets to exercises. This is required to access the
919
def worksheet_exercises(self):
920
return self.all_worksheet_exercises.find(active=True)
922
__init__ = _kwarg_init
925
return "<%s %s>" % (type(self).__name__, self.name)
927
def remove_all_exercises(self):
928
"""Remove all exercises from this worksheet.
930
This does not delete the exercises themselves. It just removes them
933
store = Store.of(self)
934
for ws_ex in self.all_worksheet_exercises:
935
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
936
raise IntegrityError()
937
store.find(WorksheetExercise,
938
WorksheetExercise.worksheet == self).remove()
940
def get_permissions(self, user, config):
941
# Almost the same permissions as for the offering itself
942
perms = self.offering.get_permissions(user, config)
943
# However, "edit" permission is derived from the "edit_worksheets"
944
# permission of the offering
945
if 'edit_worksheets' in perms:
948
perms.discard('edit')
952
"""Returns the xml of this worksheet, converts from rst if required."""
953
if self.format == u'rst':
954
ws_xml = rst(self.data)
960
"""Deletes the worksheet, provided it has no attempts on any exercises.
962
Returns True if delete succeeded, or False if this worksheet has
963
attempts attached."""
964
for ws_ex in self.all_worksheet_exercises:
965
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
966
raise IntegrityError()
968
self.remove_all_exercises()
969
Store.of(self).remove(self)
971
class WorksheetExercise(Storm):
972
"""A link between a worksheet and one of its exercises.
974
These may be marked optional, in which case the exercise does not count
975
for marking purposes. The sequence number is used to order the worksheet
979
__storm_table__ = "worksheet_exercise"
981
id = Int(primary=True, name="ws_ex_id")
983
worksheet_id = Int(name="worksheetid")
984
worksheet = Reference(worksheet_id, Worksheet.id)
985
exercise_id = Unicode(name="exerciseid")
986
exercise = Reference(exercise_id, Exercise.id)
991
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
992
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
994
__init__ = _kwarg_init
997
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
998
self.worksheet.identifier)
1000
def get_permissions(self, user, config):
1001
return self.worksheet.get_permissions(user, config)
1004
class ExerciseSave(Storm):
1005
"""A potential exercise solution submitted by a user for storage.
1007
This is not an actual tested attempt at an exercise, it's just a save of
1008
the editing session.
1011
__storm_table__ = "exercise_save"
1012
__storm_primary__ = "ws_ex_id", "user_id"
1014
ws_ex_id = Int(name="ws_ex_id")
1015
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
1017
user_id = Int(name="loginid")
1018
user = Reference(user_id, User.id)
1022
__init__ = _kwarg_init
1025
return "<%s %s by %s at %s>" % (type(self).__name__,
1026
self.exercise.name, self.user.login, self.date.strftime("%c"))
1028
class ExerciseAttempt(ExerciseSave):
1029
"""An attempt at solving an exercise.
1031
This is a special case of ExerciseSave, used when the user submits a
1032
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1035
In addition, it contains information about the result of the submission:
1037
- complete - True if this submission was successful, rendering this
1038
exercise complete for this user in this worksheet.
1039
- active - True if this submission is "active" (usually true).
1040
Submissions may be de-activated by privileged users for
1041
special reasons, and then they won't count (either as a
1042
penalty or success), but will still be stored.
1045
__storm_table__ = "exercise_attempt"
1046
__storm_primary__ = "ws_ex_id", "user_id", "date"
1048
# The "text" field is the same but has a different name in the DB table
1050
text = Unicode(name="attempt")
1054
def get_permissions(self, user, config):
1055
return set(['view']) if user is self.user else set()
1057
class TestSuite(Storm):
1058
"""A container to group an exercise's test cases.
1060
The test suite contains some information on how to test. The function to
1061
test, variables to set and stdin data are stored here.
1064
__storm_table__ = "test_suite"
1065
__storm_primary__ = "exercise_id", "suiteid"
1068
exercise_id = Unicode(name="exerciseid")
1069
description = Unicode()
1071
function = Unicode()
1073
exercise = Reference(exercise_id, Exercise.id)
1074
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1075
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1078
"""Delete this suite, without asking questions."""
1079
for variable in self.variables:
1081
for test_case in self.test_cases:
1083
Store.of(self).remove(self)
1085
class TestCase(Storm):
1086
"""A container for actual tests (see TestCasePart), inside a test suite.
1088
It is the lowest level shown to students on their pass/fail status."""
1090
__storm_table__ = "test_case"
1091
__storm_primary__ = "testid", "suiteid"
1095
suite = Reference(suiteid, "TestSuite.suiteid")
1098
test_default = Unicode() # Currently unused - only used for file matching.
1101
parts = ReferenceSet(testid, "TestCasePart.testid")
1103
__init__ = _kwarg_init
1106
for part in self.parts:
1108
Store.of(self).remove(self)
1110
class TestSuiteVar(Storm):
1111
"""A variable used by an exercise test suite.
1113
This may represent a function argument or a normal variable.
1116
__storm_table__ = "suite_variable"
1117
__storm_primary__ = "varid"
1121
var_name = Unicode()
1122
var_value = Unicode()
1123
var_type = Unicode()
1126
suite = Reference(suiteid, "TestSuite.suiteid")
1128
__init__ = _kwarg_init
1131
Store.of(self).remove(self)
1133
class TestCasePart(Storm):
1134
"""An actual piece of code to test an exercise solution."""
1136
__storm_table__ = "test_case_part"
1137
__storm_primary__ = "partid"
1142
part_type = Unicode()
1143
test_type = Unicode()
1145
filename = Unicode()
1147
test = Reference(testid, "TestCase.testid")
1149
__init__ = _kwarg_init
1152
Store.of(self).remove(self)
added
removed
ivle/database.py
