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
34
34
from ivle.worksheet.rst import rst
165
169
# TODO: Invitations should be listed too?
166
170
def get_groups(self, offering=None):
171
"""Get groups of which this user is a member.
173
@param offering: An optional offering to restrict the search to.
168
176
ProjectGroupMembership.user_id == self.id,
169
177
ProjectGroup.id == ProjectGroupMembership.project_group_id,
190
198
return self._get_enrolments(False)
192
200
def get_projects(self, offering=None, active_only=True):
193
'''Return Projects that the user can submit.
201
"""Find projects that the user can submit.
195
203
This will include projects for offerings in which the user is
196
204
enrolled, as long as the project is not in a project set which has
197
205
groups (ie. if maximum number of group members is 0).
199
Unless active_only is False, only projects for active offerings will
202
If an offering is specified, returned projects will be limited to
203
those for that offering.
207
@param active_only: Whether to only search active offerings.
208
@param offering: An optional offering to restrict the search to.
205
210
return Store.of(self).find(Project,
206
211
Project.project_set_id == ProjectSet.id,
207
212
ProjectSet.max_students_per_group == None,
216
221
def hash_password(password):
222
"""Hash a password with MD5."""
217
223
return hashlib.md5(password).hexdigest()
220
226
def get_by_login(cls, store, login):
222
Get the User from the db associated with a given store and
227
"""Find a user in a store by login name."""
225
228
return store.find(cls, cls.login == unicode(login)).one()
227
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.
228
236
if user and user.admin or user is self:
229
return set(['view', 'edit', 'submit_project'])
237
return set(['view_public', 'view', 'edit', 'submit_project'])
239
return set(['view_public'])
233
241
# SUBJECTS AND ENROLMENTS #
235
243
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
236
246
__storm_table__ = "subject"
238
248
id = Int(primary=True, name="subjectid")
249
259
return "<%s '%s'>" % (type(self).__name__, self.short_name)
251
261
def get_permissions(self, user):
262
"""Determine privileges held by a user over this object.
264
If the user requesting privileges is an admin, they may edit.
265
Otherwise they may only read.
253
268
if user is not None:
254
269
perms.add('view')
259
274
def active_offerings(self):
260
"""Return a sequence of currently active offerings for this subject
275
"""Find active offerings for this subject.
277
Return a sequence of currently active offerings for this subject
261
278
(offerings whose semester.state is "current"). There should be 0 or 1
262
279
elements in this sequence, but it's possible there are more.
265
282
Semester.state == u'current')
267
284
def offering_for_semester(self, year, semester):
268
"""Get the offering for the given year/semester, or None."""
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.
269
290
return self.offerings.find(Offering.semester_id == Semester.id,
270
291
Semester.year == unicode(year),
271
292
Semester.semester == unicode(semester)).one()
273
294
class Semester(Storm):
295
"""A semester in which subjects can be run."""
274
297
__storm_table__ = "semester"
276
299
id = Int(primary=True, name="semesterid")
290
313
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
292
315
class Offering(Storm):
316
"""An offering of a subject in a particular semester."""
293
318
__storm_table__ = "offering"
295
320
id = Int(primary=True, name="offeringid")
320
345
def enrol(self, user, role=u'student'):
321
'''Enrol a user in this offering.'''
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.
322
351
enrolment = Store.of(self).find(Enrolment,
323
352
Enrolment.user_id == user.id,
324
353
Enrolment.offering_id == self.id).one()
346
375
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
348
377
perms.add('edit')
378
# XXX Bug #493945 -- should tutors have these permissions?
379
# Potentially move into the next category (lecturer & admin)
380
perms.add('enrol') # Can see enrolment screen at all
381
perms.add('enrol_student') # Can enrol students
382
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
383
perms.add('enrol_tutor') # Can enrol tutors
385
perms.add('enrol_lecturer') # Can enrol lecturers
351
388
def get_enrolment(self, user):
389
"""Find the user's enrolment in this offering."""
353
391
enrolment = self.enrolments.find(user=user).one()
354
392
except NotOneError:
397
def get_members_by_role(self, role):
398
return Store.of(self).find(User,
399
Enrolment.user_id == User.id,
400
Enrolment.offering_id == self.id,
401
Enrolment.role == role
402
).order_by(User.login)
406
return self.get_members_by_role(u'student')
359
408
class Enrolment(Storm):
409
"""An enrolment of a user in an offering.
411
This represents the roles of both staff and students.
360
414
__storm_table__ = "enrolment"
361
415
__storm_primary__ = "user_id", "offering_id"
387
441
class ProjectSet(Storm):
442
"""A set of projects that share common groups.
444
Each student project group is attached to a project set. The group is
445
valid for all projects in the group's set.
388
448
__storm_table__ = "project_set"
390
450
id = Int(name="projectsetid", primary=True)
401
461
return "<%s %d in %r>" % (type(self).__name__, self.id,
464
def get_permissions(self, user):
465
return self.offering.get_permissions(user)
469
return self.max_students_per_group is not None
473
"""Get the entities (groups or users) assigned to submit this project.
475
This will be a Storm ResultSet.
477
#If its a solo project, return everyone in offering
479
return self.project_groups
481
return self.offering.students
404
483
class Project(Storm):
484
"""A student project for which submissions can be made."""
405
486
__storm_table__ = "project"
407
488
id = Int(name="projectid", primary=True)
432
513
def submit(self, principal, path, revision, who):
433
514
"""Submit a Subversion path and revision to a project.
435
'principal' is the owner of the Subversion repository, and the
436
entity on behalf of whom the submission is being made. 'path' is
437
a path within that repository, and 'revision' specifies which
438
revision of that path. 'who' is the person making the submission.
516
@param principal: The owner of the Subversion repository, and the
517
entity on behalf of whom the submission is being made
518
@param path: A path within that repository to submit.
519
@param revision: The revision of that path to submit.
520
@param who: The user who is actually making the submission.
441
523
if not self.can_submit(principal):
536
def get_permissions(self, user):
537
return self.project_set.offering.get_permissions(user)
540
def latest_submissions(self):
541
"""Return the latest submission for each Assessed."""
542
return Store.of(self).find(ProjectSubmission,
543
Assessed.project_id == self.id,
544
ProjectSubmission.assessed_id == Assessed.id,
545
ProjectSubmission.date_submitted == Select(
546
Max(ProjectSubmission.date_submitted),
547
ProjectSubmission.assessed_id == Assessed.id,
548
tables=ProjectSubmission
455
553
class ProjectGroup(Storm):
554
"""A group of students working together on a project."""
456
556
__storm_table__ = "project_group"
458
558
id = Int(name="groupid", primary=True)
479
579
def display_name(self):
480
return '%s (%s)' % (self.nick, self.name)
580
"""Returns the "nice name" of the user or group."""
584
def short_name(self):
585
"""Returns the database "identifier" name of the user or group."""
482
588
def get_projects(self, offering=None, active_only=True):
483
'''Return Projects that the group can submit.
589
'''Find projects that the group can submit.
485
591
This will include projects in the project set which owns this group,
486
592
unless the project set disallows groups (in which case none will be
489
Unless active_only is False, projects will only be returned if the
490
group's offering is active.
492
If an offering is specified, projects will only be returned if it
595
@param active_only: Whether to only search active offerings.
596
@param offering: An optional offering to restrict the search to.
495
598
return Store.of(self).find(Project,
496
599
Project.project_set_id == ProjectSet.id,
511
614
class ProjectGroupMembership(Storm):
615
"""A student's membership in a project group."""
512
617
__storm_table__ = "group_member"
513
618
__storm_primary__ = "user_id", "project_group_id"
524
629
self.project_group)
526
631
class Assessed(Storm):
632
"""A composite of a user or group combined with a project.
634
Each project submission and extension refers to an Assessed. It is the
635
sole specifier of the repository and project.
527
638
__storm_table__ = "assessed"
529
640
id = Int(name="assessedid", primary=True)
542
653
return "<%s %r in %r>" % (type(self).__name__,
543
654
self.user or self.project_group, self.project)
658
"""True if the Assessed is a group, False if it is a user."""
659
return self.project_group is not None
663
return self.project_group or self.user
546
666
def get(cls, store, principal, project):
667
"""Find or create an Assessed for the given user or group and project.
669
@param principal: The user or group.
670
@param project: The project.
547
672
t = type(principal)
548
673
if t not in (User, ProjectGroup):
549
674
raise AssertionError('principal must be User or ProjectGroup')
568
693
class ProjectExtension(Storm):
694
"""An extension granted to a user or group on a particular project.
696
The user or group and project are specified by the Assessed.
569
699
__storm_table__ = "project_extension"
571
701
id = Int(name="extensionid", primary=True)
577
707
notes = Unicode()
579
709
class ProjectSubmission(Storm):
710
"""A submission from a user or group repository to a particular project.
712
The content of a submission is a single path and revision inside a
713
repository. The repository is that owned by the submission's user and
714
group, while the path and revision are explicit.
716
The user or group and project are specified by the Assessed.
580
719
__storm_table__ = "project_submission"
582
721
id = Int(name="submissionid", primary=True)
592
731
# WORKSHEETS AND EXERCISES #
594
733
class Exercise(Storm):
734
"""An exercise for students to complete in a worksheet.
736
An exercise may be present in any number of worksheets.
595
739
__storm_table__ = "exercise"
596
740
id = Unicode(primary=True, name="identifier")
627
771
perms.add('edit')
628
772
perms.add('view')
629
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
773
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
776
elif u'tutor' in set((e.role for e in user.active_enrolments)):
635
782
def get_description(self):
783
"""Return the description interpreted as reStructuredText."""
636
784
return rst(self.description)
638
786
def delete(self):
644
792
Store.of(self).remove(self)
646
794
class Worksheet(Storm):
795
"""A worksheet with exercises for students to complete.
797
Worksheets are owned by offerings.
647
800
__storm_table__ = "worksheet"
649
802
id = Int(primary=True, name="worksheetid")
675
828
return "<%s %s>" % (type(self).__name__, self.name)
677
830
def remove_all_exercises(self):
679
Remove all exercises from this worksheet.
831
"""Remove all exercises from this worksheet.
680
833
This does not delete the exercises themselves. It just removes them
681
834
from the worksheet.
686
839
raise IntegrityError()
687
840
store.find(WorksheetExercise,
688
841
WorksheetExercise.worksheet == self).remove()
690
843
def get_permissions(self, user):
691
844
return self.offering.get_permissions(user)
693
846
def get_xml(self):
694
847
"""Returns the xml of this worksheet, converts from rst if required."""
695
848
if self.format == u'rst':
701
854
def delete(self):
702
855
"""Deletes the worksheet, provided it has no attempts on any exercises.
704
857
Returns True if delete succeeded, or False if this worksheet has
705
858
attempts attached."""
706
859
for ws_ex in self.all_worksheet_exercises:
707
860
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
708
861
raise IntegrityError()
710
863
self.remove_all_exercises()
711
864
Store.of(self).remove(self)
713
866
class WorksheetExercise(Storm):
867
"""A link between a worksheet and one of its exercises.
869
These may be marked optional, in which case the exercise does not count
870
for marking purposes. The sequence number is used to order the worksheet
714
874
__storm_table__ = "worksheet_exercise"
716
876
id = Int(primary=True, name="ws_ex_id")
718
878
worksheet_id = Int(name="worksheetid")
735
895
def get_permissions(self, user):
736
896
return self.worksheet.get_permissions(user)
739
899
class ExerciseSave(Storm):
741
Represents a potential solution to an exercise that a user has submitted
742
to the server for storage.
743
A basic ExerciseSave is just the current saved text for this exercise for
744
this user (doesn't count towards their attempts).
745
ExerciseSave may be extended with additional semantics (such as
900
"""A potential exercise solution submitted by a user for storage.
902
This is not an actual tested attempt at an exercise, it's just a save of
748
906
__storm_table__ = "exercise_save"
749
907
__storm_primary__ = "ws_ex_id", "user_id"
763
921
self.exercise.name, self.user.login, self.date.strftime("%c"))
765
923
class ExerciseAttempt(ExerciseSave):
767
An ExerciseAttempt is a special case of an ExerciseSave. Like an
768
ExerciseSave, it constitutes exercise solution data that the user has
769
submitted to the server for storage.
770
In addition, it contains additional information about the submission.
771
complete - True if this submission was successful, rendering this exercise
772
complete for this user.
773
active - True if this submission is "active" (usually true). Submissions
774
may be de-activated by privileged users for special reasons, and then
775
they won't count (either as a penalty or success), but will still be
924
"""An attempt at solving an exercise.
926
This is a special case of ExerciseSave, used when the user submits a
927
candidate solution. Like an ExerciseSave, it constitutes exercise solution
930
In addition, it contains information about the result of the submission:
932
- complete - True if this submission was successful, rendering this
933
exercise complete for this user in this worksheet.
934
- active - True if this submission is "active" (usually true).
935
Submissions may be de-activated by privileged users for
936
special reasons, and then they won't count (either as a
937
penalty or success), but will still be stored.
778
940
__storm_table__ = "exercise_attempt"
779
941
__storm_primary__ = "ws_ex_id", "user_id", "date"
783
945
text = Unicode(name="attempt")
784
946
complete = Bool()
787
949
def get_permissions(self, user):
788
950
return set(['view']) if user is self.user else set()
790
952
class TestSuite(Storm):
791
"""A Testsuite acts as a container for the test cases of an exercise."""
953
"""A container to group an exercise's test cases.
955
The test suite contains some information on how to test. The function to
956
test, variables to set and stdin data are stored here.
792
959
__storm_table__ = "test_suite"
793
960
__storm_primary__ = "exercise_id", "suiteid"
796
963
exercise_id = Unicode(name="exerciseid")
797
964
description = Unicode()
801
968
exercise = Reference(exercise_id, Exercise.id)
802
969
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
803
970
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
805
972
def delete(self):
806
973
"""Delete this suite, without asking questions."""
807
for vaariable in self.variables:
974
for variable in self.variables:
808
975
variable.delete()
809
976
for test_case in self.test_cases:
810
977
test_case.delete()
811
978
Store.of(self).remove(self)
813
980
class TestCase(Storm):
814
"""A TestCase is a member of a TestSuite.
816
It contains the data necessary to check if an exercise is correct"""
981
"""A container for actual tests (see TestCasePart), inside a test suite.
983
It is the lowest level shown to students on their pass/fail status."""
817
985
__storm_table__ = "test_case"
818
986
__storm_primary__ = "testid", "suiteid"
822
990
suite = Reference(suiteid, "TestSuite.suiteid")
823
991
passmsg = Unicode()
824
992
failmsg = Unicode()
825
test_default = Unicode()
993
test_default = Unicode() # Currently unused - only used for file matching.
828
996
parts = ReferenceSet(testid, "TestCasePart.testid")
830
998
__init__ = _kwarg_init
832
1000
def delete(self):
833
1001
for part in self.parts:
835
1003
Store.of(self).remove(self)
837
1005
class TestSuiteVar(Storm):
838
"""A container for the arguments of a Test Suite"""
1006
"""A variable used by an exercise test suite.
1008
This may represent a function argument or a normal variable.
839
1011
__storm_table__ = "suite_variable"
840
1012
__storm_primary__ = "varid"
844
1016
var_name = Unicode()
845
1017
var_value = Unicode()
846
1018
var_type = Unicode()
849
1021
suite = Reference(suiteid, "TestSuite.suiteid")
851
1023
__init__ = _kwarg_init
853
1025
def delete(self):
854
1026
Store.of(self).remove(self)
856
1028
class TestCasePart(Storm):
857
"""A container for the test elements of a Test Case"""
1029
"""An actual piece of code to test an exercise solution."""
858
1031
__storm_table__ = "test_case_part"
859
1032
__storm_primary__ = "partid"
864
1037
part_type = Unicode()
865
1038
test_type = Unicode()
866
1039
data = Unicode()
867
1040
filename = Unicode()
869
1042
test = Reference(testid, "TestCase.testid")
871
1044
__init__ = _kwarg_init
873
1046
def delete(self):
874
1047
Store.of(self).remove(self)
added
removed
ivle/database.py
