1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
# IVLE - Informatics Virtual Learning Environment
# Copyright (C) 2007-2009 The University of Melbourne
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# Author: Matt Giuca, Will Grant
"""
Database Classes and Utilities for Storm ORM
This module provides all of the classes which map to database tables.
It also provides miscellaneous utility functions for database interaction.
"""
import md5
import datetime
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
Reference, ReferenceSet, Bool, Storm, Desc
import ivle.conf
import ivle.caps
def _kwarg_init(self, **kwargs):
for k,v in kwargs.items():
if k.startswith('_') or not hasattr(self, k):
raise TypeError("%s got an unexpected keyword argument '%s'"
% self.__class__.__name__, k)
setattr(self, k, v)
def get_conn_string():
"""
Returns the Storm connection string, generated from the conf file.
"""
return "postgres://%s:%s@%s:%d/%s" % (ivle.conf.db_user,
ivle.conf.db_password, ivle.conf.db_host, ivle.conf.db_port,
ivle.conf.db_dbname)
def get_store():
"""
Open a database connection and transaction. Return a storm.store.Store
instance connected to the configured IVLE database.
"""
return Store(create_database(get_conn_string()))
class User(Storm):
"""
Represents an IVLE user.
"""
__storm_table__ = "login"
id = Int(primary=True, name="loginid")
login = Unicode()
passhash = Unicode()
state = Unicode()
rolenm = Unicode()
unixid = Int()
nick = Unicode()
pass_exp = DateTime()
acct_exp = DateTime()
last_login = DateTime()
svn_pass = Unicode()
email = Unicode()
fullname = Unicode()
studentid = Unicode()
settings = Unicode()
def _get_role(self):
if self.rolenm is None:
return None
return ivle.caps.Role(self.rolenm)
def _set_role(self, value):
if not isinstance(value, ivle.caps.Role):
raise TypeError("role must be an ivle.caps.Role")
self.rolenm = unicode(value)
role = property(_get_role, _set_role)
__init__ = _kwarg_init
def __repr__(self):
return "<%s '%s'>" % (type(self).__name__, self.login)
def authenticate(self, password):
"""Validate a given password against this user.
Returns True if the given password matches the password hash for this
User, False if it doesn't match, and None if there is no hash for the
user.
"""
if self.passhash is None:
return None
return self.hash_password(password) == self.passhash
def hasCap(self, capability):
"""Given a capability (which is a Role object), returns True if this
User has that capability, False otherwise.
"""
return self.role.hasCap(capability)
@property
def password_expired(self):
fieldval = self.pass_exp
return fieldval is not None and datetime.datetime.now() > fieldval
@property
def account_expired(self):
fieldval = self.acct_exp
return fieldval is not None and datetime.datetime.now() > fieldval
def _get_enrolments(self, justactive):
return Store.of(self).find(Enrolment,
Enrolment.user_id == self.id,
(Enrolment.active == True) if justactive else True,
Enrolment.offering_id == Offering.id,
Offering.semester_id == Semester.id,
Offering.subject_id == Subject.id).order_by(
Desc(Semester.year),
Desc(Semester.semester),
Desc(Subject.code)
)
@property
def subjects(self):
return Store.of(self).find(Subject,
Enrolment.user_id == self.id,
Enrolment.active == True,
Offering.id == Enrolment.offering_id,
Subject.id == Offering.subject_id).config(distinct=True)
@property
def active_enrolments(self):
'''A sanely ordered list of the user's active enrolments.'''
return self._get_enrolments(True)
@property
def enrolments(self):
'''A sanely ordered list of all of the user's enrolments.'''
return self._get_enrolments(False)
@staticmethod
def hash_password(password):
return md5.md5(password).hexdigest()
@classmethod
def get_by_login(cls, store, login):
"""
Get the User from the db associated with a given store and
login.
"""
return store.find(cls, cls.login == unicode(login)).one()
class Subject(Storm):
__storm_table__ = "subject"
id = Int(primary=True, name="subjectid")
code = Unicode(name="subj_code")
name = Unicode(name="subj_name")
short_name = Unicode(name="subj_short_name")
url = Unicode()
offerings = ReferenceSet(id, 'Offering.subject_id')
__init__ = _kwarg_init
def __repr__(self):
return "<%s '%s'>" % (type(self).__name__, self.short_name)
class Semester(Storm):
__storm_table__ = "semester"
id = Int(primary=True, name="semesterid")
year = Unicode()
semester = Unicode()
active = Bool()
offerings = ReferenceSet(id, 'Offering.semester_id')
__init__ = _kwarg_init
def __repr__(self):
return "<%s %s/%s>" % (type(self).__name__, self.year, self.semester)
class Offering(Storm):
__storm_table__ = "offering"
id = Int(primary=True, name="offeringid")
subject_id = Int(name="subject")
subject = Reference(subject_id, Subject.id)
semester_id = Int(name="semesterid")
semester = Reference(semester_id, Semester.id)
groups_student_permissions = Unicode()
enrolments = ReferenceSet(id, 'Enrolment.offering_id')
__init__ = _kwarg_init
def __repr__(self):
return "<%s %r in %r>" % (type(self).__name__, self.subject,
self.semester)
class Enrolment(Storm):
__storm_table__ = "enrolment"
__storm_primary__ = "user_id", "offering_id"
user_id = Int(name="loginid")
user = Reference(user_id, User.id)
offering_id = Int(name="offeringid")
offering = Reference(offering_id, Offering.id)
notes = Unicode()
active = Bool()
__init__ = _kwarg_init
def __repr__(self):
return "<%s %r in %r>" % (type(self).__name__, self.user,
self.offering)
|