29
30
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
30
31
Reference, ReferenceSet, Bool, Storm, Desc
215
216
Semester.id == Offering.semester_id,
216
217
(not active_only) or (Semester.state == u'current'),
217
218
Enrolment.offering_id == Offering.id,
218
Enrolment.user_id == self.id)
219
Enrolment.user_id == self.id,
220
Enrolment.active == True)
221
223
def hash_password(password):
227
229
"""Find a user in a store by login name."""
228
230
return store.find(cls, cls.login == unicode(login)).one()
230
def get_permissions(self, user):
232
def get_permissions(self, user, config):
231
233
"""Determine privileges held by a user over this object.
233
235
If the user requesting privileges is this user or an admin,
234
236
they may do everything. Otherwise they may do nothing.
236
238
if user and user.admin or user is self:
237
return set(['view', 'edit', 'submit_project'])
239
return set(['view_public', 'view', 'edit', 'submit_project'])
241
return set(['view_public'])
241
243
# SUBJECTS AND ENROLMENTS #
249
251
code = Unicode(name="subj_code")
250
252
name = Unicode(name="subj_name")
251
253
short_name = Unicode(name="subj_short_name")
254
255
offerings = ReferenceSet(id, 'Offering.subject_id')
258
259
def __repr__(self):
259
260
return "<%s '%s'>" % (type(self).__name__, self.short_name)
261
def get_permissions(self, user):
262
def get_permissions(self, user, config):
262
263
"""Determine privileges held by a user over this object.
264
265
If the user requesting privileges is an admin, they may edit.
322
323
subject = Reference(subject_id, Subject.id)
323
324
semester_id = Int(name="semesterid")
324
325
semester = Reference(semester_id, Semester.id)
326
description = Unicode()
328
show_worksheet_marks = Bool()
329
worksheet_cutoff = DateTime()
325
330
groups_student_permissions = Unicode()
327
332
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
330
335
'Enrolment.user_id',
332
337
project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
338
projects = ReferenceSet(id,
339
'ProjectSet.offering_id',
341
'Project.project_set_id')
334
343
worksheets = ReferenceSet(id,
335
344
'Worksheet.offering_id',
366
375
Enrolment.offering_id == self.id).one()
367
376
Store.of(enrolment).remove(enrolment)
369
def get_permissions(self, user):
378
def get_permissions(self, user, config):
371
380
if user is not None:
372
381
enrolment = self.get_enrolment(user)
373
382
if enrolment or user.admin:
374
383
perms.add('view')
375
if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
384
if enrolment and enrolment.role == u'tutor':
385
perms.add('view_project_submissions')
386
# Site-specific policy on the role of tutors
387
if config['policy']['tutors_can_enrol_students']:
389
perms.add('enrol_student')
390
if config['policy']['tutors_can_edit_worksheets']:
391
perms.add('edit_worksheets')
392
if config['policy']['tutors_can_admin_groups']:
393
perms.add('admin_groups')
394
if (enrolment and enrolment.role in (u'lecturer')) or user.admin:
395
perms.add('view_project_submissions')
396
perms.add('admin_groups')
397
perms.add('edit_worksheets')
398
perms.add('edit') # Can edit projects & details
399
perms.add('enrol') # Can see enrolment screen at all
400
perms.add('enrol_student') # Can enrol students
401
perms.add('enrol_tutor') # Can enrol tutors
403
perms.add('enrol_lecturer') # Can enrol lecturers
380
406
def get_enrolment(self, user):
391
417
Enrolment.user_id == User.id,
392
418
Enrolment.offering_id == self.id,
393
419
Enrolment.role == role
420
).order_by(User.login)
397
423
def students(self):
398
424
return self.get_members_by_role(u'student')
426
def get_open_projects_for_user(self, user):
427
"""Find all projects currently open to submissions by a user."""
428
# XXX: Respect extensions.
429
return self.projects.find(Project.deadline > datetime.datetime.now())
431
def clone_worksheets(self, source):
432
"""Clone all worksheets from the specified source to this offering."""
433
import ivle.worksheet.utils
434
for worksheet in source.worksheets:
436
newws.seq_no = worksheet.seq_no
437
newws.identifier = worksheet.identifier
438
newws.name = worksheet.name
439
newws.assessable = worksheet.assessable
440
newws.published = worksheet.published
441
newws.data = worksheet.data
442
newws.format = worksheet.format
443
newws.offering = self
444
Store.of(self).add(newws)
445
ivle.worksheet.utils.update_exerciselist(newws)
400
448
class Enrolment(Storm):
401
449
"""An enrolment of a user in an offering.
428
476
return "<%s %r in %r>" % (type(self).__name__, self.user,
479
def get_permissions(self, user, config):
480
# A user can edit any enrolment that they could have created.
482
if ('enrol_' + str(self.role)) in self.offering.get_permissions(
488
"""Delete this enrolment."""
489
Store.of(self).remove(self)
433
494
class ProjectSet(Storm):
453
514
return "<%s %d in %r>" % (type(self).__name__, self.id,
456
def get_permissions(self, user):
457
return self.offering.get_permissions(user)
517
def get_permissions(self, user, config):
518
return self.offering.get_permissions(user, config)
520
def get_groups_for_user(self, user):
521
"""List all groups in this offering of which the user is a member."""
523
return Store.of(self).find(
525
ProjectGroupMembership.user_id == user.id,
526
ProjectGroupMembership.project_group_id == ProjectGroup.id,
527
ProjectGroup.project_set_id == self.id)
529
def get_submission_principal(self, user):
530
"""Get the principal on behalf of which the user can submit.
532
If this is a solo project set, the given user is returned. If
533
the user is a member of exactly one group, all the group is
534
returned. Otherwise, None is returned.
537
groups = self.get_groups_for_user(user)
538
if groups.count() == 1:
547
return self.max_students_per_group is not None
460
550
def assigned(self):
463
553
This will be a Storm ResultSet.
465
555
#If its a solo project, return everyone in offering
466
if self.max_students_per_group is None:
557
return self.project_groups
467
559
return self.offering.students
469
return self.project_groups
561
class DeadlinePassed(Exception):
562
"""An exception indicating that a project cannot be submitted because the
563
deadline has passed."""
567
return "The project deadline has passed"
471
569
class Project(Storm):
472
570
"""A student project for which submissions can be made."""
494
592
return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
495
593
self.project_set.offering)
497
def can_submit(self, principal):
595
def can_submit(self, principal, user):
498
596
return (self in principal.get_projects() and
499
self.deadline > datetime.datetime.now())
597
not self.has_deadline_passed(user))
501
599
def submit(self, principal, path, revision, who):
502
600
"""Submit a Subversion path and revision to a project.
508
606
@param who: The user who is actually making the submission.
511
if not self.can_submit(principal):
512
raise Exception('cannot submit')
609
if not self.can_submit(principal, who):
610
raise DeadlinePassed()
514
612
a = Assessed.get(Store.of(self), principal, self)
515
613
ps = ProjectSubmission()
614
# Raise SubmissionError if the path is illegal
615
ps.path = ProjectSubmission.test_and_normalise_path(path)
517
616
ps.revision = revision
518
617
ps.date_submitted = datetime.datetime.now()
524
def get_permissions(self, user):
525
return self.project_set.offering.get_permissions(user)
623
def get_permissions(self, user, config):
624
return self.project_set.offering.get_permissions(user, config)
528
627
def latest_submissions(self):
639
def has_deadline_passed(self, user):
640
"""Check whether the deadline has passed."""
641
# XXX: Need to respect extensions.
642
return self.deadline < datetime.datetime.now()
644
def get_submissions_for_principal(self, principal):
645
"""Fetch a ResultSet of all submissions by a particular principal."""
646
assessed = Assessed.get(Store.of(self), principal, self)
649
return assessed.submissions
541
653
class ProjectGroup(Storm):
542
654
"""A group of students working together on a project."""
593
705
(not active_only) or (Semester.state == u'current'))
596
def get_permissions(self, user):
708
def get_permissions(self, user, config):
597
709
if user.admin or user in self.members:
598
710
return set(['submit_project'])
635
747
project = Reference(project_id, Project.id)
637
749
extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
638
submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
750
submissions = ReferenceSet(
751
id, 'ProjectSubmission.assessed_id', order_by='date_submitted')
640
753
def __repr__(self):
641
754
return "<%s %r in %r>" % (type(self).__name__,
650
763
def principal(self):
651
764
return self.project_group or self.user
767
def checkout_location(self):
768
"""Returns the location of the Subversion workspace for this piece of
769
assessment, relative to each group member's home directory."""
770
subjectname = self.project.project_set.offering.subject.short_name
772
checkout_dir_name = self.principal.short_name
774
checkout_dir_name = "mywork"
775
return subjectname + "/" + checkout_dir_name
654
778
def get(cls, store, principal, project):
655
779
"""Find or create an Assessed for the given user or group and project.
664
788
a = store.find(cls,
665
789
(t is User) or (cls.project_group_id == principal.id),
666
790
(t is ProjectGroup) or (cls.user_id == principal.id),
667
Project.id == project.id).one()
791
cls.project_id == project.id).one()
694
818
approver = Reference(approver_id, User.id)
695
819
notes = Unicode()
821
class SubmissionError(Exception):
822
"""Denotes a validation error during submission."""
697
825
class ProjectSubmission(Storm):
698
826
"""A submission from a user or group repository to a particular project.
715
843
submitter = Reference(submitter_id, User.id)
716
844
date_submitted = DateTime()
846
def get_verify_url(self, user):
847
"""Get the URL for verifying this submission, within the account of
849
# If this is a solo project, then self.path will be prefixed with the
850
# subject name. Remove the first path segment.
851
submitpath = self.path[1:] if self.path[:1] == '/' else self.path
852
if not self.assessed.is_group:
853
if '/' in submitpath:
854
submitpath = submitpath.split('/', 1)[1]
857
return "/files/%s/%s/%s?r=%d" % (user.login,
858
self.assessed.checkout_location, submitpath, self.revision)
861
def test_and_normalise_path(path):
862
"""Test that path is valid, and normalise it. This prevents possible
863
injections using malicious paths.
864
Returns the updated path, if successful.
865
Raises SubmissionError if invalid.
867
# Ensure the path is absolute to prevent being tacked onto working
869
# Prevent '\n' because it will break all sorts of things.
870
# Prevent '[' and ']' because they can be used to inject into the
872
# Normalise to avoid resulting in ".." path segments.
873
if not os.path.isabs(path):
874
raise SubmissionError("Path is not absolute")
875
if any(c in path for c in "\n[]"):
876
raise SubmissionError("Path must not contain '\\n', '[' or ']'")
877
return os.path.normpath(path)
719
879
# WORKSHEETS AND EXERCISES #
751
911
def __repr__(self):
752
912
return "<%s %s>" % (type(self).__name__, self.name)
754
def get_permissions(self, user):
914
def get_permissions(self, user, config):
915
return self.global_permissions(user, config)
918
def global_permissions(user, config):
919
"""Gets the set of permissions this user has over *all* exercises.
920
This is used to determine who may view the exercises list, and create
757
924
if user is not None:
761
928
elif u'lecturer' in set((e.role for e in user.active_enrolments)):
762
929
perms.add('edit')
763
930
perms.add('view')
764
elif u'tutor' in set((e.role for e in user.active_enrolments)):
931
elif (config['policy']['tutors_can_edit_worksheets']
932
and u'tutor' in set((e.role for e in user.active_enrolments))):
933
# Site-specific policy on the role of tutors
765
934
perms.add('edit')
766
935
perms.add('view')
828
998
store.find(WorksheetExercise,
829
999
WorksheetExercise.worksheet == self).remove()
831
def get_permissions(self, user):
832
return self.offering.get_permissions(user)
1001
def get_permissions(self, user, config):
1002
# Almost the same permissions as for the offering itself
1003
perms = self.offering.get_permissions(user, config)
1004
# However, "edit" permission is derived from the "edit_worksheets"
1005
# permission of the offering
1006
if 'edit_worksheets' in perms:
1009
perms.discard('edit')
834
1012
def get_xml(self):
835
1013
"""Returns the xml of this worksheet, converts from rst if required."""
880
1058
return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
881
1059
self.worksheet.identifier)
883
def get_permissions(self, user):
884
return self.worksheet.get_permissions(user)
1061
def get_permissions(self, user, config):
1062
return self.worksheet.get_permissions(user, config)
887
1065
class ExerciseSave(Storm):
934
1112
complete = Bool()
937
def get_permissions(self, user):
1115
def get_permissions(self, user, config):
938
1116
return set(['view']) if user is self.user else set()
940
1118
class TestSuite(Storm):
960
1138
def delete(self):
961
1139
"""Delete this suite, without asking questions."""
962
for vaariable in self.variables:
1140
for variable in self.variables:
963
1141
variable.delete()
964
1142
for test_case in self.test_cases:
965
1143
test_case.delete()
added
removed
ivle/database.py
