include/database/MssqlManager.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 /*********************************************************************************
  39
  40 * Description: This file handles the Data base functionality for the application.
  41 * It acts as the DB abstraction layer for the application. It depends on helper classes
  42 * which generate the necessary SQL. This sql is then passed to PEAR DB classes.
  43 * The helper class is chosen in DBManagerFactory, which is driven by 'db_type' in 'dbconfig' under config.php.
  44 *
  45 * All the functions in this class will work with any bean which implements the meta interface.
  46 * The passed bean is passed to helper class which uses these functions to generate correct sql.
  47 *
  48 * The meta interface has the following functions:
  49 * getTableName()                        Returns table name of the object.
  50 * getFieldDefinitions()         Returns a collection of field definitions in order.
  51 * getFieldDefintion(name)               Return field definition for the field.
  52 * getFieldValue(name)           Returns the value of the field identified by name.
  53 *                               If the field is not set, the function will return boolean FALSE.
  54 * getPrimaryFieldDefinition()   Returns the field definition for primary key
  55 *
  56 * The field definition is an array with the following keys:
  57 *
  58 * name          This represents name of the field. This is a required field.
  59 * type          This represents type of the field. This is a required field and valid values are:
  60 *               int
  61 *               long
  62 *               varchar
  63 *               text
  64 *               date
  65 *               datetime
  66 *               double
  67 *               float
  68 *               uint
  69 *               ulong
  70 *               time
  71 *               short
  72 *               enum
  73 * length        This is used only when the type is varchar and denotes the length of the string.
  74 *                       The max value is 255.
  75 * enumvals  This is a list of valid values for an enum separated by "|".
  76 *                       It is used only if the type is ?enum?;
  77 * required      This field dictates whether it is a required value.
  78 *                       The default value is ?FALSE?.
  79 * isPrimary     This field identifies the primary key of the table.
  80 *                       If none of the fields have this flag set to ?TRUE?,
  81 *                       the first field definition is assume to be the primary key.
  82 *                       Default value for this field is ?FALSE?.
  83 * default       This field sets the default value for the field definition.
  84 *
  85 *
  86 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  87 * All Rights Reserved.
  88 * Contributor(s): ______________________________________..
  89 ********************************************************************************/
  90
  91 class MssqlManager extends DBManager
  92 {
  93     /**
  94      * @see DBManager::$dbType
  95      */
  96     public $dbType = 'mssql';
  97
  98         /**
  99      * @see DBManager::$backendFunctions
 100      */
 101     protected $backendFunctions = array(
 102         'free_result' => 'mssql_free_result',
 103         'close'       => 'mssql_close',
 104         'row_count'   => 'mssql_num_rows'
 105         );
 106
 107
 108         /**
 109      * @see DBManager::connect()
 110      */
 111     public function connect(
 112         array $configOptions = null,
 113         $dieOnError = false
 114         )
 115     {
 116         global $sugar_config;
 117
 118         if (is_null($configOptions))
 119             $configOptions = $sugar_config['dbconfig'];
 120
 121         //SET DATEFORMAT to 'YYYY-MM-DD''
 122         ini_set('mssql.datetimeconvert', '0');
 123
 124         //set the text size and textlimit to max number so that blob columns are not truncated
 125         ini_set('mssql.textlimit','2147483647');
 126         ini_set('mssql.textsize','2147483647');
 127
 128         //set the connections parameters
 129         $connect_param = '';
 130         $configOptions['db_host_instance'] = trim($configOptions['db_host_instance']);
 131         if (empty($configOptions['db_host_instance']))
 132             $connect_param = $configOptions['db_host_name'];
 133         else
 134             $connect_param = $configOptions['db_host_name']."\\".$configOptions['db_host_instance'];
 135
 136         //create persistent connection
 137         if ($sugar_config['dbconfigoption']['persistent'] == true) {
 138             $this->database =@mssql_pconnect(
 139                 $connect_param ,
 140                 $configOptions['db_user_name'],
 141                 $configOptions['db_password']
 142                 );
 143         }
 144         //if no persistent connection created, then create regular connection
 145         if(!$this->database){
 146             $this->database = mssql_connect(
 147                     $connect_param ,
 148                     $configOptions['db_user_name'],
 149                     $configOptions['db_password']
 150                     );
 151             if(!$this->database){
 152                 $GLOBALS['log']->fatal("Could not connect to server ".$configOptions['db_host_name'].
 153                     " as ".$configOptions['db_user_name'].".");
 154                 sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
 155             }
 156             if($this->database && $sugar_config['dbconfigoption']['persistent'] == true){
 157                 $_SESSION['administrator_error'] = "<B>Severe Performance Degradation: Persistent Database Connections "
 158                     . "not working.  Please set \$sugar_config['dbconfigoption']['persistent'] to false in your "
 159                     . "config.php file</B>";
 160             }
 161         }
 162         //make sure connection exists
 163         if(!$this->database){
 164             sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
 165         }
 166
 167         //select database
 168
 169         //Adding sleep and retry for mssql connection. We have come across scenarios when
 170         //an error is thrown.' Unable to select database'. Following will try to connect to
 171         //mssql db maximum number of 5 times at the interval of .2 second. If can not connect
 172         //it will throw an Unable to select database message.
 173
 174         if(!@mssql_select_db($configOptions['db_name'], $this->database)){
 175                         $connected = false;
 176                         for($i=0;$i<5;$i++){
 177                                 usleep(200000);
 178                                 if(@mssql_select_db($configOptions['db_name'], $this->database)){
 179                                         $connected = true;
 180                                         break;
 181                                 }
 182                         }
 183                         if(!$connected){
 184                             $GLOBALS['log']->fatal( "Unable to select database {$configOptions['db_name']}");
 185                                 sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
 186                         }
 187          }
 188
 189         if($this->checkError('Could Not Connect', $dieOnError))
 190             $GLOBALS['log']->info("connected to db");
 191
 192         $GLOBALS['log']->info("Connect:".$this->database);
 193     }
 194
 195         /**
 196      * @see DBManager::version()
 197      */
 198     public function version()
 199     {
 200         return $this->getOne("SELECT @@VERSION as version");
 201         }
 202
 203     /**
 204      * @see DBManager::checkError()
 205      */
 206     public function checkError(
 207         $msg = '',
 208         $dieOnError = false
 209         )
 210     {
 211         if (parent::checkError($msg, $dieOnError))
 212             return true;
 213
 214         $sqlmsg = mssql_get_last_message();
 215         $sqlpos = strpos($sqlmsg, 'Changed database context to');
 216         $sqlpos2 = strpos($sqlmsg, 'Caution: Changing any part of an object name could break scripts and stored procedures.');
 217         if ( $sqlpos !== false || $sqlpos2 !== false )
 218             $sqlmsg = '';  // empty out sqlmsg if its either of the two error messages described above
 219         else {
 220                 global $app_strings;
 221             //ERR_MSSQL_DB_CONTEXT: localized version of 'Changed database context to' message
 222             if (empty($app_strings) or !isset($app_strings['ERR_MSSQL_DB_CONTEXT'])) {
 223                 //ignore the message from sql-server if $app_strings array is empty. This will happen
 224                 //only if connection if made before languge is set.
 225                 $GLOBALS['log']->debug("Ignoring this database message: " . $sqlmsg);
 226                 $sqlmsg = '';
 227             }
 228             else {
 229                 $sqlpos = strpos($sqlmsg, $app_strings['ERR_MSSQL_DB_CONTEXT']);
 230                 if ( $sqlpos !== false )
 231                     $sqlmsg = '';
 232             }
 233         }
 234
 235         if ( strlen($sqlmsg) > 2 ) {
 236                 $GLOBALS['log']->fatal("$msg: SQL Server error: " . $sqlmsg);
 237             return true;
 238         }
 239
 240         return false;
 241         }
 242
 243         /**
 244      * @see DBManager::query()
 245          */
 246         public function query(
 247         $sql,
 248         $dieOnError = false,
 249         $msg = '',
 250         $suppress = false
 251         )
 252     {
 253         // Flag if there are odd number of single quotes
 254         if ((substr_count($sql, "'") & 1))
 255             $GLOBALS['log']->error("SQL statement[" . $sql . "] has odd number of single quotes.");
 256
 257         $this->countQuery($sql);
 258         $GLOBALS['log']->info('Query:' . $sql);
 259         $this->checkConnection();
 260         $this->query_time = microtime(true);
 261
 262         // Bug 34892 - Clear out previous error message by checking the @@ERROR global variable
 263         $errorNumberHandle = mssql_query("SELECT @@ERROR",$this->database);
 264                 $errorNumber = array_shift(mssql_fetch_row($errorNumberHandle));
 265
 266         if ($suppress) {
 267         }
 268         else {
 269             $result = @mssql_query($sql, $this->database);
 270         }
 271
 272         $this->lastmysqlrow = -1;
 273
 274         $this->query_time = microtime(true) - $this->query_time;
 275         $GLOBALS['log']->info('Query Execution Time:'.$this->query_time);
 276
 277
 278         $this->checkError($msg.' Query Failed: ' . $sql, $dieOnError);
 279
 280         return $result;
 281     }
 282
 283     /**
 284      * This function take in the sql for a union query, the start and offset,
 285      * and wraps it around an "mssql friendly" limit query
 286      *
 287      * @param  string $sql
 288      * @param  int    $start record to start at
 289      * @param  int    $count number of records to retrieve
 290      * @return string SQL statement
 291      */
 292     private function handleUnionLimitQuery(
 293         $sql,
 294         $start,
 295         $count
 296         )
 297     {
 298         //set the start to 0, no negs
 299         if ($start < 0)
 300             $start=0;
 301
 302         $GLOBALS['log']->debug(print_r(func_get_args(),true));
 303
 304         $this->lastsql = $sql;
 305
 306         //change the casing to lower for easier string comparison, and trim whitespaces
 307         $sql = strtolower(trim($sql)) ;
 308
 309         //set default sql
 310         $limitUnionSQL = $sql;
 311         $order_by_str = 'order by';
 312
 313         //make array of order by's.  substring approach was proving too inconsistent
 314         $orderByArray = explode($order_by_str, $sql);
 315         $unionOrderBy = '';
 316         $rowNumOrderBy = '';
 317
 318         //count the number of array elements
 319         $unionOrderByCount = count($orderByArray);
 320         $arr_count = 0;
 321
 322         //process if there are elements
 323         if ($unionOrderByCount){
 324             //we really want the last ordery by, so reconstruct string
 325             //adding a 1 to count, as we dont wish to process the last element
 326             $unionsql = '';
 327             while ($unionOrderByCount>$arr_count+1) {
 328                 $unionsql .= $orderByArray[$arr_count];
 329                 $arr_count = $arr_count+1;
 330                 //add an "order by" string back if we are coming into loop again
 331                 //remember they were taken out when array was created
 332                 if ($unionOrderByCount>$arr_count+1) {
 333                     $unionsql .= "order by";
 334                 }
 335             }
 336             //grab the last order by element, set both order by's'
 337             $unionOrderBy = $orderByArray[$arr_count];
 338             $rowNumOrderBy = $unionOrderBy;
 339
 340             //if last element contains a "select", then this is part of the union query,
 341             //and there is no order by to use
 342             if (strpos($unionOrderBy, "select")) {
 343                 $unionsql = $sql;
 344                 //with no guidance on what to use for required order by in rownumber function,
 345                 //resort to using name column.
 346                 $rowNumOrderBy = 'id';
 347                 $unionOrderBy = "";
 348             }
 349         }
 350         else {
 351             //there are no order by elements, so just pass back string
 352             $unionsql = $sql;
 353             //with no guidance on what to use for required order by in rownumber function,
 354             //resort to using name column.
 355             $rowNumOrderBy = 'id';
 356             $unionOrderBy = '';
 357         }
 358         //Unions need the column name being sorted on to match acroos all queries in Union statement
 359         //so we do not want to strip the alias like in other queries.  Just add the "order by" string and
 360         //pass column name as is
 361         if ($unionOrderBy != '') {
 362             $unionOrderBy = ' order by ' . $unionOrderBy;
 363         }
 364
 365         //if start is 0, then just use a top query
 366         if($start == 0) {
 367             $limitUnionSQL = "select top $count * from (" .$unionsql .") as top_count ".$unionOrderBy;
 368         }
 369         else {
 370             //if start is more than 0, then use top query in conjunction
 371             //with rownumber() function to create limit query.
 372             $limitUnionSQL = "select top $count * from( select ROW_NUMBER() OVER ( order by "
 373             .$rowNumOrderBy.") AS row_number, * from ("
 374             .$unionsql .") As numbered) "
 375             . "As top_count_limit WHERE row_number > $start "
 376             .$unionOrderBy;
 377         }
 378
 379         return $limitUnionSQL;
 380     }
 381
 382         /**
 383      * @see DBManager::limitQuery()
 384      */
 385     public function limitQuery(
 386         $sql,
 387         $start,
 388         $count,
 389         $dieOnError = false,
 390         $msg = '')
 391     {
 392         $newSQL = $sql;
 393         $distinctSQLARRAY = array();
 394         if (strpos($sql, "UNION") && !preg_match("/(\')(UNION).?(\')/i", $sql))
 395             $newSQL = $this->handleUnionLimitQuery($sql,$start,$count);
 396         else {
 397             if ($start < 0)
 398                 $start = 0;
 399             $GLOBALS['log']->debug(print_r(func_get_args(),true));
 400             $this->lastsql = $sql;
 401             $matches = array();
 402             preg_match('/^(.*SELECT )(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
 403             if (!empty($matches[3])) {
 404                 if ($start == 0) {
 405                     $match_two = strtolower($matches[2]);
 406                     if (!strpos($match_two, "distinct")> 0 && strpos($match_two, "distinct") !==0) {
 407                                         //proceed as normal
 408                         $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
 409                     }
 410                     else {
 411                         $distinct_o = strpos($match_two, "distinct");
 412                         $up_to_distinct_str = substr($match_two, 0, $distinct_o);
 413                         //check to see if the distinct is within a function, if so, then proceed as normal
 414                         if (strpos($up_to_distinct_str,"(")) {
 415                             //proceed as normal
 416                             $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
 417                         }
 418                         else {
 419                             //if distinct is not within a function, then parse
 420                             //string contains distinct clause, "TOP needs to come after Distinct"
 421                             //get position of distinct
 422                             $match_zero = strtolower($matches[0]);
 423                             $distinct_pos = strpos($match_zero , "distinct");
 424                             //get position of where
 425                             $where_pos = strpos($match_zero, "where");
 426                             //parse through string
 427                             $beg = substr($matches[0], 0, $distinct_pos+9 );
 428                             $mid = substr($matches[0], strlen($beg), ($where_pos+5) - (strlen($beg)));
 429                             $end = substr($matches[0], strlen($beg) + strlen($mid) );
 430                             //repopulate matches array
 431                             $matches[1] = $beg; $matches[2] = $mid; $matches[3] = $end;
 432
 433                             $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
 434                         }
 435                     }
 436                 }
 437                 else {
 438                     $orderByMatch = array();
 439                     preg_match('/^(.*)(ORDER BY)(.*)$/is',$matches[3], $orderByMatch);
 440
 441                     //if there is a distinct clause, parse sql string as we will have to insert the rownumber
 442                     //for paging, AFTER the distinct clause
 443                     $hasDistinct = strpos(strtolower($matches[0]), "distinct");
 444                     if ($hasDistinct) {
 445                         $matches_sql = strtolower($matches[0]);
 446                         //remove reference to distinct and select keywords, as we will use a group by instead
 447                         //we need to use group by because we are introducing rownumber column which would make every row unique
 448
 449                         //take out the select and distinct from string so we can reuse in group by
 450                         $dist_str = ' distinct ';
 451                         $distinct_pos = strpos($matches_sql, $dist_str);
 452                         $matches_sql = substr($matches_sql,$distinct_pos+ strlen($dist_str));
 453                         //get the position of where and from for further processing
 454                         $from_pos = strpos($matches_sql , " from ");
 455                         $where_pos = strpos($matches_sql, "where");
 456                         //split the sql into a string before and after the from clause
 457                         //we will use the columns being selected to construct the group by clause
 458                         if ($from_pos>0 ) {
 459                             $distinctSQLARRAY[0] = substr($matches_sql,0, $from_pos+1);
 460                             $distinctSQLARRAY[1] = substr($matches_sql,$from_pos+1);
 461                             //get position of order by (if it exists) so we can strip it from the string
 462                             $ob_pos = strpos($distinctSQLARRAY[1], "order by");
 463                             if ($ob_pos) {
 464                                 $distinctSQLARRAY[1] = substr($distinctSQLARRAY[1],0,$ob_pos);
 465                             }
 466                         }
 467
 468                         //place group by string into array
 469                         $grpByArr = explode(',', $distinctSQLARRAY[0]);
 470                         $grpByStr = '';
 471                         $first = true;
 472                         //remove the aliases for each group by element, sql server doesnt like these in group by.
 473                         foreach ($grpByArr as $gb) {
 474                             $gb = trim($gb);
 475
 476                             //remove outer reference if they exist
 477                             if (strpos($gb,"'")!==false){
 478                                 continue;
 479                             }
 480                             //if there is a space, then an alias exists, remove alias
 481                             if (strpos($gb,' ')){
 482                                 $gb = substr( $gb, 0,strpos($gb,' '));
 483                             }
 484
 485                             //if resulting string is not empty then add to new group by string
 486                             if (!empty($gb)) {
 487                                 if ($first) {
 488                                     $grpByStr .= " $gb";
 489                                     $first = false;
 490                                 }
 491                                 else {
 492                                     $grpByStr .= ", $gb";
 493                                 }
 494                             }
 495                         }
 496                     }
 497
 498                     if (!empty($orderByMatch[3])) {
 499                         //if there is a distinct clause, form query with rownumber after distinct
 500                         if ($hasDistinct) {
 501                             $newSQL = "SELECT TOP $count * FROM
 502                                         (
 503                                             SELECT ROW_NUMBER()
 504                                                 OVER (ORDER BY ".$this->returnOrderBy($sql, $orderByMatch[3]).") AS row_number,
 505                                                 count(*) counter, " . $distinctSQLARRAY[0] . "
 506                                                 " . $distinctSQLARRAY[1] . "
 507                                                 group by " . $grpByStr . "
 508                                         ) AS a
 509                                         WHERE row_number > $start";
 510                         }
 511                         else {
 512                         $newSQL = "SELECT TOP $count * FROM
 513                                     (
 514                                         " . $matches[1] . " ROW_NUMBER()
 515                                         OVER (ORDER BY " . $this->returnOrderBy($sql, $orderByMatch[3]) . ") AS row_number,
 516                                         " . $matches[2] . $orderByMatch[1]. "
 517                                     ) AS a
 518                                     WHERE row_number > $start";
 519                         }
 520                     }else{
 521                         //bug: 22231 Records in campaigns' subpanel may not come from
 522                         //table of $_REQUEST['module']. Get it directly from query
 523                         $upperQuery = strtoupper($matches[2]);
 524                         if (!strpos($upperQuery,"JOIN")){
 525                             $from_pos = strpos($upperQuery , "FROM") + 4;
 526                             $where_pos = strpos($upperQuery, "WHERE");
 527                             $tablename = trim(substr($upperQuery,$from_pos, $where_pos - $from_pos));
 528                         }else{
 529                             $tablename = $this->getTableNameFromModuleName($_REQUEST['module'],$sql);
 530                         }
 531                         //if there is a distinct clause, form query with rownumber after distinct
 532                         if ($hasDistinct) {
 533                              $newSQL = "SELECT TOP $count * FROM
 534                                             (
 535                             SELECT ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, count(*) counter, " . $distinctSQLARRAY[0] . "
 536                                                         " . $distinctSQLARRAY[1] . "
 537                                                     group by " . $grpByStr . "
 538                                             )
 539                                             AS a
 540                                             WHERE row_number > $start";
 541                         }
 542                         else {
 543                              $newSQL = "SELECT TOP $count * FROM
 544                                            (
 545                                   " . $matches[1] . " ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, " . $matches[2] . $matches[3]. "
 546                                            )
 547                                            AS a
 548                                            WHERE row_number > $start";
 549                         }
 550                     }
 551                 }
 552             }
 553         }
 554
 555         $GLOBALS['log']->debug('Limit Query: ' . $newSQL);
 556         $result =  $this->query($newSQL, $dieOnError, $msg);
 557         $this->dump_slow_queries($newSQL);
 558         return $result;
 559     }
 560
 561
 562     /**
 563      * Searches for begginning and ending characters.  It places contents into
 564      * an array and replaces contents in original string.  This is used to account for use of
 565      * nested functions while aliasing column names
 566      *
 567      * @param  string $p_sql     SQL statement
 568      * @param  string $strip_beg Beginning character
 569      * @param  string $strip_end Ending character
 570      * @param  string $patt      Optional, pattern to
 571      */
 572     private function removePatternFromSQL(
 573         $p_sql,
 574         $strip_beg,
 575         $strip_end,
 576         $patt = 'patt')
 577     {
 578         //strip all single quotes out
 579         $beg_sin = 0;
 580         $sec_sin = 0;
 581         $count = substr_count ( $p_sql, $strip_beg);
 582         $increment = 1;
 583         if ($strip_beg != $strip_end)
 584             $increment = 2;
 585
 586         $i=0;
 587         $offset = 0;
 588         $strip_array = array();
 589         while ($i<$count) {
 590             $beg_sin = strpos($p_sql, $strip_beg, $offset);
 591             if (!$beg_sin)
 592                 break;
 593             $sec_sin = strpos($p_sql, $strip_end, $beg_sin+1);
 594             $strip_array[$patt.$i] = substr($p_sql, $beg_sin, $sec_sin - $beg_sin +1);
 595             if ($increment > 1) {
 596                 //we are in here because beginning and end patterns are not identical, so search for nesting
 597                 $exists = strpos($strip_array[$patt.$i], $strip_beg );
 598                 if ($exists>=0) {
 599                     $nested_pos = (strrpos($strip_array[$patt.$i], $strip_beg ));
 600                     $strip_array[$patt.$i] = substr($p_sql,$nested_pos+$beg_sin,$sec_sin - ($nested_pos+$beg_sin)+1);
 601                     $p_sql = substr($p_sql, 0, $nested_pos+$beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
 602                     $i = $i + 1;
 603                     $beg_sin = $nested_pos;
 604                     continue;
 605                 }
 606             }
 607             $p_sql = substr($p_sql, 0, $beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
 608             //move the marker up
 609             $offset = $sec_sin+1;
 610
 611             $i = $i + 1;
 612         }
 613         $strip_array['sql_string'] = $p_sql;
 614
 615         return $strip_array;
 616     }
 617
 618     /**
 619      * adds a pattern
 620      *
 621      * @param  string $token
 622      * @param  array  $pattern_array
 623      * @return string
 624      */
 625         private function addPatternToSQL(
 626         $token,
 627         array $pattern_array
 628         )
 629     {
 630         //strip all single quotes out
 631         $pattern_array = array_reverse($pattern_array);
 632
 633         foreach ($pattern_array as $key => $replace) {
 634             $token = str_replace( "##".$key."##", $replace,$token);
 635         }
 636
 637         return $token;
 638     }
 639
 640     /**
 641      * gets an alias from the sql statement
 642      *
 643      * @param  string $sql
 644      * @param  string $alias
 645      * @return string
 646      */
 647         private function getAliasFromSQL(
 648         $sql,
 649         $alias
 650         )
 651     {
 652         $matches = array();
 653         preg_match('/^(.*SELECT)(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
 654         //parse all single and double  quotes out of array
 655         $sin_array = $this->removePatternFromSQL($matches[2], "'", "'","sin_");
 656         $new_sql = array_pop($sin_array);
 657         $dub_array = $this->removePatternFromSQL($new_sql, "\"", "\"","dub_");
 658         $new_sql = array_pop($dub_array);
 659
 660         //search for parenthesis
 661         $paren_array = $this->removePatternFromSQL($new_sql, "(", ")", "par_");
 662         $new_sql = array_pop($paren_array);
 663
 664         //all functions should be removed now, so split the array on comma's
 665         $mstr_sql_array = explode(",", $new_sql);
 666         foreach($mstr_sql_array as $token ) {
 667             if (strpos($token, $alias)) {
 668                 //found token, add back comments
 669                 $token = $this->addPatternToSQL($token, $paren_array);
 670                 $token = $this->addPatternToSQL($token, $dub_array);
 671                 $token = $this->addPatternToSQL($token, $sin_array);
 672
 673                 //log and break out of this function
 674                 return $token;
 675             }
 676         }
 677         return null;
 678     }
 679
 680
 681     /**
 682      * Finds the alias of the order by column, and then return the preceding column name
 683      *
 684      * @param  string $sql
 685      * @param  string $orderMatch
 686      * @return string
 687      */
 688     private function findColumnByAlias(
 689         $sql,
 690         $orderMatch
 691         )
 692     {
 693         //change case to lowercase
 694         $sql = strtolower($sql);
 695         $patt = '/\s+'.trim($orderMatch).'\s*,/';
 696
 697         //check for the alias, it should contain comma, may contain space, \n, or \t
 698         $matches = array();
 699         preg_match($patt, $sql, $matches, PREG_OFFSET_CAPTURE);
 700         $found_in_sql = isset($matches[0][1]) ? $matches[0][1] : false;
 701
 702
 703         //set default for found variable
 704         $found = $found_in_sql;
 705
 706         //if still no match found, then we need to parse through the string
 707         if (!$found_in_sql){
 708             //get count of how many times the match exists in string
 709             $found_count = substr_count($sql, $orderMatch);
 710             $i = 0;
 711             $first_ = 0;
 712             $len = strlen($orderMatch);
 713             //loop through string as many times as there is a match
 714             while ($found_count > $i) {
 715                 //get the first match
 716                 $found_in_sql = strpos($sql, $orderMatch,$first_);
 717                 //make sure there was a match
 718                 if($found_in_sql){
 719                     //grab the next 2 individual characters
 720                     $str_plusone = substr($sql,$found_in_sql + $len,1);
 721                     $str_plustwo = substr($sql,$found_in_sql + $len+1,1);
 722                     //if one of those characters is a comma, then we have our alias
 723                     if ($str_plusone === "," || $str_plustwo === ","){
 724                         //keep track of this position
 725                         $found = $found_in_sql;
 726                     }
 727                 }
 728                 //set the offset and increase the iteration counter
 729                 $first_ = $found_in_sql+$len;
 730                 $i = $i+1;
 731             }
 732         }
 733         //return $found, defaults have been set, so if no match was found it will be a negative number
 734         return $found;
 735     }
 736
 737
 738     /**
 739      * Return the order by string to use in case the column has been aliased
 740      *
 741      * @param  string $sql
 742      * @param  string $orig_order_match
 743      * @return string
 744      */
 745     private function returnOrderBy(
 746         $sql,
 747         $orig_order_match
 748         )
 749     {
 750         $sql = strtolower($sql);
 751         $orig_order_match = trim($orig_order_match);
 752         if (strpos($orig_order_match, "."))
 753             //this has a tablename defined, pass in the order match
 754             return $orig_order_match;
 755
 756         //grab first space in order by
 757         $firstSpace = strpos($orig_order_match, " ");
 758
 759         //split order by into column name and ascending/descending
 760         $orderMatch = " " . strtolower(substr($orig_order_match, 0, $firstSpace));
 761         $asc_desc =  substr($orig_order_match,$firstSpace);
 762
 763         //look for column name as an alias in sql string
 764         $found_in_sql = $this->findColumnByAlias($sql, $orderMatch);
 765
 766         if (!$found_in_sql) {
 767             //check if this column needs the tablename prefixed to it
 768             $orderMatch = ".".trim($orderMatch);
 769             $colMatchPos = strpos($sql, $orderMatch);
 770             if ($colMatchPos !== false) {
 771                 //grab sub string up to column name
 772                 $containsColStr = substr($sql,0, $colMatchPos);
 773                 //get position of first space, so we can grab table name
 774                 $lastSpacePos = strrpos($containsColStr, " ");
 775                 //use positions of column name, space before name, and length of column to find the correct column name
 776                 $col_name = substr($sql, $lastSpacePos, $colMatchPos-$lastSpacePos+strlen($orderMatch));
 777                                 //bug 25485. When sorting by a custom field in Account List and then pressing NEXT >, system gives an error
 778                                 $containsCommaPos = strpos($col_name, ",");
 779                                 if($containsCommaPos !== false) {
 780                                         $col_name = substr($col_name, $containsCommaPos+1);
 781                                 }
 782                 //return column name
 783                 return $col_name;
 784             }
 785             //break out of here, log this
 786             $GLOBALS['log']->debug("No match was found for order by, pass string back untouched as: $orig_order_match");
 787             return $orig_order_match;
 788         }
 789         else {
 790             //if found, then parse and return
 791             //grab string up to the aliased column
 792             $GLOBALS['log']->debug("order by found, process sql string");
 793
 794             $psql = (trim($this->getAliasFromSQL($sql, $orderMatch )));
 795             if (empty($psql))
 796                 $psql = trim(substr($sql, 0, $found_in_sql));
 797
 798             //grab the last comma before the alias
 799             $comma_pos = strrpos($psql, " ");
 800             //substring between the comma and the alias to find the joined_table alias and column name
 801             $col_name = substr($psql,0, $comma_pos);
 802
 803             //make sure the string does not have an end parenthesis
 804             //and is not part of a function (i.e. "ISNULL(leads.last_name,'') as name"  )
 805             //this is especially true for unified search from home screen
 806
 807             if(strpos($psql, " as "))
 808                 $alias_beg_pos = strpos($psql, " as ");
 809             else
 810                 $alias_beg_pos = strpos($psql, " ");
 811
 812             $col_name = substr($psql,0, $alias_beg_pos );
 813             //add the "asc/desc" order back
 814             $col_name = $col_name. " ". $asc_desc;
 815
 816             //pass in new order by
 817             $GLOBALS['log']->debug("order by being returned is " . $col_name);
 818             return $col_name;
 819         }
 820     }
 821
 822     /**
 823      * Take in a string of the module and retrieve the correspondent table name
 824      *
 825      * @param  string $module_str module name
 826      * @param  string $sql        SQL statement
 827      * @return string table name
 828      */
 829     private function getTableNameFromModuleName(
 830         $module_str,
 831         $sql
 832         )
 833     {
 834
 835         global $beanList, $beanFiles;
 836         $GLOBALS['log']->debug("Module being processed is " . $module_str);
 837         //get the right module files
 838         //the module string exists in bean list, then process bean for correct table name
 839         //note that we exempt the reports module from this, as queries from reporting module should be parsed for
 840         //correct table name.
 841         if (($module_str != 'Reports' && $module_str != 'SavedReport') && isset($beanList[$module_str])  &&  isset($beanFiles[$beanList[$module_str]])){
 842             //if the class is not already loaded, then load files
 843             if (!class_exists($beanList[$module_str]))
 844                 require_once($beanFiles[$beanList[$module_str]]);
 845
 846             //instantiate new bean
 847             $module_bean = new $beanList[$module_str]();
 848             //get table name from bean
 849             $tbl_name = $module_bean->table_name;
 850             //make sure table name is not just a blank space, or empty
 851             $tbl_name = trim($tbl_name);
 852
 853             if(empty($tbl_name)){
 854                 $GLOBALS['log']->debug("Could not find table name for module $module_str. ");
 855                 $tbl_name = $module_str;
 856             }
 857         }
 858         else {
 859             //since the module does NOT exist in beanlist, then we have to parse the string
 860             //and grab the table name from the passed in sql
 861             $GLOBALS['log']->debug("Could not find table name from module in request, retrieve from passed in sql");
 862             $tbl_name = $module_str;
 863             $sql = strtolower($sql);
 864
 865             //look for the location of the "from" in sql string
 866             $fromLoc = strpos ( $sql,"from" );
 867             if ($fromLoc>0){
 868                 //found from, substring from the "FROM" string in sql to end
 869                 $tableEnd = substr($sql, $fromLoc+5);
 870                 //We know that tablename will be next parameter after from, so
 871                 //grab the next space after table name.
 872                 // 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.
 873                 $carriage_ret = strpos($tableEnd,"\n");
 874                 $next_space = strpos ( $tableEnd," " );
 875                 if ($carriage_ret < $next_space)
 876                     $next_space = $carriage_ret;
 877                 if ($next_space > 0) {
 878                     $tbl_name= substr($tableEnd,0, $next_space);
 879                     if(empty($tbl_name)){
 880                         $GLOBALS['log']->debug("Could not find table name sql either, return $module_str. ");
 881                         $tbl_name = $module_str;
 882                     }
 883                 }
 884
 885                 //grab the table, to see if it is aliased
 886                 $aliasTableEnd = trim(substr($tableEnd, $next_space));
 887                 $alias_space = strpos ($aliasTableEnd, " " );
 888                 if ($alias_space > 0){
 889                     $alias_tbl_name= substr($aliasTableEnd,0, $alias_space);
 890                     strtolower($alias_tbl_name);
 891                     if(empty($alias_tbl_name)
 892                         || $alias_tbl_name == "where"
 893                         || $alias_tbl_name == "inner"
 894                         || $alias_tbl_name == "left"
 895                         || $alias_tbl_name == "join"
 896                         || $alias_tbl_name == "outer"
 897                         || $alias_tbl_name == "right") {
 898                         //not aliased, do nothing
 899                     }
 900                     elseif ($alias_tbl_name == "as") {
 901                             //the next word is the table name
 902                             $aliasTableEnd = trim(substr($aliasTableEnd, $alias_space));
 903                             $alias_space = strpos ($aliasTableEnd, " " );
 904                             if ($alias_space > 0) {
 905                                 $alias_tbl_name= trim(substr($aliasTableEnd,0, $alias_space));
 906                                 if (!empty($alias_tbl_name))
 907                                     $tbl_name = $alias_tbl_name;
 908                             }
 909                     }
 910                     else {
 911                         //this is table alias
 912                         $tbl_name = $alias_tbl_name;
 913                     }
 914                 }
 915             }
 916         }
 917         //return table name
 918         $GLOBALS['log']->debug("Table name for module $module_str is: ".$tbl_name);
 919         return $tbl_name;
 920     }
 921
 922
 923         /**
 924      * @see DBManager::getFieldsArray()
 925      */
 926         public function getFieldsArray(
 927         &$result,
 928         $make_lower_case = false
 929         )
 930         {
 931                 $field_array = array();
 932
 933                 if(! isset($result) || empty($result))
 934             return 0;
 935
 936         $i = 0;
 937         while ($i < mssql_num_fields($result)) {
 938             $meta = mssql_fetch_field($result, $i);
 939             if (!$meta)
 940                 return 0;
 941             if($make_lower_case==true)
 942                 $meta->name = strtolower($meta->name);
 943
 944             $field_array[] = $meta->name;
 945
 946             $i++;
 947         }
 948
 949         return $field_array;
 950         }
 951
 952     /**
 953      * @see DBManager::getAffectedRowCount()
 954      */
 955         public function getAffectedRowCount()
 956     {
 957         return $this->getOne("SELECT @@ROWCOUNT");
 958     }
 959
 960     /**
 961      * @see DBManager::describeField()
 962      */
 963         protected function describeField(
 964         $name,
 965         $tablename
 966         )
 967     {
 968         global $table_descriptions;
 969         if(isset($table_descriptions[$tablename]) && isset($table_descriptions[$tablename][$name])){
 970             return      $table_descriptions[$tablename][$name];
 971         }
 972         $table_descriptions[$tablename] = array();
 973
 974         $sql = sprintf( "SELECT COLUMN_NAME AS Field
 975                                 , DATA_TYPE + CASE WHEN CHARACTER_MAXIMUM_LENGTH IS NOT NULL " .
 976                                                         "THEN '(' + RTRIM(CAST(CHARACTER_MAXIMUM_LENGTH AS CHAR)) + ')' " .
 977                                                         "ELSE '' END as 'Type'
 978                                 , CHARACTER_MAXIMUM_LENGTH
 979                                 , IS_NULLABLE AS 'Null'
 980                                 , CASE WHEN COLUMN_DEFAULT LIKE '((0))' THEN \"('0')\" ELSE COLUMN_DEFAULT END as 'Default'
 981                         FROM INFORMATION_SCHEMA.COLUMNS
 982                         WHERE TABLE_NAME = '%s'",
 983                         $tablename
 984         );
 985
 986         $result = $this->query($sql);
 987         while ($row = $this->fetchByAssoc($result) )
 988             $table_descriptions[$tablename][$row['Field']] = $row;
 989
 990         if (isset($table_descriptions[$tablename][$name]))
 991             return      $table_descriptions[$tablename][$name];
 992
 993         return array();
 994     }
 995
 996
 997
 998         /**
 999      * @see DBManager::fetchByAssoc()
1000      */
1001     public function fetchByAssoc(
1002         &$result,
1003         $rowNum = -1,
1004         $encode = true
1005         )
1006     {
1007         if (!$result)
1008             return false;
1009
1010                 if ($result && $rowNum < 0) {
1011             $row = mssql_fetch_assoc($result);
1012             //MSSQL returns a space " " when a varchar column is empty ("") and not null.
1013             //We need to iterate through the returned row array and strip empty spaces
1014             if(!empty($row)){
1015                 foreach($row as $key => $column) {
1016                     //notice we only strip if one space is returned.  we do not want to strip
1017                     //strings with intentional spaces (" foo ")
1018                     if (!empty($column) && $column ==" ") {
1019                         $row[$key] = '';
1020                     }
1021                 }
1022             }
1023
1024             if($encode && $this->encode&& is_array($row))
1025                 return array_map('to_html', $row);
1026
1027             return $row;
1028                 }
1029
1030                 if ($this->getRowCount($result) > $rowNum) {
1031                         if ( $rowNum == -1 )
1032                 $rowNum = 0;
1033                         @mssql_data_seek($result, $rowNum);
1034         }
1035
1036         $this->lastmysqlrow = $rowNum;
1037         $row = @mssql_fetch_assoc($result);
1038         if($encode && $this->encode && is_array($row))
1039             return array_map('to_html', $row);
1040         return $row;
1041         }
1042
1043     /**
1044      * @see DBManager::quote()
1045      */
1046     public function quote(
1047         $string,
1048         $isLike = true
1049         )
1050     {
1051         return $string = str_replace("'","''", parent::quote($string));
1052     }
1053
1054     /**
1055      * @see DBManager::quoteForEmail()
1056      */
1057     public function quoteForEmail(
1058         $string,
1059         $isLike = true
1060         )
1061     {
1062         return str_replace("'","''", $string);
1063     }
1064
1065
1066     /**
1067      * @see DBManager::tableExists()
1068      */
1069     public function tableExists(
1070         $tableName
1071         )
1072     {
1073         $GLOBALS['log']->info("tableExists: $tableName");
1074
1075         $this->checkConnection();
1076         $result = $this->query(
1077             "SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE='BASE TABLE' AND TABLE_NAME='".$tableName."'");
1078
1079         $rowCount = $this->getRowCount($result);
1080         $this->freeResult($result);
1081         return ($rowCount == 0) ? false : true;
1082     }
1083
1084     /**
1085      * @see DBManager::addIndexes()
1086      */
1087     public function addIndexes(
1088         $tablename,
1089         $indexes,
1090         $execute = true
1091         )
1092     {
1093         $alters = $this->helper->indexSQL($tablename,array(),$indexes);
1094         if ($execute)
1095             $this->query($alters);
1096
1097         return $alters;
1098     }
1099
1100     /**
1101      * @see DBManager::dropIndexes()
1102      */
1103     public function dropIndexes(
1104         $tablename,
1105         $indexes,
1106         $execute = true
1107         )
1108     {
1109         $sql = '';
1110         foreach ($indexes as $index) {
1111             if ( !empty($sql) ) $sql .= ";";
1112             $name = $index['name'];
1113             if($execute)
1114                 unset($GLOBALS['table_descriptions'][$tablename]['indexes'][$name]);
1115             if ($index['type'] == 'primary')
1116                 $sql .= "ALTER TABLE $tablename DROP CONSTRAINT $name";
1117             else
1118                 $sql .= "DROP INDEX $name on $tablename";
1119         }
1120         if (!empty($sql))
1121             if($execute)
1122                 $this->query($sql);
1123
1124         return $sql;
1125     }
1126
1127     /**
1128      * @see DBManager::checkQuery()
1129      */
1130     protected function checkQuery(
1131         $sql
1132         )
1133     {
1134         return true;
1135     }
1136
1137     /**
1138      * @see DBManager::getTablesArray()
1139      */
1140     public function getTablesArray()
1141     {
1142         $GLOBALS['log']->debug('MSSQL fetching table list');
1143
1144         if($this->getDatabase()) {
1145             $tables = array();
1146             $r = $this->query('SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES');
1147             if (is_resource($r)) {
1148                 while ($a = $this->fetchByAssoc($r))
1149                     $tables[] = $a['TABLE_NAME'];
1150
1151                 return $tables;
1152             }
1153         }
1154
1155         return false; // no database available
1156     }
1157
1158
1159     /**
1160      * This call is meant to be used during install, when Full Text Search is enabled
1161      * Indexing would always occur after a fresh sql server install, so this code creates
1162      * a catalog and table with full text index.
1163      */
1164     public function wakeupFTS()
1165     {
1166         $GLOBALS['log']->debug('MSSQL about to wakeup FTS');
1167
1168         if($this->getDatabase()) {
1169                 //create wakup catalog
1170                 $FTSqry[] = "if not exists(  select * from sys.fulltext_catalogs where name ='wakeup_catalog' )
1171                 CREATE FULLTEXT CATALOG wakeup_catalog
1172                 ";
1173
1174                 //drop wakeup table if it exists
1175                 $FTSqry[] = "IF EXISTS(SELECT 'fts_wakeup' FROM sysobjects WHERE name = 'fts_wakeup' AND xtype='U')
1176                     DROP TABLE fts_wakeup
1177                 ";
1178                 //create wakeup table
1179                 $FTSqry[] = "CREATE TABLE fts_wakeup(
1180                     id varchar(36) NOT NULL CONSTRAINT pk_fts_wakeup_id PRIMARY KEY CLUSTERED (id ASC ),
1181                     body text NULL,
1182                     kb_index int IDENTITY(1,1) NOT NULL CONSTRAINT wakeup_fts_unique_idx UNIQUE NONCLUSTERED
1183                 )
1184                 ";
1185                 //create full text index
1186                  $FTSqry[] = "CREATE FULLTEXT INDEX ON fts_wakeup
1187                 (
1188                     body
1189                     Language 0X0
1190                 )
1191                 KEY INDEX wakeup_fts_unique_idx ON wakeup_catalog
1192                 WITH CHANGE_TRACKING AUTO
1193                 ";
1194
1195                 //insert dummy data
1196                 $FTSqry[] = "INSERT INTO fts_wakeup (id ,body)
1197                 VALUES ('".create_guid()."', 'SugarCRM Rocks' )";
1198
1199
1200                 //create queries to stop and restart indexing
1201                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup STOP POPULATION';
1202                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup DISABLE';
1203                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup ENABLE';
1204                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING MANUAL';
1205                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup START FULL POPULATION';
1206                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING AUTO';
1207
1208                 foreach($FTSqry as $q){
1209                     sleep(3);
1210                     $this->query($q);
1211                 }
1212
1213
1214         }
1215
1216         return false; // no database available
1217     }
1218
1219     /**
1220      * @see DBManager::convert()
1221      */
1222     public function convert(
1223         $string,
1224         $type,
1225         array $additional_parameters = array(),
1226         array $additional_parameters_oracle_only = array()
1227         )
1228     {
1229         // convert the parameters array into a comma delimited string
1230         $additional_parameters_string = '';
1231         if (!empty($additional_parameters))
1232             $additional_parameters_string = ','.implode(',',$additional_parameters);
1233
1234         switch ($type) {
1235         case 'today': return "GETDATE()";
1236         case 'left': return "LEFT($string".$additional_parameters_string.")";
1237         case 'date_format':
1238             if(!empty($additional_parameters) && in_array("'%Y-%m'", $additional_parameters))
1239                return "CONVERT(varchar(7),". $string . ",120)";
1240             else
1241                return "CONVERT(varchar(10),". $string . ",120)";
1242         case 'IFNULL': return "ISNULL($string".$additional_parameters_string.")";
1243         case 'CONCAT': return "$string+".implode("+",$additional_parameters);
1244         case 'text2char': return "CAST($string AS varchar(8000))";
1245         }
1246
1247         return "$string";
1248     }
1249
1250     /**
1251      * @see DBManager::concat()
1252      */
1253     public function concat(
1254         $table,
1255         array $fields
1256         )
1257     {
1258         $ret = '';
1259
1260         foreach ( $fields as $index => $field )
1261                         if (empty($ret))
1262                             $ret =  db_convert($table.".".$field,'IFNULL', array("''"));
1263                         else
1264                             $ret .=     " + ' ' + ".db_convert($table.".".$field,'IFNULL', array("''"));
1265
1266                 return $ret;
1267     }
1268
1269     /**
1270      * @see DBManager::fromConvert()
1271      */
1272     public function fromConvert(
1273         $string,
1274         $type)
1275     {
1276         switch($type) {
1277         case 'datetime': return substr($string, 0,19);
1278         case 'date': return substr($string, 0,11);
1279         case 'time': return substr($string, 11);
1280                 }
1281
1282                 return $string;
1283     }
1284 }