18
18
# Author: Matt Giuca, Will Grant
20
"""Database utilities and content classes.
21
Database Classes and Utilities for Storm ORM
22
23
This module provides all of the classes which map to database tables.
23
24
It also provides miscellaneous utility functions for database interaction.
29
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
30
31
Reference, ReferenceSet, Bool, Storm, Desc
31
from storm.exceptions import NotOneError, IntegrityError
33
from ivle.worksheet.rst import rst
35
36
__all__ = ['get_store',
37
38
'Subject', 'Semester', 'Offering', 'Enrolment',
38
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
39
'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
40
'Exercise', 'Worksheet', 'WorksheetExercise',
41
41
'ExerciseSave', 'ExerciseAttempt',
42
'TestCase', 'TestSuite', 'TestSuiteVar'
42
'AlreadyEnrolledError'
45
45
def _kwarg_init(self, **kwargs):
49
49
% (self.__class__.__name__, k))
50
50
setattr(self, k, v)
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)))
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()))
82
"""An IVLE user account."""
71
Represents an IVLE user.
83
73
__storm_table__ = "login"
85
75
id = Int(primary=True, name="loginid")
87
77
passhash = Unicode()
92
82
pass_exp = DateTime()
190
184
'''A sanely ordered list of all of the user's enrolments.'''
191
185
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)
214
188
def hash_password(password):
215
"""Hash a password with MD5."""
216
return hashlib.md5(password).hexdigest()
189
return md5.md5(password).hexdigest()
219
192
def get_by_login(cls, store, login):
220
"""Find a user in a store by login name."""
194
Get the User from the db associated with a given store and
221
197
return store.find(cls, cls.login == unicode(login)).one()
223
def get_permissions(self, user):
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'])
234
199
# SUBJECTS AND ENROLMENTS #
236
201
class Subject(Storm):
237
"""A subject (or course) which is run in some semesters."""
239
202
__storm_table__ = "subject"
241
204
id = Int(primary=True, name="subjectid")
251
214
def __repr__(self):
252
215
return "<%s '%s'>" % (type(self).__name__, self.short_name)
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.
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()
287
217
class Semester(Storm):
288
"""A semester in which subjects can be run."""
290
218
__storm_table__ = "semester"
292
220
id = Int(primary=True, name="semesterid")
294
222
semester = Unicode()
297
225
offerings = ReferenceSet(id, 'Offering.semester_id')
298
enrolments = ReferenceSet(id,
299
'Offering.semester_id',
301
'Enrolment.offering_id')
303
227
__init__ = _kwarg_init
325
247
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
327
worksheets = ReferenceSet(id,
328
'Worksheet.offering_id',
332
249
__init__ = _kwarg_init
334
251
def __repr__(self):
335
252
return "<%s %r in %r>" % (type(self).__name__, self.subject,
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)
362
def get_permissions(self, user):
365
enrolment = self.get_enrolment(user)
366
if enrolment or user.admin:
368
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
373
def get_enrolment(self, user):
374
"""Find the user's enrolment in this offering."""
376
enrolment = self.enrolments.find(user=user).one()
382
def get_students(self):
383
enrolments = self.enrolments.find(role=u'student')
384
return [enrolment.user for enrolment in enrolments]
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)
386
267
class Enrolment(Storm):
387
"""An enrolment of a user in an offering.
389
This represents the roles of both staff and students.
392
268
__storm_table__ = "enrolment"
393
269
__storm_primary__ = "user_id", "offering_id"
439
311
return "<%s %d in %r>" % (type(self).__name__, self.id,
442
def get_permissions(self, user):
443
return self.offering.get_permissions(user)
445
# Get the individuals (groups or users) Assigned to this project
446
def get_assigned(self):
447
#If its a Solo project, return everyone in offering
448
if self.max_students_per_group is None:
449
return self.offering.get_students()
451
return self.project_groups
453
314
class Project(Storm):
454
"""A student project for which submissions can be made."""
456
315
__storm_table__ = "project"
458
317
id = Int(name="projectid", primary=True)
460
short_name = Unicode()
461
318
synopsis = Unicode()
463
320
project_set_id = Int(name="projectsetid")
464
321
project_set = Reference(project_set_id, ProjectSet.id)
465
322
deadline = DateTime()
467
assesseds = ReferenceSet(id, 'Assessed.project_id')
468
submissions = ReferenceSet(id,
469
'Assessed.project_id',
471
'ProjectSubmission.assessed_id')
473
324
__init__ = _kwarg_init
475
326
def __repr__(self):
476
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
327
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
477
328
self.project_set.offering)
479
def can_submit(self, principal):
480
return (self in principal.get_projects() and
481
self.deadline > datetime.datetime.now())
483
def submit(self, principal, path, revision, who):
484
"""Submit a Subversion path and revision to a project.
486
@param principal: The owner of the Subversion repository, and the
487
entity on behalf of whom the submission is being made
488
@param path: A path within that repository to submit.
489
@param revision: The revision of that path to submit.
490
@param who: The user who is actually making the submission.
493
if not self.can_submit(principal):
494
raise Exception('cannot submit')
496
a = Assessed.get(Store.of(self), principal, self)
497
ps = ProjectSubmission()
499
ps.revision = revision
500
ps.date_submitted = datetime.datetime.now()
506
def get_permissions(self, user):
507
return self.project_set.offering.get_permissions(user)
510
330
class ProjectGroup(Storm):
511
"""A group of students working together on a project."""
513
331
__storm_table__ = "project_group"
515
333
id = Int(name="groupid", primary=True)
532
350
return "<%s %s in %r>" % (type(self).__name__, self.name,
533
351
self.project_set.offering)
536
def display_name(self):
537
return '%s (%s)' % (self.nick, self.name)
539
def get_projects(self, offering=None, active_only=True):
540
'''Find projects that the group can submit.
542
This will include projects in the project set which owns this group,
543
unless the project set disallows groups (in which case none will be
546
@param active_only: Whether to only search active offerings.
547
@param offering: An optional offering to restrict the search to.
549
return Store.of(self).find(Project,
550
Project.project_set_id == ProjectSet.id,
551
ProjectSet.id == self.project_set.id,
552
ProjectSet.max_students_per_group != None,
553
ProjectSet.offering_id == Offering.id,
554
(offering is None) or (Offering.id == offering.id),
555
Semester.id == Offering.semester_id,
556
(not active_only) or (Semester.state == u'current'))
559
def get_permissions(self, user):
560
if user.admin or user in self.members:
561
return set(['submit_project'])
565
353
class ProjectGroupMembership(Storm):
566
"""A student's membership in a project group."""
568
354
__storm_table__ = "group_member"
569
355
__storm_primary__ = "user_id", "project_group_id"
579
365
return "<%s %r in %r>" % (type(self).__name__, self.user,
580
366
self.project_group)
582
class Assessed(Storm):
583
"""A composite of a user or group combined with a project.
585
Each project submission and extension refers to an Assessed. It is the
586
sole specifier of the repository and project.
589
__storm_table__ = "assessed"
591
id = Int(name="assessedid", primary=True)
592
user_id = Int(name="loginid")
593
user = Reference(user_id, User.id)
594
project_group_id = Int(name="groupid")
595
project_group = Reference(project_group_id, ProjectGroup.id)
597
project_id = Int(name="projectid")
598
project = Reference(project_id, Project.id)
600
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
601
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
604
return "<%s %r in %r>" % (type(self).__name__,
605
self.user or self.project_group, self.project)
609
return self.project_group or self.user
612
def get(cls, store, principal, project):
613
"""Find or create an Assessed for the given user or group and project.
615
@param principal: The user or group.
616
@param project: The project.
619
if t not in (User, ProjectGroup):
620
raise AssertionError('principal must be User or ProjectGroup')
623
(t is User) or (cls.project_group_id == principal.id),
624
(t is ProjectGroup) or (cls.user_id == principal.id),
625
Project.id == project.id).one()
632
a.project_group = principal
639
class ProjectExtension(Storm):
640
"""An extension granted to a user or group on a particular project.
642
The user or group and project are specified by the Assessed.
645
__storm_table__ = "project_extension"
647
id = Int(name="extensionid", primary=True)
648
assessed_id = Int(name="assessedid")
649
assessed = Reference(assessed_id, Assessed.id)
650
deadline = DateTime()
651
approver_id = Int(name="approver")
652
approver = Reference(approver_id, User.id)
655
class ProjectSubmission(Storm):
656
"""A submission from a user or group repository to a particular project.
658
The content of a submission is a single path and revision inside a
659
repository. The repository is that owned by the submission's user and
660
group, while the path and revision are explicit.
662
The user or group and project are specified by the Assessed.
665
__storm_table__ = "project_submission"
667
id = Int(name="submissionid", primary=True)
668
assessed_id = Int(name="assessedid")
669
assessed = Reference(assessed_id, Assessed.id)
672
submitter_id = Int(name="submitter")
673
submitter = Reference(submitter_id, User.id)
674
date_submitted = DateTime()
677
368
# WORKSHEETS AND EXERCISES #
679
370
class Exercise(Storm):
680
"""An exercise for students to complete in a worksheet.
682
An exercise may be present in any number of worksheets.
685
__storm_table__ = "exercise"
686
id = Unicode(primary=True, name="identifier")
688
description = Unicode()
694
worksheet_exercises = ReferenceSet(id,
695
'WorksheetExercise.exercise_id')
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")
697
379
worksheets = ReferenceSet(id,
698
380
'WorksheetExercise.exercise_id',
703
test_suites = ReferenceSet(id,
704
'TestSuite.exercise_id',
707
385
__init__ = _kwarg_init
709
387
def __repr__(self):
710
388
return "<%s %s>" % (type(self).__name__, self.name)
712
def get_permissions(self, user):
719
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
722
elif u'tutor' in set((e.role for e in user.active_enrolments)):
728
def get_description(self):
729
"""Return the description interpreted as reStructuredText."""
730
return rst(self.description)
733
"""Deletes the exercise, providing it has no associated worksheets."""
734
if (self.worksheet_exercises.count() > 0):
735
raise IntegrityError()
736
for suite in self.test_suites:
738
Store.of(self).remove(self)
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))
740
405
class Worksheet(Storm):
741
"""A worksheet with exercises for students to complete.
743
Worksheets are owned by offerings.
746
406
__storm_table__ = "worksheet"
748
408
id = Int(primary=True, name="worksheetid")
749
offering_id = Int(name="offeringid")
750
identifier = Unicode()
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")
752
413
assessable = Bool()
757
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
758
offering = Reference(offering_id, 'Offering.id')
760
all_worksheet_exercises = ReferenceSet(id,
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
423
worksheet_exercises = ReferenceSet(id,
761
424
'WorksheetExercise.worksheet_id')
763
# Use worksheet_exercises to get access to the *active* WorksheetExercise
764
# objects binding worksheets to exercises. This is required to access the
768
def worksheet_exercises(self):
769
return self.all_worksheet_exercises.find(active=True)
771
426
__init__ = _kwarg_init
773
428
def __repr__(self):
774
429
return "<%s %s>" % (type(self).__name__, self.name)
776
def remove_all_exercises(self):
777
"""Remove all exercises from this worksheet.
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()
443
def remove_all_exercises(self, store):
445
Remove all exercises from this worksheet.
779
446
This does not delete the exercises themselves. It just removes them
780
447
from the worksheet.
782
store = Store.of(self)
783
for ws_ex in self.all_worksheet_exercises:
784
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
785
raise IntegrityError()
786
449
store.find(WorksheetExercise,
787
450
WorksheetExercise.worksheet == self).remove()
789
def get_permissions(self, user):
790
return self.offering.get_permissions(user)
793
"""Returns the xml of this worksheet, converts from rst if required."""
794
if self.format == u'rst':
795
ws_xml = rst(self.data)
801
"""Deletes the worksheet, provided it has no attempts on any exercises.
803
Returns True if delete succeeded, or False if this worksheet has
804
attempts attached."""
805
for ws_ex in self.all_worksheet_exercises:
806
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
807
raise IntegrityError()
809
self.remove_all_exercises()
810
Store.of(self).remove(self)
812
452
class WorksheetExercise(Storm):
813
"""A link between a worksheet and one of its exercises.
815
These may be marked optional, in which case the exercise does not count
816
for marking purposes. The sequence number is used to order the worksheet
820
__storm_table__ = "worksheet_exercise"
822
id = Int(primary=True, name="ws_ex_id")
453
__storm_table__ = "worksheet_problem"
454
__storm_primary__ = "worksheet_id", "exercise_id"
824
456
worksheet_id = Int(name="worksheetid")
825
457
worksheet = Reference(worksheet_id, Worksheet.id)
826
exercise_id = Unicode(name="exerciseid")
458
exercise_id = Int(name="problemid")
827
459
exercise = Reference(exercise_id, Exercise.id)
828
460
optional = Bool()
832
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
833
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
835
462
__init__ = _kwarg_init
837
464
def __repr__(self):
838
465
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
839
self.worksheet.identifier)
841
def get_permissions(self, user):
842
return self.worksheet.get_permissions(user)
845
468
class ExerciseSave(Storm):
846
"""A potential exercise solution submitted by a user for storage.
848
This is not an actual tested attempt at an exercise, it's just a save of
852
__storm_table__ = "exercise_save"
853
__storm_primary__ = "ws_ex_id", "user_id"
855
ws_ex_id = Int(name="ws_ex_id")
856
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
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)
858
482
user_id = Int(name="loginid")
859
483
user = Reference(user_id, User.id)
860
484
date = DateTime()
867
491
self.exercise.name, self.user.login, self.date.strftime("%c"))
869
493
class ExerciseAttempt(ExerciseSave):
870
"""An attempt at solving an exercise.
872
This is a special case of ExerciseSave, used when the user submits a
873
candidate solution. Like an ExerciseSave, it constitutes exercise solution
876
In addition, it contains information about the result of the submission:
878
- complete - True if this submission was successful, rendering this
879
exercise complete for this user in this worksheet.
880
- active - True if this submission is "active" (usually true).
881
Submissions may be de-activated by privileged users for
882
special reasons, and then they won't count (either as a
883
penalty or success), but will still be stored.
886
__storm_table__ = "exercise_attempt"
887
__storm_primary__ = "ws_ex_id", "user_id", "date"
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"
889
509
# The "text" field is the same but has a different name in the DB table
890
510
# for some reason.
891
511
text = Unicode(name="attempt")
892
512
complete = Bool()
895
def get_permissions(self, user):
896
return set(['view']) if user is self.user else set()
898
class TestSuite(Storm):
899
"""A container to group an exercise's test cases.
901
The test suite contains some information on how to test. The function to
902
test, variables to set and stdin data are stored here.
905
__storm_table__ = "test_suite"
906
__storm_primary__ = "exercise_id", "suiteid"
909
exercise_id = Unicode(name="exerciseid")
910
description = Unicode()
914
exercise = Reference(exercise_id, Exercise.id)
915
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
916
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
919
"""Delete this suite, without asking questions."""
920
for vaariable in self.variables:
922
for test_case in self.test_cases:
924
Store.of(self).remove(self)
926
class TestCase(Storm):
927
"""A container for actual tests (see TestCasePart), inside a test suite.
929
It is the lowest level shown to students on their pass/fail status."""
931
__storm_table__ = "test_case"
932
__storm_primary__ = "testid", "suiteid"
936
suite = Reference(suiteid, "TestSuite.suiteid")
939
test_default = Unicode()
942
parts = ReferenceSet(testid, "TestCasePart.testid")
944
__init__ = _kwarg_init
947
for part in self.parts:
949
Store.of(self).remove(self)
951
class TestSuiteVar(Storm):
952
"""A variable used by an exercise test suite.
954
This may represent a function argument or a normal variable.
957
__storm_table__ = "suite_variable"
958
__storm_primary__ = "varid"
963
var_value = Unicode()
967
suite = Reference(suiteid, "TestSuite.suiteid")
969
__init__ = _kwarg_init
972
Store.of(self).remove(self)
974
class TestCasePart(Storm):
975
"""An actual piece of code to test an exercise solution."""
977
__storm_table__ = "test_case_part"
978
__storm_primary__ = "partid"
983
part_type = Unicode()
984
test_type = Unicode()
988
test = Reference(testid, "TestCase.testid")
990
__init__ = _kwarg_init
993
Store.of(self).remove(self)
added
removed
ivle/database.py
