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.expr import Select, Max
32
from storm.exceptions import NotOneError, IntegrityError
34
from ivle.worksheet.rst import rst
36
36
__all__ = ['get_store',
38
38
'Subject', 'Semester', 'Offering', 'Enrolment',
39
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
41
'Exercise', 'Worksheet', 'WorksheetExercise',
41
42
'ExerciseSave', 'ExerciseAttempt',
42
'AlreadyEnrolledError'
43
'TestCase', 'TestSuite', 'TestSuiteVar'
45
46
def _kwarg_init(self, **kwargs):
49
50
% (self.__class__.__name__, k))
50
51
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()))
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
69
clusterstr += '%s:%d' % (host, port)
71
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
73
def get_store(config):
74
"""Create a Storm store connected to the IVLE database.
76
@param config: The IVLE configuration.
78
return Store(create_database(get_conn_string(config)))
71
Represents an IVLE user.
83
"""An IVLE user account."""
73
84
__storm_table__ = "login"
75
86
id = Int(primary=True, name="loginid")
77
88
passhash = Unicode()
82
93
pass_exp = DateTime()
184
191
'''A sanely ordered list of all of the user's enrolments.'''
185
192
return self._get_enrolments(False)
194
def get_projects(self, offering=None, active_only=True):
195
"""Find projects that the user can submit.
197
This will include projects for offerings in which the user is
198
enrolled, as long as the project is not in a project set which has
199
groups (ie. if maximum number of group members is 0).
201
@param active_only: Whether to only search active offerings.
202
@param offering: An optional offering to restrict the search to.
204
return Store.of(self).find(Project,
205
Project.project_set_id == ProjectSet.id,
206
ProjectSet.max_students_per_group == None,
207
ProjectSet.offering_id == Offering.id,
208
(offering is None) or (Offering.id == offering.id),
209
Semester.id == Offering.semester_id,
210
(not active_only) or (Semester.state == u'current'),
211
Enrolment.offering_id == Offering.id,
212
Enrolment.user_id == self.id)
188
215
def hash_password(password):
189
return md5.md5(password).hexdigest()
216
"""Hash a password with MD5."""
217
return hashlib.md5(password).hexdigest()
192
220
def get_by_login(cls, store, login):
194
Get the User from the db associated with a given store and
221
"""Find a user in a store by login name."""
197
222
return store.find(cls, cls.login == unicode(login)).one()
224
def get_permissions(self, user):
225
"""Determine privileges held by a user over this object.
227
If the user requesting privileges is this user or an admin,
228
they may do everything. Otherwise they may do nothing.
230
if user and user.admin or user is self:
231
return set(['view', 'edit', 'submit_project'])
199
235
# SUBJECTS AND ENROLMENTS #
201
237
class Subject(Storm):
238
"""A subject (or course) which is run in some semesters."""
202
240
__storm_table__ = "subject"
204
242
id = Int(primary=True, name="subjectid")
214
252
def __repr__(self):
215
253
return "<%s '%s'>" % (type(self).__name__, self.short_name)
255
def get_permissions(self, user):
256
"""Determine privileges held by a user over this object.
258
If the user requesting privileges is an admin, they may edit.
259
Otherwise they may only read.
268
def active_offerings(self):
269
"""Find active offerings for this subject.
271
Return a sequence of currently active offerings for this subject
272
(offerings whose semester.state is "current"). There should be 0 or 1
273
elements in this sequence, but it's possible there are more.
275
return self.offerings.find(Offering.semester_id == Semester.id,
276
Semester.state == u'current')
278
def offering_for_semester(self, year, semester):
279
"""Get the offering for the given year/semester, or None.
281
@param year: A string representation of the year.
282
@param semester: A string representation of the semester.
284
return self.offerings.find(Offering.semester_id == Semester.id,
285
Semester.year == unicode(year),
286
Semester.semester == unicode(semester)).one()
217
288
class Semester(Storm):
289
"""A semester in which subjects can be run."""
218
291
__storm_table__ = "semester"
220
293
id = Int(primary=True, name="semesterid")
222
295
semester = Unicode()
225
298
offerings = ReferenceSet(id, 'Offering.semester_id')
299
enrolments = ReferenceSet(id,
300
'Offering.semester_id',
302
'Enrolment.offering_id')
227
304
__init__ = _kwarg_init
247
326
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
328
worksheets = ReferenceSet(id,
329
'Worksheet.offering_id',
249
333
__init__ = _kwarg_init
251
335
def __repr__(self):
252
336
return "<%s %r in %r>" % (type(self).__name__, self.subject,
255
def enrol(self, user):
256
'''Enrol a user in this offering.'''
257
# We'll get a horrible database constraint violation error if we try
258
# to add a second enrolment.
259
if Store.of(self).find(Enrolment,
260
Enrolment.user_id == user.id,
261
Enrolment.offering_id == self.id).count() == 1:
262
raise AlreadyEnrolledError()
264
e = Enrolment(user=user, offering=self, active=True)
265
self.enrolments.add(e)
339
def enrol(self, user, role=u'student'):
340
"""Enrol a user in this offering.
342
Enrolments handle both the staff and student cases. The role controls
343
the privileges granted by this enrolment.
345
enrolment = Store.of(self).find(Enrolment,
346
Enrolment.user_id == user.id,
347
Enrolment.offering_id == self.id).one()
349
if enrolment is None:
350
enrolment = Enrolment(user=user, offering=self)
351
self.enrolments.add(enrolment)
353
enrolment.active = True
354
enrolment.role = role
356
def unenrol(self, user):
357
'''Unenrol a user from this offering.'''
358
enrolment = Store.of(self).find(Enrolment,
359
Enrolment.user_id == user.id,
360
Enrolment.offering_id == self.id).one()
361
Store.of(enrolment).remove(enrolment)
363
def get_permissions(self, user):
366
enrolment = self.get_enrolment(user)
367
if enrolment or user.admin:
369
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
374
def get_enrolment(self, user):
375
"""Find the user's enrolment in this offering."""
377
enrolment = self.enrolments.find(user=user).one()
383
def get_members_by_role(self, role):
384
return Store.of(self).find(User,
385
Enrolment.user_id == User.id,
386
Enrolment.offering_id == self.id,
387
Enrolment.role == role
392
return self.get_members_by_role(u'student')
267
394
class Enrolment(Storm):
395
"""An enrolment of a user in an offering.
397
This represents the roles of both staff and students.
268
400
__storm_table__ = "enrolment"
269
401
__storm_primary__ = "user_id", "offering_id"
311
447
return "<%s %d in %r>" % (type(self).__name__, self.id,
450
def get_permissions(self, user):
451
return self.offering.get_permissions(user)
455
"""Get the entities (groups or users) assigned to submit this project.
457
This will be a Storm ResultSet.
459
#If its a solo project, return everyone in offering
460
if self.max_students_per_group is None:
461
return self.offering.students
463
return self.project_groups
314
465
class Project(Storm):
466
"""A student project for which submissions can be made."""
315
468
__storm_table__ = "project"
317
470
id = Int(name="projectid", primary=True)
472
short_name = Unicode()
318
473
synopsis = Unicode()
320
475
project_set_id = Int(name="projectsetid")
321
476
project_set = Reference(project_set_id, ProjectSet.id)
322
477
deadline = DateTime()
479
assesseds = ReferenceSet(id, 'Assessed.project_id')
480
submissions = ReferenceSet(id,
481
'Assessed.project_id',
483
'ProjectSubmission.assessed_id')
324
485
__init__ = _kwarg_init
326
487
def __repr__(self):
327
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
488
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
328
489
self.project_set.offering)
491
def can_submit(self, principal):
492
return (self in principal.get_projects() and
493
self.deadline > datetime.datetime.now())
495
def submit(self, principal, path, revision, who):
496
"""Submit a Subversion path and revision to a project.
498
@param principal: The owner of the Subversion repository, and the
499
entity on behalf of whom the submission is being made
500
@param path: A path within that repository to submit.
501
@param revision: The revision of that path to submit.
502
@param who: The user who is actually making the submission.
505
if not self.can_submit(principal):
506
raise Exception('cannot submit')
508
a = Assessed.get(Store.of(self), principal, self)
509
ps = ProjectSubmission()
511
ps.revision = revision
512
ps.date_submitted = datetime.datetime.now()
518
def get_permissions(self, user):
519
return self.project_set.offering.get_permissions(user)
522
def latest_submissions(self):
523
"""Return the latest submission for each Assessed."""
524
return Store.of(self).find(ProjectSubmission,
525
Assessed.project_id == self.id,
526
ProjectSubmission.assessed_id == Assessed.id,
527
ProjectSubmission.date_submitted == Select(
528
Max(ProjectSubmission.date_submitted),
529
ProjectSubmission.assessed_id == Assessed.id,
530
tables=ProjectSubmission
330
535
class ProjectGroup(Storm):
536
"""A group of students working together on a project."""
331
538
__storm_table__ = "project_group"
333
540
id = Int(name="groupid", primary=True)
350
557
return "<%s %s in %r>" % (type(self).__name__, self.name,
351
558
self.project_set.offering)
561
def display_name(self):
562
return '%s (%s)' % (self.nick, self.name)
564
def get_projects(self, offering=None, active_only=True):
565
'''Find projects that the group can submit.
567
This will include projects in the project set which owns this group,
568
unless the project set disallows groups (in which case none will be
571
@param active_only: Whether to only search active offerings.
572
@param offering: An optional offering to restrict the search to.
574
return Store.of(self).find(Project,
575
Project.project_set_id == ProjectSet.id,
576
ProjectSet.id == self.project_set.id,
577
ProjectSet.max_students_per_group != None,
578
ProjectSet.offering_id == Offering.id,
579
(offering is None) or (Offering.id == offering.id),
580
Semester.id == Offering.semester_id,
581
(not active_only) or (Semester.state == u'current'))
584
def get_permissions(self, user):
585
if user.admin or user in self.members:
586
return set(['submit_project'])
353
590
class ProjectGroupMembership(Storm):
591
"""A student's membership in a project group."""
354
593
__storm_table__ = "group_member"
355
594
__storm_primary__ = "user_id", "project_group_id"
365
604
return "<%s %r in %r>" % (type(self).__name__, self.user,
366
605
self.project_group)
607
class Assessed(Storm):
608
"""A composite of a user or group combined with a project.
610
Each project submission and extension refers to an Assessed. It is the
611
sole specifier of the repository and project.
614
__storm_table__ = "assessed"
616
id = Int(name="assessedid", primary=True)
617
user_id = Int(name="loginid")
618
user = Reference(user_id, User.id)
619
project_group_id = Int(name="groupid")
620
project_group = Reference(project_group_id, ProjectGroup.id)
622
project_id = Int(name="projectid")
623
project = Reference(project_id, Project.id)
625
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
626
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
629
return "<%s %r in %r>" % (type(self).__name__,
630
self.user or self.project_group, self.project)
634
return self.project_group or self.user
637
def get(cls, store, principal, project):
638
"""Find or create an Assessed for the given user or group and project.
640
@param principal: The user or group.
641
@param project: The project.
644
if t not in (User, ProjectGroup):
645
raise AssertionError('principal must be User or ProjectGroup')
648
(t is User) or (cls.project_group_id == principal.id),
649
(t is ProjectGroup) or (cls.user_id == principal.id),
650
Project.id == project.id).one()
657
a.project_group = principal
664
class ProjectExtension(Storm):
665
"""An extension granted to a user or group on a particular project.
667
The user or group and project are specified by the Assessed.
670
__storm_table__ = "project_extension"
672
id = Int(name="extensionid", primary=True)
673
assessed_id = Int(name="assessedid")
674
assessed = Reference(assessed_id, Assessed.id)
675
deadline = DateTime()
676
approver_id = Int(name="approver")
677
approver = Reference(approver_id, User.id)
680
class ProjectSubmission(Storm):
681
"""A submission from a user or group repository to a particular project.
683
The content of a submission is a single path and revision inside a
684
repository. The repository is that owned by the submission's user and
685
group, while the path and revision are explicit.
687
The user or group and project are specified by the Assessed.
690
__storm_table__ = "project_submission"
692
id = Int(name="submissionid", primary=True)
693
assessed_id = Int(name="assessedid")
694
assessed = Reference(assessed_id, Assessed.id)
697
submitter_id = Int(name="submitter")
698
submitter = Reference(submitter_id, User.id)
699
date_submitted = DateTime()
368
702
# WORKSHEETS AND EXERCISES #
370
704
class Exercise(Storm):
371
# Note: Table "problem" is called "Exercise" in the Object layer, since
372
# it's called that everywhere else.
373
__storm_table__ = "problem"
375
id = Int(primary=True, name="problemid")
376
name = Unicode(name="identifier")
705
"""An exercise for students to complete in a worksheet.
707
An exercise may be present in any number of worksheets.
710
__storm_table__ = "exercise"
711
id = Unicode(primary=True, name="identifier")
713
description = Unicode()
719
worksheet_exercises = ReferenceSet(id,
720
'WorksheetExercise.exercise_id')
379
722
worksheets = ReferenceSet(id,
380
723
'WorksheetExercise.exercise_id',
728
test_suites = ReferenceSet(id,
729
'TestSuite.exercise_id',
385
732
__init__ = _kwarg_init
387
734
def __repr__(self):
388
735
return "<%s %s>" % (type(self).__name__, self.name)
391
def get_by_name(cls, store, name):
393
Get the Exercise from the db associated with a given store and name.
394
If the exercise is not in the database, creates it and inserts it
397
ex = store.find(cls, cls.name == unicode(name)).one()
400
ex = Exercise(name=unicode(name))
737
def get_permissions(self, user):
744
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
747
elif u'tutor' in set((e.role for e in user.active_enrolments)):
753
def get_description(self):
754
"""Return the description interpreted as reStructuredText."""
755
return rst(self.description)
758
"""Deletes the exercise, providing it has no associated worksheets."""
759
if (self.worksheet_exercises.count() > 0):
760
raise IntegrityError()
761
for suite in self.test_suites:
763
Store.of(self).remove(self)
405
765
class Worksheet(Storm):
766
"""A worksheet with exercises for students to complete.
768
Worksheets are owned by offerings.
406
771
__storm_table__ = "worksheet"
408
773
id = Int(primary=True, name="worksheetid")
409
# XXX subject is not linked to a Subject object. This is a property of
410
# the database, and will be refactored.
412
name = Unicode(name="identifier")
774
offering_id = Int(name="offeringid")
775
identifier = Unicode()
413
777
assessable = Bool()
416
exercises = ReferenceSet(id,
417
'WorksheetExercise.worksheet_id',
418
'WorksheetExercise.exercise_id',
420
# Use worksheet_exercises to get access to the WorksheetExercise objects
421
# binding worksheets to exercises. This is required to access the
782
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
783
offering = Reference(offering_id, 'Offering.id')
785
all_worksheet_exercises = ReferenceSet(id,
786
'WorksheetExercise.worksheet_id')
788
# Use worksheet_exercises to get access to the *active* WorksheetExercise
789
# objects binding worksheets to exercises. This is required to access the
422
790
# "optional" field.
423
worksheet_exercises = ReferenceSet(id,
424
'WorksheetExercise.worksheet_id')
793
def worksheet_exercises(self):
794
return self.all_worksheet_exercises.find(active=True)
426
796
__init__ = _kwarg_init
428
798
def __repr__(self):
429
799
return "<%s %s>" % (type(self).__name__, self.name)
431
# XXX Refactor this - make it an instance method of Subject rather than a
432
# class method of Worksheet. Can't do that now because Subject isn't
433
# linked referentially to the Worksheet.
435
def get_by_name(cls, store, subjectname, worksheetname):
437
Get the Worksheet from the db associated with a given store, subject
438
name and worksheet name.
440
return store.find(cls, cls.subject == unicode(subjectname),
441
cls.name == unicode(worksheetname)).one()
801
def remove_all_exercises(self):
802
"""Remove all exercises from this worksheet.
443
def remove_all_exercises(self, store):
445
Remove all exercises from this worksheet.
446
804
This does not delete the exercises themselves. It just removes them
447
805
from the worksheet.
807
store = Store.of(self)
808
for ws_ex in self.all_worksheet_exercises:
809
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
810
raise IntegrityError()
449
811
store.find(WorksheetExercise,
450
812
WorksheetExercise.worksheet == self).remove()
814
def get_permissions(self, user):
815
return self.offering.get_permissions(user)
818
"""Returns the xml of this worksheet, converts from rst if required."""
819
if self.format == u'rst':
820
ws_xml = rst(self.data)
826
"""Deletes the worksheet, provided it has no attempts on any exercises.
828
Returns True if delete succeeded, or False if this worksheet has
829
attempts attached."""
830
for ws_ex in self.all_worksheet_exercises:
831
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
832
raise IntegrityError()
834
self.remove_all_exercises()
835
Store.of(self).remove(self)
452
837
class WorksheetExercise(Storm):
453
__storm_table__ = "worksheet_problem"
454
__storm_primary__ = "worksheet_id", "exercise_id"
838
"""A link between a worksheet and one of its exercises.
840
These may be marked optional, in which case the exercise does not count
841
for marking purposes. The sequence number is used to order the worksheet
845
__storm_table__ = "worksheet_exercise"
847
id = Int(primary=True, name="ws_ex_id")
456
849
worksheet_id = Int(name="worksheetid")
457
850
worksheet = Reference(worksheet_id, Worksheet.id)
458
exercise_id = Int(name="problemid")
851
exercise_id = Unicode(name="exerciseid")
459
852
exercise = Reference(exercise_id, Exercise.id)
460
853
optional = Bool()
857
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
858
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
462
860
__init__ = _kwarg_init
464
862
def __repr__(self):
465
863
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
864
self.worksheet.identifier)
866
def get_permissions(self, user):
867
return self.worksheet.get_permissions(user)
468
870
class ExerciseSave(Storm):
470
Represents a potential solution to an exercise that a user has submitted
471
to the server for storage.
472
A basic ExerciseSave is just the current saved text for this exercise for
473
this user (doesn't count towards their attempts).
474
ExerciseSave may be extended with additional semantics (such as
477
__storm_table__ = "problem_save"
478
__storm_primary__ = "exercise_id", "user_id", "date"
480
exercise_id = Int(name="problemid")
481
exercise = Reference(exercise_id, Exercise.id)
871
"""A potential exercise solution submitted by a user for storage.
873
This is not an actual tested attempt at an exercise, it's just a save of
877
__storm_table__ = "exercise_save"
878
__storm_primary__ = "ws_ex_id", "user_id"
880
ws_ex_id = Int(name="ws_ex_id")
881
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
482
883
user_id = Int(name="loginid")
483
884
user = Reference(user_id, User.id)
484
885
date = DateTime()
491
892
self.exercise.name, self.user.login, self.date.strftime("%c"))
493
894
class ExerciseAttempt(ExerciseSave):
495
An ExerciseAttempt is a special case of an ExerciseSave. Like an
496
ExerciseSave, it constitutes exercise solution data that the user has
497
submitted to the server for storage.
498
In addition, it contains additional information about the submission.
499
complete - True if this submission was successful, rendering this exercise
500
complete for this user.
501
active - True if this submission is "active" (usually true). Submissions
502
may be de-activated by privileged users for special reasons, and then
503
they won't count (either as a penalty or success), but will still be
506
__storm_table__ = "problem_attempt"
507
__storm_primary__ = "exercise_id", "user_id", "date"
895
"""An attempt at solving an exercise.
897
This is a special case of ExerciseSave, used when the user submits a
898
candidate solution. Like an ExerciseSave, it constitutes exercise solution
901
In addition, it contains information about the result of the submission:
903
- complete - True if this submission was successful, rendering this
904
exercise complete for this user in this worksheet.
905
- active - True if this submission is "active" (usually true).
906
Submissions may be de-activated by privileged users for
907
special reasons, and then they won't count (either as a
908
penalty or success), but will still be stored.
911
__storm_table__ = "exercise_attempt"
912
__storm_primary__ = "ws_ex_id", "user_id", "date"
509
914
# The "text" field is the same but has a different name in the DB table
510
915
# for some reason.
511
916
text = Unicode(name="attempt")
512
917
complete = Bool()
920
def get_permissions(self, user):
921
return set(['view']) if user is self.user else set()
923
class TestSuite(Storm):
924
"""A container to group an exercise's test cases.
926
The test suite contains some information on how to test. The function to
927
test, variables to set and stdin data are stored here.
930
__storm_table__ = "test_suite"
931
__storm_primary__ = "exercise_id", "suiteid"
934
exercise_id = Unicode(name="exerciseid")
935
description = Unicode()
939
exercise = Reference(exercise_id, Exercise.id)
940
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
941
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
944
"""Delete this suite, without asking questions."""
945
for vaariable in self.variables:
947
for test_case in self.test_cases:
949
Store.of(self).remove(self)
951
class TestCase(Storm):
952
"""A container for actual tests (see TestCasePart), inside a test suite.
954
It is the lowest level shown to students on their pass/fail status."""
956
__storm_table__ = "test_case"
957
__storm_primary__ = "testid", "suiteid"
961
suite = Reference(suiteid, "TestSuite.suiteid")
964
test_default = Unicode()
967
parts = ReferenceSet(testid, "TestCasePart.testid")
969
__init__ = _kwarg_init
972
for part in self.parts:
974
Store.of(self).remove(self)
976
class TestSuiteVar(Storm):
977
"""A variable used by an exercise test suite.
979
This may represent a function argument or a normal variable.
982
__storm_table__ = "suite_variable"
983
__storm_primary__ = "varid"
988
var_value = Unicode()
992
suite = Reference(suiteid, "TestSuite.suiteid")
994
__init__ = _kwarg_init
997
Store.of(self).remove(self)
999
class TestCasePart(Storm):
1000
"""An actual piece of code to test an exercise solution."""
1002
__storm_table__ = "test_case_part"
1003
__storm_primary__ = "partid"
1008
part_type = Unicode()
1009
test_type = Unicode()
1011
filename = Unicode()
1013
test = Reference(testid, "TestCase.testid")
1015
__init__ = _kwarg_init
1018
Store.of(self).remove(self)
added
removed
ivle/database.py
