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.exceptions import NotOneError, IntegrityError
33
from ivle.worksheet.rst import rst
35
__all__ = ['get_store',
37
'Subject', 'Semester', 'Offering', 'Enrolment',
38
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
39
'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
'Exercise', 'Worksheet', 'WorksheetExercise',
41
'ExerciseSave', 'ExerciseAttempt',
42
'TestCase', 'TestSuite', 'TestSuiteVar'
45
def _kwarg_init(self, **kwargs):
46
for k,v in kwargs.items():
47
if k.startswith('_') or not hasattr(self.__class__, k):
48
raise TypeError("%s got an unexpected keyword argument '%s'"
49
% (self.__class__.__name__, k))
52
def get_conn_string(config):
53
"""Create a Storm connection string to the IVLE database
55
@param config: The IVLE configuration.
59
if config['database']['username']:
60
clusterstr += config['database']['username']
61
if config['database']['password']:
62
clusterstr += ':' + config['database']['password']
65
host = config['database']['host'] or 'localhost'
66
port = config['database']['port'] or 5432
68
clusterstr += '%s:%d' % (host, port)
70
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
72
def get_store(config):
73
"""Create a Storm store connected to the IVLE database.
75
@param config: The IVLE configuration.
77
return Store(create_database(get_conn_string(config)))
82
"""An IVLE user account."""
83
__storm_table__ = "login"
85
id = Int(primary=True, name="loginid")
94
last_login = DateTime()
101
__init__ = _kwarg_init
104
return "<%s '%s'>" % (type(self).__name__, self.login)
106
def authenticate(self, password):
107
"""Validate a given password against this user.
109
Returns True if the given password matches the password hash for this
110
User, False if it doesn't match, and None if there is no hash for the
113
if self.passhash is None:
115
return self.hash_password(password) == self.passhash
118
def display_name(self):
122
def password_expired(self):
123
fieldval = self.pass_exp
124
return fieldval is not None and datetime.datetime.now() > fieldval
127
def account_expired(self):
128
fieldval = self.acct_exp
129
return fieldval is not None and datetime.datetime.now() > fieldval
133
return self.state == 'enabled' and not self.account_expired
135
def _get_enrolments(self, justactive):
136
return Store.of(self).find(Enrolment,
137
Enrolment.user_id == self.id,
138
(Enrolment.active == True) if justactive else True,
139
Enrolment.offering_id == Offering.id,
140
Offering.semester_id == Semester.id,
141
Offering.subject_id == Subject.id).order_by(
143
Desc(Semester.semester),
147
def _set_password(self, password):
151
self.passhash = unicode(User.hash_password(password))
152
password = property(fset=_set_password)
156
return Store.of(self).find(Subject,
157
Enrolment.user_id == self.id,
158
Enrolment.active == True,
159
Offering.id == Enrolment.offering_id,
160
Subject.id == Offering.subject_id).config(distinct=True)
162
# TODO: Invitations should be listed too?
163
def get_groups(self, offering=None):
164
"""Get groups of which this user is a member.
166
@param offering: An optional offering to restrict the search to.
169
ProjectGroupMembership.user_id == self.id,
170
ProjectGroup.id == ProjectGroupMembership.project_group_id,
174
ProjectSet.offering_id == offering.id,
175
ProjectGroup.project_set_id == ProjectSet.id,
177
return Store.of(self).find(ProjectGroup, *preds)
181
return self.get_groups()
184
def active_enrolments(self):
185
'''A sanely ordered list of the user's active enrolments.'''
186
return self._get_enrolments(True)
189
def enrolments(self):
190
'''A sanely ordered list of all of the user's enrolments.'''
191
return self._get_enrolments(False)
193
def get_projects(self, offering=None, active_only=True):
194
"""Find projects that the user can submit.
196
This will include projects for offerings in which the user is
197
enrolled, as long as the project is not in a project set which has
198
groups (ie. if maximum number of group members is 0).
200
@param active_only: Whether to only search active offerings.
201
@param offering: An optional offering to restrict the search to.
203
return Store.of(self).find(Project,
204
Project.project_set_id == ProjectSet.id,
205
ProjectSet.max_students_per_group == None,
206
ProjectSet.offering_id == Offering.id,
207
(offering is None) or (Offering.id == offering.id),
208
Semester.id == Offering.semester_id,
209
(not active_only) or (Semester.state == u'current'),
210
Enrolment.offering_id == Offering.id,
211
Enrolment.user_id == self.id)
214
def hash_password(password):
215
"""Hash a password with MD5."""
216
return hashlib.md5(password).hexdigest()
219
def get_by_login(cls, store, login):
220
"""Find a user in a store by login name."""
221
return store.find(cls, cls.login == unicode(login)).one()
223
def get_permissions(self, user):
224
"""Determine privileges held by a user over this object.
226
If the user requesting privileges is this user or an admin,
227
they may do everything. Otherwise they may do nothing.
229
if user and user.admin or user is self:
230
return set(['view', 'edit', 'submit_project'])
234
# SUBJECTS AND ENROLMENTS #
236
class Subject(Storm):
237
"""A subject (or course) which is run in some semesters."""
239
__storm_table__ = "subject"
241
id = Int(primary=True, name="subjectid")
242
code = Unicode(name="subj_code")
243
name = Unicode(name="subj_name")
244
short_name = Unicode(name="subj_short_name")
247
offerings = ReferenceSet(id, 'Offering.subject_id')
249
__init__ = _kwarg_init
252
return "<%s '%s'>" % (type(self).__name__, self.short_name)
254
def get_permissions(self, user):
255
"""Determine privileges held by a user over this object.
257
If the user requesting privileges is an admin, they may edit.
258
Otherwise they may only read.
267
def active_offerings(self):
268
"""Find active offerings for this subject.
270
Return a sequence of currently active offerings for this subject
271
(offerings whose semester.state is "current"). There should be 0 or 1
272
elements in this sequence, but it's possible there are more.
274
return self.offerings.find(Offering.semester_id == Semester.id,
275
Semester.state == u'current')
277
def offering_for_semester(self, year, semester):
278
"""Get the offering for the given year/semester, or None.
280
@param year: A string representation of the year.
281
@param semester: A string representation of the semester.
283
return self.offerings.find(Offering.semester_id == Semester.id,
284
Semester.year == unicode(year),
285
Semester.semester == unicode(semester)).one()
287
class Semester(Storm):
288
"""A semester in which subjects can be run."""
290
__storm_table__ = "semester"
292
id = Int(primary=True, name="semesterid")
297
offerings = ReferenceSet(id, 'Offering.semester_id')
298
enrolments = ReferenceSet(id,
299
'Offering.semester_id',
301
'Enrolment.offering_id')
303
__init__ = _kwarg_init
306
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
308
class Offering(Storm):
309
"""An offering of a subject in a particular semester."""
311
__storm_table__ = "offering"
313
id = Int(primary=True, name="offeringid")
314
subject_id = Int(name="subject")
315
subject = Reference(subject_id, Subject.id)
316
semester_id = Int(name="semesterid")
317
semester = Reference(semester_id, Semester.id)
318
groups_student_permissions = Unicode()
320
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
321
members = ReferenceSet(id,
322
'Enrolment.offering_id',
325
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
327
worksheets = ReferenceSet(id,
328
'Worksheet.offering_id',
332
__init__ = _kwarg_init
335
return "<%s %r in %r>" % (type(self).__name__, self.subject,
338
def enrol(self, user, role=u'student'):
339
"""Enrol a user in this offering.
341
Enrolments handle both the staff and student cases. The role controls
342
the privileges granted by this enrolment.
344
enrolment = Store.of(self).find(Enrolment,
345
Enrolment.user_id == user.id,
346
Enrolment.offering_id == self.id).one()
348
if enrolment is None:
349
enrolment = Enrolment(user=user, offering=self)
350
self.enrolments.add(enrolment)
352
enrolment.active = True
353
enrolment.role = role
355
def unenrol(self, user):
356
'''Unenrol a user from this offering.'''
357
enrolment = Store.of(self).find(Enrolment,
358
Enrolment.user_id == user.id,
359
Enrolment.offering_id == self.id).one()
360
Store.of(enrolment).remove(enrolment)
362
def get_permissions(self, user):
365
enrolment = self.get_enrolment(user)
366
if enrolment or user.admin:
368
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
373
def get_enrolment(self, user):
374
"""Find the user's enrolment in this offering."""
376
enrolment = self.enrolments.find(user=user).one()
382
class Enrolment(Storm):
383
"""An enrolment of a user in an offering.
385
This represents the roles of both staff and students.
388
__storm_table__ = "enrolment"
389
__storm_primary__ = "user_id", "offering_id"
391
user_id = Int(name="loginid")
392
user = Reference(user_id, User.id)
393
offering_id = Int(name="offeringid")
394
offering = Reference(offering_id, Offering.id)
401
return Store.of(self).find(ProjectGroup,
402
ProjectSet.offering_id == self.offering.id,
403
ProjectGroup.project_set_id == ProjectSet.id,
404
ProjectGroupMembership.project_group_id == ProjectGroup.id,
405
ProjectGroupMembership.user_id == self.user.id)
407
__init__ = _kwarg_init
410
return "<%s %r in %r>" % (type(self).__name__, self.user,
415
class ProjectSet(Storm):
416
"""A set of projects that share common groups.
418
Each student project group is attached to a project set. The group is
419
valid for all projects in the group's set.
422
__storm_table__ = "project_set"
424
id = Int(name="projectsetid", primary=True)
425
offering_id = Int(name="offeringid")
426
offering = Reference(offering_id, Offering.id)
427
max_students_per_group = Int()
429
projects = ReferenceSet(id, 'Project.project_set_id')
430
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
432
__init__ = _kwarg_init
435
return "<%s %d in %r>" % (type(self).__name__, self.id,
438
def get_permissions(self, user):
439
return self.offering.get_permissions(user)
441
class Project(Storm):
442
"""A student project for which submissions can be made."""
444
__storm_table__ = "project"
446
id = Int(name="projectid", primary=True)
448
short_name = Unicode()
451
project_set_id = Int(name="projectsetid")
452
project_set = Reference(project_set_id, ProjectSet.id)
453
deadline = DateTime()
455
assesseds = ReferenceSet(id, 'Assessed.project_id')
456
submissions = ReferenceSet(id,
457
'Assessed.project_id',
459
'ProjectSubmission.assessed_id')
461
__init__ = _kwarg_init
464
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
465
self.project_set.offering)
467
def can_submit(self, principal):
468
return (self in principal.get_projects() and
469
self.deadline > datetime.datetime.now())
471
def submit(self, principal, path, revision, who):
472
"""Submit a Subversion path and revision to a project.
474
@param principal: The owner of the Subversion repository, and the
475
entity on behalf of whom the submission is being made
476
@param path: A path within that repository to submit.
477
@param revision: The revision of that path to submit.
478
@param who: The user who is actually making the submission.
481
if not self.can_submit(principal):
482
raise Exception('cannot submit')
484
a = Assessed.get(Store.of(self), principal, self)
485
ps = ProjectSubmission()
487
ps.revision = revision
488
ps.date_submitted = datetime.datetime.now()
494
def get_permissions(self, user):
495
return self.project_set.offering.get_permissions(user)
498
class ProjectGroup(Storm):
499
"""A group of students working together on a project."""
501
__storm_table__ = "project_group"
503
id = Int(name="groupid", primary=True)
504
name = Unicode(name="groupnm")
505
project_set_id = Int(name="projectsetid")
506
project_set = Reference(project_set_id, ProjectSet.id)
508
created_by_id = Int(name="createdby")
509
created_by = Reference(created_by_id, User.id)
512
members = ReferenceSet(id,
513
"ProjectGroupMembership.project_group_id",
514
"ProjectGroupMembership.user_id",
517
__init__ = _kwarg_init
520
return "<%s %s in %r>" % (type(self).__name__, self.name,
521
self.project_set.offering)
524
def display_name(self):
525
return '%s (%s)' % (self.nick, self.name)
527
def get_projects(self, offering=None, active_only=True):
528
'''Find projects that the group can submit.
530
This will include projects in the project set which owns this group,
531
unless the project set disallows groups (in which case none will be
534
@param active_only: Whether to only search active offerings.
535
@param offering: An optional offering to restrict the search to.
537
return Store.of(self).find(Project,
538
Project.project_set_id == ProjectSet.id,
539
ProjectSet.id == self.project_set.id,
540
ProjectSet.max_students_per_group != None,
541
ProjectSet.offering_id == Offering.id,
542
(offering is None) or (Offering.id == offering.id),
543
Semester.id == Offering.semester_id,
544
(not active_only) or (Semester.state == u'current'))
547
def get_permissions(self, user):
548
if user.admin or user in self.members:
549
return set(['submit_project'])
553
class ProjectGroupMembership(Storm):
554
"""A student's membership in a project group."""
556
__storm_table__ = "group_member"
557
__storm_primary__ = "user_id", "project_group_id"
559
user_id = Int(name="loginid")
560
user = Reference(user_id, User.id)
561
project_group_id = Int(name="groupid")
562
project_group = Reference(project_group_id, ProjectGroup.id)
564
__init__ = _kwarg_init
567
return "<%s %r in %r>" % (type(self).__name__, self.user,
570
class Assessed(Storm):
571
"""A composite of a user or group combined with a project.
573
Each project submission and extension refers to an Assessed. It is the
574
sole specifier of the repository and project.
577
__storm_table__ = "assessed"
579
id = Int(name="assessedid", primary=True)
580
user_id = Int(name="loginid")
581
user = Reference(user_id, User.id)
582
project_group_id = Int(name="groupid")
583
project_group = Reference(project_group_id, ProjectGroup.id)
585
project_id = Int(name="projectid")
586
project = Reference(project_id, Project.id)
588
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
589
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
592
return "<%s %r in %r>" % (type(self).__name__,
593
self.user or self.project_group, self.project)
597
return self.project_group or self.user
600
def get(cls, store, principal, project):
601
"""Find or create an Assessed for the given user or group and project.
603
@param principal: The user or group.
604
@param project: The project.
607
if t not in (User, ProjectGroup):
608
raise AssertionError('principal must be User or ProjectGroup')
611
(t is User) or (cls.project_group_id == principal.id),
612
(t is ProjectGroup) or (cls.user_id == principal.id),
613
Project.id == project.id).one()
620
a.project_group = principal
627
class ProjectExtension(Storm):
628
"""An extension granted to a user or group on a particular project.
630
The user or group and project are specified by the Assessed.
633
__storm_table__ = "project_extension"
635
id = Int(name="extensionid", primary=True)
636
assessed_id = Int(name="assessedid")
637
assessed = Reference(assessed_id, Assessed.id)
638
deadline = DateTime()
639
approver_id = Int(name="approver")
640
approver = Reference(approver_id, User.id)
643
class ProjectSubmission(Storm):
644
"""A submission from a user or group repository to a particular project.
646
The content of a submission is a single path and revision inside a
647
repository. The repository is that owned by the submission's user and
648
group, while the path and revision are explicit.
650
The user or group and project are specified by the Assessed.
653
__storm_table__ = "project_submission"
655
id = Int(name="submissionid", primary=True)
656
assessed_id = Int(name="assessedid")
657
assessed = Reference(assessed_id, Assessed.id)
660
submitter_id = Int(name="submitter")
661
submitter = Reference(submitter_id, User.id)
662
date_submitted = DateTime()
665
# WORKSHEETS AND EXERCISES #
667
class Exercise(Storm):
668
"""An exercise for students to complete in a worksheet.
670
An exercise may be present in any number of worksheets.
673
__storm_table__ = "exercise"
674
id = Unicode(primary=True, name="identifier")
676
description = Unicode()
682
worksheet_exercises = ReferenceSet(id,
683
'WorksheetExercise.exercise_id')
685
worksheets = ReferenceSet(id,
686
'WorksheetExercise.exercise_id',
687
'WorksheetExercise.worksheet_id',
691
test_suites = ReferenceSet(id,
692
'TestSuite.exercise_id',
695
__init__ = _kwarg_init
698
return "<%s %s>" % (type(self).__name__, self.name)
700
def get_permissions(self, user):
707
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
710
elif u'tutor' in set((e.role for e in user.active_enrolments)):
716
def get_description(self):
717
"""Return the description interpreted as reStructuredText."""
718
return rst(self.description)
721
"""Deletes the exercise, providing it has no associated worksheets."""
722
if (self.worksheet_exercises.count() > 0):
723
raise IntegrityError()
724
for suite in self.test_suites:
726
Store.of(self).remove(self)
728
class Worksheet(Storm):
729
"""A worksheet with exercises for students to complete.
731
Worksheets are owned by offerings.
734
__storm_table__ = "worksheet"
736
id = Int(primary=True, name="worksheetid")
737
offering_id = Int(name="offeringid")
738
identifier = Unicode()
745
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
746
offering = Reference(offering_id, 'Offering.id')
748
all_worksheet_exercises = ReferenceSet(id,
749
'WorksheetExercise.worksheet_id')
751
# Use worksheet_exercises to get access to the *active* WorksheetExercise
752
# objects binding worksheets to exercises. This is required to access the
756
def worksheet_exercises(self):
757
return self.all_worksheet_exercises.find(active=True)
759
__init__ = _kwarg_init
762
return "<%s %s>" % (type(self).__name__, self.name)
764
def remove_all_exercises(self):
765
"""Remove all exercises from this worksheet.
767
This does not delete the exercises themselves. It just removes them
770
store = Store.of(self)
771
for ws_ex in self.all_worksheet_exercises:
772
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
773
raise IntegrityError()
774
store.find(WorksheetExercise,
775
WorksheetExercise.worksheet == self).remove()
777
def get_permissions(self, user):
778
return self.offering.get_permissions(user)
781
"""Returns the xml of this worksheet, converts from rst if required."""
782
if self.format == u'rst':
783
ws_xml = rst(self.data)
789
"""Deletes the worksheet, provided it has no attempts on any exercises.
791
Returns True if delete succeeded, or False if this worksheet has
792
attempts attached."""
793
for ws_ex in self.all_worksheet_exercises:
794
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
795
raise IntegrityError()
797
self.remove_all_exercises()
798
Store.of(self).remove(self)
800
class WorksheetExercise(Storm):
801
"""A link between a worksheet and one of its exercises.
803
These may be marked optional, in which case the exercise does not count
804
for marking purposes. The sequence number is used to order the worksheet
808
__storm_table__ = "worksheet_exercise"
810
id = Int(primary=True, name="ws_ex_id")
812
worksheet_id = Int(name="worksheetid")
813
worksheet = Reference(worksheet_id, Worksheet.id)
814
exercise_id = Unicode(name="exerciseid")
815
exercise = Reference(exercise_id, Exercise.id)
820
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
821
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
823
__init__ = _kwarg_init
826
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
827
self.worksheet.identifier)
829
def get_permissions(self, user):
830
return self.worksheet.get_permissions(user)
833
class ExerciseSave(Storm):
834
"""A potential exercise solution submitted by a user for storage.
836
This is not an actual tested attempt at an exercise, it's just a save of
840
__storm_table__ = "exercise_save"
841
__storm_primary__ = "ws_ex_id", "user_id"
843
ws_ex_id = Int(name="ws_ex_id")
844
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
846
user_id = Int(name="loginid")
847
user = Reference(user_id, User.id)
851
__init__ = _kwarg_init
854
return "<%s %s by %s at %s>" % (type(self).__name__,
855
self.exercise.name, self.user.login, self.date.strftime("%c"))
857
class ExerciseAttempt(ExerciseSave):
858
"""An attempt at solving an exercise.
860
This is a special case of ExerciseSave, used when the user submits a
861
candidate solution. Like an ExerciseSave, it constitutes exercise solution
864
In addition, it contains information about the result of the submission:
866
- complete - True if this submission was successful, rendering this
867
exercise complete for this user in this worksheet.
868
- active - True if this submission is "active" (usually true).
869
Submissions may be de-activated by privileged users for
870
special reasons, and then they won't count (either as a
871
penalty or success), but will still be stored.
874
__storm_table__ = "exercise_attempt"
875
__storm_primary__ = "ws_ex_id", "user_id", "date"
877
# The "text" field is the same but has a different name in the DB table
879
text = Unicode(name="attempt")
883
def get_permissions(self, user):
884
return set(['view']) if user is self.user else set()
886
class TestSuite(Storm):
887
"""A container to group an exercise's test cases.
889
The test suite contains some information on how to test. The function to
890
test, variables to set and stdin data are stored here.
893
__storm_table__ = "test_suite"
894
__storm_primary__ = "exercise_id", "suiteid"
897
exercise_id = Unicode(name="exerciseid")
898
description = Unicode()
902
exercise = Reference(exercise_id, Exercise.id)
903
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
904
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
907
"""Delete this suite, without asking questions."""
908
for vaariable in self.variables:
910
for test_case in self.test_cases:
912
Store.of(self).remove(self)
914
class TestCase(Storm):
915
"""A container for actual tests (see TestCasePart), inside a test suite.
917
It is the lowest level shown to students on their pass/fail status."""
919
__storm_table__ = "test_case"
920
__storm_primary__ = "testid", "suiteid"
924
suite = Reference(suiteid, "TestSuite.suiteid")
927
test_default = Unicode()
930
parts = ReferenceSet(testid, "TestCasePart.testid")
932
__init__ = _kwarg_init
935
for part in self.parts:
937
Store.of(self).remove(self)
939
class TestSuiteVar(Storm):
940
"""A variable used by an exercise test suite.
942
This may represent a function argument or a normal variable.
945
__storm_table__ = "suite_variable"
946
__storm_primary__ = "varid"
951
var_value = Unicode()
955
suite = Reference(suiteid, "TestSuite.suiteid")
957
__init__ = _kwarg_init
960
Store.of(self).remove(self)
962
class TestCasePart(Storm):
963
"""An actual piece of code to test an exercise solution."""
965
__storm_table__ = "test_case_part"
966
__storm_primary__ = "partid"
971
part_type = Unicode()
972
test_type = Unicode()
976
test = Reference(testid, "TestCase.testid")
978
__init__ = _kwarg_init
981
Store.of(self).remove(self)
added
removed
ivle/database.py
