mysql.php

Aller à la documentation de ce fichier.

<?php
/**
 * @package     Joomla.Platform
 * @subpackage  Database
 *
 * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die;

/**
 * MySQL database driver
 *
 * @package     Joomla.Platform
 * @subpackage  Database
 * @see         http://dev.mysql.com/doc/
 * @since       12.1
 */
class JDatabaseDriverMysql extends JDatabaseDriverMysqli
{
        /**
         * The name of the database driver.
         *
         * @var    string
         * @since  12.1
         */
        public $name = 'mysql';

        /**
         * Constructor.
         *
         * @param   array  $options  Array of database options with keys: host, user, password, database, select.
         *
         * @since   12.1
         */
        public function __construct($options)
        {
                // Get some basic values from the options.
                $options['host'] = (isset($options['host'])) ? $options['host'] : 'localhost';
                $options['user'] = (isset($options['user'])) ? $options['user'] : 'root';
                $options['password'] = (isset($options['password'])) ? $options['password'] : '';
                $options['database'] = (isset($options['database'])) ? $options['database'] : '';
                $options['select'] = (isset($options['select'])) ? (bool) $options['select'] : true;

                // Finalize initialisation.
                parent::__construct($options);
        }

        /**
         * Destructor.
         *
         * @since   12.1
         */
        public function __destruct()
        {
                $this->disconnect();
        }

        /**
         * Connects to the database if needed.
         *
         * @return  void  Returns void if the database connected successfully.
         *
         * @since   12.1
         * @throws  RuntimeException
         */
        public function connect()
        {
                if ($this->connection)
                {
                        return;
                }

                // Make sure the MySQL extension for PHP is installed and enabled.
                if (!function_exists('mysql_connect'))
                {
                        throw new RuntimeException('Could not connect to MySQL.');
                }

                // Attempt to connect to the server.
                if (!($this->connection = @ mysql_connect($this->options['host'], $this->options['user'], $this->options['password'], true)))
                {
                        throw new RuntimeException('Could not connect to MySQL.');
                }

                // Set sql_mode to non_strict mode
                mysql_query("SET @@SESSION.sql_mode = '';", $this->connection);

                // If auto-select is enabled select the given database.
                if ($this->options['select'] && !empty($this->options['database']))
                {
                        $this->select($this->options['database']);
                }

                // Set charactersets (needed for MySQL 4.1.2+).
                $this->setUTF();

                // Turn MySQL profiling ON in debug mode:
                if ($this->debug && $this->hasProfiling())
                {
                        mysql_query("SET profiling = 1;", $this->connection);
                }
        }

        /**
         * Disconnects the database.
         *
         * @return  void
         *
         * @since   12.1
         */
        public function disconnect()
        {
                // Close the connection.
                if (is_resource($this->connection))
                {
                        foreach ($this->disconnectHandlers as $h)
                        {
                                call_user_func_array($h, array( &$this));
                        }

                        mysql_close($this->connection);
                }

                $this->connection = null;
        }

        /**
         * Method to escape a string for usage in an SQL statement.
         *
         * @param   string   $text   The string to be escaped.
         * @param   boolean  $extra  Optional parameter to provide extra escaping.
         *
         * @return  string  The escaped string.
         *
         * @since   12.1
         */
        public function escape($text, $extra = false)
        {
                $this->connect();

                $result = mysql_real_escape_string($text, $this->getConnection());

                if ($extra)
                {
                        $result = addcslashes($result, '%_');
                }

                return $result;
        }

        /**
         * Test to see if the MySQL connector is available.
         *
         * @return  boolean  True on success, false otherwise.
         *
         * @since   12.1
         */
        public static function isSupported()
        {
                return (function_exists('mysql_connect'));
        }

        /**
         * Determines if the connection to the server is active.
         *
         * @return  boolean  True if connected to the database engine.
         *
         * @since   12.1
         */
        public function connected()
        {
                if (is_resource($this->connection))
                {
                        return @mysql_ping($this->connection);
                }

                return false;
        }

        /**
         * Get the number of affected rows for the previous executed SQL statement.
         *
         * @return  integer  The number of affected rows.
         *
         * @since   12.1
         */
        public function getAffectedRows()
        {
                $this->connect();

                return mysql_affected_rows($this->connection);
        }

        /**
         * Get the number of returned rows for the previous executed SQL statement.
         *
         * @param   resource  $cursor  An optional database cursor resource to extract the row count from.
         *
         * @return  integer   The number of returned rows.
         *
         * @since   12.1
         */
        public function getNumRows($cursor = null)
        {
                $this->connect();

                return mysql_num_rows($cursor ? $cursor : $this->cursor);
        }

        /**
         * Get the version of the database connector.
         *
         * @return  string  The database connector version.
         *
         * @since   12.1
         */
        public function getVersion()
        {
                $this->connect();

                return mysql_get_server_info($this->connection);
        }

        /**
         * Method to get the auto-incremented value from the last INSERT statement.
         *
         * @return  integer  The value of the auto-increment field from the last inserted row.
         *
         * @since   12.1
         */
        public function insertid()
        {
                $this->connect();

                return mysql_insert_id($this->connection);
        }

