← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/database.py

  • Committer: William Grant
  • Date: 2009-02-25 23:04:11 UTC
  • Revision ID: grantw@unimelb.edu.au-20090225230411-lbdyl32ir0m3d59b
Make all of the services executable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/database.py
31
31
                         Reference, ReferenceSet, Bool, Storm, Desc
32
32
 
33
33
import ivle.conf
34
 
import ivle.caps
35
34
 
36
35
__all__ = ['get_store',
37
36
            'User',
39
38
            'ProjectSet', 'Project', 'ProjectGroup', 'ProjectGroupMembership',
40
39
            'Exercise', 'Worksheet', 'WorksheetExercise',
41
40
            'ExerciseSave', 'ExerciseAttempt',
42
 
            'AlreadyEnrolledError', 'TestCase', 'TestSuite', 'TestSuiteVar'
 
41
            'TestCase', 'TestSuite', 'TestSuiteVar'
43
42
        ]
44
43
 
45
44
def _kwarg_init(self, **kwargs):
53
52
    """
54
53
    Returns the Storm connection string, generated from the conf file.
55
54
    """
56
 
    return "postgres://%s:%s@%s:%d/%s" % (ivle.conf.db_user,
57
 
        ivle.conf.db_password, ivle.conf.db_host, ivle.conf.db_port,
58
 
        ivle.conf.db_dbname)
 
55
 
 
56
    clusterstr = ''
 
57
    if ivle.conf.db_user:
 
58
        clusterstr += ivle.conf.db_user
 
59
        if ivle.conf.db_password:
 
60
            clusterstr += ':' + ivle.conf.db_password
 
61
        clusterstr += '@'
 
62
 
 
63
    host = ivle.conf.db_host or 'localhost'
 
64
    port = ivle.conf.db_port or 5432
 
65
 
 
66
    clusterstr += '%s:%d' % (host, port)
 
67
 
 
68
    return "postgres://%s/%s" % (clusterstr, ivle.conf.db_dbname)
59
69
 
60
70
def get_store():
61
71
    """
76
86
    login = Unicode()
77
87
    passhash = Unicode()
78
88
    state = Unicode()
79
 
    rolenm = Unicode()
 
89
    admin = Bool()
80
90
    unixid = Int()
81
91
    nick = Unicode()
82
92
    pass_exp = DateTime()
88
98
    studentid = Unicode()
89
99
    settings = Unicode()
90
100
 
91
 
    def _get_role(self):
92
 
        if self.rolenm is None:
93
 
            return None
94
 
        return ivle.caps.Role(self.rolenm)
95
 
    def _set_role(self, value):
96
 
        if not isinstance(value, ivle.caps.Role):
97
 
            raise TypeError("role must be an ivle.caps.Role")
98
 
        self.rolenm = unicode(value)
99
 
    role = property(_get_role, _set_role)
100
 
 
101
101
    __init__ = _kwarg_init
102
102
 
103
103
    def __repr__(self):
114
114
            return None
115
115
        return self.hash_password(password) == self.passhash
116
116
 
117
 
    def hasCap(self, capability):
118
 
        """Given a capability (which is a Role object), returns True if this
119
 
        User has that capability, False otherwise.
