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
230
def get_permissions(self, user):
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
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)
285
374
def get_permissions(self, user):
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')) \
383
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
384
perms.add('enrol') # Can see enrolment screen at all
385
perms.add('enrol_student') # Can enrol students
386
perms.add('enrol_tutor') # Can enrol tutors
388
perms.add('enrol_lecturer') # Can enrol lecturers
391
def get_enrolment(self, user):
392
"""Find the user's enrolment in this offering."""
394
enrolment = self.enrolments.find(user=user).one()
400
def get_members_by_role(self, role):
401
return Store.of(self).find(User,
402
Enrolment.user_id == User.id,
403
Enrolment.offering_id == self.id,
404
Enrolment.role == role
405
).order_by(User.login)
409
return self.get_members_by_role(u'student')
411
def get_open_projects_for_user(self, user):
412
"""Find all projects currently open to submissions by a user."""
413
# XXX: Respect extensions.
414
return self.projects.find(Project.deadline > datetime.datetime.now())
293
416
class Enrolment(Storm):
417
"""An enrolment of a user in an offering.
419
This represents the roles of both staff and students.
294
422
__storm_table__ = "enrolment"
295
423
__storm_primary__ = "user_id", "offering_id"
335
469
return "<%s %d in %r>" % (type(self).__name__, self.id,
472
def get_permissions(self, user):
473
return self.offering.get_permissions(user)
475
def get_groups_for_user(self, user):
476
"""List all groups in this offering of which the user is a member."""
478
return Store.of(self).find(
480
ProjectGroupMembership.user_id == user.id,
481
ProjectGroupMembership.project_group_id == ProjectGroup.id,
482
ProjectGroup.project_set_id == self.id)
484
def get_submission_principal(self, user):
485
"""Get the principal on behalf of which the user can submit.
487
If this is a solo project set, the given user is returned. If
488
the user is a member of exactly one group, all the group is
489
returned. Otherwise, None is returned.
492
groups = self.get_groups_for_user(user)
493
if groups.count() == 1:
502
return self.max_students_per_group is not None
506
"""Get the entities (groups or users) assigned to submit this project.
508
This will be a Storm ResultSet.
510
#If its a solo project, return everyone in offering
512
return self.project_groups
514
return self.offering.students
516
class DeadlinePassed(Exception):
517
"""An exception indicating that a project cannot be submitted because the
518
deadline has passed."""
522
return "The project deadline has passed"
338
524
class Project(Storm):
525
"""A student project for which submissions can be made."""
339
527
__storm_table__ = "project"
341
529
id = Int(name="projectid", primary=True)
531
short_name = Unicode()
342
532
synopsis = Unicode()
344
534
project_set_id = Int(name="projectsetid")
345
535
project_set = Reference(project_set_id, ProjectSet.id)
346
536
deadline = DateTime()
538
assesseds = ReferenceSet(id, 'Assessed.project_id')
539
submissions = ReferenceSet(id,
540
'Assessed.project_id',
542
'ProjectSubmission.assessed_id')
348
544
__init__ = _kwarg_init
350
546
def __repr__(self):
351
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
547
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
352
548
self.project_set.offering)
550
def can_submit(self, principal, user):
551
return (self in principal.get_projects() and
552
not self.has_deadline_passed(user))
554
def submit(self, principal, path, revision, who):
555
"""Submit a Subversion path and revision to a project.
557
@param principal: The owner of the Subversion repository, and the
558
entity on behalf of whom the submission is being made
559
@param path: A path within that repository to submit.
560
@param revision: The revision of that path to submit.
561
@param who: The user who is actually making the submission.
564
if not self.can_submit(principal, who):
565
raise DeadlinePassed()
567
a = Assessed.get(Store.of(self), principal, self)
568
ps = ProjectSubmission()
570
ps.revision = revision
571
ps.date_submitted = datetime.datetime.now()
577
def get_permissions(self, user):
578
return self.project_set.offering.get_permissions(user)
581
def latest_submissions(self):
582
"""Return the latest submission for each Assessed."""
583
return Store.of(self).find(ProjectSubmission,
584
Assessed.project_id == self.id,
585
ProjectSubmission.assessed_id == Assessed.id,
586
ProjectSubmission.date_submitted == Select(
587
Max(ProjectSubmission.date_submitted),
588
ProjectSubmission.assessed_id == Assessed.id,
589
tables=ProjectSubmission
593
def has_deadline_passed(self, user):
594
"""Check whether the deadline has passed."""
595
# XXX: Need to respect extensions.
596
return self.deadline < datetime.datetime.now()
598
def get_submissions_for_principal(self, principal):
599
"""Fetch a ResultSet of all submissions by a particular principal."""
600
assessed = Assessed.get(Store.of(self), principal, self)
603
return assessed.submissions
354
607
class ProjectGroup(Storm):
608
"""A group of students working together on a project."""
355
610
__storm_table__ = "project_group"
357
612
id = Int(name="groupid", primary=True)
374
629
return "<%s %s in %r>" % (type(self).__name__, self.name,
375
630
self.project_set.offering)
633
def display_name(self):
634
"""Returns the "nice name" of the user or group."""
638
def short_name(self):
639
"""Returns the database "identifier" name of the user or group."""
642
def get_projects(self, offering=None, active_only=True):
643
'''Find projects that the group can submit.
645
This will include projects in the project set which owns this group,
646
unless the project set disallows groups (in which case none will be
649
@param active_only: Whether to only search active offerings.
650
@param offering: An optional offering to restrict the search to.
652
return Store.of(self).find(Project,
653
Project.project_set_id == ProjectSet.id,
654
ProjectSet.id == self.project_set.id,
655
ProjectSet.max_students_per_group != None,
656
ProjectSet.offering_id == Offering.id,
657
(offering is None) or (Offering.id == offering.id),
658
Semester.id == Offering.semester_id,
659
(not active_only) or (Semester.state == u'current'))
662
def get_permissions(self, user):
663
if user.admin or user in self.members:
664
return set(['submit_project'])
377
668
class ProjectGroupMembership(Storm):
669
"""A student's membership in a project group."""
378
671
__storm_table__ = "group_member"
379
672
__storm_primary__ = "user_id", "project_group_id"
389
682
return "<%s %r in %r>" % (type(self).__name__, self.user,
390
683
self.project_group)
685
class Assessed(Storm):
686
"""A composite of a user or group combined with a project.
688
Each project submission and extension refers to an Assessed. It is the
689
sole specifier of the repository and project.
692
__storm_table__ = "assessed"
694
id = Int(name="assessedid", primary=True)
695
user_id = Int(name="loginid")
696
user = Reference(user_id, User.id)
697
project_group_id = Int(name="groupid")
698
project_group = Reference(project_group_id, ProjectGroup.id)
700
project_id = Int(name="projectid")
701
project = Reference(project_id, Project.id)
703
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
704
submissions = ReferenceSet(
705
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
708
return "<%s %r in %r>" % (type(self).__name__,
709
self.user or self.project_group, self.project)
713
"""True if the Assessed is a group, False if it is a user."""
714
return self.project_group is not None
718
return self.project_group or self.user
721
def checkout_location(self):
722
"""Returns the location of the Subversion workspace for this piece of
723
assessment, relative to each group member's home directory."""
724
subjectname = self.project.project_set.offering.subject.short_name
726
checkout_dir_name = self.principal.short_name
728
checkout_dir_name = "mywork"
729
return subjectname + "/" + checkout_dir_name
732
def get(cls, store, principal, project):
733
"""Find or create an Assessed for the given user or group and project.
735
@param principal: The user or group.
736
@param project: The project.
739
if t not in (User, ProjectGroup):
740
raise AssertionError('principal must be User or ProjectGroup')
743
(t is User) or (cls.project_group_id == principal.id),
744
(t is ProjectGroup) or (cls.user_id == principal.id),
745
cls.project_id == project.id).one()
752
a.project_group = principal
759
class ProjectExtension(Storm):
760
"""An extension granted to a user or group on a particular project.
762
The user or group and project are specified by the Assessed.
765
__storm_table__ = "project_extension"
767
id = Int(name="extensionid", primary=True)
768
assessed_id = Int(name="assessedid")
769
assessed = Reference(assessed_id, Assessed.id)
770
deadline = DateTime()
771
approver_id = Int(name="approver")
772
approver = Reference(approver_id, User.id)
775
class ProjectSubmission(Storm):
776
"""A submission from a user or group repository to a particular project.
778
The content of a submission is a single path and revision inside a
779
repository. The repository is that owned by the submission's user and
780
group, while the path and revision are explicit.
782
The user or group and project are specified by the Assessed.
785
__storm_table__ = "project_submission"
787
id = Int(name="submissionid", primary=True)
788
assessed_id = Int(name="assessedid")
789
assessed = Reference(assessed_id, Assessed.id)
792
submitter_id = Int(name="submitter")
793
submitter = Reference(submitter_id, User.id)
794
date_submitted = DateTime()
796
def get_verify_url(self, user):
797
"""Get the URL for verifying this submission, within the account of
799
# If this is a solo project, then self.path will be prefixed with the
800
# subject name. Remove the first path segment.
801
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
802
if not self.assessed.is_group:
803
if '/' in submitpath:
804
submitpath = submitpath.split('/', 1)[1]
807
return "/files/%s/%s/%s?r=%d" % (user.login,
808
self.assessed.checkout_location, submitpath, self.revision)
392
810
# WORKSHEETS AND EXERCISES #
394
812
class Exercise(Storm):
813
"""An exercise for students to complete in a worksheet.
815
An exercise may be present in any number of worksheets.
395
818
__storm_table__ = "exercise"
396
819
id = Unicode(primary=True, name="identifier")
415
843
return "<%s %s>" % (type(self).__name__, self.name)
417
845
def get_permissions(self, user):
846
return self.global_permissions(user)
849
def global_permissions(user):
850
"""Gets the set of permissions this user has over *all* exercises.
851
This is used to determine who may view the exercises list, and create
419
855
if user is not None:
421
857
perms.add('edit')
422
858
perms.add('view')
859
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
862
elif u'tutor' in set((e.role for e in user.active_enrolments)):
868
def get_description(self):
869
"""Return the description interpreted as reStructuredText."""
870
return rst(self.description)
873
"""Deletes the exercise, providing it has no associated worksheets."""
874
if (self.worksheet_exercises.count() > 0):
875
raise IntegrityError()
876
for suite in self.test_suites:
878
Store.of(self).remove(self)
425
880
class Worksheet(Storm):
881
"""A worksheet with exercises for students to complete.
883
Worksheets are owned by offerings.
426
886
__storm_table__ = "worksheet"
428
888
id = Int(primary=True, name="worksheetid")
452
913
def __repr__(self):
453
914
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()
916
def remove_all_exercises(self):
917
"""Remove all exercises from this worksheet.
467
def remove_all_exercises(self, store):
469
Remove all exercises from this worksheet.
470
919
This does not delete the exercises themselves. It just removes them
471
920
from the worksheet.
922
store = Store.of(self)
923
for ws_ex in self.all_worksheet_exercises:
924
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
925
raise IntegrityError()
473
926
store.find(WorksheetExercise,
474
927
WorksheetExercise.worksheet == self).remove()
476
929
def get_permissions(self, user):
477
930
return self.offering.get_permissions(user)
933
"""Returns the xml of this worksheet, converts from rst if required."""
934
if self.format == u'rst':
935
ws_xml = rst(self.data)
941
"""Deletes the worksheet, provided it has no attempts on any exercises.
943
Returns True if delete succeeded, or False if this worksheet has
944
attempts attached."""
945
for ws_ex in self.all_worksheet_exercises:
946
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
947
raise IntegrityError()
949
self.remove_all_exercises()
950
Store.of(self).remove(self)
479
952
class WorksheetExercise(Storm):
953
"""A link between a worksheet and one of its exercises.
955
These may be marked optional, in which case the exercise does not count
956
for marking purposes. The sequence number is used to order the worksheet
480
960
__storm_table__ = "worksheet_exercise"
482
962
id = Int(primary=True, name="ws_ex_id")
484
964
worksheet_id = Int(name="worksheetid")
498
978
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
499
979
self.worksheet.identifier)
981
def get_permissions(self, user):
982
return self.worksheet.get_permissions(user)
501
985
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
986
"""A potential exercise solution submitted by a user for storage.
988
This is not an actual tested attempt at an exercise, it's just a save of
510
992
__storm_table__ = "exercise_save"
511
993
__storm_primary__ = "ws_ex_id", "user_id"
525
1007
self.exercise.name, self.user.login, self.date.strftime("%c"))
527
1009
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
1010
"""An attempt at solving an exercise.
1012
This is a special case of ExerciseSave, used when the user submits a
1013
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1016
In addition, it contains information about the result of the submission:
1018
- complete - True if this submission was successful, rendering this
1019
exercise complete for this user in this worksheet.
1020
- active - True if this submission is "active" (usually true).
1021
Submissions may be de-activated by privileged users for
1022
special reasons, and then they won't count (either as a
1023
penalty or success), but will still be stored.
540
1026
__storm_table__ = "exercise_attempt"
541
1027
__storm_primary__ = "ws_ex_id", "user_id", "date"
561
1052
function = Unicode()
562
1053
stdin = Unicode()
563
1054
exercise = Reference(exercise_id, Exercise.id)
564
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
565
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
1055
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1056
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1059
"""Delete this suite, without asking questions."""
1060
for variable in self.variables:
1062
for test_case in self.test_cases:
1064
Store.of(self).remove(self)
567
1066
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"""
1067
"""A container for actual tests (see TestCasePart), inside a test suite.
1069
It is the lowest level shown to students on their pass/fail status."""
571
1071
__storm_table__ = "test_case"
572
1072
__storm_primary__ = "testid", "suiteid"
576
1076
suite = Reference(suiteid, "TestSuite.suiteid")
577
1077
passmsg = Unicode()
578
1078
failmsg = Unicode()
579
test_default = Unicode()
1079
test_default = Unicode() # Currently unused - only used for file matching.
582
1082
parts = ReferenceSet(testid, "TestCasePart.testid")
584
1084
__init__ = _kwarg_init
1087
for part in self.parts:
1089
Store.of(self).remove(self)
586
1091
class TestSuiteVar(Storm):
587
"""A container for the arguments of a Test Suite"""
1092
"""A variable used by an exercise test suite.
1094
This may represent a function argument or a normal variable.
588
1097
__storm_table__ = "suite_variable"
589
1098
__storm_primary__ = "varid"
593
1102
var_name = Unicode()
594
1103
var_value = Unicode()
595
1104
var_type = Unicode()
598
1107
suite = Reference(suiteid, "TestSuite.suiteid")
600
1109
__init__ = _kwarg_init
1112
Store.of(self).remove(self)
602
1114
class TestCasePart(Storm):
603
"""A container for the test elements of a Test Case"""
1115
"""An actual piece of code to test an exercise solution."""
604
1117
__storm_table__ = "test_case_part"
605
1118
__storm_primary__ = "partid"
610
1123
part_type = Unicode()
611
1124
test_type = Unicode()
612
1125
data = Unicode()
613
1126
filename = Unicode()
615
1128
test = Reference(testid, "TestCase.testid")
617
1130
__init__ = _kwarg_init
1133
Store.of(self).remove(self)
added
removed
ivle/database.py
