← Back to branch summary

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

« back to all changes in this revision

Viewing changes to www/common/db.py

  • Committer: mattgiuca
  • Date: 2008-02-05 01:41:15 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:409
Moved www/conf and www/common to a new directory lib. This separates the "web"
part of IVLE from what is becoming less web oriented (at least from Apache's
standpoint).
Modified setup.py to install this lib directory correctly and write conf in
the right place. Also adds the lib directory to ivle.pth.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/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
 
    """
42
 
    # "E'" is postgres's way of making "escape" strings.
43
 
    # Such strings allow backslashes to escape things. Since escape_string
44
 
    # converts a single backslash into two backslashes, it needs to be fed
45
 
    # into E mode.
46
 
    # Ref: http://www.postgresql.org/docs/8.2/static/sql-syntax-lexical.html
47
 
    # WARNING: PostgreSQL-specific code
48
 
    return "E'" + pg.escape_string(str) + "'"
49
 
 
50
 
def _passhash(password):
51
 
    return md5.md5(password).hexdigest()
52
 
 
53
 
class DBException(Exception):
54
 
    """A DBException is for bad conditions in the database or bad input to
55
 
    these methods. If Postgres throws an exception it does not get rebadged.
56
 
    This is only for additional exceptions."""
57
 
    pass
58
 
 
59
 
class DB:
60
 
    """An IVLE database object. This object provides an interface to
61
 
    interacting with the IVLE database without using any external SQL.
62
 
 
63
 
    Most methods of this class have an optional dry argument. If true, they
64
 
    will return the SQL query string and NOT actually execute it. (For
65
 
    debugging purposes).
66
 
 
67
 
    Methods may throw db.DBException, or any of the pg exceptions as well.
68
 
    (In general, be prepared to catch exceptions!)
69
 
    """
70
 
    def __init__(self):
71
 
        """Connects to the database and creates a DB object.
72
 
        Takes no parameters - gets all the DB info from the configuration."""
73
 
        self.db = pg.connect(dbname=conf.db_dbname, host=conf.db_host,
74
 
                port=conf.db_port, user=conf.db_user, passwd=conf.db_password)
75
 
 
76
 
    # USER MANAGEMENT FUNCTIONS #
77
 
 
78
 
    def create_user(self, login, password, nick, fullname, rolenm, studentid,
79
 
        dry=False):
80
 
        """Creates a user login entry in the database.
81
 
        Arguments are the same as those in the "login" table of the schema.
82
 
        The exception is "password", which is a cleartext password. makeuser
83
 
        will hash the password.
84
 
        Raises an exception if the user already exists.
85
 
        """
86
 
        passhash = _passhash(password)
87
 
        query = ("INSERT INTO login (login, passhash, nick, fullname, "
88
 
            "rolenm, studentid) VALUES (%s, %s, %s, %s, %s, %s);" %
89
 
            (_escape(login), _escape(passhash), _escape(nick),
90
 
            _escape(fullname), _escape(rolenm), _escape(studentid)))
91
 
        if dry: return query
92
 
        self.db.query(query)
93
 
 
94
 
    def update_user(self, login, password=None, nick=None,
95
 
        fullname=None, rolenm=None, dry=False):
96
 
        """Updates fields of a particular user. login is the name of the user
97
 
        to update. The other arguments are optional fields which may be
98
 
        modified. If None or omitted, they do not get modified. login and
99
 
        studentid may not be modified.
100
 
 
101
 
        Note that no checking is done. It is expected this function is called
102
 
        by a trusted source. In particular, it allows the password to be
103
 
        changed without knowing the old password. The caller should check
104
 
        that the user knows the existing password before calling this function
105
 
        with a new one.
106
 
        """
107
 
        # Make a list of SQL fragments of the form "field = 'new value'"
108
 
        # These fragments are ALREADY-ESCAPED
109
 
        setlist = []
110
 
        if password is not None:
111
 
            setlist.append("passhash = " + _escape(_passhash(password)))
112
 
        if nick is not None:
113
 
            setlist.append("nick = " + _escape(nick))
114
 
        if fullname is not None:
115
 
            setlist.append("fullname = " + _escape(fullname))
116
 
        if rolenm is not None:
117
 
            setlist.append("rolenm = " + _escape(rolenm))
118
 
        if len(setlist) == 0:
119
 
            return
120
 
        # Join the fragments into a comma-separated string
121
 
        setstring = ', '.join(setlist)
122
 
        # Build the whole query as an UPDATE statement
123
 
        query = ("UPDATE login SET %s WHERE login = %s;"
124
 
            % (setstring, _escape(login)))
125
 
        if dry: return query
126
 
        self.db.query(query)
127
 
 
128
 
    def delete_user(self, login, dry=False):
129
 
        """Deletes a user login entry from the database."""
130
 
        query = "DELETE FROM login WHERE login = %s;" % _escape(login)
131
 
        if dry: return query
132
 
        self.db.query(query)
133
 
 
134
 
    def get_user(self, login, dry=False):
135
 
        """Given a login, returns a dictionary of the user's DB fields,
136
 
        excluding the passhash field.
137
 
 
138
 
        Raises a DBException if the login is not found in the DB.
139
 
        """
140
 
        query = ("SELECT login, nick, fullname, rolenm, studentid FROM login "
141
 
            "WHERE login = %s;" % _escape(login))
142
 
        if dry: return query
143
 
        result = self.db.query(query)
144
 
        # Expecting exactly one
145
 
        if result.ntuples() != 1:
146
 
            # It should not be possible for ntuples to be greater than 1
147
 
            assert (result.ntuples() < 1)
148
 
            raise DBException("get_user: No user with that login name")
149
 
        # Return as a dictionary
150
 
        return result.dictresult()[0]
151
 
 
152
 
    def user_authenticate(self, login, password, dry=False):
153
 
        """Performs a password authentication on a user. Returns True if
154
 
        "password" is the correct password for the given login, False
155
 
        otherwise. "password" is cleartext.
156
 
        Also returns False if the login does not exist (so if you want to
157
 
        differentiate these cases, use get_user and catch an exception).
158
 
        """
159
 
        query = ("SELECT login FROM login "
160
 
            "WHERE login = '%s' AND passhash = %s;"
161
 
            % (login, _escape(_passhash(password))))
162
 
        if dry: return query
163
 
        result = self.db.query(query)
164
 
        # If one row was returned, succeed.
165
 
        # Otherwise, fail to authenticate.
166
 
        return result.ntuples() == 1
167
 
 
168
 
    def close(self):
169
 
        """Close the DB connection. Do not call any other functions after
170
 
        this. (The behaviour of doing so is undefined).
171
 
        """
172
 
        self.db.close()