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

« back to all changes in this revision

Viewing changes to ivle/database.py

Give console and tutorial services security declarations.

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
 
18
18
# Author: Matt Giuca, Will Grant
19
19
 
20
 
"""Database utilities and content classes.
 
20
"""
 
21
Database Classes and Utilities for Storm ORM
21
22
 
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.
24
25
"""
25
26
 
26
 
import hashlib
 
27
import md5
27
28
import datetime
28
29
 
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
 
from storm.exceptions import NotOneError, IntegrityError
33
32
 
34
 
from ivle.worksheet.rst import rst
 
33
import ivle.conf
 
34
import ivle.caps
35
35
 
36
36
__all__ = ['get_store',
37
37
            'User',
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
 
            'TestCase', 'TestSuite', 'TestSuiteVar'
 
42
            'AlreadyEnrolledError'
44
43
        ]
45
44
 
46
45
def _kwarg_init(self, **kwargs):
50
49
                % (self.__class__.__name__, k))
51
50
        setattr(self, k, v)
52
51
 
53
 
def get_conn_string(config):
54
 
    """Create a Storm connection string to the IVLE database
55
 
 
56
 
    @param config: The IVLE configuration.
57
 
    """
58
 
 
59
 
    clusterstr = ''
60
 
    if config['database']['username']:
61
 
        clusterstr += config['database']['username']
62
 
        if config['database']['password']:
63
 
            clusterstr += ':' + config['database']['password']
64
 
        clusterstr += '@'
65
 
 
66
 
    host = config['database']['host'] or 'localhost'
67
 
    port = config['database']['port'] or 5432
68
 
 
69
 
    clusterstr += '%s:%d' % (host, port)
70
 
 
71
 
    return "postgres://%s/%s" % (clusterstr, config['database']['name'])
72
 
 
73
 
def get_store(config):
74
 
    """Create a Storm store connected to the IVLE database.
75
 
 
76
 
    @param config: The IVLE configuration.
77
 
    """
78
 
    return Store(create_database(get_conn_string(config)))
 
52
def get_conn_string():
 
53
    """
 
54
    Returns the Storm connection string, generated from the conf file.
 
55
    """
 
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)
 
59
 
 
60
def get_store():
 
61
    """
 
62
    Open a database connection and transaction. Return a storm.store.Store
 
63
    instance connected to the configured IVLE database.
 
64
    """
 
65
    return Store(create_database(get_conn_string()))
79
66
 
80
67
# USERS #
81
68
 
82
69
class User(Storm):
83
 
    """An IVLE user account."""
 
70
    """
 
71
    Represents an IVLE user.
 
72
    """
84
73
    __storm_table__ = "login"
85
74
 
86
75
    id = Int(primary=True, name="loginid")
87
76
    login = Unicode()
88
77
    passhash = Unicode()
89
78
    state = Unicode()
90
 
    admin = Bool()
 
79
    rolenm = Unicode()
91
80
    unixid = Int()
92
81
    nick = Unicode()
93
82
    pass_exp = DateTime()
99
88
    studentid = Unicode()
100
89
    settings = Unicode()
101
90
 
 
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
 
102
101
    __init__ = _kwarg_init
103
102
 
104
103
    def __repr__(self):
115
114
            return None
116
115
        return self.hash_password(password) == self.passhash
117
116
 
118
 
    @property
119
 
    def display_name(self):
120
 
        """Returns the "nice name" of the user or group."""
121
 
        return self.fullname
122
 
 
123
 
    @property
124
 
    def short_name(self):
125
 
        """Returns the database "identifier" name of the user or group."""
126
 
        return self.login
 
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)
127
122
 
128
123
    @property
129
124
    def password_expired(self):
135
130
        fieldval = self.acct_exp
136
131
        return fieldval is not None and datetime.datetime.now() > fieldval
137
132
 
138
 
    @property
139
 
    def valid(self):
140
 
        return self.state == 'enabled' and not self.account_expired
141
 
 
142
133
    def _get_enrolments(self, justactive):
143
134
        return Store.of(self).find(Enrolment,
144
135
            Enrolment.user_id == self.id,
168
159
 
169
160
    # TODO: Invitations should be listed too?
170
161
    def get_groups(self, offering=None):
171
 
        """Get groups of which this user is a member.
172
 
 
173
 
        @param offering: An optional offering to restrict the search to.
174
 
        """
175
162
        preds = [
176
163
            ProjectGroupMembership.user_id == self.id,
177
164
            ProjectGroup.id == ProjectGroupMembership.project_group_id,
197
184
        '''A sanely ordered list of all of the user's enrolments.'''
198
185
        return self._get_enrolments(False) 
199
186
 
200
 
    def get_projects(self, offering=None, active_only=True):
201
 
        """Find projects that the user can submit.
202
 
 
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).
206
 
 
207
 
        @param active_only: Whether to only search active offerings.
