18
18
# Author: Matt Giuca, Will Grant
21
Database Classes and Utilities for Storm ORM
20
"""Database utilities and content classes.
23
22
This module provides all of the classes which map to database tables.
24
23
It also provides miscellaneous utility functions for database interaction.
30
29
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
30
Reference, ReferenceSet, Bool, Storm, Desc
31
from storm.exceptions import NotOneError, IntegrityError
33
from ivle.worksheet.rst import rst
36
35
__all__ = ['get_store',
38
37
'Subject', 'Semester', 'Offering', 'Enrolment',
39
38
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
39
'Assessed', 'ProjectSubmission', 'ProjectExtension',
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):
49
49
% (self.__class__.__name__, k))
50
50
setattr(self, k, v)
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()))
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)))
71
Represents an IVLE user.
82
"""An IVLE user account."""
73
83
__storm_table__ = "login"
75
85
id = Int(primary=True, name="loginid")
77
87
passhash = Unicode()
82
92
pass_exp = DateTime()
188
190
'''A sanely ordered list of all of the user's enrolments.'''
189
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)
192
214
def hash_password(password):
193
return md5.md5(password).hexdigest()
215
"""Hash a password with MD5."""
216
return hashlib.md5(password).hexdigest()
196
219
def get_by_login(cls, store, login):
198
Get the User from the db associated with a given store and
220
"""Find a user in a store by login name."""
201
221
return store.find(cls, cls.login == unicode(login)).one()
203
223
def get_permissions(self, user):
204
if user and user.rolenm == 'admin' or user is self:
205
return set(['view', 'edit'])
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'])
209
234
# SUBJECTS AND ENROLMENTS #
211
236
class Subject(Storm):
237
"""A subject (or course) which is run in some semesters."""
212
239
__storm_table__ = "subject"
214
241
id = Int(primary=True, name="subjectid")
225
252
return "<%s '%s'>" % (type(self).__name__, self.short_name)
227
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.
229
261
if user is not None:
230
262
perms.add('view')
231
if user.rolenm == 'admin':
232
264
perms.add('edit')
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()
235
287
class Semester(Storm):
288
"""A semester in which subjects can be run."""
236
290
__storm_table__ = "semester"
238
292
id = Int(primary=True, name="semesterid")
240
294
semester = Unicode()
243
297
offerings = ReferenceSet(id, 'Offering.semester_id')
298
enrolments = ReferenceSet(id,
299
'Offering.semester_id',
301
'Enrolment.offering_id')
245
303
__init__ = _kwarg_init
272
335
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)
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)
287
362
def get_permissions(self, user):
289
364
if user is not None:
291
if user.rolenm == 'admin':
365
enrolment = self.get_enrolment(user)
366
if enrolment or user.admin:
368
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
292
370
perms.add('edit')
373
def get_enrolment(self, user):
374
"""Find the user's enrolment in this offering."""
376
enrolment = self.enrolments.find(user=user).one()
295
382
class Enrolment(Storm):
383
"""An enrolment of a user in an offering.
385
This represents the roles of both staff and students.
296
388
__storm_table__ = "enrolment"
297
389
__storm_primary__ = "user_id", "offering_id"
342
438
class Project(Storm):
439
"""A student project for which submissions can be made."""
343
441
__storm_table__ = "project"
345
443
id = Int(name="projectid", primary=True)
445
short_name = Unicode()
346
446
synopsis = Unicode()
348
448
project_set_id = Int(name="projectsetid")
349
449
project_set = Reference(project_set_id, ProjectSet.id)
350
450
deadline = DateTime()
452
assesseds = ReferenceSet(id, 'Assessed.project_id')
453
submissions = ReferenceSet(id,
454
'Assessed.project_id',
456
'ProjectSubmission.assessed_id')
352
458
__init__ = _kwarg_init
354
460
def __repr__(self):
355
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
461
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
356
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()
358
492
class ProjectGroup(Storm):
493
"""A group of students working together on a project."""
359
495
__storm_table__ = "project_group"
361
497
id = Int(name="groupid", primary=True)
378
514
return "<%s %s in %r>" % (type(self).__name__, self.name,
379
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'])
381
547
class ProjectGroupMembership(Storm):
548
"""A student's membership in a project group."""
382
550
__storm_table__ = "group_member"
383
551
__storm_primary__ = "user_id", "project_group_id"
393
561
return "<%s %r in %r>" % (type(self).__name__, self.user,
394
562
self.project_group)
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()
396
655
# WORKSHEETS AND EXERCISES #
398
657
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
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"
403
664
id = Unicode(primary=True, name="identifier")
405
666
description = Unicode()
408
669
include = Unicode()
672
worksheet_exercises = ReferenceSet(id,
673
'WorksheetExercise.exercise_id')
411
675
worksheets = ReferenceSet(id,
412
676
'WorksheetExercise.exercise_id',
413
677
'WorksheetExercise.worksheet_id',
417
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
681
test_suites = ReferenceSet(id,
682
'TestSuite.exercise_id',
419
685
__init__ = _kwarg_init
421
687
def __repr__(self):
422
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)
425
715
class Worksheet(Storm):
716
"""A worksheet with exercises for students to complete.
718
Worksheets are owned by offerings.
426
721
__storm_table__ = "worksheet"
428
723
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
724
offering_id = Int(name="offeringid")
432
name = Unicode(name="identifier")
725
identifier = Unicode()
433
727
assessable = Bool()
436
732
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
437
733
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
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
445
740
# "optional" field.
446
worksheet_exercises = ReferenceSet(id,
447
'WorksheetExercise.worksheet_id')
743
def worksheet_exercises(self):
744
return self.all_worksheet_exercises.find(active=True)
450
746
__init__ = _kwarg_init
452
748
def __repr__(self):
453
749
return "<%s %s>" % (type(self).__name__, self.name)
455
# XXX Refactor this - make it an instance method of Subject rather than a
456
# class method of Worksheet. Can't do that now because Subject isn't
457
# linked referentially to the Worksheet.
459
def get_by_name(cls, store, subjectname, worksheetname):
461
Get the Worksheet from the db associated with a given store, subject
462
name and worksheet name.
464
return store.find(cls, cls.subject == unicode(subjectname),
465
cls.name == unicode(worksheetname)).one()
751
def remove_all_exercises(self):
752
"""Remove all exercises from this worksheet.
467
def remove_all_exercises(self, store):
469
Remove all exercises from this worksheet.
470
754
This does not delete the exercises themselves. It just removes them
471
755
from the worksheet.
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()
473
761
store.find(WorksheetExercise,
474
762
WorksheetExercise.worksheet == self).remove()
476
764
def get_permissions(self, user):
477
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)
479
787
class WorksheetExercise(Storm):
480
__storm_table__ = "worksheet_problem"
481
__storm_primary__ = "worksheet_id", "exercise_id"
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")
483
799
worksheet_id = Int(name="worksheetid")
484
800
worksheet = Reference(worksheet_id, Worksheet.id)
485
exercise_id = Unicode(name="problemid")
801
exercise_id = Unicode(name="exerciseid")
486
802
exercise = Reference(exercise_id, Exercise.id)
487
803
optional = Bool()
807
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
808
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
489
810
__init__ = _kwarg_init
491
812
def __repr__(self):
492
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)
495
820
class ExerciseSave(Storm):
497
Represents a potential solution to an exercise that a user has submitted
498
to the server for storage.
499
A basic ExerciseSave is just the current saved text for this exercise for
500
this user (doesn't count towards their attempts).
501
ExerciseSave may be extended with additional semantics (such as
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)
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")
509
833
user_id = Int(name="loginid")
510
834
user = Reference(user_id, User.id)
511
835
date = DateTime()
514
worksheet = Reference(worksheetid, Worksheet.id)
516
838
__init__ = _kwarg_init
520
842
self.exercise.name, self.user.login, self.date.strftime("%c"))
522
844
class ExerciseAttempt(ExerciseSave):
524
An ExerciseAttempt is a special case of an ExerciseSave. Like an
525
ExerciseSave, it constitutes exercise solution data that the user has
526
submitted to the server for storage.
527
In addition, it contains additional information about the submission.
528
complete - True if this submission was successful, rendering this exercise
529
complete for this user.
530
active - True if this submission is "active" (usually true). Submissions
531
may be de-activated by privileged users for special reasons, and then
532
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"
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"
538
864
# The "text" field is the same but has a different name in the DB table
539
865
# for some reason.
540
866
text = Unicode(name="attempt")
541
867
complete = Bool()
544
870
def get_permissions(self, user):
545
871
return set(['view']) if user is self.user else set()
547
873
class TestSuite(Storm):
548
"""A Testsuite acts as a container for the test cases of an exercise."""
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.
549
880
__storm_table__ = "test_suite"
550
881
__storm_primary__ = "exercise_id", "suiteid"
553
exercise_id = Unicode(name="problemid")
884
exercise_id = Unicode(name="exerciseid")
554
885
description = Unicode()
556
887
function = Unicode()
557
888
stdin = Unicode()
558
889
exercise = Reference(exercise_id, Exercise.id)
559
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
560
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
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)
562
901
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"""
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."""
566
906
__storm_table__ = "test_case"
567
907
__storm_primary__ = "testid", "suiteid"
571
911
suite = Reference(suiteid, "TestSuite.suiteid")
added
removed
ivle/database.py
