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
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
31
Reference, ReferenceSet, Bool, Storm, Desc
32
from storm.expr import Select, Max
32
33
from storm.exceptions import NotOneError, IntegrityError
35
35
from ivle.worksheet.rst import rst
37
37
__all__ = ['get_store',
39
39
'Subject', 'Semester', 'Offering', 'Enrolment',
40
40
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
41
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
42
'Exercise', 'Worksheet', 'WorksheetExercise',
42
43
'ExerciseSave', 'ExerciseAttempt',
43
44
'TestCase', 'TestSuite', 'TestSuiteVar'
50
51
% (self.__class__.__name__, k))
51
52
setattr(self, k, v)
53
def get_conn_string():
55
Returns the Storm connection string, generated from the conf file.
54
def get_conn_string(config):
55
"""Create a Storm connection string to the IVLE database
57
@param config: The IVLE configuration.
60
clusterstr += ivle.conf.db_user
61
if ivle.conf.db_password:
62
clusterstr += ':' + ivle.conf.db_password
61
if config['database']['username']:
62
clusterstr += config['database']['username']
63
if config['database']['password']:
64
clusterstr += ':' + config['database']['password']
65
host = ivle.conf.db_host or 'localhost'
66
port = ivle.conf.db_port or 5432
67
host = config['database']['host'] or 'localhost'
68
port = config['database']['port'] or 5432
68
70
clusterstr += '%s:%d' % (host, port)
70
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
74
Open a database connection and transaction. Return a storm.store.Store
75
instance connected to the configured IVLE database.
77
return Store(create_database(get_conn_string()))
72
return "postgres://%s/%s" % (clusterstr, config['database']['name'])
74
def get_store(config):
75
"""Create a Storm store connected to the IVLE database.
77
@param config: The IVLE configuration.
79
return Store(create_database(get_conn_string(config)))
83
Represents an IVLE user.
84
"""An IVLE user account."""
85
85
__storm_table__ = "login"
87
87
id = Int(primary=True, name="loginid")
184
198
'''A sanely ordered list of all of the user's enrolments.'''
185
199
return self._get_enrolments(False)
201
def get_projects(self, offering=None, active_only=True):
202
"""Find projects that the user can submit.
204
This will include projects for offerings in which the user is
205
enrolled, as long as the project is not in a project set which has
206
groups (ie. if maximum number of group members is 0).
208
@param active_only: Whether to only search active offerings.
209
@param offering: An optional offering to restrict the search to.
211
return Store.of(self).find(Project,
212
Project.project_set_id == ProjectSet.id,
213
ProjectSet.max_students_per_group == None,
214
ProjectSet.offering_id == Offering.id,
215
(offering is None) or (Offering.id == offering.id),
216
Semester.id == Offering.semester_id,
217
(not active_only) or (Semester.state == u'current'),
218
Enrolment.offering_id == Offering.id,
219
Enrolment.user_id == self.id,
220
Enrolment.active == True)
188
223
def hash_password(password):
189
return md5.md5(password).hexdigest()
224
"""Hash a password with MD5."""
225
return hashlib.md5(password).hexdigest()
192
228
def get_by_login(cls, store, login):
194
Get the User from the db associated with a given store and
229
"""Find a user in a store by login name."""
197
230
return store.find(cls, cls.login == unicode(login)).one()
199
def get_permissions(self, user):
232
def get_permissions(self, user, config):
233
"""Determine privileges held by a user over this object.
235
If the user requesting privileges is this user or an admin,
236
they may do everything. Otherwise they may do nothing.
200
238
if user and user.admin or user is self:
201
return set(['view', 'edit'])
239
return set(['view_public', 'view', 'edit', 'submit_project'])
241
return set(['view_public'])
205
243
# SUBJECTS AND ENROLMENTS #
207
245
class Subject(Storm):
246
"""A subject (or course) which is run in some semesters."""
208
248
__storm_table__ = "subject"
210
250
id = Int(primary=True, name="subjectid")
211
251
code = Unicode(name="subj_code")
212
252
name = Unicode(name="subj_name")
213
253
short_name = Unicode(name="subj_short_name")
216
255
offerings = ReferenceSet(id, 'Offering.subject_id')
228
272
perms.add('edit')
275
def active_offerings(self):
276
"""Find active offerings for this subject.
278
Return a sequence of currently active offerings for this subject
279
(offerings whose semester.state is "current"). There should be 0 or 1
280
elements in this sequence, but it's possible there are more.
282
return self.offerings.find(Offering.semester_id == Semester.id,
283
Semester.state == u'current')
285
def offering_for_semester(self, year, semester):
286
"""Get the offering for the given year/semester, or None.
288
@param year: A string representation of the year.
289
@param semester: A string representation of the semester.
291
return self.offerings.find(Offering.semester_id == Semester.id,
292
Semester.year == unicode(year),
293
Semester.semester == unicode(semester)).one()
231
295
class Semester(Storm):
296
"""A semester in which subjects can be run."""
232
298
__storm_table__ = "semester"
234
300
id = Int(primary=True, name="semesterid")
295
373
Enrolment.offering_id == self.id).one()
296
374
Store.of(enrolment).remove(enrolment)
298
def get_permissions(self, user):
376
def get_permissions(self, user, config):
300
378
if user is not None:
301
379
enrolment = self.get_enrolment(user)
302
380
if enrolment or user.admin:
303
381
perms.add('view')
304
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
382
if enrolment and enrolment.role == u'tutor':
383
perms.add('view_project_submissions')
384
# Site-specific policy on the role of tutors
385
if config['policy']['tutors_can_enrol_students']:
387
perms.add('enrol_student')
388
if config['policy']['tutors_can_edit_worksheets']:
389
perms.add('edit_worksheets')
390
if config['policy']['tutors_can_admin_groups']:
391
perms.add('admin_groups')
392
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
393
perms.add('view_project_submissions')
394
perms.add('admin_groups')
395
perms.add('edit_worksheets')
396
perms.add('edit') # Can edit projects & details
397
perms.add('enrol') # Can see enrolment screen at all
398
perms.add('enrol_student') # Can enrol students
399
perms.add('enrol_tutor') # Can enrol tutors
401
perms.add('enrol_lecturer') # Can enrol lecturers
309
404
def get_enrolment(self, user):
405
"""Find the user's enrolment in this offering."""
311
407
enrolment = self.enrolments.find(user=user).one()
312
408
except NotOneError:
413
def get_members_by_role(self, role):
414
return Store.of(self).find(User,
415
Enrolment.user_id == User.id,
416
Enrolment.offering_id == self.id,
417
Enrolment.role == role
418
).order_by(User.login)
422
return self.get_members_by_role(u'student')
424
def get_open_projects_for_user(self, user):
425
"""Find all projects currently open to submissions by a user."""
426
# XXX: Respect extensions.
427
return self.projects.find(Project.deadline > datetime.datetime.now())
429
def clone_worksheets(self, source):
430
"""Clone all worksheets from the specified source to this offering."""
431
import ivle.worksheet.utils
432
for worksheet in source.worksheets:
434
newws.seq_no = worksheet.seq_no
435
newws.identifier = worksheet.identifier
436
newws.name = worksheet.name
437
newws.assessable = worksheet.assessable
438
newws.data = worksheet.data
439
newws.format = worksheet.format
440
newws.offering = self
441
Store.of(self).add(newws)
442
ivle.worksheet.utils.update_exerciselist(newws)
317
445
class Enrolment(Storm):
446
"""An enrolment of a user in an offering.
448
This represents the roles of both staff and students.
318
451
__storm_table__ = "enrolment"
319
452
__storm_primary__ = "user_id", "offering_id"
359
511
return "<%s %d in %r>" % (type(self).__name__, self.id,
514
def get_permissions(self, user, config):
515
return self.offering.get_permissions(user, config)
517
def get_groups_for_user(self, user):
518
"""List all groups in this offering of which the user is a member."""
520
return Store.of(self).find(
522
ProjectGroupMembership.user_id == user.id,
523
ProjectGroupMembership.project_group_id == ProjectGroup.id,
524
ProjectGroup.project_set_id == self.id)
526
def get_submission_principal(self, user):
527
"""Get the principal on behalf of which the user can submit.
529
If this is a solo project set, the given user is returned. If
530
the user is a member of exactly one group, all the group is
531
returned. Otherwise, None is returned.
534
groups = self.get_groups_for_user(user)
535
if groups.count() == 1:
544
return self.max_students_per_group is not None
548
"""Get the entities (groups or users) assigned to submit this project.
550
This will be a Storm ResultSet.
552
#If its a solo project, return everyone in offering
554
return self.project_groups
556
return self.offering.students
558
class DeadlinePassed(Exception):
559
"""An exception indicating that a project cannot be submitted because the
560
deadline has passed."""
564
return "The project deadline has passed"
362
566
class Project(Storm):
567
"""A student project for which submissions can be made."""
363
569
__storm_table__ = "project"
365
571
id = Int(name="projectid", primary=True)
573
short_name = Unicode()
366
574
synopsis = Unicode()
368
576
project_set_id = Int(name="projectsetid")
369
577
project_set = Reference(project_set_id, ProjectSet.id)
370
578
deadline = DateTime()
580
assesseds = ReferenceSet(id, 'Assessed.project_id')
581
submissions = ReferenceSet(id,
582
'Assessed.project_id',
584
'ProjectSubmission.assessed_id')
372
586
__init__ = _kwarg_init
374
588
def __repr__(self):
375
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
589
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
376
590
self.project_set.offering)
592
def can_submit(self, principal, user):
593
return (self in principal.get_projects() and
594
not self.has_deadline_passed(user))
596
def submit(self, principal, path, revision, who):
597
"""Submit a Subversion path and revision to a project.
599
@param principal: The owner of the Subversion repository, and the
600
entity on behalf of whom the submission is being made
601
@param path: A path within that repository to submit.
602
@param revision: The revision of that path to submit.
603
@param who: The user who is actually making the submission.
606
if not self.can_submit(principal, who):
607
raise DeadlinePassed()
609
a = Assessed.get(Store.of(self), principal, self)
610
ps = ProjectSubmission()
611
# Raise SubmissionError if the path is illegal
612
ps.path = ProjectSubmission.test_and_normalise_path(path)
613
ps.revision = revision
614
ps.date_submitted = datetime.datetime.now()
620
def get_permissions(self, user, config):
621
return self.project_set.offering.get_permissions(user, config)
624
def latest_submissions(self):
625
"""Return the latest submission for each Assessed."""
626
return Store.of(self).find(ProjectSubmission,
627
Assessed.project_id == self.id,
628
ProjectSubmission.assessed_id == Assessed.id,
629
ProjectSubmission.date_submitted == Select(
630
Max(ProjectSubmission.date_submitted),
631
ProjectSubmission.assessed_id == Assessed.id,
632
tables=ProjectSubmission
636
def has_deadline_passed(self, user):
637
"""Check whether the deadline has passed."""
638
# XXX: Need to respect extensions.
639
return self.deadline < datetime.datetime.now()
641
def get_submissions_for_principal(self, principal):
642
"""Fetch a ResultSet of all submissions by a particular principal."""
643
assessed = Assessed.get(Store.of(self), principal, self)
646
return assessed.submissions
378
650
class ProjectGroup(Storm):
651
"""A group of students working together on a project."""
379
653
__storm_table__ = "project_group"
381
655
id = Int(name="groupid", primary=True)
398
672
return "<%s %s in %r>" % (type(self).__name__, self.name,
399
673
self.project_set.offering)
676
def display_name(self):
677
"""Returns the "nice name" of the user or group."""
681
def short_name(self):
682
"""Returns the database "identifier" name of the user or group."""
685
def get_projects(self, offering=None, active_only=True):
686
'''Find projects that the group can submit.
688
This will include projects in the project set which owns this group,
689
unless the project set disallows groups (in which case none will be
692
@param active_only: Whether to only search active offerings.
693
@param offering: An optional offering to restrict the search to.
695
return Store.of(self).find(Project,
696
Project.project_set_id == ProjectSet.id,
697
ProjectSet.id == self.project_set.id,
698
ProjectSet.max_students_per_group != None,
699
ProjectSet.offering_id == Offering.id,
700
(offering is None) or (Offering.id == offering.id),
701
Semester.id == Offering.semester_id,
702
(not active_only) or (Semester.state == u'current'))
705
def get_permissions(self, user, config):
706
if user.admin or user in self.members:
707
return set(['submit_project'])
401
711
class ProjectGroupMembership(Storm):
712
"""A student's membership in a project group."""
402
714
__storm_table__ = "group_member"
403
715
__storm_primary__ = "user_id", "project_group_id"
413
725
return "<%s %r in %r>" % (type(self).__name__, self.user,
414
726
self.project_group)
728
class Assessed(Storm):
729
"""A composite of a user or group combined with a project.
731
Each project submission and extension refers to an Assessed. It is the
732
sole specifier of the repository and project.
735
__storm_table__ = "assessed"
737
id = Int(name="assessedid", primary=True)
738
user_id = Int(name="loginid")
739
user = Reference(user_id, User.id)
740
project_group_id = Int(name="groupid")
741
project_group = Reference(project_group_id, ProjectGroup.id)
743
project_id = Int(name="projectid")
744
project = Reference(project_id, Project.id)
746
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
747
submissions = ReferenceSet(
748
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
751
return "<%s %r in %r>" % (type(self).__name__,
752
self.user or self.project_group, self.project)
756
"""True if the Assessed is a group, False if it is a user."""
757
return self.project_group is not None
761
return self.project_group or self.user
764
def checkout_location(self):
765
"""Returns the location of the Subversion workspace for this piece of
766
assessment, relative to each group member's home directory."""
767
subjectname = self.project.project_set.offering.subject.short_name
769
checkout_dir_name = self.principal.short_name
771
checkout_dir_name = "mywork"
772
return subjectname + "/" + checkout_dir_name
775
def get(cls, store, principal, project):
776
"""Find or create an Assessed for the given user or group and project.
778
@param principal: The user or group.
779
@param project: The project.
782
if t not in (User, ProjectGroup):
783
raise AssertionError('principal must be User or ProjectGroup')
786
(t is User) or (cls.project_group_id == principal.id),
787
(t is ProjectGroup) or (cls.user_id == principal.id),
788
cls.project_id == project.id).one()
795
a.project_group = principal
802
class ProjectExtension(Storm):
803
"""An extension granted to a user or group on a particular project.
805
The user or group and project are specified by the Assessed.
808
__storm_table__ = "project_extension"
810
id = Int(name="extensionid", primary=True)
811
assessed_id = Int(name="assessedid")
812
assessed = Reference(assessed_id, Assessed.id)
813
deadline = DateTime()
814
approver_id = Int(name="approver")
815
approver = Reference(approver_id, User.id)
818
class SubmissionError(Exception):
819
"""Denotes a validation error during submission."""
822
class ProjectSubmission(Storm):
823
"""A submission from a user or group repository to a particular project.
825
The content of a submission is a single path and revision inside a
826
repository. The repository is that owned by the submission's user and
827
group, while the path and revision are explicit.
829
The user or group and project are specified by the Assessed.
832
__storm_table__ = "project_submission"
834
id = Int(name="submissionid", primary=True)
835
assessed_id = Int(name="assessedid")
836
assessed = Reference(assessed_id, Assessed.id)
839
submitter_id = Int(name="submitter")
840
submitter = Reference(submitter_id, User.id)
841
date_submitted = DateTime()
843
def get_verify_url(self, user):
844
"""Get the URL for verifying this submission, within the account of
846
# If this is a solo project, then self.path will be prefixed with the
847
# subject name. Remove the first path segment.
848
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
849
if not self.assessed.is_group:
850
if '/' in submitpath:
851
submitpath = submitpath.split('/', 1)[1]
854
return "/files/%s/%s/%s?r=%d" % (user.login,
855
self.assessed.checkout_location, submitpath, self.revision)
858
def test_and_normalise_path(path):
859
"""Test that path is valid, and normalise it. This prevents possible
860
injections using malicious paths.
861
Returns the updated path, if successful.
862
Raises SubmissionError if invalid.
864
# Ensure the path is absolute to prevent being tacked onto working
866
# Prevent '\n' because it will break all sorts of things.
867
# Prevent '[' and ']' because they can be used to inject into the
869
# Normalise to avoid resulting in ".." path segments.
870
if not os.path.isabs(path):
871
raise SubmissionError("Path is not absolute")
872
if any(c in path for c in "\n[]"):
873
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
874
return os.path.normpath(path)
416
876
# WORKSHEETS AND EXERCISES #
418
878
class Exercise(Storm):
879
"""An exercise for students to complete in a worksheet.
881
An exercise may be present in any number of worksheets.
419
884
__storm_table__ = "exercise"
420
885
id = Unicode(primary=True, name="identifier")
443
908
def __repr__(self):
444
909
return "<%s %s>" % (type(self).__name__, self.name)
446
def get_permissions(self, user):
911
def get_permissions(self, user, config):
912
return self.global_permissions(user, config)
915
def global_permissions(user, config):
916
"""Gets the set of permissions this user has over *all* exercises.
917
This is used to determine who may view the exercises list, and create
449
921
if user is not None:
451
923
perms.add('edit')
452
924
perms.add('view')
453
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
925
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
928
elif (config['policy']['tutors_can_edit_worksheets']
929
and u'tutor' in set((e.role for e in user.active_enrolments))):
930
# Site-specific policy on the role of tutors
459
936
def get_description(self):
937
"""Return the description interpreted as reStructuredText."""
460
938
return rst(self.description)
462
940
def delete(self):
568
1054
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
569
1055
self.worksheet.identifier)
571
def get_permissions(self, user):
572
return self.worksheet.get_permissions(user)
1057
def get_permissions(self, user, config):
1058
return self.worksheet.get_permissions(user, config)
575
1061
class ExerciseSave(Storm):
577
Represents a potential solution to an exercise that a user has submitted
578
to the server for storage.
579
A basic ExerciseSave is just the current saved text for this exercise for
580
this user (doesn't count towards their attempts).
581
ExerciseSave may be extended with additional semantics (such as
1062
"""A potential exercise solution submitted by a user for storage.
1064
This is not an actual tested attempt at an exercise, it's just a save of
1065
the editing session.
584
1068
__storm_table__ = "exercise_save"
585
1069
__storm_primary__ = "ws_ex_id", "user_id"
599
1083
self.exercise.name, self.user.login, self.date.strftime("%c"))
601
1085
class ExerciseAttempt(ExerciseSave):
603
An ExerciseAttempt is a special case of an ExerciseSave. Like an
604
ExerciseSave, it constitutes exercise solution data that the user has
605
submitted to the server for storage.
606
In addition, it contains additional information about the submission.
607
complete - True if this submission was successful, rendering this exercise
608
complete for this user.
609
active - True if this submission is "active" (usually true). Submissions
610
may be de-activated by privileged users for special reasons, and then
611
they won't count (either as a penalty or success), but will still be
1086
"""An attempt at solving an exercise.
1088
This is a special case of ExerciseSave, used when the user submits a
1089
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1092
In addition, it contains information about the result of the submission:
1094
- complete - True if this submission was successful, rendering this
1095
exercise complete for this user in this worksheet.
1096
- active - True if this submission is "active" (usually true).
1097
Submissions may be de-activated by privileged users for
1098
special reasons, and then they won't count (either as a
1099
penalty or success), but will still be stored.
614
1102
__storm_table__ = "exercise_attempt"
615
1103
__storm_primary__ = "ws_ex_id", "user_id", "date"
637
1130
exercise = Reference(exercise_id, Exercise.id)
638
1131
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
639
1132
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
641
1134
def delete(self):
642
1135
"""Delete this suite, without asking questions."""
643
for vaariable in self.variables:
1136
for variable in self.variables:
644
1137
variable.delete()
645
1138
for test_case in self.test_cases:
646
1139
test_case.delete()
647
1140
Store.of(self).remove(self)
649
1142
class TestCase(Storm):
650
"""A TestCase is a member of a TestSuite.
652
It contains the data necessary to check if an exercise is correct"""
1143
"""A container for actual tests (see TestCasePart), inside a test suite.
1145
It is the lowest level shown to students on their pass/fail status."""
653
1147
__storm_table__ = "test_case"
654
1148
__storm_primary__ = "testid", "suiteid"
658
1152
suite = Reference(suiteid, "TestSuite.suiteid")
659
1153
passmsg = Unicode()
660
1154
failmsg = Unicode()
661
test_default = Unicode()
1155
test_default = Unicode() # Currently unused - only used for file matching.
664
1158
parts = ReferenceSet(testid, "TestCasePart.testid")
666
1160
__init__ = _kwarg_init
668
1162
def delete(self):
669
1163
for part in self.parts:
671
1165
Store.of(self).remove(self)
673
1167
class TestSuiteVar(Storm):
674
"""A container for the arguments of a Test Suite"""
1168
"""A variable used by an exercise test suite.
1170
This may represent a function argument or a normal variable.
675
1173
__storm_table__ = "suite_variable"
676
1174
__storm_primary__ = "varid"
680
1178
var_name = Unicode()
681
1179
var_value = Unicode()
682
1180
var_type = Unicode()
685
1183
suite = Reference(suiteid, "TestSuite.suiteid")
687
1185
__init__ = _kwarg_init
689
1187
def delete(self):
690
1188
Store.of(self).remove(self)
692
1190
class TestCasePart(Storm):
693
"""A container for the test elements of a Test Case"""
1191
"""An actual piece of code to test an exercise solution."""
694
1193
__storm_table__ = "test_case_part"
695
1194
__storm_primary__ = "partid"
700
1199
part_type = Unicode()
701
1200
test_type = Unicode()
702
1201
data = Unicode()
703
1202
filename = Unicode()
705
1204
test = Reference(testid, "TestCase.testid")
707
1206
__init__ = _kwarg_init
709
1208
def delete(self):
710
1209
Store.of(self).remove(self)
added
removed
ivle/database.py
