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,
219
Enrolment.active == True)
222
def hash_password(password):
223
"""Hash a password with MD5."""
224
return hashlib.md5(password).hexdigest()
227
def get_by_login(cls, store, login):
228
"""Find a user in a store by login name."""
229
return store.find(cls, cls.login == unicode(login)).one()
231
def get_permissions(self, user, config):
232
"""Determine privileges held by a user over this object.
234
If the user requesting privileges is this user or an admin,
235
they may do everything. Otherwise they may do nothing.
237
if user and user.admin or user is self:
238
return set(['view_public', 'view', 'edit', 'submit_project'])
240
return set(['view_public'])
242
# SUBJECTS AND ENROLMENTS #
244
class Subject(Storm):
245
"""A subject (or course) which is run in some semesters."""
247
__storm_table__ = "subject"
249
id = Int(primary=True, name="subjectid")
250
code = Unicode(name="subj_code")
251
name = Unicode(name="subj_name")
252
short_name = Unicode(name="subj_short_name")
254
offerings = ReferenceSet(id, 'Offering.subject_id')
256
__init__ = _kwarg_init
259
return "<%s '%s'>" % (type(self).__name__, self.short_name)
261
def get_permissions(self, user, config):
262
"""Determine privileges held by a user over this object.
264
If the user requesting privileges is an admin, they may edit.
265
Otherwise they may only read.
274
def active_offerings(self):
275
"""Find active offerings for this subject.
277
Return a sequence of currently active offerings for this subject
278
(offerings whose semester.state is "current"). There should be 0 or 1
279
elements in this sequence, but it's possible there are more.
281
return self.offerings.find(Offering.semester_id == Semester.id,
282
Semester.state == u'current')
284
def offering_for_semester(self, year, semester):
285
"""Get the offering for the given year/semester, or None.
287
@param year: A string representation of the year.
288
@param semester: A string representation of the semester.
290
return self.offerings.find(Offering.semester_id == Semester.id,
291
Semester.year == unicode(year),
292
Semester.semester == unicode(semester)).one()
294
class Semester(Storm):
295
"""A semester in which subjects can be run."""
297
__storm_table__ = "semester"
299
id = Int(primary=True, name="semesterid")
304
offerings = ReferenceSet(id, 'Offering.semester_id')
305
enrolments = ReferenceSet(id,
306
'Offering.semester_id',
308
'Enrolment.offering_id')
310
__init__ = _kwarg_init
313
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
315
class Offering(Storm):
316
"""An offering of a subject in a particular semester."""
318
__storm_table__ = "offering"
320
id = Int(primary=True, name="offeringid")
321
subject_id = Int(name="subject")
322
subject = Reference(subject_id, Subject.id)
323
semester_id = Int(name="semesterid")
324
semester = Reference(semester_id, Semester.id)
325
description = Unicode()
327
groups_student_permissions = Unicode()
329
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
330
members = ReferenceSet(id,
331
'Enrolment.offering_id',
334
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
335
projects = ReferenceSet(id,
336
'ProjectSet.offering_id',
338
'Project.project_set_id')
340
worksheets = ReferenceSet(id,
341
'Worksheet.offering_id',
345
__init__ = _kwarg_init
348
return "<%s %r in %r>" % (type(self).__name__, self.subject,
351
def enrol(self, user, role=u'student'):
352
"""Enrol a user in this offering.
354
Enrolments handle both the staff and student cases. The role controls
355
the privileges granted by this enrolment.
357
enrolment = Store.of(self).find(Enrolment,
358
Enrolment.user_id == user.id,
359
Enrolment.offering_id == self.id).one()
361
if enrolment is None:
362
enrolment = Enrolment(user=user, offering=self)
363
self.enrolments.add(enrolment)
365
enrolment.active = True
366
enrolment.role = role
368
def unenrol(self, user):
369
'''Unenrol a user from this offering.'''
370
enrolment = Store.of(self).find(Enrolment,
371
Enrolment.user_id == user.id,
372
Enrolment.offering_id == self.id).one()
373
Store.of(enrolment).remove(enrolment)
375
def get_permissions(self, user, config):
378
enrolment = self.get_enrolment(user)
379
if enrolment or user.admin:
381
if enrolment and enrolment.role == u'tutor':
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 config['policy']['tutors_can_admin_groups']:
390
perms.add('admin_groups')
391
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
392
perms.add('view_project_submissions')
393
perms.add('admin_groups')
394
perms.add('edit_worksheets')
395
perms.add('edit') # Can edit projects & details
396
perms.add('enrol') # Can see enrolment screen at all
397
perms.add('enrol_student') # Can enrol students
398
perms.add('enrol_tutor') # Can enrol tutors
400
perms.add('enrol_lecturer') # Can enrol lecturers
403
def get_enrolment(self, user):
404
"""Find the user's enrolment in this offering."""
406
enrolment = self.enrolments.find(user=user).one()
412
def get_members_by_role(self, role):
413
return Store.of(self).find(User,
414
Enrolment.user_id == User.id,
415
Enrolment.offering_id == self.id,
416
Enrolment.role == role
417
).order_by(User.login)
421
return self.get_members_by_role(u'student')
423
def get_open_projects_for_user(self, user):
424
"""Find all projects currently open to submissions by a user."""
425
# XXX: Respect extensions.
426
return self.projects.find(Project.deadline > datetime.datetime.now())
428
class Enrolment(Storm):
429
"""An enrolment of a user in an offering.
431
This represents the roles of both staff and students.
434
__storm_table__ = "enrolment"
435
__storm_primary__ = "user_id", "offering_id"
437
user_id = Int(name="loginid")
438
user = Reference(user_id, User.id)
439
offering_id = Int(name="offeringid")
440
offering = Reference(offering_id, Offering.id)
447
return Store.of(self).find(ProjectGroup,
448
ProjectSet.offering_id == self.offering.id,
449
ProjectGroup.project_set_id == ProjectSet.id,
450
ProjectGroupMembership.project_group_id == ProjectGroup.id,
451
ProjectGroupMembership.user_id == self.user.id)
453
__init__ = _kwarg_init
456
return "<%s %r in %r>" % (type(self).__name__, self.user,
461
class ProjectSet(Storm):
462
"""A set of projects that share common groups.
464
Each student project group is attached to a project set. The group is
465
valid for all projects in the group's set.
468
__storm_table__ = "project_set"
470
id = Int(name="projectsetid", primary=True)
471
offering_id = Int(name="offeringid")
472
offering = Reference(offering_id, Offering.id)
473
max_students_per_group = Int()
475
projects = ReferenceSet(id, 'Project.project_set_id')
476
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
478
__init__ = _kwarg_init
481
return "<%s %d in %r>" % (type(self).__name__, self.id,
484
def get_permissions(self, user, config):
485
return self.offering.get_permissions(user, config)
487
def get_groups_for_user(self, user):
488
"""List all groups in this offering of which the user is a member."""
490
return Store.of(self).find(
492
ProjectGroupMembership.user_id == user.id,
493
ProjectGroupMembership.project_group_id == ProjectGroup.id,
494
ProjectGroup.project_set_id == self.id)
496
def get_submission_principal(self, user):
497
"""Get the principal on behalf of which the user can submit.
499
If this is a solo project set, the given user is returned. If
500
the user is a member of exactly one group, all the group is
501
returned. Otherwise, None is returned.
504
groups = self.get_groups_for_user(user)
505
if groups.count() == 1:
514
return self.max_students_per_group is not None
518
"""Get the entities (groups or users) assigned to submit this project.
520
This will be a Storm ResultSet.
522
#If its a solo project, return everyone in offering
524
return self.project_groups
526
return self.offering.students
528
class DeadlinePassed(Exception):
529
"""An exception indicating that a project cannot be submitted because the
530
deadline has passed."""
534
return "The project deadline has passed"
536
class Project(Storm):
537
"""A student project for which submissions can be made."""
539
__storm_table__ = "project"
541
id = Int(name="projectid", primary=True)
543
short_name = Unicode()
546
project_set_id = Int(name="projectsetid")
547
project_set = Reference(project_set_id, ProjectSet.id)
548
deadline = DateTime()
550
assesseds = ReferenceSet(id, 'Assessed.project_id')
551
submissions = ReferenceSet(id,
552
'Assessed.project_id',
554
'ProjectSubmission.assessed_id')
556
__init__ = _kwarg_init
559
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
560
self.project_set.offering)
562
def can_submit(self, principal, user):
563
return (self in principal.get_projects() and
564
not self.has_deadline_passed(user))
566
def submit(self, principal, path, revision, who):
567
"""Submit a Subversion path and revision to a project.
569
@param principal: The owner of the Subversion repository, and the
570
entity on behalf of whom the submission is being made
571
@param path: A path within that repository to submit.
572
@param revision: The revision of that path to submit.
573
@param who: The user who is actually making the submission.
576
if not self.can_submit(principal, who):
577
raise DeadlinePassed()
579
a = Assessed.get(Store.of(self), principal, self)
580
ps = ProjectSubmission()
582
ps.revision = revision
583
ps.date_submitted = datetime.datetime.now()
589
def get_permissions(self, user, config):
590
return self.project_set.offering.get_permissions(user, config)
593
def latest_submissions(self):
594
"""Return the latest submission for each Assessed."""
595
return Store.of(self).find(ProjectSubmission,
596
Assessed.project_id == self.id,
597
ProjectSubmission.assessed_id == Assessed.id,
598
ProjectSubmission.date_submitted == Select(
599
Max(ProjectSubmission.date_submitted),
600
ProjectSubmission.assessed_id == Assessed.id,
601
tables=ProjectSubmission
605
def has_deadline_passed(self, user):
606
"""Check whether the deadline has passed."""
607
# XXX: Need to respect extensions.
608
return self.deadline < datetime.datetime.now()
610
def get_submissions_for_principal(self, principal):
611
"""Fetch a ResultSet of all submissions by a particular principal."""
612
assessed = Assessed.get(Store.of(self), principal, self)
615
return assessed.submissions
619
class ProjectGroup(Storm):
620
"""A group of students working together on a project."""
622
__storm_table__ = "project_group"
624
id = Int(name="groupid", primary=True)
625
name = Unicode(name="groupnm")
626
project_set_id = Int(name="projectsetid")
627
project_set = Reference(project_set_id, ProjectSet.id)
629
created_by_id = Int(name="createdby")
630
created_by = Reference(created_by_id, User.id)
633
members = ReferenceSet(id,
634
"ProjectGroupMembership.project_group_id",
635
"ProjectGroupMembership.user_id",
638
__init__ = _kwarg_init
641
return "<%s %s in %r>" % (type(self).__name__, self.name,
642
self.project_set.offering)
645
def display_name(self):
646
"""Returns the "nice name" of the user or group."""
650
def short_name(self):
651
"""Returns the database "identifier" name of the user or group."""
654
def get_projects(self, offering=None, active_only=True):
655
'''Find projects that the group can submit.
657
This will include projects in the project set which owns this group,
658
unless the project set disallows groups (in which case none will be
661
@param active_only: Whether to only search active offerings.
662
@param offering: An optional offering to restrict the search to.
664
return Store.of(self).find(Project,
665
Project.project_set_id == ProjectSet.id,
666
ProjectSet.id == self.project_set.id,
667
ProjectSet.max_students_per_group != None,
668
ProjectSet.offering_id == Offering.id,
669
(offering is None) or (Offering.id == offering.id),
670
Semester.id == Offering.semester_id,
671
(not active_only) or (Semester.state == u'current'))
674
def get_permissions(self, user, config):
675
if user.admin or user in self.members:
676
return set(['submit_project'])
680
class ProjectGroupMembership(Storm):
681
"""A student's membership in a project group."""
683
__storm_table__ = "group_member"
684
__storm_primary__ = "user_id", "project_group_id"
686
user_id = Int(name="loginid")
687
user = Reference(user_id, User.id)
688
project_group_id = Int(name="groupid")
689
project_group = Reference(project_group_id, ProjectGroup.id)
691
__init__ = _kwarg_init
694
return "<%s %r in %r>" % (type(self).__name__, self.user,
697
class Assessed(Storm):
698
"""A composite of a user or group combined with a project.
700
Each project submission and extension refers to an Assessed. It is the
701
sole specifier of the repository and project.
704
__storm_table__ = "assessed"
706
id = Int(name="assessedid", primary=True)
707
user_id = Int(name="loginid")
708
user = Reference(user_id, User.id)
709
project_group_id = Int(name="groupid")
710
project_group = Reference(project_group_id, ProjectGroup.id)
712
project_id = Int(name="projectid")
713
project = Reference(project_id, Project.id)
715
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
716
submissions = ReferenceSet(
717
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
720
return "<%s %r in %r>" % (type(self).__name__,
721
self.user or self.project_group, self.project)
725
"""True if the Assessed is a group, False if it is a user."""
726
return self.project_group is not None
730
return self.project_group or self.user
733
def checkout_location(self):
734
"""Returns the location of the Subversion workspace for this piece of
735
assessment, relative to each group member's home directory."""
736
subjectname = self.project.project_set.offering.subject.short_name
738
checkout_dir_name = self.principal.short_name
740
checkout_dir_name = "mywork"
741
return subjectname + "/" + checkout_dir_name
744
def get(cls, store, principal, project):
745
"""Find or create an Assessed for the given user or group and project.
747
@param principal: The user or group.
748
@param project: The project.
751
if t not in (User, ProjectGroup):
752
raise AssertionError('principal must be User or ProjectGroup')
755
(t is User) or (cls.project_group_id == principal.id),
756
(t is ProjectGroup) or (cls.user_id == principal.id),
757
cls.project_id == project.id).one()
764
a.project_group = principal
771
class ProjectExtension(Storm):
772
"""An extension granted to a user or group on a particular project.
774
The user or group and project are specified by the Assessed.
777
__storm_table__ = "project_extension"
779
id = Int(name="extensionid", primary=True)
780
assessed_id = Int(name="assessedid")
781
assessed = Reference(assessed_id, Assessed.id)
782
deadline = DateTime()
783
approver_id = Int(name="approver")
784
approver = Reference(approver_id, User.id)
787
class ProjectSubmission(Storm):
788
"""A submission from a user or group repository to a particular project.
790
The content of a submission is a single path and revision inside a
791
repository. The repository is that owned by the submission's user and
792
group, while the path and revision are explicit.
794
The user or group and project are specified by the Assessed.
797
__storm_table__ = "project_submission"
799
id = Int(name="submissionid", primary=True)
800
assessed_id = Int(name="assessedid")
801
assessed = Reference(assessed_id, Assessed.id)
804
submitter_id = Int(name="submitter")
805
submitter = Reference(submitter_id, User.id)
806
date_submitted = DateTime()
808
def get_verify_url(self, user):
809
"""Get the URL for verifying this submission, within the account of
811
# If this is a solo project, then self.path will be prefixed with the
812
# subject name. Remove the first path segment.
813
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
814
if not self.assessed.is_group:
815
if '/' in submitpath:
816
submitpath = submitpath.split('/', 1)[1]
819
return "/files/%s/%s/%s?r=%d" % (user.login,
820
self.assessed.checkout_location, submitpath, self.revision)
822
# WORKSHEETS AND EXERCISES #
824
class Exercise(Storm):
825
"""An exercise for students to complete in a worksheet.
827
An exercise may be present in any number of worksheets.
830
__storm_table__ = "exercise"
831
id = Unicode(primary=True, name="identifier")
833
description = Unicode()
839
worksheet_exercises = ReferenceSet(id,
840
'WorksheetExercise.exercise_id')
842
worksheets = ReferenceSet(id,
843
'WorksheetExercise.exercise_id',
844
'WorksheetExercise.worksheet_id',
848
test_suites = ReferenceSet(id,
849
'TestSuite.exercise_id',
852
__init__ = _kwarg_init
855
return "<%s %s>" % (type(self).__name__, self.name)
857
def get_permissions(self, user, config):
858
return self.global_permissions(user, config)
861
def global_permissions(user, config):
862
"""Gets the set of permissions this user has over *all* exercises.
863
This is used to determine who may view the exercises list, and create
871
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
874
elif (config['policy']['tutors_can_edit_worksheets']
875
and u'tutor' in set((e.role for e in user.active_enrolments))):
876
# Site-specific policy on the role of tutors
882
def get_description(self):
883
"""Return the description interpreted as reStructuredText."""
884
return rst(self.description)
887
"""Deletes the exercise, providing it has no associated worksheets."""
888
if (self.worksheet_exercises.count() > 0):
889
raise IntegrityError()
890
for suite in self.test_suites:
892
Store.of(self).remove(self)
894
class Worksheet(Storm):
895
"""A worksheet with exercises for students to complete.
897
Worksheets are owned by offerings.
900
__storm_table__ = "worksheet"
902
id = Int(primary=True, name="worksheetid")
903
offering_id = Int(name="offeringid")
904
identifier = Unicode()
911
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
912
offering = Reference(offering_id, 'Offering.id')
914
all_worksheet_exercises = ReferenceSet(id,
915
'WorksheetExercise.worksheet_id')
917
# Use worksheet_exercises to get access to the *active* WorksheetExercise
918
# objects binding worksheets to exercises. This is required to access the
922
def worksheet_exercises(self):
923
return self.all_worksheet_exercises.find(active=True)
925
__init__ = _kwarg_init
928
return "<%s %s>" % (type(self).__name__, self.name)
930
def remove_all_exercises(self):
931
"""Remove all exercises from this worksheet.
933
This does not delete the exercises themselves. It just removes them
936
store = Store.of(self)
937
for ws_ex in self.all_worksheet_exercises:
938
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
939
raise IntegrityError()
940
store.find(WorksheetExercise,
941
WorksheetExercise.worksheet == self).remove()
943
def get_permissions(self, user, config):
944
# Almost the same permissions as for the offering itself
945
perms = self.offering.get_permissions(user, config)
946
# However, "edit" permission is derived from the "edit_worksheets"
947
# permission of the offering
948
if 'edit_worksheets' in perms:
951
perms.discard('edit')
955
"""Returns the xml of this worksheet, converts from rst if required."""
956
if self.format == u'rst':
957
ws_xml = rst(self.data)
963
"""Deletes the worksheet, provided it has no attempts on any exercises.
965
Returns True if delete succeeded, or False if this worksheet has
966
attempts attached."""
967
for ws_ex in self.all_worksheet_exercises:
968
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
969
raise IntegrityError()
971
self.remove_all_exercises()
972
Store.of(self).remove(self)
974
class WorksheetExercise(Storm):
975
"""A link between a worksheet and one of its exercises.
977
These may be marked optional, in which case the exercise does not count
978
for marking purposes. The sequence number is used to order the worksheet
982
__storm_table__ = "worksheet_exercise"
984
id = Int(primary=True, name="ws_ex_id")
986
worksheet_id = Int(name="worksheetid")
987
worksheet = Reference(worksheet_id, Worksheet.id)
988
exercise_id = Unicode(name="exerciseid")
989
exercise = Reference(exercise_id, Exercise.id)
994
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
995
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
997
__init__ = _kwarg_init
1000
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1001
self.worksheet.identifier)
1003
def get_permissions(self, user, config):
1004
return self.worksheet.get_permissions(user, config)
1007
class ExerciseSave(Storm):
1008
"""A potential exercise solution submitted by a user for storage.
1010
This is not an actual tested attempt at an exercise, it's just a save of
1011
the editing session.
1014
__storm_table__ = "exercise_save"
1015
__storm_primary__ = "ws_ex_id", "user_id"
1017
ws_ex_id = Int(name="ws_ex_id")
1018
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
1020
user_id = Int(name="loginid")
1021
user = Reference(user_id, User.id)
1025
__init__ = _kwarg_init
1028
return "<%s %s by %s at %s>" % (type(self).__name__,
1029
self.exercise.name, self.user.login, self.date.strftime("%c"))
1031
class ExerciseAttempt(ExerciseSave):
1032
"""An attempt at solving an exercise.
1034
This is a special case of ExerciseSave, used when the user submits a
1035
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1038
In addition, it contains information about the result of the submission:
1040
- complete - True if this submission was successful, rendering this
1041
exercise complete for this user in this worksheet.
1042
- active - True if this submission is "active" (usually true).
1043
Submissions may be de-activated by privileged users for
1044
special reasons, and then they won't count (either as a
1045
penalty or success), but will still be stored.
1048
__storm_table__ = "exercise_attempt"
1049
__storm_primary__ = "ws_ex_id", "user_id", "date"
1051
# The "text" field is the same but has a different name in the DB table
1053
text = Unicode(name="attempt")
1057
def get_permissions(self, user, config):
1058
return set(['view']) if user is self.user else set()
1060
class TestSuite(Storm):
1061
"""A container to group an exercise's test cases.
1063
The test suite contains some information on how to test. The function to
1064
test, variables to set and stdin data are stored here.
1067
__storm_table__ = "test_suite"
1068
__storm_primary__ = "exercise_id", "suiteid"
1071
exercise_id = Unicode(name="exerciseid")
1072
description = Unicode()
1074
function = Unicode()
1076
exercise = Reference(exercise_id, Exercise.id)
1077
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1078
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1081
"""Delete this suite, without asking questions."""
1082
for variable in self.variables:
1084
for test_case in self.test_cases:
1086
Store.of(self).remove(self)
1088
class TestCase(Storm):
1089
"""A container for actual tests (see TestCasePart), inside a test suite.
1091
It is the lowest level shown to students on their pass/fail status."""
1093
__storm_table__ = "test_case"
1094
__storm_primary__ = "testid", "suiteid"
1098
suite = Reference(suiteid, "TestSuite.suiteid")
1101
test_default = Unicode() # Currently unused - only used for file matching.
1104
parts = ReferenceSet(testid, "TestCasePart.testid")
1106
__init__ = _kwarg_init
1109
for part in self.parts:
1111
Store.of(self).remove(self)
1113
class TestSuiteVar(Storm):
1114
"""A variable used by an exercise test suite.
1116
This may represent a function argument or a normal variable.
1119
__storm_table__ = "suite_variable"
1120
__storm_primary__ = "varid"
1124
var_name = Unicode()
1125
var_value = Unicode()
1126
var_type = Unicode()
1129
suite = Reference(suiteid, "TestSuite.suiteid")
1131
__init__ = _kwarg_init
1134
Store.of(self).remove(self)
1136
class TestCasePart(Storm):
1137
"""An actual piece of code to test an exercise solution."""
1139
__storm_table__ = "test_case_part"
1140
__storm_primary__ = "partid"
1145
part_type = Unicode()
1146
test_type = Unicode()
1148
filename = Unicode()
1150
test = Reference(testid, "TestCase.testid")
1152
__init__ = _kwarg_init
1155
Store.of(self).remove(self)
added
removed
ivle/database.py
