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
# Site-specific policy on the role of tutors
383
if config['policy']['tutors_can_enrol_students']:
385
perms.add('enrol_student')
386
if config['policy']['tutors_can_edit_worksheets']:
387
perms.add('edit_worksheets')
388
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
389
perms.add('edit_worksheets')
390
perms.add('edit') # Can edit projects & details
391
perms.add('enrol') # Can see enrolment screen at all
392
perms.add('enrol_student') # Can enrol students
393
perms.add('enrol_tutor') # Can enrol tutors
395
perms.add('enrol_lecturer') # Can enrol lecturers
398
def get_enrolment(self, user):
399
"""Find the user's enrolment in this offering."""
401
enrolment = self.enrolments.find(user=user).one()
407
def get_members_by_role(self, role):
408
return Store.of(self).find(User,
409
Enrolment.user_id == User.id,
410
Enrolment.offering_id == self.id,
411
Enrolment.role == role
412
).order_by(User.login)
416
return self.get_members_by_role(u'student')
418
def get_open_projects_for_user(self, user):
419
"""Find all projects currently open to submissions by a user."""
420
# XXX: Respect extensions.
421
return self.projects.find(Project.deadline > datetime.datetime.now())
423
class Enrolment(Storm):
424
"""An enrolment of a user in an offering.
426
This represents the roles of both staff and students.
429
__storm_table__ = "enrolment"
430
__storm_primary__ = "user_id", "offering_id"
432
user_id = Int(name="loginid")
433
user = Reference(user_id, User.id)
434
offering_id = Int(name="offeringid")
435
offering = Reference(offering_id, Offering.id)
442
return Store.of(self).find(ProjectGroup,
443
ProjectSet.offering_id == self.offering.id,
444
ProjectGroup.project_set_id == ProjectSet.id,
445
ProjectGroupMembership.project_group_id == ProjectGroup.id,
446
ProjectGroupMembership.user_id == self.user.id)
448
__init__ = _kwarg_init
451
return "<%s %r in %r>" % (type(self).__name__, self.user,
456
class ProjectSet(Storm):
457
"""A set of projects that share common groups.
459
Each student project group is attached to a project set. The group is
460
valid for all projects in the group's set.
463
__storm_table__ = "project_set"
465
id = Int(name="projectsetid", primary=True)
466
offering_id = Int(name="offeringid")
467
offering = Reference(offering_id, Offering.id)
468
max_students_per_group = Int()
470
projects = ReferenceSet(id, 'Project.project_set_id')
471
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
473
__init__ = _kwarg_init
476
return "<%s %d in %r>" % (type(self).__name__, self.id,
479
def get_permissions(self, user, config):
480
return self.offering.get_permissions(user, config)
482
def get_groups_for_user(self, user):
483
"""List all groups in this offering of which the user is a member."""
485
return Store.of(self).find(
487
ProjectGroupMembership.user_id == user.id,
488
ProjectGroupMembership.project_group_id == ProjectGroup.id,
489
ProjectGroup.project_set_id == self.id)
491
def get_submission_principal(self, user):
492
"""Get the principal on behalf of which the user can submit.
494
If this is a solo project set, the given user is returned. If
495
the user is a member of exactly one group, all the group is
496
returned. Otherwise, None is returned.
499
groups = self.get_groups_for_user(user)
500
if groups.count() == 1:
509
return self.max_students_per_group is not None
513
"""Get the entities (groups or users) assigned to submit this project.
515
This will be a Storm ResultSet.
517
#If its a solo project, return everyone in offering
519
return self.project_groups
521
return self.offering.students
523
class DeadlinePassed(Exception):
524
"""An exception indicating that a project cannot be submitted because the
525
deadline has passed."""
529
return "The project deadline has passed"
531
class Project(Storm):
532
"""A student project for which submissions can be made."""
534
__storm_table__ = "project"
536
id = Int(name="projectid", primary=True)
538
short_name = Unicode()
541
project_set_id = Int(name="projectsetid")
542
project_set = Reference(project_set_id, ProjectSet.id)
543
deadline = DateTime()
545
assesseds = ReferenceSet(id, 'Assessed.project_id')
546
submissions = ReferenceSet(id,
547
'Assessed.project_id',
549
'ProjectSubmission.assessed_id')
551
__init__ = _kwarg_init
554
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
555
self.project_set.offering)
557
def can_submit(self, principal, user):
558
return (self in principal.get_projects() and
559
not self.has_deadline_passed(user))
561
def submit(self, principal, path, revision, who):
562
"""Submit a Subversion path and revision to a project.
564
@param principal: The owner of the Subversion repository, and the
565
entity on behalf of whom the submission is being made
566
@param path: A path within that repository to submit.
567
@param revision: The revision of that path to submit.
568
@param who: The user who is actually making the submission.
571
if not self.can_submit(principal, who):
572
raise DeadlinePassed()
574
a = Assessed.get(Store.of(self), principal, self)
575
ps = ProjectSubmission()
577
ps.revision = revision
578
ps.date_submitted = datetime.datetime.now()
584
def get_permissions(self, user, config):
585
return self.project_set.offering.get_permissions(user, config)
588
def latest_submissions(self):
589
"""Return the latest submission for each Assessed."""
590
return Store.of(self).find(ProjectSubmission,
591
Assessed.project_id == self.id,
592
ProjectSubmission.assessed_id == Assessed.id,
593
ProjectSubmission.date_submitted == Select(
594
Max(ProjectSubmission.date_submitted),
595
ProjectSubmission.assessed_id == Assessed.id,
596
tables=ProjectSubmission
600
def has_deadline_passed(self, user):
601
"""Check whether the deadline has passed."""
602
# XXX: Need to respect extensions.
603
return self.deadline < datetime.datetime.now()
605
def get_submissions_for_principal(self, principal):
606
"""Fetch a ResultSet of all submissions by a particular principal."""
607
assessed = Assessed.get(Store.of(self), principal, self)
610
return assessed.submissions
614
class ProjectGroup(Storm):
615
"""A group of students working together on a project."""
617
__storm_table__ = "project_group"
619
id = Int(name="groupid", primary=True)
620
name = Unicode(name="groupnm")
621
project_set_id = Int(name="projectsetid")
622
project_set = Reference(project_set_id, ProjectSet.id)
624
created_by_id = Int(name="createdby")
625
created_by = Reference(created_by_id, User.id)
628
members = ReferenceSet(id,
629
"ProjectGroupMembership.project_group_id",
630
"ProjectGroupMembership.user_id",
633
__init__ = _kwarg_init
636
return "<%s %s in %r>" % (type(self).__name__, self.name,
637
self.project_set.offering)
640
def display_name(self):
641
"""Returns the "nice name" of the user or group."""
645
def short_name(self):
646
"""Returns the database "identifier" name of the user or group."""
649
def get_projects(self, offering=None, active_only=True):
650
'''Find projects that the group can submit.
652
This will include projects in the project set which owns this group,
653
unless the project set disallows groups (in which case none will be
656
@param active_only: Whether to only search active offerings.
657
@param offering: An optional offering to restrict the search to.
659
return Store.of(self).find(Project,
660
Project.project_set_id == ProjectSet.id,
661
ProjectSet.id == self.project_set.id,
662
ProjectSet.max_students_per_group != None,
663
ProjectSet.offering_id == Offering.id,
664
(offering is None) or (Offering.id == offering.id),
665
Semester.id == Offering.semester_id,
666
(not active_only) or (Semester.state == u'current'))
669
def get_permissions(self, user, config):
670
if user.admin or user in self.members:
671
return set(['submit_project'])
675
class ProjectGroupMembership(Storm):
676
"""A student's membership in a project group."""
678
__storm_table__ = "group_member"
679
__storm_primary__ = "user_id", "project_group_id"
681
user_id = Int(name="loginid")
682
user = Reference(user_id, User.id)
683
project_group_id = Int(name="groupid")
684
project_group = Reference(project_group_id, ProjectGroup.id)
686
__init__ = _kwarg_init
689
return "<%s %r in %r>" % (type(self).__name__, self.user,
692
class Assessed(Storm):
693
"""A composite of a user or group combined with a project.
695
Each project submission and extension refers to an Assessed. It is the
696
sole specifier of the repository and project.
699
__storm_table__ = "assessed"
701
id = Int(name="assessedid", primary=True)
702
user_id = Int(name="loginid")
703
user = Reference(user_id, User.id)
704
project_group_id = Int(name="groupid")
705
project_group = Reference(project_group_id, ProjectGroup.id)
707
project_id = Int(name="projectid")
708
project = Reference(project_id, Project.id)
710
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
711
submissions = ReferenceSet(
712
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
715
return "<%s %r in %r>" % (type(self).__name__,
716
self.user or self.project_group, self.project)
720
"""True if the Assessed is a group, False if it is a user."""
721
return self.project_group is not None
725
return self.project_group or self.user
728
def checkout_location(self):
729
"""Returns the location of the Subversion workspace for this piece of
730
assessment, relative to each group member's home directory."""
731
subjectname = self.project.project_set.offering.subject.short_name
733
checkout_dir_name = self.principal.short_name
735
checkout_dir_name = "mywork"
736
return subjectname + "/" + checkout_dir_name
739
def get(cls, store, principal, project):
740
"""Find or create an Assessed for the given user or group and project.
742
@param principal: The user or group.
743
@param project: The project.
746
if t not in (User, ProjectGroup):
747
raise AssertionError('principal must be User or ProjectGroup')
750
(t is User) or (cls.project_group_id == principal.id),
751
(t is ProjectGroup) or (cls.user_id == principal.id),
752
cls.project_id == project.id).one()
759
a.project_group = principal
766
class ProjectExtension(Storm):
767
"""An extension granted to a user or group on a particular project.
769
The user or group and project are specified by the Assessed.
772
__storm_table__ = "project_extension"
774
id = Int(name="extensionid", primary=True)
775
assessed_id = Int(name="assessedid")
776
assessed = Reference(assessed_id, Assessed.id)
777
deadline = DateTime()
778
approver_id = Int(name="approver")
779
approver = Reference(approver_id, User.id)
782
class ProjectSubmission(Storm):
783
"""A submission from a user or group repository to a particular project.
785
The content of a submission is a single path and revision inside a
786
repository. The repository is that owned by the submission's user and
787
group, while the path and revision are explicit.
789
The user or group and project are specified by the Assessed.
792
__storm_table__ = "project_submission"
794
id = Int(name="submissionid", primary=True)
795
assessed_id = Int(name="assessedid")
796
assessed = Reference(assessed_id, Assessed.id)
799
submitter_id = Int(name="submitter")
800
submitter = Reference(submitter_id, User.id)
801
date_submitted = DateTime()
803
def get_verify_url(self, user):
804
"""Get the URL for verifying this submission, within the account of
806
# If this is a solo project, then self.path will be prefixed with the
807
# subject name. Remove the first path segment.
808
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
809
if not self.assessed.is_group:
810
if '/' in submitpath:
811
submitpath = submitpath.split('/', 1)[1]
814
return "/files/%s/%s/%s?r=%d" % (user.login,
815
self.assessed.checkout_location, submitpath, self.revision)
817
# WORKSHEETS AND EXERCISES #
819
class Exercise(Storm):
820
"""An exercise for students to complete in a worksheet.
822
An exercise may be present in any number of worksheets.
825
__storm_table__ = "exercise"
826
id = Unicode(primary=True, name="identifier")
828
description = Unicode()
834
worksheet_exercises = ReferenceSet(id,
835
'WorksheetExercise.exercise_id')
837
worksheets = ReferenceSet(id,
838
'WorksheetExercise.exercise_id',
839
'WorksheetExercise.worksheet_id',
843
test_suites = ReferenceSet(id,
844
'TestSuite.exercise_id',
847
__init__ = _kwarg_init
850
return "<%s %s>" % (type(self).__name__, self.name)
852
def get_permissions(self, user, config):
853
return self.global_permissions(user, config)
856
def global_permissions(user, config):
857
"""Gets the set of permissions this user has over *all* exercises.
858
This is used to determine who may view the exercises list, and create
866
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
869
elif (config['policy']['tutors_can_edit_worksheets']
870
and u'tutor' in set((e.role for e in user.active_enrolments))):
871
# Site-specific policy on the role of tutors
877
def get_description(self):
878
"""Return the description interpreted as reStructuredText."""
879
return rst(self.description)
882
"""Deletes the exercise, providing it has no associated worksheets."""
883
if (self.worksheet_exercises.count() > 0):
884
raise IntegrityError()
885
for suite in self.test_suites:
887
Store.of(self).remove(self)
889
class Worksheet(Storm):
890
"""A worksheet with exercises for students to complete.
892
Worksheets are owned by offerings.
895
__storm_table__ = "worksheet"
897
id = Int(primary=True, name="worksheetid")
898
offering_id = Int(name="offeringid")
899
identifier = Unicode()
906
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
907
offering = Reference(offering_id, 'Offering.id')
909
all_worksheet_exercises = ReferenceSet(id,
910
'WorksheetExercise.worksheet_id')
912
# Use worksheet_exercises to get access to the *active* WorksheetExercise
913
# objects binding worksheets to exercises. This is required to access the
917
def worksheet_exercises(self):
918
return self.all_worksheet_exercises.find(active=True)
920
__init__ = _kwarg_init
923
return "<%s %s>" % (type(self).__name__, self.name)
925
def remove_all_exercises(self):
926
"""Remove all exercises from this worksheet.
928
This does not delete the exercises themselves. It just removes them
931
store = Store.of(self)
932
for ws_ex in self.all_worksheet_exercises:
933
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
934
raise IntegrityError()
935
store.find(WorksheetExercise,
936
WorksheetExercise.worksheet == self).remove()
938
def get_permissions(self, user, config):
939
# Almost the same permissions as for the offering itself
940
perms = self.offering.get_permissions(user, config)
941
# However, "edit" permission is derived from the "edit_worksheets"
942
# permission of the offering
943
if 'edit_worksheets' in perms:
946
perms.discard('edit')
950
"""Returns the xml of this worksheet, converts from rst if required."""
951
if self.format == u'rst':
952
ws_xml = rst(self.data)
958
"""Deletes the worksheet, provided it has no attempts on any exercises.
960
Returns True if delete succeeded, or False if this worksheet has
961
attempts attached."""
962
for ws_ex in self.all_worksheet_exercises:
963
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
964
raise IntegrityError()
966
self.remove_all_exercises()
967
Store.of(self).remove(self)
969
class WorksheetExercise(Storm):
970
"""A link between a worksheet and one of its exercises.
972
These may be marked optional, in which case the exercise does not count
973
for marking purposes. The sequence number is used to order the worksheet
977
__storm_table__ = "worksheet_exercise"
979
id = Int(primary=True, name="ws_ex_id")
981
worksheet_id = Int(name="worksheetid")
982
worksheet = Reference(worksheet_id, Worksheet.id)
983
exercise_id = Unicode(name="exerciseid")
984
exercise = Reference(exercise_id, Exercise.id)
989
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
990
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
992
__init__ = _kwarg_init
995
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
996
self.worksheet.identifier)
998
def get_permissions(self, user, config):
999
return self.worksheet.get_permissions(user, config)
1002
class ExerciseSave(Storm):
1003
"""A potential exercise solution submitted by a user for storage.
1005
This is not an actual tested attempt at an exercise, it's just a save of
1006
the editing session.
1009
__storm_table__ = "exercise_save"
1010
__storm_primary__ = "ws_ex_id", "user_id"
1012
ws_ex_id = Int(name="ws_ex_id")
1013
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
1015
user_id = Int(name="loginid")
1016
user = Reference(user_id, User.id)
1020
__init__ = _kwarg_init
1023
return "<%s %s by %s at %s>" % (type(self).__name__,
1024
self.exercise.name, self.user.login, self.date.strftime("%c"))
1026
class ExerciseAttempt(ExerciseSave):
1027
"""An attempt at solving an exercise.
1029
This is a special case of ExerciseSave, used when the user submits a
1030
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1033
In addition, it contains information about the result of the submission:
1035
- complete - True if this submission was successful, rendering this
1036
exercise complete for this user in this worksheet.
1037
- active - True if this submission is "active" (usually true).
1038
Submissions may be de-activated by privileged users for
1039
special reasons, and then they won't count (either as a
1040
penalty or success), but will still be stored.
1043
__storm_table__ = "exercise_attempt"
1044
__storm_primary__ = "ws_ex_id", "user_id", "date"
1046
# The "text" field is the same but has a different name in the DB table
1048
text = Unicode(name="attempt")
1052
def get_permissions(self, user, config):
1053
return set(['view']) if user is self.user else set()
1055
class TestSuite(Storm):
1056
"""A container to group an exercise's test cases.
1058
The test suite contains some information on how to test. The function to
1059
test, variables to set and stdin data are stored here.
1062
__storm_table__ = "test_suite"
1063
__storm_primary__ = "exercise_id", "suiteid"
1066
exercise_id = Unicode(name="exerciseid")
1067
description = Unicode()
1069
function = Unicode()
1071
exercise = Reference(exercise_id, Exercise.id)
1072
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1073
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1076
"""Delete this suite, without asking questions."""
1077
for variable in self.variables:
1079
for test_case in self.test_cases:
1081
Store.of(self).remove(self)
1083
class TestCase(Storm):
1084
"""A container for actual tests (see TestCasePart), inside a test suite.
1086
It is the lowest level shown to students on their pass/fail status."""
1088
__storm_table__ = "test_case"
1089
__storm_primary__ = "testid", "suiteid"
1093
suite = Reference(suiteid, "TestSuite.suiteid")
1096
test_default = Unicode() # Currently unused - only used for file matching.
1099
parts = ReferenceSet(testid, "TestCasePart.testid")
1101
__init__ = _kwarg_init
1104
for part in self.parts:
1106
Store.of(self).remove(self)
1108
class TestSuiteVar(Storm):
1109
"""A variable used by an exercise test suite.
1111
This may represent a function argument or a normal variable.
1114
__storm_table__ = "suite_variable"
1115
__storm_primary__ = "varid"
1119
var_name = Unicode()
1120
var_value = Unicode()
1121
var_type = Unicode()
1124
suite = Reference(suiteid, "TestSuite.suiteid")
1126
__init__ = _kwarg_init
1129
Store.of(self).remove(self)
1131
class TestCasePart(Storm):
1132
"""An actual piece of code to test an exercise solution."""
1134
__storm_table__ = "test_case_part"
1135
__storm_primary__ = "partid"
1140
part_type = Unicode()
1141
test_type = Unicode()
1143
filename = Unicode()
1145
test = Reference(testid, "TestCase.testid")
1147
__init__ = _kwarg_init
1150
Store.of(self).remove(self)
added
removed
ivle/database.py
