include/database/DBManager.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 /*********************************************************************************
  39
  40 * Description: This file handles the Data base functionality for the application.
  41 * It acts as the DB abstraction layer for the application. It depends on helper classes
  42 * which generate the necessary SQL. This sql is then passed to PEAR DB classes.
  43 * The helper class is chosen in DBManagerFactory, which is driven by 'db_type' in 'dbconfig' under config.php.
  44 *
  45 * All the functions in this class will work with any bean which implements the meta interface.
  46 * The passed bean is passed to helper class which uses these functions to generate correct sql.
  47 *
  48 * The meta interface has the following functions:
  49 * getTableName()                        Returns table name of the object.
  50 * getFieldDefinitions()         Returns a collection of field definitions in order.
  51 * getFieldDefintion(name)               Return field definition for the field.
  52 * getFieldValue(name)           Returns the value of the field identified by name.
  53 *                               If the field is not set, the function will return boolean FALSE.
  54 * getPrimaryFieldDefinition()   Returns the field definition for primary key
  55 *
  56 * The field definition is an array with the following keys:
  57 *
  58 * name          This represents name of the field. This is a required field.
  59 * type          This represents type of the field. This is a required field and valid values are:
  60 *           �   int
  61 *           �   long
  62 *           �   varchar
  63 *           �   text
  64 *           �   date
  65 *           �   datetime
  66 *           �   double
  67 *           �   float
  68 *           �   uint
  69 *           �   ulong
  70 *           �   time
  71 *           �   short
  72 *           �   enum
  73 * length    This is used only when the type is varchar and denotes the length of the string.
  74 *           The max value is 255.
  75 * enumvals  This is a list of valid values for an enum separated by "|".
  76 *           It is used only if the type is �enum�;
  77 * required  This field dictates whether it is a required value.
  78 *           The default value is �FALSE�.
  79 * isPrimary This field identifies the primary key of the table.
  80 *           If none of the fields have this flag set to �TRUE�,
  81 *           the first field definition is assume to be the primary key.
  82 *           Default value for this field is �FALSE�.
  83 * default   This field sets the default value for the field definition.
  84 *
  85 *
  86 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  87 * All Rights Reserved.
  88 * Contributor(s): ______________________________________..
  89 ********************************************************************************/
  90
  91
  92
  93
  94 abstract class DBManager
  95 {
  96     /**
  97      * DBHelper object instance for this class
  98      */
  99     public $helper;
 100
 101     /**
 102      * Name of database table we are dealing with
 103      */
 104     protected $tableName;
 105
 106     /**
 107      * Name of database
 108      */
 109     public $database = null;
 110
 111     /**
 112      * Indicates whether we should die when we get an error from the DB
 113      */
 114     protected $dieOnError = false;
 115
 116     /**
 117      * Indicates whether we should html encode the results from a query by default
 118      */
 119     protected $encode = true;
 120
 121     /**
 122      * Records the execution time of the last query
 123      */
 124     protected $query_time = 0;
 125
 126     /**
 127      * Number of the last row fetched from the query result set
 128      */
 129     protected $lastmysqlrow = -1;
 130
 131     /**
 132      * Last error message from the DB backend
 133      */
 134     protected $last_error = '';
 135
 136     /**
 137      * Registry of available result sets
 138      */
 139     protected $lastResult = array();
 140
 141     /**
 142      * Current query count
 143      */
 144     private static $queryCount = 0;
 145
 146     /**
 147      * Query threshold limit
 148      */
 149     private static $queryLimit = 0;
 150
 151     /**
 152      * Array of common backend functions and what the PHP they map to is
 153      */
 154     protected $backendFunctions = array();
 155
 156     /**
 157      * Array of prepared statements and their correspoding parsed tokens
 158      */
 159     protected $preparedTokens = array();
 160
 161     /**
 162      * Wrapper for those trying to access the private and protected class members directly
 163      */
 164     public function __get($p)
 165     {
 166         $GLOBALS['log']->info('call to DBManagerFactory::$'.$p.' is deprecated');
 167         return $this->$p;
 168     }
 169
 170     public function __construct()
 171     {
 172     }
 173
 174     /**
 175      * Returns the current tablename
 176      *
 177      * @return string
 178      */
 179     public function getTableName()
 180     {
 181         return $this->tableName;
 182     }
 183
 184     /**
 185      * Returns the current database handle
 186      *
 187      * @return resource
 188      */
 189     public function getDatabase()
 190     {
 191         $this->checkConnection();
 192         return $this->database;
 193     }
 194
 195     /**
 196      * Returns this instance's DBHelper
 197      *
 198      * @return object DBHelper instance
 199      */
 200     public function getHelper()
 201     {
 202         if ( !($this->helper instanceof DBHelper) ) {
 203             global $sugar_config;
 204
 205             switch ( $sugar_config['dbconfig']['db_type'] ) {
 206             case "mysql":
 207                 $my_db_helper = 'MysqlHelper';
 208                 if ( (!isset($sugar_config['mysqli_disabled'])
 209                             || $sugar_config['mysqli_disabled'] == false)
 210                         && function_exists('mysqli_connect') )
 211                     $my_db_helper = 'MysqliHelper';
 212                 break;
 213             case "mssql":
 214                 if ( function_exists('sqlsrv_connect')
 215                         && (empty($config['db_mssql_force_driver']) || $config['db_mssql_force_driver'] == 'sqlsrv' ))
 216                     $my_db_helper = 'SqlsrvHelper';
 217                 elseif (is_freetds()
 218                         && (empty($config['db_mssql_force_driver']) || $config['db_mssql_force_driver'] == 'freetds' ))
 219                     $my_db_helper = 'FreeTDSHelper';
 220                 else
 221                     $my_db_helper = 'MssqlHelper';
 222                 break;
 223             default:
 224                 $my_db_helper = 'MysqlHelper';
 225             }
 226             $GLOBALS['log']->info("using $my_db_helper DBHelper backend");
 227             require_once("include/database/{$my_db_helper}.php");
 228             $this->helper = new $my_db_helper();
 229             $this->helper->db = $this;
 230         }
 231
 232         return $this->helper;
 233     }
 234
 235     /**
 236      * Checks for database not being connected
 237      *
 238      * @param  string $msg        message to prepend to the error message
 239      * @param  bool   $dieOnError true if we want to die immediately on error
 240      * @return bool
 241      */
 242     public function checkError(
 243         $msg = '',
 244         $dieOnError = false)
 245     {
 246         $userMsg = inDeveloperMode()?"$msg: ":"";
 247
 248         if (!isset($this->database)) {
 249             $GLOBALS['log']->error("Database Is Not Connected");
 250             if($this->dieOnError || $dieOnError)
 251                 sugar_die ($userMsg."Database Is Not Connected");
 252             else
 253                 $this->last_error = $userMsg."Database Is Not Connected";
 254             return true;
 255         }
 256         return false;
 257     }
 258
 259     /**
 260      * This method is called by every method that runs a query.
 261      * If slow query dumping is turned on and the query time is beyond
 262      * the time limit, we will log the query. This function may do
 263      * additional reporting or log in a different area in the future.
 264      *
 265      * @param  string  $query query to log
 266      * @return boolean true if the query was logged, false otherwise
 267      */
 268     protected function dump_slow_queries(
 269         $query
 270         )
 271     {
 272         global $sugar_config;
 273
 274         $do_the_dump = isset($sugar_config['dump_slow_queries'])
 275             ? $sugar_config['dump_slow_queries'] : false;
 276         $slow_query_time_msec = isset($sugar_config['slow_query_time_msec'])
 277             ? $sugar_config['slow_query_time_msec'] : 5000;
 278
 279         if($do_the_dump) {
 280             if($slow_query_time_msec < ($this->query_time * 1000)) {
 281                 // Then log both the query and the query time
 282                 $GLOBALS['log']->fatal('Slow Query (time:'.$this->query_time."\n".$query);
 283                 return true;
 284             }
 285         }
 286         return false;
 287     }
 288
 289    /**
 290     * Scans order by to ensure that any field being ordered by is.
 291     *
 292     * It will throw a warning error to the log file - fatal if slow query logging is enabled
 293     *
 294     * @param  string $sql         query to be run
 295     * @param  bool   $object_name optional, object to look up indices in
 296     * @return bool   true if an index is found false otherwise
 297     */
 298    protected function checkQuery(
 299        $sql,
 300        $object_name = false
 301        )
 302    {
 303        $match = array();
 304        preg_match_all("'.* FROM ([^ ]*).* ORDER BY (.*)'is", $sql, $match);
 305        $indices = false;
 306        if (!empty($match[1][0]))
 307            $table = $match[1][0];
 308        else
 309            return false;
 310
 311        if (!empty($object_name) && !empty($GLOBALS['dictionary'][$object_name]))
 312            $indices = $GLOBALS['dictionary'][$object_name]['indices'];
 313
 314        if (empty($indices)) {
 315            foreach ( $GLOBALS['dictionary'] as $current ) {
 316                if ($current['table'] == $table){
 317                    $indices = $current['indices'];
 318                    break;
 319                }
 320            }
 321        }
 322        if (empty($indices)) {
 323            $GLOBALS['log']->warn('CHECK QUERY: Could not find index definitions for table ' . $table);
 324            return false;
 325        }
 326        if (!empty($match[2][0])) {
 327            $orderBys = explode(' ', $match[2][0]);
 328            foreach ($orderBys as $orderBy){
 329                $orderBy = trim($orderBy);
 330                if (empty($orderBy))
 331                    continue;
 332                $orderBy = strtolower($orderBy);
 333                if ($orderBy == 'asc' || $orderBy == 'desc')
 334                    continue;
 335
 336                $orderBy = str_replace(array($table . '.', ','), '', $orderBy);
 337
 338                foreach ($indices as $index)
 339                    if (empty($index['db']) || $index['db'] == $this->dbType)
 340                        foreach ($index['fields'] as $field)
 341                            if ($field == $orderBy)
 342                                return true;
 343
 344                $warning = 'Missing Index For Order By Table: ' . $table . ' Order By:' . $orderBy ;
 345                if (!empty($GLOBALS['sugar_config']['dump_slow_queries']))
 346                    $GLOBALS['log']->fatal('CHECK QUERY:' .$warning);
 347                else
 348                    $GLOBALS['log']->warn('CHECK QUERY:' .$warning);
 349
 350            }
 351        }
 352        return false;
 353     }
 354
 355     /**
 356      * Returns the time the last query took to execute
 357      *
 358      * @return int
 359      */
 360     public function getQueryTime()
 361     {
 362         return $this->query_time;
 363     }
 364
 365     /**
 366      * Checks the current connection; if it is not connected then reconnect
 367      */
 368     public function checkConnection()
 369     {
 370         $this->last_error = '';
 371         if (!isset($this->database))
 372             $this->connect();
 373     }
 374
 375     /**
 376      * Sets the dieOnError value
 377      *
 378      * @param bool $value
 379      */
 380     public function setDieOnError(
 381         $value
 382         )
 383     {
 384         $this->dieOnError = $value;
 385     }
 386
 387     /**
 388          * Implements a generic insert for any bean.
 389          *
 390          * @param object $bean SugarBean instance
 391          */
 392     public function insert(
 393         SugarBean $bean
 394         )
 395     {
 396         $sql = $this->getHelper()->insertSQL($bean);
 397         $this->tableName = $bean->getTableName();
 398         $msg = "Error inserting into table: ".$this->tableName;
 399         $this->query($sql,true,$msg);
 400     }
 401
 402     /**
 403      * Implements a generic update for any bean
 404      *
 405      * @param object $bean  Sugarbean instance
 406      * @param array  $where values with the keys as names of fields.
 407      * If we want to pass multiple values for a name, pass it as an array
 408      * If where is not passed, it defaults to id of table
 409      */
 410     public function update(
 411         SugarBean $bean,
 412         array $where = array()
 413         )
 414     {
 415         $sql = $this->getHelper()->updateSQL($bean, $where);
 416         $this->tableName = $bean->getTableName();
 417         $msg = "Error updating table: ".$this->tableName. ":";
 418         $this->query($sql,true,$msg);
 419     }
 420
 421     /**
 422          * Implements a generic delete for any bean identified by id
 423      *
 424      * @param object $bean  Sugarbean instance
 425      * @param array  $where values with the keys as names of fields.
 426          * If we want to pass multiple values for a name, pass it as an array
 427          * If where is not passed, it defaults to id of table
 428          */
 429     public function delete(
 430         SugarBean $bean,
 431         array $where = array()
 432         )
 433     {
 434         $sql = $this->getHelper()->deleteSQL($bean, $where);
 435         $this->tableName = $bean->getTableName();
 436         $msg = "Error deleting from table: ".$this->tableName. ":";
 437         $this->query($sql,true,$msg);
 438     }
 439
 440     /**
 441      * Implements a generic retrieve for any bean identified by id
 442      *
 443      * If we want to pass multiple values for a name, pass it as an array
 444      * If where is not passed, it defaults to id of table
 445      *
 446      * @param  object   $bean  Sugarbean instance
 447      * @param  array    $where values with the keys as names of fields.
 448      * @return resource result from the query
 449      */
 450     public function retrieve(
 451         SugarBean $bean,
 452         array $where = array()
 453         )
 454     {
 455         $sql = $this->getHelper()->retrieveSQL($bean, $where);
 456         $this->tableName = $bean->getTableName();
 457         $msg = "Error retriving values from table:".$this->tableName. ":";
 458         return $this->query($sql,true,$msg);
 459     }
 460
 461     /**
 462      * Implements a generic retrieve for a collection of beans.
 463      *
 464      * These beans will be joined in the sql by the key attribute of field defs.
 465      * Currently, this function does support outer joins.
 466      *
 467      * @param  array $beans Sugarbean instance(s)
 468      * @param  array $cols  columns to be returned with the keys as names of bean as identified by
 469      * get_class of bean. Values of this array is the array of fieldDefs to be returned for a bean.
 470      * If an empty array is passed, all columns are selected.
 471      * @param  array $where  values with the keys as names of bean as identified by get_class of bean
 472      * Each value at the first level is an array of values for that bean identified by name of fields.
 473      * If we want to pass multiple values for a name, pass it as an array
 474      * If where is not passed, all the rows will be returned.
 475      * @return resource
 476      */
 477     public function retrieveView(
 478         array $beans,
 479         array $cols = array(),
 480         array $where = array()
 481         )
 482     {
 483         $sql = $this->getHelper()->retrieveViewSQL($beans, $cols, $where);
 484         $this->tableName = "View Collection"; // just use this string for msg
 485         $msg = "Error retriving values from table:".$this->tableName. ":";
 486         $this->query($sql,true,$msg);
 487     }
 488
 489
 490     /**
 491          * Implements creation of a db table for a bean.
 492          *
 493      * @param object $bean  Sugarbean instance
 494      */
 495     public function createTable(
 496         SugarBean $bean
 497         )
 498     {
 499         $sql = $this->getHelper()->createTableSQL($bean);
 500         $this->tableName = $bean->getTableName();
 501         $msg = "Error creating table: ".$this->tableName. ":";
 502         $this->query($sql,true,$msg);
 503     }
 504
 505     /**
 506      * Implements creation of a db table
 507      *
 508      * @param string $tablename
 509      * @param array  $fieldDefs
 510      * @param array  $indices
 511      * @param string $engine    MySQL engine to use
 512      */
 513     public function createTableParams(
 514         $tablename,
 515         $fieldDefs,
 516         $indices,
 517         $engine = null
 518         )
 519     {
 520         if (!empty($fieldDefs)) {
 521             $sql = $this->getHelper()
 522                         ->createTableSQLParams($tablename, $fieldDefs, $indices,$engine);
 523             $this->tableName = $tablename;
 524             if ($sql) {
 525                 $msg = "Error creating table: ".$this->tableName. ":";
 526                 $this->query($sql,true,$msg);
 527             }
 528         }
 529     }
 530
 531     /**
 532          * Implements repair of a db table for a bean.
 533          *
 534          * @param  object $bean    SugarBean instance
 535      * @param  bool   $execute true if we want the action to take place, false if we just want the sql returned
 536          * @return string SQL statement or empty string, depending upon $execute
 537          */
 538     public function repairTable(SugarBean $bean, $execute = true)
 539     {
 540         $indices   = $bean->getIndices();
 541         $fielddefs = $bean->getFieldDefinitions();
 542         $tablename = $bean->getTableName();
 543
 544                 //Clean the indicies to prevent duplicate definitions
 545                 $new_Indecies = array();
 546                 foreach($indices as $ind_def){
 547                         $new_Indecies[$ind_def['name']] = $ind_def;
 548                 }
 549                 //jc: added this for beans that do not actually have a table, namely
 550                 //ForecastOpportunities
 551         if($tablename == 'does_not_exist' || $tablename == '')
 552                 return '';
 553
 554         global $dictionary;
 555         $engine=null;
 556         if (isset($dictionary[$bean->getObjectName()]['engine']) && !empty($dictionary[$bean->getObjectName()]['engine']) )
 557             $engine = $dictionary[$bean->getObjectName()]['engine'];
 558
 559         return $this->repairTableParams($tablename, $fielddefs,$new_Indecies,$execute,$engine);
 560     }
 561
 562     /**
 563      * Builds the SQL commands that repair a table structure
 564      *
 565      * @param  string $tablename
 566      * @param  array  $fielddefs
 567      * @param  array  $indices
 568      * @param  bool   $execute   optional, true if we want the queries executed instead of returned
 569      * @param  string $engine    optional, MySQL engine
 570      */
 571     public function repairTableParams(
 572         $tablename,
 573         $fielddefs,
 574         $indices,
 575         $execute = true,
 576         $engine = null
 577         )
 578     {
 579         global $table_descriptions;
 580
 581                 //jc: had a bug when running the repair if the tablename is blank the repair will
 582                 //fail when it tries to create a repair table
 583         if ($tablename == '')
 584             return '';
 585         if (empty($fielddefs))
 586             return '';
 587
 588         //if the table does not exist create it and we are done
 589         $sql = "/* Table : $tablename */\n";
 590         if (!$this->tableExists($tablename)){
 591
 592             $createtablesql = $this->getHelper()
 593                                     ->createTableSQLParams($tablename,$fielddefs,$indices,$engine);
 594             if($execute && $createtablesql){
 595                 $this->createTableParams($tablename,$fielddefs,$indices,$engine);
 596             }
 597
 598             $sql .= "/* MISSING TABLE: {$tablename} */\n";
 599             $sql .= $createtablesql . "\n";
 600             return $sql;
 601         }
 602
 603         $compareFieldDefs = $this->getHelper()->get_columns($tablename);
 604         $compareIndices = $this->getHelper()->get_indices($tablename);
 605
 606         $take_action = false;
 607
 608         // do column comparisions
 609         $sql .= "/*COLUMNS*/\n";
 610         foreach ($fielddefs as $value) {
 611             if (isset($value['source']) && $value['source'] != 'db')
 612                 continue;
 613
 614             $name = $value['name'];
 615             // add or fix the field defs per what the DB is expected to give us back
 616             $this->getHelper()->massageFieldDef($value,$tablename);
 617
 618             $ignorerequired=false;
 619
 620                         //Do not track requiredness in the DB, auto_increment, ID, and deleted fields are always required in the DB, so don't force those
 621             if (empty($value['auto_increment']) && (empty($value['type']) || $value['type'] != 'id')
 622                     && (empty($value['dbType']) || $value['dbType'] != 'id')
 623                                         && (empty($value['name']) || ($value['name'] != 'id' && $value['name'] != 'deleted'))
 624                         ){
 625                             $value['required'] = false;
 626                         }
 627                         //Should match the conditions in DBHelper::oneColumnSQLRep for DB required fields, type='id' fields will sometimes
 628                         //come into this function as 'type' = 'char', 'dbType' = 'id' without required set in $value. Assume they are correct and leave them alone.
 629                         else if (($name == 'id' || $value['type'] == 'id' || (isset($value['dbType']) && $value['dbType'] == 'id'))
 630                 && (!isset($value['required']) && isset($compareFieldDefs[$name]['required'])))
 631                         {
 632                                 $value['required'] = $compareFieldDefs[$name]['required'];
 633                         }
 634
 635             if ( !isset($compareFieldDefs[$name]) ) {
 636                 // ok we need this field lets create it
 637                 $sql .= "/*MISSING IN DATABASE - $name -  ROW*/\n";
 638                 $sql .= $this->getHelper()->addColumnSQL($tablename, $value) .  "\n";
 639                 if ($execute)
 640                     $this->addColumn($tablename, $value);
 641                 $take_action = true;
 642             }
 643             elseif ( !$this->compareVarDefs($compareFieldDefs[$name],$value)) {
 644                 //fields are different lets alter it
 645                 $sql .= "/*MISMATCH WITH DATABASE - $name -  ROW ";
 646                 foreach($compareFieldDefs[$name] as $rKey => $rValue)
 647                     $sql .=     "[$rKey] => '$rValue'  ";
 648                 $sql .= "*/\n";
 649                 $sql .= "/* VARDEF - $name -  ROW";
 650                 foreach($value as $rKey => $rValue)
 651                     $sql .=     "[$rKey] => '$rValue'  ";
 652                 $sql .= "*/\n";
 653
 654                 //jc: oracle will complain if you try to execute a statement that sets a column to (not) null
 655                 //when it is already (not) null
 656                 if ( isset($value['isnull']) && isset($compareFieldDefs[$name]['isnull']) ) {
 657                     if ($value['isnull'] === $compareFieldDefs[$name]['isnull']) {
 658                         unset($value['required']);
 659                         $ignorerequired=true;
 660                     }
 661                 }
 662
 663                 //dwheeler: Once a column has been defined as null, we cannot try to force it back to !null
 664                 if ((isset($value['required']) && ($value['required'] === true || $value['required'] == 'true' || $value['required'] === 1))
 665                                     && (empty($compareFieldDefs[$name]['required']) || $compareFieldDefs[$name]['required'] != 'true'))
 666                             {
 667                                     $ignorerequired = true;
 668                             }
 669
 670                 $sql .= $this->getHelper()->alterColumnSQL($tablename, $value,$ignorerequired) .  "\n";
 671                 if($execute){
 672                     $this->alterColumn($tablename, $value,$ignorerequired);
 673                 }
 674                 $take_action = true;
 675             }
 676         }
 677
 678         // do index comparisions
 679         $sql .= "/* INDEXES */\n";
 680         $correctedIndexs = array();
 681
 682                 // do indicies comparisons case-insensitive
 683                 foreach($compareIndices as $k => $value){
 684                         $value['name'] = strtolower($value['name']);
 685                         $compareIndices_case_insensitive[strtolower($k)] = $value;
 686                 }
 687                 $compareIndices = $compareIndices_case_insensitive;
 688                 unset($compareIndices_case_insensitive);
 689
 690         foreach ($indices as $value) {
 691             if (isset($value['source']) && $value['source'] != 'db')
 692                 continue;
 693
 694                         $name = strtolower($value['name']);
 695
 696                         //Don't attempt to fix the same index twice in one pass;
 697                         if (isset($correctedIndexs[$name]))
 698                                 continue;
 699
 700             //don't bother checking primary nothing we can do about them
 701             if (isset($value['type']) && $value['type'] == 'primary')
 702                 continue;
 703
 704             //database helpers do not know how to handle full text indices
 705             if ($value['type']=='fulltext')
 706                 continue;
 707
 708             if ( in_array($value['type'],array('alternate_key','foreign')) )
 709                 $value['type'] = 'index';
 710
 711             if ( !isset($compareIndices[$name]) ) {
 712                 // ok we need this field lets create it
 713                 $sql .=  "/*MISSING INDEX IN DATABASE - $name -{$value['type']}  ROW */\n";
 714                 $sql .= $this->addIndexes($tablename,array($value), $execute) .  "\n";
 715                 $take_action = true;
 716                                 $correctedIndexs[$name] = true;
 717             }
 718             elseif ( !$this->compareVarDefs($compareIndices[$name],$value) ) {
 719                 // fields are different lets alter it
 720                 $sql .= "/*INDEX MISMATCH WITH DATABASE - $name -  ROW ";
 721                 foreach ($compareIndices[$name] as $n1 => $t1) {
 722                     $sql .=      "<$n1>";
 723                     if ( $n1 == 'fields' )
 724                         foreach($t1 as $rKey => $rValue)
 725                             $sql .= "[$rKey] => '$rValue'  ";
 726                     else
 727                         $sql .= " $t1 ";
 728                 }
 729                 $sql .= "*/\n";
 730                 $sql .= "/* VARDEF - $name -  ROW";
 731                 foreach ($value as $n1 => $t1) {
 732                     $sql .=     "<$n1>";
 733                     if ( $n1 == 'fields' )
 734                         foreach ($t1 as $rKey => $rValue)
 735                             $sql .=     "[$rKey] => '$rValue'  ";
 736                     else
 737                         $sql .= " $t1 ";
 738                 }
 739                 $sql .= "*/\n";
 740                 $sql .= $this->modifyIndexes($tablename,array($value), $execute) .  "\n";
 741                 $take_action = true;
 742                                 $correctedIndexs[$name] = true;
 743             }
 744         }
 745
 746         return ($take_action === true) ? $sql : "";
 747     }
 748
 749     /**
 750      * Compares two vardefs
 751      *
 752      * @param  array  $fielddef1 This is from the database
 753      * @param  array  $fielddef2 This is from the vardef
 754      * @return bool   true if they match, false if they don't
 755      */
 756     public function compareVarDefs(
 757         $fielddef1,
 758         $fielddef2
 759         )
 760     {
 761         foreach ( $fielddef1 as $key => $value ) {
 762             if ( $key == 'name' && ( strtolower($fielddef1[$key]) == strtolower($fielddef2[$key]) ) )
 763                 continue;
 764             if ( isset($fielddef2[$key]) && $fielddef1[$key] == $fielddef2[$key] )
 765                 continue;
 766             return false;
 767         }
 768
 769         return true;
 770     }
 771
 772     /**
 773      * Compare a field in two tables
 774      *
 775      * @param  string $name   field name
 776      * @param  string $table1
 777      * @param  string $table2
 778      * @return array  array with keys 'msg','table1','table2'
 779      */
 780     public function compareFieldInTables(
 781         $name,
 782         $table1,
 783         $table2
 784         )
 785     {
 786         $row1 = $this->describeField($name, $table1);
 787         $row2 = $this->describeField($name, $table2);
 788         $returnArray = array(
 789             'table1' => $row1,
 790             'table2' => $row2,
 791             'msg'    => 'error',
 792             );
 793
 794         $ignore_filter = array('Key'=>1);
 795         if ($row1) {
 796             if (!$row2) {
 797                 // Exists on table1 but not table2
 798                 $returnArray['msg'] = 'not_exists_table2';
 799             }
 800             else {
 801                 if (sizeof($row1) != sizeof($row2)) {
 802                     $returnArray['msg'] = 'no_match';
 803                 }
 804                 else {
 805                     $returnArray['msg'] = 'match';
 806                     foreach($row1 as $key => $value){
 807                         //ignore keys when checking we will check them when we do the index check
 808                         if( !isset($ignore_filter[$key]) && $row1[$key] !== $row2[$key]){
 809                             $returnArray['msg'] = 'no_match';
 810                         }
 811                     }
 812                 }
 813             }
 814         }
 815         else {
 816             $returnArray['msg'] = 'not_exists_table1';
 817         }
 818
 819         return $returnArray;
 820     }
 821
 822     /**
 823      * Compare an index in two different tables
 824      *
 825      * @param  string $name   index name
 826      * @param  string $table1
 827      * @param  string $table2
 828      * @return array  array with keys 'msg','table1','table2'
 829      */
 830     public function compareIndexInTables(
 831         $name,
 832         $table1,
 833         $table2
 834         )
 835     {
 836         $row1 = $this->describeIndex($name, $table1);
 837         $row2 = $this->describeIndex($name, $table2);
 838         $returnArray = array(
 839             'table1' => $row1,
 840             'table2' => $row2,
 841             'msg'    => 'error',
 842             );
 843         $ignore_filter = array('Table'=>1, 'Seq_in_index'=>1,'Cardinality'=>1, 'Sub_part'=>1, 'Packed'=>1, 'Comment'=>1);
 844
 845         if ($row1) {
 846             if (!$row2) {
 847                 //Exists on table1 but not table2
 848                 $returnArray['msg'] = 'not_exists_table2';
 849             }
 850             else {
 851                 if (sizeof($row1) != sizeof($row2)) {
 852                     $returnArray['msg'] = 'no_match';
 853                 }
 854                 else {
 855                     $returnArray['msg'] = 'match';
 856                     foreach ($row1 as $fname => $fvalue) {
 857                         if (!isset($row2[$fname])) {
 858                             $returnArray['msg'] = 'no_match';
 859                         }
 860                         foreach($fvalue as $key => $value) {
 861                             //ignore keys when checking we will check them when we do the index check
 862                             if(!isset($ignore_filter[$key]) && $row1[$fname][$key] != $row2[$fname][$key]){
 863                                 $returnArray['msg'] = 'no_match';
 864                             }
 865                         }
 866                     }
 867                 }
 868             }
 869         }
 870         else {
 871             $returnArray['msg'] = 'not_exists_table1';
 872         }
 873
 874         return $returnArray;
 875     }
 876
 877
 878     /**
 879          * Creates an index identified by name on the given fields.
 880          *
 881      * @param object $bean      SugarBean instance
 882      * @param array  $fieldDefs
 883      * @param string $name      index name
 884      * @param bool   $unique    optional, true if we want to create an unique index
 885          */
 886     public function createIndex(
 887         SugarBean $bean,
 888         $fieldDefs,
 889         $name,
 890         $unique = true
 891         )
 892     {
 893         $sql = $this->getHelper()->createIndexSQL($bean, $fieldDefs, $name, $unique);
 894         $this->tableName = $bean->getTableName();
 895         $msg = "Error creating index $name on table: ".$this->tableName. ":";
 896         $this->query($sql,true,$msg);
 897     }
 898
 899     /**
 900      * Adds a new indexes
 901      *
 902      * @param  string $tablename
 903      * @param  array  $indexes   indexes to add
 904      * @param  bool   $execute   true if we want to execute the returned sql statement
 905      * @return string SQL statement
 906      */
 907     public function addIndexes(
 908         $tablename,
 909         $indexes,
 910         $execute = true
 911         )
 912     {
 913         $alters = $this->getHelper()->keysSQL($indexes,true,'ADD');
 914         $sql = "ALTER TABLE $tablename $alters";
 915         if ($execute)
 916             $this->query($sql);
 917         return $sql;
 918     }
 919
 920     /**
 921      * Drops indexes
 922      *
 923      * @param  string $tablename
 924      * @param  array  $indexes   indexes to drop
 925      * @param  bool   $execute   true if we want to execute the returned sql statement
 926      * @return string SQL statement
 927      */
 928     public function dropIndexes(
 929         $tablename,
 930         $indexes,
 931         $execute = true
 932         )
 933     {
 934         $sql = '';
 935         foreach ($indexes as $index) {
 936             $name =$index['name'];
 937             if($execute)
 938                 unset($GLOBALS['table_descriptions'][$tablename]['indexes'][$name]);
 939             if ($index['type'] == 'primary')
 940                 $name = 'PRIMARY KEY';
 941             else
 942                 $name = "INDEX $name";
 943             if (empty($sql))
 944                 $sql .= " DROP $name ";
 945             else
 946                 $sql .= ", DROP $name ";
 947         }
 948         if (!empty($sql)) {
 949             $sql = "ALTER TABLE $tablename $sql";
 950             if($execute)
 951                 $this->query($sql);
 952         }
 953         return $sql;
 954     }
 955
 956     /**
 957      * Modifies indexes
 958      *
 959      * @param  string $tablename
 960      * @param  array  $indexes   indexes to modify
 961      * @param  bool   $execute   true if we want to execute the returned sql statement
 962      * @return string SQL statement
 963      */
 964     public function modifyIndexes(
 965         $tablename,
 966         $indexes,
 967         $execute = true
 968         )
 969     {
 970         return $this->dropIndexes($tablename, $indexes, $execute)."\n".
 971             $this->addIndexes($tablename, $indexes, $execute);
 972     }
 973
 974     /**
 975          * Adds a column to table identified by field def.
 976          *
 977          * @param string $tablename
 978          * @param array  $fieldDefs
 979          */
 980     public function addColumn(
 981         $tablename,
 982         $fieldDefs
 983         )
 984     {
 985         $this->tableName = $tablename;
 986         $sql = $this->getHelper()->addColumnSQL($this->tableName, $fieldDefs);
 987         if ($this->getHelper()->isFieldArray($fieldDefs)){
 988             foreach ($fieldDefs as $fieldDef) $columns[] = $fieldDef['name'];
 989             $columns = implode(",", $columns);
 990         }
 991         else
 992             $columns = $fieldDefs['name'];
 993
 994         $msg = "Error adding column(s) ".$columns." on table: ".$this->tableName. ":";
 995         $this->query($sql,true,$msg);
 996     }
 997
 998     /**
 999          * Alters old column identified by oldFieldDef to new fieldDef.
1000          *
1001          * @param string $tablename
1002      * @param array  $newFieldDef
1003      * @param bool   $ignoreRequired optional, true if we are ignoring this being a required field
1004          */
1005     public function alterColumn(
1006         $tablename,
1007         $newFieldDef,
1008         $ignoreRequired = false
1009         )
1010     {
1011         $this->tableName = $tablename;
1012         $sql = $this->getHelper()->alterColumnSQL($this->tableName, $newFieldDef,$ignoreRequired);
1013         if ($this->getHelper()->isFieldArray($newFieldDef)){
1014             foreach ($newFieldDef as $fieldDef) {
1015                 unset($GLOBALS['table_descriptions'][$tablename][$fieldDef['name']]);
1016                 $columns[] = $fieldDef['name'];
1017             }
1018             $columns = implode(",", $columns);
1019         }
1020         else {
1021             unset($GLOBALS['table_descriptions'][$tablename][$newFieldDef['name']]);
1022             $columns = $newFieldDef['name'];
1023         }
1024
1025         $msg = "Error altering column(s) ".$columns." on table: ".$this->tableName. ":";
1026         $this->query($sql,true,$msg);
1027     }
1028
1029     /**
1030      * Drops the table associated with a bean
1031      *
1032      * @param object $bean SugarBean instance
1033      */
1034     public function dropTable(
1035         SugarBean $bean
1036         )
1037     {
1038         $this->tableName =  $bean->getTableName();
1039         $this->dropTableName( $this->tableName);
1040     }
1041
1042     /**
1043      * Drops the table by name
1044      *
1045      * @param string $name SugarBean instance
1046      */
1047     public function dropTableName(
1048         $name
1049         )
1050     {
1051         $sql = $this->getHelper()->dropTableNameSQL($name);
1052         $msg = "Error dropping table ".$this->tableName. ":";
1053         $this->query($sql,true,$msg);
1054     }
1055
1056     /**
1057      * Deletes a column identified by fieldDef.
1058      *
1059      * @param string $name      SugarBean instance
1060      * @param array  $fieldDefs
1061      */
1062     public function deleteColumn(
1063         SugarBean $bean,
1064         $fieldDefs
1065         )
1066     {
1067         $sql = $this->getHelper()->deleteColumnSQL($bean, $fieldDefs);
1068         $this->tableName = $bean->getTableName();
1069         $msg = "Error deleting column(s) ".$columns." on table: ".$this->tableName. ":";
1070         $this->query($sql,true,$msg);
1071     }
1072
1073     /**
1074          * Fetches all the rows for a select query. Returns FALSE if query failed and
1075          * DB_OK for all other queries
1076      *
1077      * @deprecated
1078      *
1079      * @param  resource $result
1080      * @return array    All rows in result set
1081      */
1082     private function setResult(
1083         $result
1084         )
1085     {
1086         $GLOBALS['log']->info('call to DBManager::setResult() is deprecated');
1087         if (PEAR::isError($result) === true) {
1088             $GLOBALS['log']->error($msg);
1089             $result = FALSE;
1090         }
1091         elseif ($result != DB_OK) {
1092             // must be a result
1093             $GLOBALS['log']->fatal("setResult:".print_r($result,true));
1094             $row = array();
1095             $rows = array();
1096             while (ocifetchinto($result, $row, OCI_ASSOC|OCI_RETURN_NULLS|OCI_RETURN_LOBS)){
1097                 $err = ocierror($result);
1098                 if ($err == false) $rows[] = $row;
1099                 else print_r($err);
1100             }
1101             $result = $rows;
1102         }
1103         $GLOBALS['log']->fatal("setResult: returning rows from setResult");
1104         return $result;
1105     }
1106
1107     /**
1108      * Private function to handle most of the sql statements which go as queries
1109      *
1110      * @deprecated
1111      *
1112      * @param  string   $sql
1113      * @param  int      $start
1114      * @param  int      $count
1115      * @param  boolean  $dieOnError
1116      * @param  string   $msg
1117      * @return array    All rows in result set
1118      */
1119     public function executeLimitQuery(
1120         $query,
1121         $start,
1122         $count,
1123         $dieOnError = false,
1124         $msg = '')
1125     {
1126         $GLOBALS['log']->info('call to DBManager::executeLimitQuery() is deprecated');
1127         $result = $this->limitQuery($query,$start,$count, $dieOnError, $msg);
1128         return $this->setResult($result);
1129     }
1130
1131     /**
1132      * Private function to handle most of the sql statements which go as queries
1133      *
1134      * @deprecated
1135      *
1136      * @param  string $query
1137      * @param  string $msg
1138      * @param  bool   $getRows
1139      * @return array  All rows in result set
1140          */
1141     public function executeQuery(
1142         $query,
1143         $msg,
1144         $getRows = false
1145         )
1146     {
1147         $GLOBALS['log']->info('call to DBManager::executeQuery() is deprecated');
1148         $result = $this->query($query,true,$msg);
1149         if ($getRows)
1150             return $this->setResult($result);
1151         // dd not get rows. Simply go on.
1152         }
1153
1154     /**
1155      * Given a db_type return the correct DBHelper
1156      *
1157      * @deprecated
1158      *
1159      * @param  string $db_type the type of database being used
1160      * @return object DBHelper instance corresponding to the db_type
1161     */
1162     private function configureHelper(
1163         $db_type
1164         )
1165     {
1166         $GLOBALS['log']->info('call to DBManager::configureHelper() is deprecated');
1167         global $sugar_config;
1168
1169         $my_db_helper = 'MysqlHelper';
1170         if( $sugar_config['dbconfig']['db_type'] == "mysql" ) {
1171             if (!isset($sugar_config['mysqli_disabled']) or $sugar_config['mysqli_disabled']==false) {
1172                 if (function_exists('mysqli_connect')) {
1173                     $my_db_helper = 'MysqliHelper';
1174                 }
1175             }
1176         }
1177
1178         if($db_type == "oci8" ){
1179         }else if($db_type == "mssql"){
1180             require_once('include/database/MssqlHelper.php');
1181             $my_db_helper = 'MssqlHelper';
1182         }
1183         if($my_db_helper == 'MysqlHelper'){
1184             require_once('include/database/MysqlHelper.php');
1185         }
1186         return new $my_db_helper();
1187     }
1188
1189     /**
1190      * Generate a set of Insert statements based on the bean given
1191      *
1192      * @deprecated
1193      *
1194      * @param  object $bean         the bean from which table we will generate insert stmts
1195      * @param  string $select_query the query which will give us the set of objects we want to place into our insert statement
1196      * @param  int    $start        the first row to query
1197      * @param  int    $count        the number of rows to query
1198      * @param  string $table        the table to query from
1199      * @param  string $db_type      the client db type
1200      * @return string SQL insert statement
1201      */
1202         public function generateInsertSQL(
1203         SugarBean $bean,
1204         $select_query,
1205         $start,
1206         $count = -1,
1207         $table,
1208         $db_type,
1209         $is_related_query = false
1210         )
1211     {
1212         $GLOBALS['log']->info('call to DBManager::generateInsertSQL() is deprecated');
1213         global $sugar_config;
1214
1215         $count_query = $bean->create_list_count_query($select_query);
1216                 if(!empty($count_query))
1217                 {
1218                         // We have a count query.  Run it and get the results.
1219                         $result = $this->query($count_query, true, "Error running count query for $this->object_name List: ");
1220                         $assoc = $this->fetchByAssoc($result);
1221                         if(!empty($assoc['c']))
1222                         {
1223                                 $rows_found = $assoc['c'];
1224                         }
1225                 }
1226                 if($count == -1){
1227                         $count  = $sugar_config['list_max_entries_per_page'];
1228                 }
1229                 $next_offset = $start + $count;
1230
1231                 $result = $this->limitQuery($select_query, $start, $count);
1232                 $row_count = $this->getRowCount($result);
1233                 // get basic insert
1234                 $sql = "INSERT INTO ".$table;
1235                 $custom_sql = "INSERT INTO ".$table."_cstm";
1236
1237                 // get field definitions
1238                 $fields = $bean->getFieldDefinitions();
1239                 $custom_fields = array();
1240
1241                 if($bean->hasCustomFields()){
1242                         foreach ($fields as $fieldDef){
1243                                 if($fieldDef['source'] == 'custom_fields'){
1244                                         $custom_fields[$fieldDef['name']] = $fieldDef['name'];
1245                                 }
1246                         }
1247                         if(!empty($custom_fields)){
1248                                 $custom_fields['id_c'] = 'id_c';
1249                                 $id_field = array('name' => 'id_c', custom_type => 'id',);
1250                                 $fields[] = $id_field;
1251                         }
1252                 }
1253
1254                 // get column names and values
1255                 $row_array = array();
1256                 $columns = array();
1257                 $cstm_row_array = array();
1258                 $cstm_columns = array();
1259                 $built_columns = false;
1260         //configure client helper
1261         $dbHelper = $this->configureHelper($db_type);
1262                 while(($row = $this->fetchByAssoc($result)) != null)
1263                 {
1264                         $values = array();
1265                         $cstm_values = array();
1266             if(!$is_related_query){
1267                         foreach ($fields as $fieldDef)
1268                         {
1269                                 if(isset($fieldDef['source']) && $fieldDef['source'] != 'db' && $fieldDef['source'] != 'custom_fields') continue;
1270                                 $val = $row[$fieldDef['name']];
1271
1272                                 //handle auto increment values here only need to do this on insert not create
1273                         if ($fieldDef['name'] == 'deleted'){
1274                                          $values['deleted'] = $val;
1275                                          if(!$built_columns){
1276                                         $columns[] = 'deleted';
1277                                 }
1278                                 }
1279                         else
1280                                 {
1281                                         $type = $fieldDef['type'];
1282                                                 if(!empty($fieldDef['custom_type'])){
1283                                                         $type = $fieldDef['custom_type'];
1284                                                 }
1285                                  // need to do some thing about types of values
1286                                                  if($db_type == 'mysql' && $val == '' && ($type == 'datetime' ||  $type == 'date' || $type == 'int' || $type == 'currency' || $type == 'decimal')){
1287                                                         if(!empty($custom_fields[$fieldDef['name']]))
1288                                                                 $cstm_values[$fieldDef['name']] = 'null';
1289                                                         else
1290                                                                 $values[$fieldDef['name']] = 'null';
1291                                                  }else{
1292                                          if(isset($type) && $type=='int') {
1293                                 if(!empty($custom_fields[$fieldDef['name']]))
1294                                         $cstm_values[$fieldDef['name']] = $GLOBALS['db']->quote(from_html($val));
1295                                                 else
1296                                         $values[$fieldDef['name']] = $GLOBALS['db']->quote(from_html($val));
1297                              } else {
1298                                 if(!empty($custom_fields[$fieldDef['name']]))
1299                                         $cstm_values[$fieldDef['name']] = "'".$GLOBALS['db']->quote(from_html($val))."'";
1300                                 else
1301                                         $values[$fieldDef['name']] = "'".$GLOBALS['db']->quote(from_html($val))."'";
1302                              }
1303                                                  }
1304                                 if(!$built_columns){
1305                                         if(!empty($custom_fields[$fieldDef['name']]))
1306                                                                 $cstm_columns[] = $fieldDef['name'];
1307                                                         else
1308                                                 $columns[] = $fieldDef['name'];
1309                                 }
1310                                 }
1311
1312                         }
1313             }else{
1314                foreach ($row as $key=>$val)
1315                {
1316                         if($key != 'orc_row'){
1317                             $values[$key] = "'$val'";
1318                             if(!$built_columns){
1319                                 $columns[] = $key;
1320                             }
1321                         }
1322                }
1323             }
1324                         $built_columns = true;
1325                         if(!empty($values)){
1326                                 $row_array[] = $values;
1327                         }
1328                         if(!empty($cstm_values) && !empty($cstm_values['id_c']) && (strlen($cstm_values['id_c']) > 7)){
1329                                 $cstm_row_array[] = $cstm_values;
1330                         }
1331                 }
1332
1333                 //if (sizeof ($values) == 0) return ""; // no columns set
1334
1335                 // get the entire sql
1336                 $sql .= "(".implode(",", $columns).") ";
1337                 $sql .= "VALUES";
1338                 for($i = 0; $i < count($row_array); $i++){
1339                         $sql .= " (".implode(",", $row_array[$i]).")";
1340                         if($i < (count($row_array) - 1)){
1341                                 $sql .= ", ";
1342                         }
1343                 }
1344                 //custom
1345                 // get the entire sql
1346                 $custom_sql .= "(".implode(",", $cstm_columns).") ";
1347                 $custom_sql .= "VALUES";
1348
1349                 for($i = 0; $i < count($cstm_row_array); $i++){
1350                         $custom_sql .= " (".implode(",", $cstm_row_array[$i]).")";
1351                         if($i < (count($cstm_row_array) - 1)){
1352                                 $custom_sql .= ", ";
1353                         }
1354                 }
1355                 return array('data' => $sql, 'cstm_sql' => $custom_sql, 'result_count' => $row_count, 'total_count' => $rows_found, 'next_offset' => $next_offset);
1356         }
1357
1358     /**
1359      * Disconnects all instances
1360      */
1361     public function disconnectAll()
1362     {
1363         global $dbinstances;
1364
1365         if (!empty($dbinstances)) {
1366             $cur = current($dbinstances);
1367             while ($cur) {
1368                 $cur->disconnect();
1369                 $cur = next($dbinstances);
1370             }
1371         }
1372
1373     }
1374
1375     /**
1376      * This function sets the query threshold limit
1377      *
1378      * @param int $limit value of query threshold limit
1379      */
1380     public static function setQueryLimit($limit){
1381                 //reset the queryCount
1382                 self::$queryCount = 0;
1383
1384                 self::$queryLimit = $limit;
1385     }
1386
1387     /**
1388      * Returns the static queryCount value
1389      *
1390      * @return int value of the queryCount static variable
1391      */
1392     public static function getQueryCount()
1393     {
1394         return self::$queryCount;
1395     }
1396
1397
1398     /**
1399      * Resets the queryCount value to 0
1400      *
1401      */
1402     public static function resetQueryCount() {
1403         self::$queryCount = 0;
1404     }
1405
1406     /**
1407      * This function increments the global $sql_queries variable
1408      *
1409      * @param $sql The SQL statement being counted
1410      */
1411     public function countQuery(
1412         $sql
1413         )
1414     {
1415                 if (self::$queryLimit != 0 && ++self::$queryCount > self::$queryLimit
1416             &&(empty($GLOBALS['current_user']) || !is_admin($GLOBALS['current_user']))) {
1417                    require_once('include/resource/ResourceManager.php');
1418                    $resourceManager = ResourceManager::getInstance();
1419                    $resourceManager->notifyObservers('ERR_QUERY_LIMIT');
1420                 }
1421     }
1422
1423     /**
1424      * Returns a string properly quoted for this database
1425      *
1426      * @param string $string
1427      * @param bool   $isLike
1428      */
1429     public function quote(
1430         $string,
1431         $isLike = true
1432         )
1433     {
1434         return from_html($string);
1435     }
1436
1437     /**
1438      * Returns a string properly quoted for this database that is an email
1439      *
1440      * @param string $string
1441      * @param bool   $isLike
1442      */
1443     abstract public function quoteforEmail(
1444         $string,
1445         $isLike = true
1446         );
1447
1448     /**
1449      * Quote the strings of the passed in array
1450      *
1451      * The array must only contain strings
1452      *
1453      * @param array $array
1454      * @param bool  $isLike
1455      */
1456     public function arrayQuote(
1457         array &$array,
1458         $isLike = true
1459         )
1460     {
1461         for($i = 0; $i < count($array); $i++){
1462             $array[$i] = $this->quote($array[$i], $isLike);
1463         }
1464     }
1465     /**
1466      * Parses and runs queries
1467      *
1468      * @param  string   $sql        SQL Statement to execute
1469      * @param  bool     $dieOnError True if we want to call die if the query returns errors
1470      * @param  string   $msg        Message to log if error occurs
1471      * @param  bool     $suppress   Flag to suppress all error output unless in debug logging mode.
1472      * @return resource result set
1473      */
1474     abstract public function query(
1475         $sql,
1476         $dieOnError = false,
1477         $msg = '',
1478         $suppress = false
1479         );
1480
1481     /**
1482      * Runs a limit query: one where we specify where to start getting records and how many to get
1483      *
1484      * @param  string   $sql
1485      * @param  int      $start
1486      * @param  int      $count
1487      * @param  boolean  $dieOnError
1488      * @param  string   $msg
1489      * @return resource query result
1490      */
1491     abstract function limitQuery(
1492         $sql,
1493         $start,
1494         $count,
1495         $dieOnError = false,
1496         $msg = '');
1497
1498     /**
1499      * Frees out previous results
1500      *
1501      * @param resource $result optional, pass if you want to free a single result instead of all results
1502      */
1503     protected function freeResult(
1504         $result = false
1505         )
1506     {
1507         $free_result = $this->backendFunctions['free_result'];
1508         if(!$result && $this->lastResult){
1509             $result = current($this->lastResult);
1510             while($result){
1511                 $free_result($result);
1512                 $result = next($this->lastResult);
1513             }
1514             $this->lastResult = array();
1515         }
1516         if($result){
1517             $free_result($result);
1518         }
1519     }
1520
1521     /**
1522      * Runs a query and returns a single row
1523      *
1524      * @param  string   $sql        SQL Statement to execute
1525      * @param  bool     $dieOnError True if we want to call die if the query returns errors
1526      * @param  string   $msg        Message to log if error occurs
1527      * @param  bool     $suppress   Message to log if error occurs
1528      * @return array    single row from the query
1529      */
1530     public function getOne(
1531         $sql,
1532         $dieOnError = false,
1533         $msg = '',
1534         $suppress = false
1535         )
1536     {
1537         $GLOBALS['log']->info("Get One: . |$sql|");
1538         $this->checkConnection();
1539         if(!($this instanceof MysqlManager) || stripos($sql, ' LIMIT ') === false) {
1540             $queryresult = $this->limitQuery($sql, 0, 1, $dieOnError, $msg);
1541         } else {
1542             // backward compatibility with queries having LIMIT
1543             $queryresult = $this->query($sql, $dieOnError, $msg);
1544         }
1545         if (!$queryresult)
1546             return false;
1547
1548         $row = $this->fetchByAssoc($queryresult);
1549         if ( !$row )
1550             return false;
1551
1552         $this->checkError($msg.' Get One Failed:' . $sql, $dieOnError);
1553
1554         $this->freeResult($queryresult);
1555         return array_shift($row);
1556     }
1557
1558  /**
1559      * will return the associative array of the row for a query or false if more than one row was returned
1560      *
1561      * @deprecated
1562      *
1563      * @param  string $sql
1564      * @param  bool   $dieonerror
1565      * @param  string $msg
1566      * @param  bool   $encode
1567      * @return array  associative array of the row or false
1568      */
1569     public function requireSingleRow(
1570         $sql,
1571         $dieOnError = false,
1572         $msg = '',
1573         $encode = true
1574         )
1575     {
1576         $GLOBALS['log']->info('call to DBManager::requireSingleRow() is deprecated');
1577         $result = $this->limitQuery($sql,0,2, $dieOnError, $msg);
1578         $count = 0;
1579         $firstRow = false;
1580         while ($row = $this->fetchByAssoc($result)){
1581                 if(!$firstRow)$firstRow = $row;
1582             $count++;
1583         }
1584
1585         if ($count > 1)
1586             return false;
1587
1588         return $firstRow;
1589     }
1590
1591     /**
1592      * Returns the description of fields based on the result
1593      *
1594      * @param  resource $result
1595      * @param  boolean  $make_lower_case
1596      * @return array field array
1597      */
1598     abstract public function getFieldsArray(
1599         &$result,
1600         $make_lower_case = false);
1601
1602     /**
1603      * Returns the number of rows returned by the result
1604      *
1605      * @param  resource $result
1606      * @return int
1607      */
1608     public function getRowCount(
1609         &$result
1610         )
1611     {
1612         $row_count = $this->backendFunctions['row_count'];
1613         if(isset($result) && !empty($result)){
1614             return $row_count($result);
1615                 }
1616                 return 0;
1617         }
1618
1619     /**
1620      * Returns the number of rows affected by the last query
1621      *
1622      * @return int
1623      */
1624     public function getAffectedRowCount()
1625     {
1626         $affected_row_count = $this->backendFunctions['affected_row_count'];
1627         return $affected_row_count($this->getDatabase());
1628     }
1629
1630     /**
1631      * Fetches the next row in the query result into an associative array
1632      *
1633      * @param  resource $result
1634      * @param  int      $rowNum optional, specify a certain row to return
1635      * @param  bool     $encode optional, true if we want html encode the resulting array
1636      * @return array    returns false if there are no more rows available to fetch
1637      */
1638     abstract public function fetchByAssoc(
1639         &$result,
1640         $rowNum = -1,
1641         $encode = true);
1642
1643     /**
1644      * Connects to the database backend
1645      *
1646      * Takes in the database settings and opens a database connection based on those
1647      * will open either a persistent or non-persistent connection.
1648      * If a persistent connection is desired but not available it will defualt to non-persistent
1649      *
1650      * configOptions must include
1651      * db_host_name - server ip
1652      * db_user_name - database user name
1653      * db_password - database password
1654      *
1655      * @param array   $configOptions
1656      * @param boolean $dieOnError
1657      */
1658     abstract public function connect(
1659          array $configOptions = null,
1660          $dieOnError = false
1661          );
1662
1663     /**
1664      * Disconnects from the database
1665      *
1666      * Also handles any cleanup needed
1667      */
1668     public function disconnect()
1669     {
1670         $GLOBALS['log']->debug('Calling DBManager::disconnect()');
1671         $close = $this->backendFunctions['close'];
1672         if(isset($this->database)){
1673             $this->freeResult();
1674             if ( is_resource($this->database) || is_object($this->database) )
1675                                 $close($this->database);
1676             unset($this->database);
1677         }
1678     }
1679
1680     /**
1681      * Returns the field description for a given field in table
1682      *
1683      * @param  string $name
1684      * @param  string $tablename
1685      * @return array
1686      */
1687     protected function describeField(
1688         $name,
1689         $tablename
1690         )
1691     {
1692         global $table_descriptions;
1693         if(isset($table_descriptions[$tablename])
1694                 && isset($table_descriptions[$tablename][$name]))
1695             return      $table_descriptions[$tablename][$name];
1696
1697         $table_descriptions[$tablename] = array();
1698         $table_descriptions[$tablename][$name] = $this->helper->get_columns($tablename);
1699
1700         if(isset($table_descriptions[$tablename][$name]))
1701             return      $table_descriptions[$tablename][$name];
1702
1703         return array();
1704     }
1705
1706     /**
1707      * Returns the index description for a given index in table
1708      *
1709      * @param  string $name
1710      * @param  string $tablename
1711      * @return array
1712      */
1713     protected function describeIndex(
1714         $name,
1715         $tablename
1716         )
1717     {
1718         global $table_descriptions;
1719         if(isset($table_descriptions[$tablename]) && isset($table_descriptions[$tablename]['indexes']) && isset($table_descriptions[$tablename]['indexes'][$name])){
1720             return      $table_descriptions[$tablename]['indexes'][$name];
1721         }
1722
1723         $table_descriptions[$tablename]['indexes'] = array();
1724
1725         $result = $this->helper->get_indices($tablename);
1726
1727                 foreach($result as $index_name => $row) {
1728             if(!isset($table_descriptions[$tablename]['indexes'][$index_name])){
1729                 $table_descriptions[$tablename]['indexes'][$index_name] = array();
1730             }
1731             $table_descriptions[$tablename]['indexes'][$index_name]['Column_name'] = $row;
1732                 }
1733
1734         if(isset($table_descriptions[$tablename]['indexes'][$name])){
1735             return      $table_descriptions[$tablename]['indexes'][$name];
1736         }
1737
1738         return array();
1739     }
1740
1741     /**
1742      * Returns an array of table for this database
1743      *
1744      * @return  $tables         an array of with table names
1745      * @return  false           if no tables found
1746      */
1747     abstract public function getTablesArray();
1748
1749     /**
1750      * Return's the version of the database
1751      *
1752      * @return string
1753      */
1754     abstract public function version();
1755
1756     /**
1757      * Checks if a table with the name $tableName exists
1758      * and returns true if it does or false otherwise
1759      *
1760      * @param  string $tableName
1761      * @return bool
1762      */
1763     abstract public function tableExists($tableName);
1764
1765     /**
1766      * Truncates a string to a given length
1767      *
1768      * @param string $string
1769      * @param int    $len    length to trim to
1770      * @param string
1771      */
1772     public function truncate(
1773         $string,
1774         $len
1775         )
1776     {
1777         if ( is_numeric($len) && $len > 0)
1778         {
1779             $string = mb_substr($string,0,(int) $len, "UTF-8");
1780         }
1781         return $string;
1782     }
1783
1784
1785         /**
1786      * Given a sql stmt attempt to parse it into the sql and the tokens. Then return the index of this prepared statement
1787      * Tokens can come in the following forms:
1788      * ? - a scalar which will be quoted
1789      * ! - a literal which will not be quoted
1790      * & - binary data to read from a file
1791      *
1792      * @param  string   $sql        The sql to parse
1793      * @return int index of the prepared statement to be used with execute
1794      */
1795     public function prepareQuery($sql){
1796         //parse out the tokens
1797         $tokens = preg_split('/((?<!\\\)[&?!])/', $sql, -1, PREG_SPLIT_DELIM_CAPTURE);
1798
1799         //maintain a count of the actual tokens for quick reference in execute
1800         $count = 0;
1801
1802         $sqlStr = '';
1803             foreach ($tokens as $key => $val) {
1804                 switch ($val) {
1805                     case '?' :
1806                     case '!' :
1807                     case '&' :
1808                         $count++;
1809                         $sqlStr .= '?';
1810                         break;
1811
1812                     default :
1813                         //escape any special characters
1814                         $tokens[$key] = preg_replace('/\\\([&?!])/', "\\1", $val);
1815                         $sqlStr .= $tokens[$key];
1816                         break;
1817                 } // switch
1818             } // foreach
1819
1820             $this->preparedTokens[] = array('tokens' => $tokens, 'tokenCount' => $count, 'sqlString' => $sqlStr);
1821             end($this->preparedTokens);
1822             return key($this->preparedTokens);
1823     }
1824
1825     /**
1826      * Takes a prepared stmt index and the data to replace and creates the query and runs it.
1827      *
1828      * @param  int              $stmt       The index of the prepared statement from preparedTokens
1829      * @param  array    $data           The array of data to replace the tokens with.
1830      * @return resource result set or false on error
1831      */
1832     public function executePreparedQuery($stmt, $data = array()){
1833         if(!empty($this->preparedTokens[$stmt])){
1834                 if(!is_array($data)){
1835                                 $data = array($data);
1836                         }
1837
1838                 $pTokens = $this->preparedTokens[$stmt];
1839
1840                 //ensure that the number of data elements matches the number of replacement tokens
1841                 //we found in prepare().
1842                 if(count($data) != $pTokens['tokenCount']){
1843                         //error the data count did not match the token count
1844                         return false;
1845                 }
1846
1847                 $query = '';
1848                 $dataIndex = 0;
1849                 $tokens = $pTokens['tokens'];
1850                 foreach ($tokens as $val) {
1851                 switch ($val) {
1852                         case '?':
1853                                 $query .= $this->quote($data[$dataIndex++]);
1854                                 break;
1855                         case '&':
1856                                 $filename = $data[$dataIndex++];
1857                                         $query .= sugar_file_get_contents($filename);
1858                                 break;
1859                         case '!':
1860                                 $query .= $data[$dataIndex++];
1861                                 break;
1862                         default:
1863                                 $query .= $val;
1864                                 break;
1865                 }//switch
1866                 }//foreach
1867                 return $this->query($query);
1868         }else{
1869                 return false;
1870         }
1871     }
1872
1873     /**
1874      * Run both prepare and execute without the client having to run both individually.
1875      *
1876      * @param  string   $sql        The sql to parse
1877      * @param  array    $data           The array of data to replace the tokens with.
1878      * @return resource result set or false on error
1879      */
1880     public function pQuery($sql, $data = array()){
1881         $stmt = $this->prepareQuery($sql);
1882         return $this->executePreparedQuery($stmt, $data);
1883     }
1884
1885     /**
1886      * Use when you need to convert a database string to a different value; this function does it in a
1887      * database-backend aware way
1888      *
1889      * @param string $string database string to convert
1890      * @param string $type type of conversion to do
1891      * @param array  $additional_parameters optional, additional parameters to pass to the db function
1892      * @param array  $additional_parameters_oracle_only optional, additional parameters to pass to the db function on oracle only
1893      * @return string
1894      */
1895     public function convert(
1896         $string,
1897         $type,
1898         array $additional_parameters = array(),
1899         array $additional_parameters_oracle_only = array()
1900         )
1901     {
1902         return "$string";
1903     }
1904
1905     /**
1906      * Returns the database string needed for concatinating multiple database strings together
1907      *
1908      * @param string $table table name of the database fields to concat
1909      * @param array $fields fields in the table to concat together
1910      * @return string
1911      */
1912     abstract public function concat(
1913         $table,
1914         array $fields
1915         );
1916
1917     /**
1918      * Undoes database conversion
1919      *
1920      * @param string $string database string to convert
1921      * @param string $type type of conversion to do
1922      * @return string
1923      */
1924     public function fromConvert(
1925         $string,
1926         $type)
1927     {
1928         return $string;
1929     }
1930 }
1931
1932 ?>