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
34
from ivle.worksheet.rst import rst
169
165
# TODO: Invitations should be listed too?
170
166
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.
176
168
ProjectGroupMembership.user_id == self.id,
177
169
ProjectGroup.id == ProjectGroupMembership.project_group_id,
198
190
return self._get_enrolments(False)
200
192
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
193
'''Return Projects that the user can submit.
203
195
This will include projects for offerings in which the user is
204
196
enrolled, as long as the project is not in a project set which has
205
197
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.
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.
210
205
return Store.of(self).find(Project,
211
206
Project.project_set_id == ProjectSet.id,
212
207
ProjectSet.max_students_per_group == None,
221
216
def hash_password(password):
222
"""Hash a password with MD5."""
223
217
return hashlib.md5(password).hexdigest()
226
220
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
222
Get the User from the db associated with a given store and
228
225
return store.find(cls, cls.login == unicode(login)).one()
230
227
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
228
if user and user.admin or user is self:
237
return set(['view_public', 'view', 'edit', 'submit_project'])
229
return set(['view', 'edit', 'submit_project'])
239
return set(['view_public'])
241
233
# SUBJECTS AND ENROLMENTS #
243
235
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
236
__storm_table__ = "subject"
248
238
id = Int(primary=True, name="subjectid")
259
249
return "<%s '%s'>" % (type(self).__name__, self.short_name)
261
251
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.
268
253
if user is not None:
269
254
perms.add('view')
274
259
def active_offerings(self):
275
"""Find active offerings for this subject.
277
Return a sequence of currently active offerings for this subject
260
"""Return a sequence of currently active offerings for this subject
278
261
(offerings whose semester.state is "current"). There should be 0 or 1
279
262
elements in this sequence, but it's possible there are more.
282
265
Semester.state == u'current')
284
267
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.
268
"""Get the offering for the given year/semester, or None."""
290
269
return self.offerings.find(Offering.semester_id == Semester.id,
291
270
Semester.year == unicode(year),
292
271
Semester.semester == unicode(semester)).one()
294
273
class Semester(Storm):
295
"""A semester in which subjects can be run."""
297
274
__storm_table__ = "semester"
299
276
id = Int(primary=True, name="semesterid")
313
290
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
315
292
class Offering(Storm):
316
"""An offering of a subject in a particular semester."""
318
293
__storm_table__ = "offering"
320
295
id = Int(primary=True, name="offeringid")
345
320
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.
321
'''Enrol a user in this offering.'''
351
322
enrolment = Store.of(self).find(Enrolment,
352
323
Enrolment.user_id == user.id,
353
324
Enrolment.offering_id == self.id).one()
375
346
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
377
348
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
388
351
def get_enrolment(self, user):
389
"""Find the user's enrolment in this offering."""
391
353
enrolment = self.enrolments.find(user=user).one()
392
354
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')
408
359
class Enrolment(Storm):
409
"""An enrolment of a user in an offering.
411
This represents the roles of both staff and students.
414
360
__storm_table__ = "enrolment"
415
361
__storm_primary__ = "user_id", "offering_id"
441
387
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.
448
388
__storm_table__ = "project_set"
450
390
id = Int(name="projectsetid", primary=True)
461
401
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
483
404
class Project(Storm):
484
"""A student project for which submissions can be made."""
486
405
__storm_table__ = "project"
488
407
id = Int(name="projectid", primary=True)
513
432
def submit(self, principal, path, revision, who):
514
433
"""Submit a Subversion path and revision to a project.
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.
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.
523
441
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
553
455
class ProjectGroup(Storm):
554
"""A group of students working together on a project."""
556
456
__storm_table__ = "project_group"
558
458
id = Int(name="groupid", primary=True)
579
479
def display_name(self):
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."""
480
return '%s (%s)' % (self.nick, self.name)
588
482
def get_projects(self, offering=None, active_only=True):
589
'''Find projects that the group can submit.
483
'''Return Projects that the group can submit.
591
485
This will include projects in the project set which owns this group,
592
486
unless the project set disallows groups (in which case none will be
595
@param active_only: Whether to only search active offerings.
596
@param offering: An optional offering to restrict the search to.
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
598
495
return Store.of(self).find(Project,
599
496
Project.project_set_id == ProjectSet.id,
614
511
class ProjectGroupMembership(Storm):
615
"""A student's membership in a project group."""
617
512
__storm_table__ = "group_member"
618
513
__storm_primary__ = "user_id", "project_group_id"
629
524
self.project_group)
631
526
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.
638
527
__storm_table__ = "assessed"
640
529
id = Int(name="assessedid", primary=True)
653
542
return "<%s %r in %r>" % (type(self).__name__,
654
543
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
666
546
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.
672
547
t = type(principal)
673
548
if t not in (User, ProjectGroup):
674
549
raise AssertionError('principal must be User or ProjectGroup')
693
568
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.
699
569
__storm_table__ = "project_extension"
701
571
id = Int(name="extensionid", primary=True)
707
577
notes = Unicode()
709
579
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.
719
580
__storm_table__ = "project_submission"
721
582
id = Int(name="submissionid", primary=True)
731
592
# WORKSHEETS AND EXERCISES #
733
594
class Exercise(Storm):
734
"""An exercise for students to complete in a worksheet.
736
An exercise may be present in any number of worksheets.
739
595
__storm_table__ = "exercise"
740
596
id = Unicode(primary=True, name="identifier")
771
627
perms.add('edit')
772
628
perms.add('view')
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)):
629
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
782
635
def get_description(self):
783
"""Return the description interpreted as reStructuredText."""
784
636
return rst(self.description)
786
638
def delete(self):
792
644
Store.of(self).remove(self)
794
646
class Worksheet(Storm):
795
"""A worksheet with exercises for students to complete.
797
Worksheets are owned by offerings.
800
647
__storm_table__ = "worksheet"
802
649
id = Int(primary=True, name="worksheetid")
828
675
return "<%s %s>" % (type(self).__name__, self.name)
830
677
def remove_all_exercises(self):
831
"""Remove all exercises from this worksheet.
679
Remove all exercises from this worksheet.
833
680
This does not delete the exercises themselves. It just removes them
834
681
from the worksheet.
839
686
raise IntegrityError()
840
687
store.find(WorksheetExercise,
841
688
WorksheetExercise.worksheet == self).remove()
843
690
def get_permissions(self, user):
844
691
return self.offering.get_permissions(user)
846
693
def get_xml(self):
847
694
"""Returns the xml of this worksheet, converts from rst if required."""
848
695
if self.format == u'rst':
854
701
def delete(self):
855
702
"""Deletes the worksheet, provided it has no attempts on any exercises.
857
704
Returns True if delete succeeded, or False if this worksheet has
858
705
attempts attached."""
859
706
for ws_ex in self.all_worksheet_exercises:
860
707
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
861
708
raise IntegrityError()
863
710
self.remove_all_exercises()
864
711
Store.of(self).remove(self)
866
713
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
874
714
__storm_table__ = "worksheet_exercise"
876
716
id = Int(primary=True, name="ws_ex_id")
878
718
worksheet_id = Int(name="worksheetid")
895
735
def get_permissions(self, user):
896
736
return self.worksheet.get_permissions(user)
899
739
class ExerciseSave(Storm):
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
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
906
748
__storm_table__ = "exercise_save"
907
749
__storm_primary__ = "ws_ex_id", "user_id"
921
763
self.exercise.name, self.user.login, self.date.strftime("%c"))
923
765
class ExerciseAttempt(ExerciseSave):
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.
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
940
778
__storm_table__ = "exercise_attempt"
941
779
__storm_primary__ = "ws_ex_id", "user_id", "date"
945
783
text = Unicode(name="attempt")
946
784
complete = Bool()
949
787
def get_permissions(self, user):
950
788
return set(['view']) if user is self.user else set()
952
790
class TestSuite(Storm):
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.
791
"""A Testsuite acts as a container for the test cases of an exercise."""
959
792
__storm_table__ = "test_suite"
960
793
__storm_primary__ = "exercise_id", "suiteid"
963
796
exercise_id = Unicode(name="exerciseid")
964
797
description = Unicode()
968
801
exercise = Reference(exercise_id, Exercise.id)
969
802
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
970
803
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
972
805
def delete(self):
973
806
"""Delete this suite, without asking questions."""
974
for variable in self.variables:
807
for vaariable in self.variables:
975
808
variable.delete()
976
809
for test_case in self.test_cases:
977
810
test_case.delete()
978
811
Store.of(self).remove(self)
980
813
class TestCase(Storm):
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."""
814
"""A TestCase is a member of a TestSuite.
816
It contains the data necessary to check if an exercise is correct"""
985
817
__storm_table__ = "test_case"
986
818
__storm_primary__ = "testid", "suiteid"
990
822
suite = Reference(suiteid, "TestSuite.suiteid")
991
823
passmsg = Unicode()
992
824
failmsg = Unicode()
993
test_default = Unicode() # Currently unused - only used for file matching.
825
test_default = Unicode()
996
828
parts = ReferenceSet(testid, "TestCasePart.testid")
998
830
__init__ = _kwarg_init
1000
832
def delete(self):
1001
833
for part in self.parts:
1003
835
Store.of(self).remove(self)
1005
837
class TestSuiteVar(Storm):
1006
"""A variable used by an exercise test suite.
1008
This may represent a function argument or a normal variable.
838
"""A container for the arguments of a Test Suite"""
1011
839
__storm_table__ = "suite_variable"
1012
840
__storm_primary__ = "varid"
1016
844
var_name = Unicode()
1017
845
var_value = Unicode()
1018
846
var_type = Unicode()
1021
849
suite = Reference(suiteid, "TestSuite.suiteid")
1023
851
__init__ = _kwarg_init
1025
853
def delete(self):
1026
854
Store.of(self).remove(self)
1028
856
class TestCasePart(Storm):
1029
"""An actual piece of code to test an exercise solution."""
857
"""A container for the test elements of a Test Case"""
1031
858
__storm_table__ = "test_case_part"
1032
859
__storm_primary__ = "partid"
1037
864
part_type = Unicode()
1038
865
test_type = Unicode()
1039
866
data = Unicode()
1040
867
filename = Unicode()
1042
869
test = Reference(testid, "TestCase.testid")
1044
871
__init__ = _kwarg_init
1046
873
def delete(self):
1047
874
Store.of(self).remove(self)
added
removed
ivle/database.py
