~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/database.py

  • Committer: Matt Giuca
  • Date: 2009-04-22 04:56:58 UTC
  • Revision ID: matt.giuca@gmail.com-20090422045658-nnfepg0902n3mwtq
ivle.makeuser: Fixed odd code which would create the home directory, then
    immediately clobber it by restoring the backup.
    This broke in Python 2.6 because the behaviour of shutil.move changed.
    (Commented).

Show diffs side-by-side

added added

removed removed

Lines of Context:
29
29
 
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
33
 
33
34
import ivle.conf
 
35
from ivle.worksheet.rst import rst
34
36
 
35
37
__all__ = ['get_store',
36
38
            'User',
37
39
            'Subject', 'Semester', 'Offering', 'Enrolment',
38
40
            'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
 
41
            'Assessed', 'ProjectSubmission', 'ProjectExtension',
39
42
            'Exercise', 'Worksheet', 'WorksheetExercise',
40
43
            'ExerciseSave', 'ExerciseAttempt',
41
44
            'TestCase', 'TestSuite', 'TestSuiteVar'
115
118
        return self.hash_password(password) == self.passhash
116
119
 
117
120
    @property
 
121
    def display_name(self):
 
122
        return self.fullname
 
123
 
 
124
    @property
118
125
    def password_expired(self):
119
126
        fieldval = self.pass_exp
120
127
        return fieldval is not None and datetime.datetime.now() > fieldval
182
189
        '''A sanely ordered list of all of the user's enrolments.'''
183
190
        return self._get_enrolments(False) 
184
191
 
 
192
    def get_projects(self, offering=None, active_only=True):
 
193
        '''Return Projects that the user can submit.
 
194
 
 
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).
 
198
 
 
199
        Unless active_only is False, only projects for active offerings will
 
200
        be returned.
 
201
 
 
202
        If an offering is specified, returned projects will be limited to
 
203
        those for that offering.
 
204
        '''
 
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)
 
214
 
185
215
    @staticmethod
186
216
    def hash_password(password):
187
217
        return md5.md5(password).hexdigest()
196
226
 
197
227
    def get_permissions(self, user):
198
228
        if user and user.admin or user is self:
199
 
            return set(['view', 'edit'])
 
229
            return set(['view', 'edit', 'submit_project'])
200
230
        else:
201
231
            return set()
202
232
 
235
265
    state = Unicode()
236
266
 
237
267
    offerings = ReferenceSet(id, 'Offering.semester_id')
 
268
    enrolments = ReferenceSet(id,
 
269
                              'Offering.semester_id',
 
270
                              'Offering.id',
 
271
                              'Enrolment.offering_id')
238
272
 
239
273
    __init__ = _kwarg_init
240
274
 
260
294
 
261
295
    worksheets = ReferenceSet(id, 
262
296
        'Worksheet.offering_id', 
263
 
        order_by="Worksheet.seq_no"
 
297
        order_by="seq_no"
264
298
    )
265
299
 
266
300
    __init__ = _kwarg_init
282
316
        enrolment.active = True
283
317
        enrolment.role = role
284
318
 
 
319
    def unenrol(self, user):
 
320
        '''Unenrol a user from this offering.'''
 
321
        enrolment = Store.of(self).find(Enrolment,
 
322
                               Enrolment.user_id == user.id,
 
323
                               Enrolment.offering_id == self.id).one()
 
324
        Store.of(enrolment).remove(enrolment)
 
325
 
285
326
    def get_permissions(self, user):
286
327
        perms = set()
287
328
        if user is not None:
288
 
            perms.add('view')
289
 
            if user.admin:
 
329
            enrolment = self.get_enrolment(user)
 
330
            if enrolment or user.admin:
 
331
                perms.add('view')
 
332
            if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
 
333
               or user.admin:
290
334
                perms.add('edit')
291
335
        return perms
292
336
 
 
337
    def get_enrolment(self, user):
 
338
        try:
 
339
            enrolment = self.enrolments.find(user=user).one()
 
340
        except NotOneError:
 
341
            enrolment = None
 
342
 
 
343
        return enrolment
 
