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")
121
119
def display_name(self):
120
"""Returns the "nice name" of the user or group."""
122
121
return self.fullname
124
def short_name(self):
125
"""Returns the database "identifier" name of the user or group."""
125
129
def password_expired(self):
126
130
fieldval = self.pass_exp
127
131
return fieldval is not None and datetime.datetime.now() > fieldval
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
212
ProjectSet.max_students_per_group == None,
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")
249
259
return "<%s '%s'>" % (type(self).__name__, self.short_name)
251
261
def get_permissions(self, user):
262
"""Determine privileges held by a user over this object.
264
If the user requesting privileges is an admin, they may edit.
265
Otherwise they may only read.
253
268
if user is not None:
254
269
perms.add('view')
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")
276
313
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
278
315
class Offering(Storm):
316
"""An offering of a subject in a particular semester."""
279
318
__storm_table__ = "offering"
281
320
id = Int(primary=True, name="offeringid")
306
345
def enrol(self, user, role=u'student'):
307
'''Enrol a user in this offering.'''
346
"""Enrol a user in this offering.
348
Enrolments handle both the staff and student cases. The role controls
349
the privileges granted by this enrolment.
308
351
enrolment = Store.of(self).find(Enrolment,
309
352
Enrolment.user_id == user.id,
310
353
Enrolment.offering_id == self.id).one()
389
def get_members_by_role(self, role):
390
return Store.of(self).find(User,
391
Enrolment.user_id == User.id,
392
Enrolment.offering_id == self.id,
393
Enrolment.role == role
398
return self.get_members_by_role(u'student')
345
400
class Enrolment(Storm):
401
"""An enrolment of a user in an offering.
403
This represents the roles of both staff and students.
346
406
__storm_table__ = "enrolment"
347
407
__storm_primary__ = "user_id", "offering_id"
373
433
class ProjectSet(Storm):
434
"""A set of projects that share common groups.
436
Each student project group is attached to a project set. The group is
437
valid for all projects in the group's set.
374
440
__storm_table__ = "project_set"
376
442
id = Int(name="projectsetid", primary=True)
387
453
return "<%s %d in %r>" % (type(self).__name__, self.id,
456
def get_permissions(self, user):
457
return self.offering.get_permissions(user)
461
"""Get the entities (groups or users) assigned to submit this project.
463
This will be a Storm ResultSet.
465
#If its a solo project, return everyone in offering
466
if self.max_students_per_group is None:
467
return self.offering.students
469
return self.project_groups
390
471
class Project(Storm):
472
"""A student project for which submissions can be made."""
391
474
__storm_table__ = "project"
393
476
id = Int(name="projectid", primary=True)
418
501
def submit(self, principal, path, revision, who):
419
502
"""Submit a Subversion path and revision to a project.
421
'principal' is the owner of the Subversion repository, and the
422
entity on behalf of whom the submission is being made. 'path' is
423
a path within that repository, and 'revision' specifies which
424
revision of that path. 'who' is the person making the submission.
504
@param principal: The owner of the Subversion repository, and the
505
entity on behalf of whom the submission is being made
506
@param path: A path within that repository to submit.
507
@param revision: The revision of that path to submit.
508
@param who: The user who is actually making the submission.
427
511
if not self.can_submit(principal):
524
def get_permissions(self, user):
525
return self.project_set.offering.get_permissions(user)
528
def latest_submissions(self):
529
"""Return the latest submission for each Assessed."""
530
return Store.of(self).find(ProjectSubmission,
531
Assessed.project_id == self.id,
532
ProjectSubmission.assessed_id == Assessed.id,
533
ProjectSubmission.date_submitted == Select(
534
Max(ProjectSubmission.date_submitted),
535
ProjectSubmission.assessed_id == Assessed.id,
536
tables=ProjectSubmission
441
541
class ProjectGroup(Storm):
542
"""A group of students working together on a project."""
442
544
__storm_table__ = "project_group"
444
546
id = Int(name="groupid", primary=True)
465
567
def display_name(self):
466
return '%s (%s)' % (self.nick, self.name)
568
"""Returns the "nice name" of the user or group."""
572
def short_name(self):
573
"""Returns the database "identifier" name of the user or group."""
468
576
def get_projects(self, offering=None, active_only=True):
469
'''Return Projects that the group can submit.
577
'''Find projects that the group can submit.
471
579
This will include projects in the project set which owns this group,
472
580
unless the project set disallows groups (in which case none will be
475
Unless active_only is False, projects will only be returned if the
476
group's offering is active.
478
If an offering is specified, projects will only be returned if it
583
@param active_only: Whether to only search active offerings.
584
@param offering: An optional offering to restrict the search to.
481
586
return Store.of(self).find(Project,
482
587
Project.project_set_id == ProjectSet.id,
497
602
class ProjectGroupMembership(Storm):
603
"""A student's membership in a project group."""
498
605
__storm_table__ = "group_member"
499
606
__storm_primary__ = "user_id", "project_group_id"
510
617
self.project_group)
512
619
class Assessed(Storm):
620
"""A composite of a user or group combined with a project.
622
Each project submission and extension refers to an Assessed. It is the
623
sole specifier of the repository and project.
513
626
__storm_table__ = "assessed"
515
628
id = Int(name="assessedid", primary=True)
528
641
return "<%s %r in %r>" % (type(self).__name__,
529
642
self.user or self.project_group, self.project)
646
"""True if the Assessed is a group, False if it is a user."""
647
return self.project_group is not None
651
return self.project_group or self.user
532
654
def get(cls, store, principal, project):
655
"""Find or create an Assessed for the given user or group and project.
657
@param principal: The user or group.
658
@param project: The project.
533
660
t = type(principal)
534
661
if t not in (User, ProjectGroup):
535
662
raise AssertionError('principal must be User or ProjectGroup')
554
681
class ProjectExtension(Storm):
682
"""An extension granted to a user or group on a particular project.
684
The user or group and project are specified by the Assessed.
555
687
__storm_table__ = "project_extension"
557
689
id = Int(name="extensionid", primary=True)
563
695
notes = Unicode()
565
697
class ProjectSubmission(Storm):
698
"""A submission from a user or group repository to a particular project.
700
The content of a submission is a single path and revision inside a
701
repository. The repository is that owned by the submission's user and
702
group, while the path and revision are explicit.
704
The user or group and project are specified by the Assessed.
566
707
__storm_table__ = "project_submission"
568
709
id = Int(name="submissionid", primary=True)
578
719
# WORKSHEETS AND EXERCISES #
580
721
class Exercise(Storm):
722
"""An exercise for students to complete in a worksheet.
724
An exercise may be present in any number of worksheets.
581
727
__storm_table__ = "exercise"
582
728
id = Unicode(primary=True, name="identifier")
613
759
perms.add('edit')
614
760
perms.add('view')
615
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
761
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
764
elif u'tutor' in set((e.role for e in user.active_enrolments)):
621
770
def get_description(self):
771
"""Return the description interpreted as reStructuredText."""
622
772
return rst(self.description)
624
774
def delete(self):
630
780
Store.of(self).remove(self)
632
782
class Worksheet(Storm):
783
"""A worksheet with exercises for students to complete.
785
Worksheets are owned by offerings.
633
788
__storm_table__ = "worksheet"
635
790
id = Int(primary=True, name="worksheetid")
660
815
def __repr__(self):
661
816
return "<%s %s>" % (type(self).__name__, self.name)
663
# XXX Refactor this - make it an instance method of Subject rather than a
664
# class method of Worksheet. Can't do that now because Subject isn't
665
# linked referentially to the Worksheet.
667
def get_by_name(cls, store, subjectname, worksheetname):
669
Get the Worksheet from the db associated with a given store, subject
670
name and worksheet name.
672
return store.find(cls, cls.subject == unicode(subjectname),
673
cls.name == unicode(worksheetname)).one()
675
818
def remove_all_exercises(self):
677
Remove all exercises from this worksheet.
819
"""Remove all exercises from this worksheet.
678
821
This does not delete the exercises themselves. It just removes them
679
822
from the worksheet.
684
827
raise IntegrityError()
685
828
store.find(WorksheetExercise,
686
829
WorksheetExercise.worksheet == self).remove()
688
831
def get_permissions(self, user):
689
832
return self.offering.get_permissions(user)
691
834
def get_xml(self):
692
835
"""Returns the xml of this worksheet, converts from rst if required."""
693
836
if self.format == u'rst':
699
842
def delete(self):
700
843
"""Deletes the worksheet, provided it has no attempts on any exercises.
702
845
Returns True if delete succeeded, or False if this worksheet has
703
846
attempts attached."""
704
847
for ws_ex in self.all_worksheet_exercises:
705
848
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
706
849
raise IntegrityError()
708
851
self.remove_all_exercises()
709
852
Store.of(self).remove(self)
711
854
class WorksheetExercise(Storm):
855
"""A link between a worksheet and one of its exercises.
857
These may be marked optional, in which case the exercise does not count
858
for marking purposes. The sequence number is used to order the worksheet
712
862
__storm_table__ = "worksheet_exercise"
714
864
id = Int(primary=True, name="ws_ex_id")
716
866
worksheet_id = Int(name="worksheetid")
733
883
def get_permissions(self, user):
734
884
return self.worksheet.get_permissions(user)
737
887
class ExerciseSave(Storm):
739
Represents a potential solution to an exercise that a user has submitted
740
to the server for storage.
741
A basic ExerciseSave is just the current saved text for this exercise for
742
this user (doesn't count towards their attempts).
743
ExerciseSave may be extended with additional semantics (such as
888
"""A potential exercise solution submitted by a user for storage.
890
This is not an actual tested attempt at an exercise, it's just a save of
746
894
__storm_table__ = "exercise_save"
747
895
__storm_primary__ = "ws_ex_id", "user_id"
761
909
self.exercise.name, self.user.login, self.date.strftime("%c"))
763
911
class ExerciseAttempt(ExerciseSave):
765
An ExerciseAttempt is a special case of an ExerciseSave. Like an
766
ExerciseSave, it constitutes exercise solution data that the user has
767
submitted to the server for storage.
768
In addition, it contains additional information about the submission.
769
complete - True if this submission was successful, rendering this exercise
770
complete for this user.
771
active - True if this submission is "active" (usually true). Submissions
772
may be de-activated by privileged users for special reasons, and then
773
they won't count (either as a penalty or success), but will still be
912
"""An attempt at solving an exercise.
914
This is a special case of ExerciseSave, used when the user submits a
915
candidate solution. Like an ExerciseSave, it constitutes exercise solution
918
In addition, it contains information about the result of the submission:
920
- complete - True if this submission was successful, rendering this
921
exercise complete for this user in this worksheet.
922
- active - True if this submission is "active" (usually true).
923
Submissions may be de-activated by privileged users for
924
special reasons, and then they won't count (either as a
925
penalty or success), but will still be stored.
776
928
__storm_table__ = "exercise_attempt"
777
929
__storm_primary__ = "ws_ex_id", "user_id", "date"
781
933
text = Unicode(name="attempt")
782
934
complete = Bool()
785
937
def get_permissions(self, user):
786
938
return set(['view']) if user is self.user else set()
788
940
class TestSuite(Storm):
789
"""A Testsuite acts as a container for the test cases of an exercise."""
941
"""A container to group an exercise's test cases.
943
The test suite contains some information on how to test. The function to
944
test, variables to set and stdin data are stored here.
790
947
__storm_table__ = "test_suite"
791
948
__storm_primary__ = "exercise_id", "suiteid"
794
951
exercise_id = Unicode(name="exerciseid")
795
952
description = Unicode()
799
956
exercise = Reference(exercise_id, Exercise.id)
800
957
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
801
958
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
803
960
def delete(self):
804
961
"""Delete this suite, without asking questions."""
805
962
for vaariable in self.variables:
809
966
Store.of(self).remove(self)
811
968
class TestCase(Storm):
812
"""A TestCase is a member of a TestSuite.
814
It contains the data necessary to check if an exercise is correct"""
969
"""A container for actual tests (see TestCasePart), inside a test suite.
971
It is the lowest level shown to students on their pass/fail status."""
815
973
__storm_table__ = "test_case"
816
974
__storm_primary__ = "testid", "suiteid"
820
978
suite = Reference(suiteid, "TestSuite.suiteid")
822
980
failmsg = Unicode()
823
981
test_default = Unicode()
826
984
parts = ReferenceSet(testid, "TestCasePart.testid")
828
986
__init__ = _kwarg_init
830
988
def delete(self):
831
989
for part in self.parts:
833
991
Store.of(self).remove(self)
835
993
class TestSuiteVar(Storm):
836
"""A container for the arguments of a Test Suite"""
994
"""A variable used by an exercise test suite.
996
This may represent a function argument or a normal variable.
837
999
__storm_table__ = "suite_variable"
838
1000
__storm_primary__ = "varid"
842
1004
var_name = Unicode()
843
1005
var_value = Unicode()
844
1006
var_type = Unicode()
847
1009
suite = Reference(suiteid, "TestSuite.suiteid")
849
1011
__init__ = _kwarg_init
851
1013
def delete(self):
852
1014
Store.of(self).remove(self)
854
1016
class TestCasePart(Storm):
855
"""A container for the test elements of a Test Case"""
1017
"""An actual piece of code to test an exercise solution."""
856
1019
__storm_table__ = "test_case_part"
857
1020
__storm_primary__ = "partid"
862
1025
part_type = Unicode()
863
1026
test_type = Unicode()
864
1027
data = Unicode()
865
1028
filename = Unicode()
867
1030
test = Reference(testid, "TestCase.testid")
869
1032
__init__ = _kwarg_init
871
1034
def delete(self):
872
1035
Store.of(self).remove(self)
added
removed
ivle/database.py
