source: trunk/lib/DB.inc.php @ 9

Last change on this file since 9 was 9, checked in by scdev, 19 years ago

updated DB.inc.php so SET NAMES query is only used on MySQL versions > 4.1
File size: 11.3 KB
Line 
1<?php
2/**
3 * DB.inc.php
4 * code by strangecode :: www.strangecode.com :: this document contains copyrighted information
5 *
6 * DB abstraction layer.
7 *
8 * @author  Quinn Comendant <quinn@strangecode.com>
9 * @version 1.0
10 */
11 
12class DB {
13
14    // If DB::connect has successfully opened a db connection.
15    var $_connected = false;
16
17    // Database handler.
18    var $dbh;
19
20    // Hash of DB parameters.
21    var $_params = array();
22
23    // Default parameters.
24    var $_param_defaults = array(
25
26        // DB passwords should be set as apache environment variables in httpd.conf, readable only by root.
27        'db_server' => 'localhost',
28        'db_name' => null,
29        'db_user' => null,
30        'db_pass' => null,
31
32        // Debugging.
33        'db_always_debug' => false, // TRUE = display all SQL queries.
34        'db_debug' => false, // TRUE = display db errors.
35        'db_die_on_failure' => false, // TRUE = script stops on db error.
36    );
37   
38    // Translate between HTML and MySQL character set names.
39    var $mysql_character_sets = array(
40        'utf-8' => 'utf8',
41        'iso-8859-1' => 'latin1',
42    );
43   
44    // Caches.
45    var $existing_tables;
46    var $table_columns;
47   
48    /**
49     * This method enforces the singleton pattern for this class.
50     *
51     * @return  object  Reference to the global SessionCache object.
52     * @access  public
53     * @static
54     */
55    function &getInstance()
56    {
57        static $instance = null;
58
59        if ($instance === null) {
60            $instance = new DB();
61        }
62
63        return $instance;
64    }
65   
66    /**
67     * Constructor.
68     */
69    function DB()
70    {
71        // Initialize default params.
72        if (isset($params) && is_array($params)) {
73            // Merge new parameters with old overriding only those passed.
74            $this->_params = array_merge($this->_params, $params);
75        }
76    }
77
78    /**
79     * Set (or overwrite existing) parameters by passing an array of new parameters.
80     *
81     * @access public
82     *
83     * @param  array    $params     Array of parameters (key => val pairs).
84     */
85    function setParam($params)
86    {
87        if (!isset($this) || !is_a($this, 'DB')) {
88            $this =& DB::getInstance();
89        }
90
91        if (isset($params) && is_array($params)) {
92            // Merge new parameters with old overriding only those passed.
93            $this->_params = array_merge($this->_params, $params);
94        } else {
95            App::logMsg(sprintf('Parameters are not an array: %s', $params), LOG_ERR, __FILE__, __LINE__);
96        }
97    }
98
99    /**
100     * Return the value of a parameter.
101     *
102     * @access  public
103     *
104     * @param   string  $param      The key of the parameter to return.
105     *
106     * @return  mixed               Parameter value.
107     */
108    function getParam($param)
109    {
110        if (!isset($this) || !is_a($this, 'DB')) {
111            $this =& DB::getInstance();
112        }
113
114        if (isset($this->_params[$param])) {
115            return $this->_params[$param];
116        } else {
117            App::logMsg(sprintf('Parameter is not set: %s', $param), LOG_DEBUG, __FILE__, __LINE__);
118            return null;
119        }
120    }
121   
122    /**
123     * Connect to database with credentials in params.
124     *
125     * @access  public
126     * @author  Quinn Comendant <quinn@strangecode.com>
127     * @since   28 Aug 2005 14:02:49
128     */
129    function connect()
130    {
131        if (!isset($this) || !is_a($this, 'DB')) {
132            $this =& DB::getInstance();
133        }
134       
135        if (!$this->getParam('db_name') || !$this->getParam('db_user') || !$this->getParam('db_pass')) {
136            App::logMsg('Database credentials missing.', LOG_EMERG, __FILE__, __LINE__);
137            return false;
138        }
139       
140        // Connect to database. Always create a new link to the server.
141        if ($this->dbh = mysql_connect($this->getParam('db_server'), $this->getParam('db_user'), $this->getParam('db_pass'), true)) {   
142            // Select database
143            mysql_select_db($this->getParam('db_name'), $this->dbh);
144        }
145       
146        // Connection errors.
147        if (!$this->dbh || mysql_error($this->dbh)) {
148            $mysql_error_msg = $this->dbh ? 'Codebase MySQL error: (' . mysql_errno($this->dbh) . ') ' . mysql_error($this->dbh) : 'Codebase MySQL error: Could not connect to server.';
149            if ($this->getParam('db_debug')) {
150                echo $mysql_error_msg . "\n";
151            } else {
152                echo _("This page is temporarily unavailable. It should be back up in a few minutes.");
153            }
154            App::logMsg($mysql_error_msg, LOG_EMERG, __FILE__, __LINE__);
155            echo "\n\n<!-- Script execution stopped out of embarrassment. -->";
156            die;
157        }
158       
159        // DB connection success!
160        $this->_connected = true;
161
162        // Tell MySQL what character set we're useing.
163        if (preg_match('/^4\.[1-9].*$|^5.*$/', mysql_get_server_info())) {
164            $this->query("SET NAMES '" . $this->mysql_character_sets[strtolower(App::getParam('character_set'))] . "'");
165        }
166       
167        return true;
168    }
169   
170    /**
171     * Close db connection.
172     *
173     * @access  public
174     * @author  Quinn Comendant <quinn@strangecode.com>
175     * @since   28 Aug 2005 14:32:01
176     */
177    function close()
178    {
179        if (!isset($this) || !is_a($this, 'DB')) {
180            $this =& DB::getInstance();
181        }
182       
183        if (!$this->_connected) {
184            return false;
185        }
186
187        mysql_close($this->dbh);       
188    }
189   
190    /**
191     * Return the current database handler.
192     *
193     * @access  public
194     * @return  resource Current value of $this->dbh.
195     * @author  Quinn Comendant <quinn@strangecode.com>
196     * @since   20 Aug 2005 13:50:36
197     */
198    function getDBH()
199    {
200        if (!isset($this) || !is_a($this, 'DB')) {
201            $this =& DB::getInstance();
202        }
203       
204        if (!$this->_connected) {
205            return false;
206        }
207
208        return $this->dbh;
209    }
210   
211    /**
212     * Returns connection status
213     *
214     * @access  public
215     * @author  Quinn Comendant <quinn@strangecode.com>
216     * @since   28 Aug 2005 14:58:09
217     */
218    function isConnected()
219    {
220        return $this->_connected;
221    }
222   
223    /**
224     * A wrapper for mysql_query. Allows us to set the database link_identifier,
225     * to trap errors and ease debugging.
226     *
227     * @param  string  $query   The SQL query to execute
228     * @param  bool    $debug   If true, prints debugging info
229     * @return resource         Query identifier
230     */
231    function query($query, $debug=false)
232    {
233        static $_query_count = 0;
234       
235        if (!isset($this) || !is_a($this, 'DB')) {
236            $this =& DB::getInstance();
237        }
238       
239        if (!$this->_connected) {
240           return false;
241        }
242
243        $_query_count++;
244        $debugqry = preg_replace("/\n[\t ]+/", "\n", $query);
245        if ($this->getParam('db_always_debug') || $debug) {
246            echo "<!-- ----------------- Query $_query_count ---------------------\n$debugqry\n-->\n";
247        }
248       
249        // Execute!
250        $qid = mysql_query($query, $this->dbh);
251   
252        // Error checking.
253        if (!$qid || mysql_error($this->dbh)) {
254            if ($this->getParam('db_debug')) {
255                echo '<pre style="padding:2em; background:#ddd; font:9px monaco;">' . wordwrap(mysql_error($this->dbh)) . '<hr>' . htmlspecialchars($debugqry) . '</pre>';
256            } else {
257                echo _("This page is temporarily unavailable. It should be back up in a few minutes.");
258            }
259            App::logMsg(sprintf('MySQL error %s: %s in query: %s', mysql_errno($this->dbh), mysql_error($this->dbh), $debugqry), LOG_EMERG, __FILE__, __LINE__);
260            if ($this->getParam('db_die_on_failure')) {
261                echo "\n\n<!-- Script execution stopped out of embarrassment. -->";
262                die;
263            }
264        }
265   
266        return $qid;
267    }
268
269    /**
270     * Loads a list of tables in the current database into an array, and returns
271     * true if the requested table is found. Use this function to enable/disable
272     * funtionality based upon the current available db tables or to dynamically
273     * create tables if missing.
274     *
275     * @param  string $table    The name of the table to search.
276     * @param  bool   $strict   Get fresh table info (in case DB changed).
277     * @return bool    true if given $table exists.
278     */
279    function tableExists($table, $use_cached_results=true)
280    {   
281        if (!isset($this) || !is_a($this, 'DB')) {
282            $this =& DB::getInstance();
283        }
284       
285        if (!$this->_connected) {
286            return false;
287        }
288
289        if (!isset($this->existing_tables) || !$use_cached_results) {
290            $this->existing_tables = array();
291            $qid = $this->query("SHOW TABLES");
292            while (list($row) = mysql_fetch_row($qid)) {
293                $this->existing_tables[] = $row;
294            }
295        }
296        if (in_array($table, $this->existing_tables)) {
297            return true;
298        } else {
299            App::logMsg(sprintf('nonexistent DB table: %s.%s', $this->getParam('db_name'), $table), LOG_ALERT, __FILE__, __LINE__);
300            return false;
301        }
302    }
303   
304    /**
305     * Tests if the given array of columns exists in the specified table.
306     *
307     * @param  string $table    The name of the table to search.
308     * @param  array  $columns  An array of column names.
309     * @param  bool   $strict   Exact schema match, or are additional fields in the table okay?
310     * @param  bool   $strict   Get fresh table info (in case DB changed).
311     * @return bool    true if given $table exists.
312     */
313    function columnExists($table, $columns, $strict=true, $use_cached_results=true)
314    {   
315        if (!isset($this) || !is_a($this, 'DB')) {
316            $this =& DB::getInstance();
317        }
318       
319        if (!$this->_connected) {
320            return false;
321        }
322
323        // Ensure the table exists.
324        if (!$this->tableExists($table, $use_cached_results)) {
325            return false;
326        }
327       
328        // For single-value columns.
329        if (!is_array($columns)) {
330            $columns = array($columns);
331        }
332       
333        if (!isset($this->table_columns[$table]) || !$use_cached_results) {
334            // Populate and cache array of current columns for this table.
335            $this->table_columns[$table] = array();
336            $qid = $this->query("DESCRIBE $table");
337            while ($row = mysql_fetch_row($qid)) {
338                $this->table_columns[$table][] = $row[0];
339            }
340        }
341   
342        if ($strict) {
343            // Do an exact comparison of table schemas.
344            sort($columns);
345            sort($this->table_columns[$table]);
346            return $this->table_columns[$table] == $columns;
347        } else {
348            // Only check that the specified columns are available in the table.
349            $match_columns = array_intersect($this->table_columns[$table], $columns);
350            sort($columns);
351            sort($match_columns);
352            return $match_columns == $columns;
353        }
354    }
355   
356    /**
357     * Reset cached items.
358     *
359     * @access  public
360     * @author  Quinn Comendant <quinn@strangecode.com>
361     * @since   28 Aug 2005 22:10:50
362     */
363    function resetCache()
364    {
365        $this->existing_tables = null;
366        $this->table_columns = null;
367    }
368   
369} // End.
370
371?>
Note: See TracBrowser for help on using the repository browser.