"TYPO3 4.0.1: typo3_src-4.0.1/t3lib/class.t3lib_db.php Source File", "datetime" => "Sat Dec 2 19:22:17 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

class.t3lib_db.php

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2004-2006 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project 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.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script 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.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
class t3lib_DB {


                // Debug:
        var $debugOutput = FALSE;               // Set "TRUE" if you want database errors outputted.
        var $debug_lastBuiltQuery = '';         // Internally: Set to last built query (not necessarily executed...)
        var $store_lastBuiltQuery = FALSE;      // Set "TRUE" if you want the last built query to be stored in $debug_lastBuiltQuery independent of $this->debugOutput

                // Default link identifier:
        var $link = FALSE;




        /************************************
         *
         * Query execution
         *
         * These functions are the RECOMMENDED DBAL functions for use in your applications
         * Using these functions will allow the DBAL to use alternative ways of accessing data (contrary to if a query is returned!)
         * They compile a query AND execute it immediately and then return the result
         * This principle heightens our ability to create various forms of DBAL of the functions.
         * Generally: We want to return a result pointer/object, never queries.
         * Also, having the table name together with the actual query execution allows us to direct the request to other databases.
         *
         **************************************/

        function exec_INSERTquery($table,$fields_values,$no_quote_fields=FALSE) {
                $res = mysql_query($this->INSERTquery($table,$fields_values,$no_quote_fields), $this->link);
                if ($this->debugOutput) $this->debug('exec_INSERTquery');
                return $res;
        }

        function exec_UPDATEquery($table,$where,$fields_values,$no_quote_fields=FALSE)  {
                $res = mysql_query($this->UPDATEquery($table,$where,$fields_values,$no_quote_fields), $this->link);
                if ($this->debugOutput) $this->debug('exec_UPDATEquery');
                return $res;
        }

        function exec_DELETEquery($table,$where)        {
                $res = mysql_query($this->DELETEquery($table,$where), $this->link);
                if ($this->debugOutput) $this->debug('exec_DELETEquery');
                return $res;
        }

