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
35
from ivle.worksheet.rst import rst
36
37
__all__ = ['get_store',
38
39
'Subject', 'Semester', 'Offering', 'Enrolment',
39
40
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
41
'Exercise', 'Worksheet', 'WorksheetExercise',
42
42
'ExerciseSave', 'ExerciseAttempt',
43
43
'TestCase', 'TestSuite', 'TestSuiteVar'
50
50
% (self.__class__.__name__, k))
51
51
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.
53
def get_conn_string():
55
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']
60
clusterstr += ivle.conf.db_user
61
if ivle.conf.db_password:
62
clusterstr += ':' + ivle.conf.db_password
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
65
host = ivle.conf.db_host or 'localhost'
66
port = ivle.conf.db_port or 5432
69
68
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)))
70
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
74
Open a database connection and transaction. Return a storm.store.Store
75
instance connected to the configured IVLE database.
77
return Store(create_database(get_conn_string()))
83
"""An IVLE user account."""
83
Represents an IVLE user.
84
85
__storm_table__ = "login"
86
87
id = Int(primary=True, name="loginid")
197
184
'''A sanely ordered list of all of the user's enrolments.'''
198
185
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
188
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
189
return md5.md5(password).hexdigest()
226
192
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
194
Get the User from the db associated with a given store and
228
197
return store.find(cls, cls.login == unicode(login)).one()
230
199
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
200
if user and user.admin or user is self:
237
return set(['view', 'edit', 'submit_project'])
201
return set(['view', 'edit'])
241
205
# SUBJECTS AND ENROLMENTS #
243
207
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
208
__storm_table__ = "subject"
248
210
id = Int(primary=True, name="subjectid")
271
228
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
231
class Semester(Storm):
295
"""A semester in which subjects can be run."""
297
232
__storm_table__ = "semester"
299
234
id = Int(primary=True, name="semesterid")
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
317
class Enrolment(Storm):
401
"""An enrolment of a user in an offering.
403
This represents the roles of both staff and students.
406
318
__storm_table__ = "enrolment"
407
319
__storm_primary__ = "user_id", "offering_id"
453
359
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
362
class Project(Storm):
472
"""A student project for which submissions can be made."""
474
363
__storm_table__ = "project"
476
365
id = Int(name="projectid", primary=True)
478
short_name = Unicode()
479
366
synopsis = Unicode()
481
368
project_set_id = Int(name="projectsetid")
482
369
project_set = Reference(project_set_id, ProjectSet.id)
483
370
deadline = DateTime()
485
assesseds = ReferenceSet(id, 'Assessed.project_id')
486
submissions = ReferenceSet(id,
487
'Assessed.project_id',
489
'ProjectSubmission.assessed_id')
491
372
__init__ = _kwarg_init
493
374
def __repr__(self):
494
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
375
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
495
376
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
378
class ProjectGroup(Storm):
542
"""A group of students working together on a project."""
544
379
__storm_table__ = "project_group"
546
381
id = Int(name="groupid", primary=True)
563
398
return "<%s %s in %r>" % (type(self).__name__, self.name,
564
399
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
401
class ProjectGroupMembership(Storm):
603
"""A student's membership in a project group."""
605
402
__storm_table__ = "group_member"
606
403
__storm_primary__ = "user_id", "project_group_id"
616
413
return "<%s %r in %r>" % (type(self).__name__, self.user,
617
414
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
416
# WORKSHEETS AND EXERCISES #
721
418
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
419
__storm_table__ = "exercise"
728
420
id = Unicode(primary=True, name="identifier")
815
498
def __repr__(self):
816
499
return "<%s %s>" % (type(self).__name__, self.name)
501
# XXX Refactor this - make it an instance method of Subject rather than a
502
# class method of Worksheet. Can't do that now because Subject isn't
503
# linked referentially to the Worksheet.
505
def get_by_name(cls, store, subjectname, worksheetname):
507
Get the Worksheet from the db associated with a given store, subject
508
name and worksheet name.
510
return store.find(cls, cls.subject == unicode(subjectname),
511
cls.name == unicode(worksheetname)).one()
818
513
def remove_all_exercises(self):
819
"""Remove all exercises from this worksheet.
515
Remove all exercises from this worksheet.
821
516
This does not delete the exercises themselves. It just removes them
822
517
from the worksheet.
842
537
def delete(self):
843
538
"""Deletes the worksheet, provided it has no attempts on any exercises.
845
540
Returns True if delete succeeded, or False if this worksheet has
846
541
attempts attached."""
847
542
for ws_ex in self.all_worksheet_exercises:
848
543
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
849
544
raise IntegrityError()
851
546
self.remove_all_exercises()
852
547
Store.of(self).remove(self)
854
549
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
550
__storm_table__ = "worksheet_exercise"
864
552
id = Int(primary=True, name="ws_ex_id")
866
554
worksheet_id = Int(name="worksheetid")
883
571
def get_permissions(self, user):
884
572
return self.worksheet.get_permissions(user)
887
575
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
577
Represents a potential solution to an exercise that a user has submitted
578
to the server for storage.
579
A basic ExerciseSave is just the current saved text for this exercise for
580
this user (doesn't count towards their attempts).
581
ExerciseSave may be extended with additional semantics (such as
894
584
__storm_table__ = "exercise_save"
895
585
__storm_primary__ = "ws_ex_id", "user_id"
909
599
self.exercise.name, self.user.login, self.date.strftime("%c"))
911
601
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.
603
An ExerciseAttempt is a special case of an ExerciseSave. Like an
604
ExerciseSave, it constitutes exercise solution data that the user has
605
submitted to the server for storage.
606
In addition, it contains additional information about the submission.
607
complete - True if this submission was successful, rendering this exercise
608
complete for this user.
609
active - True if this submission is "active" (usually true). Submissions
610
may be de-activated by privileged users for special reasons, and then
611
they won't count (either as a penalty or success), but will still be
928
614
__storm_table__ = "exercise_attempt"
929
615
__storm_primary__ = "ws_ex_id", "user_id", "date"
933
619
text = Unicode(name="attempt")
934
620
complete = Bool()
937
623
def get_permissions(self, user):
938
624
return set(['view']) if user is self.user else set()
940
626
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.
627
"""A Testsuite acts as a container for the test cases of an exercise."""
947
628
__storm_table__ = "test_suite"
948
629
__storm_primary__ = "exercise_id", "suiteid"
951
632
exercise_id = Unicode(name="exerciseid")
952
633
description = Unicode()
980
660
failmsg = Unicode()
981
661
test_default = Unicode()
984
664
parts = ReferenceSet(testid, "TestCasePart.testid")
986
666
__init__ = _kwarg_init
988
668
def delete(self):
989
669
for part in self.parts:
991
671
Store.of(self).remove(self)
993
673
class TestSuiteVar(Storm):
994
"""A variable used by an exercise test suite.
996
This may represent a function argument or a normal variable.
674
"""A container for the arguments of a Test Suite"""
999
675
__storm_table__ = "suite_variable"
1000
676
__storm_primary__ = "varid"
1004
680
var_name = Unicode()
1005
681
var_value = Unicode()
1006
682
var_type = Unicode()
1009
685
suite = Reference(suiteid, "TestSuite.suiteid")
1011
687
__init__ = _kwarg_init
1013
689
def delete(self):
1014
690
Store.of(self).remove(self)
1016
692
class TestCasePart(Storm):
1017
"""An actual piece of code to test an exercise solution."""
693
"""A container for the test elements of a Test Case"""
1019
694
__storm_table__ = "test_case_part"
1020
695
__storm_primary__ = "partid"
1025
700
part_type = Unicode()
1026
701
test_type = Unicode()
1027
702
data = Unicode()
1028
703
filename = Unicode()
1030
705
test = Reference(testid, "TestCase.testid")
1032
707
__init__ = _kwarg_init
1034
709
def delete(self):
1035
710
Store.of(self).remove(self)