30
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
31
Reference, ReferenceSet, Bool, Storm, Desc
32
from storm.exceptions import NotOneError
36
36
__all__ = ['get_store',
39
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
40
'Exercise', 'Worksheet', 'WorksheetExercise',
41
41
'ExerciseSave', 'ExerciseAttempt',
42
'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
42
'TestCase', 'TestSuite', 'TestSuiteVar'
45
45
def _kwarg_init(self, **kwargs):
54
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,
59
clusterstr += ivle.conf.db_user
60
if ivle.conf.db_password:
61
clusterstr += ':' + ivle.conf.db_password
64
host = ivle.conf.db_host or 'localhost'
65
port = ivle.conf.db_port or 5432
67
clusterstr += '%s:%d' % (host, port)
69
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
88
99
studentid = Unicode()
89
100
settings = Unicode()
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
102
__init__ = _kwarg_init
103
104
def __repr__(self):
115
116
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
119
def password_expired(self):
125
120
fieldval = self.pass_exp
201
196
return store.find(cls, cls.login == unicode(login)).one()
203
198
def get_permissions(self, user):
204
if user and user.rolenm == 'admin' or user is self:
199
if user and user.admin or user is self:
205
200
return set(['view', 'edit'])
238
233
id = Int(primary=True, name="semesterid")
240
235
semester = Unicode()
243
238
offerings = ReferenceSet(id, 'Offering.semester_id')
239
enrolments = ReferenceSet(id,
240
'Offering.semester_id',
242
'Enrolment.offering_id')
245
244
__init__ = _kwarg_init
265
264
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
267
worksheets = ReferenceSet(id, 'Worksheet.offering_id')
266
worksheets = ReferenceSet(id,
267
'Worksheet.offering_id',
268
order_by="Worksheet.seq_no"
269
271
__init__ = _kwarg_init
272
274
return "<%s %r in %r>" % (type(self).__name__, self.subject,
275
def enrol(self, user):
277
def enrol(self, user, role=u'student'):
276
278
'''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)
279
enrolment = Store.of(self).find(Enrolment,
280
Enrolment.user_id == user.id,
281
Enrolment.offering_id == self.id).one()
283
if enrolment is None:
284
enrolment = Enrolment(user=user, offering=self)
285
self.enrolments.add(enrolment)
287
enrolment.active = True
288
enrolment.role = role
290
def unenrol(self, user):
291
'''Unenrol a user from this offering.'''
292
enrolment = Store.of(self).find(Enrolment,
293
Enrolment.user_id == user.id,
294
Enrolment.offering_id == self.id).one()
295
Store.of(enrolment).remove(enrolment)
287
297
def get_permissions(self, user):
289
299
if user is not None:
291
if user.rolenm == 'admin':
300
enrolment = self.get_enrolment(user)
301
if enrolment or user.admin:
303
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
292
305
perms.add('edit')
308
def get_enrolment(self, user):
310
enrolment = self.enrolments.find(user=user).one()
295
316
class Enrolment(Storm):
296
317
__storm_table__ = "enrolment"
297
318
__storm_primary__ = "user_id", "offering_id"
396
415
# WORKSHEETS AND EXERCISES #
398
417
class Exercise(Storm):
399
# Note: Table "problem" is called "Exercise" in the Object layer, since
400
# it's called that everywhere else.
401
__storm_table__ = "problem"
402
#TODO: Add in a field for the user-friendly identifier
418
__storm_table__ = "exercise"
403
419
id = Unicode(primary=True, name="identifier")
405
421
description = Unicode()
421
437
def __repr__(self):
422
438
return "<%s %s>" % (type(self).__name__, self.name)
440
def get_permissions(self, user):
425
448
class Worksheet(Storm):
426
449
__storm_table__ = "worksheet"
428
451
id = Int(primary=True, name="worksheetid")
429
# XXX subject is not linked to a Subject object. This is a property of
430
# the database, and will be refactored.
431
452
offering_id = Int(name="offeringid")
432
name = Unicode(name="identifier")
453
identifier = Unicode()
433
455
assessable = Bool()
436
460
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
437
461
offering = Reference(offering_id, 'Offering.id')
439
exercises = ReferenceSet(id,
440
'WorksheetExercise.worksheet_id',
441
'WorksheetExercise.exercise_id',
443
# Use worksheet_exercises to get access to the WorksheetExercise objects
444
# binding worksheets to exercises. This is required to access the
463
all_worksheet_exercises = ReferenceSet(id,
464
'WorksheetExercise.worksheet_id')
466
# Use worksheet_exercises to get access to the *active* WorksheetExercise
467
# objects binding worksheets to exercises. This is required to access the
445
468
# "optional" field.
446
worksheet_exercises = ReferenceSet(id,
447
'WorksheetExercise.worksheet_id')
470
def worksheet_exercises(self):
471
return self.all_worksheet_exercises.find(active=True)
450
473
__init__ = _kwarg_init
477
500
return self.offering.get_permissions(user)
479
502
class WorksheetExercise(Storm):
480
__storm_table__ = "worksheet_problem"
481
__storm_primary__ = "worksheet_id", "exercise_id"
503
__storm_table__ = "worksheet_exercise"
505
id = Int(primary=True, name="ws_ex_id")
483
507
worksheet_id = Int(name="worksheetid")
484
508
worksheet = Reference(worksheet_id, Worksheet.id)
485
exercise_id = Unicode(name="problemid")
509
exercise_id = Unicode(name="exerciseid")
486
510
exercise = Reference(exercise_id, Exercise.id)
487
511
optional = Bool()
515
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
516
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
489
518
__init__ = _kwarg_init
491
520
def __repr__(self):
492
521
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
522
self.worksheet.identifier)
524
def get_permissions(self, user):
525
return self.worksheet.get_permissions(user)
495
527
class ExerciseSave(Storm):
501
533
ExerciseSave may be extended with additional semantics (such as
502
534
ExerciseAttempt).
504
__storm_table__ = "problem_save"
505
__storm_primary__ = "exercise_id", "user_id", "date"
507
exercise_id = Unicode(name="problemid")
508
exercise = Reference(exercise_id, Exercise.id)
536
__storm_table__ = "exercise_save"
537
__storm_primary__ = "ws_ex_id", "user_id"
539
ws_ex_id = Int(name="ws_ex_id")
540
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
509
542
user_id = Int(name="loginid")
510
543
user = Reference(user_id, User.id)
511
544
date = DateTime()
514
worksheet = Reference(worksheetid, Worksheet.id)
516
547
__init__ = _kwarg_init
532
563
they won't count (either as a penalty or success), but will still be
535
__storm_table__ = "problem_attempt"
536
__storm_primary__ = "exercise_id", "user_id", "date"
566
__storm_table__ = "exercise_attempt"
567
__storm_primary__ = "ws_ex_id", "user_id", "date"
538
569
# The "text" field is the same but has a different name in the DB table
539
570
# for some reason.
581
612
class TestSuiteVar(Storm):
582
613
"""A container for the arguments of a Test Suite"""
583
__storm_table__ = "suite_variables"
614
__storm_table__ = "suite_variable"
584
615
__storm_primary__ = "varid"
597
628
class TestCasePart(Storm):
598
629
"""A container for the test elements of a Test Case"""
599
__storm_table__ = "test_case_parts"
630
__storm_table__ = "test_case_part"
600
631
__storm_primary__ = "partid"
added
removed
ivle/database.py