208
 
        @param offering: An optional offering to restrict the search to.
209
 
        """
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)
219
 
 
220
187
    @staticmethod
221
188
    def hash_password(password):
222
 
        """Hash a password with MD5."""
223
 
        return hashlib.md5(password).hexdigest()
 
189
        return md5.md5(password).hexdigest()
224
190
 
225
191
    @classmethod
226
192
    def get_by_login(cls, store, login):
227
 
        """Find a user in a store by login name."""
 
193
        """
 
194
        Get the User from the db associated with a given store and
 
195
        login.
 
196
        """
228
197
        return store.find(cls, cls.login == unicode(login)).one()
229
198
 
230
199
    def get_permissions(self, user):
231
 
        """Determine privileges held by a user over this object.
232
 
 
233
 
        If the user requesting privileges is this user or an admin,
234
 
        they may do everything. Otherwise they may do nothing.
235
 
        """
236
 
        if user and user.admin or user is self:
237
 
            return set(['view', 'edit', 'submit_project'])
 
200
        if user and user.rolenm == 'admin' or user is self:
 
201
            return set(['view', 'edit'])
238
202
        else:
239
203
            return set()
240
204
 
241
205
# SUBJECTS AND ENROLMENTS #
242
206
 
243
207
class Subject(Storm):
244
 
    """A subject (or course) which is run in some semesters."""
245
 
 
246
208
    __storm_table__ = "subject"
247
209
 
248
210
    id = Int(primary=True, name="subjectid")
259
221
        return "<%s '%s'>" % (type(self).__name__, self.short_name)
260
222
 
261
223
    def get_permissions(self, user):
262
 
        """Determine privileges held by a user over this object.
263
 
 
264
 
        If the user requesting privileges is an admin, they may edit.
265
 
        Otherwise they may only read.
266
 
        """
267
224
        perms = set()
268
225
        if user is not None:
269
226
            perms.add('view')
270
 
            if user.admin:
271
 
                perms.add('edit')
 
227
        if user.rolenm == 'admin':
 
228
            perms.add('edit')
272
229
        return perms
273
230
 
274
 
    def active_offerings(self):
275
 
        """Find active offerings for this subject.
276
 
 
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.
280
 
        """
281
 
        return self.offerings.find(Offering.semester_id == Semester.id,
282
 
                                   Semester.state == u'current')
283
 
 
284
 
    def offering_for_semester(self, year, semester):
285
 
        """Get the offering for the given year/semester, or None.
286
 
 
287
 
        @param year: A string representation of the year.
288
 
        @param semester: A string representation of the semester.
289
 
        """
290
 
        return self.offerings.find(Offering.semester_id == Semester.id,
291
 
                               Semester.year == unicode(year),
292
 
                               Semester.semester == unicode(semester)).one()
293
 
 
294
231
class Semester(Storm):
295
 
    """A semester in which subjects can be run."""
296
 
 
297
232
    __storm_table__ = "semester"
298
233
 
299
234
    id = Int(primary=True, name="semesterid")
300
235
    year = Unicode()
301
236
    semester = Unicode()
302
 
    state = Unicode()
 
237
    active = Bool()
303
238
 
304
239
    offerings = ReferenceSet(id, 'Offering.semester_id')
305
 
    enrolments = ReferenceSet(id,
306
 
                              'Offering.semester_id',
307
 
                              'Offering.id',
308
 
                              'Enrolment.offering_id')
309
240
 
310
241
    __init__ = _kwarg_init
311
242
 
313
244
        return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
314
245
 
315
246
class Offering(Storm):
316
 
    """An offering of a subject in a particular semester."""
317
 
 
318
247
    __storm_table__ = "offering"
319
248
 
320
249
    id = Int(primary=True, name="offeringid")
331
260
                           'User.id')
332
261
    project_sets = ReferenceSet(id, 'ProjectSet.offering_id')
333
262
 
334
 
    worksheets = ReferenceSet(id, 
335
 
        'Worksheet.offering_id', 
336
 
        order_by="seq_no"
337
 
    )
338
 
 
339
263
    __init__ = _kwarg_init
340
264
 
341
265
    def __repr__(self):
342
266
        return "<%s %r in %r>" % (type(self).__name__, self.subject,
343
267
                                  self.semester)
344
268
 
345
 
    def enrol(self, user, role=u'student'):
346
 
        """Enrol a user in this offering.
347
 
 
348
 
        Enrolments handle both the staff and student cases. The role controls
349
 
        the privileges granted by this enrolment.
