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")
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,
197
185
'''A sanely ordered list of all of the user's enrolments.'''
198
186
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
189
def hash_password(password):
222
"""Hash a password with MD5."""
223
return hashlib.md5(password).hexdigest()
190
return md5.md5(password).hexdigest()
226
193
def get_by_login(cls, store, login):
227
"""Find a user in a store by login name."""
195
Get the User from the db associated with a given store and
228
198
return store.find(cls, cls.login == unicode(login)).one()
230
200
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
201
if user and user.admin or user is self:
237
return set(['view_public', 'view', 'edit', 'submit_project'])
202
return set(['view', 'edit', 'submit_project'])
239
return set(['view_public'])
241
206
# SUBJECTS AND ENROLMENTS #
243
208
class Subject(Storm):
244
"""A subject (or course) which is run in some semesters."""
246
209
__storm_table__ = "subject"
248
211
id = Int(primary=True, name="subjectid")
259
222
return "<%s '%s'>" % (type(self).__name__, self.short_name)
261
224
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
226
if user is not None:
269
227
perms.add('view')
271
229
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
232
class Semester(Storm):
295
"""A semester in which subjects can be run."""
297
233
__storm_table__ = "semester"
299
235
id = Int(primary=True, name="semesterid")
345
279
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.
280
'''Enrol a user in this offering.'''
351
281
enrolment = Store.of(self).find(Enrolment,
352
282
Enrolment.user_id == user.id,
353
283
Enrolment.offering_id == self.id).one()
375
305
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
377
307
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
310
def get_enrolment(self, user):
389
"""Find the user's enrolment in this offering."""
391
312
enrolment = self.enrolments.find(user=user).one()
392
313
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
318
class Enrolment(Storm):
409
"""An enrolment of a user in an offering.
411
This represents the roles of both staff and students.
414
319
__storm_table__ = "enrolment"
415
320
__storm_primary__ = "user_id", "offering_id"
461
360
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
363
class Project(Storm):
484
"""A student project for which submissions can be made."""
486
364
__storm_table__ = "project"
488
366
id = Int(name="projectid", primary=True)
506
384
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
507
385
self.project_set.offering)
509
def can_submit(self, principal):
510
return (self in principal.get_projects() and
511
self.deadline > datetime.datetime.now())
513
def submit(self, principal, path, revision, who):
514
"""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.
523
if not self.can_submit(principal):
524
raise Exception('cannot submit')
526
a = Assessed.get(Store.of(self), principal, self)
527
ps = ProjectSubmission()
529
ps.revision = revision
530
ps.date_submitted = datetime.datetime.now()
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
387
class ProjectGroup(Storm):
554
"""A group of students working together on a project."""
556
388
__storm_table__ = "project_group"
558
390
id = Int(name="groupid", primary=True)
575
407
return "<%s %s in %r>" % (type(self).__name__, self.name,
576
408
self.project_set.offering)
579
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."""
588
def get_projects(self, offering=None, active_only=True):
589
'''Find projects that the group can submit.
591
This will include projects in the project set which owns this group,
592
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.
598
return Store.of(self).find(Project,
599
Project.project_set_id == ProjectSet.id,
600
ProjectSet.id == self.project_set.id,
601
ProjectSet.max_students_per_group != None,
602
ProjectSet.offering_id == Offering.id,
603
(offering is None) or (Offering.id == offering.id),
604
Semester.id == Offering.semester_id,
605
(not active_only) or (Semester.state == u'current'))
608
410
def get_permissions(self, user):
609
411
if user.admin or user in self.members:
610
412
return set(['submit_project'])
653
447
return "<%s %r in %r>" % (type(self).__name__,
654
448
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
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.
673
if t not in (User, ProjectGroup):
674
raise AssertionError('principal must be User or ProjectGroup')
677
(t is User) or (cls.project_group_id == principal.id),
678
(t is ProjectGroup) or (cls.user_id == principal.id),
679
Project.id == project.id).one()
686
a.project_group = principal
693
450
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
451
__storm_table__ = "project_extension"
701
453
id = Int(name="extensionid", primary=True)
707
459
notes = Unicode()
709
461
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
462
__storm_table__ = "project_submission"
721
464
id = Int(name="submissionid", primary=True)
723
466
assessed = Reference(assessed_id, Assessed.id)
726
submitter_id = Int(name="submitter")
727
submitter = Reference(submitter_id, User.id)
728
469
date_submitted = DateTime()
731
472
# WORKSHEETS AND EXERCISES #
733
474
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
475
__storm_table__ = "exercise"
740
476
id = Unicode(primary=True, name="identifier")
771
507
perms.add('edit')
772
508
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)):
509
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
782
515
def get_description(self):
783
"""Return the description interpreted as reStructuredText."""
784
516
return rst(self.description)
786
518
def delete(self):
827
554
def __repr__(self):
828
555
return "<%s %s>" % (type(self).__name__, self.name)
557
# XXX Refactor this - make it an instance method of Subject rather than a
558
# class method of Worksheet. Can't do that now because Subject isn't
559
# linked referentially to the Worksheet.
561
def get_by_name(cls, store, subjectname, worksheetname):
563
Get the Worksheet from the db associated with a given store, subject
564
name and worksheet name.
566
return store.find(cls, cls.subject == unicode(subjectname),
567
cls.name == unicode(worksheetname)).one()
830
569
def remove_all_exercises(self):
831
"""Remove all exercises from this worksheet.
571
Remove all exercises from this worksheet.
833
572
This does not delete the exercises themselves. It just removes them
834
573
from the worksheet.
839
578
raise IntegrityError()
840
579
store.find(WorksheetExercise,
841
580
WorksheetExercise.worksheet == self).remove()
843
582
def get_permissions(self, user):
844
583
return self.offering.get_permissions(user)
846
585
def get_xml(self):
847
586
"""Returns the xml of this worksheet, converts from rst if required."""
848
587
if self.format == u'rst':
854
593
def delete(self):
855
594
"""Deletes the worksheet, provided it has no attempts on any exercises.
857
596
Returns True if delete succeeded, or False if this worksheet has
858
597
attempts attached."""
859
598
for ws_ex in self.all_worksheet_exercises:
860
599
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
861
600
raise IntegrityError()
863
602
self.remove_all_exercises()
864
603
Store.of(self).remove(self)
866
605
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
606
__storm_table__ = "worksheet_exercise"
876
608
id = Int(primary=True, name="ws_ex_id")
878
610
worksheet_id = Int(name="worksheetid")
895
627
def get_permissions(self, user):
896
628
return self.worksheet.get_permissions(user)
899
631
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
633
Represents a potential solution to an exercise that a user has submitted
634
to the server for storage.
635
A basic ExerciseSave is just the current saved text for this exercise for
636
this user (doesn't count towards their attempts).
637
ExerciseSave may be extended with additional semantics (such as
906
640
__storm_table__ = "exercise_save"
907
641
__storm_primary__ = "ws_ex_id", "user_id"
921
655
self.exercise.name, self.user.login, self.date.strftime("%c"))
923
657
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.
659
An ExerciseAttempt is a special case of an ExerciseSave. Like an
660
ExerciseSave, it constitutes exercise solution data that the user has
661
submitted to the server for storage.
662
In addition, it contains additional information about the submission.
663
complete - True if this submission was successful, rendering this exercise
664
complete for this user.
665
active - True if this submission is "active" (usually true). Submissions
666
may be de-activated by privileged users for special reasons, and then
667
they won't count (either as a penalty or success), but will still be
940
670
__storm_table__ = "exercise_attempt"
941
671
__storm_primary__ = "ws_ex_id", "user_id", "date"
945
675
text = Unicode(name="attempt")
946
676
complete = Bool()
949
679
def get_permissions(self, user):
950
680
return set(['view']) if user is self.user else set()
952
682
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.
683
"""A Testsuite acts as a container for the test cases of an exercise."""
959
684
__storm_table__ = "test_suite"
960
685
__storm_primary__ = "exercise_id", "suiteid"
963
688
exercise_id = Unicode(name="exerciseid")
964
689
description = Unicode()
968
693
exercise = Reference(exercise_id, Exercise.id)
969
694
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
970
695
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
972
697
def delete(self):
973
698
"""Delete this suite, without asking questions."""
974
699
for vaariable in self.variables:
978
703
Store.of(self).remove(self)
980
705
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."""
706
"""A TestCase is a member of a TestSuite.
708
It contains the data necessary to check if an exercise is correct"""
985
709
__storm_table__ = "test_case"
986
710
__storm_primary__ = "testid", "suiteid"
990
714
suite = Reference(suiteid, "TestSuite.suiteid")
991
715
passmsg = Unicode()
992
716
failmsg = Unicode()
993
test_default = Unicode() # Currently unused - only used for file matching.
717
test_default = Unicode()
996
720
parts = ReferenceSet(testid, "TestCasePart.testid")
998
722
__init__ = _kwarg_init
1000
724
def delete(self):
1001
725
for part in self.parts:
1003
727
Store.of(self).remove(self)
1005
729
class TestSuiteVar(Storm):
1006
"""A variable used by an exercise test suite.
1008
This may represent a function argument or a normal variable.
730
"""A container for the arguments of a Test Suite"""
1011
731
__storm_table__ = "suite_variable"
1012
732
__storm_primary__ = "varid"
1016
736
var_name = Unicode()
1017
737
var_value = Unicode()
1018
738
var_type = Unicode()
1021
741
suite = Reference(suiteid, "TestSuite.suiteid")
1023
743
__init__ = _kwarg_init
1025
745
def delete(self):
1026
746
Store.of(self).remove(self)
1028
748
class TestCasePart(Storm):
1029
"""An actual piece of code to test an exercise solution."""
749
"""A container for the test elements of a Test Case"""
1031
750
__storm_table__ = "test_case_part"
1032
751
__storm_primary__ = "partid"
1037
756
part_type = Unicode()
1038
757
test_type = Unicode()
1039
758
data = Unicode()
1040
759
filename = Unicode()
1042
761
test = Reference(testid, "TestCase.testid")
1044
763
__init__ = _kwarg_init
1046
765
def delete(self):
1047
766
Store.of(self).remove(self)
added
removed
ivle/database.py
