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',
38
39
'Subject', 'Semester', 'Offering', 'Enrolment',
39
40
'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(config):
54
"""Create a Storm connection string to the IVLE database
56
@param config: The IVLE configuration.
53
def get_conn_string():
55
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']
60
clusterstr += ivle.conf.db_user
61
if ivle.conf.db_password:
62
clusterstr += ':' + ivle.conf.db_password
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
65
host = ivle.conf.db_host or 'localhost'
66
port = ivle.conf.db_port or 5432
69
68
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)))
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()))
83
"""An IVLE user account."""
83
Represents an IVLE user.
84
85
__storm_table__ = "login"
86
87
id = Int(primary=True, name="loginid")
197
184
'''A sanely ordered list of all of the user's enrolments.'''
198
185
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,
219
Enrolment.active == True)
222
188
def hash_password(password):
223
"""Hash a password with MD5."""
224
return hashlib.md5(password).hexdigest()
189
return md5.md5(password).hexdigest()
227
192
def get_by_login(cls, store, login):
228
"""Find a user in a store by login name."""
194
Get the User from the db associated with a given store and
229
197
return store.find(cls, cls.login == unicode(login)).one()
231
def get_permissions(self, user, config):
232
"""Determine privileges held by a user over this object.
234
If the user requesting privileges is this user or an admin,
235
they may do everything. Otherwise they may do nothing.
199
def get_permissions(self, user):
237
200
if user and user.admin or user is self:
238
return set(['view_public', 'view', 'edit', 'submit_project'])
201
return set(['view', 'edit'])
240
return set(['view_public'])
242
205
# SUBJECTS AND ENROLMENTS #
244
207
class Subject(Storm):
245
"""A subject (or course) which is run in some semesters."""
247
208
__storm_table__ = "subject"
249
210
id = Int(primary=True, name="subjectid")
250
211
code = Unicode(name="subj_code")
251
212
name = Unicode(name="subj_name")
252
213
short_name = Unicode(name="subj_short_name")
254
216
offerings = ReferenceSet(id, 'Offering.subject_id')
271
228
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()
294
231
class Semester(Storm):
295
"""A semester in which subjects can be run."""
297
232
__storm_table__ = "semester"
299
234
id = Int(primary=True, name="semesterid")
372
295
Enrolment.offering_id == self.id).one()
373
296
Store.of(enrolment).remove(enrolment)
375
def get_permissions(self, user, config):
298
def get_permissions(self, user):
377
300
if user is not None:
378
301
enrolment = self.get_enrolment(user)
379
302
if enrolment or user.admin:
380
303
perms.add('view')
381
if enrolment and enrolment.role == u'tutor':
382
perms.add('view_project_submissions')
383
# Site-specific policy on the role of tutors
384
if config['policy']['tutors_can_enrol_students']:
386
perms.add('enrol_student')
387
if config['policy']['tutors_can_edit_worksheets']:
388
perms.add('edit_worksheets')
389
if config['policy']['tutors_can_admin_groups']:
390
perms.add('admin_groups')
391
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
392
perms.add('view_project_submissions')
393
perms.add('admin_groups')
394
perms.add('edit_worksheets')
395
perms.add('edit') # Can edit projects & details
396
perms.add('enrol') # Can see enrolment screen at all
397
perms.add('enrol_student') # Can enrol students
398
perms.add('enrol_tutor') # Can enrol tutors
400
perms.add('enrol_lecturer') # Can enrol lecturers
304
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
403
309
def get_enrolment(self, user):
404
"""Find the user's enrolment in this offering."""
406
311
enrolment = self.enrolments.find(user=user).one()
407
312
except NotOneError:
412
def get_members_by_role(self, role):
413
return Store.of(self).find(User,
414
Enrolment.user_id == User.id,
415
Enrolment.offering_id == self.id,
416
Enrolment.role == role
417
).order_by(User.login)
421
return self.get_members_by_role(u'student')
423
def get_open_projects_for_user(self, user):
424
"""Find all projects currently open to submissions by a user."""
425
# XXX: Respect extensions.
426
return self.projects.find(Project.deadline > datetime.datetime.now())
428
317
class Enrolment(Storm):
429
"""An enrolment of a user in an offering.
431
This represents the roles of both staff and students.
434
318
__storm_table__ = "enrolment"
435
319
__storm_primary__ = "user_id", "offering_id"
481
359
return "<%s %d in %r>" % (type(self).__name__, self.id,
484
def get_permissions(self, user, config):
485
return self.offering.get_permissions(user, config)
487
def get_groups_for_user(self, user):
488
"""List all groups in this offering of which the user is a member."""
490
return Store.of(self).find(
492
ProjectGroupMembership.user_id == user.id,
493
ProjectGroupMembership.project_group_id == ProjectGroup.id,
494
ProjectGroup.project_set_id == self.id)
496
def get_submission_principal(self, user):
497
"""Get the principal on behalf of which the user can submit.
499
If this is a solo project set, the given user is returned. If
500
the user is a member of exactly one group, all the group is
501
returned. Otherwise, None is returned.
504
groups = self.get_groups_for_user(user)
505
if groups.count() == 1:
514
return self.max_students_per_group is not None
518
"""Get the entities (groups or users) assigned to submit this project.
520
This will be a Storm ResultSet.
522
#If its a solo project, return everyone in offering
524
return self.project_groups
526
return self.offering.students
528
class DeadlinePassed(Exception):
529
"""An exception indicating that a project cannot be submitted because the
530
deadline has passed."""
534
return "The project deadline has passed"
536
362
class Project(Storm):
537
"""A student project for which submissions can be made."""
539
363
__storm_table__ = "project"
541
365
id = Int(name="projectid", primary=True)
543
short_name = Unicode()
544
366
synopsis = Unicode()
546
368
project_set_id = Int(name="projectsetid")
547
369
project_set = Reference(project_set_id, ProjectSet.id)
548
370
deadline = DateTime()
550
assesseds = ReferenceSet(id, 'Assessed.project_id')
551
submissions = ReferenceSet(id,
552
'Assessed.project_id',
554
'ProjectSubmission.assessed_id')
556
372
__init__ = _kwarg_init
558
374
def __repr__(self):
559
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
375
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
560
376
self.project_set.offering)
562
def can_submit(self, principal, user):
563
return (self in principal.get_projects() and
564
not self.has_deadline_passed(user))
566
def submit(self, principal, path, revision, who):
567
"""Submit a Subversion path and revision to a project.
569
@param principal: The owner of the Subversion repository, and the
570
entity on behalf of whom the submission is being made
571
@param path: A path within that repository to submit.
572
@param revision: The revision of that path to submit.
573
@param who: The user who is actually making the submission.
576
if not self.can_submit(principal, who):
577
raise DeadlinePassed()
579
a = Assessed.get(Store.of(self), principal, self)
580
ps = ProjectSubmission()
582
ps.revision = revision
583
ps.date_submitted = datetime.datetime.now()
589
def get_permissions(self, user, config):
590
return self.project_set.offering.get_permissions(user, config)
593
def latest_submissions(self):
594
"""Return the latest submission for each Assessed."""
595
return Store.of(self).find(ProjectSubmission,
596
Assessed.project_id == self.id,
597
ProjectSubmission.assessed_id == Assessed.id,
598
ProjectSubmission.date_submitted == Select(
599
Max(ProjectSubmission.date_submitted),
600
ProjectSubmission.assessed_id == Assessed.id,
601
tables=ProjectSubmission
605
def has_deadline_passed(self, user):
606
"""Check whether the deadline has passed."""
607
# XXX: Need to respect extensions.
608
return self.deadline < datetime.datetime.now()
610
def get_submissions_for_principal(self, principal):
611
"""Fetch a ResultSet of all submissions by a particular principal."""
612
assessed = Assessed.get(Store.of(self), principal, self)
615
return assessed.submissions
619
378
class ProjectGroup(Storm):
620
"""A group of students working together on a project."""
622
379
__storm_table__ = "project_group"
624
381
id = Int(name="groupid", primary=True)
641
398
return "<%s %s in %r>" % (type(self).__name__, self.name,
642
399
self.project_set.offering)
645
def display_name(self):
646
"""Returns the "nice name" of the user or group."""
650
def short_name(self):
651
"""Returns the database "identifier" name of the user or group."""
654
def get_projects(self, offering=None, active_only=True):
655
'''Find projects that the group can submit.
657
This will include projects in the project set which owns this group,
658
unless the project set disallows groups (in which case none will be
661
@param active_only: Whether to only search active offerings.
662
@param offering: An optional offering to restrict the search to.
664
return Store.of(self).find(Project,
665
Project.project_set_id == ProjectSet.id,
666
ProjectSet.id == self.project_set.id,
667
ProjectSet.max_students_per_group != None,
668
ProjectSet.offering_id == Offering.id,
669
(offering is None) or (Offering.id == offering.id),
670
Semester.id == Offering.semester_id,
671
(not active_only) or (Semester.state == u'current'))
674
def get_permissions(self, user, config):
675
if user.admin or user in self.members:
676
return set(['submit_project'])
680
401
class ProjectGroupMembership(Storm):
681
"""A student's membership in a project group."""
683
402
__storm_table__ = "group_member"
684
403
__storm_primary__ = "user_id", "project_group_id"
694
413
return "<%s %r in %r>" % (type(self).__name__, self.user,
695
414
self.project_group)
697
class Assessed(Storm):
698
"""A composite of a user or group combined with a project.
700
Each project submission and extension refers to an Assessed. It is the
701
sole specifier of the repository and project.
704
__storm_table__ = "assessed"
706
id = Int(name="assessedid", primary=True)
707
user_id = Int(name="loginid")
708
user = Reference(user_id, User.id)
709
project_group_id = Int(name="groupid")
710
project_group = Reference(project_group_id, ProjectGroup.id)
712
project_id = Int(name="projectid")
713
project = Reference(project_id, Project.id)
715
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
716
submissions = ReferenceSet(
717
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
720
return "<%s %r in %r>" % (type(self).__name__,
721
self.user or self.project_group, self.project)
725
"""True if the Assessed is a group, False if it is a user."""
726
return self.project_group is not None
730
return self.project_group or self.user
733
def checkout_location(self):
734
"""Returns the location of the Subversion workspace for this piece of
735
assessment, relative to each group member's home directory."""
736
subjectname = self.project.project_set.offering.subject.short_name
738
checkout_dir_name = self.principal.short_name
740
checkout_dir_name = "mywork"
741
return subjectname + "/" + checkout_dir_name
744
def get(cls, store, principal, project):
745
"""Find or create an Assessed for the given user or group and project.
747
@param principal: The user or group.
748
@param project: The project.
751
if t not in (User, ProjectGroup):
752
raise AssertionError('principal must be User or ProjectGroup')
755
(t is User) or (cls.project_group_id == principal.id),
756
(t is ProjectGroup) or (cls.user_id == principal.id),
757
cls.project_id == project.id).one()
764
a.project_group = principal
771
class ProjectExtension(Storm):
772
"""An extension granted to a user or group on a particular project.
774
The user or group and project are specified by the Assessed.
777
__storm_table__ = "project_extension"
779
id = Int(name="extensionid", primary=True)
780
assessed_id = Int(name="assessedid")
781
assessed = Reference(assessed_id, Assessed.id)
782
deadline = DateTime()
783
approver_id = Int(name="approver")
784
approver = Reference(approver_id, User.id)
787
class ProjectSubmission(Storm):
788
"""A submission from a user or group repository to a particular project.
790
The content of a submission is a single path and revision inside a
791
repository. The repository is that owned by the submission's user and
792
group, while the path and revision are explicit.
794
The user or group and project are specified by the Assessed.
797
__storm_table__ = "project_submission"
799
id = Int(name="submissionid", primary=True)
800
assessed_id = Int(name="assessedid")
801
assessed = Reference(assessed_id, Assessed.id)
804
submitter_id = Int(name="submitter")
805
submitter = Reference(submitter_id, User.id)
806
date_submitted = DateTime()
808
def get_verify_url(self, user):
809
"""Get the URL for verifying this submission, within the account of
811
# If this is a solo project, then self.path will be prefixed with the
812
# subject name. Remove the first path segment.
813
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
814
if not self.assessed.is_group:
815
if '/' in submitpath:
816
submitpath = submitpath.split('/', 1)[1]
819
return "/files/%s/%s/%s?r=%d" % (user.login,
820
self.assessed.checkout_location, submitpath, self.revision)
822
416
# WORKSHEETS AND EXERCISES #
824
418
class Exercise(Storm):
825
"""An exercise for students to complete in a worksheet.
827
An exercise may be present in any number of worksheets.
830
419
__storm_table__ = "exercise"
831
420
id = Unicode(primary=True, name="identifier")
854
443
def __repr__(self):
855
444
return "<%s %s>" % (type(self).__name__, self.name)
857
def get_permissions(self, user, config):
858
return self.global_permissions(user, config)
861
def global_permissions(user, config):
862
"""Gets the set of permissions this user has over *all* exercises.
863
This is used to determine who may view the exercises list, and create
446
def get_permissions(self, user):
867
449
if user is not None:
869
451
perms.add('edit')
870
452
perms.add('view')
871
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
874
elif (config['policy']['tutors_can_edit_worksheets']
875
and u'tutor' in set((e.role for e in user.active_enrolments))):
876
# Site-specific policy on the role of tutors
453
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
882
459
def get_description(self):
883
"""Return the description interpreted as reStructuredText."""
884
460
return rst(self.description)
886
462
def delete(self):
927
498
def __repr__(self):
928
499
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()
930
513
def remove_all_exercises(self):
931
"""Remove all exercises from this worksheet.
515
Remove all exercises from this worksheet.
933
516
This does not delete the exercises themselves. It just removes them
934
517
from the worksheet.
939
522
raise IntegrityError()
940
523
store.find(WorksheetExercise,
941
524
WorksheetExercise.worksheet == self).remove()
943
def get_permissions(self, user, config):
944
# Almost the same permissions as for the offering itself
945
perms = self.offering.get_permissions(user, config)
946
# However, "edit" permission is derived from the "edit_worksheets"
947
# permission of the offering
948
if 'edit_worksheets' in perms:
951
perms.discard('edit')
526
def get_permissions(self, user):
527
return self.offering.get_permissions(user)
954
529
def get_xml(self):
955
530
"""Returns the xml of this worksheet, converts from rst if required."""
956
531
if self.format == u'rst':
962
537
def delete(self):
963
538
"""Deletes the worksheet, provided it has no attempts on any exercises.
965
540
Returns True if delete succeeded, or False if this worksheet has
966
541
attempts attached."""
967
542
for ws_ex in self.all_worksheet_exercises:
968
543
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
969
544
raise IntegrityError()
971
546
self.remove_all_exercises()
972
547
Store.of(self).remove(self)
974
549
class WorksheetExercise(Storm):
975
"""A link between a worksheet and one of its exercises.
977
These may be marked optional, in which case the exercise does not count
978
for marking purposes. The sequence number is used to order the worksheet
982
550
__storm_table__ = "worksheet_exercise"
984
552
id = Int(primary=True, name="ws_ex_id")
986
554
worksheet_id = Int(name="worksheetid")
1000
568
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
1001
569
self.worksheet.identifier)
1003
def get_permissions(self, user, config):
1004
return self.worksheet.get_permissions(user, config)
571
def get_permissions(self, user):
572
return self.worksheet.get_permissions(user)
1007
575
class ExerciseSave(Storm):
1008
"""A potential exercise solution submitted by a user for storage.
1010
This is not an actual tested attempt at an exercise, it's just a save of
1011
the editing session.
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
1014
584
__storm_table__ = "exercise_save"
1015
585
__storm_primary__ = "ws_ex_id", "user_id"
1029
599
self.exercise.name, self.user.login, self.date.strftime("%c"))
1031
601
class ExerciseAttempt(ExerciseSave):
1032
"""An attempt at solving an exercise.
1034
This is a special case of ExerciseSave, used when the user submits a
1035
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1038
In addition, it contains information about the result of the submission:
1040
- complete - True if this submission was successful, rendering this
1041
exercise complete for this user in this worksheet.
1042
- active - True if this submission is "active" (usually true).
1043
Submissions may be de-activated by privileged users for
1044
special reasons, and then they won't count (either as a
1045
penalty or success), but will still be stored.
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
1048
614
__storm_table__ = "exercise_attempt"
1049
615
__storm_primary__ = "ws_ex_id", "user_id", "date"
1076
637
exercise = Reference(exercise_id, Exercise.id)
1077
638
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1078
639
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1080
641
def delete(self):
1081
642
"""Delete this suite, without asking questions."""
1082
for variable in self.variables:
643
for vaariable in self.variables:
1083
644
variable.delete()
1084
645
for test_case in self.test_cases:
1085
646
test_case.delete()
1086
647
Store.of(self).remove(self)
1088
649
class TestCase(Storm):
1089
"""A container for actual tests (see TestCasePart), inside a test suite.
1091
It is the lowest level shown to students on their pass/fail status."""
650
"""A TestCase is a member of a TestSuite.
652
It contains the data necessary to check if an exercise is correct"""
1093
653
__storm_table__ = "test_case"
1094
654
__storm_primary__ = "testid", "suiteid"
1098
658
suite = Reference(suiteid, "TestSuite.suiteid")
1099
659
passmsg = Unicode()
1100
660
failmsg = Unicode()
1101
test_default = Unicode() # Currently unused - only used for file matching.
661
test_default = Unicode()
1104
664
parts = ReferenceSet(testid, "TestCasePart.testid")
1106
666
__init__ = _kwarg_init
1108
668
def delete(self):
1109
669
for part in self.parts:
1111
671
Store.of(self).remove(self)
1113
673
class TestSuiteVar(Storm):
1114
"""A variable used by an exercise test suite.
1116
This may represent a function argument or a normal variable.
674
"""A container for the arguments of a Test Suite"""
1119
675
__storm_table__ = "suite_variable"
1120
676
__storm_primary__ = "varid"
1124
680
var_name = Unicode()
1125
681
var_value = Unicode()
1126
682
var_type = Unicode()
1129
685
suite = Reference(suiteid, "TestSuite.suiteid")
1131
687
__init__ = _kwarg_init
1133
689
def delete(self):
1134
690
Store.of(self).remove(self)
1136
692
class TestCasePart(Storm):
1137
"""An actual piece of code to test an exercise solution."""
693
"""A container for the test elements of a Test Case"""
1139
694
__storm_table__ = "test_case_part"
1140
695
__storm_primary__ = "partid"
1145
700
part_type = Unicode()
1146
701
test_type = Unicode()
1147
702
data = Unicode()
1148
703
filename = Unicode()
1150
705
test = Reference(testid, "TestCase.testid")
1152
707
__init__ = _kwarg_init
1154
709
def delete(self):
1155
710
Store.of(self).remove(self)
added
removed
ivle/database.py