350
 
        """
351
 
        enrolment = Store.of(self).find(Enrolment,
352
 
                               Enrolment.user_id == user.id,
353
 
                               Enrolment.offering_id == self.id).one()
354
 
 
355
 
        if enrolment is None:
356
 
            enrolment = Enrolment(user=user, offering=self)
357
 
            self.enrolments.add(enrolment)
358
 
 
359
 
        enrolment.active = True
360
 
        enrolment.role = role
361
 
 
362
 
    def unenrol(self, user):
363
 
        '''Unenrol a user from this offering.'''
364
 
        enrolment = Store.of(self).find(Enrolment,
365
 
                               Enrolment.user_id == user.id,
366
 
                               Enrolment.offering_id == self.id).one()
367
 
        Store.of(enrolment).remove(enrolment)
368
 
 
369
 
    def get_permissions(self, user):
370
 
        perms = set()
371
 
        if user is not None:
372
 
            enrolment = self.get_enrolment(user)
373
 
            if enrolment or user.admin:
374
 
                perms.add('view')
375
 
            if (enrolment and enrolment.role in (u'tutor', u'lecturer')) \
376
 
               or user.admin:
377
 
                perms.add('edit')
378
 
        return perms
379
 
 
380
 
    def get_enrolment(self, user):
381
 
        """Find the user's enrolment in this offering."""
382
 
        try:
383
 
            enrolment = self.enrolments.find(user=user).one()
384
 
        except NotOneError:
385
 
            enrolment = None
386
 
 
387
 
        return enrolment
388
 
 
389
 
    def get_members_by_role(self, role):
390
 
        return Store.of(self).find(User,
391
 
                Enrolment.user_id == User.id,
392
 
                Enrolment.offering_id == self.id,
393
 
                Enrolment.role == role
394
 
                )
395
 
 
396
 
    @property
397
 
    def students(self):
398
 
        return self.get_members_by_role(u'student')
 
269
    def enrol(self, user):
 
270
        '''Enrol a user in this offering.'''
 
271
        # We'll get a horrible database constraint violation error if we try
 
272
        # to add a second enrolment.
 
273
        if Store.of(self).find(Enrolment,
 
274
                               Enrolment.user_id == user.id,
 
275
                               Enrolment.offering_id == self.id).count() == 1:
 
276
            raise AlreadyEnrolledError()
 
277
 
 
278
        e = Enrolment(user=user, offering=self, active=True)
 
279
        self.enrolments.add(e)
399
280
 
400
281
class Enrolment(Storm):
401
 
    """An enrolment of a user in an offering.
402
 
 
403
 
    This represents the roles of both staff and students.
404
 
    """
405
 
 
406
282
    __storm_table__ = "enrolment"
407
283
    __storm_primary__ = "user_id", "offering_id"
408
284
 
410
286
    user = Reference(user_id, User.id)
411
287
    offering_id = Int(name="offeringid")
412
288
    offering = Reference(offering_id, Offering.id)
413
 
    role = Unicode()
414
289
    notes = Unicode()
415
290
    active = Bool()
416
291
 
428
303
        return "<%s %r in %r>" % (type(self).__name__, self.user,
429
304
                                  self.offering)
430
305
 
 
306
class AlreadyEnrolledError(Exception):
 
307
    pass
 
308
 
431
309
# PROJECTS #
432
310
 
433
311
class ProjectSet(Storm):
434
 
    """A set of projects that share common groups.
435
 
 
436
 
    Each student project group is attached to a project set. The group is
437
 
    valid for all projects in the group's set.
438
 
    """
439
 
 
440
312
    __storm_table__ = "project_set"
441
313
 
442
314
    id = Int(name="projectsetid", primary=True)
453
325
        return "<%s %d in %r>" % (type(self).__name__, self.id,
454
326
                                  self.offering)
455
327
 
456
 
    def get_permissions(self, user):
457
 
        return self.offering.get_permissions(user)
458
 
 
459
 
    @property
460
 
    def assigned(self):
461
 
        """Get the entities (groups or users) assigned to submit this project.
462
 
 
463
 
        This will be a Storm ResultSet.
464
 
        """
465
 
        #If its a solo project, return everyone in offering
466
 
        if self.max_students_per_group is None:
467
 
            return self.offering.students
468
 
        else:
469
 
            return self.project_groups
470
 
 
471
328
class Project(Storm):
472
 
    """A student project for which submissions can be made."""
473
 
 
474
329
    __storm_table__ = "project"
475
330
 
476
331
    id = Int(name="projectid", primary=True)
477
 
    name = Unicode()
478
 
    short_name = Unicode()
479
332
    synopsis = Unicode()
480
333
    url = Unicode()
481
334
    project_set_id = Int(name="projectsetid")
482
335
    project_set = Reference(project_set_id, ProjectSet.id)
483
336
    deadline = DateTime()
484
337
 
485
 
    assesseds = ReferenceSet(id, 'Assessed.project_id')
486
 
    submissions = ReferenceSet(id,
487
 
                               'Assessed.project_id',
488
 
                               'Assessed.id',
489
 
                               'ProjectSubmission.assessed_id')