344
 
293
345
class Enrolment(Storm):
294
346
    __storm_table__ = "enrolment"
295
347
    __storm_primary__ = "user_id", "offering_id"
339
391
    __storm_table__ = "project"
340
392
 
341
393
    id = Int(name="projectid", primary=True)
 
394
    name = Unicode()
 
395
    short_name = Unicode()
342
396
    synopsis = Unicode()
343
397
    url = Unicode()
344
398
    project_set_id = Int(name="projectsetid")
345
399
    project_set = Reference(project_set_id, ProjectSet.id)
346
400
    deadline = DateTime()
347
401
 
 
402
    assesseds = ReferenceSet(id, 'Assessed.project_id')
 
403
    submissions = ReferenceSet(id,
 
404
                               'Assessed.project_id',
 
405
                               'Assessed.id',
 
406
                               'ProjectSubmission.assessed_id')
 
407
 
348
408
    __init__ = _kwarg_init
349
409
 
350
410
    def __repr__(self):
351
 
        return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
 
411
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
352
412
                                  self.project_set.offering)
353
413
 
 
414
    def can_submit(self, principal):
 
415
        return (self in principal.get_projects() and
 
416
                self.deadline > datetime.datetime.now())
 
417
 
 
418
    def submit(self, principal, path, revision, who):
 
419
        """Submit a Subversion path and revision to a project.
 
420
 
 
421
        'principal' is the owner of the Subversion repository, and the
 
422
        entity on behalf of whom the submission is being made. 'path' is
 
423
        a path within that repository, and 'revision' specifies which
 
424
        revision of that path. 'who' is the person making the submission.
 
425
        """
 
426
 
 
427
        if not self.can_submit(principal):
 
428
            raise Exception('cannot submit')
 
429
 
 
430
        a = Assessed.get(Store.of(self), principal, self)
 
431
        ps = ProjectSubmission()
 
432
        ps.path = path
 
433
        ps.revision = revision
 
434
        ps.date_submitted = datetime.datetime.now()
 
435
        ps.assessed = a
 
436
        ps.submitter = who
 
437
 
 
438
        return ps
 
439
 
 
440
 
354
441
class ProjectGroup(Storm):
355
442
    __storm_table__ = "project_group"
356
443
 
374
461
        return "<%s %s in %r>" % (type(self).__name__, self.name,
375
462
                                  self.project_set.offering)
376
463
 
 
464
    @property
 
465
    def display_name(self):
 
466
        return '%s (%s)' % (self.nick, self.name)
 
467
 
 
468
    def get_projects(self, offering=None, active_only=True):
 
469
        '''Return Projects that the group can submit.
 
470
 
 
471
        This will include projects in the project set which owns this group,
 
472
        unless the project set disallows groups (in which case none will be
 
473
        returned).
 
474
 
 
475
        Unless active_only is False, projects will only be returned if the
 
476
        group's offering is active.
 
477
 
 
478
        If an offering is specified, projects will only be returned if it
 
479
        matches the group's.
 
480
        '''
 
481
        return Store.of(self).find(Project,
 
482
            Project.project_set_id == ProjectSet.id,
 
483
            ProjectSet.id == self.project_set.id,
 
484
            ProjectSet.max_students_per_group != None,
 
485
            ProjectSet.offering_id == Offering.id,
 
486
            (offering is None) or (Offering.id == offering.id),
 
487
            Semester.id == Offering.semester_id,
 
488
            (not active_only) or (Semester.state == u'current'))
 
489
 
 
490
 
 
491
    def get_permissions(self, user):
 
492
        if user.admin or user in self.members:
 
493
            return set(['submit_project'])
 
494
        else:
 
495
            return set()
 
496
 
377
497
class ProjectGroupMembership(Storm):
378
498
    __storm_table__ = "group_member"
379
499
    __storm_primary__ = "user_id", "project_group_id"
389
509
        return "<%s %r in %r>" % (type(self).__name__, self.user,
390
510
                                  self.project_group)
391
511
 
 
512
class Assessed(Storm):
 
513
    __storm_table__ = "assessed"
 
