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
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',
41
40
'Exercise', 'Worksheet', 'WorksheetExercise',
42
41
'ExerciseSave', 'ExerciseAttempt',
43
'TestCase', 'TestSuite', 'TestSuiteVar'
42
'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
46
45
def _kwarg_init(self, **kwargs):
50
49
% (self.__class__.__name__, k))
51
50
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.
52
def get_conn_string():
54
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']
59
clusterstr += ivle.conf.db_user
60
if ivle.conf.db_password:
61
clusterstr += ':' + ivle.conf.db_password
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
64
host = ivle.conf.db_host or 'localhost'
65
port = ivle.conf.db_port or 5432
69
67
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)))
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()))
83
"""An IVLE user account."""
82
Represents an IVLE user.
84
84
__storm_table__ = "login"
86
86
id = Int(primary=True, name="loginid")
88
88
passhash = Unicode()
93
93
pass_exp = DateTime()
197
199
'''A sanely ordered list of all of the user's enrolments.'''
198
200
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)
221
203
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
204
return md5.md5(password).hexdigest()
226
207
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
209
Get the User from the db associated with a given store and
228
212
return store.find(cls, cls.login == unicode(login)).one()
230
214
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.
236
if user and user.admin or user is self:
237
return set(['view_public', 'view', 'edit', 'submit_project'])
215
if user and user.rolenm == 'admin' or user is self:
216
return set(['view', 'edit'])
239
return set(['view_public'])
241
220
# SUBJECTS AND ENROLMENTS #
243
222
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
223
__storm_table__ = "subject"
248
225
id = Int(primary=True, name="subjectid")
249
226
code = Unicode(name="subj_code")
250
227
name = Unicode(name="subj_name")
251
228
short_name = Unicode(name="subj_short_name")
253
231
offerings = ReferenceSet(id, 'Offering.subject_id')
258
236
return "<%s '%s'>" % (type(self).__name__, self.short_name)
260
238
def get_permissions(self, user):
261
"""Determine privileges held by a user over this object.
263
If the user requesting privileges is an admin, they may edit.
264
Otherwise they may only read.
267
240
if user is not None:
268
241
perms.add('view')
242
if user.rolenm == 'admin':
270
243
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()
293
246
class Semester(Storm):
294
"""A semester in which subjects can be run."""
296
247
__storm_table__ = "semester"
298
249
id = Int(primary=True, name="semesterid")
300
251
semester = Unicode()
303
254
offerings = ReferenceSet(id, 'Offering.semester_id')
304
enrolments = ReferenceSet(id,
305
'Offering.semester_id',
307
'Enrolment.offering_id')
309
256
__init__ = _kwarg_init
347
286
return "<%s %r in %r>" % (type(self).__name__, self.subject,
350
def enrol(self, user, role=u'student'):
351
"""Enrol a user in this offering.
353
Enrolments handle both the staff and student cases. The role controls
354
the privileges granted by this enrolment.
356
enrolment = Store.of(self).find(Enrolment,
357
Enrolment.user_id == user.id,
358
Enrolment.offering_id == self.id).one()
360
if enrolment is None:
361
enrolment = Enrolment(user=user, offering=self)
362
self.enrolments.add(enrolment)
364
enrolment.active = True
365
enrolment.role = role
367
def unenrol(self, user):
368
'''Unenrol a user from this offering.'''
369
enrolment = Store.of(self).find(Enrolment,
370
Enrolment.user_id == user.id,
371
Enrolment.offering_id == self.id).one()
372
Store.of(enrolment).remove(enrolment)
289
def enrol(self, user):
290
'''Enrol a user in this offering.'''
291
# We'll get a horrible database constraint violation error if we try
292
# to add a second enrolment.
293
if Store.of(self).find(Enrolment,
294
Enrolment.user_id == user.id,
295
Enrolment.offering_id == self.id).count() == 1:
296
raise AlreadyEnrolledError()
298
e = Enrolment(user=user, offering=self, active=True)
299
self.enrolments.add(e)
374
301
def get_permissions(self, user):
376
303
if user is not None:
377
enrolment = self.get_enrolment(user)
378
if enrolment or user.admin:
380
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
305
if user.rolenm in ('admin', 'lecturer'):
382
306
perms.add('edit')
383
# XXX Bug #493945 -- should tutors have these permissions?
384
# Potentially move into the next category (lecturer & admin)
385
perms.add('enrol') # Can see enrolment screen at all
386
perms.add('enrol_student') # Can enrol students
387
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
388
perms.add('enrol_tutor') # Can enrol tutors
390
perms.add('enrol_lecturer') # Can enrol lecturers
393
def get_enrolment(self, user):
394
"""Find the user's enrolment in this offering."""
396
enrolment = self.enrolments.find(user=user).one()
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())
418
309
class Enrolment(Storm):
419
"""An enrolment of a user in an offering.
421
This represents the roles of both staff and students.
424
310
__storm_table__ = "enrolment"
425
311
__storm_primary__ = "user_id", "offering_id"
471
353
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
518
class DeadlinePassed(Exception):
519
"""An exception indicating that a project cannot be submitted because the
520
deadline has passed."""
524
return "The project deadline has passed"
526
356
class Project(Storm):
527
"""A student project for which submissions can be made."""
529
357
__storm_table__ = "project"
531
359
id = Int(name="projectid", primary=True)
533
short_name = Unicode()
534
360
synopsis = Unicode()
536
362
project_set_id = Int(name="projectsetid")
537
363
project_set = Reference(project_set_id, ProjectSet.id)
538
364
deadline = DateTime()
540
assesseds = ReferenceSet(id, 'Assessed.project_id')
541
submissions = ReferenceSet(id,
542
'Assessed.project_id',
544
'ProjectSubmission.assessed_id')
546
366
__init__ = _kwarg_init
548
368
def __repr__(self):
549
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
369
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
550
370
self.project_set.offering)
552
def can_submit(self, principal, user):
553
return (self in principal.get_projects() and
554
not self.has_deadline_passed(user))
556
def submit(self, principal, path, revision, who):
557
"""Submit a Subversion path and revision to a project.
559
@param principal: The owner of the Subversion repository, and the
560
entity on behalf of whom the submission is being made
561
@param path: A path within that repository to submit.
562
@param revision: The revision of that path to submit.
563
@param who: The user who is actually making the submission.
566
if not self.can_submit(principal, who):
567
raise DeadlinePassed()
569
a = Assessed.get(Store.of(self), principal, self)
570
ps = ProjectSubmission()
572
ps.revision = revision
573
ps.date_submitted = datetime.datetime.now()
579
def get_permissions(self, user):
580
return self.project_set.offering.get_permissions(user)
583
def latest_submissions(self):
584
"""Return the latest submission for each Assessed."""
585
return Store.of(self).find(ProjectSubmission,
586
Assessed.project_id == self.id,
587
ProjectSubmission.assessed_id == Assessed.id,
588
ProjectSubmission.date_submitted == Select(
589
Max(ProjectSubmission.date_submitted),
590
ProjectSubmission.assessed_id == Assessed.id,
591
tables=ProjectSubmission
595
def has_deadline_passed(self, user):
596
"""Check whether the deadline has passed."""
597
# XXX: Need to respect extensions.
598
return self.deadline < datetime.datetime.now()
600
def get_submissions_for_principal(self, principal):
601
"""Fetch a ResultSet of all submissions by a particular principal."""
602
assessed = Assessed.get(Store.of(self), principal, self)
605
return assessed.submissions
609
372
class ProjectGroup(Storm):
610
"""A group of students working together on a project."""
612
373
__storm_table__ = "project_group"
614
375
id = Int(name="groupid", primary=True)
631
392
return "<%s %s in %r>" % (type(self).__name__, self.name,
632
393
self.project_set.offering)
635
def display_name(self):
636
"""Returns the "nice name" of the user or group."""
640
def short_name(self):
641
"""Returns the database "identifier" name of the user or group."""
644
def get_projects(self, offering=None, active_only=True):
645
'''Find projects that the group can submit.
647
This will include projects in the project set which owns this group,
648
unless the project set disallows groups (in which case none will be
651
@param active_only: Whether to only search active offerings.
652
@param offering: An optional offering to restrict the search to.
654
return Store.of(self).find(Project,
655
Project.project_set_id == ProjectSet.id,
656
ProjectSet.id == self.project_set.id,
657
ProjectSet.max_students_per_group != None,
658
ProjectSet.offering_id == Offering.id,
659
(offering is None) or (Offering.id == offering.id),
660
Semester.id == Offering.semester_id,
661
(not active_only) or (Semester.state == u'current'))
664
def get_permissions(self, user):
665
if user.admin or user in self.members:
666
return set(['submit_project'])
670
395
class ProjectGroupMembership(Storm):
671
"""A student's membership in a project group."""
673
396
__storm_table__ = "group_member"
674
397
__storm_primary__ = "user_id", "project_group_id"
684
407
return "<%s %r in %r>" % (type(self).__name__, self.user,
685
408
self.project_group)
687
class Assessed(Storm):
688
"""A composite of a user or group combined with a project.
690
Each project submission and extension refers to an Assessed. It is the
691
sole specifier of the repository and project.
694
__storm_table__ = "assessed"
696
id = Int(name="assessedid", primary=True)
697
user_id = Int(name="loginid")
698
user = Reference(user_id, User.id)
699
project_group_id = Int(name="groupid")
700
project_group = Reference(project_group_id, ProjectGroup.id)
702
project_id = Int(name="projectid")
703
project = Reference(project_id, Project.id)
705
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
706
submissions = ReferenceSet(
707
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
710
return "<%s %r in %r>" % (type(self).__name__,
711
self.user or self.project_group, self.project)
715
"""True if the Assessed is a group, False if it is a user."""
716
return self.project_group is not None
720
return self.project_group or self.user
723
def get(cls, store, principal, project):
724
"""Find or create an Assessed for the given user or group and project.
726
@param principal: The user or group.
727
@param project: The project.
730
if t not in (User, ProjectGroup):
731
raise AssertionError('principal must be User or ProjectGroup')
734
(t is User) or (cls.project_group_id == principal.id),
735
(t is ProjectGroup) or (cls.user_id == principal.id),
736
cls.project_id == project.id).one()
743
a.project_group = principal
750
class ProjectExtension(Storm):
751
"""An extension granted to a user or group on a particular project.
753
The user or group and project are specified by the Assessed.
756
__storm_table__ = "project_extension"
758
id = Int(name="extensionid", primary=True)
759
assessed_id = Int(name="assessedid")
760
assessed = Reference(assessed_id, Assessed.id)
761
deadline = DateTime()
762
approver_id = Int(name="approver")
763
approver = Reference(approver_id, User.id)
766
class ProjectSubmission(Storm):
767
"""A submission from a user or group repository to a particular project.
769
The content of a submission is a single path and revision inside a
770
repository. The repository is that owned by the submission's user and
771
group, while the path and revision are explicit.
773
The user or group and project are specified by the Assessed.
776
__storm_table__ = "project_submission"
778
id = Int(name="submissionid", primary=True)
779
assessed_id = Int(name="assessedid")
780
assessed = Reference(assessed_id, Assessed.id)
783
submitter_id = Int(name="submitter")
784
submitter = Reference(submitter_id, User.id)
785
date_submitted = DateTime()
788
410
# WORKSHEETS AND EXERCISES #
790
412
class Exercise(Storm):
791
"""An exercise for students to complete in a worksheet.
793
An exercise may be present in any number of worksheets.
796
413
__storm_table__ = "exercise"
797
414
id = Unicode(primary=True, name="identifier")
823
437
def get_permissions(self, user):
826
439
if user is not None:
830
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
833
elif u'tutor' in set((e.role for e in user.active_enrolments)):
440
if user.rolenm in ('admin', 'lecturer'):
839
def get_description(self):
840
"""Return the description interpreted as reStructuredText."""
841
return rst(self.description)
844
"""Deletes the exercise, providing it has no associated worksheets."""
845
if (self.worksheet_exercises.count() > 0):
846
raise IntegrityError()
847
for suite in self.test_suites:
849
Store.of(self).remove(self)
851
445
class Worksheet(Storm):
852
"""A worksheet with exercises for students to complete.
854
Worksheets are owned by offerings.
857
446
__storm_table__ = "worksheet"
859
448
id = Int(primary=True, name="worksheetid")
868
457
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
869
458
offering = Reference(offering_id, 'Offering.id')
871
all_worksheet_exercises = ReferenceSet(id,
460
# Use worksheet_exercises to get access to the WorksheetExercise objects
461
# binding worksheets to exercises. This is required to access the
463
worksheet_exercises = ReferenceSet(id,
872
464
'WorksheetExercise.worksheet_id')
874
# Use worksheet_exercises to get access to the *active* WorksheetExercise
875
# objects binding worksheets to exercises. This is required to access the
879
def worksheet_exercises(self):
880
return self.all_worksheet_exercises.find(active=True)
882
467
__init__ = _kwarg_init
884
469
def __repr__(self):
885
470
return "<%s %s>" % (type(self).__name__, self.name)
887
def remove_all_exercises(self):
888
"""Remove all exercises from this worksheet.
472
# XXX Refactor this - make it an instance method of Subject rather than a
473
# class method of Worksheet. Can't do that now because Subject isn't
474
# linked referentially to the Worksheet.
476
def get_by_name(cls, store, subjectname, worksheetname):
478
Get the Worksheet from the db associated with a given store, subject
479
name and worksheet name.
481
return store.find(cls, cls.subject == unicode(subjectname),
482
cls.name == unicode(worksheetname)).one()
484
def remove_all_exercises(self, store):
486
Remove all exercises from this worksheet.
890
487
This does not delete the exercises themselves. It just removes them
891
488
from the worksheet.
893
store = Store.of(self)
894
for ws_ex in self.all_worksheet_exercises:
895
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
896
raise IntegrityError()
897
490
store.find(WorksheetExercise,
898
491
WorksheetExercise.worksheet == self).remove()
900
493
def get_permissions(self, user):
901
494
return self.offering.get_permissions(user)
904
"""Returns the xml of this worksheet, converts from rst if required."""
905
if self.format == u'rst':
906
ws_xml = rst(self.data)
912
"""Deletes the worksheet, provided it has no attempts on any exercises.
914
Returns True if delete succeeded, or False if this worksheet has
915
attempts attached."""
916
for ws_ex in self.all_worksheet_exercises:
917
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
918
raise IntegrityError()
920
self.remove_all_exercises()
921
Store.of(self).remove(self)
923
496
class WorksheetExercise(Storm):
924
"""A link between a worksheet and one of its exercises.
926
These may be marked optional, in which case the exercise does not count
927
for marking purposes. The sequence number is used to order the worksheet
931
497
__storm_table__ = "worksheet_exercise"
933
499
id = Int(primary=True, name="ws_ex_id")
935
501
worksheet_id = Int(name="worksheetid")
949
515
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
950
516
self.worksheet.identifier)
952
def get_permissions(self, user):
953
return self.worksheet.get_permissions(user)
956
518
class ExerciseSave(Storm):
957
"""A potential exercise solution submitted by a user for storage.
959
This is not an actual tested attempt at an exercise, it's just a save of
520
Represents a potential solution to an exercise that a user has submitted
521
to the server for storage.
522
A basic ExerciseSave is just the current saved text for this exercise for
523
this user (doesn't count towards their attempts).
524
ExerciseSave may be extended with additional semantics (such as
963
527
__storm_table__ = "exercise_save"
964
528
__storm_primary__ = "ws_ex_id", "user_id"
978
542
self.exercise.name, self.user.login, self.date.strftime("%c"))
980
544
class ExerciseAttempt(ExerciseSave):
981
"""An attempt at solving an exercise.
983
This is a special case of ExerciseSave, used when the user submits a
984
candidate solution. Like an ExerciseSave, it constitutes exercise solution
987
In addition, it contains information about the result of the submission:
989
- complete - True if this submission was successful, rendering this
990
exercise complete for this user in this worksheet.
991
- active - True if this submission is "active" (usually true).
992
Submissions may be de-activated by privileged users for
993
special reasons, and then they won't count (either as a
994
penalty or success), but will still be stored.
546
An ExerciseAttempt is a special case of an ExerciseSave. Like an
547
ExerciseSave, it constitutes exercise solution data that the user has
548
submitted to the server for storage.
549
In addition, it contains additional information about the submission.
550
complete - True if this submission was successful, rendering this exercise
551
complete for this user.
552
active - True if this submission is "active" (usually true). Submissions
553
may be de-activated by privileged users for special reasons, and then
554
they won't count (either as a penalty or success), but will still be
997
557
__storm_table__ = "exercise_attempt"
998
558
__storm_primary__ = "ws_ex_id", "user_id", "date"
1026
581
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1027
582
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1030
"""Delete this suite, without asking questions."""
1031
for variable in self.variables:
1033
for test_case in self.test_cases:
1035
Store.of(self).remove(self)
1037
584
class TestCase(Storm):
1038
"""A container for actual tests (see TestCasePart), inside a test suite.
1040
It is the lowest level shown to students on their pass/fail status."""
585
"""A TestCase is a member of a TestSuite.
587
It contains the data necessary to check if an exercise is correct"""
1042
588
__storm_table__ = "test_case"
1043
589
__storm_primary__ = "testid", "suiteid"
1047
593
suite = Reference(suiteid, "TestSuite.suiteid")
1048
594
passmsg = Unicode()
1049
595
failmsg = Unicode()
1050
test_default = Unicode() # Currently unused - only used for file matching.
596
test_default = Unicode()
1053
599
parts = ReferenceSet(testid, "TestCasePart.testid")
1055
601
__init__ = _kwarg_init
1058
for part in self.parts:
1060
Store.of(self).remove(self)
1062
603
class TestSuiteVar(Storm):
1063
"""A variable used by an exercise test suite.
1065
This may represent a function argument or a normal variable.
604
"""A container for the arguments of a Test Suite"""
1068
605
__storm_table__ = "suite_variable"
1069
606
__storm_primary__ = "varid"
1073
610
var_name = Unicode()
1074
611
var_value = Unicode()
1075
612
var_type = Unicode()
1078
615
suite = Reference(suiteid, "TestSuite.suiteid")
1080
617
__init__ = _kwarg_init
1083
Store.of(self).remove(self)
1085
619
class TestCasePart(Storm):
1086
"""An actual piece of code to test an exercise solution."""
620
"""A container for the test elements of a Test Case"""
1088
621
__storm_table__ = "test_case_part"
1089
622
__storm_primary__ = "partid"
1094
627
part_type = Unicode()
1095
628
test_type = Unicode()
1096
629
data = Unicode()
1097
630
filename = Unicode()
1099
632
test = Reference(testid, "TestCase.testid")
1101
634
__init__ = _kwarg_init
1104
Store.of(self).remove(self)
added
removed
ivle/database.py
