← Back to branch summary

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

« back to all changes in this revision

Viewing changes to lib/common/db.py

  • Committer: mattgiuca
  • Date: 2008-02-14 00:48:06 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:449
php/phpBB3/cache: Set svn:ignore on all the php files here, since they are
auto-generated.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/common/db.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2008 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Module: Database
 
19
# Author: Matt Giuca
 
20
# Date:   1/2/2008
 
21
 
 
22
# Code to talk to the PostgreSQL database.
 
23
# (This is the Data Access Layer).
 
24
# All DB code should be in this module to ensure portability if we want to
 
25
# change the DB implementation.
 
26
# This means no SQL strings should be outside of this module. Add functions
 
27
# here to perform the activities needed, and place the SQL code for those
 
28
# activities within.
 
29
 
 
30
# CAUTION to editors of this module.
 
31
# All string inputs must be sanitized by calling _escape before being
 
32
# formatted into an SQL query string.
 
33
 
 
34
import pg
 
35
import conf
 
36
import md5
 
37
 
 
38
def _escape(str):
 
39
    """Wrapper around pg.escape_string. Escapes the string for use in SQL, and
 
40
    also quotes it to make sure that every string used in a query is quoted.
 
41
    If str is None, returns "NULL", which is unescaped and thus a valid SQL
 
42
    value.
 
43
    """
 
44
    # "E'" is postgres's way of making "escape" strings.
 
45
    # Such strings allow backslashes to escape things. Since escape_string
 
46
    # converts a single backslash into two backslashes, it needs to be fed
 
47
    # into E mode.
 
48
    # Ref: http://www.postgresql.org/docs/8.2/static/sql-syntax-lexical.html
 
49
    # WARNING: PostgreSQL-specific code
 
50
    if str is None:
 
51
        return "NULL"
 
52
    return "E'" + pg.escape_string(str) + "'"
 
53
 
 
54
def _passhash(password):
 
55
    return md5.md5(password).hexdigest()
 
56
 
 
57
class DBException(Exception):
 
58
    """A DBException is for bad conditions in the database or bad input to
 
59
    these methods. If Postgres throws an exception it does not get rebadged.
 
60
    This is only for additional exceptions."""
 
61
    pass
 
62
 
 
63
class DB:
 
64
    """An IVLE database object. This object provides an interface to
 
65
    interacting with the IVLE database without using any external SQL.
 
66
 
 
67
    Most methods of this class have an optional dry argument. If true, they
 
68
    will return the SQL query string and NOT actually execute it. (For
 
69
    debugging purposes).
 
70
 
 
71
    Methods may throw db.DBException, or any of the pg exceptions as well.
 
72
    (In general, be prepared to catch exceptions!)
 
73
    """
 
74
    def __init__(self):
 
75
        """Connects to the database and creates a DB object.
 
76
        Takes no parameters - gets all the DB info from the configuration."""
 
77
        self.db = pg.connect(dbname=conf.db_dbname, host=conf.db_host,
 
78
                port=conf.db_port, user=conf.db_user, passwd=conf.db_password)
 
79
 
 
80
    # USER MANAGEMENT FUNCTIONS #
 
81
 
 
82
    def create_user(self, login, unixid, password, nick, fullname, rolenm,
 
83
        studentid, dry=False):
 
84
        """Creates a user login entry in the database.
 
85
        Arguments are the same as those in the "login" table of the schema.
 
86
        The exception is "password", which is a cleartext password. makeuser
 
87
        will hash the password.
 
88
        Raises an exception if the user already exists.
 
89
        """
 
90
        passhash = _passhash(password)
 
91
        query = ("INSERT INTO login (login, unixid, passhash, nick, fullname,"
 
92
            " rolenm, studentid) VALUES (%s, %d, %s, %s, %s, %s, %s);" %
 
93
            (_escape(login), unixid, _escape(passhash), _escape(nick),
 
94
            _escape(fullname), _escape(rolenm), _escape(studentid)))
 
95
        if dry: return query
 
96
        self.db.query(query)
 