514
 
 
515
    id = Int(name="assessedid", primary=True)
 
516
    user_id = Int(name="loginid")
 
517
    user = Reference(user_id, User.id)
 
518
    project_group_id = Int(name="groupid")
 
519
    project_group = Reference(project_group_id, ProjectGroup.id)
 
520
 
 
521
    project_id = Int(name="projectid")
 
522
    project = Reference(project_id, Project.id)
 
523
 
 
524
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
 
525
    submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
 
526
 
 
527
    def __repr__(self):
 
528
        return "<%s %r in %r>" % (type(self).__name__,
 
529
            self.user or self.project_group, self.project)
 
530
 
 
531
    @classmethod
 
532
    def get(cls, store, principal, project):
 
533
        t = type(principal)
 
534
        if t not in (User, ProjectGroup):
 
535
            raise AssertionError('principal must be User or ProjectGroup')
 
536
 
 
537
        a = store.find(cls,
 
538
            (t is User) or (cls.project_group_id == principal.id),
 
539
            (t is ProjectGroup) or (cls.user_id == principal.id),
 
540
            Project.id == project.id).one()
 
541
 
 
542
        if a is None:
 
543
            a = cls()
 
544
            if t is User:
 
545
                a.user = principal
 
546
            else:
 
547
                a.project_group = principal
 
548
            a.project = project
 
549
            store.add(a)
 
550
 
 
551
        return a
 
552
 
 
553
 
 
554
class ProjectExtension(Storm):
 
555
    __storm_table__ = "project_extension"
 
556
 
 
557
    id = Int(name="extensionid", primary=True)
 
558
    assessed_id = Int(name="assessedid")
 
559
    assessed = Reference(assessed_id, Assessed.id)
 
560
    deadline = DateTime()
 
561
    approver_id = Int(name="approver")
 
562
    approver = Reference(approver_id, User.id)
 
563
    notes = Unicode()
 
564
 
 
565
class ProjectSubmission(Storm):
 
566
    __storm_table__ = "project_submission"
 
567
 
 
568
    id = Int(name="submissionid", primary=True)
 
569
    assessed_id = Int(name="assessedid")
 
570
    assessed = Reference(assessed_id, Assessed.id)
 
571
    path = Unicode()
 
572
    revision = Int()
 
573
    submitter_id = Int(name="submitter")
 
574
    submitter = Reference(submitter_id, User.id)
 
575
    date_submitted = DateTime()
 
576
 
 
577
 
392
578
# WORKSHEETS AND EXERCISES #
393
579
 
394
580
class Exercise(Storm):
401
587
    include = Unicode()
402
588
    num_rows = Int()
403
589
 
 
590
    worksheet_exercises =  ReferenceSet(id,
 
591
        'WorksheetExercise.exercise_id')
 
592
 
404
593
    worksheets = ReferenceSet(id,
405
594
        'WorksheetExercise.exercise_id',
406
595
        'WorksheetExercise.worksheet_id',
407
596
        'Worksheet.id'
408
597
    )
409
598
    
410
 
    test_suites = ReferenceSet(id, 'TestSuite.exercise_id')
 
599
    test_suites = ReferenceSet(id, 
 
600
        'TestSuite.exercise_id',
 
601
        order_by='seq_no')
411
602
 
412
603
    __init__ = _kwarg_init
413
604
 
416
607
 
417
608
    def get_permissions(self, user):
418
609
        perms = set()
 
610
        roles = set()
419
611
        if user is not None:
420
612
            if user.admin:
421
613
                perms.add('edit')
422
614
                perms.add('view')
 
615
            elif 'lecturer' in set((e.role for e in user.active_enrolments)):
 
616
                perms.add('edit')
 
617
                perms.add('view')
 
618
            
423
619
        return perms
 
620
    
 
621
    def get_description(self):
 
622
        return rst(self.description)
 
623
 
 
624
    def delete(self):
 
625
        """Deletes the exercise, providing it has no associated worksheets."""
 
626
        if (self.worksheet_exercises.count() > 0):
 
627
            raise IntegrityError()
 
628
        for suite in self.test_suites:
 