120
 
        """
121
 
        return self.role.hasCap(capability)
122
 
 
123
117
    @property
124
118
    def password_expired(self):
125
119
        fieldval = self.pass_exp
201
195
        return store.find(cls, cls.login == unicode(login)).one()
202
196
 
203
197
    def get_permissions(self, user):
204
 
        if user and user.rolenm == 'admin' or user is self:
 
198
        if user and user.admin or user is self:
205
199
            return set(['view', 'edit'])
206
200
        else:
207
201
            return set()
228
222
        perms = set()
229
223
        if user is not None:
230
224
            perms.add('view')
231
 
            if user.rolenm == 'admin':
 
225
            if user.admin:
232
226
                perms.add('edit')
233
227
        return perms
234
228
 
238
232
    id = Int(primary=True, name="semesterid")
239
233
    year = Unicode()
240
234
    semester = Unicode()
241
 
    active = Bool()
 
235
    state = Unicode()
242
236
 
243
237
    offerings = ReferenceSet(id, 'Offering.semester_id')
244
238
 
264
258
                           'User.id')
265
259
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
266
260
 
267
 
    worksheets = ReferenceSet(id, 'Worksheet.offering_id')
 
261
    worksheets = ReferenceSet(id, 
 
262
        'Worksheet.offering_id', 
 
263
        order_by="Worksheet.seq_no"
 
264
    )
268
265
 
269
266
    __init__ = _kwarg_init
270
267
 
272
269
        return "<%s %r in %r>" % (type(self).__name__, self.subject,
273
270
                                  self.semester)
274
271
 
275
 
    def enrol(self, user):
 
272
    def enrol(self, user, role=u'student'):
276
273
        '''Enrol a user in this offering.'''
277
 
        # We'll get a horrible database constraint violation error if we try
278
 
        # to add a second enrolment.
279
 
        if Store.of(self).find(Enrolment,
 
274
        enrolment = Store.of(self).find(Enrolment,
280
275
                               Enrolment.user_id == user.id,
281
 
                               Enrolment.offering_id == self.id).count() == 1:
282
 
            raise AlreadyEnrolledError()
283
 
 
284
 
        e = Enrolment(user=user, offering=self, active=True)
285
 
        self.enrolments.add(e)
 
276
                               Enrolment.offering_id == self.id).one()
 
277
 
 
278
        if enrolment is None:
 
279
            enrolment = Enrolment(user=user, offering=self)
 
280
            self.enrolments.add(enrolment)
 
281
 
 
282
        enrolment.active = True
 
283
        enrolment.role = role
286
284
 
287
285
    def get_permissions(self, user):
288
286
        perms = set()
289
287
        if user is not None:
290
288
            perms.add('view')
291
 
            if user.rolenm == 'admin':
 
289
            if user.admin:
292
290
                perms.add('edit')
293
291
        return perms
294
292
 
300
298
    user = Reference(user_id, User.id)
301
299
    offering_id = Int(name="offeringid")
302
300
    offering = Reference(offering_id, Offering.id)
 
301
    role = Unicode()
303
302
    notes = Unicode()
304
303
    active = Bool()
305
304
 
317
316
        return "<%s %r in %r>" % (type(self).__name__, self.user,
318
317
                                  self.offering)
319
318
 
320
 
class AlreadyEnrolledError(Exception):
321
 
    pass
322
 
 
323
319
# PROJECTS #
324
320
 
325
321
class ProjectSet(Storm):
396
392
# WORKSHEETS AND EXERCISES #
397
393
 
398
394
class Exercise(Storm):
399
 
    # Note: Table "problem" is called "Exercise" in the Object layer, since
400
 
    # it's called that everywhere else.
401
 
    __storm_table__ = "problem"
402
 
#TODO: Add in a field for the user-friendly identifier
 
395
    __storm_table__ = "exercise"
403
396
    id = Unicode(primary=True, name="identifier")
404
397
    name = Unicode()
405
398
    description = Unicode()
421
414
    def __repr__(self):
422
415
        return "<%s %s>" % (type(self).__name__, self.name)
423
416
 
 
417
    def get_permissions(self, user):
 
418
        perms = set()
 
419
        if user is not None:
 
420
            if user.admin:
 
421
                perms.add('edit')
 
422
                perms.add('view')
 
423
        return perms
424
424
 
425
425
class Worksheet(Storm):
426
426
    __storm_table__ = "worksheet"
427
427
 
428
428
    id = Int(primary=True, name="worksheetid")
429
 
    # XXX subject is not linked to a Subject object. This is a property of
430
 
    # the database, and will be refactored.
431
429
    offering_id = Int(name="offeringid")
432
 
    name = Unicode(name="identifier")
 
430
    identifier = Unicode()
 
431
    name = Unicode()
433
432
    assessable = Bool()
434
 
    mtime = DateTime()
 
433
    data = Unicode()
 
434
    seq_no = Int()
 
435
    format = Unicode()
435
436
 
436
437
    attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
437
438
    offering = Reference(offering_id, 'Offering.id')
438
439
 
439
 
    exercises = ReferenceSet(id,
440
 
        'WorksheetExercise.worksheet_id',
441
 
        'WorksheetExercise.exercise_id',
442
 
        Exercise.id)
443
 
    # Use worksheet_exercises to get access to the WorksheetExercise objects
444
 
    # binding worksheets to exercises. This is required to access the
 
440
    all_worksheet_exercises = ReferenceSet(id,
 
441
        'WorksheetExercise.worksheet_id')
 
442
 
 
443
    # Use worksheet_exercises to get access to the *active* WorksheetExercise
 
444
    # objects binding worksheets to exercises. This is required to access the
445
445
    # "optional" field.
446
 
    worksheet_exercises = ReferenceSet(id,
447
 
        'WorksheetExercise.worksheet_id')
448
 
        
 
446
    @property
 
447
    def worksheet_exercises(self):
 
448
        return self.all_worksheet_exercises.find(active=True)
449
449
 
450
450
    __init__ = _kwarg_init
451
451
 
477
477
        return self.offering.get_permissions(user)
478
478
 
479
479
class WorksheetExercise(Storm):
480
 
    __storm_table__ = "worksheet_problem"
481
 
    __storm_primary__ = "worksheet_id", "exercise_id"
 
480
    __storm_table__ = "worksheet_exercise"
 
481
    
 
482
    id = Int(primary=True, name="ws_ex_id")
482
483
 
483
484
    worksheet_id = Int(name="worksheetid")
484
485
    worksheet = Reference(worksheet_id, Worksheet.id)
485
 
    exercise_id = Unicode(name="problemid")
 
486
    exercise_id = Unicode(name="exerciseid")
486
487
    exercise = Reference(exercise_id, Exercise.id)
487
488
    optional = Bool()
 
489
    active = Bool()
 
490
    seq_no = Int()
 
491
    
 
492
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
 
493
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
488
494
 
489
495
    __init__ = _kwarg_init
490
496
 
491
497
    def __repr__(self):
492
498
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
493
 
                                  self.worksheet.name)
 
499
                                  self.worksheet.identifier)
494
500
 
495
501
class ExerciseSave(Storm):
496
502
    """
