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
32
from storm.exceptions import NotOneError
31
from storm.expr import Select, Max
32
from storm.exceptions import NotOneError, IntegrityError
34
from ivle.worksheet.rst import rst
36
36
__all__ = ['get_store',
38
38
'Subject', 'Semester', 'Offering', 'Enrolment',
39
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
40
41
'Exercise', 'Worksheet', 'WorksheetExercise',
41
42
'ExerciseSave', 'ExerciseAttempt',
42
43
'TestCase', 'TestSuite', 'TestSuiteVar'
49
50
% (self.__class__.__name__, k))
50
51
setattr(self, k, v)
52
def get_conn_string():
54
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.
59
clusterstr += ivle.conf.db_user
60
if ivle.conf.db_password:
61
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']
64
host = ivle.conf.db_host or 'localhost'
65
port = ivle.conf.db_port or 5432
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
67
69
clusterstr += '%s:%d' % (host, port)
69
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
73
Open a database connection and transaction. Return a storm.store.Store
74
instance connected to the configured IVLE database.
76
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)))
82
Represents an IVLE user.
83
"""An IVLE user account."""
84
84
__storm_table__ = "login"
86
86
id = Int(primary=True, name="loginid")
183
197
'''A sanely ordered list of all of the user's enrolments.'''
184
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)
187
221
def hash_password(password):
188
return md5.md5(password).hexdigest()
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
191
226
def get_by_login(cls, store, login):
193
Get the User from the db associated with a given store and
227
"""Find a user in a store by login name."""
196
228
return store.find(cls, cls.login == unicode(login)).one()
198
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.
199
236
if user and user.admin or user is self:
200
return set(['view', 'edit'])
237
return set(['view_public', 'view', 'edit', 'submit_project'])
239
return set(['view_public'])
204
241
# SUBJECTS AND ENROLMENTS #
206
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
207
246
__storm_table__ = "subject"
209
248
id = Int(primary=True, name="subjectid")
227
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()
230
294
class Semester(Storm):
295
"""A semester in which subjects can be run."""
231
297
__storm_table__ = "semester"
233
299
id = Int(primary=True, name="semesterid")
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')
316
400
class Enrolment(Storm):
401
"""An enrolment of a user in an offering.
403
This represents the roles of both staff and students.
317
406
__storm_table__ = "enrolment"
318
407
__storm_primary__ = "user_id", "offering_id"
358
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
361
471
class Project(Storm):
472
"""A student project for which submissions can be made."""
362
474
__storm_table__ = "project"
364
476
id = Int(name="projectid", primary=True)
478
short_name = Unicode()
365
479
synopsis = Unicode()
367
481
project_set_id = Int(name="projectsetid")
368
482
project_set = Reference(project_set_id, ProjectSet.id)
369
483
deadline = DateTime()
485
assesseds = ReferenceSet(id, 'Assessed.project_id')
486
submissions = ReferenceSet(id,
487
'Assessed.project_id',
489
'ProjectSubmission.assessed_id')
371
491
__init__ = _kwarg_init
373
493
def __repr__(self):
374
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
494
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
375
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
377
541
class ProjectGroup(Storm):
542
"""A group of students working together on a project."""
378
544
__storm_table__ = "project_group"
380
546
id = Int(name="groupid", primary=True)
397
563
return "<%s %s in %r>" % (type(self).__name__, self.name,
398
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'])
400
602
class ProjectGroupMembership(Storm):
603
"""A student's membership in a project group."""
401
605
__storm_table__ = "group_member"
402
606
__storm_primary__ = "user_id", "project_group_id"
412
616
return "<%s %r in %r>" % (type(self).__name__, self.user,
413
617
self.project_group)
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.
626
__storm_table__ = "assessed"
628
id = Int(name="assessedid", primary=True)
629
user_id = Int(name="loginid")
630
user = Reference(user_id, User.id)
631
project_group_id = Int(name="groupid")
632
project_group = Reference(project_group_id, ProjectGroup.id)
634
project_id = Int(name="projectid")
635
project = Reference(project_id, Project.id)
637
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
638
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
641
return "<%s %r in %r>" % (type(self).__name__,
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
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.
687
__storm_table__ = "project_extension"
689
id = Int(name="extensionid", primary=True)
690
assessed_id = Int(name="assessedid")
691
assessed = Reference(assessed_id, Assessed.id)
692
deadline = DateTime()
693
approver_id = Int(name="approver")
694
approver = Reference(approver_id, User.id)
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.
707
__storm_table__ = "project_submission"
709
id = Int(name="submissionid", primary=True)
710
assessed_id = Int(name="assessedid")
711
assessed = Reference(assessed_id, Assessed.id)
714
submitter_id = Int(name="submitter")
715
submitter = Reference(submitter_id, User.id)
716
date_submitted = DateTime()
415
719
# WORKSHEETS AND EXERCISES #
417
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.
418
727
__storm_table__ = "exercise"
419
728
id = Unicode(primary=True, name="identifier")
440
754
def get_permissions(self, user):
442
757
if user is not None:
444
759
perms.add('edit')
445
760
perms.add('view')
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)):
770
def get_description(self):
771
"""Return the description interpreted as reStructuredText."""
772
return rst(self.description)
775
"""Deletes the exercise, providing it has no associated worksheets."""
776
if (self.worksheet_exercises.count() > 0):
777
raise IntegrityError()
778
for suite in self.test_suites:
780
Store.of(self).remove(self)
448
782
class Worksheet(Storm):
783
"""A worksheet with exercises for students to complete.
785
Worksheets are owned by offerings.
449
788
__storm_table__ = "worksheet"
451
790
id = Int(primary=True, name="worksheetid")
475
815
def __repr__(self):
476
816
return "<%s %s>" % (type(self).__name__, self.name)
478
# XXX Refactor this - make it an instance method of Subject rather than a
479
# class method of Worksheet. Can't do that now because Subject isn't
480
# linked referentially to the Worksheet.
482
def get_by_name(cls, store, subjectname, worksheetname):
484
Get the Worksheet from the db associated with a given store, subject
485
name and worksheet name.
487
return store.find(cls, cls.subject == unicode(subjectname),
488
cls.name == unicode(worksheetname)).one()
818
def remove_all_exercises(self):
819
"""Remove all exercises from this worksheet.
490
def remove_all_exercises(self, store):
492
Remove all exercises from this worksheet.
493
821
This does not delete the exercises themselves. It just removes them
494
822
from the worksheet.
824
store = Store.of(self)
825
for ws_ex in self.all_worksheet_exercises:
826
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
827
raise IntegrityError()
496
828
store.find(WorksheetExercise,
497
829
WorksheetExercise.worksheet == self).remove()
499
831
def get_permissions(self, user):
500
832
return self.offering.get_permissions(user)
835
"""Returns the xml of this worksheet, converts from rst if required."""
836
if self.format == u'rst':
837
ws_xml = rst(self.data)
843
"""Deletes the worksheet, provided it has no attempts on any exercises.
845
Returns True if delete succeeded, or False if this worksheet has
846
attempts attached."""
847
for ws_ex in self.all_worksheet_exercises:
848
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
849
raise IntegrityError()
851
self.remove_all_exercises()
852
Store.of(self).remove(self)
502
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
503
862
__storm_table__ = "worksheet_exercise"
505
864
id = Int(primary=True, name="ws_ex_id")
507
866
worksheet_id = Int(name="worksheetid")
524
883
def get_permissions(self, user):
525
884
return self.worksheet.get_permissions(user)
527
887
class ExerciseSave(Storm):
529
Represents a potential solution to an exercise that a user has submitted
530
to the server for storage.
531
A basic ExerciseSave is just the current saved text for this exercise for
532
this user (doesn't count towards their attempts).
533
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
536
894
__storm_table__ = "exercise_save"
537
895
__storm_primary__ = "ws_ex_id", "user_id"
551
909
self.exercise.name, self.user.login, self.date.strftime("%c"))
553
911
class ExerciseAttempt(ExerciseSave):
555
An ExerciseAttempt is a special case of an ExerciseSave. Like an
556
ExerciseSave, it constitutes exercise solution data that the user has
557
submitted to the server for storage.
558
In addition, it contains additional information about the submission.
559
complete - True if this submission was successful, rendering this exercise
560
complete for this user.
561
active - True if this submission is "active" (usually true). Submissions
562
may be de-activated by privileged users for special reasons, and then
563
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.
566
928
__storm_table__ = "exercise_attempt"
567
929
__storm_primary__ = "ws_ex_id", "user_id", "date"
571
933
text = Unicode(name="attempt")
572
934
complete = Bool()
575
937
def get_permissions(self, user):
576
938
return set(['view']) if user is self.user else set()
578
940
class TestSuite(Storm):
579
"""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.
580
947
__storm_table__ = "test_suite"
581
948
__storm_primary__ = "exercise_id", "suiteid"
584
951
exercise_id = Unicode(name="exerciseid")
585
952
description = Unicode()
587
954
function = Unicode()
588
955
stdin = Unicode()
589
956
exercise = Reference(exercise_id, Exercise.id)
590
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
591
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
957
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
958
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
961
"""Delete this suite, without asking questions."""
962
for vaariable in self.variables:
964
for test_case in self.test_cases:
966
Store.of(self).remove(self)
593
968
class TestCase(Storm):
594
"""A TestCase is a member of a TestSuite.
596
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."""
597
973
__storm_table__ = "test_case"
598
974
__storm_primary__ = "testid", "suiteid"
602
978
suite = Reference(suiteid, "TestSuite.suiteid")
604
980
failmsg = Unicode()
605
981
test_default = Unicode()
608
984
parts = ReferenceSet(testid, "TestCasePart.testid")
610
986
__init__ = _kwarg_init
989
for part in self.parts:
991
Store.of(self).remove(self)
612
993
class TestSuiteVar(Storm):
613
"""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.
614
999
__storm_table__ = "suite_variable"
615
1000
__storm_primary__ = "varid"
619
1004
var_name = Unicode()
620
1005
var_value = Unicode()
621
1006
var_type = Unicode()
624
1009
suite = Reference(suiteid, "TestSuite.suiteid")
626
1011
__init__ = _kwarg_init
1014
Store.of(self).remove(self)
628
1016
class TestCasePart(Storm):
629
"""A container for the test elements of a Test Case"""
1017
"""An actual piece of code to test an exercise solution."""
630
1019
__storm_table__ = "test_case_part"
631
1020
__storm_primary__ = "partid"
636
1025
part_type = Unicode()
637
1026
test_type = Unicode()
638
1027
data = Unicode()
639
1028
filename = Unicode()
641
1030
test = Reference(testid, "TestCase.testid")
643
1032
__init__ = _kwarg_init
1035
Store.of(self).remove(self)
added
removed
ivle/database.py
