24
24
It also provides miscellaneous utility functions for database interaction.
30
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
31
31
Reference, ReferenceSet, Bool, Storm, Desc
32
from storm.exceptions import NotOneError, IntegrityError
32
from storm.exceptions import NotOneError
34
from ivle.worksheet.rst import rst
36
36
__all__ = ['get_store',
38
38
'Subject', 'Semester', 'Offering', 'Enrolment',
39
39
'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
'Assessed', 'ProjectSubmission', 'ProjectExtension',
41
40
'Exercise', 'Worksheet', 'WorksheetExercise',
42
41
'ExerciseSave', 'ExerciseAttempt',
43
42
'TestCase', 'TestSuite', 'TestSuiteVar'
50
49
% (self.__class__.__name__, k))
51
50
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.
52
def get_conn_string():
54
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']
59
clusterstr += ivle.conf.db_user
60
if ivle.conf.db_password:
61
clusterstr += ':' + ivle.conf.db_password
66
host = config['database']['host'] or 'localhost'
67
port = config['database']['port'] or 5432
64
host = ivle.conf.db_host or 'localhost'
65
port = ivle.conf.db_port or 5432
69
67
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)))
69
return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
73
Open a database connection and transaction. Return a storm.store.Store
74
instance connected to the configured IVLE database.
76
return Store(create_database(get_conn_string()))
189
183
'''A sanely ordered list of all of the user's enrolments.'''
190
184
return self._get_enrolments(False)
192
def get_projects(self, offering=None, active_only=True):
193
'''Return Projects that the user can submit.
195
This will include projects for offerings in which the user is
196
enrolled, as long as the project is not in a project set which has
197
groups (ie. if maximum number of group members is 0).
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.
205
return Store.of(self).find(Project,
206
Project.project_set_id == ProjectSet.id,
207
ProjectSet.max_students_per_group == None,
208
ProjectSet.offering_id == Offering.id,
209
(offering is None) or (Offering.id == offering.id),
210
Semester.id == Offering.semester_id,
211
(not active_only) or (Semester.state == u'current'),
212
Enrolment.offering_id == Offering.id,
213
Enrolment.user_id == self.id)
216
187
def hash_password(password):
217
return hashlib.md5(password).hexdigest()
188
return md5.md5(password).hexdigest()
220
191
def get_by_login(cls, store, login):
256
227
perms.add('edit')
259
def active_offerings(self):
260
"""Return a sequence of currently active offerings for this subject
261
(offerings whose semester.state is "current"). There should be 0 or 1
262
elements in this sequence, but it's possible there are more.
264
return self.offerings.find(Offering.semester_id == Semester.id,
265
Semester.state == u'current')
267
def offering_for_semester(self, year, semester):
268
"""Get the offering for the given year/semester, or None."""
269
return self.offerings.find(Offering.semester_id == Semester.id,
270
Semester.year == unicode(year),
271
Semester.semester == unicode(semester)).one()
273
230
class Semester(Storm):
274
231
__storm_table__ = "semester"
405
362
__storm_table__ = "project"
407
364
id = Int(name="projectid", primary=True)
409
short_name = Unicode()
410
365
synopsis = Unicode()
412
367
project_set_id = Int(name="projectsetid")
413
368
project_set = Reference(project_set_id, ProjectSet.id)
414
369
deadline = DateTime()
416
assesseds = ReferenceSet(id, 'Assessed.project_id')
417
submissions = ReferenceSet(id,
418
'Assessed.project_id',
420
'ProjectSubmission.assessed_id')
422
371
__init__ = _kwarg_init
424
373
def __repr__(self):
425
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
374
return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
426
375
self.project_set.offering)
428
def can_submit(self, principal):
429
return (self in principal.get_projects() and
430
self.deadline > datetime.datetime.now())
432
def submit(self, principal, path, revision, who):
433
"""Submit a Subversion path and revision to a project.
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.
441
if not self.can_submit(principal):
442
raise Exception('cannot submit')
444
a = Assessed.get(Store.of(self), principal, self)
445
ps = ProjectSubmission()
447
ps.revision = revision
448
ps.date_submitted = datetime.datetime.now()
455
377
class ProjectGroup(Storm):
456
378
__storm_table__ = "project_group"
475
397
return "<%s %s in %r>" % (type(self).__name__, self.name,
476
398
self.project_set.offering)
479
def display_name(self):
480
return '%s (%s)' % (self.nick, self.name)
482
def get_projects(self, offering=None, active_only=True):
483
'''Return Projects that the group can submit.
485
This will include projects in the project set which owns this group,
486
unless the project set disallows groups (in which case none will be
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
495
return Store.of(self).find(Project,
496
Project.project_set_id == ProjectSet.id,
497
ProjectSet.id == self.project_set.id,
498
ProjectSet.max_students_per_group != None,
499
ProjectSet.offering_id == Offering.id,
500
(offering is None) or (Offering.id == offering.id),
501
Semester.id == Offering.semester_id,
502
(not active_only) or (Semester.state == u'current'))
505
def get_permissions(self, user):
506
if user.admin or user in self.members:
507
return set(['submit_project'])
511
400
class ProjectGroupMembership(Storm):
512
401
__storm_table__ = "group_member"
513
402
__storm_primary__ = "user_id", "project_group_id"
523
412
return "<%s %r in %r>" % (type(self).__name__, self.user,
524
413
self.project_group)
526
class Assessed(Storm):
527
__storm_table__ = "assessed"
529
id = Int(name="assessedid", primary=True)
530
user_id = Int(name="loginid")
531
user = Reference(user_id, User.id)
532
project_group_id = Int(name="groupid")
533
project_group = Reference(project_group_id, ProjectGroup.id)
535
project_id = Int(name="projectid")
536
project = Reference(project_id, Project.id)
538
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
539
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
542
return "<%s %r in %r>" % (type(self).__name__,
543
self.user or self.project_group, self.project)
546
def get(cls, store, principal, project):
548
if t not in (User, ProjectGroup):
549
raise AssertionError('principal must be User or ProjectGroup')
552
(t is User) or (cls.project_group_id == principal.id),
553
(t is ProjectGroup) or (cls.user_id == principal.id),
554
Project.id == project.id).one()
561
a.project_group = principal
568
class ProjectExtension(Storm):
569
__storm_table__ = "project_extension"
571
id = Int(name="extensionid", primary=True)
572
assessed_id = Int(name="assessedid")
573
assessed = Reference(assessed_id, Assessed.id)
574
deadline = DateTime()
575
approver_id = Int(name="approver")
576
approver = Reference(approver_id, User.id)
579
class ProjectSubmission(Storm):
580
__storm_table__ = "project_submission"
582
id = Int(name="submissionid", primary=True)
583
assessed_id = Int(name="assessedid")
584
assessed = Reference(assessed_id, Assessed.id)
587
submitter_id = Int(name="submitter")
588
submitter = Reference(submitter_id, User.id)
589
date_submitted = DateTime()
592
415
# WORKSHEETS AND EXERCISES #
594
417
class Exercise(Storm):
601
424
include = Unicode()
604
worksheet_exercises = ReferenceSet(id,
605
'WorksheetExercise.exercise_id')
607
427
worksheets = ReferenceSet(id,
608
428
'WorksheetExercise.exercise_id',
609
429
'WorksheetExercise.worksheet_id',
613
test_suites = ReferenceSet(id,
614
'TestSuite.exercise_id',
433
test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
617
435
__init__ = _kwarg_init
622
440
def get_permissions(self, user):
625
442
if user is not None:
627
444
perms.add('edit')
628
445
perms.add('view')
629
elif 'lecturer' in set((e.role for e in user.active_enrolments)):
635
def get_description(self):
636
return rst(self.description)
639
"""Deletes the exercise, providing it has no associated worksheets."""
640
if (self.worksheet_exercises.count() > 0):
641
raise IntegrityError()
642
for suite in self.test_suites:
644
Store.of(self).remove(self)
646
448
class Worksheet(Storm):
647
449
__storm_table__ = "worksheet"
674
475
def __repr__(self):
675
476
return "<%s %s>" % (type(self).__name__, self.name)
677
def remove_all_exercises(self):
478
# XXX Refactor this - make it an instance method of Subject rather than a
479
# class method of Worksheet. Can't do that now because Subject isn't
480
# linked referentially to the Worksheet.
482
def get_by_name(cls, store, subjectname, worksheetname):
484
Get the Worksheet from the db associated with a given store, subject
485
name and worksheet name.
487
return store.find(cls, cls.subject == unicode(subjectname),
488
cls.name == unicode(worksheetname)).one()
490
def remove_all_exercises(self, store):
679
492
Remove all exercises from this worksheet.
680
493
This does not delete the exercises themselves. It just removes them
681
494
from the worksheet.
683
store = Store.of(self)
684
for ws_ex in self.all_worksheet_exercises:
685
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
686
raise IntegrityError()
687
496
store.find(WorksheetExercise,
688
497
WorksheetExercise.worksheet == self).remove()
690
499
def get_permissions(self, user):
691
500
return self.offering.get_permissions(user)
694
"""Returns the xml of this worksheet, converts from rst if required."""
695
if self.format == u'rst':
696
ws_xml = rst(self.data)
702
"""Deletes the worksheet, provided it has no attempts on any exercises.
704
Returns True if delete succeeded, or False if this worksheet has
705
attempts attached."""
706
for ws_ex in self.all_worksheet_exercises:
707
if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
708
raise IntegrityError()
710
self.remove_all_exercises()
711
Store.of(self).remove(self)
713
502
class WorksheetExercise(Storm):
714
503
__storm_table__ = "worksheet_exercise"
799
587
function = Unicode()
800
588
stdin = Unicode()
801
589
exercise = Reference(exercise_id, Exercise.id)
802
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
803
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
806
"""Delete this suite, without asking questions."""
807
for vaariable in self.variables:
809
for test_case in self.test_cases:
811
Store.of(self).remove(self)
590
test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
591
variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
813
593
class TestCase(Storm):
814
594
"""A TestCase is a member of a TestSuite.
added
removed
ivle/database.py
