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',
39
38
'Subject', 'Semester', 'Offering', 'Enrolment',
40
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
41
'Exercise', 'Worksheet', 'WorksheetExercise',
42
42
'ExerciseSave', 'ExerciseAttempt',
43
43
'TestCase', 'TestSuite', 'TestSuiteVar'
50
50
% (self.__class__.__name__, k))
51
51
setattr(self, k, v)
53
def get_conn_string():
55
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.
60
clusterstr += ivle.conf.db_user
61
if ivle.conf.db_password:
62
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']
65
host = ivle.conf.db_host or 'localhost'
66
port = ivle.conf.db_port or 5432
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
68
69
clusterstr += '%s:%d' % (host, port)
70
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
74
Open a database connection and transaction. Return a storm.store.Store
75
instance connected to the configured IVLE database.
77
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)))
83
Represents an IVLE user.
83
"""An IVLE user account."""
85
84
__storm_table__ = "login"
87
86
id = Int(primary=True, name="loginid")
184
197
'''A sanely ordered list of all of the user's enrolments.'''
185
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)
188
221
def hash_password(password):
189
return md5.md5(password).hexdigest()
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
192
226
def get_by_login(cls, store, login):
194
Get the User from the db associated with a given store and
227
"""Find a user in a store by login name."""
197
228
return store.find(cls, cls.login == unicode(login)).one()
199
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.
200
236
if user and user.admin or user is self:
201
return set(['view', 'edit'])
237
return set(['view_public', 'view', 'edit', 'submit_project'])
239
return set(['view_public'])
205
241
# SUBJECTS AND ENROLMENTS #
207
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
208
246
__storm_table__ = "subject"
210
248
id = Int(primary=True, name="subjectid")
211
249
code = Unicode(name="subj_code")
212
250
name = Unicode(name="subj_name")
213
251
short_name = Unicode(name="subj_short_name")
216
253
offerings = ReferenceSet(id, 'Offering.subject_id')
228
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()
231
293
class Semester(Storm):
294
"""A semester in which subjects can be run."""
232
296
__storm_table__ = "semester"
234
298
id = Int(primary=True, name="semesterid")
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())
317
418
class Enrolment(Storm):
419
"""An enrolment of a user in an offering.
421
This represents the roles of both staff and students.
318
424
__storm_table__ = "enrolment"
319
425
__storm_primary__ = "user_id", "offering_id"
359
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
362
518
class Project(Storm):
519
"""A student project for which submissions can be made."""
363
521
__storm_table__ = "project"
365
523
id = Int(name="projectid", primary=True)
525
short_name = Unicode()
366
526
synopsis = Unicode()
368
528
project_set_id = Int(name="projectsetid")
369
529
project_set = Reference(project_set_id, ProjectSet.id)
370
530
deadline = DateTime()
532
assesseds = ReferenceSet(id, 'Assessed.project_id')
533
submissions = ReferenceSet(id,
534
'Assessed.project_id',
536
'ProjectSubmission.assessed_id')
372
538
__init__ = _kwarg_init
374
540
def __repr__(self):
375
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
541
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
376
542
self.project_set.offering)
544
def can_submit(self, principal):
545
return (self in principal.get_projects() and
546
self.deadline > datetime.datetime.now())
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):
559
raise Exception('cannot submit')
561
a = Assessed.get(Store.of(self), principal, self)
562
ps = ProjectSubmission()
564
ps.revision = revision
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
378
601
class ProjectGroup(Storm):
602
"""A group of students working together on a project."""
379
604
__storm_table__ = "project_group"
381
606
id = Int(name="groupid", primary=True)
398
623
return "<%s %s in %r>" % (type(self).__name__, self.name,
399
624
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
def get_projects(self, offering=None, active_only=True):
637
'''Find projects that the group can submit.
639
This will include projects in the project set which owns this group,
640
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.
646
return Store.of(self).find(Project,
647
Project.project_set_id == ProjectSet.id,
648
ProjectSet.id == self.project_set.id,
649
ProjectSet.max_students_per_group != None,
650
ProjectSet.offering_id == Offering.id,
651
(offering is None) or (Offering.id == offering.id),
652
Semester.id == Offering.semester_id,
653
(not active_only) or (Semester.state == u'current'))
656
def get_permissions(self, user):
657
if user.admin or user in self.members:
658
return set(['submit_project'])
401
662
class ProjectGroupMembership(Storm):
663
"""A student's membership in a project group."""
402
665
__storm_table__ = "group_member"
403
666
__storm_primary__ = "user_id", "project_group_id"
413
676
return "<%s %r in %r>" % (type(self).__name__, self.user,
414
677
self.project_group)
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.
686
__storm_table__ = "assessed"
688
id = Int(name="assessedid", primary=True)
689
user_id = Int(name="loginid")
690
user = Reference(user_id, User.id)
691
project_group_id = Int(name="groupid")
692
project_group = Reference(project_group_id, ProjectGroup.id)
694
project_id = Int(name="projectid")
695
project = Reference(project_id, Project.id)
697
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
698
submissions = ReferenceSet(
699
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
702
return "<%s %r in %r>" % (type(self).__name__,
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
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.
722
if t not in (User, ProjectGroup):
723
raise AssertionError('principal must be User or ProjectGroup')
726
(t is User) or (cls.project_group_id == principal.id),
727
(t is ProjectGroup) or (cls.user_id == principal.id),
728
cls.project_id == project.id).one()
735
a.project_group = principal
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.
748
__storm_table__ = "project_extension"
750
id = Int(name="extensionid", primary=True)
751
assessed_id = Int(name="assessedid")
752
assessed = Reference(assessed_id, Assessed.id)
753
deadline = DateTime()
754
approver_id = Int(name="approver")
755
approver = Reference(approver_id, User.id)
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.
768
__storm_table__ = "project_submission"
770
id = Int(name="submissionid", primary=True)
771
assessed_id = Int(name="assessedid")
772
assessed = Reference(assessed_id, Assessed.id)
775
submitter_id = Int(name="submitter")
776
submitter = Reference(submitter_id, User.id)
777
date_submitted = DateTime()
416
780
# WORKSHEETS AND EXERCISES #
418
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.
419
788
__storm_table__ = "exercise"
420
789
id = Unicode(primary=True, name="identifier")
498
876
def __repr__(self):
499
877
return "<%s %s>" % (type(self).__name__, self.name)
501
# XXX Refactor this - make it an instance method of Subject rather than a
502
# class method of Worksheet. Can't do that now because Subject isn't
503
# linked referentially to the Worksheet.
505
def get_by_name(cls, store, subjectname, worksheetname):
507
Get the Worksheet from the db associated with a given store, subject
508
name and worksheet name.
510
return store.find(cls, cls.subject == unicode(subjectname),
511
cls.name == unicode(worksheetname)).one()
513
879
def remove_all_exercises(self):
515
Remove all exercises from this worksheet.
880
"""Remove all exercises from this worksheet.
516
882
This does not delete the exercises themselves. It just removes them
517
883
from the worksheet.
537
903
def delete(self):
538
904
"""Deletes the worksheet, provided it has no attempts on any exercises.
540
906
Returns True if delete succeeded, or False if this worksheet has
541
907
attempts attached."""
542
908
for ws_ex in self.all_worksheet_exercises:
543
909
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
544
910
raise IntegrityError()
546
912
self.remove_all_exercises()
547
913
Store.of(self).remove(self)
549
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
550
923
__storm_table__ = "worksheet_exercise"
552
925
id = Int(primary=True, name="ws_ex_id")
554
927
worksheet_id = Int(name="worksheetid")
571
944
def get_permissions(self, user):
572
945
return self.worksheet.get_permissions(user)
575
948
class ExerciseSave(Storm):
577
Represents a potential solution to an exercise that a user has submitted
578
to the server for storage.
579
A basic ExerciseSave is just the current saved text for this exercise for
580
this user (doesn't count towards their attempts).
581
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
584
955
__storm_table__ = "exercise_save"
585
956
__storm_primary__ = "ws_ex_id", "user_id"
599
970
self.exercise.name, self.user.login, self.date.strftime("%c"))
601
972
class ExerciseAttempt(ExerciseSave):
603
An ExerciseAttempt is a special case of an ExerciseSave. Like an
604
ExerciseSave, it constitutes exercise solution data that the user has
605
submitted to the server for storage.
606
In addition, it contains additional information about the submission.
607
complete - True if this submission was successful, rendering this exercise
608
complete for this user.
609
active - True if this submission is "active" (usually true). Submissions
610
may be de-activated by privileged users for special reasons, and then
611
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.
614
989
__storm_table__ = "exercise_attempt"
615
990
__storm_primary__ = "ws_ex_id", "user_id", "date"
637
1017
exercise = Reference(exercise_id, Exercise.id)
638
1018
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
639
1019
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
641
1021
def delete(self):
642
1022
"""Delete this suite, without asking questions."""
643
for vaariable in self.variables:
1023
for variable in self.variables:
644
1024
variable.delete()
645
1025
for test_case in self.test_cases:
646
1026
test_case.delete()
647
1027
Store.of(self).remove(self)
649
1029
class TestCase(Storm):
650
"""A TestCase is a member of a TestSuite.
652
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."""
653
1034
__storm_table__ = "test_case"
654
1035
__storm_primary__ = "testid", "suiteid"
658
1039
suite = Reference(suiteid, "TestSuite.suiteid")
659
1040
passmsg = Unicode()
660
1041
failmsg = Unicode()
661
test_default = Unicode()
1042
test_default = Unicode() # Currently unused - only used for file matching.
664
1045
parts = ReferenceSet(testid, "TestCasePart.testid")
666
1047
__init__ = _kwarg_init
668
1049
def delete(self):
669
1050
for part in self.parts:
671
1052
Store.of(self).remove(self)
673
1054
class TestSuiteVar(Storm):
674
"""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.
675
1060
__storm_table__ = "suite_variable"
676
1061
__storm_primary__ = "varid"
680
1065
var_name = Unicode()
681
1066
var_value = Unicode()
682
1067
var_type = Unicode()
685
1070
suite = Reference(suiteid, "TestSuite.suiteid")
687
1072
__init__ = _kwarg_init
689
1074
def delete(self):
690
1075
Store.of(self).remove(self)
692
1077
class TestCasePart(Storm):
693
"""A container for the test elements of a Test Case"""
1078
"""An actual piece of code to test an exercise solution."""
694
1080
__storm_table__ = "test_case_part"
695
1081
__storm_primary__ = "partid"
700
1086
part_type = Unicode()
701
1087
test_type = Unicode()
702
1088
data = Unicode()
703
1089
filename = Unicode()
705
1091
test = Reference(testid, "TestCase.testid")
707
1093
__init__ = _kwarg_init
709
1095
def delete(self):
710
1096
Store.of(self).remove(self)
added
removed
ivle/database.py