490
 
 
491
338
    __init__ = _kwarg_init
492
339
 
493
340
    def __repr__(self):
494
 
        return "<%s '%s' in %r>" % (type(self).__name__, self.short_name,
 
341
        return "<%s '%s' in %r>" % (type(self).__name__, self.synopsis,
495
342
                                  self.project_set.offering)
496
343
 
497
 
    def can_submit(self, principal):
498
 
        return (self in principal.get_projects() and
499
 
                self.deadline > datetime.datetime.now())
500
 
 
501
 
    def submit(self, principal, path, revision, who):
502
 
        """Submit a Subversion path and revision to a project.
503
 
 
504
 
        @param principal: The owner of the Subversion repository, and the
505
 
                          entity on behalf of whom the submission is being made
506
 
        @param path: A path within that repository to submit.
507
 
        @param revision: The revision of that path to submit.
508
 
        @param who: The user who is actually making the submission.
509
 
        """
510
 
 
511
 
        if not self.can_submit(principal):
512
 
            raise Exception('cannot submit')
513
 
 
514
 
        a = Assessed.get(Store.of(self), principal, self)
515
 
        ps = ProjectSubmission()
516
 
        ps.path = path
517
 
        ps.revision = revision
518
 
        ps.date_submitted = datetime.datetime.now()
519
 
        ps.assessed = a
520
 
        ps.submitter = who
521
 
 
522
 
        return ps
523
 
 
524
 
    def get_permissions(self, user):
525
 
        return self.project_set.offering.get_permissions(user)
526
 
 
527
 
    @property
528
 
    def latest_submissions(self):
529
 
        """Return the latest submission for each Assessed."""
530
 
        return Store.of(self).find(ProjectSubmission,
531
 
            Assessed.project_id == self.id,
532
 
            ProjectSubmission.assessed_id == Assessed.id,
533
 
            ProjectSubmission.date_submitted == Select(
534
 
                    Max(ProjectSubmission.date_submitted),
535
 
                    ProjectSubmission.assessed_id == Assessed.id,
536
 
                    tables=ProjectSubmission
537
 
            )
538
 
        )
539
 
 
540
 
 
541
344
class ProjectGroup(Storm):
542
 
    """A group of students working together on a project."""
543
 
 
544
345
    __storm_table__ = "project_group"
545
346
 
546
347
    id = Int(name="groupid", primary=True)
563
364
        return "<%s %s in %r>" % (type(self).__name__, self.name,
564
365
                                  self.project_set.offering)
565
366
 
566
 
    @property
567
 
    def display_name(self):
568
 
        """Returns the "nice name" of the user or group."""
569
 
        return self.nick
570
 
 
571
 
    @property
572
 
    def short_name(self):
573
 
        """Returns the database "identifier" name of the user or group."""
574
 
        return self.name
575
 
 
576
 
    def get_projects(self, offering=None, active_only=True):
577
 
        '''Find projects that the group can submit.
578
 
 
579
 
        This will include projects in the project set which owns this group,
580
 
        unless the project set disallows groups (in which case none will be
581
 
        returned).
582
 
 
583
 
        @param active_only: Whether to only search active offerings.
584
 
        @param offering: An optional offering to restrict the search to.
585
 
        '''
586
 
        return Store.of(self).find(Project,
587
 
            Project.project_set_id == ProjectSet.id,
588
 
            ProjectSet.id == self.project_set.id,
589
 
            ProjectSet.max_students_per_group != None,
590
 
            ProjectSet.offering_id == Offering.id,
591
 
            (offering is None) or (Offering.id == offering.id),
592
 
            Semester.id == Offering.semester_id,
593
 
            (not active_only) or (Semester.state == u'current'))
594
 
 
595
 
 
596
 
    def get_permissions(self, user):
597
 
        if user.admin or user in self.members:
598
 
            return set(['submit_project'])
599
 
        else:
600
 
            return set()
601
 
 
602
367
class ProjectGroupMembership(Storm):
603
 
    """A student's membership in a project group."""
604
 
 
605
368
    __storm_table__ = "group_member"
606
369
    __storm_primary__ = "user_id", "project_group_id"
607
370
 
616
379
        return "<%s %r in %r>" % (type(self).__name__, self.user,
617
380
                                  self.project_group)
618
381
 
619
 
class Assessed(Storm):
620
 
    """A composite of a user or group combined with a project.
621
 
 
622
 
    Each project submission and extension refers to an Assessed. It is the
623
 
    sole specifier of the repository and project.
624
 
    """
625
 
 
626
 
    __storm_table__ = "assessed"
627
 
 
628
 
    id = Int(name="assessedid", primary=True)
629
 
    user_id = Int(name="loginid")
630
 
    user = Reference(user_id, User.id)
631
 
    project_group_id = Int(name="groupid")
632
 
    project_group = Reference(project_group_id, ProjectGroup.id)
633
 
 
634
 
    project_id = Int(name="projectid")
635
 
    project = Reference(project_id, Project.id)
636
 
 
637
 
    extensions = ReferenceSet(id, 'ProjectExtension.assessed_id')
638
 
    submissions = ReferenceSet(id, 'ProjectSubmission.assessed_id')
639
 
 
640
 
    def __repr__(self):
641
 
        return "<%s %r in %r>" % (type(self).__name__,
642
 
            self.user or self.project_group, self.project)
643
 
 
644
 
    @property
645
 
    def is_group(self):
646
 
        """True if the Assessed is a group, False if it is a user."""
647
 
        return self.project_group is not None
648
 
 
649
 
    @property
650
 
    def principal(self):
651
 
        return self.project_group or self.user
652
 
 
653
 
    @classmethod
654
 
    def get(cls, store, principal, project):
655
 
        """Find or create an Assessed for the given user or group and project.
656
 
 
657
 
        @param principal: The user or group.
658
 
        @param project: The project.
659
 
        """
660
 
        t = type(principal)
661
 
        if t not in (User, ProjectGroup):
662
 
            raise AssertionError('principal must be User or ProjectGroup')
663
 
 
664
 
        a = store.find(cls,
665
 
            (t is User) or (cls.project_group_id == principal.id),
666
 
            (t is ProjectGroup) or (cls.user_id == principal.id),
667
 
            Project.id == project.id).one()
668
 
 
669
 
        if a is None:
670
 
            a = cls()
671
 
            if t is User:
672
 
                a.user = principal
673
 
            else:
674
 
                a.project_group = principal
675
 
            a.project = project
676
 
            store.add(a)
677
 
 
678
 
        return a
679
 
 
680
 
 
681
 
class ProjectExtension(Storm):
682
 
    """An extension granted to a user or group on a particular project.
683
 
 
684
 
    The user or group and project are specified by the Assessed.
685
 
    """
686
 
 
687
 
    __storm_table__ = "project_extension"
688
 
 
689
 
    id = Int(name="extensionid", primary=True)
690
 
    assessed_id = Int(name="assessedid")
691
 
    assessed = Reference(assessed_id, Assessed.id)
692
 
    deadline = DateTime()
693
 
    approver_id = Int(name="approver")
694
 
    approver = Reference(approver_id, User.id)
695
 
    notes = Unicode()
696
 
 
697
 
class ProjectSubmission(Storm):
698
 
    """A submission from a user or group repository to a particular project.
699
 
 
700
 
    The content of a submission is a single path and revision inside a
701
 
    repository. The repository is that owned by the submission's user and
702
 
    group, while the path and revision are explicit.
703
 
 
704
 
    The user or group and project are specified by the Assessed.
705
 
    """
706
 
 
707
 
    __storm_table__ = "project_submission"
708
 
 
709
 
    id = Int(name="submissionid", primary=True)
710
 
    assessed_id = Int(name="assessedid")
711
 
    assessed = Reference(assessed_id, Assessed.id)
712
 
    path = Unicode()
713
 
    revision = Int()
714
 
    submitter_id = Int(name="submitter")
715
 
    submitter = Reference(submitter_id, User.id)
716
 
    date_submitted = DateTime()
717
 
 
718
 
 
719
382
# WORKSHEETS AND EXERCISES #
720
383
 
721
384
class Exercise(Storm):
722
 
    """An exercise for students to complete in a worksheet.
723
 
 
724
 
    An exercise may be present in any number of worksheets.
725
 
    """
726
 
 
727
 
    __storm_table__ = "exercise"
728
 
    id = Unicode(primary=True, name="identifier")
729
 
    name = Unicode()
730
 
    description = Unicode()
731
 
    partial = Unicode()
732
 
    solution = Unicode()
733
 
    include = Unicode()
734
 
    num_rows = Int()
735
 
 
736
 
    worksheet_exercises =  ReferenceSet(id,
737
 
        'WorksheetExercise.exercise_id')
 
385
    # Note: Table "problem" is called "Exercise" in the Object layer, since
 
386
    # it's called that everywhere else.
 
387
    __storm_table__ = "problem"
 
388
 
 
389
    id = Int(primary=True, name="problemid")
 
390
    name = Unicode(name="identifier")
 
391
    spec = Unicode()
738
392
 
739
393
    worksheets = ReferenceSet(id,
740
394
        'WorksheetExercise.exercise_id',
742
396
        'Worksheet.id'
743
397
    )
744
398
 
745
 
    test_suites = ReferenceSet(id, 
746
 
        'TestSuite.exercise_id',
747
 
        order_by='seq_no')
748
 
 
749
399
    __init__ = _kwarg_init
750
400
 
751
401
    def __repr__(self):
752
402
        return "<%s %s>" % (type(self).__name__, self.name)
753
403
 
754
 
    def get_permissions(self, user):
755
 
        perms = set()
756
 
        roles = set()
757
 
        if user is not None:
758
 
            if user.admin:
759
 
                perms.add('edit')
760
 
                perms.add('view')
761
 
            elif u'lecturer' in set((e.role for e in user.active_enrolments)):
762
 
                perms.add('edit')
763
 
                perms.add('view')
764
 
            elif u'tutor' in set((e.role for e in user.active_enrolments)):
765
 
                perms.add('edit')
766
 
                perms.add('view')
767
 
 
768
 
        return perms
769
 
 
770
 
    def get_description(self):
771
 
        """Return the description interpreted as reStructuredText."""
772
 
        return rst(self.description)
773
 
 
774
 
    def delete(self):
775
 
        """Deletes the exercise, providing it has no associated worksheets."""
776
 
        if (self.worksheet_exercises.count() > 0):
777
 
            raise IntegrityError()
778
 
        for suite in self.test_suites:
779
 
            suite.delete()
780
 
        Store.of(self).remove(self)
 
404
    @classmethod
 
405
    def get_by_name(cls, store, name):
 
406
        """
 
407
        Get the Exercise from the db associated with a given store and name.
 
408
        If the exercise is not in the database, creates it and inserts it
 
409
        automatically.
 
410
        """
 
411
        ex = store.find(cls, cls.name == unicode(name)).one()
 
412
        if ex is not None:
 
413
            return ex
 
414
        ex = Exercise(name=unicode(name))
 
415
        store.add(ex)
 
416
        store.commit()
 
417
        return ex
781
418
 
782
419
class Worksheet(Storm):
783
 
    """A worksheet with exercises for students to complete.
784
 
 
785
 
    Worksheets are owned by offerings.
786
 
    """
787
 
 
788
420
    __storm_table__ = "worksheet"
789
421
 
790
422
    id = Int(primary=True, name="worksheetid")
791
 
    offering_id = Int(name="offeringid")
792
 
    identifier = Unicode()
793
 
    name = Unicode()
 
423
    # XXX subject is not linked to a Subject object. This is a property of
 
424
    # the database, and will be refactored.
 
425
    subject = Unicode()
 
426
    name = Unicode(name="identifier")
794
427
    assessable = Bool()
795
 
    data = Unicode()
796
 
    seq_no = Int()
797
 
    format = Unicode()
798
 
 
799
 
    attempts = ReferenceSet(id, "ExerciseAttempt.worksheetid")
800
 
    offering = Reference(offering_id, 'Offering.id')
801
 
 
802
 
    all_worksheet_exercises = ReferenceSet(id,
 
428
    mtime = DateTime()
 
429
 
 
430
    exercises = ReferenceSet(id,
 
431
        'WorksheetExercise.worksheet_id',
 
432
        'WorksheetExercise.exercise_id',
 
433
        Exercise.id)
 
434
    # Use worksheet_exercises to get access to the WorksheetExercise objects
 
435
    # binding worksheets to exercises. This is required to access the
 
436
    # "optional" field.
 
437
    worksheet_exercises = ReferenceSet(id,
803
438
        'WorksheetExercise.worksheet_id')
804
439
 
805
 
    # Use worksheet_exercises to get access to the *active* WorksheetExercise
806
 
    # objects binding worksheets to exercises. This is required to access the
807
 
    # "optional" field.
808
 
 
809
 
    @property
810
 
    def worksheet_exercises(self):
811
 
        return self.all_worksheet_exercises.find(active=True)
812
 
 
813
440
    __init__ = _kwarg_init
814
441
 
815
442
    def __repr__(self):
816
443
        return "<%s %s>" % (type(self).__name__, self.name)
817
444
 
818
 
    def remove_all_exercises(self):
819
 
        """Remove all exercises from this worksheet.
 
445
    # XXX Refactor this - make it an instance method of Subject rather than a
 
446
    # class method of Worksheet. Can't do that now because Subject isn't
 
447
    # linked referentially to the Worksheet.
 
448
    @classmethod
 
449
    def get_by_name(cls, store, subjectname, worksheetname):
 
450
        """
 
451
        Get the Worksheet from the db associated with a given store, subject
 
452
        name and worksheet name.
 
453
        """
 
454
        return store.find(cls, cls.subject == unicode(subjectname),
 
455
            cls.name == unicode(worksheetname)).one()
820
456
 
 
457
    def remove_all_exercises(self, store):
 
458
        """
 
459
        Remove all exercises from this worksheet.
821
460
        This does not delete the exercises themselves. It just removes them
822
461
        from the worksheet.
823
462
        """
824
 
        store = Store.of(self)
825
 
        for ws_ex in self.all_worksheet_exercises:
826
 
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
827
 
                raise IntegrityError()
828
463
        store.find(WorksheetExercise,
829
464
            WorksheetExercise.worksheet == self).remove()
830
465
 
831
 
    def get_permissions(self, user):
832
 
        return self.offering.get_permissions(user)
833
 
 
834
 
    def get_xml(self):
835
 
        """Returns the xml of this worksheet, converts from rst if required."""
836
 
        if self.format == u'rst':
837
 
            ws_xml = rst(self.data)
838
 
            return ws_xml
839
 
        else:
840
 
            return self.data
841
 
 
842
 
    def delete(self):
843
 
        """Deletes the worksheet, provided it has no attempts on any exercises.
844
 
 
845
 
        Returns True if delete succeeded, or False if this worksheet has
846
 
        attempts attached."""
847
 
        for ws_ex in self.all_worksheet_exercises:
848
 
            if ws_ex.saves.count() > 0 or ws_ex.attempts.count() > 0:
849
 
                raise IntegrityError()
850
 
 
851
 
        self.remove_all_exercises()
852
 
        Store.of(self).remove(self)
853
 
 
854
466
class WorksheetExercise(Storm):
855
 
    """A link between a worksheet and one of its exercises.
856
 
 
857
 
    These may be marked optional, in which case the exercise does not count
858
 
    for marking purposes. The sequence number is used to order the worksheet
859
 
    ToC.
860
 
    """
861
 
 
862
 
    __storm_table__ = "worksheet_exercise"
863
 
 
864
 
    id = Int(primary=True, name="ws_ex_id")
 
467
    __storm_table__ = "worksheet_problem"
 
468
    __storm_primary__ = "worksheet_id", "exercise_id"
865
469
 
866
470
    worksheet_id = Int(name="worksheetid")
867
471
    worksheet = Reference(worksheet_id, Worksheet.id)
868
 
    exercise_id = Unicode(name="exerciseid")
 
472
    exercise_id = Int(name="problemid")
869
473
    exercise = Reference(exercise_id, Exercise.id)
870
474
    optional = Bool()
871
 
    active = Bool()
872
 
    seq_no = Int()
873
 
 
874
 
    saves = ReferenceSet(id, "ExerciseSave.ws_ex_id")
875
 
    attempts = ReferenceSet(id, "ExerciseAttempt.ws_ex_id")
876
475
 
877
476
    __init__ = _kwarg_init
878
477
 
879
478
    def __repr__(self):
880
479
        return "<%s %s in %s>" % (type(self).__name__, self.exercise.name,
881
 
                                  self.worksheet.identifier)
882
 
 
883
 
    def get_permissions(self, user):
884
 
        return self.worksheet.get_permissions(user)
885
 
 
 
480
                                  self.worksheet.name)
886
481
 
887
482
class ExerciseSave(Storm):
888
 
    """A potential exercise solution submitted by a user for storage.
889
 
 
890
 
    This is not an actual tested attempt at an exercise, it's just a save of
891
 
    the editing session.
892
 
    """
893
 
 
894
 
    __storm_table__ = "exercise_save"
895
 
    __storm_primary__ = "ws_ex_id", "user_id"
896
 
 
897
 
    ws_ex_id = Int(name="ws_ex_id")
898
 
    worksheet_exercise = Reference(ws_ex_id, "WorksheetExercise.id")
899
 
 
 
483
    """
 
484
    Represents a potential solution to an exercise that a user has submitted
 
485
    to the server for storage.
 
486
    A basic ExerciseSave is just the current saved text for this exercise for
 
487
    this user (doesn't count towards their attempts).
 
488
    ExerciseSave may be extended with additional semantics (such as
 
489
    ExerciseAttempt).
 
490
    """
 
491
    __storm_table__ = "problem_save"
 
492
    __storm_primary__ = "exercise_id", "user_id", "date"
 
493
 
 
494
    exercise_id = Int(name="problemid")
 
495
    exercise = Reference(exercise_id, Exercise.id)
900
496
    user_id = Int(name="loginid")
901
497
    user = Reference(user_id, User.id)
902
498
    date = DateTime()
909
505
            self.exercise.name, self.user.login, self.date.strftime("%c"))
910
506
 
911
507
class ExerciseAttempt(ExerciseSave):
912
 
    """An attempt at solving an exercise.
913
 
 
914
 
    This is a special case of ExerciseSave, used when the user submits a
915
 
    candidate solution. Like an ExerciseSave, it constitutes exercise solution
916
 
    data.
917
 
 
918
 
    In addition, it contains information about the result of the submission:
919
 
 
920
 
     - complete - True if this submission was successful, rendering this
921
 
                  exercise complete for this user in this worksheet.
922
 
     - active   - True if this submission is "active" (usually true).
923
 
                  Submissions may be de-activated by privileged users for
924
 
                  special reasons, and then they won't count (either as a
925
 
                  penalty or success), but will still be stored.
926
 
    """
927
 
 
928
 
    __storm_table__ = "exercise_attempt"
929
 
    __storm_primary__ = "ws_ex_id", "user_id", "date"
 
508
    """
 
509
    An ExerciseAttempt is a special case of an ExerciseSave. Like an
 
510
    ExerciseSave, it constitutes exercise solution data that the user has
 
511
    submitted to the server for storage.
 
512
    In addition, it contains additional information about the submission.
 
513
    complete - True if this submission was successful, rendering this exercise
 
514
        complete for this user.
 
515
    active - True if this submission is "active" (usually true). Submissions
 
516
        may be de-activated by privileged users for special reasons, and then
 
517
        they won't count (either as a penalty or success), but will still be
 
518
        stored.
 
519
    """
 
520
    __storm_table__ = "problem_attempt"
 
521
    __storm_primary__ = "exercise_id", "user_id", "date"
930
522
 
931
523
    # The "text" field is the same but has a different name in the DB table
932
524
    # for some reason.
936
528
 
937
529
    def get_permissions(self, user):
938
530
        return set(['view']) if user is self.user else set()
939
 
 
940
 
class TestSuite(Storm):
941
 
    """A container to group an exercise's test cases.
942
 
 
943
 
    The test suite contains some information on how to test. The function to
944
 
    test, variables to set and stdin data are stored here.
945
 
    """
946
 
 
947
 
    __storm_table__ = "test_suite"
948
 
    __storm_primary__ = "exercise_id", "suiteid"
949
 
 
950
 
    suiteid = Int()
951
 
    exercise_id = Unicode(name="exerciseid")
952
 
    description = Unicode()
953
 
    seq_no = Int()
954
 
    function = Unicode()
955
 
    stdin = Unicode()
956
 
    exercise = Reference(exercise_id, Exercise.id)
957
 
    test_cases = ReferenceSet(suiteid, 'TestCase.suiteid', order_by="seq_no")
958
 
    variables = ReferenceSet(suiteid, 'TestSuiteVar.suiteid', order_by='arg_no')
959
 
 
960
 
    def delete(self):
961
 
        """Delete this suite, without asking questions."""
962
 
        for vaariable in self.variables:
963
 
            variable.delete()
964
 
        for test_case in self.test_cases:
965
 
            test_case.delete()
966
 
        Store.of(self).remove(self)
967
 
 
968
 
class TestCase(Storm):
969
 
    """A container for actual tests (see TestCasePart), inside a test suite.
970
 
 
971
 
    It is the lowest level shown to students on their pass/fail status."""
972
 
 
973
 
    __storm_table__ = "test_case"
974
 
    __storm_primary__ = "testid", "suiteid"
975
 
 
976
 
    testid = Int()
977
 
    suiteid = Int()
978
 
    suite = Reference(suiteid, "TestSuite.suiteid")
979
 
    passmsg = Unicode()
980
 
    failmsg = Unicode()
981
 
    test_default = Unicode()
982
 
    seq_no = Int()
983
 
 
984
 
    parts = ReferenceSet(testid, "TestCasePart.testid")
985
 
 
986
 
    __init__ = _kwarg_init
987
 
 
988
 
    def delete(self):
989
 
        for part in self.parts:
990
 
            part.delete()
991
 
        Store.of(self).remove(self)
992
 
 
993
 
class TestSuiteVar(Storm):
994
 
    """A variable used by an exercise test suite.
995
 
 
996
 
    This may represent a function argument or a normal variable.
997
 
    """
998
 
 
999
 
    __storm_table__ = "suite_variable"
1000
 
    __storm_primary__ = "varid"
1001
 
 
1002
 
    varid = Int()
1003
 
    suiteid = Int()
1004
 
    var_name = Unicode()
1005
 
    var_value = Unicode()
1006
 
    var_type = Unicode()
1007
 
    arg_no = Int()
1008
 
 
1009
 
    suite = Reference(suiteid, "TestSuite.suiteid")
1010
 
 
1011
 
    __init__ = _kwarg_init
1012
 
 
1013
 
    def delete(self):
1014
 
        Store.of(self).remove(self)
1015
 
 
1016
 
class TestCasePart(Storm):
1017
 
    """An actual piece of code to test an exercise solution."""
1018
 
 
1019
 
    __storm_table__ = "test_case_part"
1020
 
    __storm_primary__ = "partid"
1021
 
 
1022
 
    partid = Int()
1023
 
    testid = Int()
1024
 
 
1025
 
    part_type = Unicode()
1026
 
    test_type = Unicode()
1027
 
    data = Unicode()
1028
 
    filename = Unicode()
1029
 
 
1030
 
    test = Reference(testid, "TestCase.testid")
1031
 
 
1032
 
    __init__ = _kwarg_init
1033
 
 
1034
 
    def delete(self):
1035
 
        Store.of(self).remove(self)