include/database/MssqlManager.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  * SQL Server (mssql) manager
  93  */
  94 class MssqlManager extends DBManager
  95 {
  96     /**
  97      * @see DBManager::$dbType
  98      */
  99     public $dbType = 'mssql';
 100     public $dbName = 'MsSQL';
 101     public $variant = 'mssql';
 102     public $label = 'LBL_MSSQL';
 103
 104     protected $capabilities = array(
 105         "affected_rows" => true,
 106         "select_rows" => true,
 107         'fulltext' => true,
 108         'limit_subquery' => true,
 109         "fix:expandDatabase" => true, // Support expandDatabase fix
 110         "create_user" => true,
 111         "create_db" => true,
 112     );
 113
 114     /**
 115      * Maximum length of identifiers
 116      */
 117     protected $maxNameLengths = array(
 118         'table' => 128,
 119         'column' => 128,
 120         'index' => 128,
 121         'alias' => 128
 122     );
 123
 124     protected $type_map = array(
 125             'int'      => 'int',
 126             'double'   => 'float',
 127             'float'    => 'float',
 128             'uint'     => 'int',
 129             'ulong'    => 'int',
 130             'long'     => 'bigint',
 131             'short'    => 'smallint',
 132             'varchar'  => 'varchar',
 133             'text'     => 'text',
 134             'longtext' => 'text',
 135             'date'     => 'datetime',
 136             'enum'     => 'varchar',
 137             'relate'   => 'varchar',
 138             'multienum'=> 'text',
 139             'html'     => 'text',
 140                         'longhtml' => 'text',
 141                 'datetime' => 'datetime',
 142             'datetimecombo' => 'datetime',
 143             'time'     => 'datetime',
 144             'bool'     => 'bit',
 145             'tinyint'  => 'tinyint',
 146             'char'     => 'char',
 147             'blob'     => 'image',
 148             'longblob' => 'image',
 149             'currency' => 'decimal(26,6)',
 150             'decimal'  => 'decimal',
 151             'decimal2' => 'decimal',
 152             'id'       => 'varchar(36)',
 153             'url'      => 'varchar',
 154             'encrypt'  => 'varchar',
 155             'file'     => 'varchar',
 156                 'decimal_tpl' => 'decimal(%d, %d)',
 157             );
 158
 159     protected $connectOptions = null;
 160
 161     /**
 162      * @see DBManager::connect()
 163      */
 164     public function connect(array $configOptions = null, $dieOnError = false)
 165     {
 166         global $sugar_config;
 167
 168         if (is_null($configOptions))
 169             $configOptions = $sugar_config['dbconfig'];
 170
 171         //SET DATEFORMAT to 'YYYY-MM-DD''
 172         ini_set('mssql.datetimeconvert', '0');
 173
 174         //set the text size and textlimit to max number so that blob columns are not truncated
 175         ini_set('mssql.textlimit','2147483647');
 176         ini_set('mssql.textsize','2147483647');
 177         ini_set('mssql.charset','UTF-8');
 178
 179         if(!empty($configOptions['db_host_instance'])) {
 180             $configOptions['db_host_instance'] = trim($configOptions['db_host_instance']);
 181         }
 182         //set the connections parameters
 183         if (empty($configOptions['db_host_instance'])) {
 184             $connect_param = $configOptions['db_host_name'];
 185         } else {
 186             $connect_param = $configOptions['db_host_name']."\\".$configOptions['db_host_instance'];
 187         }
 188
 189         //create persistent connection
 190         if ($this->getOption('persistent')) {
 191             $this->database =@mssql_pconnect(
 192                 $connect_param ,
 193                 $configOptions['db_user_name'],
 194                 $configOptions['db_password']
 195                 );
 196         }
 197         //if no persistent connection created, then create regular connection
 198         if(!$this->database){
 199             $this->database = mssql_connect(
 200                     $connect_param ,
 201                     $configOptions['db_user_name'],
 202                     $configOptions['db_password']
 203                     );
 204             if(!$this->database){
 205                 $GLOBALS['log']->fatal("Could not connect to server ".$configOptions['db_host_name'].
 206                     " as ".$configOptions['db_user_name'].".");
 207                 if($dieOnError) {
 208                     sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
 209                 } else {
 210                     return false;
 211                 }
 212             }
 213             if($this->database && $this->getOption('persistent')){
 214                 $_SESSION['administrator_error'] = "<B>Severe Performance Degradation: Persistent Database Connections "
 215                     . "not working.  Please set \$sugar_config['dbconfigoption']['persistent'] to false in your "
 216                     . "config.php file</B>";
 217             }
 218         }
 219         //make sure connection exists
 220         if(!$this->database) {
 221                 if($dieOnError) {
 222                     sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
 223                 } else {
 224                     return false;
 225                 }
 226         }
 227
 228         //select database
 229
 230         //Adding sleep and retry for mssql connection. We have come across scenarios when
 231         //an error is thrown.' Unable to select database'. Following will try to connect to
 232         //mssql db maximum number of 5 times at the interval of .2 second. If can not connect
 233         //it will throw an Unable to select database message.
 234
 235         if(!empty($configOptions['db_name']) && !@mssql_select_db($configOptions['db_name'], $this->database)){
 236                         $connected = false;
 237                         for($i=0;$i<5;$i++){
 238                                 usleep(200000);
 239                                 if(@mssql_select_db($configOptions['db_name'], $this->database)){
 240                                         $connected = true;
 241                                         break;
 242                                 }
 243                         }
 244                         if(!$connected){
 245                             $GLOBALS['log']->fatal( "Unable to select database {$configOptions['db_name']}");
 246                 if($dieOnError) {
 247                     if(isset($GLOBALS['app_strings']['ERR_NO_DB'])) {
 248                         sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
 249                     } else {
 250                         sugar_die("Could not connect to the database. Please refer to sugarcrm.log for details.");
 251                     }
 252                 } else {
 253                     return false;
 254                 }
 255                         }
 256          }
 257
 258         if(!$this->checkError('Could Not Connect', $dieOnError))
 259             $GLOBALS['log']->info("connected to db");
 260
 261         $this->connectOptions = $configOptions;
 262
 263         $GLOBALS['log']->info("Connect:".$this->database);
 264         return true;
 265     }
 266
 267         /**
 268      * @see DBManager::version()
 269      */
 270     public function version()
 271     {
 272         return $this->getOne("SELECT @@VERSION as version");
 273         }
 274
 275         /**
 276      * @see DBManager::query()
 277          */
 278         public function query($sql, $dieOnError = false, $msg = '', $suppress = false, $keepResult = false)
 279     {
 280         if(is_array($sql)) {
 281             return $this->queryArray($sql, $dieOnError, $msg, $suppress);
 282         }
 283         // Flag if there are odd number of single quotes
 284         if ((substr_count($sql, "'") & 1))
 285             $GLOBALS['log']->error("SQL statement[" . $sql . "] has odd number of single quotes.");
 286
 287                 $sql = $this->_appendN($sql);
 288
 289         $GLOBALS['log']->info('Query:' . $sql);
 290         $this->checkConnection();
 291         $this->countQuery($sql);
 292         $this->query_time = microtime(true);
 293
 294         // Bug 34892 - Clear out previous error message by checking the @@ERROR global variable
 295                 @mssql_query("SELECT @@ERROR", $this->database);
 296
 297         $result = $suppress?@mssql_query($sql, $this->database):mssql_query($sql, $this->database);
 298
 299         if (!$result) {
 300             // awu Bug 10657: ignoring mssql error message 'Changed database context to' - an intermittent
 301             //                            and difficult to reproduce error. The message is only a warning, and does
 302             //                            not affect the functionality of the query
 303             $sqlmsg = mssql_get_last_message();
 304             $sqlpos = strpos($sqlmsg, 'Changed database context to');
 305                         $sqlpos2 = strpos($sqlmsg, 'Warning:');
 306                         $sqlpos3 = strpos($sqlmsg, 'Checking identity information:');
 307
 308                         if ($sqlpos !== false || $sqlpos2 !== false || $sqlpos3 !== false)              // if sqlmsg has 'Changed database context to', just log it
 309                                 $GLOBALS['log']->debug($sqlmsg . ": " . $sql );
 310                         else {
 311                                 $GLOBALS['log']->fatal($sqlmsg . ": " . $sql );
 312                                 if($dieOnError)
 313                                         sugar_die('SQL Error : ' . $sqlmsg);
 314                                 else
 315                                         echo 'SQL Error : ' . $sqlmsg;
 316                         }
 317         }
 318
 319         $this->query_time = microtime(true) - $this->query_time;
 320         $GLOBALS['log']->info('Query Execution Time:'.$this->query_time);
 321
 322
 323         $this->checkError($msg.' Query Failed: ' . $sql, $dieOnError);
 324
 325         return $result;
 326     }
 327
 328     /**
 329      * This function take in the sql for a union query, the start and offset,
 330      * and wraps it around an "mssql friendly" limit query
 331      *
 332      * @param  string $sql
 333      * @param  int    $start record to start at
 334      * @param  int    $count number of records to retrieve
 335      * @return string SQL statement
 336      */
 337     private function handleUnionLimitQuery($sql, $start, $count)
 338     {
 339         //set the start to 0, no negs
 340         if ($start < 0)
 341             $start=0;
 342
 343         $GLOBALS['log']->debug(print_r(func_get_args(),true));
 344
 345         $this->lastsql = $sql;
 346
 347         //change the casing to lower for easier string comparison, and trim whitespaces
 348         $sql = strtolower(trim($sql)) ;
 349
 350         //set default sql
 351         $limitUnionSQL = $sql;
 352         $order_by_str = 'order by';
 353
 354         //make array of order by's.  substring approach was proving too inconsistent
 355         $orderByArray = explode($order_by_str, $sql);
 356         $unionOrderBy = '';
 357         $rowNumOrderBy = '';
 358
 359         //count the number of array elements
 360         $unionOrderByCount = count($orderByArray);
 361         $arr_count = 0;
 362
 363         //process if there are elements
 364         if ($unionOrderByCount){
 365             //we really want the last order by, so reconstruct string
 366             //adding a 1 to count, as we dont wish to process the last element
 367             $unionsql = '';
 368             while ($unionOrderByCount>$arr_count+1) {
 369                 $unionsql .= $orderByArray[$arr_count];
 370                 $arr_count = $arr_count+1;
 371                 //add an "order by" string back if we are coming into loop again
 372                 //remember they were taken out when array was created
 373                 if ($unionOrderByCount>$arr_count+1) {
 374                     $unionsql .= "order by";
 375                 }
 376             }
 377             //grab the last order by element, set both order by's'
 378             $unionOrderBy = $orderByArray[$arr_count];
 379             $rowNumOrderBy = $unionOrderBy;
 380
 381             //if last element contains a "select", then this is part of the union query,
 382             //and there is no order by to use
 383             if (strpos($unionOrderBy, "select")) {
 384                 $unionsql = $sql;
 385                 //with no guidance on what to use for required order by in rownumber function,
 386                 //resort to using name column.
 387                 $rowNumOrderBy = 'id';
 388                 $unionOrderBy = "";
 389             }
 390         }
 391         else {
 392             //there are no order by elements, so just pass back string
 393             $unionsql = $sql;
 394             //with no guidance on what to use for required order by in rownumber function,
 395             //resort to using name column.
 396             $rowNumOrderBy = 'id';
 397             $unionOrderBy = '';
 398         }
 399         //Unions need the column name being sorted on to match across all queries in Union statement
 400         //so we do not want to strip the alias like in other queries.  Just add the "order by" string and
 401         //pass column name as is
 402         if ($unionOrderBy != '') {
 403             $unionOrderBy = ' order by ' . $unionOrderBy;
 404         }
 405
 406         //if start is 0, then just use a top query
 407         if($start == 0) {
 408             $limitUnionSQL = "SELECT TOP $count * FROM (" .$unionsql .") as top_count ".$unionOrderBy;
 409         } else {
 410             //if start is more than 0, then use top query in conjunction
 411             //with rownumber() function to create limit query.
 412             $limitUnionSQL = "SELECT TOP $count * FROM( select ROW_NUMBER() OVER ( order by "
 413             .$rowNumOrderBy.") AS row_number, * FROM ("
 414             .$unionsql .") As numbered) "
 415             . "As top_count_limit WHERE row_number > $start "
 416             .$unionOrderBy;
 417         }
 418
 419         return $limitUnionSQL;
 420     }
 421
 422         /**
 423          * FIXME: verify and thoroughly test this code, these regexps look fishy
 424      * @see DBManager::limitQuery()
 425      */
 426     public function limitQuery($sql, $start, $count, $dieOnError = false, $msg = '', $execute = true)
 427     {
 428         $start = (int)$start;
 429         $count = (int)$count;
 430         $newSQL = $sql;
 431         $distinctSQLARRAY = array();
 432         if (strpos($sql, "UNION") && !preg_match("/(')(UNION).?(')/i", $sql))
 433             $newSQL = $this->handleUnionLimitQuery($sql,$start,$count);
 434         else {
 435             if ($start < 0)
 436                 $start = 0;
 437             $GLOBALS['log']->debug(print_r(func_get_args(),true));
 438             $this->lastsql = $sql;
 439             $matches = array();
 440             preg_match('/^(.*SELECT )(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
 441             if (!empty($matches[3])) {
 442                 if ($start == 0) {
 443                     $match_two = strtolower($matches[2]);
 444                     if (!strpos($match_two, "distinct")> 0 && strpos($match_two, "distinct") !==0) {
 445                                         //proceed as normal
 446                         $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
 447                     }
 448                     else {
 449                         $distinct_o = strpos($match_two, "distinct");
 450                         $up_to_distinct_str = substr($match_two, 0, $distinct_o);
 451                         //check to see if the distinct is within a function, if so, then proceed as normal
 452                         if (strpos($up_to_distinct_str,"(")) {
 453                             //proceed as normal
 454                             $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
 455                         }
 456                         else {
 457                             //if distinct is not within a function, then parse
 458                             //string contains distinct clause, "TOP needs to come after Distinct"
 459                             //get position of distinct
 460                             $match_zero = strtolower($matches[0]);
 461                             $distinct_pos = strpos($match_zero , "distinct");
 462                             //get position of where
 463                             $where_pos = strpos($match_zero, "where");
 464                             //parse through string
 465                             $beg = substr($matches[0], 0, $distinct_pos+9 );
 466                             $mid = substr($matches[0], strlen($beg), ($where_pos+5) - (strlen($beg)));
 467                             $end = substr($matches[0], strlen($beg) + strlen($mid) );
 468                             //repopulate matches array
 469                             $matches[1] = $beg; $matches[2] = $mid; $matches[3] = $end;
 470
 471                             $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
 472                         }
 473                     }
 474                 } else {
 475                     $orderByMatch = array();
 476                     preg_match('/^(.*)(ORDER BY)(.*)$/is',$matches[3], $orderByMatch);
 477
 478                     //if there is a distinct clause, parse sql string as we will have to insert the rownumber
 479                     //for paging, AFTER the distinct clause
 480                     $grpByStr = '';
 481                     $hasDistinct = strpos(strtolower($matches[0]), "distinct");
 482                     if ($hasDistinct) {
 483                         $matches_sql = strtolower($matches[0]);
 484                         //remove reference to distinct and select keywords, as we will use a group by instead
 485                         //we need to use group by because we are introducing rownumber column which would make every row unique
 486
 487                         //take out the select and distinct from string so we can reuse in group by
 488                         $dist_str = ' distinct ';
 489                         $distinct_pos = strpos($matches_sql, $dist_str);
 490                         $matches_sql = substr($matches_sql,$distinct_pos+ strlen($dist_str));
 491                         //get the position of where and from for further processing
 492                         $from_pos = strpos($matches_sql , " from ");
 493                         $where_pos = strpos($matches_sql, "where");
 494                         //split the sql into a string before and after the from clause
 495                         //we will use the columns being selected to construct the group by clause
 496                         if ($from_pos>0 ) {
 497                             $distinctSQLARRAY[0] = substr($matches_sql,0, $from_pos+1);
 498                             $distinctSQLARRAY[1] = substr($matches_sql,$from_pos+1);
 499                             //get position of order by (if it exists) so we can strip it from the string
 500                             $ob_pos = strpos($distinctSQLARRAY[1], "order by");
 501                             if ($ob_pos) {
 502                                 $distinctSQLARRAY[1] = substr($distinctSQLARRAY[1],0,$ob_pos);
 503                             }
 504
 505                             // strip off last closing parentheses from the where clause
 506                             $distinctSQLARRAY[1] = preg_replace('/\)\s$/',' ',$distinctSQLARRAY[1]);
 507                         }
 508
 509                         //place group by string into array
 510                         $grpByArr = explode(',', $distinctSQLARRAY[0]);
 511                         $first = true;
 512                         //remove the aliases for each group by element, sql server doesnt like these in group by.
 513                         foreach ($grpByArr as $gb) {
 514                             $gb = trim($gb);
 515
 516                             //clean out the extra stuff added if we are concatenating first_name and last_name together
 517                             //this way both fields are added in correctly to the group by
 518                             $gb = str_replace("isnull(","",$gb);
 519                             $gb = str_replace("'') + ' ' + ","",$gb);
 520
 521                             //remove outer reference if they exist
 522                             if (strpos($gb,"'")!==false){
 523                                 continue;
 524                             }
 525                             //if there is a space, then an alias exists, remove alias
 526                             if (strpos($gb,' ')){
 527                                 $gb = substr( $gb, 0,strpos($gb,' '));
 528                             }
 529
 530                             //if resulting string is not empty then add to new group by string
 531                             if (!empty($gb)) {
 532                                 if ($first) {
 533                                     $grpByStr .= " $gb";
 534                                     $first = false;
 535                                 } else {
 536                                     $grpByStr .= ", $gb";
 537                                 }
 538                             }
 539                         }
 540                     }
 541
 542                     if (!empty($orderByMatch[3])) {
 543                         //if there is a distinct clause, form query with rownumber after distinct
 544                         if ($hasDistinct) {
 545                             $newSQL = "SELECT TOP $count * FROM
 546                                         (
 547                                             SELECT ROW_NUMBER()
 548                                                 OVER (ORDER BY ".$this->returnOrderBy($sql, $orderByMatch[3]).") AS row_number,
 549                                                 count(*) counter, " . $distinctSQLARRAY[0] . "
 550                                                 " . $distinctSQLARRAY[1] . "
 551                                                 group by " . $grpByStr . "
 552                                         ) AS a
 553                                         WHERE row_number > $start";
 554                         }
 555                         else {
 556                         $newSQL = "SELECT TOP $count * FROM
 557                                     (
 558                                         " . $matches[1] . " ROW_NUMBER()
 559                                         OVER (ORDER BY " . $this->returnOrderBy($sql, $orderByMatch[3]) . ") AS row_number,
 560                                         " . $matches[2] . $orderByMatch[1]. "
 561                                     ) AS a
 562                                     WHERE row_number > $start";
 563                         }
 564                     }else{
 565                         //bug: 22231 Records in campaigns' subpanel may not come from
 566                         //table of $_REQUEST['module']. Get it directly from query
 567                         $upperQuery = strtoupper($matches[2]);
 568                         if (!strpos($upperQuery,"JOIN")){
 569                             $from_pos = strpos($upperQuery , "FROM") + 4;
 570                             $where_pos = strpos($upperQuery, "WHERE");
 571                             $tablename = trim(substr($upperQuery,$from_pos, $where_pos - $from_pos));
 572                         }else{
 573                             // FIXME: this looks really bad. Probably source for tons of bug
 574                             // needs to be removed
 575                             $tablename = $this->getTableNameFromModuleName($_REQUEST['module'],$sql);
 576                         }
 577                         //if there is a distinct clause, form query with rownumber after distinct
 578                         if ($hasDistinct) {
 579                              $newSQL = "SELECT TOP $count * FROM
 580                                             (
 581                             SELECT ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, count(*) counter, " . $distinctSQLARRAY[0] . "
 582                                                         " . $distinctSQLARRAY[1] . "
 583                                                     group by " . $grpByStr . "
 584                                             )
 585                                             AS a
 586                                             WHERE row_number > $start";
 587                         }
 588                         else {
 589                              $newSQL = "SELECT TOP $count * FROM
 590                                            (
 591                                   " . $matches[1] . " ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, " . $matches[2] . $matches[3]. "
 592                                            )
 593                                            AS a
 594                                            WHERE row_number > $start";
 595                         }
 596                     }
 597                 }
 598             }
 599         }
 600
 601         $GLOBALS['log']->debug('Limit Query: ' . $newSQL);
 602         if($execute) {
 603             $result =  $this->query($newSQL, $dieOnError, $msg);
 604             $this->dump_slow_queries($newSQL);
 605             return $result;
 606         } else {
 607             return $newSQL;
 608         }
 609     }
 610
 611
 612     /**
 613      * Searches for begginning and ending characters.  It places contents into
 614      * an array and replaces contents in original string.  This is used to account for use of
 615      * nested functions while aliasing column names
 616      *
 617      * @param  string $p_sql     SQL statement
 618      * @param  string $strip_beg Beginning character
 619      * @param  string $strip_end Ending character
 620      * @param  string $patt      Optional, pattern to
 621      */
 622     private function removePatternFromSQL($p_sql, $strip_beg, $strip_end, $patt = 'patt')
 623     {
 624         //strip all single quotes out
 625         $count = substr_count ( $p_sql, $strip_beg);
 626         $increment = 1;
 627         if ($strip_beg != $strip_end)
 628             $increment = 2;
 629
 630         $i=0;
 631         $offset = 0;
 632         $strip_array = array();
 633         while ($i<$count && $offset<strlen($p_sql)) {
 634             if ($offset > strlen($p_sql))
 635             {
 636                                 break;
 637             }
 638
 639             $beg_sin = strpos($p_sql, $strip_beg, $offset);
 640             if (!$beg_sin)
 641             {
 642                 break;
 643             }
 644             $sec_sin = strpos($p_sql, $strip_end, $beg_sin+1);
 645             $strip_array[$patt.$i] = substr($p_sql, $beg_sin, $sec_sin - $beg_sin +1);
 646             if ($increment > 1) {
 647                 //we are in here because beginning and end patterns are not identical, so search for nesting
 648                 $exists = strpos($strip_array[$patt.$i], $strip_beg );
 649                 if ($exists>=0) {
 650                     $nested_pos = (strrpos($strip_array[$patt.$i], $strip_beg ));
 651                     $strip_array[$patt.$i] = substr($p_sql,$nested_pos+$beg_sin,$sec_sin - ($nested_pos+$beg_sin)+1);
 652                     $p_sql = substr($p_sql, 0, $nested_pos+$beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
 653                     $i = $i + 1;
 654                     continue;
 655                 }
 656             }
 657             $p_sql = substr($p_sql, 0, $beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
 658             //move the marker up
 659             $offset = $sec_sin+1;
 660
 661             $i = $i + 1;
 662         }
 663         $strip_array['sql_string'] = $p_sql;
 664
 665         return $strip_array;
 666     }
 667
 668     /**
 669      * adds a pattern
 670      *
 671      * @param  string $token
 672      * @param  array  $pattern_array
 673      * @return string
 674      */
 675         private function addPatternToSQL($token, array $pattern_array)
 676     {
 677         //strip all single quotes out
 678         $pattern_array = array_reverse($pattern_array);
 679
 680         foreach ($pattern_array as $key => $replace) {
 681             $token = str_replace( "##".$key."##", $replace,$token);
 682         }
 683
 684         return $token;
 685     }
 686
 687     /**
 688      * gets an alias from the sql statement
 689      *
 690      * @param  string $sql
 691      * @param  string $alias
 692      * @return string
 693      */
 694         private function getAliasFromSQL($sql, $alias)
 695     {
 696         $matches = array();
 697         preg_match('/^(.*SELECT)(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
 698         //parse all single and double  quotes out of array
 699         $sin_array = $this->removePatternFromSQL($matches[2], "'", "'","sin_");
 700         $new_sql = array_pop($sin_array);
 701         $dub_array = $this->removePatternFromSQL($new_sql, "\"", "\"","dub_");
 702         $new_sql = array_pop($dub_array);
 703
 704         //search for parenthesis
 705         $paren_array = $this->removePatternFromSQL($new_sql, "(", ")", "par_");
 706         $new_sql = array_pop($paren_array);
 707
 708         //all functions should be removed now, so split the array on commas
 709         $mstr_sql_array = explode(",", $new_sql);
 710         foreach($mstr_sql_array as $token ) {
 711             if (strpos($token, $alias)) {
 712                 //found token, add back comments
 713                 $token = $this->addPatternToSQL($token, $paren_array);
 714                 $token = $this->addPatternToSQL($token, $dub_array);
 715                 $token = $this->addPatternToSQL($token, $sin_array);
 716
 717                 //log and break out of this function
 718                 return $token;
 719             }
 720         }
 721         return null;
 722     }
 723
 724
 725     /**
 726      * Finds the alias of the order by column, and then return the preceding column name
 727      *
 728      * @param  string $sql
 729      * @param  string $orderMatch
 730      * @return string
 731      */
 732     private function findColumnByAlias($sql, $orderMatch)
 733     {
 734         //change case to lowercase
 735         $sql = strtolower($sql);
 736         $patt = '/\s+'.trim($orderMatch).'\s*,/';
 737
 738         //check for the alias, it should contain comma, may contain space, \n, or \t
 739         $matches = array();
 740         preg_match($patt, $sql, $matches, PREG_OFFSET_CAPTURE);
 741         $found_in_sql = isset($matches[0][1]) ? $matches[0][1] : false;
 742
 743
 744         //set default for found variable
 745         $found = $found_in_sql;
 746
 747         //if still no match found, then we need to parse through the string
 748         if (!$found_in_sql){
 749             //get count of how many times the match exists in string
 750             $found_count = substr_count($sql, $orderMatch);
 751             $i = 0;
 752             $first_ = 0;
 753             $len = strlen($orderMatch);
 754             //loop through string as many times as there is a match
 755             while ($found_count > $i) {
 756                 //get the first match
 757                 $found_in_sql = strpos($sql, $orderMatch,$first_);
 758                 //make sure there was a match
 759                 if($found_in_sql){
 760                     //grab the next 2 individual characters
 761                     $str_plusone = substr($sql,$found_in_sql + $len,1);
 762                     $str_plustwo = substr($sql,$found_in_sql + $len+1,1);
 763                     //if one of those characters is a comma, then we have our alias
 764                     if ($str_plusone === "," || $str_plustwo === ","){
 765                         //keep track of this position
 766                         $found = $found_in_sql;
 767                     }
 768                 }
 769                 //set the offset and increase the iteration counter
 770                 $first_ = $found_in_sql+$len;
 771                 $i = $i+1;
 772             }
 773         }
 774         //return $found, defaults have been set, so if no match was found it will be a negative number
 775         return $found;
 776     }
 777
 778
 779     /**
 780      * Return the order by string to use in case the column has been aliased
 781      *
 782      * @param  string $sql
 783      * @param  string $orig_order_match
 784      * @return string
 785      */
 786     private function returnOrderBy($sql, $orig_order_match)
 787     {
 788         $sql = strtolower($sql);
 789         $orig_order_match = trim($orig_order_match);
 790         if (strpos($orig_order_match, ".") != 0)
 791             //this has a tablename defined, pass in the order match
 792             return $orig_order_match;
 793
 794         //grab first space in order by
 795         $firstSpace = strpos($orig_order_match, " ");
 796
 797         //split order by into column name and ascending/descending
 798         $orderMatch = " " . strtolower(substr($orig_order_match, 0, $firstSpace));
 799         $asc_desc =  substr($orig_order_match,$firstSpace);
 800
 801         //look for column name as an alias in sql string
 802         $found_in_sql = $this->findColumnByAlias($sql, $orderMatch);
 803
 804         if (!$found_in_sql) {
 805             //check if this column needs the tablename prefixed to it
 806             $orderMatch = ".".trim($orderMatch);
 807             $colMatchPos = strpos($sql, $orderMatch);
 808             if ($colMatchPos !== false) {
 809                 //grab sub string up to column name
 810                 $containsColStr = substr($sql,0, $colMatchPos);
 811                 //get position of first space, so we can grab table name
 812                 $lastSpacePos = strrpos($containsColStr, " ");
 813                 //use positions of column name, space before name, and length of column to find the correct column name
 814                 $col_name = substr($sql, $lastSpacePos, $colMatchPos-$lastSpacePos+strlen($orderMatch));
 815                                 //bug 25485. When sorting by a custom field in Account List and then pressing NEXT >, system gives an error
 816                                 $containsCommaPos = strpos($col_name, ",");
 817                                 if($containsCommaPos !== false) {
 818                                         $col_name = substr($col_name, $containsCommaPos+1);
 819                                 }
 820                 //return column name
 821                 return $col_name;
 822             }
 823             //break out of here, log this
 824             $GLOBALS['log']->debug("No match was found for order by, pass string back untouched as: $orig_order_match");
 825             return $orig_order_match;
 826         }
 827         else {
 828             //if found, then parse and return
 829             //grab string up to the aliased column
 830             $GLOBALS['log']->debug("order by found, process sql string");
 831
 832             $psql = (trim($this->getAliasFromSQL($sql, $orderMatch )));
 833             if (empty($psql))
 834                 $psql = trim(substr($sql, 0, $found_in_sql));
 835
 836             //grab the last comma before the alias
 837             $comma_pos = strrpos($psql, " ");
 838             //substring between the comma and the alias to find the joined_table alias and column name
 839             $col_name = substr($psql,0, $comma_pos);
 840
 841             //make sure the string does not have an end parenthesis
 842             //and is not part of a function (i.e. "ISNULL(leads.last_name,'') as name"  )
 843             //this is especially true for unified search from home screen
 844
 845             $alias_beg_pos = 0;
 846             if(strpos($psql, " as "))
 847                 $alias_beg_pos = strpos($psql, " as ");
 848
 849             // Bug # 44923 - This breaks the query and does not properly filter isnull
 850             // as there are other functions such as ltrim and rtrim.
 851             /* else if (strncasecmp($psql, 'isnull', 6) != 0)
 852                 $alias_beg_pos = strpos($psql, " "); */
 853
 854             if ($alias_beg_pos > 0) {
 855                 $col_name = substr($psql,0, $alias_beg_pos );
 856             }
 857             //add the "asc/desc" order back
 858             $col_name = $col_name. " ". $asc_desc;
 859
 860             //pass in new order by
 861             $GLOBALS['log']->debug("order by being returned is " . $col_name);
 862             return $col_name;
 863         }
 864     }
 865
 866     /**
 867      * Take in a string of the module and retrieve the correspondent table name
 868      *
 869      * @param  string $module_str module name
 870      * @param  string $sql        SQL statement
 871      * @return string table name
 872      */
 873     private function getTableNameFromModuleName($module_str, $sql)
 874     {
 875
 876         global $beanList, $beanFiles;
 877         $GLOBALS['log']->debug("Module being processed is " . $module_str);
 878         //get the right module files
 879         //the module string exists in bean list, then process bean for correct table name
 880         //note that we exempt the reports module from this, as queries from reporting module should be parsed for
 881         //correct table name.
 882         if (($module_str != 'Reports' && $module_str != 'SavedReport') && isset($beanList[$module_str])  &&  isset($beanFiles[$beanList[$module_str]])){
 883             //if the class is not already loaded, then load files
 884             if (!class_exists($beanList[$module_str]))
 885                 require_once($beanFiles[$beanList[$module_str]]);
 886
 887             //instantiate new bean
 888             $module_bean = new $beanList[$module_str]();
 889             //get table name from bean
 890             $tbl_name = $module_bean->table_name;
 891             //make sure table name is not just a blank space, or empty
 892             $tbl_name = trim($tbl_name);
 893
 894             if(empty($tbl_name)){
 895                 $GLOBALS['log']->debug("Could not find table name for module $module_str. ");
 896                 $tbl_name = $module_str;
 897             }
 898         }
 899         else {
 900             //since the module does NOT exist in beanlist, then we have to parse the string
 901             //and grab the table name from the passed in sql
 902             $GLOBALS['log']->debug("Could not find table name from module in request, retrieve from passed in sql");
 903             $tbl_name = $module_str;
 904             $sql = strtolower($sql);
 905
 906             // Bug #45625 : Getting Multi-part identifier (reports.id) could not be bound error when navigating to next page in reprots in mssql
 907             // there is cases when sql string is multiline string and it we cannot find " from " string in it
 908             $sql = str_replace(array("\n", "\r"), " ", $sql);
 909
 910             //look for the location of the "from" in sql string
 911             $fromLoc = strpos($sql," from " );
 912             if ($fromLoc>0){
 913                 //found from, substring from the " FROM " string in sql to end
 914                 $tableEnd = substr($sql, $fromLoc+6);
 915                 //We know that tablename will be next parameter after from, so
 916                 //grab the next space after table name.
 917                 // MFH BUG #14009: Also check to see if there are any carriage returns before the next space so that we don't grab any arbitrary joins or other tables.
 918                 $carriage_ret = strpos($tableEnd,"\n");
 919                 $next_space = strpos($tableEnd," " );
 920                 if ($carriage_ret < $next_space)
 921                     $next_space = $carriage_ret;
 922                 if ($next_space > 0) {
 923                     $tbl_name= substr($tableEnd,0, $next_space);
 924                     if(empty($tbl_name)){
 925                         $GLOBALS['log']->debug("Could not find table name sql either, return $module_str. ");
 926                         $tbl_name = $module_str;
 927                     }
 928                 }
 929
 930                 //grab the table, to see if it is aliased
 931                 $aliasTableEnd = trim(substr($tableEnd, $next_space));
 932                 $alias_space = strpos ($aliasTableEnd, " " );
 933                 if ($alias_space > 0){
 934                     $alias_tbl_name= substr($aliasTableEnd,0, $alias_space);
 935                     strtolower($alias_tbl_name);
 936                     if(empty($alias_tbl_name)
 937                         || $alias_tbl_name == "where"
 938                         || $alias_tbl_name == "inner"
 939                         || $alias_tbl_name == "left"
 940                         || $alias_tbl_name == "join"
 941                         || $alias_tbl_name == "outer"
 942                         || $alias_tbl_name == "right") {
 943                         //not aliased, do nothing
 944                     }
 945                     elseif ($alias_tbl_name == "as") {
 946                             //the next word is the table name
 947                             $aliasTableEnd = trim(substr($aliasTableEnd, $alias_space));
 948                             $alias_space = strpos ($aliasTableEnd, " " );
 949                             if ($alias_space > 0) {
 950                                 $alias_tbl_name= trim(substr($aliasTableEnd,0, $alias_space));
 951                                 if (!empty($alias_tbl_name))
 952                                     $tbl_name = $alias_tbl_name;
 953                             }
 954                     }
 955                     else {
 956                         //this is table alias
 957                         $tbl_name = $alias_tbl_name;
 958                     }
 959                 }
 960             }
 961         }
 962         //return table name
 963         $GLOBALS['log']->debug("Table name for module $module_str is: ".$tbl_name);
 964         return $tbl_name;
 965     }
 966
 967
 968         /**
 969      * @see DBManager::getFieldsArray()
 970      */
 971         public function getFieldsArray($result, $make_lower_case = false)
 972         {
 973                 $field_array = array();
 974
 975                 if(! isset($result) || empty($result))
 976             return 0;
 977
 978         $i = 0;
 979         while ($i < mssql_num_fields($result)) {
 980             $meta = mssql_fetch_field($result, $i);
 981             if (!$meta)
 982                 return 0;
 983             if($make_lower_case==true)
 984                 $meta->name = strtolower($meta->name);
 985
 986             $field_array[] = $meta->name;
 987
 988             $i++;
 989         }
 990
 991         return $field_array;
 992         }
 993
 994     /**
 995      * @see DBManager::getAffectedRowCount()
 996      */
 997         public function getAffectedRowCount()
 998     {
 999         return $this->getOne("SELECT @@ROWCOUNT");
1000     }
1001
1002         /**
1003          * @see DBManager::fetchRow()
1004          */
1005         public function fetchRow($result)
1006         {
1007                 if (empty($result))     return false;
1008
1009         $row = mssql_fetch_assoc($result);
1010         //MSSQL returns a space " " when a varchar column is empty ("") and not null.
1011         //We need to iterate through the returned row array and strip empty spaces
1012         if(!empty($row)){
1013             foreach($row as $key => $column) {
1014                //notice we only strip if one space is returned.  we do not want to strip
1015                //strings with intentional spaces (" foo ")
1016                if (!empty($column) && $column ==" ") {
1017                    $row[$key] = '';
1018                }
1019             }
1020         }
1021         return $row;
1022         }
1023
1024     /**
1025      * @see DBManager::quote()
1026      */
1027     public function quote($string)
1028     {
1029         if(is_array($string)) {
1030             return $this->arrayQuote($string);
1031         }
1032         return str_replace("'","''", $this->quoteInternal($string));
1033     }
1034
1035     /**
1036      * @see DBManager::tableExists()
1037      */
1038     public function tableExists($tableName)
1039     {
1040         $GLOBALS['log']->info("tableExists: $tableName");
1041
1042         $this->checkConnection();
1043         $result = $this->getOne(
1044             "SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE='BASE TABLE' AND TABLE_NAME=".$this->quoted($tableName));
1045
1046         return !empty($result);
1047     }
1048
1049     /**
1050      * Get tables like expression
1051      * @param $like string
1052      * @return array
1053      */
1054     public function tablesLike($like)
1055     {
1056         if ($this->getDatabase()) {
1057             $tables = array();
1058             $r = $this->query('SELECT TABLE_NAME tn FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE=\'BASE TABLE\' AND TABLE_NAME LIKE '.$this->quoted($like));
1059             if (!empty($r)) {
1060                 while ($a = $this->fetchByAssoc($r)) {
1061                     $row = array_values($a);
1062                                         $tables[]=$row[0];
1063                 }
1064                 return $tables;
1065             }
1066         }
1067         return false;
1068     }
1069
1070     /**
1071      * @see DBManager::getTablesArray()
1072      */
1073     public function getTablesArray()
1074     {
1075         $GLOBALS['log']->debug('MSSQL fetching table list');
1076
1077         if($this->getDatabase()) {
1078             $tables = array();
1079             $r = $this->query('SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES');
1080             if (is_resource($r)) {
1081                 while ($a = $this->fetchByAssoc($r))
1082                     $tables[] = $a['TABLE_NAME'];
1083
1084                 return $tables;
1085             }
1086         }
1087
1088         return false; // no database available
1089     }
1090
1091
1092     /**
1093      * This call is meant to be used during install, when Full Text Search is enabled
1094      * Indexing would always occur after a fresh sql server install, so this code creates
1095      * a catalog and table with full text index.
1096      */
1097     public function full_text_indexing_setup()
1098     {
1099         $GLOBALS['log']->debug('MSSQL about to wakeup FTS');
1100
1101         if($this->getDatabase()) {
1102                 //create wakeup catalog
1103                 $FTSqry[] = "if not exists(  select * from sys.fulltext_catalogs where name ='wakeup_catalog' )
1104                 CREATE FULLTEXT CATALOG wakeup_catalog
1105                 ";
1106
1107                 //drop wakeup table if it exists
1108                 $FTSqry[] = "IF EXISTS(SELECT 'fts_wakeup' FROM sysobjects WHERE name = 'fts_wakeup' AND xtype='U')
1109                     DROP TABLE fts_wakeup
1110                 ";
1111                 //create wakeup table
1112                 $FTSqry[] = "CREATE TABLE fts_wakeup(
1113                     id varchar(36) NOT NULL CONSTRAINT pk_fts_wakeup_id PRIMARY KEY CLUSTERED (id ASC ),
1114                     body text NULL,
1115                     kb_index int IDENTITY(1,1) NOT NULL CONSTRAINT wakeup_fts_unique_idx UNIQUE NONCLUSTERED
1116                 )
1117                 ";
1118                 //create full text index
1119                  $FTSqry[] = "CREATE FULLTEXT INDEX ON fts_wakeup
1120                 (
1121                     body
1122                     Language 0X0
1123                 )
1124                 KEY INDEX wakeup_fts_unique_idx ON wakeup_catalog
1125                 WITH CHANGE_TRACKING AUTO
1126                 ";
1127
1128                 //insert dummy data
1129                 $FTSqry[] = "INSERT INTO fts_wakeup (id ,body)
1130                 VALUES ('".create_guid()."', 'SugarCRM Rocks' )";
1131
1132
1133                 //create queries to stop and restart indexing
1134                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup STOP POPULATION';
1135                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup DISABLE';
1136                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup ENABLE';
1137                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING MANUAL';
1138                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup START FULL POPULATION';
1139                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING AUTO';
1140
1141                 foreach($FTSqry as $q){
1142                     sleep(3);
1143                     $this->query($q);
1144                 }
1145                 $this->create_default_full_text_catalog();
1146         }
1147
1148         return false; // no database available
1149     }
1150
1151     protected $date_formats = array(
1152         '%Y-%m-%d' => 10,
1153         '%Y-%m' => 7,
1154         '%Y' => 4,
1155     );
1156
1157     /**
1158      * @see DBManager::convert()
1159      */
1160     public function convert($string, $type, array $additional_parameters = array())
1161     {
1162         // convert the parameters array into a comma delimited string
1163         if (!empty($additional_parameters)) {
1164             $additional_parameters_string = ','.implode(',',$additional_parameters);
1165         } else {
1166             $additional_parameters_string = '';
1167         }
1168         $all_parameters = $additional_parameters;
1169         if(is_array($string)) {
1170             $all_parameters = array_merge($string, $all_parameters);
1171         } elseif (!is_null($string)) {
1172             array_unshift($all_parameters, $string);
1173         }
1174
1175         switch (strtolower($type)) {
1176             case 'today':
1177                 return "GETDATE()";
1178             case 'left':
1179                 return "LEFT($string$additional_parameters_string)";
1180             case 'date_format':
1181                 if(!empty($additional_parameters[0]) && $additional_parameters[0][0] == "'") {
1182                     $additional_parameters[0] = trim($additional_parameters[0], "'");
1183                 }
1184                 if(!empty($additional_parameters) && isset($this->date_formats[$additional_parameters[0]])) {
1185                     $len = $this->date_formats[$additional_parameters[0]];
1186                     return "LEFT(CONVERT(varchar($len),". $string . ",120),$len)";
1187                 } else {
1188                    return "LEFT(CONVERT(varchar(10),". $string . ",120),10)";
1189                 }
1190             case 'ifnull':
1191                 if(empty($additional_parameters_string)) {
1192                     $additional_parameters_string = ",''";
1193                 }
1194                 return "ISNULL($string$additional_parameters_string)";
1195             case 'concat':
1196                 return implode("+",$all_parameters);
1197             case 'text2char':
1198                 return "CAST($string AS varchar(8000))";
1199             case 'quarter':
1200                 return "DATENAME(quarter, $string)";
1201             case "length":
1202                 return "LEN($string)";
1203             case 'month':
1204                 return "MONTH($string)";
1205             case 'add_date':
1206                 return "DATEADD({$additional_parameters[1]},{$additional_parameters[0]},$string)";
1207             case 'add_time':
1208                 return "DATEADD(hh, {$additional_parameters[0]}, DATEADD(mi, {$additional_parameters[1]}, $string))";
1209         }
1210
1211         return "$string";
1212     }
1213
1214     /**
1215      * @see DBManager::fromConvert()
1216      */
1217     public function fromConvert($string, $type)
1218     {
1219         switch($type) {
1220             case 'datetimecombo':
1221             case 'datetime': return substr($string, 0,19);
1222             case 'date': return substr($string, 0, 10);
1223             case 'time': return substr($string, 11);
1224                 }
1225                 return $string;
1226     }
1227
1228     /**
1229      * @see DBManager::createTableSQLParams()
1230      */
1231         public function createTableSQLParams($tablename, $fieldDefs, $indices)
1232     {
1233         if (empty($tablename) || empty($fieldDefs))
1234             return '';
1235
1236         $columns = $this->columnSQLRep($fieldDefs, false, $tablename);
1237         if (empty($columns))
1238             return '';
1239
1240         return "CREATE TABLE $tablename ($columns)";
1241     }
1242
1243     /**
1244      * Does this type represent text (i.e., non-varchar) value?
1245      * @param string $type
1246      */
1247     public function isTextType($type)
1248     {
1249         $type = strtolower($type);
1250         if(!isset($this->type_map[$type])) return false;
1251         return in_array($this->type_map[$type], array('ntext','text','image', 'nvarchar(max)'));
1252     }
1253
1254     /**
1255      * Return representation of an empty value depending on type
1256      * @param string $type
1257      */
1258     public function emptyValue($type)
1259     {
1260         $ctype = $this->getColumnType($type);
1261         if($ctype == "datetime") {
1262             return $this->convert($this->quoted("1970-01-01 00:00:00"), "datetime");
1263         }
1264         if($ctype == "date") {
1265             return $this->convert($this->quoted("1970-01-01"), "datetime");
1266         }
1267         if($ctype == "time") {
1268             return $this->convert($this->quoted("00:00:00"), "time");
1269         }
1270         return parent::emptyValue($type);
1271     }
1272
1273     public function renameColumnSQL($tablename, $column, $newname)
1274     {
1275         return "SP_RENAME '$tablename.$column', '$newname', 'COLUMN'";
1276     }
1277
1278     /**
1279      * Returns the SQL Alter table statment
1280      *
1281      * MSSQL has a quirky T-SQL alter table syntax. Pay special attention to the
1282      * modify operation
1283      * @param string $action
1284      * @param array  $def
1285      * @param bool   $ignorRequired
1286      * @param string $tablename
1287      */
1288     protected function alterSQLRep($action, array $def, $ignoreRequired, $tablename)
1289     {
1290         switch($action){
1291         case 'add':
1292              $f_def=$this->oneColumnSQLRep($def, $ignoreRequired,$tablename,false);
1293             return "ADD " . $f_def;
1294             break;
1295         case 'drop':
1296             return "DROP COLUMN " . $def['name'];
1297             break;
1298         case 'modify':
1299             //You cannot specify a default value for a column for MSSQL
1300             $f_def  = $this->oneColumnSQLRep($def, $ignoreRequired,$tablename, true);
1301             $f_stmt = "ALTER COLUMN ".$f_def['name'].' '.$f_def['colType'].' '.
1302                         $f_def['required'].' '.$f_def['auto_increment']."\n";
1303             if (!empty( $f_def['default']))
1304                 $f_stmt .= " ALTER TABLE " . $tablename .  " ADD  ". $f_def['default'] . " FOR " . $def['name'];
1305             return $f_stmt;
1306             break;
1307         default:
1308             return '';
1309         }
1310     }
1311
1312     /**
1313      * @see DBManager::changeColumnSQL()
1314      *
1315      * MSSQL uses a different syntax than MySQL for table altering that is
1316      * not quite as simplistic to implement...
1317      */
1318     protected function changeColumnSQL($tablename, $fieldDefs, $action, $ignoreRequired = false)
1319     {
1320         $sql=$sql2='';
1321         $constraints = $this->get_field_default_constraint_name($tablename);
1322         $columns = array();
1323         if ($this->isFieldArray($fieldDefs)) {
1324             foreach ($fieldDefs as $def)
1325                 {
1326                         //if the column is being modified drop the default value
1327                         //constraint if it exists. alterSQLRep will add the constraint back
1328                         if (!empty($constraints[$def['name']])) {
1329                                 $sql.=" ALTER TABLE " . $tablename . " DROP CONSTRAINT " . $constraints[$def['name']];
1330                         }
1331                         //check to see if we need to drop related indexes before the alter
1332                         $indices = $this->get_indices($tablename);
1333                 foreach ( $indices as $index ) {
1334                     if ( in_array($def['name'],$index['fields']) ) {
1335                         $sql  .= ' ' . $this->add_drop_constraint($tablename,$index,true).' ';
1336                         $sql2 .= ' ' . $this->add_drop_constraint($tablename,$index,false).' ';
1337                     }
1338                 }
1339
1340                         $columns[] = $this->alterSQLRep($action, $def, $ignoreRequired,$tablename);
1341                 }
1342         }
1343         else {
1344             //if the column is being modified drop the default value
1345                 //constraint if it exists. alterSQLRep will add the constraint back
1346                 if (!empty($constraints[$fieldDefs['name']])) {
1347                         $sql.=" ALTER TABLE " . $tablename . " DROP CONSTRAINT " . $constraints[$fieldDefs['name']];
1348                 }
1349                 //check to see if we need to drop related indexes before the alter
1350             $indices = $this->get_indices($tablename);
1351             foreach ( $indices as $index ) {
1352                 if ( in_array($fieldDefs['name'],$index['fields']) ) {
1353                     $sql  .= ' ' . $this->add_drop_constraint($tablename,$index,true).' ';
1354                     $sql2 .= ' ' . $this->add_drop_constraint($tablename,$index,false).' ';
1355                 }
1356             }
1357
1358
1359                 $columns[] = $this->alterSQLRep($action, $fieldDefs, $ignoreRequired,$tablename);
1360         }
1361
1362         $columns = implode(", ", $columns);
1363         $sql .= " ALTER TABLE $tablename $columns " . $sql2;
1364
1365         return $sql;
1366     }
1367
1368     protected function setAutoIncrement($table, $field_name)
1369     {
1370                 return "identity(1,1)";
1371         }
1372
1373     /**
1374      * @see DBManager::setAutoIncrementStart()
1375      */
1376     public function setAutoIncrementStart($table, $field_name, $start_value)
1377     {
1378         if($start_value > 1)
1379             $start_value -= 1;
1380                 $this->query("DBCC CHECKIDENT ('$table', RESEED, $start_value)");
1381         return true;
1382     }
1383
1384         /**
1385      * @see DBManager::getAutoIncrement()
1386      */
1387     public function getAutoIncrement($table, $field_name)
1388     {
1389                 $result = $this->getOne("select IDENT_CURRENT('$table') + IDENT_INCR ( '$table' ) as 'Auto_increment'");
1390         return $result;
1391     }
1392
1393     /**
1394      * @see DBManager::get_indices()
1395      */
1396     public function get_indices($tableName)
1397     {
1398         //find all unique indexes and primary keys.
1399         $query = <<<EOSQL
1400 SELECT sys.tables.object_id, sys.tables.name as table_name, sys.columns.name as column_name,
1401                 sys.indexes.name as index_name, sys.indexes.is_unique, sys.indexes.is_primary_key
1402             FROM sys.tables, sys.indexes, sys.index_columns, sys.columns
1403             WHERE (sys.tables.object_id = sys.indexes.object_id
1404                     AND sys.tables.object_id = sys.index_columns.object_id
1405                     AND sys.tables.object_id = sys.columns.object_id
1406                     AND sys.indexes.index_id = sys.index_columns.index_id
1407                     AND sys.index_columns.column_id = sys.columns.column_id)
1408                 AND sys.tables.name = '$tableName'
1409 EOSQL;
1410         $result = $this->query($query);
1411
1412         $indices = array();
1413         while (($row=$this->fetchByAssoc($result)) != null) {
1414             $index_type = 'index';
1415             if ($row['is_primary_key'] == '1')
1416                 $index_type = 'primary';
1417             elseif ($row['is_unique'] == 1 )
1418                 $index_type = 'unique';
1419             $name = strtolower($row['index_name']);
1420             $indices[$name]['name']     = $name;
1421             $indices[$name]['type']     = $index_type;
1422             $indices[$name]['fields'][] = strtolower($row['column_name']);
1423         }
1424         return $indices;
1425     }
1426
1427     /**
1428      * @see DBManager::get_columns()
1429      */
1430     public function get_columns($tablename)
1431     {
1432         //find all unique indexes and primary keys.
1433         $result = $this->query("sp_columns $tablename");
1434
1435         $columns = array();
1436         while (($row=$this->fetchByAssoc($result)) !=null) {
1437             $column_name = strtolower($row['COLUMN_NAME']);
1438             $columns[$column_name]['name']=$column_name;
1439             $columns[$column_name]['type']=strtolower($row['TYPE_NAME']);
1440             if ( $row['TYPE_NAME'] == 'decimal' ) {
1441                 $columns[$column_name]['len']=strtolower($row['PRECISION']);
1442                 $columns[$column_name]['len'].=','.strtolower($row['SCALE']);
1443             }
1444                         elseif ( in_array($row['TYPE_NAME'],array('nchar','nvarchar')) )
1445                                 $columns[$column_name]['len']=strtolower($row['PRECISION']);
1446             elseif ( !in_array($row['TYPE_NAME'],array('datetime','text')) )
1447                 $columns[$column_name]['len']=strtolower($row['LENGTH']);
1448             if ( stristr($row['TYPE_NAME'],'identity') ) {
1449                 $columns[$column_name]['auto_increment'] = '1';
1450                 $columns[$column_name]['type']=str_replace(' identity','',strtolower($row['TYPE_NAME']));
1451             }
1452
1453             if (!empty($row['IS_NULLABLE']) && $row['IS_NULLABLE'] == 'NO' && (empty($row['KEY']) || !stristr($row['KEY'],'PRI')))
1454                 $columns[strtolower($row['COLUMN_NAME'])]['required'] = 'true';
1455
1456             $column_def = 1;
1457             if ( strtolower($tablename) == 'relationships' ) {
1458                 $column_def = $this->getOne("select cdefault from syscolumns where id = object_id('relationships') and name = '$column_name'");
1459             }
1460             if ( $column_def != 0 && ($row['COLUMN_DEF'] != null)) {    // NOTE Not using !empty as an empty string may be a viable default value.
1461                 $matches = array();
1462                 $row['COLUMN_DEF'] = html_entity_decode($row['COLUMN_DEF'],ENT_QUOTES);
1463                 if ( preg_match('/\([\(|\'](.*)[\)|\']\)/i',$row['COLUMN_DEF'],$matches) )
1464                     $columns[$column_name]['default'] = $matches[1];
1465                 elseif ( preg_match('/\(N\'(.*)\'\)/i',$row['COLUMN_DEF'],$matches) )
1466                     $columns[$column_name]['default'] = $matches[1];
1467                 else
1468                     $columns[$column_name]['default'] = $row['COLUMN_DEF'];
1469             }
1470         }
1471         return $columns;
1472     }
1473
1474
1475     /**
1476      * Get FTS catalog name for current DB
1477      */
1478     protected function ftsCatalogName()
1479     {
1480         if(isset($this->connectOptions['db_name'])) {
1481             return $this->connectOptions['db_name']."_fts_catalog";
1482         }
1483         return 'sugar_fts_catalog';
1484     }
1485
1486     /**
1487      * @see DBManager::add_drop_constraint()
1488      */
1489     public function add_drop_constraint($table, $definition, $drop = false)
1490     {
1491         $type         = $definition['type'];
1492         $fields       = is_array($definition['fields'])?implode(',',$definition['fields']):$definition['fields'];
1493         $name         = $definition['name'];
1494         $sql          = '';
1495
1496         switch ($type){
1497         // generic indices
1498         case 'index':
1499         case 'alternate_key':
1500             if ($drop)
1501                 $sql = "DROP INDEX {$name} ON {$table}";
1502             else
1503                 $sql = "CREATE INDEX {$name} ON {$table} ({$fields})";
1504             break;
1505         case 'clustered':
1506             if ($drop)
1507                 $sql = "DROP INDEX {$name} ON {$table}";
1508             else
1509                 $sql = "CREATE CLUSTERED INDEX $name ON $table ($fields)";
1510             break;
1511             // constraints as indices
1512         case 'unique':
1513             if ($drop)
1514                 $sql = "ALTER TABLE {$table} DROP CONSTRAINT $name";
1515             else
1516                 $sql = "ALTER TABLE {$table} ADD CONSTRAINT {$name} UNIQUE ({$fields})";
1517             break;
1518         case 'primary':
1519             if ($drop)
1520                 $sql = "ALTER TABLE {$table} DROP PRIMARY KEY";
1521             else
1522                 $sql = "ALTER TABLE {$table} ADD CONSTRAINT {$name} PRIMARY KEY ({$fields})";
1523             break;
1524         case 'foreign':
1525             if ($drop)
1526                 $sql = "ALTER TABLE {$table} DROP FOREIGN KEY ({$fields})";
1527             else
1528                 $sql = "ALTER TABLE {$table} ADD CONSTRAINT {$name}  FOREIGN KEY ({$fields}) REFERENCES {$definition['foreignTable']}({$definition['foreignFields']})";
1529             break;
1530         case 'fulltext':
1531             if ($this->full_text_indexing_enabled() && $drop) {
1532                 $sql = "DROP FULLTEXT INDEX ON {$table}";
1533             } elseif ($this->full_text_indexing_enabled()) {
1534                 $catalog_name=$this->ftsCatalogName();
1535                 if ( isset($definition['catalog_name']) && $definition['catalog_name'] != 'default')
1536                     $catalog_name = $definition['catalog_name'];
1537
1538                 $language = "Language 1033";
1539                 if (isset($definition['language']) && !empty($definition['language']))
1540                     $language = "Language " . $definition['language'];
1541
1542                 $key_index = $definition['key_index'];
1543
1544                 $change_tracking = "auto";
1545                 if (isset($definition['change_tracking']) && !empty($definition['change_tracking']))
1546                     $change_tracking = $definition['change_tracking'];
1547
1548                 $sql = " CREATE FULLTEXT INDEX ON $table ($fields $language) KEY INDEX $key_index ON $catalog_name WITH CHANGE_TRACKING $change_tracking" ;
1549             }
1550             break;
1551         }
1552         return $sql;
1553     }
1554
1555     /**
1556      * Returns true if Full Text Search is installed
1557      *
1558      * @return bool
1559      */
1560     public function full_text_indexing_installed()
1561     {
1562         $ftsChckRes = $this->getOne("SELECT FULLTEXTSERVICEPROPERTY('IsFulltextInstalled') as fts");
1563         return !empty($ftsChckRes);
1564     }
1565
1566     /**
1567      * @see DBManager::full_text_indexing_enabled()
1568      */
1569     protected function full_text_indexing_enabled($dbname = null)
1570     {
1571         // check to see if we already have install setting in session
1572         if(!isset($_SESSION['IsFulltextInstalled']))
1573             $_SESSION['IsFulltextInstalled'] = $this->full_text_indexing_installed();
1574
1575         // check to see if FTS Indexing service is installed
1576         if(empty($_SESSION['IsFulltextInstalled']))
1577             return false;
1578
1579         // grab the dbname if it was not passed through
1580                 if (empty($dbname)) {
1581                         global $sugar_config;
1582                         $dbname = $sugar_config['dbconfig']['db_name'];
1583                 }
1584         //we already know that Indexing service is installed, now check
1585         //to see if it is enabled
1586                 $res = $this->getOne("SELECT DATABASEPROPERTY('$dbname', 'IsFulltextEnabled') ftext");
1587         return !empty($res);
1588         }
1589
1590     /**
1591      * Creates default full text catalog
1592      */
1593         protected function create_default_full_text_catalog()
1594     {
1595                 if ($this->full_text_indexing_enabled()) {
1596                     $catalog = $this->ftsCatalogName();
1597             $GLOBALS['log']->debug("Creating the default catalog for full-text indexing, $catalog");
1598
1599             //drop catalog if exists.
1600                         $ret = $this->query("
1601                 if not exists(
1602                     select *
1603                         from sys.fulltext_catalogs
1604                         where name ='$catalog'
1605                         )
1606                 CREATE FULLTEXT CATALOG $catalog");
1607
1608                         if (empty($ret)) {
1609                                 $GLOBALS['log']->error("Error creating default full-text catalog, $catalog");
1610                         }
1611                 }
1612         }
1613
1614     /**
1615      * Function returns name of the constraint automatically generated by sql-server.
1616      * We request this for default, primary key, required
1617      *
1618      * @param  string $table
1619      * @param  string $column
1620      * @return string
1621      */
1622         private function get_field_default_constraint_name($table, $column = null)
1623     {
1624         static $results = array();
1625
1626         if ( empty($column) && isset($results[$table]) )
1627             return $results[$table];
1628
1629         $query = <<<EOQ
1630 select s.name, o.name, c.name dtrt, d.name ctrt
1631     from sys.default_constraints as d
1632         join sys.objects as o
1633             on o.object_id = d.parent_object_id
1634         join sys.columns as c
1635             on c.object_id = o.object_id and c.column_id = d.parent_column_id
1636         join sys.schemas as s
1637             on s.schema_id = o.schema_id
1638     where o.name = '$table'
1639 EOQ;
1640         if ( !empty($column) )
1641             $query .= " and c.name = '$column'";
1642         $res = $this->query($query);
1643         if ( !empty($column) ) {
1644             $row = $this->fetchByAssoc($res);
1645             if (!empty($row))
1646                 return $row['ctrt'];
1647         }
1648         else {
1649             $returnResult = array();
1650             while ( $row = $this->fetchByAssoc($res) )
1651                 $returnResult[$row['dtrt']] = $row['ctrt'];
1652             $results[$table] = $returnResult;
1653             return $returnResult;
1654         }
1655
1656         return null;
1657         }
1658
1659     /**
1660      * @see DBManager::massageFieldDef()
1661      */
1662     public function massageFieldDef(&$fieldDef, $tablename)
1663     {
1664         parent::massageFieldDef($fieldDef,$tablename);
1665
1666         if ($fieldDef['type'] == 'int')
1667             $fieldDef['len'] = '4';
1668
1669         if(empty($fieldDef['len']))
1670         {
1671             switch($fieldDef['type']) {
1672                 case 'bit'      :
1673                 case 'bool'     : $fieldDef['len'] = '1'; break;
1674                 case 'smallint' : $fieldDef['len'] = '2'; break;
1675                 case 'float'    : $fieldDef['len'] = '8'; break;
1676                 case 'varchar'  :
1677                 case 'nvarchar' :
1678                                   $fieldDef['len'] = $this->isTextType($fieldDef['dbType']) ? 'max' : '255';
1679                                   break;
1680                 case 'image'    : $fieldDef['len'] = '2147483647'; break;
1681                 case 'ntext'    : $fieldDef['len'] = '2147483646'; break;   // Note: this is from legacy code, don't know if this is correct
1682             }
1683         }
1684         if($fieldDef['type'] == 'decimal'
1685            && empty($fieldDef['precision'])
1686            && !strpos($fieldDef['len'], ','))
1687         {
1688              $fieldDef['len'] .= ',0'; // Adding 0 precision if it is not specified
1689         }
1690
1691         if(empty($fieldDef['default'])
1692             && in_array($fieldDef['type'],array('bit','bool')))
1693         {
1694             $fieldDef['default'] = '0';
1695         }
1696                 if (isset($fieldDef['required']) && $fieldDef['required'] && !isset($fieldDef['default']) )
1697                         $fieldDef['default'] = '';
1698 //        if ($fieldDef['type'] == 'bit' && empty($fieldDef['len']) )
1699 //            $fieldDef['len'] = '1';
1700 //              if ($fieldDef['type'] == 'bool' && empty($fieldDef['len']) )
1701 //            $fieldDef['len'] = '1';
1702 //        if ($fieldDef['type'] == 'float' && empty($fieldDef['len']) )
1703 //            $fieldDef['len'] = '8';
1704 //        if ($fieldDef['type'] == 'varchar' && empty($fieldDef['len']) )
1705 //            $fieldDef['len'] = '255';
1706 //              if ($fieldDef['type'] == 'nvarchar' && empty($fieldDef['len']) )
1707 //            $fieldDef['len'] = '255';
1708 //        if ($fieldDef['type'] == 'image' && empty($fieldDef['len']) )
1709 //            $fieldDef['len'] = '2147483647';
1710 //        if ($fieldDef['type'] == 'ntext' && empty($fieldDef['len']) )
1711 //            $fieldDef['len'] = '2147483646';
1712 //        if ($fieldDef['type'] == 'smallint' && empty($fieldDef['len']) )
1713 //            $fieldDef['len'] = '2';
1714 //        if ($fieldDef['type'] == 'bit' && empty($fieldDef['default']) )
1715 //            $fieldDef['default'] = '0';
1716 //              if ($fieldDef['type'] == 'bool' && empty($fieldDef['default']) )
1717 //            $fieldDef['default'] = '0';
1718
1719     }
1720
1721     /**
1722      * @see DBManager::oneColumnSQLRep()
1723      */
1724     protected function oneColumnSQLRep($fieldDef, $ignoreRequired = false, $table = '', $return_as_array = false)
1725     {
1726         //Bug 25814
1727                 if(isset($fieldDef['name'])){
1728                     $colType = $this->getFieldType($fieldDef);
1729                 if(stristr($this->getFieldType($fieldDef), 'decimal') && isset($fieldDef['len'])){
1730                                 $fieldDef['len'] = min($fieldDef['len'],38);
1731                         }
1732                     //bug: 39690 float(8) is interpreted as real and this generates a diff when doing repair
1733                         if(stristr($colType, 'float') && isset($fieldDef['len']) && $fieldDef['len'] == 8){
1734                                 unset($fieldDef['len']);
1735                         }
1736                 }
1737
1738                 // always return as array for post-processing
1739                 $ref = parent::oneColumnSQLRep($fieldDef, $ignoreRequired, $table, true);
1740
1741                 // Bug 24307 - Don't add precision for float fields.
1742                 if ( stristr($ref['colType'],'float') )
1743                         $ref['colType'] = preg_replace('/(,\d+)/','',$ref['colType']);
1744
1745         if ( $return_as_array )
1746             return $ref;
1747         else
1748             return "{$ref['name']} {$ref['colType']} {$ref['default']} {$ref['required']} {$ref['auto_increment']}";
1749         }
1750
1751     /**
1752      * Saves changes to module's audit table
1753      *
1754      * @param object $bean    Sugarbean instance
1755      * @param array  $changes changes
1756      */
1757     public function save_audit_records(SugarBean $bean, $changes)
1758         {
1759                 //Bug 25078 fixed by Martin Hu: sqlserver haven't 'date' type, trim extra "00:00:00"
1760                 if($changes['data_type'] == 'date'){
1761                         $changes['before'] = str_replace(' 00:00:00','',$changes['before']);
1762                 }
1763                 parent::save_audit_records($bean,$changes);
1764         }
1765
1766     /**
1767      * Disconnects from the database
1768      *
1769      * Also handles any cleanup needed
1770      */
1771     public function disconnect()
1772     {
1773         $GLOBALS['log']->debug('Calling Mssql::disconnect()');
1774         if(!empty($this->database)){
1775             $this->freeResult();
1776             mssql_close($this->database);
1777             $this->database = null;
1778         }
1779     }
1780
1781     /**
1782      * @see DBManager::freeDbResult()
1783      */
1784     protected function freeDbResult($dbResult)
1785     {
1786         if(!empty($dbResult))
1787             mssql_free_result($dbResult);
1788     }
1789
1790         /**
1791          * (non-PHPdoc)
1792          * @see DBManager::lastDbError()
1793          */
1794     public function lastDbError()
1795     {
1796         $sqlmsg = mssql_get_last_message();
1797         if(empty($sqlmsg)) return false;
1798         global $app_strings;
1799         if (empty($app_strings)
1800                     or !isset($app_strings['ERR_MSSQL_DB_CONTEXT'])
1801                         or !isset($app_strings['ERR_MSSQL_WARNING']) ) {
1802         //ignore the message from sql-server if $app_strings array is empty. This will happen
1803         //only if connection if made before language is set.
1804                     return false;
1805         }
1806
1807         $sqlpos = strpos($sqlmsg, 'Changed database context to');
1808         $sqlpos2 = strpos($sqlmsg, 'Warning:');
1809         $sqlpos3 = strpos($sqlmsg, 'Checking identity information:');
1810         if ( $sqlpos !== false || $sqlpos2 !== false || $sqlpos3 !== false ) {
1811             return false;
1812         } else {
1813                 global $app_strings;
1814             //ERR_MSSQL_DB_CONTEXT: localized version of 'Changed database context to' message
1815             if (empty($app_strings) or !isset($app_strings['ERR_MSSQL_DB_CONTEXT'])) {
1816                 //ignore the message from sql-server if $app_strings array is empty. This will happen
1817                 //only if connection if made before languge is set.
1818                 $GLOBALS['log']->debug("Ignoring this database message: " . $sqlmsg);
1819                 return false;
1820             }
1821             else {
1822                 $sqlpos = strpos($sqlmsg, $app_strings['ERR_MSSQL_DB_CONTEXT']);
1823                 if ( $sqlpos !== false )
1824                     return false;
1825             }
1826         }
1827
1828         if ( strlen($sqlmsg) > 2 ) {
1829                 return "SQL Server error: " . $sqlmsg;
1830         }
1831
1832         return false;
1833     }
1834
1835     /**
1836      * (non-PHPdoc)
1837      * @see DBManager::getDbInfo()
1838      */
1839     public function getDbInfo()
1840     {
1841         return array("version" => $this->version());
1842     }
1843
1844     /**
1845      * (non-PHPdoc)
1846      * @see DBManager::validateQuery()
1847      */
1848     public function validateQuery($query)
1849     {
1850         if(!$this->isSelect($query)) {
1851             return false;
1852         }
1853         $this->query("SET SHOWPLAN_TEXT ON");
1854         $res = $this->getOne($query);
1855         $this->query("SET SHOWPLAN_TEXT OFF");
1856         return !empty($res);
1857     }
1858
1859     /**
1860      * This is a utility function to prepend the "N" character in front of SQL values that are
1861      * surrounded by single quotes.
1862      *
1863      * @param  $sql string SQL statement
1864      * @return string SQL statement with single quote values prepended with "N" character for nvarchar columns
1865      */
1866     protected function _appendN($sql)
1867     {
1868         // If there are no single quotes, don't bother, will just assume there is no character data
1869         if (strpos($sql, "'") === false)
1870             return $sql;
1871
1872         // Flag if there are odd number of single quotes, just continue without trying to append N
1873         if ((substr_count($sql, "'") & 1)) {
1874             $GLOBALS['log']->error("SQL statement[" . $sql . "] has odd number of single quotes.");
1875             return $sql;
1876         }
1877
1878         //The only location of three subsequent ' will be at the beginning or end of a value.
1879         $sql = preg_replace('/(?<!\')(\'{3})(?!\')/', "'<@#@#@PAIR@#@#@>", $sql);
1880
1881         // Remove any remaining '' and do not parse... replace later (hopefully we don't even have any)
1882         $pairs        = array();
1883         $regexp       = '/(\'{2})/';
1884         $pair_matches = array();
1885         preg_match_all($regexp, $sql, $pair_matches);
1886         if ($pair_matches) {
1887             foreach (array_unique($pair_matches[0]) as $key=>$value) {
1888                 $pairs['<@PAIR-'.$key.'@>'] = $value;
1889             }
1890             if (!empty($pairs)) {
1891                 $sql = str_replace($pairs, array_keys($pairs), $sql);
1892             }
1893         }
1894
1895         $regexp  = "/(N?'.+?')/is";
1896         $matches = array();
1897         preg_match_all($regexp, $sql, $matches);
1898         $replace = array();
1899         if (!empty($matches)) {
1900             foreach ($matches[0] as $value) {
1901                 // We are assuming that all nvarchar columns are no more than 200 characters in length
1902                 // One problem we face is the image column type in reports which cannot accept nvarchar data
1903                 if (!empty($value) && !is_numeric(trim(str_replace(array("'", ","), "", $value))) && !preg_match('/^\'[\,]\'$/', $value)) {
1904                     $replace[$value] = 'N' . trim($value, "N");
1905                 }
1906             }
1907         }
1908
1909         if (!empty($replace))
1910             $sql = str_replace(array_keys($replace), $replace, $sql);
1911
1912         if (!empty($pairs))
1913             $sql = str_replace(array_keys($pairs), $pairs, $sql);
1914
1915         if(strpos($sql, "<@#@#@PAIR@#@#@>"))
1916             $sql = str_replace(array('<@#@#@PAIR@#@#@>'), array("''"), $sql);
1917
1918         return $sql;
1919     }
1920
1921     /**
1922      * Quote SQL Server search term
1923      * @param string $term
1924      * @return string
1925      */
1926     protected function quoteTerm($term)
1927     {
1928         $term = str_replace("%", "*", $term); // Mssql wildcard is *
1929         return '"'.$term.'"';
1930     }
1931
1932     /**
1933      * Generate fulltext query from set of terms
1934      * @param string $fields Field to search against
1935      * @param array $terms Search terms that may be or not be in the result
1936      * @param array $must_terms Search terms that have to be in the result
1937      * @param array $exclude_terms Search terms that have to be not in the result
1938      */
1939     public function getFulltextQuery($field, $terms, $must_terms = array(), $exclude_terms = array())
1940     {
1941         $condition = $or_condition = array();
1942         foreach($must_terms as $term) {
1943             $condition[] = $this->quoteTerm($term);
1944         }
1945
1946         foreach($terms as $term) {
1947             $or_condition[] = $this->quoteTerm($term);
1948         }
1949
1950         if(!empty($or_condition)) {
1951             $condition[] = "(".join(" | ", $or_condition).")";
1952         }
1953
1954         foreach($exclude_terms as $term) {
1955             $condition[] = " NOT ".$this->quoteTerm($term);
1956         }
1957         $condition = $this->quoted(join(" AND ",$condition));
1958         return "CONTAINS($field, $condition)";
1959     }
1960
1961     /**
1962      * Check if certain database exists
1963      * @param string $dbname
1964      */
1965     public function dbExists($dbname)
1966     {
1967         $db = $this->getOne("SELECT name FROM master..sysdatabases WHERE name = N".$this->quoted($dbname));
1968         return !empty($db);
1969     }
1970
1971     /**
1972      * Select database
1973      * @param string $dbname
1974      */
1975     protected function selectDb($dbname)
1976     {
1977         return mssql_select_db($dbname);
1978     }
1979
1980     /**
1981      * Check if certain DB user exists
1982      * @param string $username
1983      */
1984     public function userExists($username)
1985     {
1986         $this->selectDb("master");
1987         $user = $this->getOne("select count(*) from sys.sql_logins where name =".$this->quoted($username));
1988         // FIXME: go back to the original DB
1989         return !empty($user);
1990     }
1991
1992     /**
1993      * Create DB user
1994      * @param string $database_name
1995      * @param string $host_name
1996      * @param string $user
1997      * @param string $password
1998      */
1999     public function createDbUser($database_name, $host_name, $user, $password)
2000     {
2001         $qpassword = $this->quote($password);
2002         $this->selectDb($database_name);
2003         $this->query("CREATE LOGIN $user WITH PASSWORD = '$qpassword'", true);
2004         $this->query("CREATE USER $user FOR LOGIN $user", true);
2005         $this->query("EXEC sp_addRoleMember 'db_ddladmin ', '$user'", true);
2006         $this->query("EXEC sp_addRoleMember 'db_datareader','$user'", true);
2007         $this->query("EXEC sp_addRoleMember 'db_datawriter','$user'", true);
2008     }
2009
2010     /**
2011      * Create a database
2012      * @param string $dbname
2013      */
2014     public function createDatabase($dbname)
2015     {
2016         return $this->query("CREATE DATABASE $dbname", true);
2017     }
2018
2019     /**
2020      * Drop a database
2021      * @param string $dbname
2022      */
2023     public function dropDatabase($dbname)
2024     {
2025         return $this->query("DROP DATABASE $dbname", true);
2026     }
2027
2028     /**
2029      * Check if this driver can be used
2030      * @return bool
2031      */
2032     public function valid()
2033     {
2034         return function_exists("mssql_connect");
2035     }
2036
2037     /**
2038      * Check if this DB name is valid
2039      *
2040      * @param string $name
2041      * @return bool
2042      */
2043     public function isDatabaseNameValid($name)
2044     {
2045         // No funny chars, does not begin with number
2046         return preg_match('/^[0-9#@]+|[\"\'\*\/\\?\:\\<\>\-\ \&\!\(\)\[\]\{\}\;\,\.\`\~\|\\\\]+/', $name)==0;
2047     }
2048
2049     public function installConfig()
2050     {
2051         return array(
2052                 'LBL_DBCONFIG_MSG3' =>  array(
2053                 "setup_db_database_name" => array("label" => 'LBL_DBCONF_DB_NAME', "required" => true),
2054             ),
2055             'LBL_DBCONFIG_MSG2' =>  array(
2056                 "setup_db_host_name" => array("label" => 'LBL_DBCONF_HOST_NAME', "required" => true),
2057                 "setup_db_host_instance" => array("label" => 'LBL_DBCONF_HOST_INSTANCE'),
2058             ),
2059             'LBL_DBCONF_TITLE_USER_INFO' => array(),
2060             'LBL_DBCONFIG_B_MSG1' => array(
2061                 "setup_db_admin_user_name" => array("label" => 'LBL_DBCONF_DB_ADMIN_USER', "required" => true),
2062                 "setup_db_admin_password" => array("label" => 'LBL_DBCONF_DB_ADMIN_PASSWORD', "type" => "password"),
2063             )
2064         );
2065     }
2066
2067     /**
2068      * Returns a DB specific FROM clause which can be used to select against functions.
2069      * Note that depending on the database that this may also be an empty string.
2070      * @return string
2071      */
2072     public function getFromDummyTable()
2073     {
2074         return '';
2075     }
2076
2077     /**
2078      * Returns a DB specific piece of SQL which will generate GUID (UUID)
2079      * This string can be used in dynamic SQL to do multiple inserts with a single query.
2080      * I.e. generate a unique Sugar id in a sub select of an insert statement.
2081      * @return string
2082      */
2083         public function getGuidSQL()
2084     {
2085         return 'NEWID()';
2086     }
2087 }