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
class Project(Storm):
439
"""A student project for which submissions can be made."""
441
__storm_table__ = "project"
443
id = Int(name="projectid", primary=True)
445
short_name = Unicode()
448
project_set_id = Int(name="projectsetid")
449
project_set = Reference(project_set_id, ProjectSet.id)
450
deadline = DateTime()
452
assesseds = ReferenceSet(id, 'Assessed.project_id')
453
submissions = ReferenceSet(id,
454
'Assessed.project_id',
456
'ProjectSubmission.assessed_id')
458
__init__ = _kwarg_init
461
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
462
self.project_set.offering)
464
def can_submit(self, principal):
465
return (self in principal.get_projects() and
466
self.deadline > datetime.datetime.now())
468
def submit(self, principal, path, revision, who):
469
"""Submit a Subversion path and revision to a project.
471
@param principal: The owner of the Subversion repository, and the
472
entity on behalf of whom the submission is being made
473
@param path: A path within that repository to submit.
474
@param revision: The revision of that path to submit.
475
@param who: The user who is actually making the submission.
478
if not self.can_submit(principal):
479
raise Exception('cannot submit')
481
a = Assessed.get(Store.of(self), principal, self)
482
ps = ProjectSubmission()
484
ps.revision = revision
485
ps.date_submitted = datetime.datetime.now()
492
class ProjectGroup(Storm):
493
"""A group of students working together on a project."""
495
__storm_table__ = "project_group"
497
id = Int(name="groupid", primary=True)
498
name = Unicode(name="groupnm")
499
project_set_id = Int(name="projectsetid")
500
project_set = Reference(project_set_id, ProjectSet.id)
502
created_by_id = Int(name="createdby")
503
created_by = Reference(created_by_id, User.id)
506
members = ReferenceSet(id,
507
"ProjectGroupMembership.project_group_id",
508
"ProjectGroupMembership.user_id",
511
__init__ = _kwarg_init
514
return "<%s %s in %r>" % (type(self).__name__, self.name,
515
self.project_set.offering)
518
def display_name(self):
519
return '%s (%s)' % (self.nick, self.name)
521
def get_projects(self, offering=None, active_only=True):
522
'''Find projects that the group can submit.
524
This will include projects in the project set which owns this group,
525
unless the project set disallows groups (in which case none will be
528
@param active_only: Whether to only search active offerings.
529
@param offering: An optional offering to restrict the search to.
531
return Store.of(self).find(Project,
532
Project.project_set_id == ProjectSet.id,
533
ProjectSet.id == self.project_set.id,
534
ProjectSet.max_students_per_group != None,
535
ProjectSet.offering_id == Offering.id,
536
(offering is None) or (Offering.id == offering.id),
537
Semester.id == Offering.semester_id,
538
(not active_only) or (Semester.state == u'current'))
541
def get_permissions(self, user):
542
if user.admin or user in self.members:
543
return set(['submit_project'])
547
class ProjectGroupMembership(Storm):
548
"""A student's membership in a project group."""
550
__storm_table__ = "group_member"
551
__storm_primary__ = "user_id", "project_group_id"
553
user_id = Int(name="loginid")
554
user = Reference(user_id, User.id)
555
project_group_id = Int(name="groupid")
556
project_group = Reference(project_group_id, ProjectGroup.id)
558
__init__ = _kwarg_init
561
return "<%s %r in %r>" % (type(self).__name__, self.user,
564
class Assessed(Storm):
565
"""A composite of a user or group combined with a project.
567
Each project submission and extension refers to an Assessed. It is the
568
sole specifier of the repository and project.
571
__storm_table__ = "assessed"
573
id = Int(name="assessedid", primary=True)
574
user_id = Int(name="loginid")
575
user = Reference(user_id, User.id)
576
project_group_id = Int(name="groupid")
577
project_group = Reference(project_group_id, ProjectGroup.id)
579
project_id = Int(name="projectid")
580
project = Reference(project_id, Project.id)
582
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
583
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
586
return "<%s %r in %r>" % (type(self).__name__,
587
self.user or self.project_group, self.project)
590
def get(cls, store, principal, project):
591
"""Find or create an Assessed for the given user or group and project.
593
@param principal: The user or group.
594
@param project: The project.
597
if t not in (User, ProjectGroup):
598
raise AssertionError('principal must be User or ProjectGroup')
601
(t is User) or (cls.project_group_id == principal.id),
602
(t is ProjectGroup) or (cls.user_id == principal.id),
603
Project.id == project.id).one()
610
a.project_group = principal
617
class ProjectExtension(Storm):
618
"""An extension granted to a user or group on a particular project.
620
The user or group and project are specified by the Assessed.
623
__storm_table__ = "project_extension"
625
id = Int(name="extensionid", primary=True)
626
assessed_id = Int(name="assessedid")
627
assessed = Reference(assessed_id, Assessed.id)
628
deadline = DateTime()
629
approver_id = Int(name="approver")
630
approver = Reference(approver_id, User.id)
633
class ProjectSubmission(Storm):
634
"""A submission from a user or group repository to a particular project.
636
The content of a submission is a single path and revision inside a
637
repository. The repository is that owned by the submission's user and
638
group, while the path and revision are explicit.
640
The user or group and project are specified by the Assessed.
643
__storm_table__ = "project_submission"
645
id = Int(name="submissionid", primary=True)
646
assessed_id = Int(name="assessedid")
647
assessed = Reference(assessed_id, Assessed.id)
650
submitter_id = Int(name="submitter")
651
submitter = Reference(submitter_id, User.id)
652
date_submitted = DateTime()
655
# WORKSHEETS AND EXERCISES #
657
class Exercise(Storm):
658
"""An exercise for students to complete in a worksheet.
660
An exercise may be present in any number of worksheets.
663
__storm_table__ = "exercise"
664
id = Unicode(primary=True, name="identifier")
666
description = Unicode()
672
worksheet_exercises = ReferenceSet(id,
673
'WorksheetExercise.exercise_id')
675
worksheets = ReferenceSet(id,
676
'WorksheetExercise.exercise_id',
677
'WorksheetExercise.worksheet_id',
681
test_suites = ReferenceSet(id,
682
'TestSuite.exercise_id',
685
__init__ = _kwarg_init
688
return "<%s %s>" % (type(self).__name__, self.name)
690
def get_permissions(self, user):
697
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
703
def get_description(self):
704
"""Return the description interpreted as reStructuredText."""
705
return rst(self.description)
708
"""Deletes the exercise, providing it has no associated worksheets."""
709
if (self.worksheet_exercises.count() > 0):
710
raise IntegrityError()
711
for suite in self.test_suites:
713
Store.of(self).remove(self)
715
class Worksheet(Storm):
716
"""A worksheet with exercises for students to complete.
718
Worksheets are owned by offerings.
721
__storm_table__ = "worksheet"
723
id = Int(primary=True, name="worksheetid")
724
offering_id = Int(name="offeringid")
725
identifier = Unicode()
732
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
733
offering = Reference(offering_id, 'Offering.id')
735
all_worksheet_exercises = ReferenceSet(id,
736
'WorksheetExercise.worksheet_id')
738
# Use worksheet_exercises to get access to the *active* WorksheetExercise
739
# objects binding worksheets to exercises. This is required to access the
743
def worksheet_exercises(self):
744
return self.all_worksheet_exercises.find(active=True)
746
__init__ = _kwarg_init
749
return "<%s %s>" % (type(self).__name__, self.name)
751
def remove_all_exercises(self):
752
"""Remove all exercises from this worksheet.
754
This does not delete the exercises themselves. It just removes them
757
store = Store.of(self)
758
for ws_ex in self.all_worksheet_exercises:
759
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
760
raise IntegrityError()
761
store.find(WorksheetExercise,
762
WorksheetExercise.worksheet == self).remove()
764
def get_permissions(self, user):
765
return self.offering.get_permissions(user)
768
"""Returns the xml of this worksheet, converts from rst if required."""
769
if self.format == u'rst':
770
ws_xml = rst(self.data)
776
"""Deletes the worksheet, provided it has no attempts on any exercises.
778
Returns True if delete succeeded, or False if this worksheet has
779
attempts attached."""
780
for ws_ex in self.all_worksheet_exercises:
781
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
782
raise IntegrityError()
784
self.remove_all_exercises()
785
Store.of(self).remove(self)
787
class WorksheetExercise(Storm):
788
"""A link between a worksheet and one of its exercises.
790
These may be marked optional, in which case the exercise does not count
791
for marking purposes. The sequence number is used to order the worksheet
795
__storm_table__ = "worksheet_exercise"
797
id = Int(primary=True, name="ws_ex_id")
799
worksheet_id = Int(name="worksheetid")
800
worksheet = Reference(worksheet_id, Worksheet.id)
801
exercise_id = Unicode(name="exerciseid")
802
exercise = Reference(exercise_id, Exercise.id)
807
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
808
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
810
__init__ = _kwarg_init
813
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
814
self.worksheet.identifier)
816
def get_permissions(self, user):
817
return self.worksheet.get_permissions(user)
820
class ExerciseSave(Storm):
821
"""A potential exercise solution submitted by a user for storage.
823
This is not an actual tested attempt at an exercise, it's just a save of
827
__storm_table__ = "exercise_save"
828
__storm_primary__ = "ws_ex_id", "user_id"
830
ws_ex_id = Int(name="ws_ex_id")
831
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
833
user_id = Int(name="loginid")
834
user = Reference(user_id, User.id)
838
__init__ = _kwarg_init
841
return "<%s %s by %s at %s>" % (type(self).__name__,
842
self.exercise.name, self.user.login, self.date.strftime("%c"))
844
class ExerciseAttempt(ExerciseSave):
845
"""An attempt at solving an exercise.
847
This is a special case of ExerciseSave, used when the user submits a
848
candidate solution. Like an ExerciseSave, it constitutes exercise solution
851
In addition, it contains information about the result of the submission:
853
- complete - True if this submission was successful, rendering this
854
exercise complete for this user in this worksheet.
855
- active - True if this submission is "active" (usually true).
856
Submissions may be de-activated by privileged users for
857
special reasons, and then they won't count (either as a
858
penalty or success), but will still be stored.
861
__storm_table__ = "exercise_attempt"
862
__storm_primary__ = "ws_ex_id", "user_id", "date"
864
# The "text" field is the same but has a different name in the DB table
866
text = Unicode(name="attempt")
870
def get_permissions(self, user):
871
return set(['view']) if user is self.user else set()
873
class TestSuite(Storm):
874
"""A container to group an exercise's test cases.
876
The test suite contains some information on how to test. The function to
877
test, variables to set and stdin data are stored here.
880
__storm_table__ = "test_suite"
881
__storm_primary__ = "exercise_id", "suiteid"
884
exercise_id = Unicode(name="exerciseid")
885
description = Unicode()
889
exercise = Reference(exercise_id, Exercise.id)
890
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
891
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
894
"""Delete this suite, without asking questions."""
895
for vaariable in self.variables:
897
for test_case in self.test_cases:
899
Store.of(self).remove(self)
901
class TestCase(Storm):
902
"""A container for actual tests (see TestCasePart), inside a test suite.
904
It is the lowest level shown to students on their pass/fail status."""
906
__storm_table__ = "test_case"
907
__storm_primary__ = "testid", "suiteid"
911
suite = Reference(suiteid, "TestSuite.suiteid")
914
test_default = Unicode()
917
parts = ReferenceSet(testid, "TestCasePart.testid")
919
__init__ = _kwarg_init
922
for part in self.parts:
924
Store.of(self).remove(self)
926
class TestSuiteVar(Storm):
927
"""A variable used by an exercise test suite.
929
This may represent a function argument or a normal variable.
932
__storm_table__ = "suite_variable"
933
__storm_primary__ = "varid"
938
var_value = Unicode()
942
suite = Reference(suiteid, "TestSuite.suiteid")
944
__init__ = _kwarg_init
947
Store.of(self).remove(self)
949
class TestCasePart(Storm):
950
"""An actual piece of code to test an exercise solution."""
952
__storm_table__ = "test_case_part"
953
__storm_primary__ = "partid"
958
part_type = Unicode()
959
test_type = Unicode()
963
test = Reference(testid, "TestCase.testid")
965
__init__ = _kwarg_init
968
Store.of(self).remove(self)
added
removed
ivle/database.py
