]> CyberLeo.Net >> Repos - Github/sugarcrm.git/blob - include/database/MssqlManager.php
Release 6.2.0beta4
[Github/sugarcrm.git] / 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         
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
490                         //place group by string into array
491                         $grpByArr = explode(',', $distinctSQLARRAY[0]);
492                         $grpByStr = '';
493                         $first = true;
494                         //remove the aliases for each group by element, sql server doesnt like these in group by.
495                         foreach ($grpByArr as $gb) {
496                             $gb = trim($gb);
497
498                             //remove outer reference if they exist
499                             if (strpos($gb,"'")!==false){
500                                 continue;
501                             }
502                             //if there is a space, then an alias exists, remove alias
503                             if (strpos($gb,' ')){
504                                 $gb = substr( $gb, 0,strpos($gb,' '));
505                             }
506
507                             //if resulting string is not empty then add to new group by string
508                             if (!empty($gb)) {
509                                 if ($first) {
510                                     $grpByStr .= " $gb";
511                                     $first = false;
512                                 }
513                                 else {
514                                     $grpByStr .= ", $gb";
515                                 }
516                             }
517                         }
518                     }
519
520                     if (!empty($orderByMatch[3])) {
521                         //if there is a distinct clause, form query with rownumber after distinct
522                         if ($hasDistinct) {
523                             $newSQL = "SELECT TOP $count * FROM
524                                         (
525                                             SELECT ROW_NUMBER()
526                                                 OVER (ORDER BY ".$this->returnOrderBy($sql, $orderByMatch[3]).") AS row_number,
527                                                 count(*) counter, " . $distinctSQLARRAY[0] . "
528                                                 " . $distinctSQLARRAY[1] . "
529                                                 group by " . $grpByStr . "
530                                         ) AS a
531                                         WHERE row_number > $start";
532                         }
533                         else {
534                         $newSQL = "SELECT TOP $count * FROM
535                                     (
536                                         " . $matches[1] . " ROW_NUMBER()
537                                         OVER (ORDER BY " . $this->returnOrderBy($sql, $orderByMatch[3]) . ") AS row_number,
538                                         " . $matches[2] . $orderByMatch[1]. "
539                                     ) AS a
540                                     WHERE row_number > $start";
541                         }
542                     }else{
543                         //bug: 22231 Records in campaigns' subpanel may not come from
544                         //table of $_REQUEST['module']. Get it directly from query
545                         $upperQuery = strtoupper($matches[2]);
546                         if (!strpos($upperQuery,"JOIN")){
547                             $from_pos = strpos($upperQuery , "FROM") + 4;
548                             $where_pos = strpos($upperQuery, "WHERE");
549                             $tablename = trim(substr($upperQuery,$from_pos, $where_pos - $from_pos));
550                         }else{
551                             $tablename = $this->getTableNameFromModuleName($_REQUEST['module'],$sql);
552                         }
553                         //if there is a distinct clause, form query with rownumber after distinct
554                         if ($hasDistinct) {
555                              $newSQL = "SELECT TOP $count * FROM
556                                             (
557                             SELECT ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, count(*) counter, " . $distinctSQLARRAY[0] . "
558                                                         " . $distinctSQLARRAY[1] . "
559                                                     group by " . $grpByStr . "
560                                             )
561                                             AS a
562                                             WHERE row_number > $start";
563                         }
564                         else {
565                              $newSQL = "SELECT TOP $count * FROM
566                                            (
567                                   " . $matches[1] . " ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, " . $matches[2] . $matches[3]. "
568                                            )
569                                            AS a
570                                            WHERE row_number > $start";
571                         }
572                     }
573                 }
574             }
575         }
576
577         $GLOBALS['log']->debug('Limit Query: ' . $newSQL);
578         $result =  $this->query($newSQL, $dieOnError, $msg);
579         $this->dump_slow_queries($newSQL);
580         return $result;
581     }
582
583
584     /**
585      * Searches for begginning and ending characters.  It places contents into
586      * an array and replaces contents in original string.  This is used to account for use of
587      * nested functions while aliasing column names
588      *
589      * @param  string $p_sql     SQL statement
590      * @param  string $strip_beg Beginning character
591      * @param  string $strip_end Ending character
592      * @param  string $patt      Optional, pattern to
593      */
594     private function removePatternFromSQL(
595         $p_sql,
596         $strip_beg,
597         $strip_end,
598         $patt = 'patt')
599     {
600         //strip all single quotes out
601         $beg_sin = 0;
602         $sec_sin = 0;
603         $count = substr_count ( $p_sql, $strip_beg);
604         $increment = 1;
605         if ($strip_beg != $strip_end)
606             $increment = 2;
607
608         $i=0;
609         $offset = 0;
610         $strip_array = array();
611         while ($i<$count) {
612             $beg_sin = strpos($p_sql, $strip_beg, $offset);
613             if (!$beg_sin)
614                 break;
615             $sec_sin = strpos($p_sql, $strip_end, $beg_sin+1);
616             $strip_array[$patt.$i] = substr($p_sql, $beg_sin, $sec_sin - $beg_sin +1);
617             if ($increment > 1) {
618                 //we are in here because beginning and end patterns are not identical, so search for nesting
619                 $exists = strpos($strip_array[$patt.$i], $strip_beg );
620                 if ($exists>=0) {
621                     $nested_pos = (strrpos($strip_array[$patt.$i], $strip_beg ));
622                     $strip_array[$patt.$i] = substr($p_sql,$nested_pos+$beg_sin,$sec_sin - ($nested_pos+$beg_sin)+1);
623                     $p_sql = substr($p_sql, 0, $nested_pos+$beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
624                     $i = $i + 1;
625                     $beg_sin = $nested_pos;
626                     continue;
627                 }
628             }
629             $p_sql = substr($p_sql, 0, $beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
630             //move the marker up
631             $offset = $sec_sin+1;
632
633             $i = $i + 1;
634         }
635         $strip_array['sql_string'] = $p_sql;
636
637         return $strip_array;
638     }
639
640     /**
641      * adds a pattern
642      *
643      * @param  string $token
644      * @param  array  $pattern_array
645      * @return string
646      */
647         private function addPatternToSQL(
648         $token,
649         array $pattern_array
650         )
651     {
652         //strip all single quotes out
653         $pattern_array = array_reverse($pattern_array);
654
655         foreach ($pattern_array as $key => $replace) {
656             $token = str_replace( "##".$key."##", $replace,$token);
657         }
658
659         return $token;
660     }
661
662     /**
663      * gets an alias from the sql statement
664      *
665      * @param  string $sql
666      * @param  string $alias
667      * @return string
668      */
669         private function getAliasFromSQL(
670         $sql,
671         $alias
672         )
673     {
674         $matches = array();
675         preg_match('/^(.*SELECT)(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
676         //parse all single and double  quotes out of array
677         $sin_array = $this->removePatternFromSQL($matches[2], "'", "'","sin_");
678         $new_sql = array_pop($sin_array);
679         $dub_array = $this->removePatternFromSQL($new_sql, "\"", "\"","dub_");
680         $new_sql = array_pop($dub_array);
681
682         //search for parenthesis
683         $paren_array = $this->removePatternFromSQL($new_sql, "(", ")", "par_");
684         $new_sql = array_pop($paren_array);
685
686         //all functions should be removed now, so split the array on comma's
687         $mstr_sql_array = explode(",", $new_sql);
688         foreach($mstr_sql_array as $token ) {
689             if (strpos($token, $alias)) {
690                 //found token, add back comments
691                 $token = $this->addPatternToSQL($token, $paren_array);
692                 $token = $this->addPatternToSQL($token, $dub_array);
693                 $token = $this->addPatternToSQL($token, $sin_array);
694
695                 //log and break out of this function
696                 return $token;
697             }
698         }
699         return null;
700     }
701
702
703     /**
704      * Finds the alias of the order by column, and then return the preceding column name
705      *
706      * @param  string $sql
707      * @param  string $orderMatch
708      * @return string
709      */
710     private function findColumnByAlias(
711         $sql,
712         $orderMatch
713         )
714     {
715         //change case to lowercase
716         $sql = strtolower($sql);
717         $patt = '/\s+'.trim($orderMatch).'\s*,/';
718
719         //check for the alias, it should contain comma, may contain space, \n, or \t
720         $matches = array();
721         preg_match($patt, $sql, $matches, PREG_OFFSET_CAPTURE);
722         $found_in_sql = isset($matches[0][1]) ? $matches[0][1] : false;
723
724
725         //set default for found variable
726         $found = $found_in_sql;
727
728         //if still no match found, then we need to parse through the string
729         if (!$found_in_sql){
730             //get count of how many times the match exists in string
731             $found_count = substr_count($sql, $orderMatch);
732             $i = 0;
733             $first_ = 0;
734             $len = strlen($orderMatch);
735             //loop through string as many times as there is a match
736             while ($found_count > $i) {
737                 //get the first match
738                 $found_in_sql = strpos($sql, $orderMatch,$first_);
739                 //make sure there was a match
740                 if($found_in_sql){
741                     //grab the next 2 individual characters
742                     $str_plusone = substr($sql,$found_in_sql + $len,1);
743                     $str_plustwo = substr($sql,$found_in_sql + $len+1,1);
744                     //if one of those characters is a comma, then we have our alias
745                     if ($str_plusone === "," || $str_plustwo === ","){
746                         //keep track of this position
747                         $found = $found_in_sql;
748                     }
749                 }
750                 //set the offset and increase the iteration counter
751                 $first_ = $found_in_sql+$len;
752                 $i = $i+1;
753             }
754         }
755         //return $found, defaults have been set, so if no match was found it will be a negative number
756         return $found;
757     }
758
759
760     /**
761      * Return the order by string to use in case the column has been aliased
762      *
763      * @param  string $sql
764      * @param  string $orig_order_match
765      * @return string
766      */
767     private function returnOrderBy(
768         $sql,
769         $orig_order_match
770         )
771     {
772         $sql = strtolower($sql);
773         $orig_order_match = trim($orig_order_match);
774         if (strpos($orig_order_match, "."))
775             //this has a tablename defined, pass in the order match
776             return $orig_order_match;
777
778         //grab first space in order by
779         $firstSpace = strpos($orig_order_match, " ");
780
781         //split order by into column name and ascending/descending
782         $orderMatch = " " . strtolower(substr($orig_order_match, 0, $firstSpace));
783         $asc_desc =  substr($orig_order_match,$firstSpace);
784
785         //look for column name as an alias in sql string
786         $found_in_sql = $this->findColumnByAlias($sql, $orderMatch);
787
788         if (!$found_in_sql) {
789             //check if this column needs the tablename prefixed to it
790             $orderMatch = ".".trim($orderMatch);
791             $colMatchPos = strpos($sql, $orderMatch);
792             if ($colMatchPos !== false) {
793                 //grab sub string up to column name
794                 $containsColStr = substr($sql,0, $colMatchPos);
795                 //get position of first space, so we can grab table name
796                 $lastSpacePos = strrpos($containsColStr, " ");
797                 //use positions of column name, space before name, and length of column to find the correct column name
798                 $col_name = substr($sql, $lastSpacePos, $colMatchPos-$lastSpacePos+strlen($orderMatch));
799                                 //bug 25485. When sorting by a custom field in Account List and then pressing NEXT >, system gives an error
800                                 $containsCommaPos = strpos($col_name, ",");
801                                 if($containsCommaPos !== false) {
802                                         $col_name = substr($col_name, $containsCommaPos+1);
803                                 }
804                 //return column name
805                 return $col_name;
806             }
807             //break out of here, log this
808             $GLOBALS['log']->debug("No match was found for order by, pass string back untouched as: $orig_order_match");
809             return $orig_order_match;
810         }
811         else {
812             //if found, then parse and return
813             //grab string up to the aliased column
814             $GLOBALS['log']->debug("order by found, process sql string");
815
816             $psql = (trim($this->getAliasFromSQL($sql, $orderMatch )));
817             if (empty($psql))
818                 $psql = trim(substr($sql, 0, $found_in_sql));
819
820             //grab the last comma before the alias
821             $comma_pos = strrpos($psql, " ");
822             //substring between the comma and the alias to find the joined_table alias and column name
823             $col_name = substr($psql,0, $comma_pos);
824
825             //make sure the string does not have an end parenthesis
826             //and is not part of a function (i.e. "ISNULL(leads.last_name,'') as name"  )
827             //this is especially true for unified search from home screen
828
829             $alias_beg_pos = 0;
830             if(strpos($psql, " as "))
831                 $alias_beg_pos = strpos($psql, " as ");
832             else if (strncasecmp($psql, 'isnull', 6))
833                 $alias_beg_pos = strpos($psql, " ");
834
835             if ($alias_beg_pos > 0) {
836                 $col_name = substr($psql,0, $alias_beg_pos );
837             }
838             //add the "asc/desc" order back
839             $col_name = $col_name. " ". $asc_desc;
840
841             //pass in new order by
842             $GLOBALS['log']->debug("order by being returned is " . $col_name);
843             return $col_name;
844         }
845     }
846
847     /**
848      * Take in a string of the module and retrieve the correspondent table name
849      *
850      * @param  string $module_str module name
851      * @param  string $sql        SQL statement
852      * @return string table name
853      */
854     private function getTableNameFromModuleName(
855         $module_str,
856         $sql
857         )
858     {
859
860         global $beanList, $beanFiles;
861         $GLOBALS['log']->debug("Module being processed is " . $module_str);
862         //get the right module files
863         //the module string exists in bean list, then process bean for correct table name
864         //note that we exempt the reports module from this, as queries from reporting module should be parsed for
865         //correct table name.
866         if (($module_str != 'Reports' && $module_str != 'SavedReport') && isset($beanList[$module_str])  &&  isset($beanFiles[$beanList[$module_str]])){
867             //if the class is not already loaded, then load files
868             if (!class_exists($beanList[$module_str]))
869                 require_once($beanFiles[$beanList[$module_str]]);
870
871             //instantiate new bean
872             $module_bean = new $beanList[$module_str]();
873             //get table name from bean
874             $tbl_name = $module_bean->table_name;
875             //make sure table name is not just a blank space, or empty
876             $tbl_name = trim($tbl_name);
877
878             if(empty($tbl_name)){
879                 $GLOBALS['log']->debug("Could not find table name for module $module_str. ");
880                 $tbl_name = $module_str;
881             }
882         }
883         else {
884             //since the module does NOT exist in beanlist, then we have to parse the string
885             //and grab the table name from the passed in sql
886             $GLOBALS['log']->debug("Could not find table name from module in request, retrieve from passed in sql");
887             $tbl_name = $module_str;
888             $sql = strtolower($sql);
889
890             //look for the location of the "from" in sql string
891             $fromLoc = strpos ( $sql,"from" );
892             if ($fromLoc>0){
893                 //found from, substring from the "FROM" string in sql to end
894                 $tableEnd = substr($sql, $fromLoc+5);
895                 //We know that tablename will be next parameter after from, so
896                 //grab the next space after table name.
897                 // 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.
898                 $carriage_ret = strpos($tableEnd,"\n");
899                 $next_space = strpos ( $tableEnd," " );
900                 if ($carriage_ret < $next_space)
901                     $next_space = $carriage_ret;
902                 if ($next_space > 0) {
903                     $tbl_name= substr($tableEnd,0, $next_space);
904                     if(empty($tbl_name)){
905                         $GLOBALS['log']->debug("Could not find table name sql either, return $module_str. ");
906                         $tbl_name = $module_str;
907                     }
908                 }
909
910                 //grab the table, to see if it is aliased
911                 $aliasTableEnd = trim(substr($tableEnd, $next_space));
912                 $alias_space = strpos ($aliasTableEnd, " " );
913                 if ($alias_space > 0){
914                     $alias_tbl_name= substr($aliasTableEnd,0, $alias_space);
915                     strtolower($alias_tbl_name);
916                     if(empty($alias_tbl_name)
917                         || $alias_tbl_name == "where"
918                         || $alias_tbl_name == "inner"
919                         || $alias_tbl_name == "left"
920                         || $alias_tbl_name == "join"
921                         || $alias_tbl_name == "outer"
922                         || $alias_tbl_name == "right") {
923                         //not aliased, do nothing
924                     }
925                     elseif ($alias_tbl_name == "as") {
926                             //the next word is the table name
927                             $aliasTableEnd = trim(substr($aliasTableEnd, $alias_space));
928                             $alias_space = strpos ($aliasTableEnd, " " );
929                             if ($alias_space > 0) {
930                                 $alias_tbl_name= trim(substr($aliasTableEnd,0, $alias_space));
931                                 if (!empty($alias_tbl_name))
932                                     $tbl_name = $alias_tbl_name;
933                             }
934                     }
935                     else {
936                         //this is table alias
937                         $tbl_name = $alias_tbl_name;
938                     }
939                 }
940             }
941         }
942         //return table name
943         $GLOBALS['log']->debug("Table name for module $module_str is: ".$tbl_name);
944         return $tbl_name;
945     }
946
947
948         /**
949      * @see DBManager::getFieldsArray()
950      */
951         public function getFieldsArray(
952         &$result,
953         $make_lower_case = false
954         )
955         {
956                 $field_array = array();
957
958                 if(! isset($result) || empty($result))
959             return 0;
960
961         $i = 0;
962         while ($i < mssql_num_fields($result)) {
963             $meta = mssql_fetch_field($result, $i);
964             if (!$meta)
965                 return 0;
966             if($make_lower_case==true)
967                 $meta->name = strtolower($meta->name);
968
969             $field_array[] = $meta->name;
970
971             $i++;
972         }
973
974         return $field_array;
975         }
976
977     /**
978      * @see DBManager::getAffectedRowCount()
979      */
980         public function getAffectedRowCount()
981     {
982         return $this->getOne("SELECT @@ROWCOUNT");
983     }
984
985     /**
986      * @see DBManager::describeField()
987      */
988         protected function describeField(
989         $name,
990         $tablename
991         )
992     {
993         global $table_descriptions;
994         if(isset($table_descriptions[$tablename]) && isset($table_descriptions[$tablename][$name])){
995             return      $table_descriptions[$tablename][$name];
996         }
997         $table_descriptions[$tablename] = array();
998
999         $sql = sprintf( "SELECT COLUMN_NAME AS Field
1000                                 , DATA_TYPE + CASE WHEN CHARACTER_MAXIMUM_LENGTH IS NOT NULL
1001                         THEN '(' + RTRIM(CAST(CHARACTER_MAXIMUM_LENGTH AS CHAR)) + ')' 
1002                                                 ELSE '' END as 'Type'
1003                                 , CHARACTER_MAXIMUM_LENGTH
1004                                 , IS_NULLABLE AS 'Null'
1005                                 , CASE WHEN COLUMN_DEFAULT LIKE '((0))' THEN '(''0'')' ELSE COLUMN_DEFAULT END as 'Default'
1006                         FROM INFORMATION_SCHEMA.COLUMNS
1007                         WHERE TABLE_NAME = '%s'",
1008                         $tablename
1009         );
1010
1011         $result = $this->query($sql);
1012         while ($row = $this->fetchByAssoc($result) )
1013             $table_descriptions[$tablename][$row['Field']] = $row;
1014
1015         if (isset($table_descriptions[$tablename][$name]))
1016             return      $table_descriptions[$tablename][$name];
1017
1018         return array();
1019     }
1020
1021
1022
1023         /**
1024      * @see DBManager::fetchByAssoc()
1025      */
1026     public function fetchByAssoc(
1027         &$result,
1028         $rowNum = -1,
1029         $encode = true
1030         )
1031     {
1032         if (!$result)
1033             return false;
1034
1035                 if ($result && $rowNum < 0) {
1036             $row = mssql_fetch_assoc($result);
1037             //MSSQL returns a space " " when a varchar column is empty ("") and not null.
1038             //We need to iterate through the returned row array and strip empty spaces
1039             if(!empty($row)){
1040                 foreach($row as $key => $column) {
1041                     //notice we only strip if one space is returned.  we do not want to strip
1042                     //strings with intentional spaces (" foo ")
1043                     if (!empty($column) && $column ==" ") {
1044                         $row[$key] = '';
1045                     }
1046                 }
1047             }
1048
1049             if($encode && $this->encode&& is_array($row))
1050                 return array_map('to_html', $row);
1051
1052             return $row;
1053                 }
1054
1055                 if ($this->getRowCount($result) > $rowNum) {
1056                         if ( $rowNum == -1 )
1057                 $rowNum = 0;
1058                         @mssql_data_seek($result, $rowNum);
1059         }
1060
1061         $this->lastmysqlrow = $rowNum;
1062         $row = @mssql_fetch_assoc($result);
1063         if($encode && $this->encode && is_array($row))
1064             return array_map('to_html', $row);
1065         return $row;
1066         }
1067
1068     /**
1069      * @see DBManager::quote()
1070      */
1071     public function quote(
1072         $string,
1073         $isLike = true
1074         )
1075     {
1076         return $string = str_replace("'","''", parent::quote($string));
1077     }
1078
1079     /**
1080      * @see DBManager::quoteForEmail()
1081      */
1082     public function quoteForEmail(
1083         $string,
1084         $isLike = true
1085         )
1086     {
1087         return str_replace("'","''", $string);
1088     }
1089
1090
1091     /**
1092      * @see DBManager::tableExists()
1093      */
1094     public function tableExists(
1095         $tableName
1096         )
1097     {
1098         $GLOBALS['log']->info("tableExists: $tableName");
1099
1100         $this->checkConnection();
1101         $result = $this->query(
1102             "SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE='BASE TABLE' AND TABLE_NAME='".$tableName."'");
1103
1104         $rowCount = $this->getRowCount($result);
1105         $this->freeResult($result);
1106         return ($rowCount == 0) ? false : true;
1107     }
1108
1109     /**
1110      * @see DBManager::addIndexes()
1111      */
1112     public function addIndexes(
1113         $tablename,
1114         $indexes,
1115         $execute = true
1116         )
1117     {
1118         $alters = $this->helper->indexSQL($tablename,array(),$indexes);
1119         if ($execute)
1120             $this->query($alters);
1121
1122         return $alters;
1123     }
1124
1125     /**
1126      * @see DBManager::dropIndexes()
1127      */
1128     public function dropIndexes(
1129         $tablename,
1130         $indexes,
1131         $execute = true
1132         )
1133     {
1134         $sql = '';
1135         foreach ($indexes as $index) {
1136             if ( !empty($sql) ) $sql .= ";";
1137             $name = $index['name'];
1138             if($execute)
1139                 unset($GLOBALS['table_descriptions'][$tablename]['indexes'][$name]);
1140             if ($index['type'] == 'primary')
1141                 $sql .= "ALTER TABLE $tablename DROP CONSTRAINT $name";
1142             else
1143                 $sql .= "DROP INDEX $name on $tablename";
1144         }
1145         if (!empty($sql))
1146             if($execute)
1147                 $this->query($sql);
1148
1149         return $sql;
1150     }
1151
1152     /**
1153      * @see DBManager::checkQuery()
1154      */
1155     protected function checkQuery(
1156         $sql
1157         )
1158     {
1159         return true;
1160     }
1161
1162     /**
1163      * @see DBManager::getTablesArray()
1164      */
1165     public function getTablesArray()
1166     {
1167         $GLOBALS['log']->debug('MSSQL fetching table list');
1168
1169         if($this->getDatabase()) {
1170             $tables = array();
1171             $r = $this->query('SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES');
1172             if (is_resource($r)) {
1173                 while ($a = $this->fetchByAssoc($r))
1174                     $tables[] = $a['TABLE_NAME'];
1175
1176                 return $tables;
1177             }
1178         }
1179
1180         return false; // no database available
1181     }
1182
1183
1184     /**
1185      * This call is meant to be used during install, when Full Text Search is enabled
1186      * Indexing would always occur after a fresh sql server install, so this code creates
1187      * a catalog and table with full text index.
1188      */
1189     public function wakeupFTS()
1190     {
1191         $GLOBALS['log']->debug('MSSQL about to wakeup FTS');
1192
1193         if($this->getDatabase()) {
1194                 //create wakup catalog
1195                 $FTSqry[] = "if not exists(  select * from sys.fulltext_catalogs where name ='wakeup_catalog' )
1196                 CREATE FULLTEXT CATALOG wakeup_catalog
1197                 ";
1198
1199                 //drop wakeup table if it exists
1200                 $FTSqry[] = "IF EXISTS(SELECT 'fts_wakeup' FROM sysobjects WHERE name = 'fts_wakeup' AND xtype='U')
1201                     DROP TABLE fts_wakeup
1202                 ";
1203                 //create wakeup table
1204                 $FTSqry[] = "CREATE TABLE fts_wakeup(
1205                     id varchar(36) NOT NULL CONSTRAINT pk_fts_wakeup_id PRIMARY KEY CLUSTERED (id ASC ),
1206                     body text NULL,
1207                     kb_index int IDENTITY(1,1) NOT NULL CONSTRAINT wakeup_fts_unique_idx UNIQUE NONCLUSTERED
1208                 )
1209                 ";
1210                 //create full text index
1211                  $FTSqry[] = "CREATE FULLTEXT INDEX ON fts_wakeup
1212                 (
1213                     body
1214                     Language 0X0
1215                 )
1216                 KEY INDEX wakeup_fts_unique_idx ON wakeup_catalog
1217                 WITH CHANGE_TRACKING AUTO
1218                 ";
1219
1220                 //insert dummy data
1221                 $FTSqry[] = "INSERT INTO fts_wakeup (id ,body)
1222                 VALUES ('".create_guid()."', 'SugarCRM Rocks' )";
1223
1224
1225                 //create queries to stop and restart indexing
1226                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup STOP POPULATION';
1227                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup DISABLE';
1228                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup ENABLE';
1229                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING MANUAL';
1230                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup START FULL POPULATION';
1231                 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING AUTO';
1232
1233                 foreach($FTSqry as $q){
1234                     sleep(3);
1235                     $this->query($q);
1236                 }
1237
1238
1239         }
1240
1241         return false; // no database available
1242     }
1243
1244     /**
1245      * @see DBManager::convert()
1246      */
1247     public function convert(
1248         $string,
1249         $type,
1250         array $additional_parameters = array(),
1251         array $additional_parameters_oracle_only = array()
1252         )
1253     {
1254         // convert the parameters array into a comma delimited string
1255         $additional_parameters_string = '';
1256         if (!empty($additional_parameters))
1257             $additional_parameters_string = ','.implode(',',$additional_parameters);
1258
1259         switch ($type) {
1260         case 'today': return "GETDATE()";
1261         case 'left': return "LEFT($string".$additional_parameters_string.")";
1262         case 'date_format':
1263             if(!empty($additional_parameters) && in_array("'%Y-%m'", $additional_parameters))
1264                return "CONVERT(varchar(7),". $string . ",120)";
1265             else
1266                return "CONVERT(varchar(10),". $string . ",120)";
1267         case 'IFNULL': return "ISNULL($string".$additional_parameters_string.")";
1268         case 'CONCAT': return "$string+".implode("+",$additional_parameters);
1269         case 'text2char': return "CAST($string AS varchar(8000))";
1270         }
1271
1272         return "$string";
1273     }
1274
1275     /**
1276      * @see DBManager::concat()
1277      */
1278     public function concat(
1279         $table,
1280         array $fields
1281         )
1282     {
1283         $ret = '';
1284
1285         foreach ( $fields as $index => $field )
1286                         if (empty($ret))
1287                             $ret =  db_convert($table.".".$field,'IFNULL', array("''"));
1288                         else
1289                             $ret .=     " + ' ' + ".db_convert($table.".".$field,'IFNULL', array("''"));
1290
1291                 return empty($ret)?$ret:"LTRIM(RTRIM($ret))";
1292     }
1293
1294     /**
1295      * @see DBManager::fromConvert()
1296      */
1297     public function fromConvert(
1298         $string,
1299         $type)
1300     {
1301         switch($type) {
1302         case 'datetime': return substr($string, 0,19);
1303         case 'date': return substr($string, 0,11);
1304         case 'time': return substr($string, 11);
1305                 }
1306
1307                 return $string;
1308     }
1309 }