        function exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='')   {
                $res = mysql_query($this->SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy,$limit), $this->link);
                if ($this->debugOutput) $this->debug('exec_SELECTquery');
                return $res;
        }

        function exec_SELECT_mm_query($select,$local_table,$mm_table,$foreign_table,$whereClause='',$groupBy='',$orderBy='',$limit='')  {
                if($foreign_table == $local_table) {
                        $foreign_table_as = $foreign_table.uniqid('_join');
                }

                $mmWhere = $local_table ? $local_table.'.uid='.$mm_table.'.uid_local' : '';
                $mmWhere.= ($local_table AND $foreign_table) ? ' AND ' : '';
                $mmWhere.= $foreign_table ? ($foreign_table_as ? $foreign_table_as : $foreign_table).'.uid='.$mm_table.'.uid_foreign' : '';

                return $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                                        $select,
                                        ($local_table ? $local_table.',' : '').$mm_table.($foreign_table ? ','. $foreign_table.($foreign_table_as ? ' AS '.$foreign_table_as : '') : ''),
                                        $mmWhere.' '.$whereClause,              // whereClauseMightContainGroupOrderBy
                                        $groupBy,
                                        $orderBy,
                                        $limit
                                );
        }

        function exec_SELECT_queryArray($queryParts)    {
                return $this->exec_SELECTquery(
                                        $queryParts['SELECT'],
                                        $queryParts['FROM'],
                                        $queryParts['WHERE'],
                                        $queryParts['GROUPBY'],
                                        $queryParts['ORDERBY'],
                                        $queryParts['LIMIT']
                                );
        }

        function exec_SELECTgetRows($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='',$uidIndexField='')       {
                $res = $this->exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy,$limit);
                if ($this->debugOutput) $this->debug('exec_SELECTquery');

                if (!$this->sql_error())        {
                        $output = array();

                        if ($uidIndexField)     {
                                while($tempRow = $this->sql_fetch_assoc($res))  {
                                        $output[$tempRow[$uidIndexField]] = $tempRow;
                                }
                        } else {
                                while($output[] = $this->sql_fetch_assoc($res));
                                array_pop($output);
                        }
                }
                return $output;
        }











        /**************************************
         *
         * Query building
         *
         **************************************/

        function INSERTquery($table,$fields_values,$no_quote_fields=FALSE)      {

                        // Table and fieldnames should be "SQL-injection-safe" when supplied to this function (contrary to values in the arrays which may be insecure).
                if (is_array($fields_values) && count($fields_values))  {

                                // quote and escape values
                        $fields_values = $this->fullQuoteArray($fields_values,$table,$no_quote_fields);

                                // Build query:
                        $query = 'INSERT INTO '.$table.'
                                (
                                        '.implode(',
                                        ',array_keys($fields_values)).'
                                ) VALUES (
                                        '.implode(',
                                        ',$fields_values).'
                                )';

                                // Return query:
                        if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
                        return $query;
                }
        }

        function UPDATEquery($table,$where,$fields_values,$no_quote_fields=FALSE)       {

                        // Table and fieldnames should be "SQL-injection-safe" when supplied to this function (contrary to values in the arrays which may be insecure).
                if (is_string($where))  {
                        if (is_array($fields_values) && count($fields_values))  {

                                        // quote and escape values
                                $nArr = $this->fullQuoteArray($fields_values,$table,$no_quote_fields);

                                $fields = array();
                                foreach ($nArr as $k => $v) {
                                        $fields[] = $k.'='.$v;
                                }

                                        // Build query:
                                $query = 'UPDATE '.$table.'
                                        SET
                                                '.implode(',
                                                ',$fields).
                                        (strlen($where)>0 ? '
                                        WHERE
                                                '.$where : '');

                                        // Return query:
                                if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
                                return $query;
                        }
                } else {
                        die('<strong>TYPO3 Fatal Error:</strong> "Where" clause argument for UPDATE query was not a string in $this->UPDATEquery() !');
                }
        }

        function DELETEquery($table,$where)     {
                if (is_string($where))  {

                                // Table and fieldnames should be "SQL-injection-safe" when supplied to this function
                        $query = 'DELETE FROM '.$table.
                                (strlen($where)>0 ? '
                                WHERE
                                        '.$where : '');

                        if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
                        return $query;
                } else {
                        die('<strong>TYPO3 Fatal Error:</strong> "Where" clause argument for DELETE query was not a string in $this->DELETEquery() !');
                }
        }

        function SELECTquery($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='')        {

                        // Table and fieldnames should be "SQL-injection-safe" when supplied to this function
                        // Build basic query:
                $query = 'SELECT '.$select_fields.'
                        FROM '.$from_table.
                        (strlen($where_clause)>0 ? '
                        WHERE
                                '.$where_clause : '');

                        // Group by:
                if (strlen($groupBy)>0) {
                        $query.= '
                        GROUP BY '.$groupBy;
                }
                        // Order by:
                if (strlen($orderBy)>0) {
                        $query.= '
                        ORDER BY '.$orderBy;
                }
                        // Group by:
                if (strlen($limit)>0)   {
                        $query.= '
                        LIMIT '.$limit;
                }

                        // Return query:
                if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
                return $query;
        }

        function listQuery($field, $value, $table)      {
                $command = $this->quoteStr($value, $table);
                $where = '('.$field.' LIKE \'%,'.$command.',%\' OR '.$field.' LIKE \''.$command.',%\' OR '.$field.' LIKE \'%,'.$command.'\' OR '.$field.'=\''.$command.'\')';
                return $where;
        }

        function searchQuery($searchWords,$fields,$table)       {
                $queryParts = array();

                foreach($searchWords as $sw)    {
                        $like=' LIKE \'%'.$this->quoteStr($sw, $table).'%\'';
                        $queryParts[] = $table.'.'.implode($like.' OR '.$table.'.',$fields).$like;
                }
                $query = '('.implode(') AND (',$queryParts).')';
                return $query ;
        }
















        /**************************************
         *
         * Various helper functions
         *
         * Functions recommended to be used for
         * - escaping values,
         * - cleaning lists of values,
         * - stripping of excess ORDER BY/GROUP BY keywords
         *
         **************************************/

        function fullQuoteStr($str, $table)     {
                if (function_exists('mysql_real_escape_string'))        {
                        return '\''.mysql_real_escape_string($str, $this->link).'\'';
                } else {
                        return '\''.mysql_escape_string($str).'\'';
                }
        }

        function fullQuoteArray($arr, $table, $noQuote=FALSE)   {
                if (is_string($noQuote))        {
                        $noQuote = explode(',',$noQuote);
                } elseif (!is_array($noQuote))  {       // sanity check
                        $noQuote = FALSE;
                }

                foreach($arr as $k => $v)       {
                        if ($noQuote===FALSE || !in_array($k,$noQuote))     {
                                $arr[$k] = $this->fullQuoteStr($v, $table);
                        }
                }
                return $arr;
        }

        function quoteStr($str, $table) {
                if (function_exists('mysql_real_escape_string'))        {
                        return mysql_real_escape_string($str, $this->link);
                } else {
                        return mysql_escape_string($str);
                }
        }

        function escapeStrForLike($str, $table) {
                return preg_replace('/[_%]/','\\\$0',$str);
        }

        function cleanIntArray($arr)    {
                foreach($arr as $k => $v)       {
                        $arr[$k] = intval($arr[$k]);
                }
                return $arr;
        }

        function cleanIntList($list)    {
                return implode(',',t3lib_div::intExplode(',',$list));
        }

        function stripOrderBy($str)     {
                return preg_replace('/^ORDER[[:space:]]+BY[[:space:]]+/i','',trim($str));
        }

        function stripGroupBy($str)     {
                return preg_replace('/^GROUP[[:space:]]+BY[[:space:]]+/i','',trim($str));
        }

        function splitGroupOrderLimit($str)     {
                $str = ' '.$str;        // Prepending a space to make sure "[[:space:]]+" will find a space there for the first element.
                        // Init output array:
                $wgolParts = array(
                        'WHERE' => '',
                        'GROUPBY' => '',
                        'ORDERBY' => '',
                        'LIMIT' => ''
                );

                        // Find LIMIT:
                $reg = array();
                if (preg_match('/^(.*)[[:space:]]+LIMIT[[:space:]]+([[:alnum:][:space:],._]+)$/i',$str,$reg))   {
                        $wgolParts['LIMIT'] = trim($reg[2]);
                        $str = $reg[1];
                }

                        // Find ORDER BY:
                $reg = array();
                if (preg_match('/^(.*)[[:space:]]+ORDER[[:space:]]+BY[[:space:]]+([[:alnum:][:space:],._]+)$/i',$str,$reg))     {
                        $wgolParts['ORDERBY'] = trim($reg[2]);
                        $str = $reg[1];
                }

                        // Find GROUP BY:
                $reg = array();
                if (preg_match('/^(.*)[[:space:]]+GROUP[[:space:]]+BY[[:space:]]+([[:alnum:][:space:],._]+)$/i',$str,$reg))     {
                        $wgolParts['GROUPBY'] = trim($reg[2]);
                        $str = $reg[1];
                }

                        // Rest is assumed to be "WHERE" clause:
                $wgolParts['WHERE'] = $str;

                return $wgolParts;
        }















        /**************************************
         *
         * MySQL wrapper functions
         * (For use in your applications)
         *
         **************************************/

        function sql($db,$query)        {
                $res = mysql_query($query, $this->link);
                if ($this->debugOutput) $this->debug('sql');
                return $res;
        }

        function sql_query($query)      {
                $res = mysql_query($query, $this->link);
                if ($this->debugOutput) $this->debug('sql_query');
                return $res;
        }

        function sql_error()    {
                return mysql_error($this->link);
        }

        function sql_num_rows($res)     {
                return mysql_num_rows($res);
        }

        function sql_fetch_assoc($res)  {
                return mysql_fetch_assoc($res);
        }

        function sql_fetch_row($res)    {
                return mysql_fetch_row($res);
        }

        function sql_free_result($res)  {
                return mysql_free_result($res);
        }

        function sql_insert_id()        {
                return mysql_insert_id($this->link);
        }

        function sql_affected_rows()    {
                return mysql_affected_rows($this->link);
        }

        function sql_data_seek($res,$seek)      {
                return mysql_data_seek($res,$seek);
        }

        function sql_field_type($res,$pointer)  {
                return mysql_field_type($res,$pointer);
        }

        function sql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password)   {
                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['no_pconnect'])  {
                        $this->link = @mysql_connect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password);
                } else {
                        $this->link = @mysql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password);
                }

                if (!$this->link) {
                        t3lib_div::sysLog('Could not connect to Mysql server '.$TYPO3_db_host.' with user '.$TYPO3_db_username.'.','Core',4);
                } else {
                        $setDBinit = t3lib_div::trimExplode(chr(10), $GLOBALS['TYPO3_CONF_VARS']['SYS']['setDBinit'],true);
                        foreach ($setDBinit as $v)      {
                                if (mysql_query($v, $this->link) === FALSE)     {
                                        t3lib_div::sysLog('Could not initialize DB connection with query "'.$v.'": '.mysql_error($this->link),'Core',3);
                                }
                        }
                }
                return $this->link;
        }

        function sql_select_db($TYPO3_db)       {
                $ret = @mysql_select_db($TYPO3_db, $this->link);
                if (!$ret) {
                        t3lib_div::sysLog('Could not select Mysql database '.$TYPO3_db.': '.mysql_error(),'Core',4);
        }
                return $ret;
        }










        /**************************************
         *
         * SQL admin functions
         * (For use in the Install Tool and Extension Manager)
         *
         **************************************/

        function admin_get_dbs()        {
                $dbArr = array();
                $db_list = mysql_list_dbs($this->link);
                while ($row = mysql_fetch_object($db_list)) {
                        if ($this->sql_select_db($row->Database))       {
                                $dbArr[] = $row->Database;
                        }
                }
                return $dbArr;
        }

        function admin_get_tables()     {
                $whichTables = array();
                $tables_result = mysql_list_tables(TYPO3_db, $this->link);
                if (!mysql_error())     {
                        while ($theTable = mysql_fetch_assoc($tables_result)) {
                                $whichTables[current($theTable)] = current($theTable);
                        }
                }
                return $whichTables;
        }

        function admin_get_fields($tableName)   {
                $output = array();

                $columns_res = mysql_query('SHOW columns FROM '.$tableName, $this->link);
                while($fieldRow = mysql_fetch_assoc($columns_res))      {
                        $output[$fieldRow['Field']] = $fieldRow;
                }

                return $output;
        }

        function admin_get_keys($tableName)     {
                $output = array();

                $keyRes = mysql_query('SHOW keys FROM '.$tableName, $this->link);
                while($keyRow = mysql_fetch_assoc($keyRes))     {
                        $output[] = $keyRow;
                }

                return $output;
        }

        function admin_query($query)    {
                $res = mysql_query($query, $this->link);
                if ($this->debugOutput) $this->debug('admin_query');
                return $res;
        }












        /******************************
         *
         * Connecting service
         *
         ******************************/

        function connectDB()    {
                if ($this->sql_pconnect(TYPO3_db_host, TYPO3_db_username, TYPO3_db_password))   {
                        if (!TYPO3_db)  {
                                die('No database selected');
                                exit;
                        } elseif (!$this->sql_select_db(TYPO3_db))      {
                                die('Cannot connect to the current database, "'.TYPO3_db.'"');
                                exit;
                        }
                } else {
                        die('The current username, password or host was not accepted when the connection to the database was attempted to be established!');
                        exit;
                }
        }












        /******************************
         *
         * Debugging
         *
         ******************************/

        function debug($func)   {

                $error = $this->sql_error();
                if ($error)             {
                        echo t3lib_div::view_array(array(
                                'caller' => 't3lib_DB::'.$func,
                                'ERROR' => $error,
                                'lastBuiltQuery' => $this->debug_lastBuiltQuery,
                                'debug_backtrace' => t3lib_div::debug_trail()
                        ));
                }
        }
}


if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_db.php'])        {
        include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_db.php']);
}
?>