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")
161
169
# TODO: Invitations should be listed too?
162
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.
164
176
ProjectGroupMembership.user_id == self.id,
165
177
ProjectGroup.id == ProjectGroupMembership.project_group_id,
185
197
'''A sanely ordered list of all of the user's enrolments.'''
186
198
return self._get_enrolments(False)
200
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
203
This will include projects for offerings in which the user is
204
enrolled, as long as the project is not in a project set which has
205
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.
210
return Store.of(self).find(Project,
211
Project.project_set_id == ProjectSet.id,
212
ProjectSet.max_students_per_group == None,
213
ProjectSet.offering_id == Offering.id,
214
(offering is None) or (Offering.id == offering.id),
215
Semester.id == Offering.semester_id,
216
(not active_only) or (Semester.state == u'current'),
217
Enrolment.offering_id == Offering.id,
218
Enrolment.user_id == self.id)
189
221
def hash_password(password):
190
return md5.md5(password).hexdigest()
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
193
226
def get_by_login(cls, store, login):
195
Get the User from the db associated with a given store and
227
"""Find a user in a store by login name."""
198
228
return store.find(cls, cls.login == unicode(login)).one()
200
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.
201
236
if user and user.admin or user is self:
202
return set(['view', 'edit'])
237
return set(['view', 'edit', 'submit_project'])
206
241
# SUBJECTS AND ENROLMENTS #
208
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
209
246
__storm_table__ = "subject"
211
248
id = Int(primary=True, name="subjectid")
222
259
return "<%s '%s'>" % (type(self).__name__, self.short_name)
224
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.
226
268
if user is not None:
227
269
perms.add('view')
229
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()
232
294
class Semester(Storm):
295
"""A semester in which subjects can be run."""
233
297
__storm_table__ = "semester"
235
299
id = Int(primary=True, name="semesterid")
279
345
def enrol(self, user, role=u'student'):
280
'''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.
281
351
enrolment = Store.of(self).find(Enrolment,
282
352
Enrolment.user_id == user.id,
283
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')
318
400
class Enrolment(Storm):
401
"""An enrolment of a user in an offering.
403
This represents the roles of both staff and students.
319
406
__storm_table__ = "enrolment"
320
407
__storm_primary__ = "user_id", "offering_id"
360
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
363
471
class Project(Storm):
472
"""A student project for which submissions can be made."""
364
474
__storm_table__ = "project"
366
476
id = Int(name="projectid", primary=True)
384
494
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
385
495
self.project_set.offering)
497
def can_submit(self, principal):
498
return (self in principal.get_projects() and
499
self.deadline > datetime.datetime.now())
501
def submit(self, principal, path, revision, who):
502
"""Submit a Subversion path and revision to a project.
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.
511
if not self.can_submit(principal):
512
raise Exception('cannot submit')
514
a = Assessed.get(Store.of(self), principal, self)
515
ps = ProjectSubmission()
517
ps.revision = revision
518
ps.date_submitted = datetime.datetime.now()
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
387
541
class ProjectGroup(Storm):
542
"""A group of students working together on a project."""
388
544
__storm_table__ = "project_group"
390
546
id = Int(name="groupid", primary=True)
407
563
return "<%s %s in %r>" % (type(self).__name__, self.name,
408
564
self.project_set.offering)
567
def display_name(self):
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."""
576
def get_projects(self, offering=None, active_only=True):
577
'''Find projects that the group can submit.
579
This will include projects in the project set which owns this group,
580
unless the project set disallows groups (in which case none will be
583
@param active_only: Whether to only search active offerings.
584
@param offering: An optional offering to restrict the search to.
586
return Store.of(self).find(Project,
587
Project.project_set_id == ProjectSet.id,
588
ProjectSet.id == self.project_set.id,
589
ProjectSet.max_students_per_group != None,
590
ProjectSet.offering_id == Offering.id,
591
(offering is None) or (Offering.id == offering.id),
592
Semester.id == Offering.semester_id,
593
(not active_only) or (Semester.state == u'current'))
596
def get_permissions(self, user):
597
if user.admin or user in self.members:
598
return set(['submit_project'])
410
602
class ProjectGroupMembership(Storm):
603
"""A student's membership in a project group."""
411
605
__storm_table__ = "group_member"
412
606
__storm_primary__ = "user_id", "project_group_id"
441
641
return "<%s %r in %r>" % (type(self).__name__,
442
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
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.
661
if t not in (User, ProjectGroup):
662
raise AssertionError('principal must be User or ProjectGroup')
665
(t is User) or (cls.project_group_id == principal.id),
666
(t is ProjectGroup) or (cls.user_id == principal.id),
667
Project.id == project.id).one()
674
a.project_group = principal
444
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.
445
687
__storm_table__ = "project_extension"
447
689
id = Int(name="extensionid", primary=True)
453
695
notes = Unicode()
455
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.
456
707
__storm_table__ = "project_submission"
458
709
id = Int(name="submissionid", primary=True)
460
711
assessed = Reference(assessed_id, Assessed.id)
714
submitter_id = Int(name="submitter")
715
submitter = Reference(submitter_id, User.id)
463
716
date_submitted = DateTime()
466
719
# WORKSHEETS AND EXERCISES #
468
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.
469
727
__storm_table__ = "exercise"
470
728
id = Unicode(primary=True, name="identifier")
501
759
perms.add('edit')
502
760
perms.add('view')
503
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)):
509
770
def get_description(self):
771
"""Return the description interpreted as reStructuredText."""
510
772
return rst(self.description)
512
774
def delete(self):
548
815
def __repr__(self):
549
816
return "<%s %s>" % (type(self).__name__, self.name)
551
# XXX Refactor this - make it an instance method of Subject rather than a
552
# class method of Worksheet. Can't do that now because Subject isn't
553
# linked referentially to the Worksheet.
555
def get_by_name(cls, store, subjectname, worksheetname):
557
Get the Worksheet from the db associated with a given store, subject
558
name and worksheet name.
560
return store.find(cls, cls.subject == unicode(subjectname),
561
cls.name == unicode(worksheetname)).one()
563
818
def remove_all_exercises(self):
565
Remove all exercises from this worksheet.
819
"""Remove all exercises from this worksheet.
566
821
This does not delete the exercises themselves. It just removes them
567
822
from the worksheet.
572
827
raise IntegrityError()
573
828
store.find(WorksheetExercise,
574
829
WorksheetExercise.worksheet == self).remove()
576
831
def get_permissions(self, user):
577
832
return self.offering.get_permissions(user)
579
834
def get_xml(self):
580
835
"""Returns the xml of this worksheet, converts from rst if required."""
581
836
if self.format == u'rst':
587
842
def delete(self):
588
843
"""Deletes the worksheet, provided it has no attempts on any exercises.
590
845
Returns True if delete succeeded, or False if this worksheet has
591
846
attempts attached."""
592
847
for ws_ex in self.all_worksheet_exercises:
593
848
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
594
849
raise IntegrityError()
596
851
self.remove_all_exercises()
597
852
Store.of(self).remove(self)
599
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
600
862
__storm_table__ = "worksheet_exercise"
602
864
id = Int(primary=True, name="ws_ex_id")
604
866
worksheet_id = Int(name="worksheetid")
621
883
def get_permissions(self, user):
622
884
return self.worksheet.get_permissions(user)
625
887
class ExerciseSave(Storm):
627
Represents a potential solution to an exercise that a user has submitted
628
to the server for storage.
629
A basic ExerciseSave is just the current saved text for this exercise for
630
this user (doesn't count towards their attempts).
631
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
634
894
__storm_table__ = "exercise_save"
635
895
__storm_primary__ = "ws_ex_id", "user_id"
649
909
self.exercise.name, self.user.login, self.date.strftime("%c"))
651
911
class ExerciseAttempt(ExerciseSave):
653
An ExerciseAttempt is a special case of an ExerciseSave. Like an
654
ExerciseSave, it constitutes exercise solution data that the user has
655
submitted to the server for storage.
656
In addition, it contains additional information about the submission.
657
complete - True if this submission was successful, rendering this exercise
658
complete for this user.
659
active - True if this submission is "active" (usually true). Submissions
660
may be de-activated by privileged users for special reasons, and then
661
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.
664
928
__storm_table__ = "exercise_attempt"
665
929
__storm_primary__ = "ws_ex_id", "user_id", "date"
669
933
text = Unicode(name="attempt")
670
934
complete = Bool()
673
937
def get_permissions(self, user):
674
938
return set(['view']) if user is self.user else set()
676
940
class TestSuite(Storm):
677
"""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.
678
947
__storm_table__ = "test_suite"
679
948
__storm_primary__ = "exercise_id", "suiteid"
682
951
exercise_id = Unicode(name="exerciseid")
683
952
description = Unicode()
687
956
exercise = Reference(exercise_id, Exercise.id)
688
957
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
689
958
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
691
960
def delete(self):
692
961
"""Delete this suite, without asking questions."""
693
962
for vaariable in self.variables:
697
966
Store.of(self).remove(self)
699
968
class TestCase(Storm):
700
"""A TestCase is a member of a TestSuite.
702
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."""
703
973
__storm_table__ = "test_case"
704
974
__storm_primary__ = "testid", "suiteid"
708
978
suite = Reference(suiteid, "TestSuite.suiteid")
710
980
failmsg = Unicode()
711
981
test_default = Unicode()
714
984
parts = ReferenceSet(testid, "TestCasePart.testid")
716
986
__init__ = _kwarg_init
718
988
def delete(self):
719
989
for part in self.parts:
721
991
Store.of(self).remove(self)
723
993
class TestSuiteVar(Storm):
724
"""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.
725
999
__storm_table__ = "suite_variable"
726
1000
__storm_primary__ = "varid"
730
1004
var_name = Unicode()
731
1005
var_value = Unicode()
732
1006
var_type = Unicode()
735
1009
suite = Reference(suiteid, "TestSuite.suiteid")
737
1011
__init__ = _kwarg_init
739
1013
def delete(self):
740
1014
Store.of(self).remove(self)
742
1016
class TestCasePart(Storm):
743
"""A container for the test elements of a Test Case"""
1017
"""An actual piece of code to test an exercise solution."""
744
1019
__storm_table__ = "test_case_part"
745
1020
__storm_primary__ = "partid"
750
1025
part_type = Unicode()
751
1026
test_type = Unicode()
752
1027
data = Unicode()
753
1028
filename = Unicode()
755
1030
test = Reference(testid, "TestCase.testid")
757
1032
__init__ = _kwarg_init
759
1034
def delete(self):
760
1035
Store.of(self).remove(self)