include/database/MysqlManager.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-2012 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  * MySQL manager implementation for mysql extension
  93  */
  94 class MysqlManager extends DBManager
  95 {
  96         /**
  97          * @see DBManager::$dbType
  98          */
  99         public $dbType = 'mysql';
 100         public $variant = 'mysql';
 101         public $dbName = 'MySQL';
 102         public $label = 'LBL_MYSQL';
 103
 104         protected $maxNameLengths = array(
 105                 'table' => 64,
 106                 'column' => 64,
 107                 'index' => 64,
 108                 'alias' => 256
 109         );
 110
 111         protected $type_map = array(
 112                         'int'      => 'int',
 113                         'double'   => 'double',
 114                         'float'    => 'float',
 115                         'uint'     => 'int unsigned',
 116                         'ulong'    => 'bigint unsigned',
 117                         'long'     => 'bigint',
 118                         'short'    => 'smallint',
 119                         'varchar'  => 'varchar',
 120                         'text'     => 'text',
 121                         'longtext' => 'longtext',
 122                         'date'     => 'date',
 123                         'enum'     => 'varchar',
 124                         'relate'   => 'varchar',
 125                         'multienum'=> 'text',
 126                         'html'     => 'text',
 127                         'longhtml' => 'longtext',
 128                         'datetime' => 'datetime',
 129                         'datetimecombo' => 'datetime',
 130                         'time'     => 'time',
 131                         'bool'     => 'bool',
 132                         'tinyint'  => 'tinyint',
 133                         'char'     => 'char',
 134                         'blob'     => 'blob',
 135                         'longblob' => 'longblob',
 136                         'currency' => 'decimal(26,6)',
 137                         'decimal'  => 'decimal',
 138                         'decimal2' => 'decimal',
 139                         'id'       => 'char(36)',
 140                         'url'      => 'varchar',
 141                         'encrypt'  => 'varchar',
 142                         'file'     => 'varchar',
 143                         'decimal_tpl' => 'decimal(%d, %d)',
 144
 145         );
 146
 147         protected $capabilities = array(
 148                 "affected_rows" => true,
 149                 "select_rows" => true,
 150                 "inline_keys" => true,
 151                 "create_user" => true,
 152                 "fulltext" => true,
 153             "collation" => true,
 154             "create_db" => true,
 155             "disable_keys" => true,
 156         );
 157
 158         /**
 159          * Parses and runs queries
 160          *
 161          * @param  string   $sql        SQL Statement to execute
 162          * @param  bool     $dieOnError True if we want to call die if the query returns errors
 163          * @param  string   $msg        Message to log if error occurs
 164          * @param  bool     $suppress   Flag to suppress all error output unless in debug logging mode.
 165          * @param  bool     $keepResult True if we want to push this result into the $lastResult array.
 166          * @return resource result set
 167          */
 168         public function query($sql, $dieOnError = false, $msg = '', $suppress = false, $keepResult = false)
 169         {
 170                 if(is_array($sql)) {
 171                         return $this->queryArray($sql, $dieOnError, $msg, $suppress);
 172                 }
 173
 174                 parent::countQuery($sql);
 175                 $GLOBALS['log']->info('Query:' . $sql);
 176                 $this->checkConnection();
 177                 $this->query_time = microtime(true);
 178                 $this->lastsql = $sql;
 179                 $result = $suppress?@mysql_query($sql, $this->database):mysql_query($sql, $this->database);
 180
 181                 $this->query_time = microtime(true) - $this->query_time;
 182                 $GLOBALS['log']->info('Query Execution Time:'.$this->query_time);
 183
 184
 185                 if($keepResult)
 186                         $this->lastResult = $result;
 187
 188                 $this->checkError($msg.' Query Failed:' . $sql . '::', $dieOnError);
 189                 return $result;
 190         }
 191
 192     /**
 193      * Returns the number of rows affected by the last query
 194      * @param $result
 195      * @return int
 196      */
 197         public function getAffectedRowCount($result)
 198         {
 199                 return mysql_affected_rows($this->getDatabase());
 200         }
 201
 202         /**
 203          * Returns the number of rows returned by the result
 204          *
 205          * This function can't be reliably implemented on most DB, do not use it.
 206          * @abstract
 207          * @deprecated
 208          * @param  resource $result
 209          * @return int
 210          */
 211         public function getRowCount($result)
 212         {
 213             return mysql_num_rows($result);
 214         }
 215
 216         /**
 217          * Disconnects from the database
 218          *
 219          * Also handles any cleanup needed
 220          */
 221         public function disconnect()
 222         {
 223                 $GLOBALS['log']->debug('Calling MySQL::disconnect()');
 224                 if(!empty($this->database)){
 225                         $this->freeResult();
 226                         mysql_close($this->database);
 227                         $this->database = null;
 228                 }
 229         }
 230
 231         /**
 232          * @see DBManager::freeDbResult()
 233          */
 234         protected function freeDbResult($dbResult)
 235         {
 236                 if(!empty($dbResult))
 237                         mysql_free_result($dbResult);
 238         }
 239
 240
 241         /**
 242          * @abstract
 243          * Check if query has LIMIT clause
 244          * Relevant for now only for Mysql
 245          * @param string $sql
 246          * @return bool
 247          */
 248         protected function hasLimit($sql)
 249         {
 250             return stripos($sql, " limit ") !== false;
 251         }
 252
 253         /**
 254          * @see DBManager::limitQuery()
 255          */
 256         public function limitQuery($sql, $start, $count, $dieOnError = false, $msg = '', $execute = true)
 257         {
 258         $start = (int)$start;
 259         $count = (int)$count;
 260             if ($start < 0)
 261                         $start = 0;
 262                 $GLOBALS['log']->debug('Limit Query:' . $sql. ' Start: ' .$start . ' count: ' . $count);
 263
 264             $sql = "$sql LIMIT $start,$count";
 265                 $this->lastsql = $sql;
 266
 267                 if(!empty($GLOBALS['sugar_config']['check_query'])){
 268                         $this->checkQuery($sql);
 269                 }
 270                 if(!$execute) {
 271                         return $sql;
 272                 }
 273
 274                 return $this->query($sql, $dieOnError, $msg);
 275         }
 276
 277
 278         /**
 279          * @see DBManager::checkQuery()
 280          */
 281         protected function checkQuery($sql)
 282         {
 283                 $result   = $this->query('EXPLAIN ' . $sql);
 284                 $badQuery = array();
 285                 while ($row = $this->fetchByAssoc($result)) {
 286                         if (empty($row['table']))
 287                                 continue;
 288                         $badQuery[$row['table']] = '';
 289                         if (strtoupper($row['type']) == 'ALL')
 290                                 $badQuery[$row['table']]  .=  ' Full Table Scan;';
 291                         if (empty($row['key']))
 292                                 $badQuery[$row['table']] .= ' No Index Key Used;';
 293                         if (!empty($row['Extra']) && substr_count($row['Extra'], 'Using filesort') > 0)
 294                                 $badQuery[$row['table']] .= ' Using FileSort;';
 295                         if (!empty($row['Extra']) && substr_count($row['Extra'], 'Using temporary') > 0)
 296                                 $badQuery[$row['table']] .= ' Using Temporary Table;';
 297                 }
 298
 299                 if ( empty($badQuery) )
 300                         return true;
 301
 302                 foreach($badQuery as $table=>$data ){
 303                         if(!empty($data)){
 304                                 $warning = ' Table:' . $table . ' Data:' . $data;
 305                                 if(!empty($GLOBALS['sugar_config']['check_query_log'])){
 306                                         $GLOBALS['log']->fatal($sql);
 307                                         $GLOBALS['log']->fatal('CHECK QUERY:' .$warning);
 308                                 }
 309                                 else{
 310                                         $GLOBALS['log']->warn('CHECK QUERY:' .$warning);
 311                                 }
 312                         }
 313                 }
 314
 315                 return false;
 316         }
 317
 318         /**
 319          * @see DBManager::get_columns()
 320          */
 321         public function get_columns($tablename)
 322         {
 323                 //find all unique indexes and primary keys.
 324                 $result = $this->query("DESCRIBE $tablename");
 325
 326                 $columns = array();
 327                 while (($row=$this->fetchByAssoc($result)) !=null) {
 328                         $name = strtolower($row['Field']);
 329                         $columns[$name]['name']=$name;
 330                         $matches = array();
 331                         preg_match_all('/(\w+)(?:\(([0-9]+,?[0-9]*)\)|)( unsigned)?/i', $row['Type'], $matches);
 332                         $columns[$name]['type']=strtolower($matches[1][0]);
 333                         if ( isset($matches[2][0]) && in_array(strtolower($matches[1][0]),array('varchar','char','varchar2','int','decimal','float')) )
 334                                 $columns[$name]['len']=strtolower($matches[2][0]);
 335                         if ( stristr($row['Extra'],'auto_increment') )
 336                                 $columns[$name]['auto_increment'] = '1';
 337                         if ($row['Null'] == 'NO' && !stristr($row['Key'],'PRI'))
 338                                 $columns[$name]['required'] = 'true';
 339                         if (!empty($row['Default']) )
 340                                 $columns[$name]['default'] = $row['Default'];
 341                 }
 342                 return $columns;
 343         }
 344
 345         /**
 346          * @see DBManager::getFieldsArray()
 347          */
 348         public function getFieldsArray($result, $make_lower_case=false)
 349         {
 350                 $field_array = array();
 351
 352                 if(empty($result))
 353                         return 0;
 354
 355                 $fields = mysql_num_fields($result);
 356                 for ($i=0; $i < $fields; $i++) {
 357                         $meta = mysql_fetch_field($result, $i);
 358                         if (!$meta)
 359                                 return array();
 360
 361                         if($make_lower_case == true)
 362                                 $meta->name = strtolower($meta->name);
 363
 364                         $field_array[] = $meta->name;
 365                 }
 366
 367                 return $field_array;
 368         }
 369
 370         /**
 371          * @see DBManager::fetchRow()
 372          */
 373         public function fetchRow($result)
 374         {
 375                 if (empty($result))     return false;
 376
 377                 return mysql_fetch_assoc($result);
 378         }
 379
 380         /**
 381          * @see DBManager::getTablesArray()
 382          */
 383         public function getTablesArray()
 384         {
 385                 $this->log->debug('Fetching table list');
 386
 387                 if ($this->getDatabase()) {
 388                         $tables = array();
 389                         $r = $this->query('SHOW TABLES');
 390                         if (!empty($r)) {
 391                                 while ($a = $this->fetchByAssoc($r)) {
 392                                         $row = array_values($a);
 393                                         $tables[]=$row[0];
 394                                 }
 395                                 return $tables;
 396                         }
 397                 }
 398
 399                 return false; // no database available
 400         }
 401
 402         /**
 403          * @see DBManager::version()
 404          */
 405         public function version()
 406         {
 407                 return $this->getOne("SELECT version() version");
 408         }
 409
 410         /**
 411          * @see DBManager::tableExists()
 412          */
 413         public function tableExists($tableName)
 414         {
 415                 $this->log->info("tableExists: $tableName");
 416
 417                 if ($this->getDatabase()) {
 418                         $result = $this->query("SHOW TABLES LIKE ".$this->quoted($tableName));
 419                         if(empty($result)) return false;
 420                         $row = $this->fetchByAssoc($result);
 421                         return !empty($row);
 422                 }
 423
 424                 return false;
 425         }
 426
 427         /**
 428          * Get tables like expression
 429          * @param $like string
 430          * @return array
 431          */
 432         public function tablesLike($like)
 433         {
 434                 if ($this->getDatabase()) {
 435                         $tables = array();
 436                         $r = $this->query('SHOW TABLES LIKE '.$this->quoted($like));
 437                         if (!empty($r)) {
 438                                 while ($a = $this->fetchByAssoc($r)) {
 439                                         $row = array_values($a);
 440                                         $tables[]=$row[0];
 441                                 }
 442                                 return $tables;
 443                         }
 444                 }
 445                 return false;
 446         }
 447
 448         /**
 449          * @see DBManager::quote()
 450          */
 451         public function quote($string)
 452         {
 453                 if(is_array($string)) {
 454                         return $this->arrayQuote($string);
 455                 }
 456                 return mysql_real_escape_string($this->quoteInternal($string), $this->getDatabase());
 457         }
 458
 459         /**
 460          * @see DBManager::connect()
 461          */
 462         public function connect(array $configOptions = null, $dieOnError = false)
 463         {
 464                 global $sugar_config;
 465
 466                 if(is_null($configOptions))
 467                         $configOptions = $sugar_config['dbconfig'];
 468
 469                 if ($this->getOption('persistent')) {
 470                         $this->database = @mysql_pconnect(
 471                                 $configOptions['db_host_name'],
 472                                 $configOptions['db_user_name'],
 473                                 $configOptions['db_password']
 474                                 );
 475                 }
 476
 477                 if (!$this->database) {
 478                         $this->database = mysql_connect(
 479                                         $configOptions['db_host_name'],
 480                                         $configOptions['db_user_name'],
 481                                         $configOptions['db_password']
 482                                         );
 483                         if(empty($this->database)) {
 484                                 $GLOBALS['log']->fatal("Could not connect to server ".$configOptions['db_host_name']." as ".$configOptions['db_user_name'].":".mysql_error());
 485                                 if($dieOnError) {
 486                                         if(isset($GLOBALS['app_strings']['ERR_NO_DB'])) {
 487                                                 sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
 488                                         } else {
 489                                                 sugar_die("Could not connect to the database. Please refer to sugarcrm.log for details.");
 490                                         }
 491                                 } else {
 492                                         return false;
 493                                 }
 494                         }
 495                         // Do not pass connection information because we have not connected yet
 496                         if($this->database  && $this->getOption('persistent')){
 497                                 $_SESSION['administrator_error'] = "<b>Severe Performance Degradation: Persistent Database Connections "
 498                                         . "not working.  Please set \$sugar_config['dbconfigoption']['persistent'] to false "
 499                                         . "in your config.php file</b>";
 500                         }
 501                 }
 502                 if(!empty($configOptions['db_name']) && !@mysql_select_db($configOptions['db_name'])) {
 503                         $GLOBALS['log']->fatal( "Unable to select database {$configOptions['db_name']}: " . mysql_error($this->database));
 504                         if($dieOnError) {
 505                                 sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
 506                         } else {
 507                                 return false;
 508                         }
 509                 }
 510
 511                 // cn: using direct calls to prevent this from spamming the Logs
 512             mysql_query("SET CHARACTER SET utf8", $this->database);
 513             $names = "SET NAMES 'utf8'";
 514             $collation = $this->getOption('collation');
 515             if(!empty($collation)) {
 516                 $names .= " COLLATE '$collation'";
 517                 }
 518             mysql_query($names, $this->database);
 519
 520                 if(!$this->checkError('Could Not Connect:', $dieOnError))
 521                         $GLOBALS['log']->info("connected to db");
 522                 $this->connectOptions = $configOptions;
 523
 524                 $GLOBALS['log']->info("Connect:".$this->database);
 525                 return true;
 526         }
 527
 528         /**
 529          * @see DBManager::repairTableParams()
 530          *
 531          * For MySQL, we can write the ALTER TABLE statement all in one line, which speeds things
 532          * up quite a bit. So here, we'll parse the returned SQL into a single ALTER TABLE command.
 533          */
 534         public function repairTableParams($tablename, $fielddefs, $indices, $execute = true, $engine = null)
 535         {
 536                 $sql = parent::repairTableParams($tablename,$fielddefs,$indices,false,$engine);
 537
 538                 if ( $sql == '' )
 539                         return '';
 540
 541                 if ( stristr($sql,'create table') )
 542                 {
 543                         if ($execute) {
 544                                 $msg = "Error creating table: ".$tablename. ":";
 545                                 $this->query($sql,true,$msg);
 546                         }
 547                         return $sql;
 548                 }
 549
 550                 // first, parse out all the comments
 551                 $match = array();
 552                 preg_match_all('!/\*.*?\*/!is', $sql, $match);
 553                 $commentBlocks = $match[0];
 554                 $sql = preg_replace('!/\*.*?\*/!is','', $sql);
 555
 556                 // now, we should only have alter table statements
 557                 // let's replace the 'alter table name' part with a comma
 558                 $sql = preg_replace("!alter table $tablename!is",', ', $sql);
 559
 560                 // re-add it at the beginning
 561                 $sql = substr_replace($sql,'',strpos($sql,','),1);
 562                 $sql = str_replace(";","",$sql);
 563                 $sql = str_replace("\n","",$sql);
 564                 $sql = "ALTER TABLE $tablename $sql";
 565
 566                 if ( $execute )
 567                         $this->query($sql,'Error with MySQL repair table');
 568
 569                 // and re-add the comments at the beginning
 570                 $sql = implode("\n",$commentBlocks) . "\n". $sql . "\n";
 571
 572                 return $sql;
 573         }
 574
 575         /**
 576          * @see DBManager::convert()
 577          */
 578         public function convert($string, $type, array $additional_parameters = array())
 579         {
 580                 $all_parameters = $additional_parameters;
 581                 if(is_array($string)) {
 582                         $all_parameters = array_merge($string, $all_parameters);
 583                 } elseif (!is_null($string)) {
 584                         array_unshift($all_parameters, $string);
 585                 }
 586                 $all_strings = implode(',', $all_parameters);
 587
 588                 switch (strtolower($type)) {
 589                         case 'today':
 590                                 return "CURDATE()";
 591                         case 'left':
 592                                 return "LEFT($all_strings)";
 593                         case 'date_format':
 594                                 if(empty($additional_parameters)) {
 595                                         return "DATE_FORMAT($string,'%Y-%m-%d')";
 596                                 } else {
 597                                         $format = $additional_parameters[0];
 598                                         if($format[0] != "'") {
 599                                                 $format = $this->quoted($format);
 600                                         }
 601                                         return "DATE_FORMAT($string,$format)";
 602                                 }
 603                         case 'ifnull':
 604                                 if(empty($additional_parameters) && !strstr($all_strings, ",")) {
 605                                         $all_strings .= ",''";
 606                                 }
 607                                 return "IFNULL($all_strings)";
 608                         case 'concat':
 609                                 return "CONCAT($all_strings)";
 610                         case 'quarter':
 611                                         return "QUARTER($string)";
 612                         case "length":
 613                                         return "LENGTH($string)";
 614                         case 'month':
 615                                         return "MONTH($string)";
 616                         case 'add_date':
 617                                         return "DATE_ADD($string, INTERVAL {$additional_parameters[0]} {$additional_parameters[1]})";
 618                         case 'add_time':
 619                                         return "DATE_ADD($string, INTERVAL + CONCAT({$additional_parameters[0]}, ':', {$additional_parameters[1]}) HOUR_MINUTE)";
 620                 }
 621
 622                 return $string;
 623         }
 624
 625         /**
 626          * (non-PHPdoc)
 627          * @see DBManager::fromConvert()
 628          */
 629         public function fromConvert($string, $type)
 630         {
 631                 return $string;
 632         }
 633
 634         /**
 635          * Returns the name of the engine to use or null if we are to use the default
 636          *
 637          * @param  object $bean SugarBean instance
 638          * @return string
 639          */
 640         protected function getEngine($bean)
 641         {
 642                 global $dictionary;
 643                 $engine = null;
 644                 if (isset($dictionary[$bean->getObjectName()]['engine'])) {
 645                         $engine = $dictionary[$bean->getObjectName()]['engine'];
 646                 }
 647                 return $engine;
 648         }
 649
 650         /**
 651          * Returns true if the engine given is enabled in the backend
 652          *
 653          * @param  string $engine
 654          * @return bool
 655          */
 656         protected function isEngineEnabled($engine)
 657         {
 658                 if(!is_string($engine)) return false;
 659
 660                 $engine = strtoupper($engine);
 661
 662                 $r = $this->query("SHOW ENGINES");
 663
 664                 while ( $row = $this->fetchByAssoc($r) )
 665                         if ( strtoupper($row['Engine']) == $engine )
 666                                 return ($row['Support']=='YES' || $row['Support']=='DEFAULT');
 667
 668                 return false;
 669         }
 670
 671         /**
 672          * @see DBManager::createTableSQL()
 673          */
 674         public function createTableSQL(SugarBean $bean)
 675         {
 676                 $tablename = $bean->getTableName();
 677                 $fieldDefs = $bean->getFieldDefinitions();
 678                 $indices   = $bean->getIndices();
 679                 $engine    = $this->getEngine($bean);
 680                 return $this->createTableSQLParams($tablename, $fieldDefs, $indices, $engine);
 681         }
 682
 683         /**
 684          * Generates sql for create table statement for a bean.
 685          *
 686          * @param  string $tablename
 687          * @param  array  $fieldDefs
 688          * @param  array  $indices
 689          * @param  string $engine optional, MySQL engine to use
 690          * @return string SQL Create Table statement
 691         */
 692         public function createTableSQLParams($tablename, $fieldDefs, $indices, $engine = null)
 693         {
 694                 if ( empty($engine) && isset($fieldDefs['engine']))
 695                         $engine = $fieldDefs['engine'];
 696                 if ( !$this->isEngineEnabled($engine) )
 697                         $engine = '';
 698
 699                 $columns = $this->columnSQLRep($fieldDefs, false, $tablename);
 700                 if (empty($columns))
 701                         return false;
 702
 703                 $keys = $this->keysSQL($indices);
 704                 if (!empty($keys))
 705                         $keys = ",$keys";
 706
 707                 // cn: bug 9873 - module tables do not get created in utf8 with assoc collation
 708                 $collation = $this->getOption('collation');
 709                 if(empty($collation)) {
 710                     $collation = 'utf8_general_ci';
 711                 }
 712                 $sql = "CREATE TABLE $tablename ($columns $keys) CHARACTER SET utf8 COLLATE $collation";
 713
 714                 if (!empty($engine))
 715                         $sql.= " ENGINE=$engine";
 716
 717                 return $sql;
 718         }
 719
 720     /**
 721      * Does this type represent text (i.e., non-varchar) value?
 722      * @param string $type
 723      */
 724     public function isTextType($type)
 725     {
 726         $type = $this->getColumnType(strtolower($type));
 727         return in_array($type, array('blob','text','longblob', 'longtext'));
 728     }
 729
 730         /**
 731          * @see DBManager::oneColumnSQLRep()
 732          */
 733         protected function oneColumnSQLRep($fieldDef, $ignoreRequired = false, $table = '', $return_as_array = false)
 734         {
 735                 // always return as array for post-processing
 736                 $ref = parent::oneColumnSQLRep($fieldDef, $ignoreRequired, $table, true);
 737
 738                 if ( $ref['colType'] == 'int' && !empty($fieldDef['len']) ) {
 739                         $ref['colType'] .= "(".$fieldDef['len'].")";
 740                 }
 741
 742                 // bug 22338 - don't set a default value on text or blob fields
 743                 if ( isset($ref['default']) &&
 744             in_array($ref['colBaseType'], array('text', 'blob', 'longtext', 'longblob')))
 745                             $ref['default'] = '';
 746
 747                 if ( $return_as_array )
 748                         return $ref;
 749                 else
 750                         return "{$ref['name']} {$ref['colType']} {$ref['default']} {$ref['required']} {$ref['auto_increment']}";
 751         }
 752
 753         /**
 754          * @see DBManager::changeColumnSQL()
 755          */
 756         protected function changeColumnSQL($tablename, $fieldDefs, $action, $ignoreRequired = false)
 757         {
 758                 $columns = array();
 759                 if ($this->isFieldArray($fieldDefs)){
 760                         foreach ($fieldDefs as $def){
 761                                 if ($action == 'drop')
 762                                         $columns[] = $def['name'];
 763                                 else
 764                                         $columns[] = $this->oneColumnSQLRep($def, $ignoreRequired);
 765                         }
 766                 } else {
 767                         if ($action == 'drop')
 768                                 $columns[] = $fieldDefs['name'];
 769                 else
 770                         $columns[] = $this->oneColumnSQLRep($fieldDefs);
 771                 }
 772
 773                 return "ALTER TABLE $tablename $action COLUMN ".implode(",$action column ", $columns);
 774         }
 775
 776         /**
 777          * Generates SQL for key specification inside CREATE TABLE statement
 778          *
 779          * The passes array is an array of field definitions or a field definition
 780          * itself. The keys generated will be either primary, foreign, unique, index
 781          * or none at all depending on the setting of the "key" parameter of a field definition
 782          *
 783          * @param  array  $indices
 784          * @param  bool   $alter_table
 785          * @param  string $alter_action
 786          * @return string SQL Statement
 787          */
 788         protected function keysSQL($indices, $alter_table = false, $alter_action = '')
 789         {
 790         // check if the passed value is an array of fields.
 791         // if not, convert it into an array
 792         if (!$this->isFieldArray($indices))
 793                 $indices[] = $indices;
 794
 795         $columns = array();
 796         foreach ($indices as $index) {
 797                 if(!empty($index['db']) && $index['db'] != $this->dbType)
 798                         continue;
 799                 if (isset($index['source']) && $index['source'] != 'db')
 800                         continue;
 801
 802                 $type = $index['type'];
 803                 $name = $index['name'];
 804
 805                 if (is_array($index['fields']))
 806                         $fields = implode(", ", $index['fields']);
 807                 else
 808                         $fields = $index['fields'];
 809
 810                 switch ($type) {
 811                 case 'unique':
 812                         $columns[] = " UNIQUE $name ($fields)";
 813                         break;
 814                 case 'primary':
 815                         $columns[] = " PRIMARY KEY ($fields)";
 816                         break;
 817                 case 'index':
 818                 case 'foreign':
 819                 case 'clustered':
 820                 case 'alternate_key':
 821                         /**
 822                                 * @todo here it is assumed that the primary key of the foreign
 823                                 * table will always be named 'id'. It must be noted though
 824                                 * that this can easily be fixed by referring to db dictionary
 825                                 * to find the correct primary field name
 826                                 */
 827                         if ( $alter_table )
 828                                 $columns[] = " INDEX $name ($fields)";
 829                         else
 830                                 $columns[] = " KEY $name ($fields)";
 831                         break;
 832                 case 'fulltext':
 833                         if ($this->full_text_indexing_installed())
 834                                 $columns[] = " FULLTEXT ($fields)";
 835                         else
 836                                 $GLOBALS['log']->debug('MYISAM engine is not available/enabled, full-text indexes will be skipped. Skipping:',$name);
 837                         break;
 838                 }
 839         }
 840         $columns = implode(", $alter_action ", $columns);
 841         if(!empty($alter_action)){
 842                 $columns = $alter_action . ' '. $columns;
 843         }
 844         return $columns;
 845         }
 846
 847         /**
 848          * @see DBManager::setAutoIncrement()
 849          */
 850         protected function setAutoIncrement($table, $field_name)
 851         {
 852                 return "auto_increment";
 853         }
 854
 855         /**
 856          * Sets the next auto-increment value of a column to a specific value.
 857          *
 858          * @param  string $table tablename
 859          * @param  string $field_name
 860          */
 861         public function setAutoIncrementStart($table, $field_name, $start_value)
 862         {
 863                 $start_value = (int)$start_value;
 864                 return $this->query( "ALTER TABLE $table AUTO_INCREMENT = $start_value;");
 865         }
 866
 867         /**
 868          * Returns the next value for an auto increment
 869          *
 870          * @param  string $table tablename
 871          * @param  string $field_name
 872          * @return string
 873          */
 874         public function getAutoIncrement($table, $field_name)
 875         {
 876                 $result = $this->query("SHOW TABLE STATUS LIKE '$table'");
 877                 $row = $this->fetchByAssoc($result);
 878                 if (!empty($row['Auto_increment']))
 879                         return $row['Auto_increment'];
 880
 881                 return "";
 882         }
 883
 884         /**
 885          * @see DBManager::get_indices()
 886          */
 887         public function get_indices($tablename)
 888         {
 889                 //find all unique indexes and primary keys.
 890                 $result = $this->query("SHOW INDEX FROM $tablename");
 891
 892                 $indices = array();
 893                 while (($row=$this->fetchByAssoc($result)) !=null) {
 894                         $index_type='index';
 895                         if ($row['Key_name'] =='PRIMARY') {
 896                                 $index_type='primary';
 897                         }
 898                         elseif ( $row['Non_unique'] == '0' ) {
 899                                 $index_type='unique';
 900                         }
 901                         $name = strtolower($row['Key_name']);
 902                         $indices[$name]['name']=$name;
 903                         $indices[$name]['type']=$index_type;
 904                         $indices[$name]['fields'][]=strtolower($row['Column_name']);
 905                 }
 906                 return $indices;
 907         }
 908
 909         /**
 910          * @see DBManager::add_drop_constraint()
 911          */
 912         public function add_drop_constraint($table, $definition, $drop = false)
 913         {
 914                 $type         = $definition['type'];
 915                 $fields       = implode(',',$definition['fields']);
 916                 $name         = $definition['name'];
 917                 $sql          = '';
 918
 919                 switch ($type){
 920                 // generic indices
 921                 case 'index':
 922                 case 'alternate_key':
 923                 case 'clustered':
 924                         if ($drop)
 925                                 $sql = "ALTER TABLE {$table} DROP INDEX {$name} ";
 926                         else
 927                                 $sql = "ALTER TABLE {$table} ADD INDEX {$name} ({$fields})";
 928                         break;
 929                 // constraints as indices
 930                 case 'unique':
 931                         if ($drop)
 932                                 $sql = "ALTER TABLE {$table} DROP INDEX $name";
 933                         else
 934                                 $sql = "ALTER TABLE {$table} ADD CONSTRAINT UNIQUE {$name} ({$fields})";
 935                         break;
 936                 case 'primary':
 937                         if ($drop)
 938                                 $sql = "ALTER TABLE {$table} DROP PRIMARY KEY";
 939                         else
 940                                 $sql = "ALTER TABLE {$table} ADD CONSTRAINT PRIMARY KEY ({$fields})";
 941                         break;
 942                 case 'foreign':
 943                         if ($drop)
 944                                 $sql = "ALTER TABLE {$table} DROP FOREIGN KEY ({$fields})";
 945                         else
 946                                 $sql = "ALTER TABLE {$table} ADD CONSTRAINT FOREIGN KEY {$name} ({$fields}) REFERENCES {$definition['foreignTable']}({$definition['foreignField']})";
 947                         break;
 948                 }
 949                 return $sql;
 950         }
 951
 952         /**
 953          * Runs a query and returns a single row
 954          *
 955          * @param  string   $sql        SQL Statement to execute
 956          * @param  bool     $dieOnError True if we want to call die if the query returns errors
 957          * @param  string   $msg        Message to log if error occurs
 958          * @param  bool     $suppress   Message to log if error occurs
 959          * @return array    single row from the query
 960          */
 961         public function fetchOne($sql, $dieOnError = false, $msg = '', $suppress = false)
 962         {
 963                 if(stripos($sql, ' LIMIT ') === false) {
 964                         // little optimization to just fetch one row
 965                         $sql .= " LIMIT 0,1";
 966                 }
 967                 return parent::fetchOne($sql, $dieOnError, $msg, $suppress);
 968         }
 969
 970         /**
 971          * @see DBManager::full_text_indexing_installed()
 972          */
 973         public function full_text_indexing_installed($dbname = null)
 974         {
 975                 return $this->isEngineEnabled('MyISAM');
 976         }
 977
 978         /**
 979          * @see DBManager::massageFieldDef()
 980          */
 981         public function massageFieldDef(&$fieldDef, $tablename)
 982         {
 983                 parent::massageFieldDef($fieldDef,$tablename);
 984
 985                 if ( isset($fieldDef['default']) &&
 986                         ($fieldDef['dbType'] == 'text'
 987                                 || $fieldDef['dbType'] == 'blob'
 988                                 || $fieldDef['dbType'] == 'longtext'
 989                                 || $fieldDef['dbType'] == 'longblob' ))
 990                         unset($fieldDef['default']);
 991                 if ($fieldDef['dbType'] == 'uint')
 992                         $fieldDef['len'] = '10';
 993                 if ($fieldDef['dbType'] == 'ulong')
 994                         $fieldDef['len'] = '20';
 995                 if ($fieldDef['dbType'] == 'bool')
 996                         $fieldDef['type'] = 'tinyint';
 997                 if ($fieldDef['dbType'] == 'bool' && empty($fieldDef['default']) )
 998                         $fieldDef['default'] = '0';
 999                 if (($fieldDef['dbType'] == 'varchar' || $fieldDef['dbType'] == 'enum') && empty($fieldDef['len']) )
1000                         $fieldDef['len'] = '255';
1001                 if ($fieldDef['dbType'] == 'uint')
1002                         $fieldDef['len'] = '10';
1003                 if ($fieldDef['dbType'] == 'int' && empty($fieldDef['len']) )
1004                         $fieldDef['len'] = '11';
1005
1006                 if($fieldDef['dbType'] == 'decimal') {
1007                         if(isset($fieldDef['len'])) {
1008                                 if(strstr($fieldDef['len'], ",") === false) {
1009                                         $fieldDef['len'] .= ",0";
1010                                 }
1011                         } else {
1012                                 $fieldDef['len']  = '10,0';
1013                         }
1014                 }
1015         }
1016
1017         /**
1018          * Generates SQL for dropping a table.
1019          *
1020          * @param  string $name table name
1021          * @return string SQL statement
1022          */
1023         public function dropTableNameSQL($name)
1024         {
1025                 return "DROP TABLE IF EXISTS ".$name;
1026         }
1027
1028         public function dropIndexes($tablename, $indexes, $execute = true)
1029         {
1030                 $sql = array();
1031                 foreach ($indexes as $index) {
1032                         $name =$index['name'];
1033                         if($execute) {
1034                         unset(self::$index_descriptions[$tablename][$name]);
1035                         }
1036                         if ($index['type'] == 'primary') {
1037                                 $sql[] = 'DROP PRIMARY KEY';
1038                         } else {
1039                                 $sql[] = "DROP INDEX $name";
1040                         }
1041                 }
1042                 if (!empty($sql)) {
1043                         $sql = "ALTER TABLE $tablename ".join(",", $sql);
1044                         if($execute)
1045                                 $this->query($sql);
1046                 } else {
1047                         $sql = '';
1048                 }
1049                 return $sql;
1050         }
1051
1052         /**
1053          * List of available collation settings
1054          * @return string
1055          */
1056         public function getDefaultCollation()
1057         {
1058                 return "utf8_general_ci";
1059         }
1060
1061         /**
1062          * List of available collation settings
1063          * @return array
1064          */
1065         public function getCollationList()
1066         {
1067                 $q = "SHOW COLLATION LIKE 'utf8%'";
1068                 $r = $this->query($q);
1069                 $res = array();
1070                 while($a = $this->fetchByAssoc($r)) {
1071                         $res[] = $a['Collation'];
1072                 }
1073                 return $res;
1074         }
1075
1076         /**
1077          * (non-PHPdoc)
1078          * @see DBManager::renameColumnSQL()
1079          */
1080         public function renameColumnSQL($tablename, $column, $newname)
1081         {
1082                 $field = $this->describeField($column, $tablename);
1083                 $field['name'] = $newname;
1084                 return "ALTER TABLE $tablename CHANGE COLUMN $column ".$this->oneColumnSQLRep($field);
1085         }
1086
1087         public function emptyValue($type)
1088         {
1089                 $ctype = $this->getColumnType($type);
1090                 if($ctype == "datetime") {
1091                         return $this->convert($this->quoted("0000-00-00 00:00:00"), "datetime");
1092                 }
1093                 if($ctype == "date") {
1094                         return $this->convert($this->quoted("0000-00-00"), "date");
1095                 }
1096                 if($ctype == "time") {
1097                         return $this->convert($this->quoted("00:00:00"), "time");
1098                 }
1099                 return parent::emptyValue($type);
1100         }
1101
1102         /**
1103          * (non-PHPdoc)
1104          * @see DBManager::lastDbError()
1105          */
1106         public function lastDbError()
1107         {
1108                 if($this->database) {
1109                     if(mysql_errno($this->database)) {
1110                             return "MySQL error ".mysql_errno($this->database).": ".mysql_error($this->database);
1111                     }
1112                 } else {
1113                         $err =  mysql_error();
1114                         if($err) {
1115                             return $err;
1116                         }
1117                 }
1118         return false;
1119     }
1120
1121         /**
1122          * Quote MySQL search term
1123          * @param unknown_type $term
1124          */
1125         protected function quoteTerm($term)
1126         {
1127                 if(strpos($term, ' ') !== false) {
1128                         return '"'.$term.'"';
1129                 }
1130                 return $term;
1131         }
1132
1133         /**
1134          * Generate fulltext query from set of terms
1135          * @param string $fields Field to search against
1136          * @param array $terms Search terms that may be or not be in the result
1137          * @param array $must_terms Search terms that have to be in the result
1138          * @param array $exclude_terms Search terms that have to be not in the result
1139          */
1140         public function getFulltextQuery($field, $terms, $must_terms = array(), $exclude_terms = array())
1141         {
1142                 $condition = array();
1143                 foreach($terms as $term) {
1144                         $condition[] = $this->quoteTerm($term);
1145                 }
1146                 foreach($must_terms as $term) {
1147                         $condition[] = "+".$this->quoteTerm($term);
1148                 }
1149                 foreach($exclude_terms as $term) {
1150                         $condition[] = "-".$this->quoteTerm($term);
1151                 }
1152                 $condition = $this->quoted(join(" ",$condition));
1153                 return "MATCH($field) AGAINST($condition IN BOOLEAN MODE)";
1154         }
1155
1156         /**
1157          * Get list of all defined charsets
1158          * @return array
1159          */
1160         protected function getCharsetInfo()
1161         {
1162                 $charsets = array();
1163                 $res = $this->query("show variables like 'character\\_set\\_%'");
1164                 while($row = $this->fetchByAssoc($res)) {
1165                         $charsets[$row['Variable_name']] = $row['Value'];
1166                 }
1167                 return $charsets;
1168         }
1169
1170         public function getDbInfo()
1171         {
1172                 $charsets = $this->getCharsetInfo();
1173                 $charset_str = array();
1174                 foreach($charsets as $name => $value) {
1175                         $charset_str[] = "$name = $value";
1176                 }
1177                 return array(
1178                         "MySQL Version" => @mysql_get_client_info(),
1179                         "MySQL Host Info" => @mysql_get_host_info($this->database),
1180                         "MySQL Server Info" => @mysql_get_server_info($this->database),
1181                         "MySQL Client Encoding" =>  @mysql_client_encoding($this->database),
1182                         "MySQL Character Set Settings" => join(", ", $charset_str),
1183                 );
1184         }
1185
1186         public function validateQuery($query)
1187         {
1188                 $res = $this->query("EXPLAIN $query");
1189                 return !empty($res);
1190         }
1191
1192         protected function makeTempTableCopy($table)
1193         {
1194                 $this->log->debug("creating temp table for [$table]...");
1195                 $result = $this->query("SHOW CREATE TABLE {$table}");
1196                 if(empty($result)) {
1197                         return false;
1198                 }
1199                 $row = $this->fetchByAssoc($result);
1200                 if(empty($row) || empty($row['Create Table'])) {
1201                     return false;
1202                 }
1203                 $create = $row['Create Table'];
1204                 // rewrite DDL with _temp name
1205                 $tempTableQuery = str_replace("CREATE TABLE `{$table}`", "CREATE TABLE `{$table}__uw_temp`", $create);
1206                 $r2 = $this->query($tempTableQuery);
1207                 if(empty($r2)) {
1208                         return false;
1209                 }
1210
1211                 // get sample data into the temp table to test for data/constraint conflicts
1212                 $this->log->debug('inserting temp dataset...');
1213                 $q3 = "INSERT INTO `{$table}__uw_temp` SELECT * FROM `{$table}` LIMIT 10";
1214                 $this->query($q3, false, "Preflight Failed for: {$q3}");
1215                 return true;
1216         }
1217
1218         /**
1219          * Tests an ALTER TABLE query
1220          * @param string table The table name to get DDL
1221          * @param string query The query to test.
1222          * @return string Non-empty if error found
1223          */
1224         protected function verifyAlterTable($table, $query)
1225         {
1226                 $this->log->debug("verifying ALTER TABLE");
1227                 // Skipping ALTER TABLE [table] DROP PRIMARY KEY because primary keys are not being copied
1228                 // over to the temp tables
1229                 if(strpos(strtoupper($query), 'DROP PRIMARY KEY') !== false) {
1230                         $this->log->debug("Skipping DROP PRIMARY KEY");
1231                         return '';
1232                 }
1233                 if(!$this->makeTempTableCopy($table)) {
1234                         return 'Could not create temp table copy';
1235                 }
1236
1237                 // test the query on the test table
1238                 $this->log->debug('testing query: ['.$query.']');
1239                 $tempTableTestQuery = str_replace("ALTER TABLE `{$table}`", "ALTER TABLE `{$table}__uw_temp`", $query);
1240                 if (strpos($tempTableTestQuery, 'idx') === false) {
1241                         if(strpos($tempTableTestQuery, '__uw_temp') === false) {
1242                                 return 'Could not use a temp table to test query!';
1243                         }
1244
1245                         $this->log->debug('testing query on temp table: ['.$tempTableTestQuery.']');
1246                         $this->query($tempTableTestQuery, false, "Preflight Failed for: {$query}");
1247                 } else {
1248                         // test insertion of an index on a table
1249                         $tempTableTestQuery_idx = str_replace("ADD INDEX `idx_", "ADD INDEX `temp_idx_", $tempTableTestQuery);
1250                         $this->log->debug('testing query on temp table: ['.$tempTableTestQuery_idx.']');
1251                         $this->query($tempTableTestQuery_idx, false, "Preflight Failed for: {$query}");
1252                 }
1253                 $mysqlError = $this->getL();
1254                 if(!empty($mysqlError)) {
1255                         return $mysqlError;
1256                 }
1257                 $this->dropTableName("{$table}__uw_temp");
1258
1259                 return '';
1260         }
1261
1262         protected function verifyGenericReplaceQuery($querytype, $table, $query)
1263         {
1264                 $this->log->debug("verifying $querytype statement");
1265
1266                 if(!$this->makeTempTableCopy($table)) {
1267                         return 'Could not create temp table copy';
1268                 }
1269                 // test the query on the test table
1270                 $this->log->debug('testing query: ['.$query.']');
1271                 $tempTableTestQuery = str_replace("$querytype `{$table}`", "$querytype `{$table}__uw_temp`", $query);
1272                 if(strpos($tempTableTestQuery, '__uw_temp') === false) {
1273                         return 'Could not use a temp table to test query!';
1274                 }
1275
1276                 $this->query($tempTableTestQuery, false, "Preflight Failed for: {$query}");
1277                 $error = $this->lastError(); // empty on no-errors
1278                 $this->dropTableName("{$table}__uw_temp"); // just in case
1279                 return $error;
1280         }
1281
1282         /**
1283          * Tests a DROP TABLE query
1284          * @param string table The table name to get DDL
1285          * @param string query The query to test.
1286          * @return string Non-empty if error found
1287          */
1288         public function verifyDropTable($table, $query)
1289         {
1290                 return $this->verifyGenericReplaceQuery("DROP TABLE", $table, $query);
1291         }
1292
1293         /**
1294          * Tests an INSERT INTO query
1295          * @param string table The table name to get DDL
1296          * @param string query The query to test.
1297          * @return string Non-empty if error found
1298          */
1299         public function verifyInsertInto($table, $query)
1300         {
1301                 return $this->verifyGenericReplaceQuery("INSERT INTO", $table, $query);
1302         }
1303
1304         /**
1305          * Tests an UPDATE query
1306          * @param string table The table name to get DDL
1307          * @param string query The query to test.
1308          * @return string Non-empty if error found
1309          */
1310         public function verifyUpdate($table, $query)
1311         {
1312                 return $this->verifyGenericReplaceQuery("UPDATE", $table, $query);
1313         }
1314
1315         /**
1316          * Tests an DELETE FROM query
1317          * @param string table The table name to get DDL
1318          * @param string query The query to test.
1319          * @return string Non-empty if error found
1320          */
1321         public function verifyDeleteFrom($table, $query)
1322         {
1323                 return $this->verifyGenericReplaceQuery("DELETE FROM", $table, $query);
1324         }
1325
1326         /**
1327          * Check if certain database exists
1328          * @param string $dbname
1329          */
1330         public function dbExists($dbname)
1331         {
1332                 $db = $this->getOne("SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = ".$this->quoted($dbname));
1333                 return !empty($db);
1334         }
1335
1336         /**
1337          * Select database
1338          * @param string $dbname
1339          */
1340         protected function selectDb($dbname)
1341         {
1342                 return mysql_select_db($dbname);
1343         }
1344
1345         /**
1346          * Check if certain DB user exists
1347          * @param string $username
1348          */
1349         public function userExists($username)
1350         {
1351                 $db = $this->getOne("SELECT DATABASE()");
1352                 if(!$this->selectDb("mysql")) {
1353                         return false;
1354                 }
1355                 $user = $this->getOne("select count(*) from user where user = ".$this->quoted($username));
1356                 if(!$this->selectDb($db)) {
1357                         $this->checkError("Cannot select database $db", true);
1358                 }
1359                 return !empty($user);
1360         }
1361
1362         /**
1363          * Create DB user
1364          * @param string $database_name
1365          * @param string $host_name
1366          * @param string $user
1367          * @param string $password
1368          */
1369         public function createDbUser($database_name, $host_name, $user, $password)
1370         {
1371                 $qpassword = $this->quote($password);
1372                 $this->query("GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, INDEX
1373                                                         ON `$database_name`.*
1374                                                         TO \"$user\"@\"$host_name\"
1375                                                         IDENTIFIED BY '{$qpassword}';", true);
1376
1377                 $this->query("SET PASSWORD FOR \"{$user}\"@\"{$host_name}\" = password('{$qpassword}');", true);
1378                 if($host_name != 'localhost') {
1379                         $this->createDbUser($database_name, "localhost", $user, $password);
1380                 }
1381         }
1382
1383         /**
1384          * Create a database
1385          * @param string $dbname
1386          */
1387         public function createDatabase($dbname)
1388         {
1389                 $this->query("CREATE DATABASE `$dbname` CHARACTER SET utf8 COLLATE utf8_general_ci", true);
1390         }
1391
1392         public function preInstall()
1393         {
1394                 $db->query("ALTER DATABASE `{$setup_db_database_name}` DEFAULT CHARACTER SET utf8", true);
1395                 $db->query("ALTER DATABASE `{$setup_db_database_name}` DEFAULT COLLATE utf8_general_ci", true);
1396
1397         }
1398
1399         /**
1400          * Drop a database
1401          * @param string $dbname
1402          */
1403         public function dropDatabase($dbname)
1404         {
1405                 return $this->query("DROP DATABASE IF EXISTS `$dbname`", true);
1406         }
1407
1408         /**
1409          * Check if this driver can be used
1410          * @return bool
1411          */
1412         public function valid()
1413         {
1414                 return function_exists("mysql_connect");
1415         }
1416
1417         /**
1418          * Check DB version
1419          * @see DBManager::canInstall()
1420          */
1421         public function canInstall()
1422         {
1423                 $db_version = $this->version();
1424                 if(empty($db_version)) {
1425                         return array('ERR_DB_VERSION_FAILURE');
1426                 }
1427                 if(version_compare($db_version, '4.1.2') < 0) {
1428                         return array('ERR_DB_MYSQL_VERSION', $db_version);
1429                 }
1430                 return true;
1431         }
1432
1433         public function installConfig()
1434         {
1435                 return array(
1436                         'LBL_DBCONFIG_MSG3' =>  array(
1437                                 "setup_db_database_name" => array("label" => 'LBL_DBCONF_DB_NAME', "required" => true),
1438                         ),
1439                         'LBL_DBCONFIG_MSG2' =>  array(
1440                                 "setup_db_host_name" => array("label" => 'LBL_DBCONF_HOST_NAME', "required" => true),
1441                         ),
1442                         'LBL_DBCONF_TITLE_USER_INFO' => array(),
1443                         'LBL_DBCONFIG_B_MSG1' => array(
1444                                 "setup_db_admin_user_name" => array("label" => 'LBL_DBCONF_DB_ADMIN_USER', "required" => true),
1445                                 "setup_db_admin_password" => array("label" => 'LBL_DBCONF_DB_ADMIN_PASSWORD', "type" => "password"),
1446                         )
1447                 );
1448         }
1449
1450         /**
1451          * Disable keys on the table
1452          * @abstract
1453          * @param string $tableName
1454          */
1455         public function disableKeys($tableName)
1456         {
1457             return $this->query('ALTER TABLE '.$tableName.' DISABLE KEYS');
1458         }
1459
1460         /**
1461          * Re-enable keys on the table
1462          * @abstract
1463          * @param string $tableName
1464          */
1465         public function enableKeys($tableName)
1466         {
1467             return $this->query('ALTER TABLE '.$tableName.' ENABLE KEYS');
1468         }
1469
1470     /**
1471      * Returns a DB specific FROM clause which can be used to select against functions.
1472      * Note that depending on the database that this may also be an empty string.
1473      * @return string
1474      */
1475     public function getFromDummyTable()
1476     {
1477         return '';
1478     }
1479
1480     /**
1481      * Returns a DB specific piece of SQL which will generate GUID (UUID)
1482      * This string can be used in dynamic SQL to do multiple inserts with a single query.
1483      * I.e. generate a unique Sugar id in a sub select of an insert statement.
1484      * @return string
1485      */
1486         public function getGuidSQL()
1487     {
1488         return 'UUID()';
1489     }
1490 }