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, IntegrityError
35
from ivle.worksheet.rst import rst
36
37
__all__ = ['get_store',
39
40
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
41
'Exercise', 'Worksheet', 'WorksheetExercise',
41
42
'ExerciseSave', 'ExerciseAttempt',
42
'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
43
'TestCase', 'TestSuite', 'TestSuiteVar'
45
46
def _kwarg_init(self, **kwargs):
54
55
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,
60
clusterstr += ivle.conf.db_user
61
if ivle.conf.db_password:
62
clusterstr += ':' + ivle.conf.db_password
65
host = ivle.conf.db_host or 'localhost'
66
port = ivle.conf.db_port or 5432
68
clusterstr += '%s:%d' % (host, port)
70
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
88
100
studentid = Unicode()
89
101
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
103
__init__ = _kwarg_init
103
105
def __repr__(self):
115
117
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
120
def password_expired(self):
125
121
fieldval = self.pass_exp
201
197
return store.find(cls, cls.login == unicode(login)).one()
203
199
def get_permissions(self, user):
204
if user and user.rolenm == 'admin' or user is self:
200
if user and user.admin or user is self:
205
201
return set(['view', 'edit'])
272
275
return "<%s %r in %r>" % (type(self).__name__, self.subject,
275
def enrol(self, user):
278
def enrol(self, user, role=u'student'):
276
279
'''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)
280
enrolment = Store.of(self).find(Enrolment,
281
Enrolment.user_id == user.id,
282
Enrolment.offering_id == self.id).one()
284
if enrolment is None:
285
enrolment = Enrolment(user=user, offering=self)
286
self.enrolments.add(enrolment)
288
enrolment.active = True
289
enrolment.role = role
291
def unenrol(self, user):
292
'''Unenrol a user from this offering.'''
293
enrolment = Store.of(self).find(Enrolment,
294
Enrolment.user_id == user.id,
295
Enrolment.offering_id == self.id).one()
296
Store.of(enrolment).remove(enrolment)
287
298
def get_permissions(self, user):
289
300
if user is not None:
291
if user.rolenm == 'admin':
301
enrolment = self.get_enrolment(user)
302
if enrolment or user.admin:
304
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
292
306
perms.add('edit')
309
def get_enrolment(self, user):
311
enrolment = self.enrolments.find(user=user).one()
295
317
class Enrolment(Storm):
296
318
__storm_table__ = "enrolment"
297
319
__storm_primary__ = "user_id", "offering_id"
396
416
# WORKSHEETS AND EXERCISES #
398
418
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
419
__storm_table__ = "exercise"
403
420
id = Unicode(primary=True, name="identifier")
405
422
description = Unicode()
408
425
include = Unicode()
428
worksheet_exercises = ReferenceSet(id,
429
'WorksheetExercise.exercise_id')
411
431
worksheets = ReferenceSet(id,
412
432
'WorksheetExercise.exercise_id',
413
433
'WorksheetExercise.worksheet_id',
417
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
437
test_suites = ReferenceSet(id,
438
'TestSuite.exercise_id',
419
441
__init__ = _kwarg_init
421
443
def __repr__(self):
422
444
return "<%s %s>" % (type(self).__name__, self.name)
446
def get_permissions(self, user):
453
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
459
def get_description(self):
460
return rst(self.description)
463
"""Deletes the exercise, providing it has no associated worksheets."""
464
if (self.worksheet_exercises.count() > 0):
465
raise IntegrityError()
466
for suite in self.test_suites:
468
Store.of(self).remove(self)
425
470
class Worksheet(Storm):
426
471
__storm_table__ = "worksheet"
428
473
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
474
offering_id = Int(name="offeringid")
432
name = Unicode(name="identifier")
475
identifier = Unicode()
433
477
assessable = Bool()
436
482
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
437
483
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
485
all_worksheet_exercises = ReferenceSet(id,
486
'WorksheetExercise.worksheet_id')
488
# Use worksheet_exercises to get access to the *active* WorksheetExercise
489
# objects binding worksheets to exercises. This is required to access the
445
490
# "optional" field.
446
worksheet_exercises = ReferenceSet(id,
447
'WorksheetExercise.worksheet_id')
493
def worksheet_exercises(self):
494
return self.all_worksheet_exercises.find(active=True)
450
496
__init__ = _kwarg_init
464
510
return store.find(cls, cls.subject == unicode(subjectname),
465
511
cls.name == unicode(worksheetname)).one()
467
def remove_all_exercises(self, store):
513
def remove_all_exercises(self):
469
515
Remove all exercises from this worksheet.
470
516
This does not delete the exercises themselves. It just removes them
471
517
from the worksheet.
519
store = Store.of(self)
520
for ws_ex in self.all_worksheet_exercises:
521
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
522
raise IntegrityError()
473
523
store.find(WorksheetExercise,
474
524
WorksheetExercise.worksheet == self).remove()
476
526
def get_permissions(self, user):
477
527
return self.offering.get_permissions(user)
530
"""Returns the xml of this worksheet, converts from rst if required."""
531
if self.format == u'rst':
532
ws_xml = rst(self.data)
538
"""Deletes the worksheet, provided it has no attempts on any exercises.
540
Returns True if delete succeeded, or False if this worksheet has
541
attempts attached."""
542
for ws_ex in self.all_worksheet_exercises:
543
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
544
raise IntegrityError()
546
self.remove_all_exercises()
547
Store.of(self).remove(self)
479
549
class WorksheetExercise(Storm):
480
__storm_table__ = "worksheet_problem"
481
__storm_primary__ = "worksheet_id", "exercise_id"
550
__storm_table__ = "worksheet_exercise"
552
id = Int(primary=True, name="ws_ex_id")
483
554
worksheet_id = Int(name="worksheetid")
484
555
worksheet = Reference(worksheet_id, Worksheet.id)
485
exercise_id = Unicode(name="problemid")
556
exercise_id = Unicode(name="exerciseid")
486
557
exercise = Reference(exercise_id, Exercise.id)
487
558
optional = Bool()
562
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
563
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
489
565
__init__ = _kwarg_init
491
567
def __repr__(self):
492
568
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
569
self.worksheet.identifier)
571
def get_permissions(self, user):
572
return self.worksheet.get_permissions(user)
495
575
class ExerciseSave(Storm):
501
581
ExerciseSave may be extended with additional semantics (such as
502
582
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)
584
__storm_table__ = "exercise_save"
585
__storm_primary__ = "ws_ex_id", "user_id"
587
ws_ex_id = Int(name="ws_ex_id")
588
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
509
590
user_id = Int(name="loginid")
510
591
user = Reference(user_id, User.id)
511
592
date = DateTime()
514
worksheet = Reference(worksheetid, Worksheet.id)
516
595
__init__ = _kwarg_init
532
611
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"
614
__storm_table__ = "exercise_attempt"
615
__storm_primary__ = "ws_ex_id", "user_id", "date"
538
617
# The "text" field is the same but has a different name in the DB table
539
618
# for some reason.
550
629
__storm_primary__ = "exercise_id", "suiteid"
553
exercise_id = Unicode(name="problemid")
632
exercise_id = Unicode(name="exerciseid")
554
633
description = Unicode()
556
635
function = Unicode()
557
636
stdin = Unicode()
558
637
exercise = Reference(exercise_id, Exercise.id)
559
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
560
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
638
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
639
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
642
"""Delete this suite, without asking questions."""
643
for vaariable in self.variables:
645
for test_case in self.test_cases:
647
Store.of(self).remove(self)
562
649
class TestCase(Storm):
563
650
"""A TestCase is a member of a TestSuite.
577
664
parts = ReferenceSet(testid, "TestCasePart.testid")
579
666
__init__ = _kwarg_init
669
for part in self.parts:
671
Store.of(self).remove(self)
581
673
class TestSuiteVar(Storm):
582
674
"""A container for the arguments of a Test Suite"""
583
__storm_table__ = "suite_variables"
675
__storm_table__ = "suite_variable"
584
676
__storm_primary__ = "varid"
595
687
__init__ = _kwarg_init
690
Store.of(self).remove(self)
597
692
class TestCasePart(Storm):
598
693
"""A container for the test elements of a Test Case"""
599
__storm_table__ = "test_case_parts"
694
__storm_table__ = "test_case_part"
600
695
__storm_primary__ = "partid"
added
removed
ivle/database.py