501
507
    ExerciseSave may be extended with additional semantics (such as
502
508
    ExerciseAttempt).
503
509
    """
504
 
    __storm_table__ = "problem_save"
505
 
    __storm_primary__ = "exercise_id", "user_id", "date"
506
 
 
507
 
    exercise_id = Unicode(name="problemid")
508
 
    exercise = Reference(exercise_id, Exercise.id)
 
510
    __storm_table__ = "exercise_save"
 
511
    __storm_primary__ = "ws_ex_id", "user_id"
 
512
 
 
513
    ws_ex_id = Int(name="ws_ex_id")
 
514
    worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
 
515
 
509
516
    user_id = Int(name="loginid")
510
517
    user = Reference(user_id, User.id)
511
518
    date = DateTime()
512
519
    text = Unicode()
513
 
    worksheetid = Int()
514
 
    worksheet = Reference(worksheetid, Worksheet.id)
515
520
 
516
521
    __init__ = _kwarg_init
517
522
 
532
537
        they won't count (either as a penalty or success), but will still be
533
538
        stored.
534
539
    """
535
 
    __storm_table__ = "problem_attempt"
536
 
    __storm_primary__ = "exercise_id", "user_id", "date"
 
540
    __storm_table__ = "exercise_attempt"
 
541
    __storm_primary__ = "ws_ex_id", "user_id", "date"
537
542
 
538
543
    # The "text" field is the same but has a different name in the DB table
539
544
    # for some reason.
550
555
    __storm_primary__ = "exercise_id", "suiteid"
551
556
    
552
557
    suiteid = Int()
553
 
    exercise_id = Unicode(name="problemid")
 
558
    exercise_id = Unicode(name="exerciseid")
554
559
    description = Unicode()
555
560
    seq_no = Int()
556
561
    function = Unicode()
580
585
 
581
586
class TestSuiteVar(Storm):
582
587
    """A container for the arguments of a Test Suite"""
583
 
    __storm_table__ = "suite_variables"
 
588
    __storm_table__ = "suite_variable"
584
589
    __storm_primary__ = "varid"
585
590
    
586
591
    varid = Int()
596
601
    
597
602
class TestCasePart(Storm):
598
603
    """A container for the test elements of a Test Case"""
599
 
    __storm_table__ = "test_case_parts"
 
604
    __storm_table__ = "test_case_part"
600
605
    __storm_primary__ = "partid"
601
606
    
602
607
    partid = Int()