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")
249
239
code = Unicode(name="subj_code")
250
240
name = Unicode(name="subj_name")
251
241
short_name = Unicode(name="subj_short_name")
253
244
offerings = ReferenceSet(id, 'Offering.subject_id')
258
249
return "<%s '%s'>" % (type(self).__name__, self.short_name)
260
251
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
253
if user is not None:
268
254
perms.add('view')
273
259
def active_offerings(self):
274
"""Find active offerings for this subject.
276
Return a sequence of currently active offerings for this subject
260
"""Return a sequence of currently active offerings for this subject
277
261
(offerings whose semester.state is "current"). There should be 0 or 1
278
262
elements in this sequence, but it's possible there are more.
281
265
Semester.state == u'current')
283
267
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.
268
"""Get the offering for the given year/semester, or None."""
289
269
return self.offerings.find(Offering.semester_id == Semester.id,
290
270
Semester.year == unicode(year),
291
271
Semester.semester == unicode(semester)).one()
293
273
class Semester(Storm):
294
"""A semester in which subjects can be run."""
296
274
__storm_table__ = "semester"
298
276
id = Int(primary=True, name="semesterid")
312
290
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
314
292
class Offering(Storm):
315
"""An offering of a subject in a particular semester."""
317
293
__storm_table__ = "offering"
319
295
id = Int(primary=True, name="offeringid")
321
297
subject = Reference(subject_id, Subject.id)
322
298
semester_id = Int(name="semesterid")
323
299
semester = Reference(semester_id, Semester.id)
324
description = Unicode()
326
300
groups_student_permissions = Unicode()
328
302
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
331
305
'Enrolment.user_id',
333
307
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
334
projects = ReferenceSet(id,
335
'ProjectSet.offering_id',
337
'Project.project_set_id')
339
309
worksheets = ReferenceSet(id,
340
310
'Worksheet.offering_id',
350
320
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.
321
'''Enrol a user in this offering.'''
356
322
enrolment = Store.of(self).find(Enrolment,
357
323
Enrolment.user_id == user.id,
358
324
Enrolment.offering_id == self.id).one()
380
346
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
382
348
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
351
def get_enrolment(self, user):
394
"""Find the user's enrolment in this offering."""
396
353
enrolment = self.enrolments.find(user=user).one()
397
354
except NotOneError:
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
359
class Enrolment(Storm):
419
"""An enrolment of a user in an offering.
421
This represents the roles of both staff and students.
424
360
__storm_table__ = "enrolment"
425
361
__storm_primary__ = "user_id", "offering_id"
451
387
class ProjectSet(Storm):
452
"""A set of projects that share common groups.
454
Each student project group is attached to a project set. The group is
455
valid for all projects in the group's set.
458
388
__storm_table__ = "project_set"
460
390
id = Int(name="projectsetid", primary=True)
471
401
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
404
class Project(Storm):
527
"""A student project for which submissions can be made."""
529
405
__storm_table__ = "project"
531
407
id = Int(name="projectid", primary=True)
549
425
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
550
426
self.project_set.offering)
552
def can_submit(self, principal, user):
428
def can_submit(self, principal):
553
429
return (self in principal.get_projects() and
554
not self.has_deadline_passed(user))
430
self.deadline > datetime.datetime.now())
556
432
def submit(self, principal, path, revision, who):
557
433
"""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.
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.
566
if not self.can_submit(principal, who):
567
raise DeadlinePassed()
441
if not self.can_submit(principal):
442
raise Exception('cannot submit')
569
444
a = Assessed.get(Store.of(self), principal, self)
570
445
ps = ProjectSubmission()
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
455
class ProjectGroup(Storm):
610
"""A group of students working together on a project."""
612
456
__storm_table__ = "project_group"
614
458
id = Int(name="groupid", primary=True)
635
479
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."""
480
return '%s (%s)' % (self.nick, self.name)
644
482
def get_projects(self, offering=None, active_only=True):
645
'''Find projects that the group can submit.
483
'''Return Projects that the group can submit.
647
485
This will include projects in the project set which owns this group,
648
486
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.
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
654
495
return Store.of(self).find(Project,
655
496
Project.project_set_id == ProjectSet.id,
670
511
class ProjectGroupMembership(Storm):
671
"""A student's membership in a project group."""
673
512
__storm_table__ = "group_member"
674
513
__storm_primary__ = "user_id", "project_group_id"
685
524
self.project_group)
687
526
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
527
__storm_table__ = "assessed"
696
529
id = Int(name="assessedid", primary=True)
703
536
project = Reference(project_id, Project.id)
705
538
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
706
submissions = ReferenceSet(
707
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
539
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
709
541
def __repr__(self):
710
542
return "<%s %r in %r>" % (type(self).__name__,
711
543
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 checkout_location(self):
724
"""Returns the location of the Subversion workspace for this piece of
725
assessment, relative to each group member's home directory."""
726
subjectname = self.project.project_set.offering.subject.short_name
728
checkout_dir_name = self.principal.short_name
730
checkout_dir_name = "mywork"
731
return subjectname + "/" + checkout_dir_name
734
546
def get(cls, store, principal, project):
735
"""Find or create an Assessed for the given user or group and project.
737
@param principal: The user or group.
738
@param project: The project.
740
547
t = type(principal)
741
548
if t not in (User, ProjectGroup):
742
549
raise AssertionError('principal must be User or ProjectGroup')
744
551
a = store.find(cls,
745
552
(t is User) or (cls.project_group_id == principal.id),
746
553
(t is ProjectGroup) or (cls.user_id == principal.id),
747
cls.project_id == project.id).one()
554
Project.id == project.id).one()
761
568
class ProjectExtension(Storm):
762
"""An extension granted to a user or group on a particular project.
764
The user or group and project are specified by the Assessed.
767
569
__storm_table__ = "project_extension"
769
571
id = Int(name="extensionid", primary=True)
775
577
notes = Unicode()
777
579
class ProjectSubmission(Storm):
778
"""A submission from a user or group repository to a particular project.
780
The content of a submission is a single path and revision inside a
781
repository. The repository is that owned by the submission's user and
782
group, while the path and revision are explicit.
784
The user or group and project are specified by the Assessed.
787
580
__storm_table__ = "project_submission"
789
582
id = Int(name="submissionid", primary=True)
795
588
submitter = Reference(submitter_id, User.id)
796
589
date_submitted = DateTime()
798
def get_verify_url(self, user):
799
"""Get the URL for verifying this submission, within the account of
801
# If this is a solo project, then self.path will be prefixed with the
802
# subject name. Remove the first path segment.
803
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
804
if not self.assessed.is_group:
805
if '/' in submitpath:
806
submitpath = submitpath.split('/', 1)[1]
809
return "/files/%s/%s/%s?r=%d" % (user.login,
810
self.assessed.checkout_location, submitpath, self.revision)
812
592
# WORKSHEETS AND EXERCISES #
814
594
class Exercise(Storm):
815
"""An exercise for students to complete in a worksheet.
817
An exercise may be present in any number of worksheets.
820
595
__storm_table__ = "exercise"
821
596
id = Unicode(primary=True, name="identifier")
852
627
perms.add('edit')
853
628
perms.add('view')
854
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
857
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)):
863
635
def get_description(self):
864
"""Return the description interpreted as reStructuredText."""
865
636
return rst(self.description)
867
638
def delete(self):
873
644
Store.of(self).remove(self)
875
646
class Worksheet(Storm):
876
"""A worksheet with exercises for students to complete.
878
Worksheets are owned by offerings.
881
647
__storm_table__ = "worksheet"
883
649
id = Int(primary=True, name="worksheetid")
909
675
return "<%s %s>" % (type(self).__name__, self.name)
911
677
def remove_all_exercises(self):
912
"""Remove all exercises from this worksheet.
679
Remove all exercises from this worksheet.
914
680
This does not delete the exercises themselves. It just removes them
915
681
from the worksheet.
920
686
raise IntegrityError()
921
687
store.find(WorksheetExercise,
922
688
WorksheetExercise.worksheet == self).remove()
924
690
def get_permissions(self, user):
925
691
return self.offering.get_permissions(user)
927
693
def get_xml(self):
928
694
"""Returns the xml of this worksheet, converts from rst if required."""
929
695
if self.format == u'rst':
935
701
def delete(self):
936
702
"""Deletes the worksheet, provided it has no attempts on any exercises.
938
704
Returns True if delete succeeded, or False if this worksheet has
939
705
attempts attached."""
940
706
for ws_ex in self.all_worksheet_exercises:
941
707
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
942
708
raise IntegrityError()
944
710
self.remove_all_exercises()
945
711
Store.of(self).remove(self)
947
713
class WorksheetExercise(Storm):
948
"""A link between a worksheet and one of its exercises.
950
These may be marked optional, in which case the exercise does not count
951
for marking purposes. The sequence number is used to order the worksheet
955
714
__storm_table__ = "worksheet_exercise"
957
716
id = Int(primary=True, name="ws_ex_id")
959
718
worksheet_id = Int(name="worksheetid")
976
735
def get_permissions(self, user):
977
736
return self.worksheet.get_permissions(user)
980
739
class ExerciseSave(Storm):
981
"""A potential exercise solution submitted by a user for storage.
983
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
987
748
__storm_table__ = "exercise_save"
988
749
__storm_primary__ = "ws_ex_id", "user_id"
1002
763
self.exercise.name, self.user.login, self.date.strftime("%c"))
1004
765
class ExerciseAttempt(ExerciseSave):
1005
"""An attempt at solving an exercise.
1007
This is a special case of ExerciseSave, used when the user submits a
1008
candidate solution. Like an ExerciseSave, it constitutes exercise solution
1011
In addition, it contains information about the result of the submission:
1013
- complete - True if this submission was successful, rendering this
1014
exercise complete for this user in this worksheet.
1015
- active - True if this submission is "active" (usually true).
1016
Submissions may be de-activated by privileged users for
1017
special reasons, and then they won't count (either as a
1018
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
1021
778
__storm_table__ = "exercise_attempt"
1022
779
__storm_primary__ = "ws_ex_id", "user_id", "date"
1026
783
text = Unicode(name="attempt")
1027
784
complete = Bool()
1030
787
def get_permissions(self, user):
1031
788
return set(['view']) if user is self.user else set()
1033
790
class TestSuite(Storm):
1034
"""A container to group an exercise's test cases.
1036
The test suite contains some information on how to test. The function to
1037
test, variables to set and stdin data are stored here.
791
"""A Testsuite acts as a container for the test cases of an exercise."""
1040
792
__storm_table__ = "test_suite"
1041
793
__storm_primary__ = "exercise_id", "suiteid"
1044
796
exercise_id = Unicode(name="exerciseid")
1045
797
description = Unicode()
1049
801
exercise = Reference(exercise_id, Exercise.id)
1050
802
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
1051
803
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
1053
805
def delete(self):
1054
806
"""Delete this suite, without asking questions."""
1055
for variable in self.variables:
807
for vaariable in self.variables:
1056
808
variable.delete()
1057
809
for test_case in self.test_cases:
1058
810
test_case.delete()
1059
811
Store.of(self).remove(self)
1061
813
class TestCase(Storm):
1062
"""A container for actual tests (see TestCasePart), inside a test suite.
1064
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"""
1066
817
__storm_table__ = "test_case"
1067
818
__storm_primary__ = "testid", "suiteid"
1071
822
suite = Reference(suiteid, "TestSuite.suiteid")
1072
823
passmsg = Unicode()
1073
824
failmsg = Unicode()
1074
test_default = Unicode() # Currently unused - only used for file matching.
825
test_default = Unicode()
1077
828
parts = ReferenceSet(testid, "TestCasePart.testid")
1079
830
__init__ = _kwarg_init
1081
832
def delete(self):
1082
833
for part in self.parts:
1084
835
Store.of(self).remove(self)
1086
837
class TestSuiteVar(Storm):
1087
"""A variable used by an exercise test suite.
1089
This may represent a function argument or a normal variable.
838
"""A container for the arguments of a Test Suite"""
1092
839
__storm_table__ = "suite_variable"
1093
840
__storm_primary__ = "varid"
1097
844
var_name = Unicode()
1098
845
var_value = Unicode()
1099
846
var_type = Unicode()
1102
849
suite = Reference(suiteid, "TestSuite.suiteid")
1104
851
__init__ = _kwarg_init
1106
853
def delete(self):
1107
854
Store.of(self).remove(self)
1109
856
class TestCasePart(Storm):
1110
"""An actual piece of code to test an exercise solution."""
857
"""A container for the test elements of a Test Case"""
1112
858
__storm_table__ = "test_case_part"
1113
859
__storm_primary__ = "partid"
1118
864
part_type = Unicode()
1119
865
test_type = Unicode()
1120
866
data = Unicode()
1121
867
filename = Unicode()
1123
869
test = Reference(testid, "TestCase.testid")
1125
871
__init__ = _kwarg_init
1127
873
def delete(self):
1128
874
Store.of(self).remove(self)
added
removed
ivle/database.py
