1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Author: Matt Giuca, Will Grant
20
"""Database utilities and content classes.
22
This module provides all of the classes which map to database tables.
23
It also provides miscellaneous utility functions for database interaction.
29
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
30
Reference, ReferenceSet, Bool, Storm, Desc
31
from storm.expr import Select, Max
32
from storm.exceptions import NotOneError, IntegrityError
34
from ivle.worksheet.rst import rst
36
__all__ = ['get_store',
38
'Subject', 'Semester', 'Offering', 'Enrolment',
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
'Exercise', 'Worksheet', 'WorksheetExercise',
42
'ExerciseSave', 'ExerciseAttempt',
43
'TestCase', 'TestSuite', 'TestSuiteVar'
46
def _kwarg_init(self, **kwargs):
47
for k,v in kwargs.items():
48
if k.startswith('_') or not hasattr(self.__class__, k):
49
raise TypeError("%s got an unexpected keyword argument '%s'"
50
% (self.__class__.__name__, k))
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
69
clusterstr += '%s:%d' % (host, port)
71
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
73
def get_store(config):
74
"""Create a Storm store connected to the IVLE database.
76
@param config: The IVLE configuration.
78
return Store(create_database(get_conn_string(config)))
83
"""An IVLE user account."""
84
__storm_table__ = "login"
86
id = Int(primary=True, name="loginid")
95
last_login = DateTime()
102
__init__ = _kwarg_init
105
return "<%s '%s'>" % (type(self).__name__, self.login)
107
def authenticate(self, password):
108
"""Validate a given password against this user.
110
Returns True if the given password matches the password hash for this
111
User, False if it doesn't match, and None if there is no hash for the
114
if self.passhash is None:
116
return self.hash_password(password) == self.passhash
119
def display_name(self):
120
"""Returns the "nice name" of the user or group."""
124
def short_name(self):
125
"""Returns the database "identifier" name of the user or group."""
129
def password_expired(self):
130
fieldval = self.pass_exp
131
return fieldval is not None and datetime.datetime.now() > fieldval
134
def account_expired(self):
135
fieldval = self.acct_exp
136
return fieldval is not None and datetime.datetime.now() > fieldval
140
return self.state == 'enabled' and not self.account_expired
142
def _get_enrolments(self, justactive):
143
return Store.of(self).find(Enrolment,
144
Enrolment.user_id == self.id,
145
(Enrolment.active == True) if justactive else True,
146
Enrolment.offering_id == Offering.id,
147
Offering.semester_id == Semester.id,
148
Offering.subject_id == Subject.id).order_by(
150
Desc(Semester.semester),
154
def _set_password(self, password):
158
self.passhash = unicode(User.hash_password(password))
159
password = property(fset=_set_password)
163
return Store.of(self).find(Subject,
164
Enrolment.user_id == self.id,
165
Enrolment.active == True,
166
Offering.id == Enrolment.offering_id,
167
Subject.id == Offering.subject_id).config(distinct=True)
169
# TODO: Invitations should be listed too?
170
def get_groups(self, offering=None):
171
"""Get groups of which this user is a member.
173
@param offering: An optional offering to restrict the search to.
176
ProjectGroupMembership.user_id == self.id,
177
ProjectGroup.id == ProjectGroupMembership.project_group_id,
181
ProjectSet.offering_id == offering.id,
182
ProjectGroup.project_set_id == ProjectSet.id,
184
return Store.of(self).find(ProjectGroup, *preds)
188
return self.get_groups()
191
def active_enrolments(self):
192
'''A sanely ordered list of the user's active enrolments.'''
193
return self._get_enrolments(True)
196
def enrolments(self):
197
'''A sanely ordered list of all of the user's enrolments.'''
198
return self._get_enrolments(False)
200
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
203
This will include projects for offerings in which the user is
204
enrolled, as long as the project is not in a project set which has
205
groups (ie. if maximum number of group members is 0).
207
@param active_only: Whether to only search active offerings.
208
@param offering: An optional offering to restrict the search to.
210
return Store.of(self).find(Project,
211
Project.project_set_id == ProjectSet.id,
212
ProjectSet.max_students_per_group == None,
213
ProjectSet.offering_id == Offering.id,
214
(offering is None) or (Offering.id == offering.id),
215
Semester.id == Offering.semester_id,
216
(not active_only) or (Semester.state == u'current'),
217
Enrolment.offering_id == Offering.id,
218
Enrolment.user_id == self.id)
221
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
226
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
228
return store.find(cls, cls.login == unicode(login)).one()
230
def get_permissions(self, user):
231
"""Determine privileges held by a user over this object.
233
If the user requesting privileges is this user or an admin,
234
they may do everything. Otherwise they may do nothing.
236
if user and user.admin or user is self:
237
return set(['view_public', 'view', 'edit', 'submit_project'])
239
return set(['view_public'])
241
# SUBJECTS AND ENROLMENTS #
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
__storm_table__ = "subject"
248
id = Int(primary=True, name="subjectid")
249
code = Unicode(name="subj_code")
250
name = Unicode(name="subj_name")
251
short_name = Unicode(name="subj_short_name")
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):
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
groups_student_permissions = Unicode()
327
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
328
members = ReferenceSet(id,
329
'Enrolment.offering_id',
332
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
333
projects = ReferenceSet(id,
334
'ProjectSet.offering_id',
336
'Project.project_set_id')
338
worksheets = ReferenceSet(id,
339
'Worksheet.offering_id',
343
__init__ = _kwarg_init
346
return "<%s %r in %r>" % (type(self).__name__, self.subject,
349
def enrol(self, user, role=u'student'):
350
"""Enrol a user in this offering.
352
Enrolments handle both the staff and student cases. The role controls
353
the privileges granted by this enrolment.
355
enrolment = Store.of(self).find(Enrolment,
356
Enrolment.user_id == user.id,
357
Enrolment.offering_id == self.id).one()
359
if enrolment is None:
360
enrolment = Enrolment(user=user, offering=self)
361
self.enrolments.add(enrolment)
363
enrolment.active = True
364
enrolment.role = role
366
def unenrol(self, user):
367
'''Unenrol a user from this offering.'''
368
enrolment = Store.of(self).find(Enrolment,
369
Enrolment.user_id == user.id,
370
Enrolment.offering_id == self.id).one()
371
Store.of(enrolment).remove(enrolment)
373
def get_permissions(self, user):
376
enrolment = self.get_enrolment(user)
377
if enrolment or user.admin:
379
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
382
# XXX Bug #493945 -- should tutors have these permissions?
383
# Potentially move into the next category (lecturer & admin)
384
perms.add('enrol') # Can see enrolment screen at all
385
perms.add('enrol_student') # Can enrol students
386
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
387
perms.add('enrol_tutor') # Can enrol tutors
389
perms.add('enrol_lecturer') # Can enrol lecturers
392
def get_enrolment(self, user):
393
"""Find the user's enrolment in this offering."""
395
enrolment = self.enrolments.find(user=user).one()
401
def get_members_by_role(self, role):
402
return Store.of(self).find(User,
403
Enrolment.user_id == User.id,
404
Enrolment.offering_id == self.id,
405
Enrolment.role == role
406
).order_by(User.login)
410
return self.get_members_by_role(u'student')
412
def get_open_projects_for_user(self, user):
413
"""Find all projects currently open to submissions by a user."""
414
# XXX: Respect extensions.
415
return self.projects.find(Project.deadline > datetime.datetime.now())
417
class Enrolment(Storm):
418
"""An enrolment of a user in an offering.
420
This represents the roles of both staff and students.
423
__storm_table__ = "enrolment"
424
__storm_primary__ = "user_id", "offering_id"
426
user_id = Int(name="loginid")
427
user = Reference(user_id, User.id)
428
offering_id = Int(name="offeringid")
429
offering = Reference(offering_id, Offering.id)
436
return Store.of(self).find(ProjectGroup,
437
ProjectSet.offering_id == self.offering.id,
438
ProjectGroup.project_set_id == ProjectSet.id,
439
ProjectGroupMembership.project_group_id == ProjectGroup.id,
440
ProjectGroupMembership.user_id == self.user.id)
442
__init__ = _kwarg_init
445
return "<%s %r in %r>" % (type(self).__name__, self.user,
450
class ProjectSet(Storm):
451
"""A set of projects that share common groups.
453
Each student project group is attached to a project set. The group is
454
valid for all projects in the group's set.
457
__storm_table__ = "project_set"
459
id = Int(name="projectsetid", primary=True)
460
offering_id = Int(name="offeringid")
461
offering = Reference(offering_id, Offering.id)
462
max_students_per_group = Int()
464
projects = ReferenceSet(id, 'Project.project_set_id')
465
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
467
__init__ = _kwarg_init
470
return "<%s %d in %r>" % (type(self).__name__, self.id,
473
def get_permissions(self, user):
474
return self.offering.get_permissions(user)
476
def get_groups_for_user(self, user):
477
"""List all groups in this offering of which the user is a member."""
479
return Store.of(self).find(
481
ProjectGroupMembership.user_id == user.id,
482
ProjectGroupMembership.project_group_id == ProjectGroup.id,
483
ProjectGroup.project_set_id == self.id)
485
def get_submission_principal(self, user):
486
"""Get the principal on behalf of which the user can submit.
488
If this is a solo project set, the given user is returned. If
489
the user is a member of exactly one group, all the group is
490
returned. Otherwise, None is returned.
493
groups = self.get_groups_for_user(user)
494
if groups.count() == 1:
503
return self.max_students_per_group is not None
507
"""Get the entities (groups or users) assigned to submit this project.
509
This will be a Storm ResultSet.
511
#If its a solo project, return everyone in offering
513
return self.project_groups
515
return self.offering.students
517
class Project(Storm):
518
"""A student project for which submissions can be made."""
520
__storm_table__ = "project"
522
id = Int(name="projectid", primary=True)
524
short_name = Unicode()
527
project_set_id = Int(name="projectsetid")
528
project_set = Reference(project_set_id, ProjectSet.id)
529
deadline = DateTime()
531
assesseds = ReferenceSet(id, 'Assessed.project_id')
532
submissions = ReferenceSet(id,
533
'Assessed.project_id',
535
'ProjectSubmission.assessed_id')
537
__init__ = _kwarg_init
540
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
541
self.project_set.offering)
543
def can_submit(self, principal):
544
return (self in principal.get_projects() and
545
self.deadline > datetime.datetime.now())
547
def submit(self, principal, path, revision, who):
548
"""Submit a Subversion path and revision to a project.
550
@param principal: The owner of the Subversion repository, and the
551
entity on behalf of whom the submission is being made
552
@param path: A path within that repository to submit.
553
@param revision: The revision of that path to submit.
554
@param who: The user who is actually making the submission.
557
if not self.can_submit(principal):
558
raise Exception('cannot submit')
560
a = Assessed.get(Store.of(self), principal, self)
561
ps = ProjectSubmission()
563
ps.revision = revision
564
ps.date_submitted = datetime.datetime.now()
570
def get_permissions(self, user):
571
return self.project_set.offering.get_permissions(user)
574
def latest_submissions(self):
575
"""Return the latest submission for each Assessed."""
576
return Store.of(self).find(ProjectSubmission,
577
Assessed.project_id == self.id,
578
ProjectSubmission.assessed_id == Assessed.id,
579
ProjectSubmission.date_submitted == Select(
580
Max(ProjectSubmission.date_submitted),
581
ProjectSubmission.assessed_id == Assessed.id,
582
tables=ProjectSubmission
586
def has_deadline_passed(self, user):
587
"""Check whether the deadline has passed."""
588
# XXX: Need to respect extensions.
589
return self.deadline < datetime.datetime.now()
591
def get_submissions_for_principal(self, principal):
592
"""Fetch a ResultSet of all submissions by a particular principal."""
593
assessed = Assessed.get(Store.of(self), principal, self)
596
return assessed.submissions
600
class ProjectGroup(Storm):
601
"""A group of students working together on a project."""
603
__storm_table__ = "project_group"
605
id = Int(name="groupid", primary=True)
606
name = Unicode(name="groupnm")
607
project_set_id = Int(name="projectsetid")
608
project_set = Reference(project_set_id, ProjectSet.id)
610
created_by_id = Int(name="createdby")
611
created_by = Reference(created_by_id, User.id)
614
members = ReferenceSet(id,
615
"ProjectGroupMembership.project_group_id",
616
"ProjectGroupMembership.user_id",
619
__init__ = _kwarg_init
622
return "<%s %s in %r>" % (type(self).__name__, self.name,
623
self.project_set.offering)
626
def display_name(self):
627
"""Returns the "nice name" of the user or group."""
631
def short_name(self):
632
"""Returns the database "identifier" name of the user or group."""
635
def get_projects(self, offering=None, active_only=True):
636
'''Find projects that the group can submit.
638
This will include projects in the project set which owns this group,
639
unless the project set disallows groups (in which case none will be
642
@param active_only: Whether to only search active offerings.
643
@param offering: An optional offering to restrict the search to.
645
return Store.of(self).find(Project,
646
Project.project_set_id == ProjectSet.id,
647
ProjectSet.id == self.project_set.id,
648
ProjectSet.max_students_per_group != None,
649
ProjectSet.offering_id == Offering.id,
650
(offering is None) or (Offering.id == offering.id),
651
Semester.id == Offering.semester_id,
652
(not active_only) or (Semester.state == u'current'))
655
def get_permissions(self, user):
656
if user.admin or user in self.members:
657
return set(['submit_project'])
661
class ProjectGroupMembership(Storm):
662
"""A student's membership in a project group."""
664
__storm_table__ = "group_member"
665
__storm_primary__ = "user_id", "project_group_id"
667
user_id = Int(name="loginid")
668
user = Reference(user_id, User.id)
669
project_group_id = Int(name="groupid")
670
project_group = Reference(project_group_id, ProjectGroup.id)
672
__init__ = _kwarg_init
675
return "<%s %r in %r>" % (type(self).__name__, self.user,
678
class Assessed(Storm):
679
"""A composite of a user or group combined with a project.
681
Each project submission and extension refers to an Assessed. It is the
682
sole specifier of the repository and project.
685
__storm_table__ = "assessed"
687
id = Int(name="assessedid", primary=True)
688
user_id = Int(name="loginid")
689
user = Reference(user_id, User.id)
690
project_group_id = Int(name="groupid")
691
project_group = Reference(project_group_id, ProjectGroup.id)
693
project_id = Int(name="projectid")
694
project = Reference(project_id, Project.id)
696
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
697
submissions = ReferenceSet(
698
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
701
return "<%s %r in %r>" % (type(self).__name__,
702
self.user or self.project_group, self.project)
706
"""True if the Assessed is a group, False if it is a user."""
707
return self.project_group is not None
711
return self.project_group or self.user
714
def get(cls, store, principal, project):
715
"""Find or create an Assessed for the given user or group and project.
717
@param principal: The user or group.
718
@param project: The project.
721
if t not in (User, ProjectGroup):
722
raise AssertionError('principal must be User or ProjectGroup')
725
(t is User) or (cls.project_group_id == principal.id),
726
(t is ProjectGroup) or (cls.user_id == principal.id),
727
cls.project_id == project.id).one()
734
a.project_group = principal
741
class ProjectExtension(Storm):
742
"""An extension granted to a user or group on a particular project.
744
The user or group and project are specified by the Assessed.
747
__storm_table__ = "project_extension"
749
id = Int(name="extensionid", primary=True)
750
assessed_id = Int(name="assessedid")
751
assessed = Reference(assessed_id, Assessed.id)
752
deadline = DateTime()
753
approver_id = Int(name="approver")
754
approver = Reference(approver_id, User.id)
757
class ProjectSubmission(Storm):
758
"""A submission from a user or group repository to a particular project.
760
The content of a submission is a single path and revision inside a
761
repository. The repository is that owned by the submission's user and
762
group, while the path and revision are explicit.
764
The user or group and project are specified by the Assessed.
767
__storm_table__ = "project_submission"
769
id = Int(name="submissionid", primary=True)
770
assessed_id = Int(name="assessedid")
771
assessed = Reference(assessed_id, Assessed.id)
774
submitter_id = Int(name="submitter")
775
submitter = Reference(submitter_id, User.id)
776
date_submitted = DateTime()
779
# WORKSHEETS AND EXERCISES #
781
class Exercise(Storm):
782
"""An exercise for students to complete in a worksheet.
784
An exercise may be present in any number of worksheets.
787
__storm_table__ = "exercise"
788
id = Unicode(primary=True, name="identifier")
790
description = Unicode()
796
worksheet_exercises = ReferenceSet(id,
797
'WorksheetExercise.exercise_id')
799
worksheets = ReferenceSet(id,
800
'WorksheetExercise.exercise_id',
801
'WorksheetExercise.worksheet_id',
805
test_suites = ReferenceSet(id,
806
'TestSuite.exercise_id',
809
__init__ = _kwarg_init
812
return "<%s %s>" % (type(self).__name__, self.name)
814
def get_permissions(self, user):
821
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
824
elif u'tutor' in set((e.role for e in user.active_enrolments)):
830
def get_description(self):
831
"""Return the description interpreted as reStructuredText."""
832
return rst(self.description)
835
"""Deletes the exercise, providing it has no associated worksheets."""
836
if (self.worksheet_exercises.count() > 0):
837
raise IntegrityError()
838
for suite in self.test_suites:
840
Store.of(self).remove(self)
842
class Worksheet(Storm):
843
"""A worksheet with exercises for students to complete.
845
Worksheets are owned by offerings.
848
__storm_table__ = "worksheet"
850
id = Int(primary=True, name="worksheetid")
851
offering_id = Int(name="offeringid")
852
identifier = Unicode()
859
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
860
offering = Reference(offering_id, 'Offering.id')
862
all_worksheet_exercises = ReferenceSet(id,
863
'WorksheetExercise.worksheet_id')
865
# Use worksheet_exercises to get access to the *active* WorksheetExercise
866
# objects binding worksheets to exercises. This is required to access the
870
def worksheet_exercises(self):
871
return self.all_worksheet_exercises.find(active=True)
873
__init__ = _kwarg_init
876
return "<%s %s>" % (type(self).__name__, self.name)
878
def remove_all_exercises(self):
879
"""Remove all exercises from this worksheet.
881
This does not delete the exercises themselves. It just removes them
884
store = Store.of(self)
885
for ws_ex in self.all_worksheet_exercises:
886
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
887
raise IntegrityError()
888
store.find(WorksheetExercise,
889
WorksheetExercise.worksheet == self).remove()
891
def get_permissions(self, user):
892
return self.offering.get_permissions(user)
895
"""Returns the xml of this worksheet, converts from rst if required."""
896
if self.format == u'rst':
897
ws_xml = rst(self.data)
903
"""Deletes the worksheet, provided it has no attempts on any exercises.
905
Returns True if delete succeeded, or False if this worksheet has
906
attempts attached."""
907
for ws_ex in self.all_worksheet_exercises:
908
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
909
raise IntegrityError()
911
self.remove_all_exercises()
912
Store.of(self).remove(self)
914
class WorksheetExercise(Storm):
915
"""A link between a worksheet and one of its exercises.
917
These may be marked optional, in which case the exercise does not count
918
for marking purposes. The sequence number is used to order the worksheet
922
__storm_table__ = "worksheet_exercise"
924
id = Int(primary=True, name="ws_ex_id")
926
worksheet_id = Int(name="worksheetid")
927
worksheet = Reference(worksheet_id, Worksheet.id)
928
exercise_id = Unicode(name="exerciseid")
929
exercise = Reference(exercise_id, Exercise.id)
934
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
935
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
937
__init__ = _kwarg_init
940
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
941
self.worksheet.identifier)
943
def get_permissions(self, user):
944
return self.worksheet.get_permissions(user)
947
class ExerciseSave(Storm):
948
"""A potential exercise solution submitted by a user for storage.
950
This is not an actual tested attempt at an exercise, it's just a save of
954
__storm_table__ = "exercise_save"
955
__storm_primary__ = "ws_ex_id", "user_id"
957
ws_ex_id = Int(name="ws_ex_id")
958
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
960
user_id = Int(name="loginid")
961
user = Reference(user_id, User.id)
965
__init__ = _kwarg_init
968
return "<%s %s by %s at %s>" % (type(self).__name__,
969
self.exercise.name, self.user.login, self.date.strftime("%c"))
971
class ExerciseAttempt(ExerciseSave):
972
"""An attempt at solving an exercise.
974
This is a special case of ExerciseSave, used when the user submits a
975
candidate solution. Like an ExerciseSave, it constitutes exercise solution
978
In addition, it contains information about the result of the submission:
980
- complete - True if this submission was successful, rendering this
981
exercise complete for this user in this worksheet.
982
- active - True if this submission is "active" (usually true).
983
Submissions may be de-activated by privileged users for
984
special reasons, and then they won't count (either as a
985
penalty or success), but will still be stored.
988
__storm_table__ = "exercise_attempt"
989
__storm_primary__ = "ws_ex_id", "user_id", "date"
991
# The "text" field is the same but has a different name in the DB table
993
text = Unicode(name="attempt")
997
def get_permissions(self, user):
998
return set(['view']) if user is self.user else set()
1000
class TestSuite(Storm):
1001
"""A container to group an exercise's test cases.
1003
The test suite contains some information on how to test. The function to
1004
test, variables to set and stdin data are stored here.
1007
__storm_table__ = "test_suite"
1008
__storm_primary__ = "exercise_id", "suiteid"
1011
exercise_id = Unicode(name="exerciseid")
1012
description = Unicode()
1014
function = Unicode()
1016
exercise = Reference(exercise_id, Exercise.id)
1017
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1018
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1021
"""Delete this suite, without asking questions."""
1022
for variable in self.variables:
1024
for test_case in self.test_cases:
1026
Store.of(self).remove(self)
1028
class TestCase(Storm):
1029
"""A container for actual tests (see TestCasePart), inside a test suite.
1031
It is the lowest level shown to students on their pass/fail status."""
1033
__storm_table__ = "test_case"
1034
__storm_primary__ = "testid", "suiteid"
1038
suite = Reference(suiteid, "TestSuite.suiteid")
1041
test_default = Unicode() # Currently unused - only used for file matching.
1044
parts = ReferenceSet(testid, "TestCasePart.testid")
1046
__init__ = _kwarg_init
1049
for part in self.parts:
1051
Store.of(self).remove(self)
1053
class TestSuiteVar(Storm):
1054
"""A variable used by an exercise test suite.
1056
This may represent a function argument or a normal variable.
1059
__storm_table__ = "suite_variable"
1060
__storm_primary__ = "varid"
1064
var_name = Unicode()
1065
var_value = Unicode()
1066
var_type = Unicode()
1069
suite = Reference(suiteid, "TestSuite.suiteid")
1071
__init__ = _kwarg_init
1074
Store.of(self).remove(self)
1076
class TestCasePart(Storm):
1077
"""An actual piece of code to test an exercise solution."""
1079
__storm_table__ = "test_case_part"
1080
__storm_primary__ = "partid"
1085
part_type = Unicode()
1086
test_type = Unicode()
1088
filename = Unicode()
1090
test = Reference(testid, "TestCase.testid")
1092
__init__ = _kwarg_init
1095
Store.of(self).remove(self)
added
removed
ivle/database.py
