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
35
__all__ = ['get_store',
38
37
'Subject', 'Semester', 'Offering', 'Enrolment',
39
38
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
39
'Exercise', 'Worksheet', 'WorksheetExercise',
42
40
'ExerciseSave', 'ExerciseAttempt',
43
'TestCase', 'TestSuite', 'TestSuiteVar'
41
'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
46
44
def _kwarg_init(self, **kwargs):
50
48
% (self.__class__.__name__, k))
51
49
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.
51
def get_conn_string():
53
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']
58
clusterstr += ivle.conf.db_user
59
if ivle.conf.db_password:
60
clusterstr += ':' + ivle.conf.db_password
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
63
host = ivle.conf.db_host or 'localhost'
64
port = ivle.conf.db_port or 5432
69
66
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)))
68
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
72
Open a database connection and transaction. Return a storm.store.Store
73
instance connected to the configured IVLE database.
75
return Store(create_database(get_conn_string()))
83
"""An IVLE user account."""
81
Represents an IVLE user.
84
83
__storm_table__ = "login"
86
85
id = Int(primary=True, name="loginid")
197
182
'''A sanely ordered list of all of the user's enrolments.'''
198
183
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
186
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
187
return md5.md5(password).hexdigest()
226
190
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
192
Get the User from the db associated with a given store and
228
195
return store.find(cls, cls.login == unicode(login)).one()
230
197
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
198
if user and user.admin or user is self:
237
return set(['view', 'edit', 'submit_project'])
199
return set(['view', 'edit'])
241
203
# SUBJECTS AND ENROLMENTS #
243
205
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
206
__storm_table__ = "subject"
248
208
id = Int(primary=True, name="subjectid")
271
226
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
229
class Semester(Storm):
295
"""A semester in which subjects can be run."""
297
230
__storm_table__ = "semester"
299
232
id = Int(primary=True, name="semesterid")
342
269
return "<%s %r in %r>" % (type(self).__name__, self.subject,
345
def enrol(self, user, role=u'student'):
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.
351
enrolment = Store.of(self).find(Enrolment,
352
Enrolment.user_id == user.id,
353
Enrolment.offering_id == self.id).one()
355
if enrolment is None:
356
enrolment = Enrolment(user=user, offering=self)
357
self.enrolments.add(enrolment)
359
enrolment.active = True
360
enrolment.role = role
362
def unenrol(self, user):
363
'''Unenrol a user from this offering.'''
364
enrolment = Store.of(self).find(Enrolment,
365
Enrolment.user_id == user.id,
366
Enrolment.offering_id == self.id).one()
367
Store.of(enrolment).remove(enrolment)
272
def enrol(self, user):
273
'''Enrol a user in this offering.'''
274
# We'll get a horrible database constraint violation error if we try
275
# to add a second enrolment.
276
if Store.of(self).find(Enrolment,
277
Enrolment.user_id == user.id,
278
Enrolment.offering_id == self.id).count() == 1:
279
raise AlreadyEnrolledError()
281
e = Enrolment(user=user, offering=self, active=True)
282
self.enrolments.add(e)
369
284
def get_permissions(self, user):
371
286
if user is not None:
372
enrolment = self.get_enrolment(user)
373
if enrolment or user.admin:
375
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
377
289
perms.add('edit')
380
def get_enrolment(self, user):
381
"""Find the user's enrolment in this offering."""
383
enrolment = self.enrolments.find(user=user).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')
400
292
class Enrolment(Storm):
401
"""An enrolment of a user in an offering.
403
This represents the roles of both staff and students.
406
293
__storm_table__ = "enrolment"
407
294
__storm_primary__ = "user_id", "offering_id"
453
337
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
471
340
class Project(Storm):
472
"""A student project for which submissions can be made."""
474
341
__storm_table__ = "project"
476
343
id = Int(name="projectid", primary=True)
478
short_name = Unicode()
479
344
synopsis = Unicode()
481
346
project_set_id = Int(name="projectsetid")
482
347
project_set = Reference(project_set_id, ProjectSet.id)
483
348
deadline = DateTime()
485
assesseds = ReferenceSet(id, 'Assessed.project_id')
486
submissions = ReferenceSet(id,
487
'Assessed.project_id',
489
'ProjectSubmission.assessed_id')
491
350
__init__ = _kwarg_init
493
352
def __repr__(self):
494
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
353
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
495
354
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
541
356
class ProjectGroup(Storm):
542
"""A group of students working together on a project."""
544
357
__storm_table__ = "project_group"
546
359
id = Int(name="groupid", primary=True)
563
376
return "<%s %s in %r>" % (type(self).__name__, self.name,
564
377
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'])
602
379
class ProjectGroupMembership(Storm):
603
"""A student's membership in a project group."""
605
380
__storm_table__ = "group_member"
606
381
__storm_primary__ = "user_id", "project_group_id"
616
391
return "<%s %r in %r>" % (type(self).__name__, self.user,
617
392
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()
719
394
# WORKSHEETS AND EXERCISES #
721
396
class Exercise(Storm):
722
"""An exercise for students to complete in a worksheet.
724
An exercise may be present in any number of worksheets.
727
397
__storm_table__ = "exercise"
728
398
id = Unicode(primary=True, name="identifier")
754
419
def get_permissions(self, user):
757
421
if user is not None:
759
423
perms.add('edit')
760
424
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)
782
427
class Worksheet(Storm):
783
"""A worksheet with exercises for students to complete.
785
Worksheets are owned by offerings.
788
428
__storm_table__ = "worksheet"
790
430
id = Int(primary=True, name="worksheetid")
815
454
def __repr__(self):
816
455
return "<%s %s>" % (type(self).__name__, self.name)
818
def remove_all_exercises(self):
819
"""Remove all exercises from this worksheet.
457
# XXX Refactor this - make it an instance method of Subject rather than a
458
# class method of Worksheet. Can't do that now because Subject isn't
459
# linked referentially to the Worksheet.
461
def get_by_name(cls, store, subjectname, worksheetname):
463
Get the Worksheet from the db associated with a given store, subject
464
name and worksheet name.
466
return store.find(cls, cls.subject == unicode(subjectname),
467
cls.name == unicode(worksheetname)).one()
469
def remove_all_exercises(self, store):
471
Remove all exercises from this worksheet.
821
472
This does not delete the exercises themselves. It just removes them
822
473
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()
828
475
store.find(WorksheetExercise,
829
476
WorksheetExercise.worksheet == self).remove()
831
478
def get_permissions(self, user):
832
479
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)
854
481
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
862
482
__storm_table__ = "worksheet_exercise"
864
484
id = Int(primary=True, name="ws_ex_id")
866
486
worksheet_id = Int(name="worksheetid")
880
500
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
881
501
self.worksheet.identifier)
883
def get_permissions(self, user):
884
return self.worksheet.get_permissions(user)
887
503
class ExerciseSave(Storm):
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
505
Represents a potential solution to an exercise that a user has submitted
506
to the server for storage.
507
A basic ExerciseSave is just the current saved text for this exercise for
508
this user (doesn't count towards their attempts).
509
ExerciseSave may be extended with additional semantics (such as
894
512
__storm_table__ = "exercise_save"
895
513
__storm_primary__ = "ws_ex_id", "user_id"
909
527
self.exercise.name, self.user.login, self.date.strftime("%c"))
911
529
class ExerciseAttempt(ExerciseSave):
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.
531
An ExerciseAttempt is a special case of an ExerciseSave. Like an
532
ExerciseSave, it constitutes exercise solution data that the user has
533
submitted to the server for storage.
534
In addition, it contains additional information about the submission.
535
complete - True if this submission was successful, rendering this exercise
536
complete for this user.
537
active - True if this submission is "active" (usually true). Submissions
538
may be de-activated by privileged users for special reasons, and then
539
they won't count (either as a penalty or success), but will still be
928
542
__storm_table__ = "exercise_attempt"
929
543
__storm_primary__ = "ws_ex_id", "user_id", "date"
933
547
text = Unicode(name="attempt")
934
548
complete = Bool()
937
551
def get_permissions(self, user):
938
552
return set(['view']) if user is self.user else set()
940
554
class TestSuite(Storm):
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.
555
"""A Testsuite acts as a container for the test cases of an exercise."""
947
556
__storm_table__ = "test_suite"
948
557
__storm_primary__ = "exercise_id", "suiteid"
951
560
exercise_id = Unicode(name="exerciseid")
952
561
description = Unicode()
954
563
function = Unicode()
955
564
stdin = Unicode()
956
565
exercise = Reference(exercise_id, Exercise.id)
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)
566
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
567
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
968
569
class TestCase(Storm):
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."""
570
"""A TestCase is a member of a TestSuite.
572
It contains the data necessary to check if an exercise is correct"""
973
573
__storm_table__ = "test_case"
974
574
__storm_primary__ = "testid", "suiteid"
978
578
suite = Reference(suiteid, "TestSuite.suiteid")
980
580
failmsg = Unicode()
981
581
test_default = Unicode()
984
584
parts = ReferenceSet(testid, "TestCasePart.testid")
986
586
__init__ = _kwarg_init
989
for part in self.parts:
991
Store.of(self).remove(self)
993
588
class TestSuiteVar(Storm):
994
"""A variable used by an exercise test suite.
996
This may represent a function argument or a normal variable.
589
"""A container for the arguments of a Test Suite"""
999
590
__storm_table__ = "suite_variable"
1000
591
__storm_primary__ = "varid"
1004
595
var_name = Unicode()
1005
596
var_value = Unicode()
1006
597
var_type = Unicode()
1009
600
suite = Reference(suiteid, "TestSuite.suiteid")
1011
602
__init__ = _kwarg_init
1014
Store.of(self).remove(self)
1016
604
class TestCasePart(Storm):
1017
"""An actual piece of code to test an exercise solution."""
605
"""A container for the test elements of a Test Case"""
1019
606
__storm_table__ = "test_case_part"
1020
607
__storm_primary__ = "partid"
1025
612
part_type = Unicode()
1026
613
test_type = Unicode()
1027
614
data = Unicode()
1028
615
filename = Unicode()
1030
617
test = Reference(testid, "TestCase.testid")
1032
619
__init__ = _kwarg_init
1035
Store.of(self).remove(self)
added
removed
ivle/database.py
