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', '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(config):
53
"""Create a Storm connection string to the IVLE database
55
@param config: The IVLE configuration.
52
def get_conn_string():
54
Returns the Storm connection string, generated from the conf file.
59
if config['database']['username']:
60
clusterstr += config['database']['username']
61
if config['database']['password']:
62
clusterstr += ':' + config['database']['password']
59
clusterstr += ivle.conf.db_user
60
if ivle.conf.db_password:
61
clusterstr += ':' + ivle.conf.db_password
65
host = config['database']['host'] or 'localhost'
66
port = config['database']['port'] or 5432
64
host = ivle.conf.db_host or 'localhost'
65
port = ivle.conf.db_port or 5432
68
67
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)))
69
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
73
Open a database connection and transaction. Return a storm.store.Store
74
instance connected to the configured IVLE database.
76
return Store(create_database(get_conn_string()))
82
"""An IVLE user account."""
82
Represents an IVLE user.
83
84
__storm_table__ = "login"
85
86
id = Int(primary=True, name="loginid")
87
88
passhash = Unicode()
92
93
pass_exp = DateTime()
190
199
'''A sanely ordered list of all of the user's enrolments.'''
191
200
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
203
def hash_password(password):
215
"""Hash a password with MD5."""
216
return hashlib.md5(password).hexdigest()
204
return md5.md5(password).hexdigest()
219
207
def get_by_login(cls, store, login):
220
"""Find a user in a store by login name."""
209
Get the User from the db associated with a given store and
221
212
return store.find(cls, cls.login == unicode(login)).one()
223
214
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'])
215
if user and user.rolenm == 'admin' or user is self:
216
return set(['view', 'edit'])
234
220
# SUBJECTS AND ENROLMENTS #
236
222
class Subject(Storm):
237
"""A subject (or course) which is run in some semesters."""
239
223
__storm_table__ = "subject"
241
225
id = Int(primary=True, name="subjectid")
252
236
return "<%s '%s'>" % (type(self).__name__, self.short_name)
254
238
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.
261
240
if user is not None:
262
241
perms.add('view')
242
if user.rolenm == 'admin':
264
243
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()
287
246
class Semester(Storm):
288
"""A semester in which subjects can be run."""
290
247
__storm_table__ = "semester"
292
249
id = Int(primary=True, name="semesterid")
294
251
semester = Unicode()
297
254
offerings = ReferenceSet(id, 'Offering.semester_id')
298
enrolments = ReferenceSet(id,
299
'Offering.semester_id',
301
'Enrolment.offering_id')
303
256
__init__ = _kwarg_init
335
286
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)
289
def enrol(self, user):
290
'''Enrol a user in this offering.'''
291
# We'll get a horrible database constraint violation error if we try
292
# to add a second enrolment.
293
if Store.of(self).find(Enrolment,
294
Enrolment.user_id == user.id,
295
Enrolment.offering_id == self.id).count() == 1:
296
raise AlreadyEnrolledError()
298
e = Enrolment(user=user, offering=self, active=True)
299
self.enrolments.add(e)
362
301
def get_permissions(self, user):
364
303
if user is not None:
365
enrolment = self.get_enrolment(user)
366
if enrolment or user.admin:
368
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
305
if user.rolenm in ('admin', 'lecturer'):
370
306
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()
382
309
class Enrolment(Storm):
383
"""An enrolment of a user in an offering.
385
This represents the roles of both staff and students.
388
310
__storm_table__ = "enrolment"
389
311
__storm_primary__ = "user_id", "offering_id"
435
353
return "<%s %d in %r>" % (type(self).__name__, self.id,
438
def get_permissions(self, user):
439
return self.offering.get_permissions(user)
441
356
class Project(Storm):
442
"""A student project for which submissions can be made."""
444
357
__storm_table__ = "project"
446
359
id = Int(name="projectid", primary=True)
448
short_name = Unicode()
449
360
synopsis = Unicode()
451
362
project_set_id = Int(name="projectsetid")
452
363
project_set = Reference(project_set_id, ProjectSet.id)
453
364
deadline = DateTime()
455
assesseds = ReferenceSet(id, 'Assessed.project_id')
456
submissions = ReferenceSet(id,
457
'Assessed.project_id',
459
'ProjectSubmission.assessed_id')
461
366
__init__ = _kwarg_init
463
368
def __repr__(self):
464
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
369
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
465
370
self.project_set.offering)
467
def can_submit(self, principal):
468
return (self in principal.get_projects() and
469
self.deadline > datetime.datetime.now())
471
def submit(self, principal, path, revision, who):
472
"""Submit a Subversion path and revision to a project.
474
@param principal: The owner of the Subversion repository, and the
475
entity on behalf of whom the submission is being made
476
@param path: A path within that repository to submit.
477
@param revision: The revision of that path to submit.
478
@param who: The user who is actually making the submission.
481
if not self.can_submit(principal):
482
raise Exception('cannot submit')
484
a = Assessed.get(Store.of(self), principal, self)
485
ps = ProjectSubmission()
487
ps.revision = revision
488
ps.date_submitted = datetime.datetime.now()
494
def get_permissions(self, user):
495
return self.project_set.offering.get_permissions(user)
498
372
class ProjectGroup(Storm):
499
"""A group of students working together on a project."""
501
373
__storm_table__ = "project_group"
503
375
id = Int(name="groupid", primary=True)
520
392
return "<%s %s in %r>" % (type(self).__name__, self.name,
521
393
self.project_set.offering)
524
def display_name(self):
525
return '%s (%s)' % (self.nick, self.name)
527
def get_projects(self, offering=None, active_only=True):
528
'''Find projects that the group can submit.
530
This will include projects in the project set which owns this group,
531
unless the project set disallows groups (in which case none will be
534
@param active_only: Whether to only search active offerings.
535
@param offering: An optional offering to restrict the search to.
537
return Store.of(self).find(Project,
538
Project.project_set_id == ProjectSet.id,
539
ProjectSet.id == self.project_set.id,
540
ProjectSet.max_students_per_group != None,
541
ProjectSet.offering_id == Offering.id,
542
(offering is None) or (Offering.id == offering.id),
543
Semester.id == Offering.semester_id,
544
(not active_only) or (Semester.state == u'current'))
547
def get_permissions(self, user):
548
if user.admin or user in self.members:
549
return set(['submit_project'])
553
395
class ProjectGroupMembership(Storm):
554
"""A student's membership in a project group."""
556
396
__storm_table__ = "group_member"
557
397
__storm_primary__ = "user_id", "project_group_id"
567
407
return "<%s %r in %r>" % (type(self).__name__, self.user,
568
408
self.project_group)
570
class Assessed(Storm):
571
"""A composite of a user or group combined with a project.
573
Each project submission and extension refers to an Assessed. It is the
574
sole specifier of the repository and project.
577
__storm_table__ = "assessed"
579
id = Int(name="assessedid", primary=True)
580
user_id = Int(name="loginid")
581
user = Reference(user_id, User.id)
582
project_group_id = Int(name="groupid")
583
project_group = Reference(project_group_id, ProjectGroup.id)
585
project_id = Int(name="projectid")
586
project = Reference(project_id, Project.id)
588
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
589
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
592
return "<%s %r in %r>" % (type(self).__name__,
593
self.user or self.project_group, self.project)
597
return self.project_group or self.user
600
def get(cls, store, principal, project):
601
"""Find or create an Assessed for the given user or group and project.
603
@param principal: The user or group.
604
@param project: The project.
607
if t not in (User, ProjectGroup):
608
raise AssertionError('principal must be User or ProjectGroup')
611
(t is User) or (cls.project_group_id == principal.id),
612
(t is ProjectGroup) or (cls.user_id == principal.id),
613
Project.id == project.id).one()
620
a.project_group = principal
627
class ProjectExtension(Storm):
628
"""An extension granted to a user or group on a particular project.
630
The user or group and project are specified by the Assessed.
633
__storm_table__ = "project_extension"
635
id = Int(name="extensionid", primary=True)
636
assessed_id = Int(name="assessedid")
637
assessed = Reference(assessed_id, Assessed.id)
638
deadline = DateTime()
639
approver_id = Int(name="approver")
640
approver = Reference(approver_id, User.id)
643
class ProjectSubmission(Storm):
644
"""A submission from a user or group repository to a particular project.
646
The content of a submission is a single path and revision inside a
647
repository. The repository is that owned by the submission's user and
648
group, while the path and revision are explicit.
650
The user or group and project are specified by the Assessed.
653
__storm_table__ = "project_submission"
655
id = Int(name="submissionid", primary=True)
656
assessed_id = Int(name="assessedid")
657
assessed = Reference(assessed_id, Assessed.id)
660
submitter_id = Int(name="submitter")
661
submitter = Reference(submitter_id, User.id)
662
date_submitted = DateTime()
665
410
# WORKSHEETS AND EXERCISES #
667
412
class Exercise(Storm):
668
"""An exercise for students to complete in a worksheet.
670
An exercise may be present in any number of worksheets.
673
413
__storm_table__ = "exercise"
674
414
id = Unicode(primary=True, name="identifier")
700
435
def get_permissions(self, user):
703
437
if user is not None:
707
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
710
elif u'tutor' in set((e.role for e in user.active_enrolments)):
438
if user.rolenm in ('admin', 'lecturer'):
716
def get_description(self):
717
"""Return the description interpreted as reStructuredText."""
718
return rst(self.description)
721
"""Deletes the exercise, providing it has no associated worksheets."""
722
if (self.worksheet_exercises.count() > 0):
723
raise IntegrityError()
724
for suite in self.test_suites:
726
Store.of(self).remove(self)
728
443
class Worksheet(Storm):
729
"""A worksheet with exercises for students to complete.
731
Worksheets are owned by offerings.
734
444
__storm_table__ = "worksheet"
736
446
id = Int(primary=True, name="worksheetid")
745
455
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
746
456
offering = Reference(offering_id, 'Offering.id')
748
all_worksheet_exercises = ReferenceSet(id,
458
# Use worksheet_exercises to get access to the WorksheetExercise objects
459
# binding worksheets to exercises. This is required to access the
461
worksheet_exercises = ReferenceSet(id,
749
462
'WorksheetExercise.worksheet_id')
751
# Use worksheet_exercises to get access to the *active* WorksheetExercise
752
# objects binding worksheets to exercises. This is required to access the
756
def worksheet_exercises(self):
757
return self.all_worksheet_exercises.find(active=True)
759
465
__init__ = _kwarg_init
761
467
def __repr__(self):
762
468
return "<%s %s>" % (type(self).__name__, self.name)
764
def remove_all_exercises(self):
765
"""Remove all exercises from this worksheet.
470
# XXX Refactor this - make it an instance method of Subject rather than a
471
# class method of Worksheet. Can't do that now because Subject isn't
472
# linked referentially to the Worksheet.
474
def get_by_name(cls, store, subjectname, worksheetname):
476
Get the Worksheet from the db associated with a given store, subject
477
name and worksheet name.
479
return store.find(cls, cls.subject == unicode(subjectname),
480
cls.name == unicode(worksheetname)).one()
482
def remove_all_exercises(self, store):
484
Remove all exercises from this worksheet.
767
485
This does not delete the exercises themselves. It just removes them
768
486
from the worksheet.
770
store = Store.of(self)
771
for ws_ex in self.all_worksheet_exercises:
772
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
773
raise IntegrityError()
774
488
store.find(WorksheetExercise,
775
489
WorksheetExercise.worksheet == self).remove()
777
491
def get_permissions(self, user):
778
492
return self.offering.get_permissions(user)
781
"""Returns the xml of this worksheet, converts from rst if required."""
782
if self.format == u'rst':
783
ws_xml = rst(self.data)
789
"""Deletes the worksheet, provided it has no attempts on any exercises.
791
Returns True if delete succeeded, or False if this worksheet has
792
attempts attached."""
793
for ws_ex in self.all_worksheet_exercises:
794
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
795
raise IntegrityError()
797
self.remove_all_exercises()
798
Store.of(self).remove(self)
800
494
class WorksheetExercise(Storm):
801
"""A link between a worksheet and one of its exercises.
803
These may be marked optional, in which case the exercise does not count
804
for marking purposes. The sequence number is used to order the worksheet
808
495
__storm_table__ = "worksheet_exercise"
810
497
id = Int(primary=True, name="ws_ex_id")
812
499
worksheet_id = Int(name="worksheetid")
826
513
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
827
514
self.worksheet.identifier)
829
def get_permissions(self, user):
830
return self.worksheet.get_permissions(user)
833
516
class ExerciseSave(Storm):
834
"""A potential exercise solution submitted by a user for storage.
836
This is not an actual tested attempt at an exercise, it's just a save of
518
Represents a potential solution to an exercise that a user has submitted
519
to the server for storage.
520
A basic ExerciseSave is just the current saved text for this exercise for
521
this user (doesn't count towards their attempts).
522
ExerciseSave may be extended with additional semantics (such as
840
525
__storm_table__ = "exercise_save"
841
526
__storm_primary__ = "ws_ex_id", "user_id"
855
540
self.exercise.name, self.user.login, self.date.strftime("%c"))
857
542
class ExerciseAttempt(ExerciseSave):
858
"""An attempt at solving an exercise.
860
This is a special case of ExerciseSave, used when the user submits a
861
candidate solution. Like an ExerciseSave, it constitutes exercise solution
864
In addition, it contains information about the result of the submission:
866
- complete - True if this submission was successful, rendering this
867
exercise complete for this user in this worksheet.
868
- active - True if this submission is "active" (usually true).
869
Submissions may be de-activated by privileged users for
870
special reasons, and then they won't count (either as a
871
penalty or success), but will still be stored.
544
An ExerciseAttempt is a special case of an ExerciseSave. Like an
545
ExerciseSave, it constitutes exercise solution data that the user has
546
submitted to the server for storage.
547
In addition, it contains additional information about the submission.
548
complete - True if this submission was successful, rendering this exercise
549
complete for this user.
550
active - True if this submission is "active" (usually true). Submissions
551
may be de-activated by privileged users for special reasons, and then
552
they won't count (either as a penalty or success), but will still be
874
555
__storm_table__ = "exercise_attempt"
875
556
__storm_primary__ = "ws_ex_id", "user_id", "date"
879
560
text = Unicode(name="attempt")
880
561
complete = Bool()
883
564
def get_permissions(self, user):
884
565
return set(['view']) if user is self.user else set()
886
567
class TestSuite(Storm):
887
"""A container to group an exercise's test cases.
889
The test suite contains some information on how to test. The function to
890
test, variables to set and stdin data are stored here.
568
"""A Testsuite acts as a container for the test cases of an exercise."""
893
569
__storm_table__ = "test_suite"
894
570
__storm_primary__ = "exercise_id", "suiteid"
897
573
exercise_id = Unicode(name="exerciseid")
898
574
description = Unicode()
900
576
function = Unicode()
901
577
stdin = Unicode()
902
578
exercise = Reference(exercise_id, Exercise.id)
903
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
904
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
907
"""Delete this suite, without asking questions."""
908
for vaariable in self.variables:
910
for test_case in self.test_cases:
912
Store.of(self).remove(self)
579
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
580
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
914
582
class TestCase(Storm):
915
"""A container for actual tests (see TestCasePart), inside a test suite.
917
It is the lowest level shown to students on their pass/fail status."""
583
"""A TestCase is a member of a TestSuite.
585
It contains the data necessary to check if an exercise is correct"""
919
586
__storm_table__ = "test_case"
920
587
__storm_primary__ = "testid", "suiteid"
924
591
suite = Reference(suiteid, "TestSuite.suiteid")
926
593
failmsg = Unicode()
927
594
test_default = Unicode()
930
597
parts = ReferenceSet(testid, "TestCasePart.testid")
932
599
__init__ = _kwarg_init
935
for part in self.parts:
937
Store.of(self).remove(self)
939
601
class TestSuiteVar(Storm):
940
"""A variable used by an exercise test suite.
942
This may represent a function argument or a normal variable.
602
"""A container for the arguments of a Test Suite"""
945
603
__storm_table__ = "suite_variable"
946
604
__storm_primary__ = "varid"
950
608
var_name = Unicode()
951
609
var_value = Unicode()
952
610
var_type = Unicode()
955
613
suite = Reference(suiteid, "TestSuite.suiteid")
957
615
__init__ = _kwarg_init
960
Store.of(self).remove(self)
962
617
class TestCasePart(Storm):
963
"""An actual piece of code to test an exercise solution."""
618
"""A container for the test elements of a Test Case"""
965
619
__storm_table__ = "test_case_part"
966
620
__storm_primary__ = "partid"
971
625
part_type = Unicode()
972
626
test_type = Unicode()
974
628
filename = Unicode()
976
630
test = Reference(testid, "TestCase.testid")
978
632
__init__ = _kwarg_init
981
Store.of(self).remove(self)
added
removed
ivle/database.py
