2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
38 /*********************************************************************************
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.
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.
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
56 * The field definition is an array with the following keys:
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:
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.
86 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
87 * All Rights Reserved.
88 * Contributor(s): ______________________________________..
89 ********************************************************************************/
92 * SQL Server (mssql) manager
94 class MssqlManager extends DBManager
97 * @see DBManager::$dbType
99 public $dbType = 'mssql';
100 public $dbName = 'MsSQL';
101 public $variant = 'mssql';
102 public $label = 'LBL_MSSQL';
104 protected $capabilities = array(
105 "affected_rows" => true,
106 "select_rows" => true,
108 'limit_subquery' => true,
109 "fix:expandDatabase" => true, // Support expandDatabase fix
110 "create_user" => true,
115 * Maximum length of identifiers
117 protected $maxNameLengths = array(
124 protected $type_map = array(
131 'short' => 'smallint',
132 'varchar' => 'varchar',
134 'longtext' => 'text',
135 'date' => 'datetime',
137 'relate' => 'varchar',
138 'multienum'=> 'text',
140 'longhtml' => 'text',
141 'datetime' => 'datetime',
142 'datetimecombo' => 'datetime',
143 'time' => 'datetime',
145 'tinyint' => 'tinyint',
148 'longblob' => 'image',
149 'currency' => 'decimal(26,6)',
150 'decimal' => 'decimal',
151 'decimal2' => 'decimal',
152 'id' => 'varchar(36)',
154 'encrypt' => 'varchar',
156 'decimal_tpl' => 'decimal(%d, %d)',
159 protected $connectOptions = null;
162 * @see DBManager::connect()
164 public function connect(array $configOptions = null, $dieOnError = false)
166 global $sugar_config;
168 if (is_null($configOptions))
169 $configOptions = $sugar_config['dbconfig'];
171 //SET DATEFORMAT to 'YYYY-MM-DD''
172 ini_set('mssql.datetimeconvert', '0');
174 //set the text size and textlimit to max number so that blob columns are not truncated
175 ini_set('mssql.textlimit','2147483647');
176 ini_set('mssql.textsize','2147483647');
177 ini_set('mssql.charset','UTF-8');
179 if(!empty($configOptions['db_host_instance'])) {
180 $configOptions['db_host_instance'] = trim($configOptions['db_host_instance']);
182 //set the connections parameters
183 if (empty($configOptions['db_host_instance'])) {
184 $connect_param = $configOptions['db_host_name'];
186 $connect_param = $configOptions['db_host_name']."\\".$configOptions['db_host_instance'];
189 //create persistent connection
190 if ($this->getOption('persistent')) {
191 $this->database =@mssql_pconnect(
193 $configOptions['db_user_name'],
194 $configOptions['db_password']
197 //if no persistent connection created, then create regular connection
198 if(!$this->database){
199 $this->database = mssql_connect(
201 $configOptions['db_user_name'],
202 $configOptions['db_password']
204 if(!$this->database){
205 $GLOBALS['log']->fatal("Could not connect to server ".$configOptions['db_host_name'].
206 " as ".$configOptions['db_user_name'].".");
208 sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
213 if($this->database && $this->getOption('persistent')){
214 $_SESSION['administrator_error'] = "<B>Severe Performance Degradation: Persistent Database Connections "
215 . "not working. Please set \$sugar_config['dbconfigoption']['persistent'] to false in your "
216 . "config.php file</B>";
219 //make sure connection exists
220 if(!$this->database) {
222 sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
230 //Adding sleep and retry for mssql connection. We have come across scenarios when
231 //an error is thrown.' Unable to select database'. Following will try to connect to
232 //mssql db maximum number of 5 times at the interval of .2 second. If can not connect
233 //it will throw an Unable to select database message.
235 if(!@mssql_select_db($configOptions['db_name'], $this->database)){
239 if(@mssql_select_db($configOptions['db_name'], $this->database)){
245 $GLOBALS['log']->fatal( "Unable to select database {$configOptions['db_name']}");
247 if(isset($GLOBALS['app_strings']['ERR_NO_DB'])) {
248 sugar_die($GLOBALS['app_strings']['ERR_NO_DB']);
250 sugar_die("Could not connect to the database. Please refer to sugarcrm.log for details.");
258 if(!$this->checkError('Could Not Connect', $dieOnError))
259 $GLOBALS['log']->info("connected to db");
261 $this->connectOptions = $configOptions;
263 $GLOBALS['log']->info("Connect:".$this->database);
268 * @see DBManager::version()
270 public function version()
272 return $this->getOne("SELECT @@VERSION as version");
276 * @see DBManager::query()
278 public function query($sql, $dieOnError = false, $msg = '', $suppress = false, $keepResult = false)
281 return $this->queryArray($sql, $dieOnError, $msg, $suppress);
283 // Flag if there are odd number of single quotes
284 if ((substr_count($sql, "'") & 1))
285 $GLOBALS['log']->error("SQL statement[" . $sql . "] has odd number of single quotes.");
287 $sql = $this->_appendN($sql);
289 $GLOBALS['log']->info('Query:' . $sql);
290 $this->checkConnection();
291 $this->countQuery($sql);
292 $this->query_time = microtime(true);
294 // Bug 34892 - Clear out previous error message by checking the @@ERROR global variable
295 $errorNumber = $this->getOne("SELECT @@ERROR");
297 $result = $suppress?@mssql_query($sql, $this->database):mssql_query($sql, $this->database);
300 // awu Bug 10657: ignoring mssql error message 'Changed database context to' - an intermittent
301 // and difficult to reproduce error. The message is only a warning, and does
302 // not affect the functionality of the query
303 $sqlmsg = mssql_get_last_message();
304 $sqlpos = strpos($sqlmsg, 'Changed database context to');
305 $sqlpos2 = strpos($sqlmsg, 'Warning:');
306 $sqlpos3 = strpos($sqlmsg, 'Checking identity information:');
308 if ($sqlpos !== false || $sqlpos2 !== false || $sqlpos3 !== false) // if sqlmsg has 'Changed database context to', just log it
309 $GLOBALS['log']->debug($sqlmsg . ": " . $sql );
311 $GLOBALS['log']->fatal($sqlmsg . ": " . $sql );
313 sugar_die('SQL Error : ' . $sqlmsg);
315 echo 'SQL Error : ' . $sqlmsg;
319 $this->query_time = microtime(true) - $this->query_time;
320 $GLOBALS['log']->info('Query Execution Time:'.$this->query_time);
323 $this->checkError($msg.' Query Failed: ' . $sql, $dieOnError);
329 * This function take in the sql for a union query, the start and offset,
330 * and wraps it around an "mssql friendly" limit query
333 * @param int $start record to start at
334 * @param int $count number of records to retrieve
335 * @return string SQL statement
337 private function handleUnionLimitQuery($sql, $start, $count)
339 //set the start to 0, no negs
343 $GLOBALS['log']->debug(print_r(func_get_args(),true));
345 $this->lastsql = $sql;
347 //change the casing to lower for easier string comparison, and trim whitespaces
348 $sql = strtolower(trim($sql)) ;
351 $limitUnionSQL = $sql;
352 $order_by_str = 'order by';
354 //make array of order by's. substring approach was proving too inconsistent
355 $orderByArray = explode($order_by_str, $sql);
359 //count the number of array elements
360 $unionOrderByCount = count($orderByArray);
363 //process if there are elements
364 if ($unionOrderByCount){
365 //we really want the last order by, so reconstruct string
366 //adding a 1 to count, as we dont wish to process the last element
368 while ($unionOrderByCount>$arr_count+1) {
369 $unionsql .= $orderByArray[$arr_count];
370 $arr_count = $arr_count+1;
371 //add an "order by" string back if we are coming into loop again
372 //remember they were taken out when array was created
373 if ($unionOrderByCount>$arr_count+1) {
374 $unionsql .= "order by";
377 //grab the last order by element, set both order by's'
378 $unionOrderBy = $orderByArray[$arr_count];
379 $rowNumOrderBy = $unionOrderBy;
381 //if last element contains a "select", then this is part of the union query,
382 //and there is no order by to use
383 if (strpos($unionOrderBy, "select")) {
385 //with no guidance on what to use for required order by in rownumber function,
386 //resort to using name column.
387 $rowNumOrderBy = 'id';
392 //there are no order by elements, so just pass back string
394 //with no guidance on what to use for required order by in rownumber function,
395 //resort to using name column.
396 $rowNumOrderBy = 'id';
399 //Unions need the column name being sorted on to match across all queries in Union statement
400 //so we do not want to strip the alias like in other queries. Just add the "order by" string and
401 //pass column name as is
402 if ($unionOrderBy != '') {
403 $unionOrderBy = ' order by ' . $unionOrderBy;
406 //if start is 0, then just use a top query
408 $limitUnionSQL = "SELECT TOP $count * FROM (" .$unionsql .") as top_count ".$unionOrderBy;
410 //if start is more than 0, then use top query in conjunction
411 //with rownumber() function to create limit query.
412 $limitUnionSQL = "SELECT TOP $count * FROM( select ROW_NUMBER() OVER ( order by "
413 .$rowNumOrderBy.") AS row_number, * FROM ("
414 .$unionsql .") As numbered) "
415 . "As top_count_limit WHERE row_number > $start "
419 return $limitUnionSQL;
423 * FIXME: verify and thoroughly test this code, these regexps look fishy
424 * @see DBManager::limitQuery()
426 public function limitQuery($sql, $start, $count, $dieOnError = false, $msg = '', $execute = true)
428 $start = (int)$start;
429 $count = (int)$count;
431 $distinctSQLARRAY = array();
432 if (strpos($sql, "UNION") && !preg_match("/(')(UNION).?(')/i", $sql))
433 $newSQL = $this->handleUnionLimitQuery($sql,$start,$count);
437 $GLOBALS['log']->debug(print_r(func_get_args(),true));
438 $this->lastsql = $sql;
440 preg_match('/^(.*SELECT )(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
441 if (!empty($matches[3])) {
443 $match_two = strtolower($matches[2]);
444 if (!strpos($match_two, "distinct")> 0 && strpos($match_two, "distinct") !==0) {
446 $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
449 $distinct_o = strpos($match_two, "distinct");
450 $up_to_distinct_str = substr($match_two, 0, $distinct_o);
451 //check to see if the distinct is within a function, if so, then proceed as normal
452 if (strpos($up_to_distinct_str,"(")) {
454 $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
457 //if distinct is not within a function, then parse
458 //string contains distinct clause, "TOP needs to come after Distinct"
459 //get position of distinct
460 $match_zero = strtolower($matches[0]);
461 $distinct_pos = strpos($match_zero , "distinct");
462 //get position of where
463 $where_pos = strpos($match_zero, "where");
464 //parse through string
465 $beg = substr($matches[0], 0, $distinct_pos+9 );
466 $mid = substr($matches[0], strlen($beg), ($where_pos+5) - (strlen($beg)));
467 $end = substr($matches[0], strlen($beg) + strlen($mid) );
468 //repopulate matches array
469 $matches[1] = $beg; $matches[2] = $mid; $matches[3] = $end;
471 $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
475 $orderByMatch = array();
476 preg_match('/^(.*)(ORDER BY)(.*)$/is',$matches[3], $orderByMatch);
478 //if there is a distinct clause, parse sql string as we will have to insert the rownumber
479 //for paging, AFTER the distinct clause
481 $hasDistinct = strpos(strtolower($matches[0]), "distinct");
483 $matches_sql = strtolower($matches[0]);
484 //remove reference to distinct and select keywords, as we will use a group by instead
485 //we need to use group by because we are introducing rownumber column which would make every row unique
487 //take out the select and distinct from string so we can reuse in group by
488 $dist_str = ' distinct ';
489 $distinct_pos = strpos($matches_sql, $dist_str);
490 $matches_sql = substr($matches_sql,$distinct_pos+ strlen($dist_str));
491 //get the position of where and from for further processing
492 $from_pos = strpos($matches_sql , " from ");
493 $where_pos = strpos($matches_sql, "where");
494 //split the sql into a string before and after the from clause
495 //we will use the columns being selected to construct the group by clause
497 $distinctSQLARRAY[0] = substr($matches_sql,0, $from_pos+1);
498 $distinctSQLARRAY[1] = substr($matches_sql,$from_pos+1);
499 //get position of order by (if it exists) so we can strip it from the string
500 $ob_pos = strpos($distinctSQLARRAY[1], "order by");
502 $distinctSQLARRAY[1] = substr($distinctSQLARRAY[1],0,$ob_pos);
505 // strip off last closing parentheses from the where clause
506 $distinctSQLARRAY[1] = preg_replace('/\)\s$/',' ',$distinctSQLARRAY[1]);
509 //place group by string into array
510 $grpByArr = explode(',', $distinctSQLARRAY[0]);
512 //remove the aliases for each group by element, sql server doesnt like these in group by.
513 foreach ($grpByArr as $gb) {
516 //clean out the extra stuff added if we are concatenating first_name and last_name together
517 //this way both fields are added in correctly to the group by
518 $gb = str_replace("isnull(","",$gb);
519 $gb = str_replace("'') + ' ' + ","",$gb);
521 //remove outer reference if they exist
522 if (strpos($gb,"'")!==false){
525 //if there is a space, then an alias exists, remove alias
526 if (strpos($gb,' ')){
527 $gb = substr( $gb, 0,strpos($gb,' '));
530 //if resulting string is not empty then add to new group by string
536 $grpByStr .= ", $gb";
542 if (!empty($orderByMatch[3])) {
543 //if there is a distinct clause, form query with rownumber after distinct
545 $newSQL = "SELECT TOP $count * FROM
548 OVER (ORDER BY ".$this->returnOrderBy($sql, $orderByMatch[3]).") AS row_number,
549 count(*) counter, " . $distinctSQLARRAY[0] . "
550 " . $distinctSQLARRAY[1] . "
551 group by " . $grpByStr . "
553 WHERE row_number > $start";
556 $newSQL = "SELECT TOP $count * FROM
558 " . $matches[1] . " ROW_NUMBER()
559 OVER (ORDER BY " . $this->returnOrderBy($sql, $orderByMatch[3]) . ") AS row_number,
560 " . $matches[2] . $orderByMatch[1]. "
562 WHERE row_number > $start";
565 //bug: 22231 Records in campaigns' subpanel may not come from
566 //table of $_REQUEST['module']. Get it directly from query
567 $upperQuery = strtoupper($matches[2]);
568 if (!strpos($upperQuery,"JOIN")){
569 $from_pos = strpos($upperQuery , "FROM") + 4;
570 $where_pos = strpos($upperQuery, "WHERE");
571 $tablename = trim(substr($upperQuery,$from_pos, $where_pos - $from_pos));
573 // FIXME: this looks really bad. Probably source for tons of bug
574 // needs to be removed
575 $tablename = $this->getTableNameFromModuleName($_REQUEST['module'],$sql);
577 //if there is a distinct clause, form query with rownumber after distinct
579 $newSQL = "SELECT TOP $count * FROM
581 SELECT ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, count(*) counter, " . $distinctSQLARRAY[0] . "
582 " . $distinctSQLARRAY[1] . "
583 group by " . $grpByStr . "
586 WHERE row_number > $start";
589 $newSQL = "SELECT TOP $count * FROM
591 " . $matches[1] . " ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, " . $matches[2] . $matches[3]. "
594 WHERE row_number > $start";
601 $GLOBALS['log']->debug('Limit Query: ' . $newSQL);
603 $result = $this->query($newSQL, $dieOnError, $msg);
604 $this->dump_slow_queries($newSQL);
613 * Searches for begginning and ending characters. It places contents into
614 * an array and replaces contents in original string. This is used to account for use of
615 * nested functions while aliasing column names
617 * @param string $p_sql SQL statement
618 * @param string $strip_beg Beginning character
619 * @param string $strip_end Ending character
620 * @param string $patt Optional, pattern to
622 private function removePatternFromSQL($p_sql, $strip_beg, $strip_end, $patt = 'patt')
624 //strip all single quotes out
625 $count = substr_count ( $p_sql, $strip_beg);
627 if ($strip_beg != $strip_end)
632 $strip_array = array();
633 while ($i<$count && $offset<strlen($p_sql)) {
634 if ($offset > strlen($p_sql))
639 $beg_sin = strpos($p_sql, $strip_beg, $offset);
644 $sec_sin = strpos($p_sql, $strip_end, $beg_sin+1);
645 $strip_array[$patt.$i] = substr($p_sql, $beg_sin, $sec_sin - $beg_sin +1);
646 if ($increment > 1) {
647 //we are in here because beginning and end patterns are not identical, so search for nesting
648 $exists = strpos($strip_array[$patt.$i], $strip_beg );
650 $nested_pos = (strrpos($strip_array[$patt.$i], $strip_beg ));
651 $strip_array[$patt.$i] = substr($p_sql,$nested_pos+$beg_sin,$sec_sin - ($nested_pos+$beg_sin)+1);
652 $p_sql = substr($p_sql, 0, $nested_pos+$beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
657 $p_sql = substr($p_sql, 0, $beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
659 $offset = $sec_sin+1;
663 $strip_array['sql_string'] = $p_sql;
671 * @param string $token
672 * @param array $pattern_array
675 private function addPatternToSQL($token, array $pattern_array)
677 //strip all single quotes out
678 $pattern_array = array_reverse($pattern_array);
680 foreach ($pattern_array as $key => $replace) {
681 $token = str_replace( "##".$key."##", $replace,$token);
688 * gets an alias from the sql statement
691 * @param string $alias
694 private function getAliasFromSQL($sql, $alias)
697 preg_match('/^(.*SELECT)(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
698 //parse all single and double quotes out of array
699 $sin_array = $this->removePatternFromSQL($matches[2], "'", "'","sin_");
700 $new_sql = array_pop($sin_array);
701 $dub_array = $this->removePatternFromSQL($new_sql, "\"", "\"","dub_");
702 $new_sql = array_pop($dub_array);
704 //search for parenthesis
705 $paren_array = $this->removePatternFromSQL($new_sql, "(", ")", "par_");
706 $new_sql = array_pop($paren_array);
708 //all functions should be removed now, so split the array on commas
709 $mstr_sql_array = explode(",", $new_sql);
710 foreach($mstr_sql_array as $token ) {
711 if (strpos($token, $alias)) {
712 //found token, add back comments
713 $token = $this->addPatternToSQL($token, $paren_array);
714 $token = $this->addPatternToSQL($token, $dub_array);
715 $token = $this->addPatternToSQL($token, $sin_array);
717 //log and break out of this function
726 * Finds the alias of the order by column, and then return the preceding column name
729 * @param string $orderMatch
732 private function findColumnByAlias($sql, $orderMatch)
734 //change case to lowercase
735 $sql = strtolower($sql);
736 $patt = '/\s+'.trim($orderMatch).'\s*,/';
738 //check for the alias, it should contain comma, may contain space, \n, or \t
740 preg_match($patt, $sql, $matches, PREG_OFFSET_CAPTURE);
741 $found_in_sql = isset($matches[0][1]) ? $matches[0][1] : false;
744 //set default for found variable
745 $found = $found_in_sql;
747 //if still no match found, then we need to parse through the string
749 //get count of how many times the match exists in string
750 $found_count = substr_count($sql, $orderMatch);
753 $len = strlen($orderMatch);
754 //loop through string as many times as there is a match
755 while ($found_count > $i) {
756 //get the first match
757 $found_in_sql = strpos($sql, $orderMatch,$first_);
758 //make sure there was a match
760 //grab the next 2 individual characters
761 $str_plusone = substr($sql,$found_in_sql + $len,1);
762 $str_plustwo = substr($sql,$found_in_sql + $len+1,1);
763 //if one of those characters is a comma, then we have our alias
764 if ($str_plusone === "," || $str_plustwo === ","){
765 //keep track of this position
766 $found = $found_in_sql;
769 //set the offset and increase the iteration counter
770 $first_ = $found_in_sql+$len;
774 //return $found, defaults have been set, so if no match was found it will be a negative number
780 * Return the order by string to use in case the column has been aliased
783 * @param string $orig_order_match
786 private function returnOrderBy($sql, $orig_order_match)
788 $sql = strtolower($sql);
789 $orig_order_match = trim($orig_order_match);
790 if (strpos($orig_order_match, ".") != 0)
791 //this has a tablename defined, pass in the order match
792 return $orig_order_match;
794 //grab first space in order by
795 $firstSpace = strpos($orig_order_match, " ");
797 //split order by into column name and ascending/descending
798 $orderMatch = " " . strtolower(substr($orig_order_match, 0, $firstSpace));
799 $asc_desc = substr($orig_order_match,$firstSpace);
801 //look for column name as an alias in sql string
802 $found_in_sql = $this->findColumnByAlias($sql, $orderMatch);
804 if (!$found_in_sql) {
805 //check if this column needs the tablename prefixed to it
806 $orderMatch = ".".trim($orderMatch);
807 $colMatchPos = strpos($sql, $orderMatch);
808 if ($colMatchPos !== false) {
809 //grab sub string up to column name
810 $containsColStr = substr($sql,0, $colMatchPos);
811 //get position of first space, so we can grab table name
812 $lastSpacePos = strrpos($containsColStr, " ");
813 //use positions of column name, space before name, and length of column to find the correct column name
814 $col_name = substr($sql, $lastSpacePos, $colMatchPos-$lastSpacePos+strlen($orderMatch));
815 //bug 25485. When sorting by a custom field in Account List and then pressing NEXT >, system gives an error
816 $containsCommaPos = strpos($col_name, ",");
817 if($containsCommaPos !== false) {
818 $col_name = substr($col_name, $containsCommaPos+1);
823 //break out of here, log this
824 $GLOBALS['log']->debug("No match was found for order by, pass string back untouched as: $orig_order_match");
825 return $orig_order_match;
828 //if found, then parse and return
829 //grab string up to the aliased column
830 $GLOBALS['log']->debug("order by found, process sql string");
832 $psql = (trim($this->getAliasFromSQL($sql, $orderMatch )));
834 $psql = trim(substr($sql, 0, $found_in_sql));
836 //grab the last comma before the alias
837 $comma_pos = strrpos($psql, " ");
838 //substring between the comma and the alias to find the joined_table alias and column name
839 $col_name = substr($psql,0, $comma_pos);
841 //make sure the string does not have an end parenthesis
842 //and is not part of a function (i.e. "ISNULL(leads.last_name,'') as name" )
843 //this is especially true for unified search from home screen
846 if(strpos($psql, " as "))
847 $alias_beg_pos = strpos($psql, " as ");
849 // Bug # 44923 - This breaks the query and does not properly filter isnull
850 // as there are other functions such as ltrim and rtrim.
851 /* else if (strncasecmp($psql, 'isnull', 6) != 0)
852 $alias_beg_pos = strpos($psql, " "); */
854 if ($alias_beg_pos > 0) {
855 $col_name = substr($psql,0, $alias_beg_pos );
857 //add the "asc/desc" order back
858 $col_name = $col_name. " ". $asc_desc;
860 //pass in new order by
861 $GLOBALS['log']->debug("order by being returned is " . $col_name);
867 * Take in a string of the module and retrieve the correspondent table name
869 * @param string $module_str module name
870 * @param string $sql SQL statement
871 * @return string table name
873 private function getTableNameFromModuleName($module_str, $sql)
876 global $beanList, $beanFiles;
877 $GLOBALS['log']->debug("Module being processed is " . $module_str);
878 //get the right module files
879 //the module string exists in bean list, then process bean for correct table name
880 //note that we exempt the reports module from this, as queries from reporting module should be parsed for
881 //correct table name.
882 if (($module_str != 'Reports' && $module_str != 'SavedReport') && isset($beanList[$module_str]) && isset($beanFiles[$beanList[$module_str]])){
883 //if the class is not already loaded, then load files
884 if (!class_exists($beanList[$module_str]))
885 require_once($beanFiles[$beanList[$module_str]]);
887 //instantiate new bean
888 $module_bean = new $beanList[$module_str]();
889 //get table name from bean
890 $tbl_name = $module_bean->table_name;
891 //make sure table name is not just a blank space, or empty
892 $tbl_name = trim($tbl_name);
894 if(empty($tbl_name)){
895 $GLOBALS['log']->debug("Could not find table name for module $module_str. ");
896 $tbl_name = $module_str;
900 //since the module does NOT exist in beanlist, then we have to parse the string
901 //and grab the table name from the passed in sql
902 $GLOBALS['log']->debug("Could not find table name from module in request, retrieve from passed in sql");
903 $tbl_name = $module_str;
904 $sql = strtolower($sql);
906 //look for the location of the "from" in sql string
907 $fromLoc = strpos($sql," from " );
909 //found from, substring from the " FROM " string in sql to end
910 $tableEnd = substr($sql, $fromLoc+6);
911 //We know that tablename will be next parameter after from, so
912 //grab the next space after table name.
913 // 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.
914 $carriage_ret = strpos($tableEnd,"\n");
915 $next_space = strpos($tableEnd," " );
916 if ($carriage_ret < $next_space)
917 $next_space = $carriage_ret;
918 if ($next_space > 0) {
919 $tbl_name= substr($tableEnd,0, $next_space);
920 if(empty($tbl_name)){
921 $GLOBALS['log']->debug("Could not find table name sql either, return $module_str. ");
922 $tbl_name = $module_str;
926 //grab the table, to see if it is aliased
927 $aliasTableEnd = trim(substr($tableEnd, $next_space));
928 $alias_space = strpos ($aliasTableEnd, " " );
929 if ($alias_space > 0){
930 $alias_tbl_name= substr($aliasTableEnd,0, $alias_space);
931 strtolower($alias_tbl_name);
932 if(empty($alias_tbl_name)
933 || $alias_tbl_name == "where"
934 || $alias_tbl_name == "inner"
935 || $alias_tbl_name == "left"
936 || $alias_tbl_name == "join"
937 || $alias_tbl_name == "outer"
938 || $alias_tbl_name == "right") {
939 //not aliased, do nothing
941 elseif ($alias_tbl_name == "as") {
942 //the next word is the table name
943 $aliasTableEnd = trim(substr($aliasTableEnd, $alias_space));
944 $alias_space = strpos ($aliasTableEnd, " " );
945 if ($alias_space > 0) {
946 $alias_tbl_name= trim(substr($aliasTableEnd,0, $alias_space));
947 if (!empty($alias_tbl_name))
948 $tbl_name = $alias_tbl_name;
952 //this is table alias
953 $tbl_name = $alias_tbl_name;
959 $GLOBALS['log']->debug("Table name for module $module_str is: ".$tbl_name);
965 * @see DBManager::getFieldsArray()
967 public function getFieldsArray($result, $make_lower_case = false)
969 $field_array = array();
971 if(! isset($result) || empty($result))
975 while ($i < mssql_num_fields($result)) {
976 $meta = mssql_fetch_field($result, $i);
979 if($make_lower_case==true)
980 $meta->name = strtolower($meta->name);
982 $field_array[] = $meta->name;
991 * @see DBManager::getAffectedRowCount()
993 public function getAffectedRowCount()
995 return $this->getOne("SELECT @@ROWCOUNT");
999 * @see DBManager::fetchRow()
1001 public function fetchRow($result)
1003 if (empty($result)) return false;
1005 $row = mssql_fetch_assoc($result);
1006 //MSSQL returns a space " " when a varchar column is empty ("") and not null.
1007 //We need to iterate through the returned row array and strip empty spaces
1009 foreach($row as $key => $column) {
1010 //notice we only strip if one space is returned. we do not want to strip
1011 //strings with intentional spaces (" foo ")
1012 if (!empty($column) && $column ==" ") {
1021 * @see DBManager::quote()
1023 public function quote($string)
1025 if(is_array($string)) {
1026 return $this->arrayQuote($string);
1028 return str_replace("'","''", $this->quoteInternal($string));
1032 * @see DBManager::tableExists()
1034 public function tableExists($tableName)
1036 $GLOBALS['log']->info("tableExists: $tableName");
1038 $this->checkConnection();
1039 $result = $this->getOne(
1040 "SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE='BASE TABLE' AND TABLE_NAME=".$this->quoted($tableName));
1042 return !empty($result);
1046 * Get tables like expression
1047 * @param $like string
1050 public function tablesLike($like)
1052 if ($this->getDatabase()) {
1054 $r = $this->query('SELECT TABLE_NAME tn FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE=\'BASE TABLE\' AND TABLE_NAME LIKE '.$this->quoted($like));
1056 while ($a = $this->fetchByAssoc($r)) {
1057 $row = array_values($a);
1067 * @see DBManager::getTablesArray()
1069 public function getTablesArray()
1071 $GLOBALS['log']->debug('MSSQL fetching table list');
1073 if($this->getDatabase()) {
1075 $r = $this->query('SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES');
1076 if (is_resource($r)) {
1077 while ($a = $this->fetchByAssoc($r))
1078 $tables[] = $a['TABLE_NAME'];
1084 return false; // no database available
1089 * This call is meant to be used during install, when Full Text Search is enabled
1090 * Indexing would always occur after a fresh sql server install, so this code creates
1091 * a catalog and table with full text index.
1093 public function full_text_indexing_setup()
1095 $GLOBALS['log']->debug('MSSQL about to wakeup FTS');
1097 if($this->getDatabase()) {
1098 //create wakeup catalog
1099 $FTSqry[] = "if not exists( select * from sys.fulltext_catalogs where name ='wakeup_catalog' )
1100 CREATE FULLTEXT CATALOG wakeup_catalog
1103 //drop wakeup table if it exists
1104 $FTSqry[] = "IF EXISTS(SELECT 'fts_wakeup' FROM sysobjects WHERE name = 'fts_wakeup' AND xtype='U')
1105 DROP TABLE fts_wakeup
1107 //create wakeup table
1108 $FTSqry[] = "CREATE TABLE fts_wakeup(
1109 id varchar(36) NOT NULL CONSTRAINT pk_fts_wakeup_id PRIMARY KEY CLUSTERED (id ASC ),
1111 kb_index int IDENTITY(1,1) NOT NULL CONSTRAINT wakeup_fts_unique_idx UNIQUE NONCLUSTERED
1114 //create full text index
1115 $FTSqry[] = "CREATE FULLTEXT INDEX ON fts_wakeup
1120 KEY INDEX wakeup_fts_unique_idx ON wakeup_catalog
1121 WITH CHANGE_TRACKING AUTO
1125 $FTSqry[] = "INSERT INTO fts_wakeup (id ,body)
1126 VALUES ('".create_guid()."', 'SugarCRM Rocks' )";
1129 //create queries to stop and restart indexing
1130 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup STOP POPULATION';
1131 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup DISABLE';
1132 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup ENABLE';
1133 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING MANUAL';
1134 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup START FULL POPULATION';
1135 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING AUTO';
1137 foreach($FTSqry as $q){
1141 $this->create_default_full_text_catalog();
1144 return false; // no database available
1147 protected $date_formats = array(
1154 * @see DBManager::convert()
1156 public function convert($string, $type, array $additional_parameters = array())
1158 // convert the parameters array into a comma delimited string
1159 if (!empty($additional_parameters)) {
1160 $additional_parameters_string = ','.implode(',',$additional_parameters);
1162 $additional_parameters_string = '';
1164 $all_parameters = $additional_parameters;
1165 if(is_array($string)) {
1166 $all_parameters = array_merge($string, $all_parameters);
1167 } elseif (!is_null($string)) {
1168 array_unshift($all_parameters, $string);
1171 switch (strtolower($type)) {
1175 return "LEFT($string$additional_parameters_string)";
1177 if(!empty($additional_parameters[0]) && $additional_parameters[0][0] == "'") {
1178 $additional_parameters[0] = trim($additional_parameters[0], "'");
1180 if(!empty($additional_parameters) && isset($this->date_formats[$additional_parameters[0]])) {
1181 $len = $this->date_formats[$additional_parameters[0]];
1182 return "LEFT(CONVERT(varchar($len),". $string . ",120),$len)";
1184 return "LEFT(CONVERT(varchar(10),". $string . ",120),10)";
1187 if(empty($additional_parameters_string)) {
1188 $additional_parameters_string = ",''";
1190 return "ISNULL($string$additional_parameters_string)";
1192 return implode("+",$all_parameters);
1194 return "CAST($string AS varchar(8000))";
1196 return "DATENAME(quarter, $string)";
1198 return "LEN($string)";
1200 return "MONTH($string)";
1202 return "DATEADD({$additional_parameters[1]},{$additional_parameters[0]},$string)";
1204 return "DATEADD(hh, {$additional_parameters[0]}, DATEADD(mi, {$additional_parameters[1]}, $string))";
1211 * @see DBManager::fromConvert()
1213 public function fromConvert($string, $type)
1216 case 'datetimecombo':
1217 case 'datetime': return substr($string, 0,19);
1218 case 'date': return substr($string, 0, 10);
1219 case 'time': return substr($string, 11);
1225 * @see DBManager::createTableSQLParams()
1227 public function createTableSQLParams($tablename, $fieldDefs, $indices)
1229 if (empty($tablename) || empty($fieldDefs))
1232 $columns = $this->columnSQLRep($fieldDefs, false, $tablename);
1233 if (empty($columns))
1236 return "CREATE TABLE $tablename ($columns)";
1240 * Does this type represent text (i.e., non-varchar) value?
1241 * @param string $type
1243 public function isTextType($type)
1245 $type = strtolower($type);
1246 return in_array($this->type_map[$type], array('ntext','text','image'));
1250 * Return representation of an empty value depending on type
1251 * @param string $type
1253 public function emptyValue($type)
1255 $ctype = $this->getColumnType($type);
1256 if($ctype == "datetime") {
1257 return $this->convert($this->quoted("1970-01-01 00:00:00"), "datetime");
1259 if($ctype == "date") {
1260 return $this->convert($this->quoted("1970-01-01"), "datetime");
1262 if($ctype == "time") {
1263 return $this->convert($this->quoted("00:00:00"), "time");
1265 return parent::emptyValue($type);
1268 public function renameColumnSQL($tablename, $column, $newname)
1270 return "SP_RENAME '$tablename.$column', '$newname', 'COLUMN'";
1274 * Returns the SQL Alter table statment
1276 * MSSQL has a quirky T-SQL alter table syntax. Pay special attention to the
1278 * @param string $action
1280 * @param bool $ignorRequired
1281 * @param string $tablename
1283 protected function alterSQLRep($action, array $def, $ignoreRequired, $tablename)
1287 $f_def=$this->oneColumnSQLRep($def, $ignoreRequired,$tablename,false);
1288 return "ADD " . $f_def;
1291 return "DROP COLUMN " . $def['name'];
1294 //You cannot specify a default value for a column for MSSQL
1295 $f_def = $this->oneColumnSQLRep($def, $ignoreRequired,$tablename, true);
1296 $f_stmt = "ALTER COLUMN ".$f_def['name'].' '.$f_def['colType'].' '.
1297 $f_def['required'].' '.$f_def['auto_increment']."\n";
1298 if (!empty( $f_def['default']))
1299 $f_stmt .= " ALTER TABLE " . $tablename . " ADD ". $f_def['default'] . " FOR " . $def['name'];
1308 * @see DBManager::changeColumnSQL()
1310 * MSSQL uses a different syntax than MySQL for table altering that is
1311 * not quite as simplistic to implement...
1313 protected function changeColumnSQL($tablename, $fieldDefs, $action, $ignoreRequired = false)
1316 $constraints = $this->get_field_default_constraint_name($tablename);
1318 if ($this->isFieldArray($fieldDefs)) {
1319 foreach ($fieldDefs as $def)
1321 //if the column is being modified drop the default value
1322 //constraint if it exists. alterSQLRep will add the constraint back
1323 if (!empty($constraints[$def['name']])) {
1324 $sql.=" ALTER TABLE " . $tablename . " DROP CONSTRAINT " . $constraints[$def['name']];
1326 //check to see if we need to drop related indexes before the alter
1327 $indices = $this->get_indices($tablename);
1328 foreach ( $indices as $index ) {
1329 if ( in_array($def['name'],$index['fields']) ) {
1330 $sql .= ' ' . $this->add_drop_constraint($tablename,$index,true).' ';
1331 $sql2 .= ' ' . $this->add_drop_constraint($tablename,$index,false).' ';
1335 $columns[] = $this->alterSQLRep($action, $def, $ignoreRequired,$tablename);
1339 //if the column is being modified drop the default value
1340 //constraint if it exists. alterSQLRep will add the constraint back
1341 if (!empty($constraints[$fieldDefs['name']])) {
1342 $sql.=" ALTER TABLE " . $tablename . " DROP CONSTRAINT " . $constraints[$fieldDefs['name']];
1344 //check to see if we need to drop related indexes before the alter
1345 $indices = $this->get_indices($tablename);
1346 foreach ( $indices as $index ) {
1347 if ( in_array($fieldDefs['name'],$index['fields']) ) {
1348 $sql .= ' ' . $this->add_drop_constraint($tablename,$index,true).' ';
1349 $sql2 .= ' ' . $this->add_drop_constraint($tablename,$index,false).' ';
1354 $columns[] = $this->alterSQLRep($action, $fieldDefs, $ignoreRequired,$tablename);
1357 $columns = implode(", ", $columns);
1358 $sql .= " ALTER TABLE $tablename $columns " . $sql2;
1363 protected function setAutoIncrement($table, $field_name)
1365 return "identity(1,1)";
1369 * @see DBManager::setAutoIncrementStart()
1371 public function setAutoIncrementStart($table, $field_name, $start_value)
1373 if($start_value > 1)
1375 $this->query("DBCC CHECKIDENT ('$table', RESEED, $start_value)");
1380 * @see DBManager::getAutoIncrement()
1382 public function getAutoIncrement($table, $field_name)
1384 $result = $this->getOne("select IDENT_CURRENT('$table') + IDENT_INCR ( '$table' ) as 'Auto_increment'");
1389 * @see DBManager::get_indices()
1391 public function get_indices($tablename)
1393 //find all unique indexes and primary keys.
1395 SELECT LEFT(so.[name], 30) TableName,
1396 LEFT(si.[name], 50) 'Key_name',
1397 LEFT(sik.[keyno], 30) Sequence,
1398 LEFT(sc.[name], 30) Column_name,
1400 WHEN si.status & 2 = 2 AND so.xtype != 'PK' THEN 1
1404 INNER JOIN sysindexkeys sik
1405 ON (si.[id] = sik.[id] AND si.indid = sik.indid)
1406 INNER JOIN sysobjects so
1407 ON si.[id] = so.[id]
1408 INNER JOIN syscolumns sc
1409 ON (so.[id] = sc.[id] AND sik.colid = sc.colid)
1410 INNER JOIN sysfilegroups sfg
1411 ON si.groupid = sfg.groupid
1412 WHERE so.[name] = '$tablename'
1413 ORDER BY Key_name, Sequence, Column_name
1415 $result = $this->query($query);
1418 while (($row=$this->fetchByAssoc($result)) != null) {
1419 $index_type = 'index';
1420 if ($row['Key_name'] == 'PRIMARY')
1421 $index_type = 'primary';
1422 elseif ($row['isunique'] == 1 )
1423 $index_type = 'unique';
1424 $name = strtolower($row['Key_name']);
1425 $indices[$name]['name'] = $name;
1426 $indices[$name]['type'] = $index_type;
1427 $indices[$name]['fields'][] = strtolower($row['Column_name']);
1433 * @see DBManager::get_columns()
1435 public function get_columns($tablename)
1437 //find all unique indexes and primary keys.
1438 $result = $this->query("sp_columns $tablename");
1441 while (($row=$this->fetchByAssoc($result)) !=null) {
1442 $column_name = strtolower($row['COLUMN_NAME']);
1443 $columns[$column_name]['name']=$column_name;
1444 $columns[$column_name]['type']=strtolower($row['TYPE_NAME']);
1445 if ( $row['TYPE_NAME'] == 'decimal' ) {
1446 $columns[$column_name]['len']=strtolower($row['PRECISION']);
1447 $columns[$column_name]['len'].=','.strtolower($row['SCALE']);
1449 elseif ( in_array($row['TYPE_NAME'],array('nchar','nvarchar')) )
1450 $columns[$column_name]['len']=strtolower($row['PRECISION']);
1451 elseif ( !in_array($row['TYPE_NAME'],array('datetime','text')) )
1452 $columns[$column_name]['len']=strtolower($row['LENGTH']);
1453 if ( stristr($row['TYPE_NAME'],'identity') ) {
1454 $columns[$column_name]['auto_increment'] = '1';
1455 $columns[$column_name]['type']=str_replace(' identity','',strtolower($row['TYPE_NAME']));
1458 if (!empty($row['IS_NULLABLE']) && $row['IS_NULLABLE'] == 'NO' && (empty($row['KEY']) || !stristr($row['KEY'],'PRI')))
1459 $columns[strtolower($row['COLUMN_NAME'])]['required'] = 'true';
1462 if ( strtolower($tablename) == 'relationships' ) {
1463 $column_def = $this->getOne("select cdefault from syscolumns where id = object_id('relationships') and name = '$column_name'");
1465 if ( $column_def != 0 && ($row['COLUMN_DEF'] != null)) { // NOTE Not using !empty as an empty string may be a viable default value.
1467 $row['COLUMN_DEF'] = html_entity_decode($row['COLUMN_DEF'],ENT_QUOTES);
1468 if ( preg_match('/\([\(|\'](.*)[\)|\']\)/i',$row['COLUMN_DEF'],$matches) )
1469 $columns[$column_name]['default'] = $matches[1];
1470 elseif ( preg_match('/\(N\'(.*)\'\)/i',$row['COLUMN_DEF'],$matches) )
1471 $columns[$column_name]['default'] = $matches[1];
1473 $columns[$column_name]['default'] = $row['COLUMN_DEF'];
1481 * Get FTS catalog name for current DB
1483 protected function ftsCatalogName()
1485 if(isset($this->connectOptions['db_name'])) {
1486 return $this->connectOptions['db_name']."_fts_catalog";
1488 return 'sugar_fts_catalog';
1492 * @see DBManager::add_drop_constraint()
1494 public function add_drop_constraint($table, $definition, $drop = false)
1496 $type = $definition['type'];
1497 $fields = is_array($definition['fields'])?implode(',',$definition['fields']):$definition['fields'];
1498 $name = $definition['name'];
1504 case 'alternate_key':
1506 $sql = "DROP INDEX {$name} ON {$table}";
1508 $sql = "CREATE INDEX {$name} ON {$table} ({$fields})";
1512 $sql = "DROP INDEX {$name} ON {$table}";
1514 $sql = "CREATE CLUSTERED INDEX $name ON $table ($fields)";
1516 // constraints as indices
1519 $sql = "ALTER TABLE {$table} DROP CONSTRAINT $name";
1521 $sql = "ALTER TABLE {$table} ADD CONSTRAINT {$name} UNIQUE ({$fields})";
1525 $sql = "ALTER TABLE {$table} DROP PRIMARY KEY";
1527 $sql = "ALTER TABLE {$table} ADD CONSTRAINT {$name} PRIMARY KEY ({$fields})";
1531 $sql = "ALTER TABLE {$table} DROP FOREIGN KEY ({$fields})";
1533 $sql = "ALTER TABLE {$table} ADD CONSTRAINT {$name} FOREIGN KEY ({$fields}) REFERENCES {$definition['foreignTable']}({$definition['foreignFields']})";
1536 if ($this->full_text_indexing_enabled() && $drop) {
1537 $sql = "DROP FULLTEXT INDEX ON {$table}";
1538 } elseif ($this->full_text_indexing_enabled()) {
1539 $catalog_name=$this->ftsCatalogName();
1540 if ( isset($definition['catalog_name']) && $definition['catalog_name'] != 'default')
1541 $catalog_name = $definition['catalog_name'];
1543 $language = "Language 1033";
1544 if (isset($definition['language']) && !empty($definition['language']))
1545 $language = "Language " . $definition['language'];
1547 $key_index = $definition['key_index'];
1549 $change_tracking = "auto";
1550 if (isset($definition['change_tracking']) && !empty($definition['change_tracking']))
1551 $change_tracking = $definition['change_tracking'];
1553 $sql = " CREATE FULLTEXT INDEX ON $table ($fields $language) KEY INDEX $key_index ON $catalog_name WITH CHANGE_TRACKING $change_tracking" ;
1561 * Returns true if Full Text Search is installed
1565 public function full_text_indexing_installed()
1567 $ftsChckRes = $this->getOne("SELECT FULLTEXTSERVICEPROPERTY('IsFulltextInstalled') as fts");
1568 return !empty($ftsChckRes);
1572 * @see DBManager::full_text_indexing_enabled()
1574 protected function full_text_indexing_enabled($dbname = null)
1576 // check to see if we already have install setting in session
1577 if(!isset($_SESSION['IsFulltextInstalled']))
1578 $_SESSION['IsFulltextInstalled'] = $this->full_text_indexing_installed();
1580 // check to see if FTS Indexing service is installed
1581 if(empty($_SESSION['IsFulltextInstalled']))
1584 // grab the dbname if it was not passed through
1585 if (empty($dbname)) {
1586 global $sugar_config;
1587 $dbname = $sugar_config['dbconfig']['db_name'];
1589 //we already know that Indexing service is installed, now check
1590 //to see if it is enabled
1591 $res = $this->getOne("SELECT DATABASEPROPERTY('$dbname', 'IsFulltextEnabled') ftext");
1592 return !empty($res);
1596 * Creates default full text catalog
1598 protected function create_default_full_text_catalog()
1600 if ($this->full_text_indexing_enabled()) {
1601 $catalog = $this->ftsCatalogName();
1602 $GLOBALS['log']->debug("Creating the default catalog for full-text indexing, $catalog");
1604 //drop catalog if exists.
1605 $ret = $this->query("
1608 from sys.fulltext_catalogs
1609 where name ='$catalog'
1611 CREATE FULLTEXT CATALOG $catalog");
1614 $GLOBALS['log']->error("Error creating default full-text catalog, $catalog");
1620 * Function returns name of the constraint automatically generated by sql-server.
1621 * We request this for default, primary key, required
1623 * @param string $table
1624 * @param string $column
1627 private function get_field_default_constraint_name($table, $column = null)
1629 static $results = array();
1631 if ( empty($column) && isset($results[$table]) )
1632 return $results[$table];
1635 select s.name, o.name, c.name dtrt, d.name ctrt
1636 from sys.default_constraints as d
1637 join sys.objects as o
1638 on o.object_id = d.parent_object_id
1639 join sys.columns as c
1640 on c.object_id = o.object_id and c.column_id = d.parent_column_id
1641 join sys.schemas as s
1642 on s.schema_id = o.schema_id
1643 where o.name = '$table'
1645 if ( !empty($column) )
1646 $query .= " and c.name = '$column'";
1647 $res = $this->query($query);
1648 if ( !empty($column) ) {
1649 $row = $this->fetchByAssoc($res);
1651 return $row['ctrt'];
1654 $returnResult = array();
1655 while ( $row = $this->fetchByAssoc($res) )
1656 $returnResult[$row['dtrt']] = $row['ctrt'];
1657 $results[$table] = $returnResult;
1658 return $returnResult;
1665 * @see DBManager::massageFieldDef()
1667 public function massageFieldDef(&$fieldDef, $tablename)
1669 parent::massageFieldDef($fieldDef,$tablename);
1671 if ($fieldDef['type'] == 'int')
1672 $fieldDef['len'] = '4';
1674 if(empty($fieldDef['len']))
1676 switch($fieldDef['type']) {
1678 case 'bool' : $fieldDef['len'] = '1'; break;
1679 case 'smallint' : $fieldDef['len'] = '2'; break;
1680 case 'float' : $fieldDef['len'] = '8'; break;
1682 case 'nvarchar' : if(!in_array($fieldDef['dbType'],array('text','ntext')))
1683 $fieldDef['len'] = '255';
1685 $fieldDef['len'] = 'max'; // text or ntext
1687 case 'image' : $fieldDef['len'] = '2147483647'; break;
1688 case 'ntext' : $fieldDef['len'] = '2147483646'; break; // Note: this is from legacy code, don't know if this is correct
1691 if($fieldDef['type'] == 'decimal'
1692 && empty($fieldDef['precision'])
1693 && !strpos($fieldDef['len'], ','))
1695 $fieldDef['len'] .= ',0'; // Adding 0 precision if it is not specified
1698 if(empty($fieldDef['default'])
1699 && in_array($fieldDef['type'],array('bit','bool')))
1701 $fieldDef['default'] = '0';
1703 if (isset($fieldDef['required']) && $fieldDef['required'] && !isset($fieldDef['default']) )
1704 $fieldDef['default'] = '';
1705 // if ($fieldDef['type'] == 'bit' && empty($fieldDef['len']) )
1706 // $fieldDef['len'] = '1';
1707 // if ($fieldDef['type'] == 'bool' && empty($fieldDef['len']) )
1708 // $fieldDef['len'] = '1';
1709 // if ($fieldDef['type'] == 'float' && empty($fieldDef['len']) )
1710 // $fieldDef['len'] = '8';
1711 // if ($fieldDef['type'] == 'varchar' && empty($fieldDef['len']) )
1712 // $fieldDef['len'] = '255';
1713 // if ($fieldDef['type'] == 'nvarchar' && empty($fieldDef['len']) )
1714 // $fieldDef['len'] = '255';
1715 // if ($fieldDef['type'] == 'image' && empty($fieldDef['len']) )
1716 // $fieldDef['len'] = '2147483647';
1717 // if ($fieldDef['type'] == 'ntext' && empty($fieldDef['len']) )
1718 // $fieldDef['len'] = '2147483646';
1719 // if ($fieldDef['type'] == 'smallint' && empty($fieldDef['len']) )
1720 // $fieldDef['len'] = '2';
1721 // if ($fieldDef['type'] == 'bit' && empty($fieldDef['default']) )
1722 // $fieldDef['default'] = '0';
1723 // if ($fieldDef['type'] == 'bool' && empty($fieldDef['default']) )
1724 // $fieldDef['default'] = '0';
1729 * @see DBManager::oneColumnSQLRep()
1731 protected function oneColumnSQLRep($fieldDef, $ignoreRequired = false, $table = '', $return_as_array = false)
1734 if(isset($fieldDef['name'])){
1735 $colType = $this->getFieldType($fieldDef);
1736 if(stristr($this->getFieldType($fieldDef), 'decimal') && isset($fieldDef['len'])){
1737 $fieldDef['len'] = min($fieldDef['len'],38);
1739 //bug: 39690 float(8) is interpreted as real and this generates a diff when doing repair
1740 if(stristr($colType, 'float') && isset($fieldDef['len']) && $fieldDef['len'] == 8){
1741 unset($fieldDef['len']);
1745 // always return as array for post-processing
1746 $ref = parent::oneColumnSQLRep($fieldDef, $ignoreRequired, $table, true);
1748 // Bug 24307 - Don't add precision for float fields.
1749 if ( stristr($ref['colType'],'float') )
1750 $ref['colType'] = preg_replace('/(,\d+)/','',$ref['colType']);
1752 if ( $return_as_array )
1755 return "{$ref['name']} {$ref['colType']} {$ref['default']} {$ref['required']} {$ref['auto_increment']}";
1759 * Saves changes to module's audit table
1761 * @param object $bean Sugarbean instance
1762 * @param array $changes changes
1764 public function save_audit_records(SugarBean $bean, $changes)
1766 //Bug 25078 fixed by Martin Hu: sqlserver haven't 'date' type, trim extra "00:00:00"
1767 if($changes['data_type'] == 'date'){
1768 $changes['before'] = str_replace(' 00:00:00','',$changes['before']);
1770 parent::save_audit_records($bean,$changes);
1774 * Disconnects from the database
1776 * Also handles any cleanup needed
1778 public function disconnect()
1780 $GLOBALS['log']->debug('Calling Mssql::disconnect()');
1781 if(!empty($this->database)){
1782 $this->freeResult();
1783 mssql_close($this->database);
1784 $this->database = null;
1789 * @see DBManager::freeDbResult()
1791 protected function freeDbResult($dbResult)
1793 if(!empty($dbResult))
1794 mssql_free_result($dbResult);
1799 * @see DBManager::lastDbError()
1801 public function lastDbError()
1803 $sqlmsg = mssql_get_last_message();
1804 if(empty($sqlmsg)) return false;
1805 global $app_strings;
1806 if (empty($app_strings)
1807 or !isset($app_strings['ERR_MSSQL_DB_CONTEXT'])
1808 or !isset($app_strings['ERR_MSSQL_WARNING']) ) {
1809 //ignore the message from sql-server if $app_strings array is empty. This will happen
1810 //only if connection if made before language is set.
1814 $sqlpos = strpos($sqlmsg, 'Changed database context to');
1815 $sqlpos2 = strpos($sqlmsg, 'Warning:');
1816 $sqlpos3 = strpos($sqlmsg, 'Checking identity information:');
1817 if ( $sqlpos !== false || $sqlpos2 !== false || $sqlpos3 !== false ) {
1820 global $app_strings;
1821 //ERR_MSSQL_DB_CONTEXT: localized version of 'Changed database context to' message
1822 if (empty($app_strings) or !isset($app_strings['ERR_MSSQL_DB_CONTEXT'])) {
1823 //ignore the message from sql-server if $app_strings array is empty. This will happen
1824 //only if connection if made before languge is set.
1825 $GLOBALS['log']->debug("Ignoring this database message: " . $sqlmsg);
1829 $sqlpos = strpos($sqlmsg, $app_strings['ERR_MSSQL_DB_CONTEXT']);
1830 if ( $sqlpos !== false )
1835 if ( strlen($sqlmsg) > 2 ) {
1836 return "SQL Server error: " . $sqlmsg;
1844 * @see DBManager::getDbInfo()
1846 public function getDbInfo()
1848 return array("version" => $this->version());
1853 * @see DBManager::validateQuery()
1855 public function validateQuery($query)
1857 if(!$this->isSelect($query)) {
1860 $this->query("SET SHOWPLAN_TEXT ON");
1861 $res = $this->getOne($query);
1862 $this->query("SET SHOWPLAN_TEXT OFF");
1863 return !empty($res);
1867 * This is a utility function to prepend the "N" character in front of SQL values that are
1868 * surrounded by single quotes.
1870 * @param $sql string SQL statement
1871 * @return string SQL statement with single quote values prepended with "N" character for nvarchar columns
1873 protected function _appendN($sql)
1875 // If there are no single quotes, don't bother, will just assume there is no character data
1876 if (strpos($sql, "'") === false)
1879 // Flag if there are odd number of single quotes, just continue without trying to append N
1880 if ((substr_count($sql, "'") & 1)) {
1881 $GLOBALS['log']->error("SQL statement[" . $sql . "] has odd number of single quotes.");
1885 //The only location of three subsequent ' will be at the beginning or end of a value.
1886 $sql = preg_replace('/(?<!\')(\'{3})(?!\')/', "'<@#@#@PAIR@#@#@>", $sql);
1888 // Remove any remaining '' and do not parse... replace later (hopefully we don't even have any)
1890 $regexp = '/(\'{2})/';
1891 $pair_matches = array();
1892 preg_match_all($regexp, $sql, $pair_matches);
1893 if ($pair_matches) {
1894 foreach (array_unique($pair_matches[0]) as $key=>$value) {
1895 $pairs['<@PAIR-'.$key.'@>'] = $value;
1897 if (!empty($pairs)) {
1898 $sql = str_replace($pairs, array_keys($pairs), $sql);
1902 $regexp = "/(N?'.+?')/is";
1904 preg_match_all($regexp, $sql, $matches);
1906 if (!empty($matches)) {
1907 foreach ($matches[0] as $value) {
1908 // We are assuming that all nvarchar columns are no more than 200 characters in length
1909 // One problem we face is the image column type in reports which cannot accept nvarchar data
1910 if (!empty($value) && !is_numeric(trim(str_replace(array("'", ","), "", $value))) && !preg_match('/^\'[\,]\'$/', $value)) {
1911 $replace[$value] = 'N' . trim($value, "N");
1916 if (!empty($replace))
1917 $sql = str_replace(array_keys($replace), $replace, $sql);
1920 $sql = str_replace(array_keys($pairs), $pairs, $sql);
1922 if(strpos($sql, "<@#@#@PAIR@#@#@>"))
1923 $sql = str_replace(array('<@#@#@PAIR@#@#@>'), array("''"), $sql);
1929 * Quote SQL Server search term
1930 * @param string $term
1933 protected function quoteTerm($term)
1935 $term = str_replace("%", "*", $term); // Mssql wildcard is *
1936 return '"'.$term.'"';
1940 * Generate fulltext query from set of terms
1941 * @param string $fields Field to search against
1942 * @param array $terms Search terms that may be or not be in the result
1943 * @param array $must_terms Search terms that have to be in the result
1944 * @param array $exclude_terms Search terms that have to be not in the result
1946 public function getFulltextQuery($field, $terms, $must_terms = array(), $exclude_terms = array())
1948 $condition = $or_condition = array();
1949 foreach($must_terms as $term) {
1950 $condition[] = $this->quoteTerm($term);
1953 foreach($terms as $term) {
1954 $or_condition[] = $this->quoteTerm($term);
1957 if(!empty($or_condition)) {
1958 $condition[] = "(".join(" | ", $or_condition).")";
1961 foreach($exclude_terms as $term) {
1962 $condition[] = " NOT ".$this->quoteTerm($term);
1964 $condition = $this->quoted(join(" AND ",$condition));
1965 return "CONTAINS($field, $condition)";
1969 * Check if certain database exists
1970 * @param string $dbname
1972 public function dbExists($dbname)
1974 $db = $this->getOne("SELECT name FROM master..sysdatabases WHERE name = N".$this->quoted($dbname));
1980 * @param string $dbname
1982 protected function selectDb($dbname)
1984 return mssql_select_db($dbname);
1988 * Check if certain DB user exists
1989 * @param string $username
1991 public function userExists($username)
1993 $this->selectDb("master");
1994 $user = $this->getOne("select count(*) from sys.sql_logins where name =".$this->quoted($username));
1995 // FIXME: go back to the original DB
1996 return !empty($user);
2001 * @param string $database_name
2002 * @param string $host_name
2003 * @param string $user
2004 * @param string $password
2006 public function createDbUser($database_name, $host_name, $user, $password)
2008 $qpassword = $this->quote($password);
2009 $this->selectDb($database_name);
2010 $this->query("CREATE LOGIN $user WITH PASSWORD = '$qpassword'", true);
2011 $this->query("CREATE USER $user FOR LOGIN $user", true);
2012 $this->query("EXEC sp_addRoleMember 'db_ddladmin ', '$user'", true);
2013 $this->query("EXEC sp_addRoleMember 'db_datareader','$user'", true);
2014 $this->query("EXEC sp_addRoleMember 'db_datawriter','$user'", true);
2019 * @param string $dbname
2021 public function createDatabase($dbname)
2023 return $this->query("CREATE DATABASE $dbname", true);
2028 * @param string $dbname
2030 public function dropDatabase($dbname)
2032 return $this->query("DROP DATABASE $dbname", true);
2036 * Check if this driver can be used
2039 public function valid()
2041 return function_exists("mssql_connect");
2045 * Check if this DB name is valid
2047 * @param string $name
2050 public function isDatabaseNameValid($name)
2052 // No funny chars, does not begin with number
2053 return preg_match('/^[0-9#@]+|[\"\'\*\/\\?\:\\<\>\-\ \&\!\(\)\[\]\{\}\;\,\.\`\~\|\\\\]+/', $name)==0;
2056 public function installConfig()
2059 'LBL_DBCONFIG_MSG3' => array(
2060 "setup_db_database_name" => array("label" => 'LBL_DBCONF_DB_NAME', "required" => true),
2062 'LBL_DBCONFIG_MSG2' => array(
2063 "setup_db_host_name" => array("label" => 'LBL_DBCONF_HOST_NAME', "required" => true),
2064 "setup_db_host_instance" => array("label" => 'LBL_DBCONF_HOST_INSTANCE'),
2066 'LBL_DBCONF_TITLE_USER_INFO' => array(),
2067 'LBL_DBCONFIG_B_MSG1' => array(
2068 "setup_db_admin_user_name" => array("label" => 'LBL_DBCONF_DB_ADMIN_USER', "required" => true),
2069 "setup_db_admin_password" => array("label" => 'LBL_DBCONF_DB_ADMIN_PASSWORD', "type" => "password"),