18
18
# Author: Matt Giuca, Will Grant
20
"""Database utilities and content classes.
21
Database Classes and Utilities for Storm ORM
22
23
This module provides all of the classes which map to database tables.
23
24
It also provides miscellaneous utility functions for database interaction.
29
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
30
31
Reference, ReferenceSet, Bool, Storm, Desc
31
from storm.expr import Select, Max
32
32
from storm.exceptions import NotOneError, IntegrityError
34
35
from ivle.worksheet.rst import rst
36
37
__all__ = ['get_store',
50
51
% (self.__class__.__name__, k))
51
52
setattr(self, k, v)
53
def get_conn_string(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
54
def get_conn_string():
56
Returns the Storm connection string, generated from the conf file.
60
if config['database']['username']:
61
clusterstr += config['database']['username']
62
if config['database']['password']:
63
clusterstr += ':' + config['database']['password']
61
clusterstr += ivle.conf.db_user
62
if ivle.conf.db_password:
63
clusterstr += ':' + ivle.conf.db_password
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
66
host = ivle.conf.db_host or 'localhost'
67
port = ivle.conf.db_port or 5432
69
69
clusterstr += '%s:%d' % (host, port)
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)))
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()))
83
"""An IVLE user account."""
84
Represents an IVLE user.
84
86
__storm_table__ = "login"
86
88
id = Int(primary=True, name="loginid")
116
118
return self.hash_password(password) == self.passhash
119
def display_name(self):
120
"""Returns the "nice name" of the user or group."""
124
def short_name(self):
125
"""Returns the database "identifier" name of the user or group."""
129
121
def password_expired(self):
130
122
fieldval = self.pass_exp
131
123
return fieldval is not None and datetime.datetime.now() > fieldval
169
161
# TODO: Invitations should be listed too?
170
162
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.
176
164
ProjectGroupMembership.user_id == self.id,
177
165
ProjectGroup.id == ProjectGroupMembership.project_group_id,
198
186
return self._get_enrolments(False)
200
188
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
189
'''Return Projects that the user can submit.
203
191
This will include projects for offerings in which the user is
204
192
enrolled, as long as the project is not in a project set which has
205
193
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.
195
Unless active_only is False, only projects for active offerings will
198
If an offering is specified, returned projects will be limited to
199
those for that offering.
210
201
return Store.of(self).find(Project,
211
202
Project.project_set_id == ProjectSet.id,
212
ProjectSet.max_students_per_group == None,
203
ProjectSet.max_students_per_group == 0,
213
204
ProjectSet.offering_id == Offering.id,
214
205
(offering is None) or (Offering.id == offering.id),
215
206
Semester.id == Offering.semester_id,
221
212
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
213
return md5.md5(password).hexdigest()
226
216
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
218
Get the User from the db associated with a given store and
228
221
return store.find(cls, cls.login == unicode(login)).one()
230
223
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.
236
224
if user and user.admin or user is self:
237
return set(['view_public', 'view', 'edit', 'submit_project'])
225
return set(['view', 'edit', 'submit_project'])
239
return set(['view_public'])
241
229
# SUBJECTS AND ENROLMENTS #
243
231
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
232
__storm_table__ = "subject"
248
234
id = Int(primary=True, name="subjectid")
249
235
code = Unicode(name="subj_code")
250
236
name = Unicode(name="subj_name")
251
237
short_name = Unicode(name="subj_short_name")
253
240
offerings = ReferenceSet(id, 'Offering.subject_id')
258
245
return "<%s '%s'>" % (type(self).__name__, self.short_name)
260
247
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.
267
249
if user is not None:
268
250
perms.add('view')
270
252
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()
293
255
class Semester(Storm):
294
"""A semester in which subjects can be run."""
296
256
__storm_table__ = "semester"
298
258
id = Int(primary=True, name="semesterid")
312
272
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
314
274
class Offering(Storm):
315
"""An offering of a subject in a particular semester."""
317
275
__storm_table__ = "offering"
319
277
id = Int(primary=True, name="offeringid")
321
279
subject = Reference(subject_id, Subject.id)
322
280
semester_id = Int(name="semesterid")
323
281
semester = Reference(semester_id, Semester.id)
324
description = Unicode()
326
282
groups_student_permissions = Unicode()
328
284
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
331
287
'Enrolment.user_id',
333
289
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
334
projects = ReferenceSet(id,
335
'ProjectSet.offering_id',
337
'Project.project_set_id')
339
291
worksheets = ReferenceSet(id,
340
292
'Worksheet.offering_id',
350
302
def enrol(self, user, role=u'student'):
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.
303
'''Enrol a user in this offering.'''
356
304
enrolment = Store.of(self).find(Enrolment,
357
305
Enrolment.user_id == user.id,
358
306
Enrolment.offering_id == self.id).one()
380
328
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
382
330
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
393
333
def get_enrolment(self, user):
394
"""Find the user's enrolment in this offering."""
396
335
enrolment = self.enrolments.find(user=user).one()
397
336
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())
418
341
class Enrolment(Storm):
419
"""An enrolment of a user in an offering.
421
This represents the roles of both staff and students.
424
342
__storm_table__ = "enrolment"
425
343
__storm_primary__ = "user_id", "offering_id"
451
369
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.
458
370
__storm_table__ = "project_set"
460
372
id = Int(name="projectsetid", primary=True)
471
383
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
518
386
class Project(Storm):
519
"""A student project for which submissions can be made."""
521
387
__storm_table__ = "project"
523
389
id = Int(name="projectid", primary=True)
541
407
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
542
408
self.project_set.offering)
544
def can_submit(self, principal, user):
410
def can_submit(self, principal):
545
411
return (self in principal.get_projects() and
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):
412
self.deadline > datetime.datetime.now())
414
def submit(self, principal, path, revision):
415
if not self.can_submit(principal):
559
416
raise Exception('cannot submit')
561
418
a = Assessed.get(Store.of(self), principal, self)
564
421
ps.revision = revision
565
422
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
601
428
class ProjectGroup(Storm):
602
"""A group of students working together on a project."""
604
429
__storm_table__ = "project_group"
606
431
id = Int(name="groupid", primary=True)
623
448
return "<%s %s in %r>" % (type(self).__name__, self.name,
624
449
self.project_set.offering)
627
def display_name(self):
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."""
636
451
def get_projects(self, offering=None, active_only=True):
637
'''Find projects that the group can submit.
452
'''Return Projects that the group can submit.
639
454
This will include projects in the project set which owns this group,
640
455
unless the project set disallows groups (in which case none will be
643
@param active_only: Whether to only search active offerings.
644
@param offering: An optional offering to restrict the search to.
458
Unless active_only is False, projects will only be returned if the
459
group's offering is active.
461
If an offering is specified, projects will only be returned if it
646
464
return Store.of(self).find(Project,
647
465
Project.project_set_id == ProjectSet.id,
648
466
ProjectSet.id == self.project_set.id,
649
ProjectSet.max_students_per_group != None,
467
ProjectSet.max_students_per_group > 0,
650
468
ProjectSet.offering_id == Offering.id,
651
469
(offering is None) or (Offering.id == offering.id),
652
470
Semester.id == Offering.semester_id,
662
480
class ProjectGroupMembership(Storm):
663
"""A student's membership in a project group."""
665
481
__storm_table__ = "group_member"
666
482
__storm_primary__ = "user_id", "project_group_id"
677
493
self.project_group)
679
495
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.
686
496
__storm_table__ = "assessed"
688
498
id = Int(name="assessedid", primary=True)
695
505
project = Reference(project_id, Project.id)
697
507
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
698
submissions = ReferenceSet(
699
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
508
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
701
510
def __repr__(self):
702
511
return "<%s %r in %r>" % (type(self).__name__,
703
512
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
715
515
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.
721
516
t = type(principal)
722
517
if t not in (User, ProjectGroup):
723
518
raise AssertionError('principal must be User or ProjectGroup')
725
520
a = store.find(cls,
726
521
(t is User) or (cls.project_group_id == principal.id),
727
522
(t is ProjectGroup) or (cls.user_id == principal.id),
728
cls.project_id == project.id).one()
523
Project.id == project.id).one()
742
537
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.
748
538
__storm_table__ = "project_extension"
750
540
id = Int(name="extensionid", primary=True)
756
546
notes = Unicode()
758
548
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.
768
549
__storm_table__ = "project_submission"
770
551
id = Int(name="submissionid", primary=True)
772
553
assessed = Reference(assessed_id, Assessed.id)
775
submitter_id = Int(name="submitter")
776
submitter = Reference(submitter_id, User.id)
777
556
date_submitted = DateTime()
780
559
# WORKSHEETS AND EXERCISES #
782
561
class Exercise(Storm):
783
"""An exercise for students to complete in a worksheet.
785
An exercise may be present in any number of worksheets.
788
562
__storm_table__ = "exercise"
789
563
id = Unicode(primary=True, name="identifier")
820
594
perms.add('edit')
821
595
perms.add('view')
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)):
596
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
831
602
def get_description(self):
832
"""Return the description interpreted as reStructuredText."""
833
603
return rst(self.description)
835
605
def delete(self):
841
611
Store.of(self).remove(self)
843
613
class Worksheet(Storm):
844
"""A worksheet with exercises for students to complete.
846
Worksheets are owned by offerings.
849
614
__storm_table__ = "worksheet"
851
616
id = Int(primary=True, name="worksheetid")
876
641
def __repr__(self):
877
642
return "<%s %s>" % (type(self).__name__, self.name)
644
# XXX Refactor this - make it an instance method of Subject rather than a
645
# class method of Worksheet. Can't do that now because Subject isn't
646
# linked referentially to the Worksheet.
648
def get_by_name(cls, store, subjectname, worksheetname):
650
Get the Worksheet from the db associated with a given store, subject
651
name and worksheet name.
653
return store.find(cls, cls.subject == unicode(subjectname),
654
cls.name == unicode(worksheetname)).one()
879
656
def remove_all_exercises(self):
880
"""Remove all exercises from this worksheet.
658
Remove all exercises from this worksheet.
882
659
This does not delete the exercises themselves. It just removes them
883
660
from the worksheet.
888
665
raise IntegrityError()
889
666
store.find(WorksheetExercise,
890
667
WorksheetExercise.worksheet == self).remove()
892
669
def get_permissions(self, user):
893
670
return self.offering.get_permissions(user)
895
672
def get_xml(self):
896
673
"""Returns the xml of this worksheet, converts from rst if required."""
897
674
if self.format == u'rst':
903
680
def delete(self):
904
681
"""Deletes the worksheet, provided it has no attempts on any exercises.
906
683
Returns True if delete succeeded, or False if this worksheet has
907
684
attempts attached."""
908
685
for ws_ex in self.all_worksheet_exercises:
909
686
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
910
687
raise IntegrityError()
912
689
self.remove_all_exercises()
913
690
Store.of(self).remove(self)
915
692
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
923
693
__storm_table__ = "worksheet_exercise"
925
695
id = Int(primary=True, name="ws_ex_id")
927
697
worksheet_id = Int(name="worksheetid")
944
714
def get_permissions(self, user):
945
715
return self.worksheet.get_permissions(user)
948
718
class ExerciseSave(Storm):
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
720
Represents a potential solution to an exercise that a user has submitted
721
to the server for storage.
722
A basic ExerciseSave is just the current saved text for this exercise for
723
this user (doesn't count towards their attempts).
724
ExerciseSave may be extended with additional semantics (such as
955
727
__storm_table__ = "exercise_save"
956
728
__storm_primary__ = "ws_ex_id", "user_id"
970
742
self.exercise.name, self.user.login, self.date.strftime("%c"))
972
744
class ExerciseAttempt(ExerciseSave):
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.
746
An ExerciseAttempt is a special case of an ExerciseSave. Like an
747
ExerciseSave, it constitutes exercise solution data that the user has
748
submitted to the server for storage.
749
In addition, it contains additional information about the submission.
750
complete - True if this submission was successful, rendering this exercise
751
complete for this user.
752
active - True if this submission is "active" (usually true). Submissions
753
may be de-activated by privileged users for special reasons, and then
754
they won't count (either as a penalty or success), but will still be
989
757
__storm_table__ = "exercise_attempt"
990
758
__storm_primary__ = "ws_ex_id", "user_id", "date"
994
762
text = Unicode(name="attempt")
995
763
complete = Bool()
998
766
def get_permissions(self, user):
999
767
return set(['view']) if user is self.user else set()
1001
769
class TestSuite(Storm):
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.
770
"""A Testsuite acts as a container for the test cases of an exercise."""
1008
771
__storm_table__ = "test_suite"
1009
772
__storm_primary__ = "exercise_id", "suiteid"
1012
775
exercise_id = Unicode(name="exerciseid")
1013
776
description = Unicode()
1017
780
exercise = Reference(exercise_id, Exercise.id)
1018
781
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1019
782
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1021
784
def delete(self):
1022
785
"""Delete this suite, without asking questions."""
1023
for variable in self.variables:
786
for vaariable in self.variables:
1024
787
variable.delete()
1025
788
for test_case in self.test_cases:
1026
789
test_case.delete()
1027
790
Store.of(self).remove(self)
1029
792
class TestCase(Storm):
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."""
793
"""A TestCase is a member of a TestSuite.
795
It contains the data necessary to check if an exercise is correct"""
1034
796
__storm_table__ = "test_case"
1035
797
__storm_primary__ = "testid", "suiteid"
1039
801
suite = Reference(suiteid, "TestSuite.suiteid")
1040
802
passmsg = Unicode()
1041
803
failmsg = Unicode()
1042
test_default = Unicode() # Currently unused - only used for file matching.
804
test_default = Unicode()
1045
807
parts = ReferenceSet(testid, "TestCasePart.testid")
1047
809
__init__ = _kwarg_init
1049
811
def delete(self):
1050
812
for part in self.parts:
1052
814
Store.of(self).remove(self)
1054
816
class TestSuiteVar(Storm):
1055
"""A variable used by an exercise test suite.
1057
This may represent a function argument or a normal variable.
817
"""A container for the arguments of a Test Suite"""
1060
818
__storm_table__ = "suite_variable"
1061
819
__storm_primary__ = "varid"
1065
823
var_name = Unicode()
1066
824
var_value = Unicode()
1067
825
var_type = Unicode()
1070
828
suite = Reference(suiteid, "TestSuite.suiteid")
1072
830
__init__ = _kwarg_init
1074
832
def delete(self):
1075
833
Store.of(self).remove(self)
1077
835
class TestCasePart(Storm):
1078
"""An actual piece of code to test an exercise solution."""
836
"""A container for the test elements of a Test Case"""
1080
837
__storm_table__ = "test_case_part"
1081
838
__storm_primary__ = "partid"
1086
843
part_type = Unicode()
1087
844
test_type = Unicode()
1088
845
data = Unicode()
1089
846
filename = Unicode()
1091
848
test = Reference(testid, "TestCase.testid")
1093
850
__init__ = _kwarg_init
1095
852
def delete(self):
1096
853
Store.of(self).remove(self)
added
removed
ivle/database.py