97
 
 
98
    def update_user(self, login, password=None, nick=None,
 
99
        fullname=None, rolenm=None, dry=False):
 
100
        """Updates fields of a particular user. login is the name of the user
 
101
        to update. The other arguments are optional fields which may be
 
102
        modified. If None or omitted, they do not get modified. login and
 
103
        studentid may not be modified.
 
104
 
 
105
        Note that no checking is done. It is expected this function is called
 
106
        by a trusted source. In particular, it allows the password to be
 
107
        changed without knowing the old password. The caller should check
 
108
        that the user knows the existing password before calling this function
 
109
        with a new one.
 
110
        """
 
111
        # Make a list of SQL fragments of the form "field = 'new value'"
 
112
        # These fragments are ALREADY-ESCAPED
 
113
        setlist = []
 
114
        if password is not None:
 
115
            setlist.append("passhash = " + _escape(_passhash(password)))
 
116
        if nick is not None:
 
117
            setlist.append("nick = " + _escape(nick))
 
118
        if fullname is not None:
 
119
            setlist.append("fullname = " + _escape(fullname))
 
120
        if rolenm is not None:
 
121
            setlist.append("rolenm = " + _escape(rolenm))
 
122
        if len(setlist) == 0:
 
123
            return
 
124
        # Join the fragments into a comma-separated string
 
125
        setstring = ', '.join(setlist)
 
126
        # Build the whole query as an UPDATE statement
 
127
        query = ("UPDATE login SET %s WHERE login = %s;"
 
128
            % (setstring, _escape(login)))
 
129
        if dry: return query
 
130
        self.db.query(query)
 
131
 
 
132
    def delete_user(self, login, dry=False):
 
133
        """Deletes a user login entry from the database."""
 
134
        query = "DELETE FROM login WHERE login = %s;" % _escape(login)
 
135
        if dry: return query
 
136
        self.db.query(query)
 
137
 
 
138
    def get_user(self, login, dry=False):
 
139
        """Given a login, returns a dictionary of the user's DB fields,
 
140
        excluding the passhash field.
 
141
 
 
142
        Raises a DBException if the login is not found in the DB.
 
143
        """
 
144
        query = ("SELECT login, unixid, nick, fullname, rolenm, studentid "
 
145
            "FROM login WHERE login = %s;" % _escape(login))
 
146
        if dry: return query
 
147
        result = self.db.query(query)
 
148
        # Expecting exactly one
 
149
        if result.ntuples() != 1:
 
150
            # It should not be possible for ntuples to be greater than 1
 
151
            assert (result.ntuples() < 1)
 
152
            raise DBException("get_user: No user with that login name")
 
153
        # Return as a dictionary
 
154
        return result.dictresult()[0]
 
155
 
 
156
    def get_users(self, dry=False):
 
157
        """Returns a list of all users. The list elements are a dictionary of
 
158
        the user's DB fields, excluding the passhash field.
 
159
        """
 
160
        query = ("SELECT login, unixid, nick, fullname, rolenm, studentid "
 
161
            "FROM login")
 
162
        if dry: return query
 
163
        return self.db.query(query).dictresult()
 
164
 
 
165
    def user_authenticate(self, login, password, dry=False):
 
166
        """Performs a password authentication on a user. Returns True if
 
167
        "password" is the correct password for the given login, False
 
168
        otherwise. "password" is cleartext.
 
169
        Also returns False if the login does not exist (so if you want to
 
170
        differentiate these cases, use get_user and catch an exception).
 
171
        """
 
172
        query = ("SELECT login FROM login "
 
173
            "WHERE login = '%s' AND passhash = %s;"
 
174
            % (login, _escape(_passhash(password))))
 
175
        if dry: return query
 
176
        result = self.db.query(query)
 
177
        # If one row was returned, succeed.
 
178
        # Otherwise, fail to authenticate.
 
179
        return result.ntuples() == 1
 
180
 
 
181
    def close(self):
 
182
        """Close the DB connection. Do not call any other functions after
 
183
        this. (The behaviour of doing so is undefined).
 
184
        """
 
185
        self.db.close()