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
32
from storm.exceptions import NotOneError, IntegrityError
35
34
from ivle.worksheet.rst import rst
37
36
__all__ = ['get_store',
51
50
% (self.__class__.__name__, k))
52
51
setattr(self, k, v)
54
def get_conn_string():
56
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.
61
clusterstr += ivle.conf.db_user
62
if ivle.conf.db_password:
63
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']
66
host = ivle.conf.db_host or 'localhost'
67
port = ivle.conf.db_port or 5432
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
69
69
clusterstr += '%s:%d' % (host, port)
71
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
75
Open a database connection and transaction. Return a storm.store.Store
76
instance connected to the configured IVLE database.
78
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)))
84
Represents an IVLE user.
83
"""An IVLE user account."""
86
84
__storm_table__ = "login"
88
86
id = Int(primary=True, name="loginid")
190
198
return self._get_enrolments(False)
192
200
def get_projects(self, offering=None, active_only=True):
193
'''Return Projects that the user can submit.
201
"""Find projects that the user can submit.
195
203
This will include projects for offerings in which the user is
196
204
enrolled, as long as the project is not in a project set which has
197
205
groups (ie. if maximum number of group members is 0).
199
Unless active_only is False, only projects for active offerings will
202
If an offering is specified, returned projects will be limited to
203
those for that offering.
207
@param active_only: Whether to only search active offerings.
208
@param offering: An optional offering to restrict the search to.
205
210
return Store.of(self).find(Project,
206
211
Project.project_set_id == ProjectSet.id,
207
ProjectSet.max_students_per_group == 0,
212
ProjectSet.max_students_per_group == None,
208
213
ProjectSet.offering_id == Offering.id,
209
214
(offering is None) or (Offering.id == offering.id),
210
215
Semester.id == Offering.semester_id,
211
216
(not active_only) or (Semester.state == u'current'),
212
217
Enrolment.offering_id == Offering.id,
213
Enrolment.user_id == self.id)
218
Enrolment.user_id == self.id,
219
Enrolment.active == True)
216
222
def hash_password(password):
217
return md5.md5(password).hexdigest()
223
"""Hash a password with MD5."""
224
return hashlib.md5(password).hexdigest()
220
227
def get_by_login(cls, store, login):
222
Get the User from the db associated with a given store and
228
"""Find a user in a store by login name."""
225
229
return store.find(cls, cls.login == unicode(login)).one()
227
def get_permissions(self, user):
231
def get_permissions(self, user, config):
232
"""Determine privileges held by a user over this object.
234
If the user requesting privileges is this user or an admin,
235
they may do everything. Otherwise they may do nothing.
228
237
if user and user.admin or user is self:
229
return set(['view', 'edit', 'submit_project'])
238
return set(['view_public', 'view', 'edit', 'submit_project'])
240
return set(['view_public'])
233
242
# SUBJECTS AND ENROLMENTS #
235
244
class Subject(Storm):
245
"""A subject (or course) which is run in some semesters."""
236
247
__storm_table__ = "subject"
238
249
id = Int(primary=True, name="subjectid")
239
250
code = Unicode(name="subj_code")
240
251
name = Unicode(name="subj_name")
241
252
short_name = Unicode(name="subj_short_name")
244
254
offerings = ReferenceSet(id, 'Offering.subject_id')
256
271
perms.add('edit')
274
def active_offerings(self):
275
"""Find active offerings for this subject.
277
Return a sequence of currently active offerings for this subject
278
(offerings whose semester.state is "current"). There should be 0 or 1
279
elements in this sequence, but it's possible there are more.
281
return self.offerings.find(Offering.semester_id == Semester.id,
282
Semester.state == u'current')
284
def offering_for_semester(self, year, semester):
285
"""Get the offering for the given year/semester, or None.
287
@param year: A string representation of the year.
288
@param semester: A string representation of the semester.
290
return self.offerings.find(Offering.semester_id == Semester.id,
291
Semester.year == unicode(year),
292
Semester.semester == unicode(semester)).one()
259
294
class Semester(Storm):
295
"""A semester in which subjects can be run."""
260
297
__storm_table__ = "semester"
262
299
id = Int(primary=True, name="semesterid")
306
351
def enrol(self, user, role=u'student'):
307
'''Enrol a user in this offering.'''
352
"""Enrol a user in this offering.
354
Enrolments handle both the staff and student cases. The role controls
355
the privileges granted by this enrolment.
308
357
enrolment = Store.of(self).find(Enrolment,
309
358
Enrolment.user_id == user.id,
310
359
Enrolment.offering_id == self.id).one()
323
372
Enrolment.offering_id == self.id).one()
324
373
Store.of(enrolment).remove(enrolment)
326
def get_permissions(self, user):
375
def get_permissions(self, user, config):
328
377
if user is not None:
329
378
enrolment = self.get_enrolment(user)
330
379
if enrolment or user.admin:
331
380
perms.add('view')
332
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
381
if enrolment and enrolment.role == u'tutor':
382
perms.add('view_project_submissions')
383
# Site-specific policy on the role of tutors
384
if config['policy']['tutors_can_enrol_students']:
386
perms.add('enrol_student')
387
if config['policy']['tutors_can_edit_worksheets']:
388
perms.add('edit_worksheets')
389
if config['policy']['tutors_can_admin_groups']:
390
perms.add('admin_groups')
391
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
392
perms.add('view_project_submissions')
393
perms.add('admin_groups')
394
perms.add('edit_worksheets')
395
perms.add('edit') # Can edit projects & details
396
perms.add('enrol') # Can see enrolment screen at all
397
perms.add('enrol_student') # Can enrol students
398
perms.add('enrol_tutor') # Can enrol tutors
400
perms.add('enrol_lecturer') # Can enrol lecturers
337
403
def get_enrolment(self, user):
404
"""Find the user's enrolment in this offering."""
339
406
enrolment = self.enrolments.find(user=user).one()
340
407
except NotOneError:
412
def get_members_by_role(self, role):
413
return Store.of(self).find(User,
414
Enrolment.user_id == User.id,
415
Enrolment.offering_id == self.id,
416
Enrolment.role == role
417
).order_by(User.login)
421
return self.get_members_by_role(u'student')
423
def get_open_projects_for_user(self, user):
424
"""Find all projects currently open to submissions by a user."""
425
# XXX: Respect extensions.
426
return self.projects.find(Project.deadline > datetime.datetime.now())
345
428
class Enrolment(Storm):
429
"""An enrolment of a user in an offering.
431
This represents the roles of both staff and students.
346
434
__storm_table__ = "enrolment"
347
435
__storm_primary__ = "user_id", "offering_id"
387
481
return "<%s %d in %r>" % (type(self).__name__, self.id,
484
def get_permissions(self, user, config):
485
return self.offering.get_permissions(user, config)
487
def get_groups_for_user(self, user):
488
"""List all groups in this offering of which the user is a member."""
490
return Store.of(self).find(
492
ProjectGroupMembership.user_id == user.id,
493
ProjectGroupMembership.project_group_id == ProjectGroup.id,
494
ProjectGroup.project_set_id == self.id)
496
def get_submission_principal(self, user):
497
"""Get the principal on behalf of which the user can submit.
499
If this is a solo project set, the given user is returned. If
500
the user is a member of exactly one group, all the group is
501
returned. Otherwise, None is returned.
504
groups = self.get_groups_for_user(user)
505
if groups.count() == 1:
514
return self.max_students_per_group is not None
518
"""Get the entities (groups or users) assigned to submit this project.
520
This will be a Storm ResultSet.
522
#If its a solo project, return everyone in offering
524
return self.project_groups
526
return self.offering.students
528
class DeadlinePassed(Exception):
529
"""An exception indicating that a project cannot be submitted because the
530
deadline has passed."""
534
return "The project deadline has passed"
390
536
class Project(Storm):
537
"""A student project for which submissions can be made."""
391
539
__storm_table__ = "project"
393
541
id = Int(name="projectid", primary=True)
411
559
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
412
560
self.project_set.offering)
414
def can_submit(self, principal):
562
def can_submit(self, principal, user):
415
563
return (self in principal.get_projects() and
416
self.deadline > datetime.datetime.now())
418
def submit(self, principal, path, revision):
419
if not self.can_submit(principal):
420
raise Exception('cannot submit')
564
not self.has_deadline_passed(user))
566
def submit(self, principal, path, revision, who):
567
"""Submit a Subversion path and revision to a project.
569
@param principal: The owner of the Subversion repository, and the
570
entity on behalf of whom the submission is being made
571
@param path: A path within that repository to submit.
572
@param revision: The revision of that path to submit.
573
@param who: The user who is actually making the submission.
576
if not self.can_submit(principal, who):
577
raise DeadlinePassed()
422
579
a = Assessed.get(Store.of(self), principal, self)
423
580
ps = ProjectSubmission()
425
582
ps.revision = revision
426
583
ps.date_submitted = datetime.datetime.now()
589
def get_permissions(self, user, config):
590
return self.project_set.offering.get_permissions(user, config)
593
def latest_submissions(self):
594
"""Return the latest submission for each Assessed."""
595
return Store.of(self).find(ProjectSubmission,
596
Assessed.project_id == self.id,
597
ProjectSubmission.assessed_id == Assessed.id,
598
ProjectSubmission.date_submitted == Select(
599
Max(ProjectSubmission.date_submitted),
600
ProjectSubmission.assessed_id == Assessed.id,
601
tables=ProjectSubmission
605
def has_deadline_passed(self, user):
606
"""Check whether the deadline has passed."""
607
# XXX: Need to respect extensions.
608
return self.deadline < datetime.datetime.now()
610
def get_submissions_for_principal(self, principal):
611
"""Fetch a ResultSet of all submissions by a particular principal."""
612
assessed = Assessed.get(Store.of(self), principal, self)
615
return assessed.submissions
432
619
class ProjectGroup(Storm):
620
"""A group of students working together on a project."""
433
622
__storm_table__ = "project_group"
435
624
id = Int(name="groupid", primary=True)
456
645
def display_name(self):
457
return '%s (%s)' % (self.nick, self.name)
646
"""Returns the "nice name" of the user or group."""
650
def short_name(self):
651
"""Returns the database "identifier" name of the user or group."""
459
654
def get_projects(self, offering=None, active_only=True):
460
'''Return Projects that the group can submit.
655
'''Find projects that the group can submit.
462
657
This will include projects in the project set which owns this group,
463
658
unless the project set disallows groups (in which case none will be
466
Unless active_only is False, projects will only be returned if the
467
group's offering is active.
469
If an offering is specified, projects will only be returned if it
661
@param active_only: Whether to only search active offerings.
662
@param offering: An optional offering to restrict the search to.
472
664
return Store.of(self).find(Project,
473
665
Project.project_set_id == ProjectSet.id,
474
666
ProjectSet.id == self.project_set.id,
475
ProjectSet.max_students_per_group > 0,
667
ProjectSet.max_students_per_group != None,
476
668
ProjectSet.offering_id == Offering.id,
477
669
(offering is None) or (Offering.id == offering.id),
478
670
Semester.id == Offering.semester_id,
479
671
(not active_only) or (Semester.state == u'current'))
482
def get_permissions(self, user):
674
def get_permissions(self, user, config):
483
675
if user.admin or user in self.members:
484
676
return set(['submit_project'])
488
680
class ProjectGroupMembership(Storm):
681
"""A student's membership in a project group."""
489
683
__storm_table__ = "group_member"
490
684
__storm_primary__ = "user_id", "project_group_id"
513
713
project = Reference(project_id, Project.id)
515
715
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
516
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
716
submissions = ReferenceSet(
717
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
518
719
def __repr__(self):
519
720
return "<%s %r in %r>" % (type(self).__name__,
520
721
self.user or self.project_group, self.project)
725
"""True if the Assessed is a group, False if it is a user."""
726
return self.project_group is not None
730
return self.project_group or self.user
733
def checkout_location(self):
734
"""Returns the location of the Subversion workspace for this piece of
735
assessment, relative to each group member's home directory."""
736
subjectname = self.project.project_set.offering.subject.short_name
738
checkout_dir_name = self.principal.short_name
740
checkout_dir_name = "mywork"
741
return subjectname + "/" + checkout_dir_name
523
744
def get(cls, store, principal, project):
745
"""Find or create an Assessed for the given user or group and project.
747
@param principal: The user or group.
748
@param project: The project.
524
750
t = type(principal)
525
751
if t not in (User, ProjectGroup):
526
752
raise AssertionError('principal must be User or ProjectGroup')
554
785
notes = Unicode()
556
787
class ProjectSubmission(Storm):
788
"""A submission from a user or group repository to a particular project.
790
The content of a submission is a single path and revision inside a
791
repository. The repository is that owned by the submission's user and
792
group, while the path and revision are explicit.
794
The user or group and project are specified by the Assessed.
557
797
__storm_table__ = "project_submission"
559
799
id = Int(name="submissionid", primary=True)
561
801
assessed = Reference(assessed_id, Assessed.id)
804
submitter_id = Int(name="submitter")
805
submitter = Reference(submitter_id, User.id)
564
806
date_submitted = DateTime()
808
def get_verify_url(self, user):
809
"""Get the URL for verifying this submission, within the account of
811
# If this is a solo project, then self.path will be prefixed with the
812
# subject name. Remove the first path segment.
813
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
814
if not self.assessed.is_group:
815
if '/' in submitpath:
816
submitpath = submitpath.split('/', 1)[1]
819
return "/files/%s/%s/%s?r=%d" % (user.login,
820
self.assessed.checkout_location, submitpath, self.revision)
567
822
# WORKSHEETS AND EXERCISES #
569
824
class Exercise(Storm):
825
"""An exercise for students to complete in a worksheet.
827
An exercise may be present in any number of worksheets.
570
830
__storm_table__ = "exercise"
571
831
id = Unicode(primary=True, name="identifier")
594
854
def __repr__(self):
595
855
return "<%s %s>" % (type(self).__name__, self.name)
597
def get_permissions(self, user):
857
def get_permissions(self, user, config):
858
return self.global_permissions(user, config)
861
def global_permissions(user, config):
862
"""Gets the set of permissions this user has over *all* exercises.
863
This is used to determine who may view the exercises list, and create
600
867
if user is not None:
602
869
perms.add('edit')
603
870
perms.add('view')
604
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
871
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
874
elif (config['policy']['tutors_can_edit_worksheets']
875
and u'tutor' in set((e.role for e in user.active_enrolments))):
876
# Site-specific policy on the role of tutors
610
882
def get_description(self):
883
"""Return the description interpreted as reStructuredText."""
611
884
return rst(self.description)
613
886
def delete(self):
649
927
def __repr__(self):
650
928
return "<%s %s>" % (type(self).__name__, self.name)
652
# XXX Refactor this - make it an instance method of Subject rather than a
653
# class method of Worksheet. Can't do that now because Subject isn't
654
# linked referentially to the Worksheet.
656
def get_by_name(cls, store, subjectname, worksheetname):
658
Get the Worksheet from the db associated with a given store, subject
659
name and worksheet name.
661
return store.find(cls, cls.subject == unicode(subjectname),
662
cls.name == unicode(worksheetname)).one()
664
930
def remove_all_exercises(self):
666
Remove all exercises from this worksheet.
931
"""Remove all exercises from this worksheet.
667
933
This does not delete the exercises themselves. It just removes them
668
934
from the worksheet.
673
939
raise IntegrityError()
674
940
store.find(WorksheetExercise,
675
941
WorksheetExercise.worksheet == self).remove()
677
def get_permissions(self, user):
678
return self.offering.get_permissions(user)
943
def get_permissions(self, user, config):
944
# Almost the same permissions as for the offering itself
945
perms = self.offering.get_permissions(user, config)
946
# However, "edit" permission is derived from the "edit_worksheets"
947
# permission of the offering
948
if 'edit_worksheets' in perms:
951
perms.discard('edit')
680
954
def get_xml(self):
681
955
"""Returns the xml of this worksheet, converts from rst if required."""
682
956
if self.format == u'rst':
688
962
def delete(self):
689
963
"""Deletes the worksheet, provided it has no attempts on any exercises.
691
965
Returns True if delete succeeded, or False if this worksheet has
692
966
attempts attached."""
693
967
for ws_ex in self.all_worksheet_exercises:
694
968
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
695
969
raise IntegrityError()
697
971
self.remove_all_exercises()
698
972
Store.of(self).remove(self)
700
974
class WorksheetExercise(Storm):
975
"""A link between a worksheet and one of its exercises.
977
These may be marked optional, in which case the exercise does not count
978
for marking purposes. The sequence number is used to order the worksheet
701
982
__storm_table__ = "worksheet_exercise"
703
984
id = Int(primary=True, name="ws_ex_id")
705
986
worksheet_id = Int(name="worksheetid")
719
1000
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
720
1001
self.worksheet.identifier)
722
def get_permissions(self, user):
723
return self.worksheet.get_permissions(user)
1003
def get_permissions(self, user, config):
1004
return self.worksheet.get_permissions(user, config)
726
1007
class ExerciseSave(Storm):
728
Represents a potential solution to an exercise that a user has submitted
729
to the server for storage.
730
A basic ExerciseSave is just the current saved text for this exercise for
731
this user (doesn't count towards their attempts).
732
ExerciseSave may be extended with additional semantics (such as
1008
"""A potential exercise solution submitted by a user for storage.
1010
This is not an actual tested attempt at an exercise, it's just a save of
1011
the editing session.
735
1014
__storm_table__ = "exercise_save"
736
1015
__storm_primary__ = "ws_ex_id", "user_id"
750
1029
self.exercise.name, self.user.login, self.date.strftime("%c"))
752
1031
class ExerciseAttempt(ExerciseSave):
754
An ExerciseAttempt is a special case of an ExerciseSave. Like an
755
ExerciseSave, it constitutes exercise solution data that the user has
756
submitted to the server for storage.
757
In addition, it contains additional information about the submission.
758
complete - True if this submission was successful, rendering this exercise
759
complete for this user.
760
active - True if this submission is "active" (usually true). Submissions
761
may be de-activated by privileged users for special reasons, and then
762
they won't count (either as a penalty or success), but will still be
1032
"""An attempt at solving an exercise.
1034
This is a special case of ExerciseSave, used when the user submits a
1035
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1038
In addition, it contains information about the result of the submission:
1040
- complete - True if this submission was successful, rendering this
1041
exercise complete for this user in this worksheet.
1042
- active - True if this submission is "active" (usually true).
1043
Submissions may be de-activated by privileged users for
1044
special reasons, and then they won't count (either as a
1045
penalty or success), but will still be stored.
765
1048
__storm_table__ = "exercise_attempt"
766
1049
__storm_primary__ = "ws_ex_id", "user_id", "date"
770
1053
text = Unicode(name="attempt")
771
1054
complete = Bool()
774
def get_permissions(self, user):
1057
def get_permissions(self, user, config):
775
1058
return set(['view']) if user is self.user else set()
777
1060
class TestSuite(Storm):
778
"""A Testsuite acts as a container for the test cases of an exercise."""
1061
"""A container to group an exercise's test cases.
1063
The test suite contains some information on how to test. The function to
1064
test, variables to set and stdin data are stored here.
779
1067
__storm_table__ = "test_suite"
780
1068
__storm_primary__ = "exercise_id", "suiteid"
783
1071
exercise_id = Unicode(name="exerciseid")
784
1072
description = Unicode()
788
1076
exercise = Reference(exercise_id, Exercise.id)
789
1077
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
790
1078
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
792
1080
def delete(self):
793
1081
"""Delete this suite, without asking questions."""
794
for vaariable in self.variables:
1082
for variable in self.variables:
795
1083
variable.delete()
796
1084
for test_case in self.test_cases:
797
1085
test_case.delete()
798
1086
Store.of(self).remove(self)
800
1088
class TestCase(Storm):
801
"""A TestCase is a member of a TestSuite.
803
It contains the data necessary to check if an exercise is correct"""
1089
"""A container for actual tests (see TestCasePart), inside a test suite.
1091
It is the lowest level shown to students on their pass/fail status."""
804
1093
__storm_table__ = "test_case"
805
1094
__storm_primary__ = "testid", "suiteid"
809
1098
suite = Reference(suiteid, "TestSuite.suiteid")
810
1099
passmsg = Unicode()
811
1100
failmsg = Unicode()
812
test_default = Unicode()
1101
test_default = Unicode() # Currently unused - only used for file matching.
815
1104
parts = ReferenceSet(testid, "TestCasePart.testid")
817
1106
__init__ = _kwarg_init
819
1108
def delete(self):
820
1109
for part in self.parts:
822
1111
Store.of(self).remove(self)
824
1113
class TestSuiteVar(Storm):
825
"""A container for the arguments of a Test Suite"""
1114
"""A variable used by an exercise test suite.
1116
This may represent a function argument or a normal variable.
826
1119
__storm_table__ = "suite_variable"
827
1120
__storm_primary__ = "varid"
831
1124
var_name = Unicode()
832
1125
var_value = Unicode()
833
1126
var_type = Unicode()
836
1129
suite = Reference(suiteid, "TestSuite.suiteid")
838
1131
__init__ = _kwarg_init
840
1133
def delete(self):
841
1134
Store.of(self).remove(self)
843
1136
class TestCasePart(Storm):
844
"""A container for the test elements of a Test Case"""
1137
"""An actual piece of code to test an exercise solution."""
845
1139
__storm_table__ = "test_case_part"
846
1140
__storm_primary__ = "partid"
851
1145
part_type = Unicode()
852
1146
test_type = Unicode()
853
1147
data = Unicode()
854
1148
filename = Unicode()
856
1150
test = Reference(testid, "TestCase.testid")
858
1152
__init__ = _kwarg_init
860
1154
def delete(self):
861
1155
Store.of(self).remove(self)
added
removed
ivle/database.py
