]> CyberLeo.Net >> Repos - Github/sugarcrm.git/blob - include/database/MssqlManager.php
Release 6.2.2
[Github/sugarcrm.git] / 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-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         
216         $sqlpos = strpos($sqlmsg, 'Changed database context to');
217         $sqlpos2 = strpos($sqlmsg, 'Warning:');
218         $sqlpos3 = strpos($sqlmsg, 'Checking identity information:');
219         if ( $sqlpos !== false || $sqlpos2 !== false || $sqlpos3 !== false )
220             $sqlmsg = '';  // empty out sqlmsg if its either of the two error messages described above
221         else {
222                 global $app_strings;
223             //ERR_MSSQL_DB_CONTEXT: localized version of 'Changed database context to' message
224             if (empty($app_strings) or !isset($app_strings['ERR_MSSQL_DB_CONTEXT'])) {
225                 //ignore the message from sql-server if $app_strings array is empty. This will happen
226                 //only if connection if made before languge is set.
227                 $GLOBALS['log']->debug("Ignoring this database message: " . $sqlmsg);
228                 $sqlmsg = '';
229             }
230             else {
231                 $sqlpos = strpos($sqlmsg, $app_strings['ERR_MSSQL_DB_CONTEXT']);
232                 if ( $sqlpos !== false )
233                     $sqlmsg = '';
234             }
235         }
236
237         if ( strlen($sqlmsg) > 2 ) {
238                 $GLOBALS['log']->fatal("$msg: SQL Server error: " . $sqlmsg);
239             return true;
240         }
241
242         return false;
243         }
244
245         /**
246      * @see DBManager::query()
247          */
248         public function query(
249         $sql,
250         $dieOnError = false,
251         $msg = '',
252         $suppress = false
253         )
254     {
255         // Flag if there are odd number of single quotes
256         if ((substr_count($sql, "'") & 1))
257             $GLOBALS['log']->error("SQL statement[" . $sql . "] has odd number of single quotes.");
258
259         $this->countQuery($sql);
260         $GLOBALS['log']->info('Query:' . $sql);
261         $this->checkConnection();
262         $this->query_time = microtime(true);
263
264         // Bug 34892 - Clear out previous error message by checking the @@ERROR global variable
265         $errorNumberHandle = mssql_query("SELECT @@ERROR",$this->database);
266                 $errorNumber = array_shift(mssql_fetch_row($errorNumberHandle));
267
268         if ($suppress) {
269         }
270         else {
271             $result = @mssql_query($sql, $this->database);
272         }
273
274         if (!$result) {
275
276             // awu Bug 10657: ignoring mssql error message 'Changed database context to' - an intermittent
277             //                            and difficult to reproduce error. The message is only a warning, and does
278             //                            not affect the functionality of the query
279             $sqlmsg = mssql_get_last_message();
280             $sqlpos = strpos($sqlmsg, 'Changed database context to');
281                         $sqlpos2 = strpos($sqlmsg, 'Warning:');
282                         $sqlpos3 = strpos($sqlmsg, 'Checking identity information:');
283             
284                         if ($sqlpos !== false || $sqlpos2 !== false || $sqlpos3 !== false)              // if sqlmsg has 'Changed database context to', just log it
285                                 $GLOBALS['log']->debug($sqlmsg . ": " . $sql );
286                         else {
287                                 $GLOBALS['log']->fatal($sqlmsg . ": " . $sql );
288                                 if($dieOnError)
289                                         sugar_die('SQL Error : ' . $sqlmsg);
290                                 else
291                                         echo 'SQL Error : ' . $sqlmsg;
292                         }
293         }
294         $this->lastmysqlrow = -1;
295
296         $this->query_time = microtime(true) - $this->query_time;
297         $GLOBALS['log']->info('Query Execution Time:'.$this->query_time);
298
299
300         $this->checkError($msg.' Query Failed: ' . $sql, $dieOnError);
301
302         return $result;
303     }
304
305     /**
306      * This function take in the sql for a union query, the start and offset,
307      * and wraps it around an "mssql friendly" limit query
308      *
309      * @param  string $sql
310      * @param  int    $start record to start at
311      * @param  int    $count number of records to retrieve
312      * @return string SQL statement
313      */
314     private function handleUnionLimitQuery(
315         $sql,
316         $start,
317         $count
318         )
319     {
320         //set the start to 0, no negs
321         if ($start < 0)
322             $start=0;
323
324         $GLOBALS['log']->debug(print_r(func_get_args(),true));
325
326         $this->lastsql = $sql;
327
328         //change the casing to lower for easier string comparison, and trim whitespaces
329         $sql = strtolower(trim($sql)) ;
330
331         //set default sql
332         $limitUnionSQL = $sql;
333         $order_by_str = 'order by';
334
335         //make array of order by's.  substring approach was proving too inconsistent
336         $orderByArray = explode($order_by_str, $sql);
337         $unionOrderBy = '';
338         $rowNumOrderBy = '';
339
340         //count the number of array elements
341         $unionOrderByCount = count($orderByArray);
342         $arr_count = 0;
343
344         //process if there are elements
345         if ($unionOrderByCount){
346             //we really want the last ordery by, so reconstruct string
347             //adding a 1 to count, as we dont wish to process the last element
348             $unionsql = '';
349             while ($unionOrderByCount>$arr_count+1) {
350                 $unionsql .= $orderByArray[$arr_count];
351                 $arr_count = $arr_count+1;
352                 //add an "order by" string back if we are coming into loop again
353                 //remember they were taken out when array was created
354                 if ($unionOrderByCount>$arr_count+1) {
355                     $unionsql .= "order by";
356                 }
357             }
358             //grab the last order by element, set both order by's'
359             $unionOrderBy = $orderByArray[$arr_count];
360             $rowNumOrderBy = $unionOrderBy;
361
362             //if last element contains a "select", then this is part of the union query,
363             //and there is no order by to use
364             if (strpos($unionOrderBy, "select")) {
365                 $unionsql = $sql;
366                 //with no guidance on what to use for required order by in rownumber function,
367                 //resort to using name column.
368                 $rowNumOrderBy = 'id';
369                 $unionOrderBy = "";
370             }
371         }
372         else {
373             //there are no order by elements, so just pass back string
374             $unionsql = $sql;
375             //with no guidance on what to use for required order by in rownumber function,
376             //resort to using name column.
377             $rowNumOrderBy = 'id';
378             $unionOrderBy = '';
379         }
380         //Unions need the column name being sorted on to match acroos all queries in Union statement
381         //so we do not want to strip the alias like in other queries.  Just add the "order by" string and
382         //pass column name as is
383         if ($unionOrderBy != '') {
384             $unionOrderBy = ' order by ' . $unionOrderBy;
385         }
386
387         //if start is 0, then just use a top query
388         if($start == 0) {
389             $limitUnionSQL = "select top $count * from (" .$unionsql .") as top_count ".$unionOrderBy;
390         }
391         else {
392             //if start is more than 0, then use top query in conjunction
393             //with rownumber() function to create limit query.
394             $limitUnionSQL = "select top $count * from( select ROW_NUMBER() OVER ( order by "
395             .$rowNumOrderBy.") AS row_number, * from ("
396             .$unionsql .") As numbered) "
397             . "As top_count_limit WHERE row_number > $start "
398             .$unionOrderBy;
399         }
400
401         return $limitUnionSQL;
402     }
403
404         /**
405      * @see DBManager::limitQuery()
406      */
407     public function limitQuery(
408         $sql,
409         $start,
410         $count,
411         $dieOnError = false,
412         $msg = '')
413     {
414         $newSQL = $sql;
415         $distinctSQLARRAY = array();
416         if (strpos($sql, "UNION") && !preg_match("/(\')(UNION).?(\')/i", $sql))
417             $newSQL = $this->handleUnionLimitQuery($sql,$start,$count);
418         else {
419             if ($start < 0)
420                 $start = 0;
421             $GLOBALS['log']->debug(print_r(func_get_args(),true));
422             $this->lastsql = $sql;
423             $matches = array();
424             preg_match('/^(.*SELECT )(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
425             if (!empty($matches[3])) {
426                 if ($start == 0) {
427                     $match_two = strtolower($matches[2]);
428                     if (!strpos($match_two, "distinct")> 0 && strpos($match_two, "distinct") !==0) {
429                                         //proceed as normal
430                         $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
431                     }
432                     else {
433                         $distinct_o = strpos($match_two, "distinct");
434                         $up_to_distinct_str = substr($match_two, 0, $distinct_o);
435                         //check to see if the distinct is within a function, if so, then proceed as normal
436                         if (strpos($up_to_distinct_str,"(")) {
437                             //proceed as normal
438                             $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
439                         }
440                         else {
441                             //if distinct is not within a function, then parse
442                             //string contains distinct clause, "TOP needs to come after Distinct"
443                             //get position of distinct
444                             $match_zero = strtolower($matches[0]);
445                             $distinct_pos = strpos($match_zero , "distinct");
446                             //get position of where
447                             $where_pos = strpos($match_zero, "where");
448                             //parse through string
449                             $beg = substr($matches[0], 0, $distinct_pos+9 );
450                             $mid = substr($matches[0], strlen($beg), ($where_pos+5) - (strlen($beg)));
451                             $end = substr($matches[0], strlen($beg) + strlen($mid) );
452                             //repopulate matches array
453                             $matches[1] = $beg; $matches[2] = $mid; $matches[3] = $end;
454
455                             $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
456                         }
457                     }
458                 }
459                 else {
460                     $orderByMatch = array();
461                     preg_match('/^(.*)(ORDER BY)(.*)$/is',$matches[3], $orderByMatch);
462
463                     //if there is a distinct clause, parse sql string as we will have to insert the rownumber
464                     //for paging, AFTER the distinct clause
465                     $hasDistinct = strpos(strtolower($matches[0]), "distinct");
466                     if ($hasDistinct) {
467                         $matches_sql = strtolower($matches[0]);
468                         //remove reference to distinct and select keywords, as we will use a group by instead
469                         //we need to use group by because we are introducing rownumber column which would make every row unique
470
471                         //take out the select and distinct from string so we can reuse in group by
472                         $dist_str = ' distinct ';
473                         $distinct_pos = strpos($matches_sql, $dist_str);
474                         $matches_sql = substr($matches_sql,$distinct_pos+ strlen($dist_str));
475                         //get the position of where and from for further processing
476                         $from_pos = strpos($matches_sql , " from ");
477                         $where_pos = strpos($matches_sql, "where");
478                         //split the sql into a string before and after the from clause
479                         //we will use the columns being selected to construct the group by clause
480                         if ($from_pos>0 ) {
481                             $distinctSQLARRAY[0] = substr($matches_sql,0, $from_pos+1);
482                             $distinctSQLARRAY[1] = substr($matches_sql,$from_pos+1);
483                             //get position of order by (if it exists) so we can strip it from the string
484                             $ob_pos = strpos($distinctSQLARRAY[1], "order by");
485                             if ($ob_pos) {
486                                 $distinctSQLARRAY[1] = substr($distinctSQLARRAY[1],0,$ob_pos);
487                             }
488
489                             // strip off last closing parathese from the where clause
490                             $distinctSQLARRAY[1] = preg_replace("/\)\s$/"," ",$distinctSQLARRAY[1]);
491                         }
492
493                         //place group by string into array
494                         $grpByArr = explode(',', $distinctSQLARRAY[0]);
495                         $grpByStr = '';
496                         $first = true;
497                         //remove the aliases for each group by element, sql server doesnt like these in group by.
498                         foreach ($grpByArr as $gb) {
499                             $gb = trim($gb);
500
501                             //clean out the extra stuff added if we are concating first_name and last_name together
502                             //this way both fields are added in correctly to the group by
503                             $gb = str_replace("isnull(","",$gb);
504                             $gb = str_replace("'') + ' ' + ","",$gb);
505
506                             //remove outer reference if they exist
507                             if (strpos($gb,"'")!==false){
508                                 continue;
509                             }
510                             //if there is a space, then an alias exists, remove alias
511                             if (strpos($gb,' ')){
512                                 $gb = substr( $gb, 0,strpos($gb,' '));
513                             }
514
515                             //if resulting string is not empty then add to new group by string
516                             if (!empty($gb)) {
517                                 if ($first) {
518                                     $grpByStr .= " $gb";
519                                     $first = false;
520                                 }
521                                 else {
522                                     $grpByStr .= ", $gb";
523                                 }
524                             }
525                         }
526                     }
527
528                     if (!empty($orderByMatch[3])) {
529                         //if there is a distinct clause, form query with rownumber after distinct
530                         if ($hasDistinct) {
531                             $newSQL = "SELECT TOP $count * FROM
532                                         (
533                                             SELECT ROW_NUMBER()
534                                                 OVER (ORDER BY ".$this->returnOrderBy($sql, $orderByMatch[3]).") AS row_number,
535                                                 count(*) counter, " . $distinctSQLARRAY[0] . "
536                                                 " . $distinctSQLARRAY[1] . "
537                                                 group by " . $grpByStr . "
538                                         ) AS a
539                                         WHERE row_number > $start";
540                         }
541                         else {
542                         $newSQL = "SELECT TOP $count * FROM
543                                     (
544                                         " . $matches[1] . " ROW_NUMBER()
545                                         OVER (ORDER BY " . $this->returnOrderBy($sql, $orderByMatch[3]) . ") AS row_number,
546                                         " . $matches[2] . $orderByMatch[1]. "
547                                     ) AS a
548                                     WHERE row_number > $start";
549                         }
550                     }else{
551                         //bug: 22231 Records in campaigns' subpanel may not come from
552                         //table of $_REQUEST['module']. Get it directly from query
553                         $upperQuery = strtoupper($matches[2]);
554                         if (!strpos($upperQuery,"JOIN")){
555                             $from_pos = strpos($upperQuery , "FROM") + 4;
556                             $where_pos = strpos($upperQuery, "WHERE");
557                             $tablename = trim(substr($upperQuery,$from_pos, $where_pos - $from_pos));
558                         }else{
559                             $tablename = $this->getTableNameFromModuleName($_REQUEST['module'],$sql);
560                         }
561                         //if there is a distinct clause, form query with rownumber after distinct
562                         if ($hasDistinct) {
563                              $newSQL = "SELECT TOP $count * FROM
564                                             (
565                             SELECT ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, count(*) counter, " . $distinctSQLARRAY[0] . "
566                                                         " . $distinctSQLARRAY[1] . "
567                                                     group by " . $grpByStr . "
568                                             )
569                                             AS a
570                                             WHERE row_number > $start";
571                         }
572                         else {
573                              $newSQL = "SELECT TOP $count * FROM
574                                            (
575                                   " . $matches[1] . " ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, " . $matches[2] . $matches[3]. "
576                                            )
577                                            AS a
578                                            WHERE row_number > $start";
579                         }
580                     }
581                 }
582             }
583         }
584
585         $GLOBALS['log']->debug('Limit Query: ' . $newSQL);
586         $result =  $this->query($newSQL, $dieOnError, $msg);
587         $this->dump_slow_queries($newSQL);
588         return $result;
589     }
590
591
592     /**
593      * Searches for begginning and ending characters.  It places contents into
594      * an array and replaces contents in original string.  This is used to account for use of
595      * nested functions while aliasing column names
596      *
597      * @param  string $p_sql     SQL statement
598      * @param  string $strip_beg Beginning character
599      * @param  string $strip_end Ending character
600      * @param  string $patt      Optional, pattern to
601      */
602     private function removePatternFromSQL(
603         $p_sql,
604         $strip_beg,
605         $strip_end,
606         $patt = 'patt')
607     {
608         //strip all single quotes out
609         $beg_sin = 0;
610         $sec_sin = 0;
611         $count = substr_count ( $p_sql, $strip_beg);
612         $increment = 1;
613         if ($strip_beg != $strip_end)
614             $increment = 2;
615
616         $i=0;
617         $offset = 0;
618         $strip_array = array();
619         while ($i<$count && $offset<strlen($p_sql)) {
620             if ($offset > strlen($p_sql))
621             {
622                                 break;   
623             }           
624
625             $beg_sin = strpos($p_sql, $strip_beg, $offset);
626             if (!$beg_sin)
627             {
628                 break;
629             }
630             $sec_sin = strpos($p_sql, $strip_end, $beg_sin+1);
631             $strip_array[$patt.$i] = substr($p_sql, $beg_sin, $sec_sin - $beg_sin +1);
632             if ($increment > 1) {
633                 //we are in here because beginning and end patterns are not identical, so search for nesting
634                 $exists = strpos($strip_array[$patt.$i], $strip_beg );
635                 if ($exists>=0) {
636                     $nested_pos = (strrpos($strip_array[$patt.$i], $strip_beg ));
637                     $strip_array[$patt.$i] = substr($p_sql,$nested_pos+$beg_sin,$sec_sin - ($nested_pos+$beg_sin)+1);
638                     $p_sql = substr($p_sql, 0, $nested_pos+$beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
639                     $i = $i + 1;
640                     $beg_sin = $nested_pos;
641                     continue;
642                 }
643             }
644             $p_sql = substr($p_sql, 0, $beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
645             //move the marker up
646             $offset = $sec_sin+1;
647
648             $i = $i + 1;
649         }
650         $strip_array['sql_string'] = $p_sql;
651
652         return $strip_array;
653     }
654
655     /**
656      * adds a pattern
657      *
658      * @param  string $token
659      * @param  array  $pattern_array
660      * @return string
661      */
662         private function addPatternToSQL(
663         $token,
664         array $pattern_array
665         )
666     {
667         //strip all single quotes out
668         $pattern_array = array_reverse($pattern_array);
669
670         foreach ($pattern_array as $key => $replace) {
671             $token = str_replace( "##".$key."##", $replace,$token);
672         }
673
674         return $token;
675     }
676
677     /**
678      * gets an alias from the sql statement
679      *
680      * @param  string $sql
681      * @param  string $alias
682      * @return string
683      */
684         private function getAliasFromSQL(
685         $sql,
686         $alias
687         )
688     {
689         $matches = array();
690         preg_match('/^(.*SELECT)(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
691         //parse all single and double  quotes out of array
692         $sin_array = $this->removePatternFromSQL($matches[2], "'", "'","sin_");
693         $new_sql = array_pop($sin_array);
694         $dub_array = $this->removePatternFromSQL($new_sql, "\"", "\"","dub_");
695         $new_sql = array_pop($dub_array);
696
697         //search for parenthesis
698         $paren_array = $this->removePatternFromSQL($new_sql, "(", ")", "par_");
699         $new_sql = array_pop($paren_array);
700
701         //all functions should be removed now, so split the array on comma's
702         $mstr_sql_array = explode(",", $new_sql);
703         foreach($mstr_sql_array as $token ) {
704             if (strpos($token, $alias)) {
705                 //found token, add back comments
706                 $token = $this->addPatternToSQL($token, $paren_array);
707                 $token = $this->addPatternToSQL($token, $dub_array);
708                 $token = $this->addPatternToSQL($token, $sin_array);
709
710                 //log and break out of this function
711                 return $token;
712             }
713         }
714         return null;
715     }
716
717
718     /**
719      * Finds the alias of the order by column, and then return the preceding column name
720      *
721      * @param  string $sql
722      * @param  string $orderMatch
723      * @return string
724      */
725     private function findColumnByAlias(
726         $sql,
727         $orderMatch
728         )
729     {
730         //change case to lowercase
731         $sql = strtolower($sql);
732         $patt = '/\s+'.trim($orderMatch).'\s*,/';
733
734         //check for the alias, it should contain comma, may contain space, \n, or \t
735         $matches = array();
736         preg_match($patt, $sql, $matches, PREG_OFFSET_CAPTURE);
737         $found_in_sql = isset($matches[0][1]) ? $matches[0][1] : false;
738
739
740         //set default for found variable
741         $found = $found_in_sql;
742
743         //if still no match found, then we need to parse through the string
744         if (!$found_in_sql){
745             //get count of how many times the match exists in string
746             $found_count = substr_count($sql, $orderMatch);
747             $i = 0;
748             $first_ = 0;
749             $len = strlen($orderMatch);
750             //loop through string as many times as there is a match
751             while ($found_count > $i) {
752                 //get the first match
753                 $found_in_sql = strpos($sql, $orderMatch,$first_);
754                 //make sure there was a match
755                 if($found_in_sql){
756                     //grab the next 2 individual characters
757                     $str_plusone = substr($sql,$found_in_sql + $len,1);
758                     $str_plustwo = substr($sql,$found_in_sql + $len+1,1);
759                     //if one of those characters is a comma, then we have our alias
760                     if ($str_plusone === "," || $str_plustwo === ","){
761                         //keep track of this position
762                         $found = $found_in_sql;
763                     }
764                 }
765                 //set the offset and increase the iteration counter
766                 $first_ = $found_in_sql+$len;
767                 $i = $i+1;
768             }
769         }
770         //return $found, defaults have been set, so if no match was found it will be a negative number
771         return $found;
772     }
773
774
775     /**
776      * Return the order by string to use in case the column has been aliased
777      *
778      * @param  string $sql
779      * @param  string $orig_order_match
780      * @return string
781      */
782     private function returnOrderBy(
783         $sql,
784         $orig_order_match
785         )
786     {
787         $sql = strtolower($sql);
788         $orig_order_match = trim($orig_order_match);
789         if (strpos($orig_order_match, ".") != 0)
790             //this has a tablename defined, pass in the order match
791             return $orig_order_match;
792
793         //grab first space in order by
794         $firstSpace = strpos($orig_order_match, " ");
795
796         //split order by into column name and ascending/descending
797         $orderMatch = " " . strtolower(substr($orig_order_match, 0, $firstSpace));
798         $asc_desc =  substr($orig_order_match,$firstSpace);
799
800         //look for column name as an alias in sql string
801         $found_in_sql = $this->findColumnByAlias($sql, $orderMatch);
802
803         if (!$found_in_sql) {
804             //check if this column needs the tablename prefixed to it
805             $orderMatch = ".".trim($orderMatch);
806             $colMatchPos = strpos($sql, $orderMatch);
807             if ($colMatchPos !== false) {
808                 //grab sub string up to column name
809                 $containsColStr = substr($sql,0, $colMatchPos);
810                 //get position of first space, so we can grab table name
811                 $lastSpacePos = strrpos($containsColStr, " ");
812                 //use positions of column name, space before name, and length of column to find the correct column name
813                 $col_name = substr($sql, $lastSpacePos, $colMatchPos-$lastSpacePos+strlen($orderMatch));
814                                 //bug 25485. When sorting by a custom field in Account List and then pressing NEXT >, system gives an error
815                                 $containsCommaPos = strpos($col_name, ",");
816                                 if($containsCommaPos !== false) {
817                                         $col_name = substr($col_name, $containsCommaPos+1);
818                                 }
819                 //return column name
820                 return $col_name;
821             }
822             //break out of here, log this
823             $GLOBALS['log']->debug("No match was found for order by, pass string back untouched as: $orig_order_match");
824             return $orig_order_match;
825         }
826         else {
827             //if found, then parse and return
828             //grab string up to the aliased column
829             $GLOBALS['log']->debug("order by found, process sql string");
830
831             $psql = (trim($this->getAliasFromSQL($sql, $orderMatch )));
832             if (empty($psql))
833                 $psql = trim(substr($sql, 0, $found_in_sql));
834
835             //grab the last comma before the alias
836             $comma_pos = strrpos($psql, " ");
837             //substring between the comma and the alias to find the joined_table alias and column name
838             $col_name = substr($psql,0, $comma_pos);
839
840             //make sure the string does not have an end parenthesis
841             //and is not part of a function (i.e. "ISNULL(leads.last_name,'') as name"  )
842             //this is especially true for unified search from home screen
843
844             $alias_beg_pos = 0;
845             if(strpos($psql, " as "))
846                 $alias_beg_pos = strpos($psql, " as ");
847
848             // Bug # 44923 - This breaks the query and does not properly filter isnull
849             // as there are other functions such as ltrim and rtrim.
850             /* else if (strncasecmp($psql, 'isnull', 6) != 0)
851                 $alias_beg_pos = strpos($psql, " "); */
852
853             if ($alias_beg_pos > 0) {
854                 $col_name = substr($psql,0, $alias_beg_pos );
855             }
856             //add the "asc/desc" order back
857             $col_name = $col_name. " ". $asc_desc;
858
859             //pass in new order by
860             $GLOBALS['log']->debug("order by being returned is " . $col_name);
861             return $col_name;
862         }
863     }
864
865     /**
866      * Take in a string of the module and retrieve the correspondent table name
867      *
868      * @param  string $module_str module name
869      * @param  string $sql        SQL statement
870      * @return string table name
871      */
872     private function getTableNameFromModuleName(
873         $module_str,
874         $sql
875         )
876     {
877
878         global $beanList, $beanFiles;
879         $GLOBALS['log']->debug("Module being processed is " . $module_str);
880         //get the right module files
881         //the module string exists in bean list, then process bean for correct table name
882         //note that we exempt the reports module from this, as queries from reporting module should be parsed for
883         //correct table name.
884         if (($module_str != 'Reports' && $module_str != 'SavedReport') && isset($beanList[$module_str])  &&  isset($beanFiles[$beanList[$module_str]])){
885             //if the class is not already loaded, then load files
886             if (!class_exists($beanList[$module_str]))
887                 require_once($beanFiles[$beanList[$module_str]]);
888
889             //instantiate new bean
890             $module_bean = new $beanList[$module_str]();
891             //get table name from bean
892             $tbl_name = $module_bean->table_name;
893             //make sure table name is not just a blank space, or empty
894             $tbl_name = trim($tbl_name);
895
896             if(empty($tbl_name)){
897                 $GLOBALS['log']->debug("Could not find table name for module $module_str. ");
898                 $tbl_name = $module_str;
899             }
900         }
901         else {
902             //since the module does NOT exist in beanlist, then we have to parse the string
903             //and grab the table name from the passed in sql
904             $GLOBALS['log']->debug("Could not find table name from module in request, retrieve from passed in sql");
905             $tbl_name = $module_str;
906             $sql = strtolower($sql);
907
908             //look for the location of the "from" in sql string
909             $fromLoc = strpos($sql," from " );
910             if ($fromLoc>0){
911                 //found from, substring from the " FROM " string in sql to end
912                 $tableEnd = substr($sql, $fromLoc+6);
913                 //We know that tablename will be next parameter after from, so
914                 //grab the next space after table name.
915                 // 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.
916                 $carriage_ret = strpos($tableEnd,"\n");
917                 $next_space = strpos($tableEnd," " );
918                 if ($carriage_ret < $next_space)
919                     $next_space = $carriage_ret;
920                 if ($next_space > 0) {
921                     $tbl_name= substr($tableEnd,0, $next_space);
922                     if(empty($tbl_name)){
923                         $GLOBALS['log']->debug("Could not find table name sql either, return $module_str. ");
924                         $tbl_name = $module_str;
925                     }
926                 }
927
928                 //grab the table, to see if it is aliased
929                 $aliasTableEnd = trim(substr($tableEnd, $next_space));
930                 $alias_space = strpos ($aliasTableEnd, " " );
931                 if ($alias_space > 0){
932                     $alias_tbl_name= substr($aliasTableEnd,0, $alias_space);
933                     strtolower($alias_tbl_name);
934                     if(empty($alias_tbl_name)
935                         || $alias_tbl_name == "where"
936                         || $alias_tbl_name == "inner"
937                         || $alias_tbl_name == "left"
938                         || $alias_tbl_name == "join"
939                         || $alias_tbl_name == "outer"
940                         || $alias_tbl_name == "right") {
941                         //not aliased, do nothing
942                     }
943                     elseif ($alias_tbl_name == "as") {
944                             //the next word is the table name
945                             $aliasTableEnd = trim(substr($aliasTableEnd, $alias_space));
946                             $alias_space = strpos ($aliasTableEnd, " " );
947                             if ($alias_space > 0) {
948                                 $alias_tbl_name= trim(substr($aliasTableEnd,0, $alias_space));
949                                 if (!empty($alias_tbl_name))
950                                     $tbl_name = $alias_tbl_name;
951                             }
952                     }
953                     else {
954                         //this is table alias
955                         $tbl_name = $alias_tbl_name;
956                     }
957                 }
958             }
959         }
960         //return table name
961         $GLOBALS['log']->debug("Table name for module $module_str is: ".$tbl_name);
962         return $tbl_name;
963     }
964
965
966         /**
967      * @see DBManager::getFieldsArray()
968      */
969         public function getFieldsArray(
970         &$result,
971         $make_lower_case = false
972         )
973         {
974                 $field_array = array();
975
976                 if(! isset($result) || empty($result))
977             return 0;
978
979         $i = 0;
980         while ($i < mssql_num_fields($result)) {
981             $meta = mssql_fetch_field($result, $i);
982             if (!$meta)
983                 return 0;
984             if($make_lower_case==true)
985                 $meta->name = strtolower($meta->name);
986
987             $field_array[] = $meta->name;
988
989             $i++;
990         }
991
992         return $field_array;
993         }
994
995     /**
996      * @see DBManager::getAffectedRowCount()
997      */
998         public function getAffectedRowCount()
999     {
1000         return $this->getOne("SELECT @@ROWCOUNT");
1001     }
1002
1003     /**
1004      * @see DBManager::describeField()
1005      */
1006         protected function describeField(
1007         $name,
1008         $tablename
1009         )
1010     {
1011         global $table_descriptions;
1012         if(isset($table_descriptions[$tablename]) && isset($table_descriptions[$tablename][$name])){
1013             return      $table_descriptions[$tablename][$name];
1014         }
1015         $table_descriptions[$tablename] = array();
1016
1017         $sql = sprintf( "SELECT COLUMN_NAME AS Field
1018                                 , DATA_TYPE + CASE WHEN CHARACTER_MAXIMUM_LENGTH IS NOT NULL
1019                         THEN '(' + RTRIM(CAST(CHARACTER_MAXIMUM_LENGTH AS CHAR)) + ')' 
1020                                                 ELSE '' END as 'Type'
1021                                 , CHARACTER_MAXIMUM_LENGTH
1022                                 , IS_NULLABLE AS 'Null'
1023                                 , CASE WHEN COLUMN_DEFAULT LIKE '((0))' THEN '(''0'')' ELSE COLUMN_DEFAULT END as 'Default'
1024                         FROM INFORMATION_SCHEMA.COLUMNS
1025                         WHERE TABLE_NAME = '%s'",
1026                         $tablename
1027         );
1028
1029         $result = $this->query($sql);
1030         while ($row = $this->fetchByAssoc($result) )
1031             $table_descriptions[$tablename][$row['Field']] = $row;
1032
1033         if (isset($table_descriptions[$tablename][$name]))
1034             return      $table_descriptions[$tablename][$name];
1035
1036         return array();
1037     }
1038
1039
1040
1041         /**
1042      * @see DBManager::fetchByAssoc()
1043      */
1044     public function fetchByAssoc(
1045         &$result,
1046         $rowNum = -1,
1047         $encode = true
1048         )
1049     {
1050         if (!$result)
1051             return false;
1052
1053                 if ($result && $rowNum < 0) {
1054             $row = mssql_fetch_assoc($result);
1055             //MSSQL returns a space " " when a varchar column is empty ("") and not null.
1056             //We need to iterate through the returned row array and strip empty spaces
1057             if(!empty($row)){
1058                 foreach($row as $key => $column) {
1059                     //notice we only strip if one space is returned.  we do not want to strip
1060                     //strings with intentional spaces (" foo ")
1061                     if (!empty($column) && $column ==" ") {
1062                         $row[$key] = '';
1063                     }
1064                 }
1065             }
1066
1067             if($encode && $this->encode&& is_array($row))
1068                 return array_map('to_html', $row);
1069
1070             return $row;
1071                 }
1072
1073                 if ($this->getRowCount($result) > $rowNum) {
1074                         if ( $rowNum == -1 )
1075                 $rowNum = 0;
1076                         @mssql_data_seek($result, $rowNum);
1077         }
1078
1079         $this->lastmysqlrow = $rowNum;
1080         $row = @mssql_fetch_assoc($result);
1081         if($encode && $this->encode && is_array($row))
1082             return array_map('to_html', $row);
1083         return $row;
1084         }
1085
1086     /**
1087      * @see DBManager::quote()
1088      */
1089     public function quote(
1090         $string,
1091         $isLike = true
1092         )
1093     {
1094         return $string = str_replace("'","''", parent::quote($string));
1095     }
1096
1097     /**
1098      * @see DBManager::quoteForEmail()
1099      */
1100     public function quoteForEmail(
1101         $string,
1102         $isLike = true
1103         )
1104     {
1105         return str_replace("'","''", $string);
1106     }
1107
1108
1109     /**
1110      * @see DBManager::tableExists()
1111      */
1112     public function tableExists(
1113         $tableName
1114         )
1115     {
1116         $GLOBALS['log']->info("tableExists: $tableName");
1117
1118         $this->checkConnection();
1119         $result = $this->query(
1120             "SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE='BASE TABLE' AND TABLE_NAME='".$tableName."'");
1121
1122         $rowCount = $this->getRowCount($result);
1123         $this->freeResult($result);
1124         return ($rowCount == 0) ? false : true;
1125     }
1126
1127     /**
1128      * @see DBManager::addIndexes()
1129      */
1130     public function addIndexes(
1131         $tablename,
1132         $indexes,
1133         $execute = true
1134         )
1135     {
1136         $alters = $this->helper->indexSQL($tablename,array(),$indexes);
1137         if ($execute)
1138             $this->query($alters);
1139
1140         return $alters;
1141     }
1142
1143     /**
1144      * @see DBManager::dropIndexes()
1145      */
1146     public function dropIndexes(
1147         $tablename,
1148         $indexes,
1149         $execute = true
1150         )
1151     {
1152         $sql = '';
1153         foreach ($indexes as $index) {
1154             if ( !empty($sql) ) $sql .= ";";
1155             $name = $index['name'];
1156             if($execute)
1157                 unset($GLOBALS['table_descriptions'][$tablename]['indexes'][$name]);
1158             if ($index['type'] == 'primary')
1159                 $sql .= "ALTER TABLE $tablename DROP CONSTRAINT $name";
1160             else
1161                 $sql .= "DROP INDEX $name on $tablename";
1162         }
1163         if (!empty($sql))
1164             if($execute)
1165                 $this->query($sql);
1166
1167         return $sql;
1168     }
1169
1170     /**
1171      * @see DBManager::checkQuery()
1172      */
1173     protected function checkQuery(
1174         $sql
1175         )
1176     {
1177         return true;
1178     }
1179
1180     /**
1181      * @see DBManager::getTablesArray()
1182      */
1183     public function getTablesArray()
1184     {
1185         $GLOBALS['log']->debug('MSSQL fetching table list');
1186
1187         if($this->getDatabase()) {
1188             $tables = array();
1189             $r = $this->query('SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES');
1190             if (is_resource($r)) {
1191                 while ($a = $this->fetchByAssoc($r))
1192                     $tables[] = $a['TABLE_NAME'];
1193
1194                 return $tables;
1195             }
1196         }
1197
1198         return false; // no database available
1199     }
1200
1201
1202     /**
1203      * This call is meant to be used during install, when Full Text Search is enabled
1204      * Indexing would always occur after a fresh sql server install, so this code creates
1205      * a catalog and table with full text index.
1206      */
1207     public function wakeupFTS()
1208     {
1209         $GLOBALS['log']->debug('MSSQL about to wakeup FTS');
1210
1211         if($this->getDatabase()) {
1212                 //create wakup catalog
1213                 $FTSqry[] = "if not exists(  select * from sys.fulltext_catalogs where name ='wakeup_catalog' )
1214                 CREATE FULLTEXT CATALOG wakeup_catalog
1215                 ";
1216
1217                 //drop wakeup table if it exists
1218                 $FTSqry[] = "IF EXISTS(SELECT 'fts_wakeup' FROM sysobjects WHERE name = 'fts_wakeup' AND xtype='U')
1219                     DROP TABLE fts_wakeup
1220                 ";
1221                 //create wakeup table
1222                 $FTSqry[] = "CREATE TABLE fts_wakeup(
1223                     id varchar(36) NOT NULL CONSTRAINT pk_fts_wakeup_id PRIMARY KEY CLUSTERED (id ASC ),
1224                     body text NULL,
1225                     kb_index int IDENTITY(1,1) NOT NULL CONSTRAINT wakeup_fts_unique_idx UNIQUE NONCLUSTERED
1226                 )
1227                 ";
1228                 //create full text index
1229                  $FTSqry[] = "CREATE FULLTEXT INDEX ON fts_wakeup
1230                 (
1231                     body
1232                     Language 0X0
1233                 )
1234                 KEY INDEX wakeup_fts_unique_idx ON wakeup_catalog
1235                 WITH CHANGE_TRACKING AUTO
1236                 ";
1237
1238                 //insert dummy data
1239                 $FTSqry[] = "INSERT INTO fts_wakeup (id ,body)
1240                 VALUES ('".create_guid()."', 'SugarCRM Rocks' )";
1241
1242
1243                 //create queries to stop and restart indexing
1244                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup STOP POPULATION';
1245                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup DISABLE';
1246                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup ENABLE';
1247                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING MANUAL';
1248                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup START FULL POPULATION';
1249                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING AUTO';
1250
1251                 foreach($FTSqry as $q){
1252                     sleep(3);
1253                     $this->query($q);
1254                 }
1255
1256
1257         }
1258
1259         return false; // no database available
1260     }
1261
1262     /**
1263      * @see DBManager::convert()
1264      */
1265     public function convert(
1266         $string,
1267         $type,
1268         array $additional_parameters = array(),
1269         array $additional_parameters_oracle_only = array()
1270         )
1271     {
1272         // convert the parameters array into a comma delimited string
1273         $additional_parameters_string = '';
1274         if (!empty($additional_parameters))
1275             $additional_parameters_string = ','.implode(',',$additional_parameters);
1276
1277         switch ($type) {
1278         case 'today': return "GETDATE()";
1279         case 'left': return "LEFT($string".$additional_parameters_string.")";
1280         case 'date_format':
1281             if(!empty($additional_parameters) && in_array("'%Y-%m'", $additional_parameters))
1282                return "CONVERT(varchar(7),". $string . ",120)";
1283             else
1284                return "CONVERT(varchar(10),". $string . ",120)";
1285         case 'IFNULL': return "ISNULL($string".$additional_parameters_string.")";
1286         case 'CONCAT': return "$string+".implode("+",$additional_parameters);
1287         case 'text2char': return "CAST($string AS varchar(8000))";
1288         }
1289
1290         return "$string";
1291     }
1292
1293     /**
1294      * @see DBManager::concat()
1295      */
1296     public function concat(
1297         $table,
1298         array $fields
1299         )
1300     {
1301         $ret = '';
1302
1303         foreach ( $fields as $index => $field )
1304                         if (empty($ret))
1305                             $ret =  db_convert($table.".".$field,'IFNULL', array("''"));
1306                         else
1307                             $ret .=     " + ' ' + ".db_convert($table.".".$field,'IFNULL', array("''"));
1308
1309                 return empty($ret)?$ret:"LTRIM(RTRIM($ret))";
1310     }
1311
1312     /**
1313      * @see DBManager::fromConvert()
1314      */
1315     public function fromConvert(
1316         $string,
1317         $type)
1318     {
1319         switch($type) {
1320         case 'datetime': return substr($string, 0,19);
1321         case 'date': return substr($string, 0,11);
1322         case 'time': return substr($string, 11);
1323                 }
1324
1325                 return $string;
1326     }
1327 }