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
35
36
__all__ = ['get_store',
37
38
'Subject', 'Semester', 'Offering', 'Enrolment',
38
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
39
41
'Exercise', 'Worksheet', 'WorksheetExercise',
40
42
'ExerciseSave', 'ExerciseAttempt',
41
43
'TestCase', 'TestSuite', 'TestSuiteVar'
48
50
% (self.__class__.__name__, k))
49
51
setattr(self, k, v)
51
def get_conn_string():
53
Returns the Storm connection string, generated from the conf file.
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
58
clusterstr += ivle.conf.db_user
59
if ivle.conf.db_password:
60
clusterstr += ':' + ivle.conf.db_password
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
63
host = ivle.conf.db_host or 'localhost'
64
port = ivle.conf.db_port or 5432
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
66
69
clusterstr += '%s:%d' % (host, port)
68
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
72
Open a database connection and transaction. Return a storm.store.Store
73
instance connected to the configured IVLE database.
75
return Store(create_database(get_conn_string()))
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)))
81
Represents an IVLE user.
83
"""An IVLE user account."""
83
84
__storm_table__ = "login"
85
86
id = Int(primary=True, name="loginid")
182
197
'''A sanely ordered list of all of the user's enrolments.'''
183
198
return self._get_enrolments(False)
200
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
203
This will include projects for offerings in which the user is
204
enrolled, as long as the project is not in a project set which has
205
groups (ie. if maximum number of group members is 0).
207
@param active_only: Whether to only search active offerings.
208
@param offering: An optional offering to restrict the search to.
210
return Store.of(self).find(Project,
211
Project.project_set_id == ProjectSet.id,
212
ProjectSet.max_students_per_group == None,
213
ProjectSet.offering_id == Offering.id,
214
(offering is None) or (Offering.id == offering.id),
215
Semester.id == Offering.semester_id,
216
(not active_only) or (Semester.state == u'current'),
217
Enrolment.offering_id == Offering.id,
218
Enrolment.user_id == self.id)
186
221
def hash_password(password):
187
return md5.md5(password).hexdigest()
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
190
226
def get_by_login(cls, store, login):
192
Get the User from the db associated with a given store and
227
"""Find a user in a store by login name."""
195
228
return store.find(cls, cls.login == unicode(login)).one()
197
def get_permissions(self, user):
230
def get_permissions(self, user, config):
231
"""Determine privileges held by a user over this object.
233
If the user requesting privileges is this user or an admin,
234
they may do everything. Otherwise they may do nothing.
198
236
if user and user.admin or user is self:
199
return set(['view', 'edit'])
237
return set(['view_public', 'view', 'edit', 'submit_project'])
239
return set(['view_public'])
203
241
# SUBJECTS AND ENROLMENTS #
205
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
206
246
__storm_table__ = "subject"
208
248
id = Int(primary=True, name="subjectid")
209
249
code = Unicode(name="subj_code")
210
250
name = Unicode(name="subj_name")
211
251
short_name = Unicode(name="subj_short_name")
214
253
offerings = ReferenceSet(id, 'Offering.subject_id')
226
270
perms.add('edit')
273
def active_offerings(self):
274
"""Find active offerings for this subject.
276
Return a sequence of currently active offerings for this subject
277
(offerings whose semester.state is "current"). There should be 0 or 1
278
elements in this sequence, but it's possible there are more.
280
return self.offerings.find(Offering.semester_id == Semester.id,
281
Semester.state == u'current')
283
def offering_for_semester(self, year, semester):
284
"""Get the offering for the given year/semester, or None.
286
@param year: A string representation of the year.
287
@param semester: A string representation of the semester.
289
return self.offerings.find(Offering.semester_id == Semester.id,
290
Semester.year == unicode(year),
291
Semester.semester == unicode(semester)).one()
229
293
class Semester(Storm):
294
"""A semester in which subjects can be run."""
230
296
__storm_table__ = "semester"
232
298
id = Int(primary=True, name="semesterid")
282
364
enrolment.active = True
283
365
enrolment.role = role
285
def get_permissions(self, user):
367
def unenrol(self, user):
368
'''Unenrol a user from this offering.'''
369
enrolment = Store.of(self).find(Enrolment,
370
Enrolment.user_id == user.id,
371
Enrolment.offering_id == self.id).one()
372
Store.of(enrolment).remove(enrolment)
374
def get_permissions(self, user, config):
287
376
if user is not None:
377
enrolment = self.get_enrolment(user)
378
if enrolment or user.admin:
380
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
382
perms.add('edit_worksheets')
383
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
384
perms.add('edit') # Can edit projects & details
385
perms.add('enrol') # Can see enrolment screen at all
386
perms.add('enrol_student') # Can enrol students
387
perms.add('enrol_tutor') # Can enrol tutors
389
perms.add('enrol_lecturer') # Can enrol lecturers
392
def get_enrolment(self, user):
393
"""Find the user's enrolment in this offering."""
395
enrolment = self.enrolments.find(user=user).one()
401
def get_members_by_role(self, role):
402
return Store.of(self).find(User,
403
Enrolment.user_id == User.id,
404
Enrolment.offering_id == self.id,
405
Enrolment.role == role
406
).order_by(User.login)
410
return self.get_members_by_role(u'student')
412
def get_open_projects_for_user(self, user):
413
"""Find all projects currently open to submissions by a user."""
414
# XXX: Respect extensions.
415
return self.projects.find(Project.deadline > datetime.datetime.now())
293
417
class Enrolment(Storm):
418
"""An enrolment of a user in an offering.
420
This represents the roles of both staff and students.
294
423
__storm_table__ = "enrolment"
295
424
__storm_primary__ = "user_id", "offering_id"
335
470
return "<%s %d in %r>" % (type(self).__name__, self.id,
473
def get_permissions(self, user, config):
474
return self.offering.get_permissions(user, config)
476
def get_groups_for_user(self, user):
477
"""List all groups in this offering of which the user is a member."""
479
return Store.of(self).find(
481
ProjectGroupMembership.user_id == user.id,
482
ProjectGroupMembership.project_group_id == ProjectGroup.id,
483
ProjectGroup.project_set_id == self.id)
485
def get_submission_principal(self, user):
486
"""Get the principal on behalf of which the user can submit.
488
If this is a solo project set, the given user is returned. If
489
the user is a member of exactly one group, all the group is
490
returned. Otherwise, None is returned.
493
groups = self.get_groups_for_user(user)
494
if groups.count() == 1:
503
return self.max_students_per_group is not None
507
"""Get the entities (groups or users) assigned to submit this project.
509
This will be a Storm ResultSet.
511
#If its a solo project, return everyone in offering
513
return self.project_groups
515
return self.offering.students
517
class DeadlinePassed(Exception):
518
"""An exception indicating that a project cannot be submitted because the
519
deadline has passed."""
523
return "The project deadline has passed"
338
525
class Project(Storm):
526
"""A student project for which submissions can be made."""
339
528
__storm_table__ = "project"
341
530
id = Int(name="projectid", primary=True)
532
short_name = Unicode()
342
533
synopsis = Unicode()
344
535
project_set_id = Int(name="projectsetid")
345
536
project_set = Reference(project_set_id, ProjectSet.id)
346
537
deadline = DateTime()
539
assesseds = ReferenceSet(id, 'Assessed.project_id')
540
submissions = ReferenceSet(id,
541
'Assessed.project_id',
543
'ProjectSubmission.assessed_id')
348
545
__init__ = _kwarg_init
350
547
def __repr__(self):
351
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
548
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
352
549
self.project_set.offering)
551
def can_submit(self, principal, user):
552
return (self in principal.get_projects() and
553
not self.has_deadline_passed(user))
555
def submit(self, principal, path, revision, who):
556
"""Submit a Subversion path and revision to a project.
558
@param principal: The owner of the Subversion repository, and the
559
entity on behalf of whom the submission is being made
560
@param path: A path within that repository to submit.
561
@param revision: The revision of that path to submit.
562
@param who: The user who is actually making the submission.
565
if not self.can_submit(principal, who):
566
raise DeadlinePassed()
568
a = Assessed.get(Store.of(self), principal, self)
569
ps = ProjectSubmission()
571
ps.revision = revision
572
ps.date_submitted = datetime.datetime.now()
578
def get_permissions(self, user, config):
579
return self.project_set.offering.get_permissions(user, config)
582
def latest_submissions(self):
583
"""Return the latest submission for each Assessed."""
584
return Store.of(self).find(ProjectSubmission,
585
Assessed.project_id == self.id,
586
ProjectSubmission.assessed_id == Assessed.id,
587
ProjectSubmission.date_submitted == Select(
588
Max(ProjectSubmission.date_submitted),
589
ProjectSubmission.assessed_id == Assessed.id,
590
tables=ProjectSubmission
594
def has_deadline_passed(self, user):
595
"""Check whether the deadline has passed."""
596
# XXX: Need to respect extensions.
597
return self.deadline < datetime.datetime.now()
599
def get_submissions_for_principal(self, principal):
600
"""Fetch a ResultSet of all submissions by a particular principal."""
601
assessed = Assessed.get(Store.of(self), principal, self)
604
return assessed.submissions
354
608
class ProjectGroup(Storm):
609
"""A group of students working together on a project."""
355
611
__storm_table__ = "project_group"
357
613
id = Int(name="groupid", primary=True)
374
630
return "<%s %s in %r>" % (type(self).__name__, self.name,
375
631
self.project_set.offering)
634
def display_name(self):
635
"""Returns the "nice name" of the user or group."""
639
def short_name(self):
640
"""Returns the database "identifier" name of the user or group."""
643
def get_projects(self, offering=None, active_only=True):
644
'''Find projects that the group can submit.
646
This will include projects in the project set which owns this group,
647
unless the project set disallows groups (in which case none will be
650
@param active_only: Whether to only search active offerings.
651
@param offering: An optional offering to restrict the search to.
653
return Store.of(self).find(Project,
654
Project.project_set_id == ProjectSet.id,
655
ProjectSet.id == self.project_set.id,
656
ProjectSet.max_students_per_group != None,
657
ProjectSet.offering_id == Offering.id,
658
(offering is None) or (Offering.id == offering.id),
659
Semester.id == Offering.semester_id,
660
(not active_only) or (Semester.state == u'current'))
663
def get_permissions(self, user, config):
664
if user.admin or user in self.members:
665
return set(['submit_project'])
377
669
class ProjectGroupMembership(Storm):
670
"""A student's membership in a project group."""
378
672
__storm_table__ = "group_member"
379
673
__storm_primary__ = "user_id", "project_group_id"
389
683
return "<%s %r in %r>" % (type(self).__name__, self.user,
390
684
self.project_group)
686
class Assessed(Storm):
687
"""A composite of a user or group combined with a project.
689
Each project submission and extension refers to an Assessed. It is the
690
sole specifier of the repository and project.
693
__storm_table__ = "assessed"
695
id = Int(name="assessedid", primary=True)
696
user_id = Int(name="loginid")
697
user = Reference(user_id, User.id)
698
project_group_id = Int(name="groupid")
699
project_group = Reference(project_group_id, ProjectGroup.id)
701
project_id = Int(name="projectid")
702
project = Reference(project_id, Project.id)
704
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
705
submissions = ReferenceSet(
706
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
709
return "<%s %r in %r>" % (type(self).__name__,
710
self.user or self.project_group, self.project)
714
"""True if the Assessed is a group, False if it is a user."""
715
return self.project_group is not None
719
return self.project_group or self.user
722
def checkout_location(self):
723
"""Returns the location of the Subversion workspace for this piece of
724
assessment, relative to each group member's home directory."""
725
subjectname = self.project.project_set.offering.subject.short_name
727
checkout_dir_name = self.principal.short_name
729
checkout_dir_name = "mywork"
730
return subjectname + "/" + checkout_dir_name
733
def get(cls, store, principal, project):
734
"""Find or create an Assessed for the given user or group and project.
736
@param principal: The user or group.
737
@param project: The project.
740
if t not in (User, ProjectGroup):
741
raise AssertionError('principal must be User or ProjectGroup')
744
(t is User) or (cls.project_group_id == principal.id),
745
(t is ProjectGroup) or (cls.user_id == principal.id),
746
cls.project_id == project.id).one()
753
a.project_group = principal
760
class ProjectExtension(Storm):
761
"""An extension granted to a user or group on a particular project.
763
The user or group and project are specified by the Assessed.
766
__storm_table__ = "project_extension"
768
id = Int(name="extensionid", primary=True)
769
assessed_id = Int(name="assessedid")
770
assessed = Reference(assessed_id, Assessed.id)
771
deadline = DateTime()
772
approver_id = Int(name="approver")
773
approver = Reference(approver_id, User.id)
776
class ProjectSubmission(Storm):
777
"""A submission from a user or group repository to a particular project.
779
The content of a submission is a single path and revision inside a
780
repository. The repository is that owned by the submission's user and
781
group, while the path and revision are explicit.
783
The user or group and project are specified by the Assessed.
786
__storm_table__ = "project_submission"
788
id = Int(name="submissionid", primary=True)
789
assessed_id = Int(name="assessedid")
790
assessed = Reference(assessed_id, Assessed.id)
793
submitter_id = Int(name="submitter")
794
submitter = Reference(submitter_id, User.id)
795
date_submitted = DateTime()
797
def get_verify_url(self, user):
798
"""Get the URL for verifying this submission, within the account of
800
# If this is a solo project, then self.path will be prefixed with the
801
# subject name. Remove the first path segment.
802
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
803
if not self.assessed.is_group:
804
if '/' in submitpath:
805
submitpath = submitpath.split('/', 1)[1]
808
return "/files/%s/%s/%s?r=%d" % (user.login,
809
self.assessed.checkout_location, submitpath, self.revision)
392
811
# WORKSHEETS AND EXERCISES #
394
813
class Exercise(Storm):
814
"""An exercise for students to complete in a worksheet.
816
An exercise may be present in any number of worksheets.
395
819
__storm_table__ = "exercise"
396
820
id = Unicode(primary=True, name="identifier")
401
825
include = Unicode()
828
worksheet_exercises = ReferenceSet(id,
829
'WorksheetExercise.exercise_id')
404
831
worksheets = ReferenceSet(id,
405
832
'WorksheetExercise.exercise_id',
406
833
'WorksheetExercise.worksheet_id',
410
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
837
test_suites = ReferenceSet(id,
838
'TestSuite.exercise_id',
412
841
__init__ = _kwarg_init
414
843
def __repr__(self):
415
844
return "<%s %s>" % (type(self).__name__, self.name)
417
def get_permissions(self, user):
846
def get_permissions(self, user, config):
847
return self.global_permissions(user, config)
850
def global_permissions(user, config):
851
"""Gets the set of permissions this user has over *all* exercises.
852
This is used to determine who may view the exercises list, and create
419
856
if user is not None:
421
858
perms.add('edit')
422
859
perms.add('view')
860
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
863
elif u'tutor' in set((e.role for e in user.active_enrolments)):
869
def get_description(self):
870
"""Return the description interpreted as reStructuredText."""
871
return rst(self.description)
874
"""Deletes the exercise, providing it has no associated worksheets."""
875
if (self.worksheet_exercises.count() > 0):
876
raise IntegrityError()
877
for suite in self.test_suites:
879
Store.of(self).remove(self)
425
881
class Worksheet(Storm):
882
"""A worksheet with exercises for students to complete.
884
Worksheets are owned by offerings.
426
887
__storm_table__ = "worksheet"
428
889
id = Int(primary=True, name="worksheetid")
452
914
def __repr__(self):
453
915
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()
917
def remove_all_exercises(self):
918
"""Remove all exercises from this worksheet.
467
def remove_all_exercises(self, store):
469
Remove all exercises from this worksheet.
470
920
This does not delete the exercises themselves. It just removes them
471
921
from the worksheet.
923
store = Store.of(self)
924
for ws_ex in self.all_worksheet_exercises:
925
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
926
raise IntegrityError()
473
927
store.find(WorksheetExercise,
474
928
WorksheetExercise.worksheet == self).remove()
476
def get_permissions(self, user):
477
return self.offering.get_permissions(user)
930
def get_permissions(self, user, config):
931
# Almost the same permissions as for the offering itself
932
perms = self.offering.get_permissions(user, config)
933
# However, "edit" permission is derived from the "edit_worksheets"
934
# permission of the offering
935
if 'edit_worksheets' in perms:
938
perms.discard('edit')
942
"""Returns the xml of this worksheet, converts from rst if required."""
943
if self.format == u'rst':
944
ws_xml = rst(self.data)
950
"""Deletes the worksheet, provided it has no attempts on any exercises.
952
Returns True if delete succeeded, or False if this worksheet has
953
attempts attached."""
954
for ws_ex in self.all_worksheet_exercises:
955
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
956
raise IntegrityError()
958
self.remove_all_exercises()
959
Store.of(self).remove(self)
479
961
class WorksheetExercise(Storm):
962
"""A link between a worksheet and one of its exercises.
964
These may be marked optional, in which case the exercise does not count
965
for marking purposes. The sequence number is used to order the worksheet
480
969
__storm_table__ = "worksheet_exercise"
482
971
id = Int(primary=True, name="ws_ex_id")
484
973
worksheet_id = Int(name="worksheetid")
498
987
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
499
988
self.worksheet.identifier)
990
def get_permissions(self, user, config):
991
return self.worksheet.get_permissions(user, config)
501
994
class ExerciseSave(Storm):
503
Represents a potential solution to an exercise that a user has submitted
504
to the server for storage.
505
A basic ExerciseSave is just the current saved text for this exercise for
506
this user (doesn't count towards their attempts).
507
ExerciseSave may be extended with additional semantics (such as
995
"""A potential exercise solution submitted by a user for storage.
997
This is not an actual tested attempt at an exercise, it's just a save of
510
1001
__storm_table__ = "exercise_save"
511
1002
__storm_primary__ = "ws_ex_id", "user_id"
525
1016
self.exercise.name, self.user.login, self.date.strftime("%c"))
527
1018
class ExerciseAttempt(ExerciseSave):
529
An ExerciseAttempt is a special case of an ExerciseSave. Like an
530
ExerciseSave, it constitutes exercise solution data that the user has
531
submitted to the server for storage.
532
In addition, it contains additional information about the submission.
533
complete - True if this submission was successful, rendering this exercise
534
complete for this user.
535
active - True if this submission is "active" (usually true). Submissions
536
may be de-activated by privileged users for special reasons, and then
537
they won't count (either as a penalty or success), but will still be
1019
"""An attempt at solving an exercise.
1021
This is a special case of ExerciseSave, used when the user submits a
1022
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1025
In addition, it contains information about the result of the submission:
1027
- complete - True if this submission was successful, rendering this
1028
exercise complete for this user in this worksheet.
1029
- active - True if this submission is "active" (usually true).
1030
Submissions may be de-activated by privileged users for
1031
special reasons, and then they won't count (either as a
1032
penalty or success), but will still be stored.
540
1035
__storm_table__ = "exercise_attempt"
541
1036
__storm_primary__ = "ws_ex_id", "user_id", "date"
561
1061
function = Unicode()
562
1062
stdin = Unicode()
563
1063
exercise = Reference(exercise_id, Exercise.id)
564
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
565
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1064
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1065
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1068
"""Delete this suite, without asking questions."""
1069
for variable in self.variables:
1071
for test_case in self.test_cases:
1073
Store.of(self).remove(self)
567
1075
class TestCase(Storm):
568
"""A TestCase is a member of a TestSuite.
570
It contains the data necessary to check if an exercise is correct"""
1076
"""A container for actual tests (see TestCasePart), inside a test suite.
1078
It is the lowest level shown to students on their pass/fail status."""
571
1080
__storm_table__ = "test_case"
572
1081
__storm_primary__ = "testid", "suiteid"
576
1085
suite = Reference(suiteid, "TestSuite.suiteid")
577
1086
passmsg = Unicode()
578
1087
failmsg = Unicode()
579
test_default = Unicode()
1088
test_default = Unicode() # Currently unused - only used for file matching.
582
1091
parts = ReferenceSet(testid, "TestCasePart.testid")
584
1093
__init__ = _kwarg_init
1096
for part in self.parts:
1098
Store.of(self).remove(self)
586
1100
class TestSuiteVar(Storm):
587
"""A container for the arguments of a Test Suite"""
1101
"""A variable used by an exercise test suite.
1103
This may represent a function argument or a normal variable.
588
1106
__storm_table__ = "suite_variable"
589
1107
__storm_primary__ = "varid"
593
1111
var_name = Unicode()
594
1112
var_value = Unicode()
595
1113
var_type = Unicode()
598
1116
suite = Reference(suiteid, "TestSuite.suiteid")
600
1118
__init__ = _kwarg_init
1121
Store.of(self).remove(self)
602
1123
class TestCasePart(Storm):
603
"""A container for the test elements of a Test Case"""
1124
"""An actual piece of code to test an exercise solution."""
604
1126
__storm_table__ = "test_case_part"
605
1127
__storm_primary__ = "partid"
610
1132
part_type = Unicode()
611
1133
test_type = Unicode()
612
1134
data = Unicode()
613
1135
filename = Unicode()
615
1137
test = Reference(testid, "TestCase.testid")
617
1139
__init__ = _kwarg_init
1142
Store.of(self).remove(self)
added
removed
ivle/database.py
