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
|
# 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.
"""
from storm.locals import create_database, Store, Int, Unicode, DateTime, \
Reference
import ivle.conf
import ivle.caps
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(object):
"""
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)
def __init__(self, **kwargs):
"""
Create a new User object. Supply any columns as a keyword argument.
"""
for k,v in kwargs.items():
if k.startswith('_') or not hasattr(self, k):
raise TypeError("User got an unexpected keyword argument '%s'"
% k)
setattr(self, k, v)
def __repr__(self):
return "<%s '%s'>" % (type(self).__name__, self.login)
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)
# XXX Should be @property
def pass_expired(self):
"""Determines whether the pass_exp field indicates that
login should be denied.
"""
fieldval = self.pass_exp
return fieldval is not None and time.localtime() > fieldval
# XXX Should be @property
def acct_expired(self):
"""Determines whether the acct_exp field indicates that
login should be denied.
"""
fieldval = self.acct_exp
return fieldval is not None and time.localtime() > fieldval
@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()
|