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',
50
51
% (self.__class__.__name__, k))
51
52
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.
54
def get_conn_string():
56
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']
61
clusterstr += ivle.conf.db_user
62
if ivle.conf.db_password:
63
clusterstr += ':' + ivle.conf.db_password
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
66
host = ivle.conf.db_host or 'localhost'
67
port = ivle.conf.db_port or 5432
69
69
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)))
71
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
75
Open a database connection and transaction. Return a storm.store.Store
76
instance connected to the configured IVLE database.
78
return Store(create_database(get_conn_string()))
83
"""An IVLE user account."""
84
Represents an IVLE user.
84
86
__storm_table__ = "login"
86
88
id = Int(primary=True, name="loginid")
116
118
return self.hash_password(password) == self.passhash
119
def display_name(self):
120
"""Returns the "nice name" of the user or group."""
124
def short_name(self):
125
"""Returns the database "identifier" name of the user or group."""
129
121
def password_expired(self):
130
122
fieldval = self.pass_exp
131
123
return fieldval is not None and datetime.datetime.now() > fieldval
169
161
# TODO: Invitations should be listed too?
170
162
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
164
ProjectGroupMembership.user_id == self.id,
177
165
ProjectGroup.id == ProjectGroupMembership.project_group_id,
198
186
return self._get_enrolments(False)
200
188
def get_projects(self, offering=None, active_only=True):
201
"""Find projects that the user can submit.
189
'''Return Projects that the user can submit.
203
191
This will include projects for offerings in which the user is
204
192
enrolled, as long as the project is not in a project set which has
205
193
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.
195
Unless active_only is False, only projects for active offerings will
198
If an offering is specified, returned projects will be limited to
199
those for that offering.
210
201
return Store.of(self).find(Project,
211
202
Project.project_set_id == ProjectSet.id,
212
ProjectSet.max_students_per_group == None,
203
ProjectSet.max_students_per_group == 0,
213
204
ProjectSet.offering_id == Offering.id,
214
205
(offering is None) or (Offering.id == offering.id),
215
206
Semester.id == Offering.semester_id,
221
212
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
213
return md5.md5(password).hexdigest()
226
216
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
218
Get the User from the db associated with a given store and
228
221
return store.find(cls, cls.login == unicode(login)).one()
230
223
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
224
if user and user.admin or user is self:
237
225
return set(['view', 'edit', 'submit_project'])
241
229
# SUBJECTS AND ENROLMENTS #
243
231
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
232
__storm_table__ = "subject"
248
234
id = Int(primary=True, name="subjectid")
259
245
return "<%s '%s'>" % (type(self).__name__, self.short_name)
261
247
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
249
if user is not None:
269
250
perms.add('view')
271
252
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
255
class Semester(Storm):
295
"""A semester in which subjects can be run."""
297
256
__storm_table__ = "semester"
299
258
id = Int(primary=True, name="semesterid")
313
272
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
315
274
class Offering(Storm):
316
"""An offering of a subject in a particular semester."""
318
275
__storm_table__ = "offering"
320
277
id = Int(primary=True, name="offeringid")
345
302
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.
303
'''Enrol a user in this offering.'''
351
304
enrolment = Store.of(self).find(Enrolment,
352
305
Enrolment.user_id == user.id,
353
306
Enrolment.offering_id == self.id).one()
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
341
class Enrolment(Storm):
401
"""An enrolment of a user in an offering.
403
This represents the roles of both staff and students.
406
342
__storm_table__ = "enrolment"
407
343
__storm_primary__ = "user_id", "offering_id"
433
369
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
370
__storm_table__ = "project_set"
442
372
id = Int(name="projectsetid", primary=True)
453
383
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
386
class Project(Storm):
472
"""A student project for which submissions can be made."""
474
387
__storm_table__ = "project"
476
389
id = Int(name="projectid", primary=True)
498
411
return (self in principal.get_projects() and
499
412
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.
414
def submit(self, principal, path, revision):
511
415
if not self.can_submit(principal):
512
416
raise Exception('cannot submit')
517
421
ps.revision = revision
518
422
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
428
class ProjectGroup(Storm):
542
"""A group of students working together on a project."""
544
429
__storm_table__ = "project_group"
546
431
id = Int(name="groupid", primary=True)
563
448
return "<%s %s in %r>" % (type(self).__name__, self.name,
564
449
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
451
def get_projects(self, offering=None, active_only=True):
577
'''Find projects that the group can submit.
452
'''Return Projects that the group can submit.
579
454
This will include projects in the project set which owns this group,
580
455
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.
458
Unless active_only is False, projects will only be returned if the
459
group's offering is active.
461
If an offering is specified, projects will only be returned if it
586
464
return Store.of(self).find(Project,
587
465
Project.project_set_id == ProjectSet.id,
588
466
ProjectSet.id == self.project_set.id,
589
ProjectSet.max_students_per_group != None,
467
ProjectSet.max_students_per_group > 0,
590
468
ProjectSet.offering_id == Offering.id,
591
469
(offering is None) or (Offering.id == offering.id),
592
470
Semester.id == Offering.semester_id,
602
480
class ProjectGroupMembership(Storm):
603
"""A student's membership in a project group."""
605
481
__storm_table__ = "group_member"
606
482
__storm_primary__ = "user_id", "project_group_id"
617
493
self.project_group)
619
495
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
496
__storm_table__ = "assessed"
628
498
id = Int(name="assessedid", primary=True)
641
511
return "<%s %r in %r>" % (type(self).__name__,
642
512
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
515
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.
660
516
t = type(principal)
661
517
if t not in (User, ProjectGroup):
662
518
raise AssertionError('principal must be User or ProjectGroup')
681
537
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
538
__storm_table__ = "project_extension"
689
540
id = Int(name="extensionid", primary=True)
695
546
notes = Unicode()
697
548
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
549
__storm_table__ = "project_submission"
709
551
id = Int(name="submissionid", primary=True)
711
553
assessed = Reference(assessed_id, Assessed.id)
714
submitter_id = Int(name="submitter")
715
submitter = Reference(submitter_id, User.id)
716
556
date_submitted = DateTime()
719
559
# WORKSHEETS AND EXERCISES #
721
561
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
562
__storm_table__ = "exercise"
728
563
id = Unicode(primary=True, name="identifier")
759
594
perms.add('edit')
760
595
perms.add('view')
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)):
596
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
770
602
def get_description(self):
771
"""Return the description interpreted as reStructuredText."""
772
603
return rst(self.description)
774
605
def delete(self):
780
611
Store.of(self).remove(self)
782
613
class Worksheet(Storm):
783
"""A worksheet with exercises for students to complete.
785
Worksheets are owned by offerings.
788
614
__storm_table__ = "worksheet"
790
616
id = Int(primary=True, name="worksheetid")
815
641
def __repr__(self):
816
642
return "<%s %s>" % (type(self).__name__, self.name)
644
# XXX Refactor this - make it an instance method of Subject rather than a
645
# class method of Worksheet. Can't do that now because Subject isn't
646
# linked referentially to the Worksheet.
648
def get_by_name(cls, store, subjectname, worksheetname):
650
Get the Worksheet from the db associated with a given store, subject
651
name and worksheet name.
653
return store.find(cls, cls.subject == unicode(subjectname),
654
cls.name == unicode(worksheetname)).one()
818
656
def remove_all_exercises(self):
819
"""Remove all exercises from this worksheet.
658
Remove all exercises from this worksheet.
821
659
This does not delete the exercises themselves. It just removes them
822
660
from the worksheet.
827
665
raise IntegrityError()
828
666
store.find(WorksheetExercise,
829
667
WorksheetExercise.worksheet == self).remove()
831
669
def get_permissions(self, user):
832
670
return self.offering.get_permissions(user)
834
672
def get_xml(self):
835
673
"""Returns the xml of this worksheet, converts from rst if required."""
836
674
if self.format == u'rst':
842
680
def delete(self):
843
681
"""Deletes the worksheet, provided it has no attempts on any exercises.
845
683
Returns True if delete succeeded, or False if this worksheet has
846
684
attempts attached."""
847
685
for ws_ex in self.all_worksheet_exercises:
848
686
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
849
687
raise IntegrityError()
851
689
self.remove_all_exercises()
852
690
Store.of(self).remove(self)
854
692
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
693
__storm_table__ = "worksheet_exercise"
864
695
id = Int(primary=True, name="ws_ex_id")
866
697
worksheet_id = Int(name="worksheetid")
883
714
def get_permissions(self, user):
884
715
return self.worksheet.get_permissions(user)
887
718
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
720
Represents a potential solution to an exercise that a user has submitted
721
to the server for storage.
722
A basic ExerciseSave is just the current saved text for this exercise for
723
this user (doesn't count towards their attempts).
724
ExerciseSave may be extended with additional semantics (such as
894
727
__storm_table__ = "exercise_save"
895
728
__storm_primary__ = "ws_ex_id", "user_id"
909
742
self.exercise.name, self.user.login, self.date.strftime("%c"))
911
744
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.
746
An ExerciseAttempt is a special case of an ExerciseSave. Like an
747
ExerciseSave, it constitutes exercise solution data that the user has
748
submitted to the server for storage.
749
In addition, it contains additional information about the submission.
750
complete - True if this submission was successful, rendering this exercise
751
complete for this user.
752
active - True if this submission is "active" (usually true). Submissions
753
may be de-activated by privileged users for special reasons, and then
754
they won't count (either as a penalty or success), but will still be
928
757
__storm_table__ = "exercise_attempt"
929
758
__storm_primary__ = "ws_ex_id", "user_id", "date"
933
762
text = Unicode(name="attempt")
934
763
complete = Bool()
937
766
def get_permissions(self, user):
938
767
return set(['view']) if user is self.user else set()
940
769
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.
770
"""A Testsuite acts as a container for the test cases of an exercise."""
947
771
__storm_table__ = "test_suite"
948
772
__storm_primary__ = "exercise_id", "suiteid"
951
775
exercise_id = Unicode(name="exerciseid")
952
776
description = Unicode()
956
780
exercise = Reference(exercise_id, Exercise.id)
957
781
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
958
782
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
960
784
def delete(self):
961
785
"""Delete this suite, without asking questions."""
962
786
for vaariable in self.variables:
966
790
Store.of(self).remove(self)
968
792
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."""
793
"""A TestCase is a member of a TestSuite.
795
It contains the data necessary to check if an exercise is correct"""
973
796
__storm_table__ = "test_case"
974
797
__storm_primary__ = "testid", "suiteid"
978
801
suite = Reference(suiteid, "TestSuite.suiteid")
980
803
failmsg = Unicode()
981
804
test_default = Unicode()
984
807
parts = ReferenceSet(testid, "TestCasePart.testid")
986
809
__init__ = _kwarg_init
988
811
def delete(self):
989
812
for part in self.parts:
991
814
Store.of(self).remove(self)
993
816
class TestSuiteVar(Storm):
994
"""A variable used by an exercise test suite.
996
This may represent a function argument or a normal variable.
817
"""A container for the arguments of a Test Suite"""
999
818
__storm_table__ = "suite_variable"
1000
819
__storm_primary__ = "varid"
1004
823
var_name = Unicode()
1005
824
var_value = Unicode()
1006
825
var_type = Unicode()
1009
828
suite = Reference(suiteid, "TestSuite.suiteid")
1011
830
__init__ = _kwarg_init
1013
832
def delete(self):
1014
833
Store.of(self).remove(self)
1016
835
class TestCasePart(Storm):
1017
"""An actual piece of code to test an exercise solution."""
836
"""A container for the test elements of a Test Case"""
1019
837
__storm_table__ = "test_case_part"
1020
838
__storm_primary__ = "partid"
1025
843
part_type = Unicode()
1026
844
test_type = Unicode()
1027
845
data = Unicode()
1028
846
filename = Unicode()
1030
848
test = Reference(testid, "TestCase.testid")
1032
850
__init__ = _kwarg_init
1034
852
def delete(self):
1035
853
Store.of(self).remove(self)
added
removed
ivle/database.py
