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")
165
169
# TODO: Invitations should be listed too?
166
170
def get_groups(self, offering=None):
171
"""Get groups of which this user is a member.
173
@param offering: An optional offering to restrict the search to.
168
176
ProjectGroupMembership.user_id == self.id,
169
177
ProjectGroup.id == ProjectGroupMembership.project_group_id,
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,
216
221
def hash_password(password):
217
return md5.md5(password).hexdigest()
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
220
226
def get_by_login(cls, store, login):
222
Get the User from the db associated with a given store and
227
"""Find a user in a store by login name."""
225
228
return store.find(cls, cls.login == unicode(login)).one()
227
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.
228
236
if user and user.admin or user is self:
229
return set(['view', 'edit', 'submit_project'])
237
return set(['view_public', 'view', 'edit', 'submit_project'])
239
return set(['view_public'])
233
241
# SUBJECTS AND ENROLMENTS #
235
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
236
246
__storm_table__ = "subject"
238
248
id = Int(primary=True, name="subjectid")
239
249
code = Unicode(name="subj_code")
240
250
name = Unicode(name="subj_name")
241
251
short_name = Unicode(name="subj_short_name")
244
253
offerings = ReferenceSet(id, 'Offering.subject_id')
249
258
return "<%s '%s'>" % (type(self).__name__, self.short_name)
251
260
def get_permissions(self, user):
261
"""Determine privileges held by a user over this object.
263
If the user requesting privileges is an admin, they may edit.
264
Otherwise they may only read.
253
267
if user is not None:
254
268
perms.add('view')
256
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()
259
293
class Semester(Storm):
294
"""A semester in which subjects can be run."""
260
296
__storm_table__ = "semester"
262
298
id = Int(primary=True, name="semesterid")
276
312
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
278
314
class Offering(Storm):
315
"""An offering of a subject in a particular semester."""
279
317
__storm_table__ = "offering"
281
319
id = Int(primary=True, name="offeringid")
283
321
subject = Reference(subject_id, Subject.id)
284
322
semester_id = Int(name="semesterid")
285
323
semester = Reference(semester_id, Semester.id)
324
description = Unicode()
286
326
groups_student_permissions = Unicode()
288
328
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
291
331
'Enrolment.user_id',
293
333
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
334
projects = ReferenceSet(id,
335
'ProjectSet.offering_id',
337
'Project.project_set_id')
295
339
worksheets = ReferenceSet(id,
296
340
'Worksheet.offering_id',
306
350
def enrol(self, user, role=u'student'):
307
'''Enrol a user in this offering.'''
351
"""Enrol a user in this offering.
353
Enrolments handle both the staff and student cases. The role controls
354
the privileges granted by this enrolment.
308
356
enrolment = Store.of(self).find(Enrolment,
309
357
Enrolment.user_id == user.id,
310
358
Enrolment.offering_id == self.id).one()
332
380
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
334
382
perms.add('edit')
383
# XXX Bug #493945 -- should tutors have these permissions?
384
# Potentially move into the next category (lecturer & admin)
385
perms.add('enrol') # Can see enrolment screen at all
386
perms.add('enrol_student') # Can enrol students
387
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
388
perms.add('enrol_tutor') # Can enrol tutors
390
perms.add('enrol_lecturer') # Can enrol lecturers
337
393
def get_enrolment(self, user):
394
"""Find the user's enrolment in this offering."""
339
396
enrolment = self.enrolments.find(user=user).one()
340
397
except NotOneError:
402
def get_members_by_role(self, role):
403
return Store.of(self).find(User,
404
Enrolment.user_id == User.id,
405
Enrolment.offering_id == self.id,
406
Enrolment.role == role
407
).order_by(User.login)
411
return self.get_members_by_role(u'student')
413
def get_open_projects_for_user(self, user):
414
"""Find all projects currently open to submissions by a user."""
415
# XXX: Respect extensions.
416
return self.projects.find(Project.deadline > datetime.datetime.now())
345
418
class Enrolment(Storm):
419
"""An enrolment of a user in an offering.
421
This represents the roles of both staff and students.
346
424
__storm_table__ = "enrolment"
347
425
__storm_primary__ = "user_id", "offering_id"
373
451
class ProjectSet(Storm):
452
"""A set of projects that share common groups.
454
Each student project group is attached to a project set. The group is
455
valid for all projects in the group's set.
374
458
__storm_table__ = "project_set"
376
460
id = Int(name="projectsetid", primary=True)
387
471
return "<%s %d in %r>" % (type(self).__name__, self.id,
474
def get_permissions(self, user):
475
return self.offering.get_permissions(user)
477
def get_groups_for_user(self, user):
478
"""List all groups in this offering of which the user is a member."""
480
return Store.of(self).find(
482
ProjectGroupMembership.user_id == user.id,
483
ProjectGroupMembership.project_group_id == ProjectGroup.id,
484
ProjectGroup.project_set_id == self.id)
486
def get_submission_principal(self, user):
487
"""Get the principal on behalf of which the user can submit.
489
If this is a solo project set, the given user is returned. If
490
the user is a member of exactly one group, all the group is
491
returned. Otherwise, None is returned.
494
groups = self.get_groups_for_user(user)
495
if groups.count() == 1:
504
return self.max_students_per_group is not None
508
"""Get the entities (groups or users) assigned to submit this project.
510
This will be a Storm ResultSet.
512
#If its a solo project, return everyone in offering
514
return self.project_groups
516
return self.offering.students
390
518
class Project(Storm):
519
"""A student project for which submissions can be made."""
391
521
__storm_table__ = "project"
393
523
id = Int(name="projectid", primary=True)
411
541
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
412
542
self.project_set.offering)
414
def can_submit(self, principal):
544
def can_submit(self, principal, user):
415
545
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):
546
not self.has_deadline_passed(user))
548
def submit(self, principal, path, revision, who):
549
"""Submit a Subversion path and revision to a project.
551
@param principal: The owner of the Subversion repository, and the
552
entity on behalf of whom the submission is being made
553
@param path: A path within that repository to submit.
554
@param revision: The revision of that path to submit.
555
@param who: The user who is actually making the submission.
558
if not self.can_submit(principal, who):
420
559
raise Exception('cannot submit')
422
561
a = Assessed.get(Store.of(self), principal, self)
425
564
ps.revision = revision
426
565
ps.date_submitted = datetime.datetime.now()
571
def get_permissions(self, user):
572
return self.project_set.offering.get_permissions(user)
575
def latest_submissions(self):
576
"""Return the latest submission for each Assessed."""
577
return Store.of(self).find(ProjectSubmission,
578
Assessed.project_id == self.id,
579
ProjectSubmission.assessed_id == Assessed.id,
580
ProjectSubmission.date_submitted == Select(
581
Max(ProjectSubmission.date_submitted),
582
ProjectSubmission.assessed_id == Assessed.id,
583
tables=ProjectSubmission
587
def has_deadline_passed(self, user):
588
"""Check whether the deadline has passed."""
589
# XXX: Need to respect extensions.
590
return self.deadline < datetime.datetime.now()
592
def get_submissions_for_principal(self, principal):
593
"""Fetch a ResultSet of all submissions by a particular principal."""
594
assessed = Assessed.get(Store.of(self), principal, self)
597
return assessed.submissions
432
601
class ProjectGroup(Storm):
602
"""A group of students working together on a project."""
433
604
__storm_table__ = "project_group"
435
606
id = Int(name="groupid", primary=True)
456
627
def display_name(self):
457
return '%s (%s)' % (self.nick, self.name)
628
"""Returns the "nice name" of the user or group."""
632
def short_name(self):
633
"""Returns the database "identifier" name of the user or group."""
459
636
def get_projects(self, offering=None, active_only=True):
460
'''Return Projects that the group can submit.
637
'''Find projects that the group can submit.
462
639
This will include projects in the project set which owns this group,
463
640
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
643
@param active_only: Whether to only search active offerings.
644
@param offering: An optional offering to restrict the search to.
472
646
return Store.of(self).find(Project,
473
647
Project.project_set_id == ProjectSet.id,
474
648
ProjectSet.id == self.project_set.id,
475
ProjectSet.max_students_per_group > 0,
649
ProjectSet.max_students_per_group != None,
476
650
ProjectSet.offering_id == Offering.id,
477
651
(offering is None) or (Offering.id == offering.id),
478
652
Semester.id == Offering.semester_id,
488
662
class ProjectGroupMembership(Storm):
663
"""A student's membership in a project group."""
489
665
__storm_table__ = "group_member"
490
666
__storm_primary__ = "user_id", "project_group_id"
501
677
self.project_group)
503
679
class Assessed(Storm):
680
"""A composite of a user or group combined with a project.
682
Each project submission and extension refers to an Assessed. It is the
683
sole specifier of the repository and project.
504
686
__storm_table__ = "assessed"
506
688
id = Int(name="assessedid", primary=True)
513
695
project = Reference(project_id, Project.id)
515
697
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
516
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
698
submissions = ReferenceSet(
699
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
518
701
def __repr__(self):
519
702
return "<%s %r in %r>" % (type(self).__name__,
520
703
self.user or self.project_group, self.project)
707
"""True if the Assessed is a group, False if it is a user."""
708
return self.project_group is not None
712
return self.project_group or self.user
523
715
def get(cls, store, principal, project):
716
"""Find or create an Assessed for the given user or group and project.
718
@param principal: The user or group.
719
@param project: The project.
524
721
t = type(principal)
525
722
if t not in (User, ProjectGroup):
526
723
raise AssertionError('principal must be User or ProjectGroup')
528
725
a = store.find(cls,
529
726
(t is User) or (cls.project_group_id == principal.id),
530
727
(t is ProjectGroup) or (cls.user_id == principal.id),
531
Project.id == project.id).one()
728
cls.project_id == project.id).one()
545
742
class ProjectExtension(Storm):
743
"""An extension granted to a user or group on a particular project.
745
The user or group and project are specified by the Assessed.
546
748
__storm_table__ = "project_extension"
548
750
id = Int(name="extensionid", primary=True)
554
756
notes = Unicode()
556
758
class ProjectSubmission(Storm):
759
"""A submission from a user or group repository to a particular project.
761
The content of a submission is a single path and revision inside a
762
repository. The repository is that owned by the submission's user and
763
group, while the path and revision are explicit.
765
The user or group and project are specified by the Assessed.
557
768
__storm_table__ = "project_submission"
559
770
id = Int(name="submissionid", primary=True)
561
772
assessed = Reference(assessed_id, Assessed.id)
775
submitter_id = Int(name="submitter")
776
submitter = Reference(submitter_id, User.id)
564
777
date_submitted = DateTime()
567
780
# WORKSHEETS AND EXERCISES #
569
782
class Exercise(Storm):
783
"""An exercise for students to complete in a worksheet.
785
An exercise may be present in any number of worksheets.
570
788
__storm_table__ = "exercise"
571
789
id = Unicode(primary=True, name="identifier")
602
820
perms.add('edit')
603
821
perms.add('view')
604
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
822
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
825
elif u'tutor' in set((e.role for e in user.active_enrolments)):
610
831
def get_description(self):
832
"""Return the description interpreted as reStructuredText."""
611
833
return rst(self.description)
613
835
def delete(self):
619
841
Store.of(self).remove(self)
621
843
class Worksheet(Storm):
844
"""A worksheet with exercises for students to complete.
846
Worksheets are owned by offerings.
622
849
__storm_table__ = "worksheet"
624
851
id = Int(primary=True, name="worksheetid")
649
876
def __repr__(self):
650
877
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
879
def remove_all_exercises(self):
666
Remove all exercises from this worksheet.
880
"""Remove all exercises from this worksheet.
667
882
This does not delete the exercises themselves. It just removes them
668
883
from the worksheet.
673
888
raise IntegrityError()
674
889
store.find(WorksheetExercise,
675
890
WorksheetExercise.worksheet == self).remove()
677
892
def get_permissions(self, user):
678
893
return self.offering.get_permissions(user)
680
895
def get_xml(self):
681
896
"""Returns the xml of this worksheet, converts from rst if required."""
682
897
if self.format == u'rst':
688
903
def delete(self):
689
904
"""Deletes the worksheet, provided it has no attempts on any exercises.
691
906
Returns True if delete succeeded, or False if this worksheet has
692
907
attempts attached."""
693
908
for ws_ex in self.all_worksheet_exercises:
694
909
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
695
910
raise IntegrityError()
697
912
self.remove_all_exercises()
698
913
Store.of(self).remove(self)
700
915
class WorksheetExercise(Storm):
916
"""A link between a worksheet and one of its exercises.
918
These may be marked optional, in which case the exercise does not count
919
for marking purposes. The sequence number is used to order the worksheet
701
923
__storm_table__ = "worksheet_exercise"
703
925
id = Int(primary=True, name="ws_ex_id")
705
927
worksheet_id = Int(name="worksheetid")
722
944
def get_permissions(self, user):
723
945
return self.worksheet.get_permissions(user)
726
948
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
949
"""A potential exercise solution submitted by a user for storage.
951
This is not an actual tested attempt at an exercise, it's just a save of
735
955
__storm_table__ = "exercise_save"
736
956
__storm_primary__ = "ws_ex_id", "user_id"
750
970
self.exercise.name, self.user.login, self.date.strftime("%c"))
752
972
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
973
"""An attempt at solving an exercise.
975
This is a special case of ExerciseSave, used when the user submits a
976
candidate solution. Like an ExerciseSave, it constitutes exercise solution
979
In addition, it contains information about the result of the submission:
981
- complete - True if this submission was successful, rendering this
982
exercise complete for this user in this worksheet.
983
- active - True if this submission is "active" (usually true).
984
Submissions may be de-activated by privileged users for
985
special reasons, and then they won't count (either as a
986
penalty or success), but will still be stored.
765
989
__storm_table__ = "exercise_attempt"
766
990
__storm_primary__ = "ws_ex_id", "user_id", "date"
770
994
text = Unicode(name="attempt")
771
995
complete = Bool()
774
998
def get_permissions(self, user):
775
999
return set(['view']) if user is self.user else set()
777
1001
class TestSuite(Storm):
778
"""A Testsuite acts as a container for the test cases of an exercise."""
1002
"""A container to group an exercise's test cases.
1004
The test suite contains some information on how to test. The function to
1005
test, variables to set and stdin data are stored here.
779
1008
__storm_table__ = "test_suite"
780
1009
__storm_primary__ = "exercise_id", "suiteid"
783
1012
exercise_id = Unicode(name="exerciseid")
784
1013
description = Unicode()
788
1017
exercise = Reference(exercise_id, Exercise.id)
789
1018
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
790
1019
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
792
1021
def delete(self):
793
1022
"""Delete this suite, without asking questions."""
794
for vaariable in self.variables:
1023
for variable in self.variables:
795
1024
variable.delete()
796
1025
for test_case in self.test_cases:
797
1026
test_case.delete()
798
1027
Store.of(self).remove(self)
800
1029
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"""
1030
"""A container for actual tests (see TestCasePart), inside a test suite.
1032
It is the lowest level shown to students on their pass/fail status."""
804
1034
__storm_table__ = "test_case"
805
1035
__storm_primary__ = "testid", "suiteid"
809
1039
suite = Reference(suiteid, "TestSuite.suiteid")
810
1040
passmsg = Unicode()
811
1041
failmsg = Unicode()
812
test_default = Unicode()
1042
test_default = Unicode() # Currently unused - only used for file matching.
815
1045
parts = ReferenceSet(testid, "TestCasePart.testid")
817
1047
__init__ = _kwarg_init
819
1049
def delete(self):
820
1050
for part in self.parts:
822
1052
Store.of(self).remove(self)
824
1054
class TestSuiteVar(Storm):
825
"""A container for the arguments of a Test Suite"""
1055
"""A variable used by an exercise test suite.
1057
This may represent a function argument or a normal variable.
826
1060
__storm_table__ = "suite_variable"
827
1061
__storm_primary__ = "varid"
831
1065
var_name = Unicode()
832
1066
var_value = Unicode()
833
1067
var_type = Unicode()
836
1070
suite = Reference(suiteid, "TestSuite.suiteid")
838
1072
__init__ = _kwarg_init
840
1074
def delete(self):
841
1075
Store.of(self).remove(self)
843
1077
class TestCasePart(Storm):
844
"""A container for the test elements of a Test Case"""
1078
"""An actual piece of code to test an exercise solution."""
845
1080
__storm_table__ = "test_case_part"
846
1081
__storm_primary__ = "partid"
851
1086
part_type = Unicode()
852
1087
test_type = Unicode()
853
1088
data = Unicode()
854
1089
filename = Unicode()
856
1091
test = Reference(testid, "TestCase.testid")
858
1093
__init__ = _kwarg_init
860
1095
def delete(self):
861
1096
Store.of(self).remove(self)
added
removed
ivle/database.py
