410
218
user = Reference(user_id, User.id)
411
219
offering_id = Int(name="offeringid")
412
220
offering = Reference(offering_id, Offering.id)
419
return Store.of(self).find(ProjectGroup,
420
ProjectSet.offering_id == self.offering.id,
421
ProjectGroup.project_set_id == ProjectSet.id,
422
ProjectGroupMembership.project_group_id == ProjectGroup.id,
423
ProjectGroupMembership.user_id == self.user.id)
425
__init__ = _kwarg_init
428
return "<%s %r in %r>" % (type(self).__name__, self.user,
433
class ProjectSet(Storm):
434
"""A set of projects that share common groups.
436
Each student project group is attached to a project set. The group is
437
valid for all projects in the group's set.
440
__storm_table__ = "project_set"
442
id = Int(name="projectsetid", primary=True)
443
offering_id = Int(name="offeringid")
444
offering = Reference(offering_id, Offering.id)
445
max_students_per_group = Int()
447
projects = ReferenceSet(id, 'Project.project_set_id')
448
project_groups = ReferenceSet(id, 'ProjectGroup.project_set_id')
450
__init__ = _kwarg_init
453
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
class Project(Storm):
472
"""A student project for which submissions can be made."""
474
__storm_table__ = "project"
476
id = Int(name="projectid", primary=True)
478
short_name = Unicode()
481
project_set_id = Int(name="projectsetid")
482
project_set = Reference(project_set_id, ProjectSet.id)
483
deadline = DateTime()
485
assesseds = ReferenceSet(id, 'Assessed.project_id')
486
submissions = ReferenceSet(id,
487
'Assessed.project_id',
489
'ProjectSubmission.assessed_id')
491
__init__ = _kwarg_init
494
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
495
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
class ProjectGroup(Storm):
542
"""A group of students working together on a project."""
544
__storm_table__ = "project_group"
546
id = Int(name="groupid", primary=True)
547
name = Unicode(name="groupnm")
548
project_set_id = Int(name="projectsetid")
549
project_set = Reference(project_set_id, ProjectSet.id)
551
created_by_id = Int(name="createdby")
552
created_by = Reference(created_by_id, User.id)
555
members = ReferenceSet(id,
556
"ProjectGroupMembership.project_group_id",
557
"ProjectGroupMembership.user_id",
560
__init__ = _kwarg_init
563
return "<%s %s in %r>" % (type(self).__name__, self.name,
564
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
class ProjectGroupMembership(Storm):
603
"""A student's membership in a project group."""
605
__storm_table__ = "group_member"
606
__storm_primary__ = "user_id", "project_group_id"
608
user_id = Int(name="loginid")
609
user = Reference(user_id, User.id)
610
project_group_id = Int(name="groupid")
611
project_group = Reference(project_group_id, ProjectGroup.id)
613
__init__ = _kwarg_init
616
return "<%s %r in %r>" % (type(self).__name__, self.user,
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
# WORKSHEETS AND EXERCISES #
721
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
__storm_table__ = "exercise"
728
id = Unicode(primary=True, name="identifier")
730
description = Unicode()
736
worksheet_exercises = ReferenceSet(id,
737
'WorksheetExercise.exercise_id')
739
worksheets = ReferenceSet(id,
740
'WorksheetExercise.exercise_id',
741
'WorksheetExercise.worksheet_id',
745
test_suites = ReferenceSet(id,
746
'TestSuite.exercise_id',
749
__init__ = _kwarg_init
752
return "<%s %s>" % (type(self).__name__, self.name)
754
def get_permissions(self, user):
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
class Worksheet(Storm):
783
"""A worksheet with exercises for students to complete.
785
Worksheets are owned by offerings.
788
__storm_table__ = "worksheet"
790
id = Int(primary=True, name="worksheetid")
791
offering_id = Int(name="offeringid")
792
identifier = Unicode()
799
attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
800
offering = Reference(offering_id, 'Offering.id')
802
all_worksheet_exercises = ReferenceSet(id,
803
'WorksheetExercise.worksheet_id')
805
# Use worksheet_exercises to get access to the *active* WorksheetExercise
806
# objects binding worksheets to exercises. This is required to access the
810
def worksheet_exercises(self):
811
return self.all_worksheet_exercises.find(active=True)
813
__init__ = _kwarg_init
816
return "<%s %s>" % (type(self).__name__, self.name)
818
def remove_all_exercises(self):
819
"""Remove all exercises from this worksheet.
821
This does not delete the exercises themselves. It just removes them
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
store.find(WorksheetExercise,
829
WorksheetExercise.worksheet == self).remove()
831
def get_permissions(self, user):
832
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
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
__storm_table__ = "worksheet_exercise"
864
id = Int(primary=True, name="ws_ex_id")
866
worksheet_id = Int(name="worksheetid")
867
worksheet = Reference(worksheet_id, Worksheet.id)
868
exercise_id = Unicode(name="exerciseid")
869
exercise = Reference(exercise_id, Exercise.id)
874
saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
875
attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
877
__init__ = _kwarg_init
880
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
881
self.worksheet.identifier)
883
def get_permissions(self, user):
884
return self.worksheet.get_permissions(user)
887
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
894
__storm_table__ = "exercise_save"
895
__storm_primary__ = "ws_ex_id", "user_id"
897
ws_ex_id = Int(name="ws_ex_id")
898
worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
900
user_id = Int(name="loginid")
901
user = Reference(user_id, User.id)
905
__init__ = _kwarg_init
908
return "<%s %s by %s at %s>" % (type(self).__name__,
909
self.exercise.name, self.user.login, self.date.strftime("%c"))
911
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.
928
__storm_table__ = "exercise_attempt"
929
__storm_primary__ = "ws_ex_id", "user_id", "date"
931
# The "text" field is the same but has a different name in the DB table
933
text = Unicode(name="attempt")
937
def get_permissions(self, user):
938
return set(['view']) if user is self.user else set()
940
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.
947
__storm_table__ = "test_suite"
948
__storm_primary__ = "exercise_id", "suiteid"
951
exercise_id = Unicode(name="exerciseid")
952
description = Unicode()
956
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)
968
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."""
973
__storm_table__ = "test_case"
974
__storm_primary__ = "testid", "suiteid"
978
suite = Reference(suiteid, "TestSuite.suiteid")
981
test_default = Unicode()
984
parts = ReferenceSet(testid, "TestCasePart.testid")
986
__init__ = _kwarg_init
989
for part in self.parts:
991
Store.of(self).remove(self)
993
class TestSuiteVar(Storm):
994
"""A variable used by an exercise test suite.
996
This may represent a function argument or a normal variable.
999
__storm_table__ = "suite_variable"
1000
__storm_primary__ = "varid"
1004
var_name = Unicode()
1005
var_value = Unicode()
1006
var_type = Unicode()
1009
suite = Reference(suiteid, "TestSuite.suiteid")
1011
__init__ = _kwarg_init
1014
Store.of(self).remove(self)
1016
class TestCasePart(Storm):
1017
"""An actual piece of code to test an exercise solution."""
1019
__storm_table__ = "test_case_part"
1020
__storm_primary__ = "partid"
1025
part_type = Unicode()
1026
test_type = Unicode()
1028
filename = Unicode()
1030
test = Reference(testid, "TestCase.testid")
1032
__init__ = _kwarg_init
1035
Store.of(self).remove(self)
224
__init__ = _kwarg_init
227
return "<%s %r in %r>" % (type(self).__name__, self.user,
added
removed
ivle/database.py
