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 == u'tutor':
381
perms.add('view_project_submissions')
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 config['policy']['tutors_can_admin_groups']:
389
perms.add('admin_groups')
390
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
391
perms.add('view_project_submissions')
392
perms.add('admin_groups')
393
perms.add('edit_worksheets')
394
perms.add('edit') # Can edit projects & details
395
perms.add('enrol') # Can see enrolment screen at all
396
perms.add('enrol_student') # Can enrol students
397
perms.add('enrol_tutor') # Can enrol tutors
399
perms.add('enrol_lecturer') # Can enrol lecturers
402
def get_enrolment(self, user):
403
"""Find the user's enrolment in this offering."""
405
enrolment = self.enrolments.find(user=user).one()
411
def get_members_by_role(self, role):
412
return Store.of(self).find(User,
413
Enrolment.user_id == User.id,
414
Enrolment.offering_id == self.id,
415
Enrolment.role == role
416
).order_by(User.login)
420
return self.get_members_by_role(u'student')
422
def get_open_projects_for_user(self, user):
423
"""Find all projects currently open to submissions by a user."""
424
# XXX: Respect extensions.
425
return self.projects.find(Project.deadline > datetime.datetime.now())
427
class Enrolment(Storm):
428
"""An enrolment of a user in an offering.
430
This represents the roles of both staff and students.
433
__storm_table__ = "enrolment"
434
__storm_primary__ = "user_id", "offering_id"
436
user_id = Int(name="loginid")
437
user = Reference(user_id, User.id)
438
offering_id = Int(name="offeringid")
439
offering = Reference(offering_id, Offering.id)
446
return Store.of(self).find(ProjectGroup,
447
ProjectSet.offering_id == self.offering.id,
448
ProjectGroup.project_set_id == ProjectSet.id,
449
ProjectGroupMembership.project_group_id == ProjectGroup.id,
450
ProjectGroupMembership.user_id == self.user.id)
452
__init__ = _kwarg_init
455
return "<%s %r in %r>" % (type(self).__name__, self.user,
460
class ProjectSet(Storm):
461
"""A set of projects that share common groups.
463
Each student project group is attached to a project set. The group is
464
valid for all projects in the group's set.
467
__storm_table__ = "project_set"
469
id = Int(name="projectsetid", primary=True)
470
offering_id = Int(name="offeringid")
471
offering = Reference(offering_id, Offering.id)
472
max_students_per_group = Int()
474
projects = ReferenceSet(id, 'Project.project_set_id')
475
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
477
__init__ = _kwarg_init
480
return "<%s %d in %r>" % (type(self).__name__, self.id,
483
def get_permissions(self, user, config):
484
return self.offering.get_permissions(user, config)
486
def get_groups_for_user(self, user):
487
"""List all groups in this offering of which the user is a member."""
489
return Store.of(self).find(
491
ProjectGroupMembership.user_id == user.id,
492
ProjectGroupMembership.project_group_id == ProjectGroup.id,
493
ProjectGroup.project_set_id == self.id)
495
def get_submission_principal(self, user):
496
"""Get the principal on behalf of which the user can submit.
498
If this is a solo project set, the given user is returned. If
499
the user is a member of exactly one group, all the group is
500
returned. Otherwise, None is returned.
503
groups = self.get_groups_for_user(user)
504
if groups.count() == 1:
513
return self.max_students_per_group is not None
517
"""Get the entities (groups or users) assigned to submit this project.
519
This will be a Storm ResultSet.
521
#If its a solo project, return everyone in offering
523
return self.project_groups
525
return self.offering.students
527
class DeadlinePassed(Exception):
528
"""An exception indicating that a project cannot be submitted because the
529
deadline has passed."""
533
return "The project deadline has passed"
535
class Project(Storm):
536
"""A student project for which submissions can be made."""
538
__storm_table__ = "project"
540
id = Int(name="projectid", primary=True)
542
short_name = Unicode()
545
project_set_id = Int(name="projectsetid")
546
project_set = Reference(project_set_id, ProjectSet.id)
547
deadline = DateTime()
549
assesseds = ReferenceSet(id, 'Assessed.project_id')
550
submissions = ReferenceSet(id,
551
'Assessed.project_id',
553
'ProjectSubmission.assessed_id')
555
__init__ = _kwarg_init
558
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
559
self.project_set.offering)
561
def can_submit(self, principal, user):
562
return (self in principal.get_projects() and
563
not self.has_deadline_passed(user))
565
def submit(self, principal, path, revision, who):
566
"""Submit a Subversion path and revision to a project.
568
@param principal: The owner of the Subversion repository, and the
569
entity on behalf of whom the submission is being made
570
@param path: A path within that repository to submit.
571
@param revision: The revision of that path to submit.
572
@param who: The user who is actually making the submission.
575
if not self.can_submit(principal, who):
576
raise DeadlinePassed()
578
a = Assessed.get(Store.of(self), principal, self)
579
ps = ProjectSubmission()
581
ps.revision = revision
582
ps.date_submitted = datetime.datetime.now()
588
def get_permissions(self, user, config):
589
return self.project_set.offering.get_permissions(user, config)
592
def latest_submissions(self):
593
"""Return the latest submission for each Assessed."""
594
return Store.of(self).find(ProjectSubmission,
595
Assessed.project_id == self.id,
596
ProjectSubmission.assessed_id == Assessed.id,
597
ProjectSubmission.date_submitted == Select(
598
Max(ProjectSubmission.date_submitted),
599
ProjectSubmission.assessed_id == Assessed.id,
600
tables=ProjectSubmission
604
def has_deadline_passed(self, user):
605
"""Check whether the deadline has passed."""
606
# XXX: Need to respect extensions.
607
return self.deadline < datetime.datetime.now()
609
def get_submissions_for_principal(self, principal):
610
"""Fetch a ResultSet of all submissions by a particular principal."""
611
assessed = Assessed.get(Store.of(self), principal, self)
614
return assessed.submissions
618
class ProjectGroup(Storm):
619
"""A group of students working together on a project."""
621
__storm_table__ = "project_group"
623
id = Int(name="groupid", primary=True)
624
name = Unicode(name="groupnm")
625
project_set_id = Int(name="projectsetid")
626
project_set = Reference(project_set_id, ProjectSet.id)
628
created_by_id = Int(name="createdby")
629
created_by = Reference(created_by_id, User.id)
632
members = ReferenceSet(id,
633
"ProjectGroupMembership.project_group_id",
634
"ProjectGroupMembership.user_id",
637
__init__ = _kwarg_init
640
return "<%s %s in %r>" % (type(self).__name__, self.name,
641
self.project_set.offering)
644
def display_name(self):
645
"""Returns the "nice name" of the user or group."""
649
def short_name(self):
650
"""Returns the database "identifier" name of the user or group."""
653
def get_projects(self, offering=None, active_only=True):
654
'''Find projects that the group can submit.
656
This will include projects in the project set which owns this group,
657
unless the project set disallows groups (in which case none will be
660
@param active_only: Whether to only search active offerings.
661
@param offering: An optional offering to restrict the search to.
663
return Store.of(self).find(Project,
664
Project.project_set_id == ProjectSet.id,
665
ProjectSet.id == self.project_set.id,
666
ProjectSet.max_students_per_group != None,
667
ProjectSet.offering_id == Offering.id,
668
(offering is None) or (Offering.id == offering.id),
669
Semester.id == Offering.semester_id,
670
(not active_only) or (Semester.state == u'current'))
673
def get_permissions(self, user, config):
674
if user.admin or user in self.members:
675
return set(['submit_project'])
679
class ProjectGroupMembership(Storm):
680
"""A student's membership in a project group."""
682
__storm_table__ = "group_member"
683
__storm_primary__ = "user_id", "project_group_id"
685
user_id = Int(name="loginid")
686
user = Reference(user_id, User.id)
687
project_group_id = Int(name="groupid")
688
project_group = Reference(project_group_id, ProjectGroup.id)
690
__init__ = _kwarg_init
693
return "<%s %r in %r>" % (type(self).__name__, self.user,
696
class Assessed(Storm):
697
"""A composite of a user or group combined with a project.
699
Each project submission and extension refers to an Assessed. It is the
700
sole specifier of the repository and project.
703
__storm_table__ = "assessed"
705
id = Int(name="assessedid", primary=True)
706
user_id = Int(name="loginid")
707
user = Reference(user_id, User.id)
708
project_group_id = Int(name="groupid")
709
project_group = Reference(project_group_id, ProjectGroup.id)
711
project_id = Int(name="projectid")
712
project = Reference(project_id, Project.id)
714
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
715
submissions = ReferenceSet(
716
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
719
return "<%s %r in %r>" % (type(self).__name__,
720
self.user or self.project_group, self.project)
724
"""True if the Assessed is a group, False if it is a user."""
725
return self.project_group is not None
729
return self.project_group or self.user
732
def checkout_location(self):
733
"""Returns the location of the Subversion workspace for this piece of
734
assessment, relative to each group member's home directory."""
735
subjectname = self.project.project_set.offering.subject.short_name
737
checkout_dir_name = self.principal.short_name
739
checkout_dir_name = "mywork"
740
return subjectname + "/" + checkout_dir_name
743
def get(cls, store, principal, project):
744
"""Find or create an Assessed for the given user or group and project.
746
@param principal: The user or group.
747
@param project: The project.
750
if t not in (User, ProjectGroup):
751
raise AssertionError('principal must be User or ProjectGroup')
754
(t is User) or (cls.project_group_id == principal.id),
755
(t is ProjectGroup) or (cls.user_id == principal.id),
756
cls.project_id == project.id).one()
763
a.project_group = principal
770
class ProjectExtension(Storm):
771
"""An extension granted to a user or group on a particular project.
773
The user or group and project are specified by the Assessed.
776
__storm_table__ = "project_extension"
778
id = Int(name="extensionid", primary=True)
779
assessed_id = Int(name="assessedid")
780
assessed = Reference(assessed_id, Assessed.id)
781
deadline = DateTime()
782
approver_id = Int(name="approver")
783
approver = Reference(approver_id, User.id)
786
class ProjectSubmission(Storm):
787
"""A submission from a user or group repository to a particular project.
789
The content of a submission is a single path and revision inside a
790
repository. The repository is that owned by the submission's user and
791
group, while the path and revision are explicit.
793
The user or group and project are specified by the Assessed.
796
__storm_table__ = "project_submission"
798
id = Int(name="submissionid", primary=True)
799
assessed_id = Int(name="assessedid")
800
assessed = Reference(assessed_id, Assessed.id)
803
submitter_id = Int(name="submitter")
804
submitter = Reference(submitter_id, User.id)
805
date_submitted = DateTime()
807
def get_verify_url(self, user):
808
"""Get the URL for verifying this submission, within the account of
810
# If this is a solo project, then self.path will be prefixed with the
811
# subject name. Remove the first path segment.
812
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
813
if not self.assessed.is_group:
814
if '/' in submitpath:
815
submitpath = submitpath.split('/', 1)[1]
818
return "/files/%s/%s/%s?r=%d" % (user.login,
819
self.assessed.checkout_location, submitpath, self.revision)
821
# WORKSHEETS AND EXERCISES #
823
class Exercise(Storm):
824
"""An exercise for students to complete in a worksheet.
826
An exercise may be present in any number of worksheets.
829
__storm_table__ = "exercise"
830
id = Unicode(primary=True, name="identifier")
832
description = Unicode()
838
worksheet_exercises = ReferenceSet(id,
839
'WorksheetExercise.exercise_id')
841
worksheets = ReferenceSet(id,
842
'WorksheetExercise.exercise_id',
843
'WorksheetExercise.worksheet_id',
847
test_suites = ReferenceSet(id,
848
'TestSuite.exercise_id',
851
__init__ = _kwarg_init
854
return "<%s %s>" % (type(self).__name__, self.name)
856
def get_permissions(self, user, config):
857
return self.global_permissions(user, config)
860
def global_permissions(user, config):
861
"""Gets the set of permissions this user has over *all* exercises.
862
This is used to determine who may view the exercises list, and create
870
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
873
elif (config['policy']['tutors_can_edit_worksheets']
874
and u'tutor' in set((e.role for e in user.active_enrolments))):
875
# Site-specific policy on the role of tutors
881
def get_description(self):
882
"""Return the description interpreted as reStructuredText."""
883
return rst(self.description)
886
"""Deletes the exercise, providing it has no associated worksheets."""
887
if (self.worksheet_exercises.count() > 0):
888
raise IntegrityError()
889
for suite in self.test_suites:
891
Store.of(self).remove(self)
893
class Worksheet(Storm):
894
"""A worksheet with exercises for students to complete.
896
Worksheets are owned by offerings.
899
__storm_table__ = "worksheet"
901
id = Int(primary=True, name="worksheetid")
902
offering_id = Int(name="offeringid")
903
identifier = Unicode()
910
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
911
offering = Reference(offering_id, 'Offering.id')
913
all_worksheet_exercises = ReferenceSet(id,
914
'WorksheetExercise.worksheet_id')
916
# Use worksheet_exercises to get access to the *active* WorksheetExercise
917
# objects binding worksheets to exercises. This is required to access the
921
def worksheet_exercises(self):
922
return self.all_worksheet_exercises.find(active=True)
924
__init__ = _kwarg_init
927
return "<%s %s>" % (type(self).__name__, self.name)
929
def remove_all_exercises(self):
930
"""Remove all exercises from this worksheet.
932
This does not delete the exercises themselves. It just removes them
935
store = Store.of(self)
936
for ws_ex in self.all_worksheet_exercises:
937
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
938
raise IntegrityError()
939
store.find(WorksheetExercise,
940
WorksheetExercise.worksheet == self).remove()
942
def get_permissions(self, user, config):
943
# Almost the same permissions as for the offering itself
944
perms = self.offering.get_permissions(user, config)
945
# However, "edit" permission is derived from the "edit_worksheets"
946
# permission of the offering
947
if 'edit_worksheets' in perms:
950
perms.discard('edit')
954
"""Returns the xml of this worksheet, converts from rst if required."""
955
if self.format == u'rst':
956
ws_xml = rst(self.data)
962
"""Deletes the worksheet, provided it has no attempts on any exercises.
964
Returns True if delete succeeded, or False if this worksheet has
965
attempts attached."""
966
for ws_ex in self.all_worksheet_exercises:
967
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
968
raise IntegrityError()
970
self.remove_all_exercises()
971
Store.of(self).remove(self)
973
class WorksheetExercise(Storm):
974
"""A link between a worksheet and one of its exercises.
976
These may be marked optional, in which case the exercise does not count
977
for marking purposes. The sequence number is used to order the worksheet
981
__storm_table__ = "worksheet_exercise"
983
id = Int(primary=True, name="ws_ex_id")
985
worksheet_id = Int(name="worksheetid")
986
worksheet = Reference(worksheet_id, Worksheet.id)
987
exercise_id = Unicode(name="exerciseid")
988
exercise = Reference(exercise_id, Exercise.id)
993
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
994
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
996
__init__ = _kwarg_init
999
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1000
self.worksheet.identifier)
1002
def get_permissions(self, user, config):
1003
return self.worksheet.get_permissions(user, config)
1006
class ExerciseSave(Storm):
1007
"""A potential exercise solution submitted by a user for storage.
1009
This is not an actual tested attempt at an exercise, it's just a save of
1010
the editing session.
1013
__storm_table__ = "exercise_save"
1014
__storm_primary__ = "ws_ex_id", "user_id"
1016
ws_ex_id = Int(name="ws_ex_id")
1017
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
1019
user_id = Int(name="loginid")
1020
user = Reference(user_id, User.id)
1024
__init__ = _kwarg_init
1027
return "<%s %s by %s at %s>" % (type(self).__name__,
1028
self.exercise.name, self.user.login, self.date.strftime("%c"))
1030
class ExerciseAttempt(ExerciseSave):
1031
"""An attempt at solving an exercise.
1033
This is a special case of ExerciseSave, used when the user submits a
1034
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1037
In addition, it contains information about the result of the submission:
1039
- complete - True if this submission was successful, rendering this
1040
exercise complete for this user in this worksheet.
1041
- active - True if this submission is "active" (usually true).
1042
Submissions may be de-activated by privileged users for
1043
special reasons, and then they won't count (either as a
1044
penalty or success), but will still be stored.
1047
__storm_table__ = "exercise_attempt"
1048
__storm_primary__ = "ws_ex_id", "user_id", "date"
1050
# The "text" field is the same but has a different name in the DB table
1052
text = Unicode(name="attempt")
1056
def get_permissions(self, user, config):
1057
return set(['view']) if user is self.user else set()
1059
class TestSuite(Storm):
1060
"""A container to group an exercise's test cases.
1062
The test suite contains some information on how to test. The function to
1063
test, variables to set and stdin data are stored here.
1066
__storm_table__ = "test_suite"
1067
__storm_primary__ = "exercise_id", "suiteid"
1070
exercise_id = Unicode(name="exerciseid")
1071
description = Unicode()
1073
function = Unicode()
1075
exercise = Reference(exercise_id, Exercise.id)
1076
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1077
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1080
"""Delete this suite, without asking questions."""
1081
for variable in self.variables:
1083
for test_case in self.test_cases:
1085
Store.of(self).remove(self)
1087
class TestCase(Storm):
1088
"""A container for actual tests (see TestCasePart), inside a test suite.
1090
It is the lowest level shown to students on their pass/fail status."""
1092
__storm_table__ = "test_case"
1093
__storm_primary__ = "testid", "suiteid"
1097
suite = Reference(suiteid, "TestSuite.suiteid")
1100
test_default = Unicode() # Currently unused - only used for file matching.
1103
parts = ReferenceSet(testid, "TestCasePart.testid")
1105
__init__ = _kwarg_init
1108
for part in self.parts:
1110
Store.of(self).remove(self)
1112
class TestSuiteVar(Storm):
1113
"""A variable used by an exercise test suite.
1115
This may represent a function argument or a normal variable.
1118
__storm_table__ = "suite_variable"
1119
__storm_primary__ = "varid"
1123
var_name = Unicode()
1124
var_value = Unicode()
1125
var_type = Unicode()
1128
suite = Reference(suiteid, "TestSuite.suiteid")
1130
__init__ = _kwarg_init
1133
Store.of(self).remove(self)
1135
class TestCasePart(Storm):
1136
"""An actual piece of code to test an exercise solution."""
1138
__storm_table__ = "test_case_part"
1139
__storm_primary__ = "partid"
1144
part_type = Unicode()
1145
test_type = Unicode()
1147
filename = Unicode()
1149
test = Reference(testid, "TestCase.testid")
1151
__init__ = _kwarg_init
1154
Store.of(self).remove(self)
added
removed
ivle/database.py