        /**
         * Execute the SQL statement.
         *
         * @return  mixed  A database cursor resource on success, boolean false on failure.
         *
         * @since   12.1
         * @throws  RuntimeException
         */
        public function execute()
        {
                $this->connect();

                if (!is_resource($this->connection))
                {
                        JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED', $this->errorNum, $this->errorMsg), JLog::ERROR, 'database');
                        throw new RuntimeException($this->errorMsg, $this->errorNum);
                }

                // Take a local copy so that we don't modify the original query and cause issues later
                $query = $this->replacePrefix((string) $this->sql);

                if (!($this->sql instanceof JDatabaseQuery) && ($this->limit > 0 || $this->offset > 0))
                {
                        $query .= ' LIMIT ' . $this->offset . ', ' . $this->limit;
                }

                // Increment the query counter.
                $this->count++;

                // Reset the error values.
                $this->errorNum = 0;
                $this->errorMsg = '';

                // If debugging is enabled then let's log the query.
                if ($this->debug)
                {
                        // Add the query to the object queue.
                        $this->log[] = $query;

                        JLog::add($query, JLog::DEBUG, 'databasequery');

                        $this->timings[] = microtime(true);
                }

                // Execute the query. Error suppression is used here to prevent warnings/notices that the connection has been lost.
                $this->cursor = @mysql_query($query, $this->connection);

                if ($this->debug)
                {
                        $this->timings[] = microtime(true);

                        if (defined('DEBUG_BACKTRACE_IGNORE_ARGS'))
                        {
                                $this->callStacks[] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
                        }
                        else
                        {
                                $this->callStacks[] = debug_backtrace();
                        }
                }

                // If an error occurred handle it.
                if (!$this->cursor)
                {
                        // Check if the server was disconnected.
                        if (!$this->connected())
                        {
                                try
                                {
                                        // Attempt to reconnect.
                                        $this->connection = null;
                                        $this->connect();
                                }
                                // If connect fails, ignore that exception and throw the normal exception.
                                catch (RuntimeException $e)
                                {
                                        // Get the error number and message.
                                        $this->errorNum = (int) mysql_errno($this->connection);
                                        $this->errorMsg = (string) mysql_error($this->connection) . ' SQL=' . $query;

                                        // Throw the normal query exception.
                                        JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED', $this->errorNum, $this->errorMsg), JLog::ERROR, 'databasequery');
                                        throw new RuntimeException($this->errorMsg, $this->errorNum);
                                }

                                // Since we were able to reconnect, run the query again.
                                return $this->execute();
                        }
                        // The server was not disconnected.
                        else
                        {
                                // Get the error number and message.
                                $this->errorNum = (int) mysql_errno($this->connection);
                                $this->errorMsg = (string) mysql_error($this->connection) . ' SQL=' . $query;

                                // Throw the normal query exception.
                                JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED', $this->errorNum, $this->errorMsg), JLog::ERROR, 'databasequery');
                                throw new RuntimeException($this->errorMsg, $this->errorNum);
                        }
                }

                return $this->cursor;
        }

        /**
         * Select a database for use.
         *
         * @param   string  $database  The name of the database to select for use.
         *
         * @return  boolean  True if the database was successfully selected.
         *
         * @since   12.1
         * @throws  RuntimeException
         */
        public function select($database)
        {
                $this->connect();

                if (!$database)
                {
                        return false;
                }

                if (!mysql_select_db($database, $this->connection))
                {
                        throw new RuntimeException('Could not connect to database');
                }

                return true;
        }

        /**
         * Set the connection to use UTF-8 character encoding.
         *
         * @return  boolean  True on success.
         *
         * @since   12.1
         */
        public function setUTF()
        {
                $this->connect();

                return mysql_set_charset('utf8', $this->connection);
        }

        /**
         * Method to fetch a row from the result set cursor as an array.
         *
         * @param   mixed  $cursor  The optional result set cursor from which to fetch the row.
         *
         * @return  mixed  Either the next row from the result set or false if there are no more rows.
         *
         * @since   12.1
         */
        protected function fetchArray($cursor = null)
        {
                return mysql_fetch_row($cursor ? $cursor : $this->cursor);
        }

        /**
         * Method to fetch a row from the result set cursor as an associative array.
         *
         * @param   mixed  $cursor  The optional result set cursor from which to fetch the row.
         *
         * @return  mixed  Either the next row from the result set or false if there are no more rows.
         *
         * @since   12.1
         */
        protected function fetchAssoc($cursor = null)
        {
                return mysql_fetch_assoc($cursor ? $cursor : $this->cursor);
        }

        /**
         * Method to fetch a row from the result set cursor as an object.
         *
         * @param   mixed   $cursor  The optional result set cursor from which to fetch the row.
         * @param   string  $class   The class name to use for the returned row object.
         *
         * @return  mixed   Either the next row from the result set or false if there are no more rows.
         *
         * @since   12.1
         */
        protected function fetchObject($cursor = null, $class = 'stdClass')
        {
                return mysql_fetch_object($cursor ? $cursor : $this->cursor, $class);
        }

        /**
         * Method to free up the memory used for the result set.
         *
         * @param   mixed  $cursor  The optional result set cursor from which to fetch the row.
         *
         * @return  void
         *
         * @since   12.1
         */
        protected function freeResult($cursor = null)
        {
                mysql_free_result($cursor ? $cursor : $this->cursor);
        }

        /**
         * Internal function to check if profiling is available
         *
         * @return  boolean
         *
         * @since 3.1.3
         */
        private function hasProfiling()
        {
                try
                {
                        $res = mysql_query("SHOW VARIABLES LIKE 'have_profiling'", $this->connection);
                        $row = mysql_fetch_assoc($res);

                        return isset($row);
                }
                catch (Exception $e)
                {
                        return false;
                }
        }
}