629
            suite.delete()
 
630
        Store.of(self).remove(self)
424
631
 
425
632
class Worksheet(Storm):
426
633
    __storm_table__ = "worksheet"
443
650
    # Use worksheet_exercises to get access to the *active* WorksheetExercise
444
651
    # objects binding worksheets to exercises. This is required to access the
445
652
    # "optional" field.
 
653
 
446
654
    @property
447
655
    def worksheet_exercises(self):
448
656
        return self.all_worksheet_exercises.find(active=True)
464
672
        return store.find(cls, cls.subject == unicode(subjectname),
465
673
            cls.name == unicode(worksheetname)).one()
466
674
 
467
 
    def remove_all_exercises(self, store):
 
675
    def remove_all_exercises(self):
468
676
        """
469
677
        Remove all exercises from this worksheet.
470
678
        This does not delete the exercises themselves. It just removes them
471
679
        from the worksheet.
472
680
        """
 
681
        store = Store.of(self)
 
682
        for ws_ex in self.all_worksheet_exercises:
 
683
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
684
                raise IntegrityError()
473
685
        store.find(WorksheetExercise,
474
686
            WorksheetExercise.worksheet == self).remove()
475
687
            
476
688
    def get_permissions(self, user):
477
689
        return self.offering.get_permissions(user)
478
 
 
 
690
    
 
691
    def get_xml(self):
 
692
        """Returns the xml of this worksheet, converts from rst if required."""
 
693
        if self.format == u'rst':
 
694
            ws_xml = rst(self.data)
 
695
            return ws_xml
 
696
        else:
 
697
            return self.data
 
698
    
 
699
    def delete(self):
 
700
        """Deletes the worksheet, provided it has no attempts on any exercises.
 
701
        
 
702
        Returns True if delete succeeded, or False if this worksheet has
 
703
        attempts attached."""
 
704
        for ws_ex in self.all_worksheet_exercises:
 
705
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
 
706
                raise IntegrityError()
 
707
        
 
708
        self.remove_all_exercises()
 
709
        Store.of(self).remove(self)
 
710
        
479
711
class WorksheetExercise(Storm):
480
712
    __storm_table__ = "worksheet_exercise"
481
713
    
498
730
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
499
731
                                  self.worksheet.identifier)
500
732
 
 
733
    def get_permissions(self, user):
 
734
        return self.worksheet.get_permissions(user)
 
735
    
 
736
 
501
737
class ExerciseSave(Storm):
502
738
    """
503
739
    Represents a potential solution to an exercise that a user has submitted
561
797
    function = Unicode()
562
798
    stdin = Unicode()
563
799
    exercise = Reference(exercise_id, Exercise.id)
564
 
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid')
565
 
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid')
 
800
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
 
801
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
 
802
    
 
803
    def delete(self):
 
804
        """Delete this suite, without asking questions."""
 
805
        for vaariable in self.variables:
 
806
            variable.delete()
 
807
        for test_case in self.test_cases:
 
808
            test_case.delete()
 
809
        Store.of(self).remove(self)
566
810
 
567
811
class TestCase(Storm):
568
812
    """A TestCase is a member of a TestSuite.
582
826
    parts = ReferenceSet(testid, "TestCasePart.testid")
583
827
    
584
828
    __init__ = _kwarg_init
 
829
    
 
830
    def delete(self):
 
831
        for part in self.parts:
 
832
            part.delete()
 
833
        Store.of(self).remove(self)
585
834
 
586
835
class TestSuiteVar(Storm):
587
836
    """A container for the arguments of a Test Suite"""
599
848
    
600
849
    __init__ = _kwarg_init
601
850
    
 
851
    def delete(self):
 
852
        Store.of(self).remove(self)
 
853
    
602
854
class TestCasePart(Storm):
603
855
    """A container for the test elements of a Test Case"""
604
856
    __storm_table__ = "test_case_part"
615
867
    test = Reference(testid, "TestCase.testid")
616
868
    
617
869
    __init__ = _kwarg_init
 
870
    
 
871
    def delete(self):
 
872
        Store.of(self).remove(self)