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
21
Database Classes and Utilities for Storm ORM
23
This module provides all of the classes which map to database tables.
24
It also provides miscellaneous utility functions for database interaction.
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
Reference, ReferenceSet, Bool, Storm, Desc
36
__all__ = ['get_store',
38
'Subject', 'Semester', 'Offering', 'Enrolment',
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Exercise', 'Worksheet', 'WorksheetExercise',
41
'ExerciseSave', 'ExerciseAttempt',
42
'AlreadyEnrolledError', 'TestCase', 'TestSuite'
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():
54
Returns the Storm connection string, generated from the conf file.
56
return "postgres://%s:%s@%s:%d/%s" % (ivle.conf.db_user,
57
ivle.conf.db_password, ivle.conf.db_host, ivle.conf.db_port,
62
Open a database connection and transaction. Return a storm.store.Store
63
instance connected to the configured IVLE database.
65
return Store(create_database(get_conn_string()))
71
Represents an IVLE user.
73
__storm_table__ = "login"
75
id = Int(primary=True, name="loginid")
84
last_login = DateTime()
92
if self.rolenm is None:
94
return ivle.caps.Role(self.rolenm)
95
def _set_role(self, value):
96
if not isinstance(value, ivle.caps.Role):
97
raise TypeError("role must be an ivle.caps.Role")
98
self.rolenm = unicode(value)
99
role = property(_get_role, _set_role)
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
117
def hasCap(self, capability):
118
"""Given a capability (which is a Role object), returns True if this
119
User has that capability, False otherwise.
121
return self.role.hasCap(capability)
124
def password_expired(self):
125
fieldval = self.pass_exp
126
return fieldval is not None and datetime.datetime.now() > fieldval
129
def account_expired(self):
130
fieldval = self.acct_exp
131
return fieldval is not None and datetime.datetime.now() > fieldval
135
return self.state == 'enabled' and not self.account_expired
137
def _get_enrolments(self, justactive):
138
return Store.of(self).find(Enrolment,
139
Enrolment.user_id == self.id,
140
(Enrolment.active == True) if justactive else True,
141
Enrolment.offering_id == Offering.id,
142
Offering.semester_id == Semester.id,
143
Offering.subject_id == Subject.id).order_by(
145
Desc(Semester.semester),
149
def _set_password(self, password):
153
self.passhash = unicode(User.hash_password(password))
154
password = property(fset=_set_password)
158
return Store.of(self).find(Subject,
159
Enrolment.user_id == self.id,
160
Enrolment.active == True,
161
Offering.id == Enrolment.offering_id,
162
Subject.id == Offering.subject_id).config(distinct=True)
164
# TODO: Invitations should be listed too?
165
def get_groups(self, offering=None):
167
ProjectGroupMembership.user_id == self.id,
168
ProjectGroup.id == ProjectGroupMembership.project_group_id,
172
ProjectSet.offering_id == offering.id,
173
ProjectGroup.project_set_id == ProjectSet.id,
175
return Store.of(self).find(ProjectGroup, *preds)
179
return self.get_groups()
182
def active_enrolments(self):
183
'''A sanely ordered list of the user's active enrolments.'''
184
return self._get_enrolments(True)
187
def enrolments(self):
188
'''A sanely ordered list of all of the user's enrolments.'''
189
return self._get_enrolments(False)
192
def hash_password(password):
193
return md5.md5(password).hexdigest()
196
def get_by_login(cls, store, login):
198
Get the User from the db associated with a given store and
201
return store.find(cls, cls.login == unicode(login)).one()
203
def get_permissions(self, user):
204
if user and user.rolenm == 'admin' or user is self:
205
return set(['view', 'edit'])
209
# SUBJECTS AND ENROLMENTS #
211
class Subject(Storm):
212
__storm_table__ = "subject"
214
id = Int(primary=True, name="subjectid")
215
code = Unicode(name="subj_code")
216
name = Unicode(name="subj_name")
217
short_name = Unicode(name="subj_short_name")
220
offerings = ReferenceSet(id, 'Offering.subject_id')
222
__init__ = _kwarg_init
225
return "<%s '%s'>" % (type(self).__name__, self.short_name)
227
def get_permissions(self, user):
231
if user.rolenm == 'admin':
235
class Semester(Storm):
236
__storm_table__ = "semester"
238
id = Int(primary=True, name="semesterid")
243
offerings = ReferenceSet(id, 'Offering.semester_id')
245
__init__ = _kwarg_init
248
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
250
class Offering(Storm):
251
__storm_table__ = "offering"
253
id = Int(primary=True, name="offeringid")
254
subject_id = Int(name="subject")
255
subject = Reference(subject_id, Subject.id)
256
semester_id = Int(name="semesterid")
257
semester = Reference(semester_id, Semester.id)
258
groups_student_permissions = Unicode()
260
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
261
members = ReferenceSet(id,
262
'Enrolment.offering_id',
265
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
267
worksheets = ReferenceSet(id, 'Worksheet.offering_id')
269
__init__ = _kwarg_init
272
return "<%s %r in %r>" % (type(self).__name__, self.subject,
275
def enrol(self, user):
276
'''Enrol a user in this offering.'''
277
# We'll get a horrible database constraint violation error if we try
278
# to add a second enrolment.
279
if Store.of(self).find(Enrolment,
280
Enrolment.user_id == user.id,
281
Enrolment.offering_id == self.id).count() == 1:
282
raise AlreadyEnrolledError()
284
e = Enrolment(user=user, offering=self, active=True)
285
self.enrolments.add(e)
287
class Enrolment(Storm):
288
__storm_table__ = "enrolment"
289
__storm_primary__ = "user_id", "offering_id"
291
user_id = Int(name="loginid")
292
user = Reference(user_id, User.id)
293
offering_id = Int(name="offeringid")
294
offering = Reference(offering_id, Offering.id)
300
return Store.of(self).find(ProjectGroup,
301
ProjectSet.offering_id == self.offering.id,
302
ProjectGroup.project_set_id == ProjectSet.id,
303
ProjectGroupMembership.project_group_id == ProjectGroup.id,
304
ProjectGroupMembership.user_id == self.user.id)
306
__init__ = _kwarg_init
309
return "<%s %r in %r>" % (type(self).__name__, self.user,
312
class AlreadyEnrolledError(Exception):
317
class ProjectSet(Storm):
318
__storm_table__ = "project_set"
320
id = Int(name="projectsetid", primary=True)
321
offering_id = Int(name="offeringid")
322
offering = Reference(offering_id, Offering.id)
323
max_students_per_group = Int()
325
projects = ReferenceSet(id, 'Project.project_set_id')
326
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
328
__init__ = _kwarg_init
331
return "<%s %d in %r>" % (type(self).__name__, self.id,
334
class Project(Storm):
335
__storm_table__ = "project"
337
id = Int(name="projectid", primary=True)
340
project_set_id = Int(name="projectsetid")
341
project_set = Reference(project_set_id, ProjectSet.id)
342
deadline = DateTime()
344
__init__ = _kwarg_init
347
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
348
self.project_set.offering)
350
class ProjectGroup(Storm):
351
__storm_table__ = "project_group"
353
id = Int(name="groupid", primary=True)
354
name = Unicode(name="groupnm")
355
project_set_id = Int(name="projectsetid")
356
project_set = Reference(project_set_id, ProjectSet.id)
358
created_by_id = Int(name="createdby")
359
created_by = Reference(created_by_id, User.id)
362
members = ReferenceSet(id,
363
"ProjectGroupMembership.project_group_id",
364
"ProjectGroupMembership.user_id",
367
__init__ = _kwarg_init
370
return "<%s %s in %r>" % (type(self).__name__, self.name,
371
self.project_set.offering)
373
class ProjectGroupMembership(Storm):
374
__storm_table__ = "group_member"
375
__storm_primary__ = "user_id", "project_group_id"
377
user_id = Int(name="loginid")
378
user = Reference(user_id, User.id)
379
project_group_id = Int(name="groupid")
380
project_group = Reference(project_group_id, ProjectGroup.id)
382
__init__ = _kwarg_init
385
return "<%s %r in %r>" % (type(self).__name__, self.user,
388
# WORKSHEETS AND EXERCISES #
390
class Exercise(Storm):
391
# Note: Table "problem" is called "Exercise" in the Object layer, since
392
# it's called that everywhere else.
393
__storm_table__ = "problem"
394
#TODO: Add in a field for the user-friendly identifier
395
id = Unicode(primary=True, name="identifier")
397
description = Unicode()
403
worksheets = ReferenceSet(id,
404
'WorksheetExercise.exercise_id',
405
'WorksheetExercise.worksheet_id',
409
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
411
__init__ = _kwarg_init
414
return "<%s %s>" % (type(self).__name__, self.name)
417
def get_by_name(cls, store, name):
419
Get the Exercise from the db associated with a given store and name.
420
If the exercise is not in the database, creates it and inserts it
423
ex = store.find(cls, cls.name == unicode(name)).one()
426
ex = Exercise(name=unicode(name))
431
class Worksheet(Storm):
432
__storm_table__ = "worksheet"
434
id = Int(primary=True, name="worksheetid")
435
# XXX subject is not linked to a Subject object. This is a property of
436
# the database, and will be refactored.
438
offering_id = Int(name="offeringid")
439
name = Unicode(name="identifier")
443
offering = Reference(offering_id, 'Offering.id')
445
exercises = ReferenceSet(id,
446
'WorksheetExercise.worksheet_id',
447
'WorksheetExercise.exercise_id',
449
# Use worksheet_exercises to get access to the WorksheetExercise objects
450
# binding worksheets to exercises. This is required to access the
452
worksheet_exercises = ReferenceSet(id,
453
'WorksheetExercise.worksheet_id')
456
__init__ = _kwarg_init
459
return "<%s %s>" % (type(self).__name__, self.name)
461
# XXX Refactor this - make it an instance method of Subject rather than a
462
# class method of Worksheet. Can't do that now because Subject isn't
463
# linked referentially to the Worksheet.
465
def get_by_name(cls, store, subjectname, worksheetname):
467
Get the Worksheet from the db associated with a given store, subject
468
name and worksheet name.
470
return store.find(cls, cls.subject == unicode(subjectname),
471
cls.name == unicode(worksheetname)).one()
473
def remove_all_exercises(self, store):
475
Remove all exercises from this worksheet.
476
This does not delete the exercises themselves. It just removes them
479
store.find(WorksheetExercise,
480
WorksheetExercise.worksheet == self).remove()
482
class WorksheetExercise(Storm):
483
__storm_table__ = "worksheet_problem"
484
__storm_primary__ = "worksheet_id", "exercise_id"
486
worksheet_id = Int(name="worksheetid")
487
worksheet = Reference(worksheet_id, Worksheet.id)
488
exercise_id = Unicode(name="problemid")
489
exercise = Reference(exercise_id, Exercise.id)
492
__init__ = _kwarg_init
495
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
498
class ExerciseSave(Storm):
500
Represents a potential solution to an exercise that a user has submitted
501
to the server for storage.
502
A basic ExerciseSave is just the current saved text for this exercise for
503
this user (doesn't count towards their attempts).
504
ExerciseSave may be extended with additional semantics (such as
507
__storm_table__ = "problem_save"
508
__storm_primary__ = "exercise_id", "user_id", "date"
510
exercise_id = Unicode(name="problemid")
511
exercise = Reference(exercise_id, Exercise.id)
512
user_id = Int(name="loginid")
513
user = Reference(user_id, User.id)
517
worksheet = Reference(worksheetid, Worksheet.id)
519
__init__ = _kwarg_init
522
return "<%s %s by %s at %s>" % (type(self).__name__,
523
self.exercise.name, self.user.login, self.date.strftime("%c"))
525
class ExerciseAttempt(ExerciseSave):
527
An ExerciseAttempt is a special case of an ExerciseSave. Like an
528
ExerciseSave, it constitutes exercise solution data that the user has
529
submitted to the server for storage.
530
In addition, it contains additional information about the submission.
531
complete - True if this submission was successful, rendering this exercise
532
complete for this user.
533
active - True if this submission is "active" (usually true). Submissions
534
may be de-activated by privileged users for special reasons, and then
535
they won't count (either as a penalty or success), but will still be
538
__storm_table__ = "problem_attempt"
539
__storm_primary__ = "exercise_id", "user_id", "date"
541
# The "text" field is the same but has a different name in the DB table
543
text = Unicode(name="attempt")
547
def get_permissions(self, user):
548
return set(['view']) if user is self.user else set()
550
class TestSuite(Storm):
551
"""A Testsuite acts as a container for the test cases of an exercise."""
552
__storm_table__ = "test_suite"
553
__storm_primary__ = "exercise_id", "suiteid"
556
exercise_id = Unicode(name="problemid")
557
exercise = Reference(exercise_id, Exercise.id)
558
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
559
description = Unicode()
562
class TestCase(Storm):
563
"""A TestCase is a member of a TestSuite.
565
It contains the data necessary to check if an exercise is correct"""
566
__storm_table__ = "test_case"
567
__storm_primary__ = "testid", "suiteid"
571
suite = Reference(suiteid, TestSuite.suiteid)
575
code_type = Unicode()
580
__init__ = _kwarg_init
added
removed
ivle/database.py
