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(!empty($configOptions['db_name']) && !@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 @mssql_query("SELECT @@ERROR", $this->database);
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 $orderByMatch = array();
447 preg_match('/^(.*)(ORDER BY)(.*)$/is',$matches[3], $orderByMatch);
448 if (!empty($orderByMatch[3])) {
449 $newSQL = "SELECT TOP $count * FROM
451 " . $matches[1] . " ROW_NUMBER()
452 OVER (ORDER BY " . $this->returnOrderBy($sql, $orderByMatch[3]) . ") AS row_number,
453 " . $matches[2] . $orderByMatch[1]. "
455 WHERE row_number > $start";
458 $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
463 $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
467 $distinct_o = strpos($match_two, "distinct");
468 $up_to_distinct_str = substr($match_two, 0, $distinct_o);
469 //check to see if the distinct is within a function, if so, then proceed as normal
470 if (strpos($up_to_distinct_str,"(")) {
472 $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
475 //if distinct is not within a function, then parse
476 //string contains distinct clause, "TOP needs to come after Distinct"
477 //get position of distinct
478 $match_zero = strtolower($matches[0]);
479 $distinct_pos = strpos($match_zero , "distinct");
480 //get position of where
481 $where_pos = strpos($match_zero, "where");
482 //parse through string
483 $beg = substr($matches[0], 0, $distinct_pos+9 );
484 $mid = substr($matches[0], strlen($beg), ($where_pos+5) - (strlen($beg)));
485 $end = substr($matches[0], strlen($beg) + strlen($mid) );
486 //repopulate matches array
487 $matches[1] = $beg; $matches[2] = $mid; $matches[3] = $end;
489 $newSQL = $matches[1] . " TOP $count " . $matches[2] . $matches[3];
493 $orderByMatch = array();
494 preg_match('/^(.*)(ORDER BY)(.*)$/is',$matches[3], $orderByMatch);
496 //if there is a distinct clause, parse sql string as we will have to insert the rownumber
497 //for paging, AFTER the distinct clause
499 $hasDistinct = strpos(strtolower($matches[0]), "distinct");
501 $matches_sql = strtolower($matches[0]);
502 //remove reference to distinct and select keywords, as we will use a group by instead
503 //we need to use group by because we are introducing rownumber column which would make every row unique
505 //take out the select and distinct from string so we can reuse in group by
506 $dist_str = ' distinct ';
507 $distinct_pos = strpos($matches_sql, $dist_str);
508 $matches_sql = substr($matches_sql,$distinct_pos+ strlen($dist_str));
509 //get the position of where and from for further processing
510 $from_pos = strpos($matches_sql , " from ");
511 $where_pos = strpos($matches_sql, "where");
512 //split the sql into a string before and after the from clause
513 //we will use the columns being selected to construct the group by clause
515 $distinctSQLARRAY[0] = substr($matches_sql,0, $from_pos+1);
516 $distinctSQLARRAY[1] = substr($matches_sql,$from_pos+1);
517 //get position of order by (if it exists) so we can strip it from the string
518 $ob_pos = strpos($distinctSQLARRAY[1], "order by");
520 $distinctSQLARRAY[1] = substr($distinctSQLARRAY[1],0,$ob_pos);
523 // strip off last closing parentheses from the where clause
524 $distinctSQLARRAY[1] = preg_replace('/\)\s$/',' ',$distinctSQLARRAY[1]);
527 //place group by string into array
528 $grpByArr = explode(',', $distinctSQLARRAY[0]);
530 //remove the aliases for each group by element, sql server doesnt like these in group by.
531 foreach ($grpByArr as $gb) {
534 //clean out the extra stuff added if we are concatenating first_name and last_name together
535 //this way both fields are added in correctly to the group by
536 $gb = str_replace("isnull(","",$gb);
537 $gb = str_replace("'') + ' ' + ","",$gb);
539 //remove outer reference if they exist
540 if (strpos($gb,"'")!==false){
543 //if there is a space, then an alias exists, remove alias
544 if (strpos($gb,' ')){
545 $gb = substr( $gb, 0,strpos($gb,' '));
548 //if resulting string is not empty then add to new group by string
554 $grpByStr .= ", $gb";
560 if (!empty($orderByMatch[3])) {
561 //if there is a distinct clause, form query with rownumber after distinct
563 $newSQL = "SELECT TOP $count * FROM
566 OVER (ORDER BY ".$this->returnOrderBy($sql, $orderByMatch[3]).") AS row_number,
567 count(*) counter, " . $distinctSQLARRAY[0] . "
568 " . $distinctSQLARRAY[1] . "
569 group by " . $grpByStr . "
571 WHERE row_number > $start";
574 $newSQL = "SELECT TOP $count * FROM
576 " . $matches[1] . " ROW_NUMBER()
577 OVER (ORDER BY " . $this->returnOrderBy($sql, $orderByMatch[3]) . ") AS row_number,
578 " . $matches[2] . $orderByMatch[1]. "
580 WHERE row_number > $start";
583 //bug: 22231 Records in campaigns' subpanel may not come from
584 //table of $_REQUEST['module']. Get it directly from query
585 $upperQuery = strtoupper($matches[2]);
586 if (!strpos($upperQuery,"JOIN")){
587 $from_pos = strpos($upperQuery , "FROM") + 4;
588 $where_pos = strpos($upperQuery, "WHERE");
589 $tablename = trim(substr($upperQuery,$from_pos, $where_pos - $from_pos));
591 // FIXME: this looks really bad. Probably source for tons of bug
592 // needs to be removed
593 $tablename = $this->getTableNameFromModuleName($_REQUEST['module'],$sql);
595 //if there is a distinct clause, form query with rownumber after distinct
597 $newSQL = "SELECT TOP $count * FROM
599 SELECT ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, count(*) counter, " . $distinctSQLARRAY[0] . "
600 " . $distinctSQLARRAY[1] . "
601 group by " . $grpByStr . "
604 WHERE row_number > $start";
607 $newSQL = "SELECT TOP $count * FROM
609 " . $matches[1] . " ROW_NUMBER() OVER (ORDER BY ".$tablename.".id) AS row_number, " . $matches[2] . $matches[3]. "
612 WHERE row_number > $start";
619 $GLOBALS['log']->debug('Limit Query: ' . $newSQL);
621 $result = $this->query($newSQL, $dieOnError, $msg);
622 $this->dump_slow_queries($newSQL);
631 * Searches for begginning and ending characters. It places contents into
632 * an array and replaces contents in original string. This is used to account for use of
633 * nested functions while aliasing column names
635 * @param string $p_sql SQL statement
636 * @param string $strip_beg Beginning character
637 * @param string $strip_end Ending character
638 * @param string $patt Optional, pattern to
640 private function removePatternFromSQL($p_sql, $strip_beg, $strip_end, $patt = 'patt')
642 //strip all single quotes out
643 $count = substr_count ( $p_sql, $strip_beg);
645 if ($strip_beg != $strip_end)
650 $strip_array = array();
651 while ($i<$count && $offset<strlen($p_sql)) {
652 if ($offset > strlen($p_sql))
657 $beg_sin = strpos($p_sql, $strip_beg, $offset);
662 $sec_sin = strpos($p_sql, $strip_end, $beg_sin+1);
663 $strip_array[$patt.$i] = substr($p_sql, $beg_sin, $sec_sin - $beg_sin +1);
664 if ($increment > 1) {
665 //we are in here because beginning and end patterns are not identical, so search for nesting
666 $exists = strpos($strip_array[$patt.$i], $strip_beg );
668 $nested_pos = (strrpos($strip_array[$patt.$i], $strip_beg ));
669 $strip_array[$patt.$i] = substr($p_sql,$nested_pos+$beg_sin,$sec_sin - ($nested_pos+$beg_sin)+1);
670 $p_sql = substr($p_sql, 0, $nested_pos+$beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
675 $p_sql = substr($p_sql, 0, $beg_sin) . " ##". $patt.$i."## " . substr($p_sql, $sec_sin+1);
677 $offset = $sec_sin+1;
681 $strip_array['sql_string'] = $p_sql;
689 * @param string $token
690 * @param array $pattern_array
693 private function addPatternToSQL($token, array $pattern_array)
695 //strip all single quotes out
696 $pattern_array = array_reverse($pattern_array);
698 foreach ($pattern_array as $key => $replace) {
699 $token = str_replace( "##".$key."##", $replace,$token);
706 * gets an alias from the sql statement
709 * @param string $alias
712 private function getAliasFromSQL($sql, $alias)
715 preg_match('/^(.*SELECT)(.*?FROM.*WHERE)(.*)$/isU',$sql, $matches);
716 //parse all single and double quotes out of array
717 $sin_array = $this->removePatternFromSQL($matches[2], "'", "'","sin_");
718 $new_sql = array_pop($sin_array);
719 $dub_array = $this->removePatternFromSQL($new_sql, "\"", "\"","dub_");
720 $new_sql = array_pop($dub_array);
722 //search for parenthesis
723 $paren_array = $this->removePatternFromSQL($new_sql, "(", ")", "par_");
724 $new_sql = array_pop($paren_array);
726 //all functions should be removed now, so split the array on commas
727 $mstr_sql_array = explode(",", $new_sql);
728 foreach($mstr_sql_array as $token ) {
729 if (strpos($token, $alias)) {
730 //found token, add back comments
731 $token = $this->addPatternToSQL($token, $paren_array);
732 $token = $this->addPatternToSQL($token, $dub_array);
733 $token = $this->addPatternToSQL($token, $sin_array);
735 //log and break out of this function
744 * Finds the alias of the order by column, and then return the preceding column name
747 * @param string $orderMatch
750 private function findColumnByAlias($sql, $orderMatch)
752 //change case to lowercase
753 $sql = strtolower($sql);
754 $patt = '/\s+'.trim($orderMatch).'\s*,/';
756 //check for the alias, it should contain comma, may contain space, \n, or \t
758 preg_match($patt, $sql, $matches, PREG_OFFSET_CAPTURE);
759 $found_in_sql = isset($matches[0][1]) ? $matches[0][1] : false;
762 //set default for found variable
763 $found = $found_in_sql;
765 //if still no match found, then we need to parse through the string
767 //get count of how many times the match exists in string
768 $found_count = substr_count($sql, $orderMatch);
771 $len = strlen($orderMatch);
772 //loop through string as many times as there is a match
773 while ($found_count > $i) {
774 //get the first match
775 $found_in_sql = strpos($sql, $orderMatch,$first_);
776 //make sure there was a match
778 //grab the next 2 individual characters
779 $str_plusone = substr($sql,$found_in_sql + $len,1);
780 $str_plustwo = substr($sql,$found_in_sql + $len+1,1);
781 //if one of those characters is a comma, then we have our alias
782 if ($str_plusone === "," || $str_plustwo === ","){
783 //keep track of this position
784 $found = $found_in_sql;
787 //set the offset and increase the iteration counter
788 $first_ = $found_in_sql+$len;
792 //return $found, defaults have been set, so if no match was found it will be a negative number
798 * Return the order by string to use in case the column has been aliased
801 * @param string $orig_order_match
804 private function returnOrderBy($sql, $orig_order_match)
806 $sql = strtolower($sql);
807 $orig_order_match = trim($orig_order_match);
808 if (strpos($orig_order_match, ".") != 0)
809 //this has a tablename defined, pass in the order match
810 return $orig_order_match;
812 // If there is no ordering direction (ASC/DESC), use ASC by default
813 if (strpos($orig_order_match, " ") === false) {
814 $orig_order_match .= " ASC";
817 //grab first space in order by
818 $firstSpace = strpos($orig_order_match, " ");
820 //split order by into column name and ascending/descending
821 $orderMatch = " " . strtolower(substr($orig_order_match, 0, $firstSpace));
822 $asc_desc = substr($orig_order_match,$firstSpace);
824 //look for column name as an alias in sql string
825 $found_in_sql = $this->findColumnByAlias($sql, $orderMatch);
827 if (!$found_in_sql) {
828 //check if this column needs the tablename prefixed to it
829 $orderMatch = ".".trim($orderMatch);
830 $colMatchPos = strpos($sql, $orderMatch);
831 if ($colMatchPos !== false) {
832 //grab sub string up to column name
833 $containsColStr = substr($sql,0, $colMatchPos);
834 //get position of first space, so we can grab table name
835 $lastSpacePos = strrpos($containsColStr, " ");
836 //use positions of column name, space before name, and length of column to find the correct column name
837 $col_name = substr($sql, $lastSpacePos, $colMatchPos-$lastSpacePos+strlen($orderMatch));
838 //bug 25485. When sorting by a custom field in Account List and then pressing NEXT >, system gives an error
839 $containsCommaPos = strpos($col_name, ",");
840 if($containsCommaPos !== false) {
841 $col_name = substr($col_name, $containsCommaPos+1);
846 //break out of here, log this
847 $GLOBALS['log']->debug("No match was found for order by, pass string back untouched as: $orig_order_match");
848 return $orig_order_match;
851 //if found, then parse and return
852 //grab string up to the aliased column
853 $GLOBALS['log']->debug("order by found, process sql string");
855 $psql = (trim($this->getAliasFromSQL($sql, $orderMatch )));
857 $psql = trim(substr($sql, 0, $found_in_sql));
859 //grab the last comma before the alias
860 $comma_pos = strrpos($psql, " ");
861 //substring between the comma and the alias to find the joined_table alias and column name
862 $col_name = substr($psql,0, $comma_pos);
864 //make sure the string does not have an end parenthesis
865 //and is not part of a function (i.e. "ISNULL(leads.last_name,'') as name" )
866 //this is especially true for unified search from home screen
869 if(strpos($psql, " as "))
870 $alias_beg_pos = strpos($psql, " as ");
872 // Bug # 44923 - This breaks the query and does not properly filter isnull
873 // as there are other functions such as ltrim and rtrim.
874 /* else if (strncasecmp($psql, 'isnull', 6) != 0)
875 $alias_beg_pos = strpos($psql, " "); */
877 if ($alias_beg_pos > 0) {
878 $col_name = substr($psql,0, $alias_beg_pos );
880 //add the "asc/desc" order back
881 $col_name = $col_name. " ". $asc_desc;
883 //pass in new order by
884 $GLOBALS['log']->debug("order by being returned is " . $col_name);
890 * Take in a string of the module and retrieve the correspondent table name
892 * @param string $module_str module name
893 * @param string $sql SQL statement
894 * @return string table name
896 private function getTableNameFromModuleName($module_str, $sql)
899 global $beanList, $beanFiles;
900 $GLOBALS['log']->debug("Module being processed is " . $module_str);
901 //get the right module files
902 //the module string exists in bean list, then process bean for correct table name
903 //note that we exempt the reports module from this, as queries from reporting module should be parsed for
904 //correct table name.
905 if (($module_str != 'Reports' && $module_str != 'SavedReport') && isset($beanList[$module_str]) && isset($beanFiles[$beanList[$module_str]])){
906 //if the class is not already loaded, then load files
907 if (!class_exists($beanList[$module_str]))
908 require_once($beanFiles[$beanList[$module_str]]);
910 //instantiate new bean
911 $module_bean = new $beanList[$module_str]();
912 //get table name from bean
913 $tbl_name = $module_bean->table_name;
914 //make sure table name is not just a blank space, or empty
915 $tbl_name = trim($tbl_name);
917 if(empty($tbl_name)){
918 $GLOBALS['log']->debug("Could not find table name for module $module_str. ");
919 $tbl_name = $module_str;
923 //since the module does NOT exist in beanlist, then we have to parse the string
924 //and grab the table name from the passed in sql
925 $GLOBALS['log']->debug("Could not find table name from module in request, retrieve from passed in sql");
926 $tbl_name = $module_str;
927 $sql = strtolower($sql);
929 // Bug #45625 : Getting Multi-part identifier (reports.id) could not be bound error when navigating to next page in reprots in mssql
930 // there is cases when sql string is multiline string and it we cannot find " from " string in it
931 $sql = str_replace(array("\n", "\r"), " ", $sql);
933 //look for the location of the "from" in sql string
934 $fromLoc = strpos($sql," from " );
936 //found from, substring from the " FROM " string in sql to end
937 $tableEnd = substr($sql, $fromLoc+6);
938 //We know that tablename will be next parameter after from, so
939 //grab the next space after table name.
940 // 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.
941 $carriage_ret = strpos($tableEnd,"\n");
942 $next_space = strpos($tableEnd," " );
943 if ($carriage_ret < $next_space)
944 $next_space = $carriage_ret;
945 if ($next_space > 0) {
946 $tbl_name= substr($tableEnd,0, $next_space);
947 if(empty($tbl_name)){
948 $GLOBALS['log']->debug("Could not find table name sql either, return $module_str. ");
949 $tbl_name = $module_str;
953 //grab the table, to see if it is aliased
954 $aliasTableEnd = trim(substr($tableEnd, $next_space));
955 $alias_space = strpos ($aliasTableEnd, " " );
956 if ($alias_space > 0){
957 $alias_tbl_name= substr($aliasTableEnd,0, $alias_space);
958 strtolower($alias_tbl_name);
959 if(empty($alias_tbl_name)
960 || $alias_tbl_name == "where"
961 || $alias_tbl_name == "inner"
962 || $alias_tbl_name == "left"
963 || $alias_tbl_name == "join"
964 || $alias_tbl_name == "outer"
965 || $alias_tbl_name == "right") {
966 //not aliased, do nothing
968 elseif ($alias_tbl_name == "as") {
969 //the next word is the table name
970 $aliasTableEnd = trim(substr($aliasTableEnd, $alias_space));
971 $alias_space = strpos ($aliasTableEnd, " " );
972 if ($alias_space > 0) {
973 $alias_tbl_name= trim(substr($aliasTableEnd,0, $alias_space));
974 if (!empty($alias_tbl_name))
975 $tbl_name = $alias_tbl_name;
979 //this is table alias
980 $tbl_name = $alias_tbl_name;
986 $GLOBALS['log']->debug("Table name for module $module_str is: ".$tbl_name);
992 * @see DBManager::getFieldsArray()
994 public function getFieldsArray($result, $make_lower_case = false)
996 $field_array = array();
998 if(! isset($result) || empty($result))
1002 while ($i < mssql_num_fields($result)) {
1003 $meta = mssql_fetch_field($result, $i);
1006 if($make_lower_case==true)
1007 $meta->name = strtolower($meta->name);
1009 $field_array[] = $meta->name;
1014 return $field_array;
1018 * @see DBManager::getAffectedRowCount()
1020 public function getAffectedRowCount()
1022 return $this->getOne("SELECT @@ROWCOUNT");
1026 * @see DBManager::fetchRow()
1028 public function fetchRow($result)
1030 if (empty($result)) return false;
1032 $row = mssql_fetch_assoc($result);
1033 //MSSQL returns a space " " when a varchar column is empty ("") and not null.
1034 //We need to iterate through the returned row array and strip empty spaces
1036 foreach($row as $key => $column) {
1037 //notice we only strip if one space is returned. we do not want to strip
1038 //strings with intentional spaces (" foo ")
1039 if (!empty($column) && $column ==" ") {
1048 * @see DBManager::quote()
1050 public function quote($string)
1052 if(is_array($string)) {
1053 return $this->arrayQuote($string);
1055 return str_replace("'","''", $this->quoteInternal($string));
1059 * @see DBManager::tableExists()
1061 public function tableExists($tableName)
1063 $GLOBALS['log']->info("tableExists: $tableName");
1065 $this->checkConnection();
1066 $result = $this->getOne(
1067 "SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE='BASE TABLE' AND TABLE_NAME=".$this->quoted($tableName));
1069 return !empty($result);
1073 * Get tables like expression
1074 * @param $like string
1077 public function tablesLike($like)
1079 if ($this->getDatabase()) {
1081 $r = $this->query('SELECT TABLE_NAME tn FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE=\'BASE TABLE\' AND TABLE_NAME LIKE '.$this->quoted($like));
1083 while ($a = $this->fetchByAssoc($r)) {
1084 $row = array_values($a);
1094 * @see DBManager::getTablesArray()
1096 public function getTablesArray()
1098 $GLOBALS['log']->debug('MSSQL fetching table list');
1100 if($this->getDatabase()) {
1102 $r = $this->query('SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES');
1103 if (is_resource($r)) {
1104 while ($a = $this->fetchByAssoc($r))
1105 $tables[] = $a['TABLE_NAME'];
1111 return false; // no database available
1116 * This call is meant to be used during install, when Full Text Search is enabled
1117 * Indexing would always occur after a fresh sql server install, so this code creates
1118 * a catalog and table with full text index.
1120 public function full_text_indexing_setup()
1122 $GLOBALS['log']->debug('MSSQL about to wakeup FTS');
1124 if($this->getDatabase()) {
1125 //create wakeup catalog
1126 $FTSqry[] = "if not exists( select * from sys.fulltext_catalogs where name ='wakeup_catalog' )
1127 CREATE FULLTEXT CATALOG wakeup_catalog
1130 //drop wakeup table if it exists
1131 $FTSqry[] = "IF EXISTS(SELECT 'fts_wakeup' FROM sysobjects WHERE name = 'fts_wakeup' AND xtype='U')
1132 DROP TABLE fts_wakeup
1134 //create wakeup table
1135 $FTSqry[] = "CREATE TABLE fts_wakeup(
1136 id varchar(36) NOT NULL CONSTRAINT pk_fts_wakeup_id PRIMARY KEY CLUSTERED (id ASC ),
1138 kb_index int IDENTITY(1,1) NOT NULL CONSTRAINT wakeup_fts_unique_idx UNIQUE NONCLUSTERED
1141 //create full text index
1142 $FTSqry[] = "CREATE FULLTEXT INDEX ON fts_wakeup
1147 KEY INDEX wakeup_fts_unique_idx ON wakeup_catalog
1148 WITH CHANGE_TRACKING AUTO
1152 $FTSqry[] = "INSERT INTO fts_wakeup (id ,body)
1153 VALUES ('".create_guid()."', 'SugarCRM Rocks' )";
1156 //create queries to stop and restart indexing
1157 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup STOP POPULATION';
1158 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup DISABLE';
1159 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup ENABLE';
1160 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING MANUAL';
1161 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup START FULL POPULATION';
1162 $FTSqry[] = 'ALTER FULLTEXT INDEX ON fts_wakeup SET CHANGE_TRACKING AUTO';
1164 foreach($FTSqry as $q){
1168 $this->create_default_full_text_catalog();
1171 return false; // no database available
1174 protected $date_formats = array(
1181 * @see DBManager::convert()
1183 public function convert($string, $type, array $additional_parameters = array())
1185 // convert the parameters array into a comma delimited string
1186 if (!empty($additional_parameters)) {
1187 $additional_parameters_string = ','.implode(',',$additional_parameters);
1189 $additional_parameters_string = '';
1191 $all_parameters = $additional_parameters;
1192 if(is_array($string)) {
1193 $all_parameters = array_merge($string, $all_parameters);
1194 } elseif (!is_null($string)) {
1195 array_unshift($all_parameters, $string);
1198 switch (strtolower($type)) {
1202 return "LEFT($string$additional_parameters_string)";
1204 if(!empty($additional_parameters[0]) && $additional_parameters[0][0] == "'") {
1205 $additional_parameters[0] = trim($additional_parameters[0], "'");
1207 if(!empty($additional_parameters) && isset($this->date_formats[$additional_parameters[0]])) {
1208 $len = $this->date_formats[$additional_parameters[0]];
1209 return "LEFT(CONVERT(varchar($len),". $string . ",120),$len)";
1211 return "LEFT(CONVERT(varchar(10),". $string . ",120),10)";
1214 if(empty($additional_parameters_string)) {
1215 $additional_parameters_string = ",''";
1217 return "ISNULL($string$additional_parameters_string)";
1219 return implode("+",$all_parameters);
1221 return "CAST($string AS varchar(8000))";
1223 return "DATENAME(quarter, $string)";
1225 return "LEN($string)";
1227 return "MONTH($string)";
1229 return "DATEADD({$additional_parameters[1]},{$additional_parameters[0]},$string)";
1231 return "DATEADD(hh, {$additional_parameters[0]}, DATEADD(mi, {$additional_parameters[1]}, $string))";
1238 * @see DBManager::fromConvert()
1240 public function fromConvert($string, $type)
1243 case 'datetimecombo':
1244 case 'datetime': return substr($string, 0,19);
1245 case 'date': return substr($string, 0, 10);
1246 case 'time': return substr($string, 11);
1252 * @see DBManager::createTableSQLParams()
1254 public function createTableSQLParams($tablename, $fieldDefs, $indices)
1256 if (empty($tablename) || empty($fieldDefs))
1259 $columns = $this->columnSQLRep($fieldDefs, false, $tablename);
1260 if (empty($columns))
1263 return "CREATE TABLE $tablename ($columns)";
1267 * Does this type represent text (i.e., non-varchar) value?
1268 * @param string $type
1270 public function isTextType($type)
1272 $type = strtolower($type);
1273 if(!isset($this->type_map[$type])) return false;
1274 return in_array($this->type_map[$type], array('ntext','text','image', 'nvarchar(max)'));
1278 * Return representation of an empty value depending on type
1279 * @param string $type
1281 public function emptyValue($type)
1283 $ctype = $this->getColumnType($type);
1284 if($ctype == "datetime") {
1285 return $this->convert($this->quoted("1970-01-01 00:00:00"), "datetime");
1287 if($ctype == "date") {
1288 return $this->convert($this->quoted("1970-01-01"), "datetime");
1290 if($ctype == "time") {
1291 return $this->convert($this->quoted("00:00:00"), "time");
1293 return parent::emptyValue($type);
1296 public function renameColumnSQL($tablename, $column, $newname)
1298 return "SP_RENAME '$tablename.$column', '$newname', 'COLUMN'";
1302 * Returns the SQL Alter table statment
1304 * MSSQL has a quirky T-SQL alter table syntax. Pay special attention to the
1306 * @param string $action
1308 * @param bool $ignorRequired
1309 * @param string $tablename
1311 protected function alterSQLRep($action, array $def, $ignoreRequired, $tablename)
1315 $f_def=$this->oneColumnSQLRep($def, $ignoreRequired,$tablename,false);
1316 return "ADD " . $f_def;
1319 return "DROP COLUMN " . $def['name'];
1322 //You cannot specify a default value for a column for MSSQL
1323 $f_def = $this->oneColumnSQLRep($def, $ignoreRequired,$tablename, true);
1324 $f_stmt = "ALTER COLUMN ".$f_def['name'].' '.$f_def['colType'].' '.
1325 $f_def['required'].' '.$f_def['auto_increment']."\n";
1326 if (!empty( $f_def['default']))
1327 $f_stmt .= " ALTER TABLE " . $tablename . " ADD ". $f_def['default'] . " FOR " . $def['name'];
1336 * @see DBManager::changeColumnSQL()
1338 * MSSQL uses a different syntax than MySQL for table altering that is
1339 * not quite as simplistic to implement...
1341 protected function changeColumnSQL($tablename, $fieldDefs, $action, $ignoreRequired = false)
1344 $constraints = $this->get_field_default_constraint_name($tablename);
1346 if ($this->isFieldArray($fieldDefs)) {
1347 foreach ($fieldDefs as $def)
1349 //if the column is being modified drop the default value
1350 //constraint if it exists. alterSQLRep will add the constraint back
1351 if (!empty($constraints[$def['name']])) {
1352 $sql.=" ALTER TABLE " . $tablename . " DROP CONSTRAINT " . $constraints[$def['name']];
1354 //check to see if we need to drop related indexes before the alter
1355 $indices = $this->get_indices($tablename);
1356 foreach ( $indices as $index ) {
1357 if ( in_array($def['name'],$index['fields']) ) {
1358 $sql .= ' ' . $this->add_drop_constraint($tablename,$index,true).' ';
1359 $sql2 .= ' ' . $this->add_drop_constraint($tablename,$index,false).' ';
1363 $columns[] = $this->alterSQLRep($action, $def, $ignoreRequired,$tablename);
1367 //if the column is being modified drop the default value
1368 //constraint if it exists. alterSQLRep will add the constraint back
1369 if (!empty($constraints[$fieldDefs['name']])) {
1370 $sql.=" ALTER TABLE " . $tablename . " DROP CONSTRAINT " . $constraints[$fieldDefs['name']];
1372 //check to see if we need to drop related indexes before the alter
1373 $indices = $this->get_indices($tablename);
1374 foreach ( $indices as $index ) {
1375 if ( in_array($fieldDefs['name'],$index['fields']) ) {
1376 $sql .= ' ' . $this->add_drop_constraint($tablename,$index,true).' ';
1377 $sql2 .= ' ' . $this->add_drop_constraint($tablename,$index,false).' ';
1382 $columns[] = $this->alterSQLRep($action, $fieldDefs, $ignoreRequired,$tablename);
1385 $columns = implode(", ", $columns);
1386 $sql .= " ALTER TABLE $tablename $columns " . $sql2;
1391 protected function setAutoIncrement($table, $field_name)
1393 return "identity(1,1)";
1397 * @see DBManager::setAutoIncrementStart()
1399 public function setAutoIncrementStart($table, $field_name, $start_value)
1401 if($start_value > 1)
1403 $this->query("DBCC CHECKIDENT ('$table', RESEED, $start_value)");
1408 * @see DBManager::getAutoIncrement()
1410 public function getAutoIncrement($table, $field_name)
1412 $result = $this->getOne("select IDENT_CURRENT('$table') + IDENT_INCR ( '$table' ) as 'Auto_increment'");
1417 * @see DBManager::get_indices()
1419 public function get_indices($tableName)
1421 //find all unique indexes and primary keys.
1423 SELECT sys.tables.object_id, sys.tables.name as table_name, sys.columns.name as column_name,
1424 sys.indexes.name as index_name, sys.indexes.is_unique, sys.indexes.is_primary_key
1425 FROM sys.tables, sys.indexes, sys.index_columns, sys.columns
1426 WHERE (sys.tables.object_id = sys.indexes.object_id
1427 AND sys.tables.object_id = sys.index_columns.object_id
1428 AND sys.tables.object_id = sys.columns.object_id
1429 AND sys.indexes.index_id = sys.index_columns.index_id
1430 AND sys.index_columns.column_id = sys.columns.column_id)
1431 AND sys.tables.name = '$tableName'
1433 $result = $this->query($query);
1436 while (($row=$this->fetchByAssoc($result)) != null) {
1437 $index_type = 'index';
1438 if ($row['is_primary_key'] == '1')
1439 $index_type = 'primary';
1440 elseif ($row['is_unique'] == 1 )
1441 $index_type = 'unique';
1442 $name = strtolower($row['index_name']);
1443 $indices[$name]['name'] = $name;
1444 $indices[$name]['type'] = $index_type;
1445 $indices[$name]['fields'][] = strtolower($row['column_name']);
1451 * @see DBManager::get_columns()
1453 public function get_columns($tablename)
1455 //find all unique indexes and primary keys.
1456 $result = $this->query("sp_columns $tablename");
1459 while (($row=$this->fetchByAssoc($result)) !=null) {
1460 $column_name = strtolower($row['COLUMN_NAME']);
1461 $columns[$column_name]['name']=$column_name;
1462 $columns[$column_name]['type']=strtolower($row['TYPE_NAME']);
1463 if ( $row['TYPE_NAME'] == 'decimal' ) {
1464 $columns[$column_name]['len']=strtolower($row['PRECISION']);
1465 $columns[$column_name]['len'].=','.strtolower($row['SCALE']);
1467 elseif ( in_array($row['TYPE_NAME'],array('nchar','nvarchar')) )
1468 $columns[$column_name]['len']=strtolower($row['PRECISION']);
1469 elseif ( !in_array($row['TYPE_NAME'],array('datetime','text')) )
1470 $columns[$column_name]['len']=strtolower($row['LENGTH']);
1471 if ( stristr($row['TYPE_NAME'],'identity') ) {
1472 $columns[$column_name]['auto_increment'] = '1';
1473 $columns[$column_name]['type']=str_replace(' identity','',strtolower($row['TYPE_NAME']));
1476 if (!empty($row['IS_NULLABLE']) && $row['IS_NULLABLE'] == 'NO' && (empty($row['KEY']) || !stristr($row['KEY'],'PRI')))
1477 $columns[strtolower($row['COLUMN_NAME'])]['required'] = 'true';
1480 if ( strtolower($tablename) == 'relationships' ) {
1481 $column_def = $this->getOne("select cdefault from syscolumns where id = object_id('relationships') and name = '$column_name'");
1483 if ( $column_def != 0 && ($row['COLUMN_DEF'] != null)) { // NOTE Not using !empty as an empty string may be a viable default value.
1485 $row['COLUMN_DEF'] = html_entity_decode($row['COLUMN_DEF'],ENT_QUOTES);
1486 if ( preg_match('/\([\(|\'](.*)[\)|\']\)/i',$row['COLUMN_DEF'],$matches) )
1487 $columns[$column_name]['default'] = $matches[1];
1488 elseif ( preg_match('/\(N\'(.*)\'\)/i',$row['COLUMN_DEF'],$matches) )
1489 $columns[$column_name]['default'] = $matches[1];
1491 $columns[$column_name]['default'] = $row['COLUMN_DEF'];
1499 * Get FTS catalog name for current DB
1501 protected function ftsCatalogName()
1503 if(isset($this->connectOptions['db_name'])) {
1504 return $this->connectOptions['db_name']."_fts_catalog";
1506 return 'sugar_fts_catalog';
1510 * @see DBManager::add_drop_constraint()
1512 public function add_drop_constraint($table, $definition, $drop = false)
1514 $type = $definition['type'];
1515 $fields = is_array($definition['fields'])?implode(',',$definition['fields']):$definition['fields'];
1516 $name = $definition['name'];
1522 case 'alternate_key':
1524 $sql = "DROP INDEX {$name} ON {$table}";
1526 $sql = "CREATE INDEX {$name} ON {$table} ({$fields})";
1530 $sql = "DROP INDEX {$name} ON {$table}";
1532 $sql = "CREATE CLUSTERED INDEX $name ON $table ($fields)";
1534 // constraints as indices
1537 $sql = "ALTER TABLE {$table} DROP CONSTRAINT $name";
1539 $sql = "ALTER TABLE {$table} ADD CONSTRAINT {$name} UNIQUE ({$fields})";
1543 $sql = "ALTER TABLE {$table} DROP PRIMARY KEY";
1545 $sql = "ALTER TABLE {$table} ADD CONSTRAINT {$name} PRIMARY KEY ({$fields})";
1549 $sql = "ALTER TABLE {$table} DROP FOREIGN KEY ({$fields})";
1551 $sql = "ALTER TABLE {$table} ADD CONSTRAINT {$name} FOREIGN KEY ({$fields}) REFERENCES {$definition['foreignTable']}({$definition['foreignFields']})";
1554 if ($this->full_text_indexing_enabled() && $drop) {
1555 $sql = "DROP FULLTEXT INDEX ON {$table}";
1556 } elseif ($this->full_text_indexing_enabled()) {
1557 $catalog_name=$this->ftsCatalogName();
1558 if ( isset($definition['catalog_name']) && $definition['catalog_name'] != 'default')
1559 $catalog_name = $definition['catalog_name'];
1561 $language = "Language 1033";
1562 if (isset($definition['language']) && !empty($definition['language']))
1563 $language = "Language " . $definition['language'];
1565 $key_index = $definition['key_index'];
1567 $change_tracking = "auto";
1568 if (isset($definition['change_tracking']) && !empty($definition['change_tracking']))
1569 $change_tracking = $definition['change_tracking'];
1571 $sql = " CREATE FULLTEXT INDEX ON $table ($fields $language) KEY INDEX $key_index ON $catalog_name WITH CHANGE_TRACKING $change_tracking" ;
1579 * Returns true if Full Text Search is installed
1583 public function full_text_indexing_installed()
1585 $ftsChckRes = $this->getOne("SELECT FULLTEXTSERVICEPROPERTY('IsFulltextInstalled') as fts");
1586 return !empty($ftsChckRes);
1590 * @see DBManager::full_text_indexing_enabled()
1592 protected function full_text_indexing_enabled($dbname = null)
1594 // check to see if we already have install setting in session
1595 if(!isset($_SESSION['IsFulltextInstalled']))
1596 $_SESSION['IsFulltextInstalled'] = $this->full_text_indexing_installed();
1598 // check to see if FTS Indexing service is installed
1599 if(empty($_SESSION['IsFulltextInstalled']))
1602 // grab the dbname if it was not passed through
1603 if (empty($dbname)) {
1604 global $sugar_config;
1605 $dbname = $sugar_config['dbconfig']['db_name'];
1607 //we already know that Indexing service is installed, now check
1608 //to see if it is enabled
1609 $res = $this->getOne("SELECT DATABASEPROPERTY('$dbname', 'IsFulltextEnabled') ftext");
1610 return !empty($res);
1614 * Creates default full text catalog
1616 protected function create_default_full_text_catalog()
1618 if ($this->full_text_indexing_enabled()) {
1619 $catalog = $this->ftsCatalogName();
1620 $GLOBALS['log']->debug("Creating the default catalog for full-text indexing, $catalog");
1622 //drop catalog if exists.
1623 $ret = $this->query("
1626 from sys.fulltext_catalogs
1627 where name ='$catalog'
1629 CREATE FULLTEXT CATALOG $catalog");
1632 $GLOBALS['log']->error("Error creating default full-text catalog, $catalog");
1638 * Function returns name of the constraint automatically generated by sql-server.
1639 * We request this for default, primary key, required
1641 * @param string $table
1642 * @param string $column
1645 private function get_field_default_constraint_name($table, $column = null)
1647 static $results = array();
1649 if ( empty($column) && isset($results[$table]) )
1650 return $results[$table];
1653 select s.name, o.name, c.name dtrt, d.name ctrt
1654 from sys.default_constraints as d
1655 join sys.objects as o
1656 on o.object_id = d.parent_object_id
1657 join sys.columns as c
1658 on c.object_id = o.object_id and c.column_id = d.parent_column_id
1659 join sys.schemas as s
1660 on s.schema_id = o.schema_id
1661 where o.name = '$table'
1663 if ( !empty($column) )
1664 $query .= " and c.name = '$column'";
1665 $res = $this->query($query);
1666 if ( !empty($column) ) {
1667 $row = $this->fetchByAssoc($res);
1669 return $row['ctrt'];
1672 $returnResult = array();
1673 while ( $row = $this->fetchByAssoc($res) )
1674 $returnResult[$row['dtrt']] = $row['ctrt'];
1675 $results[$table] = $returnResult;
1676 return $returnResult;
1683 * @see DBManager::massageFieldDef()
1685 public function massageFieldDef(&$fieldDef, $tablename)
1687 parent::massageFieldDef($fieldDef,$tablename);
1689 if ($fieldDef['type'] == 'int')
1690 $fieldDef['len'] = '4';
1692 if(empty($fieldDef['len']))
1694 switch($fieldDef['type']) {
1696 case 'bool' : $fieldDef['len'] = '1'; break;
1697 case 'smallint' : $fieldDef['len'] = '2'; break;
1698 case 'float' : $fieldDef['len'] = '8'; break;
1701 $fieldDef['len'] = $this->isTextType($fieldDef['dbType']) ? 'max' : '255';
1703 case 'image' : $fieldDef['len'] = '2147483647'; break;
1704 case 'ntext' : $fieldDef['len'] = '2147483646'; break; // Note: this is from legacy code, don't know if this is correct
1707 if($fieldDef['type'] == 'decimal'
1708 && empty($fieldDef['precision'])
1709 && !strpos($fieldDef['len'], ','))
1711 $fieldDef['len'] .= ',0'; // Adding 0 precision if it is not specified
1714 if(empty($fieldDef['default'])
1715 && in_array($fieldDef['type'],array('bit','bool')))
1717 $fieldDef['default'] = '0';
1719 if (isset($fieldDef['required']) && $fieldDef['required'] && !isset($fieldDef['default']) )
1720 $fieldDef['default'] = '';
1721 // if ($fieldDef['type'] == 'bit' && empty($fieldDef['len']) )
1722 // $fieldDef['len'] = '1';
1723 // if ($fieldDef['type'] == 'bool' && empty($fieldDef['len']) )
1724 // $fieldDef['len'] = '1';
1725 // if ($fieldDef['type'] == 'float' && empty($fieldDef['len']) )
1726 // $fieldDef['len'] = '8';
1727 // if ($fieldDef['type'] == 'varchar' && empty($fieldDef['len']) )
1728 // $fieldDef['len'] = '255';
1729 // if ($fieldDef['type'] == 'nvarchar' && empty($fieldDef['len']) )
1730 // $fieldDef['len'] = '255';
1731 // if ($fieldDef['type'] == 'image' && empty($fieldDef['len']) )
1732 // $fieldDef['len'] = '2147483647';
1733 // if ($fieldDef['type'] == 'ntext' && empty($fieldDef['len']) )
1734 // $fieldDef['len'] = '2147483646';
1735 // if ($fieldDef['type'] == 'smallint' && empty($fieldDef['len']) )
1736 // $fieldDef['len'] = '2';
1737 // if ($fieldDef['type'] == 'bit' && empty($fieldDef['default']) )
1738 // $fieldDef['default'] = '0';
1739 // if ($fieldDef['type'] == 'bool' && empty($fieldDef['default']) )
1740 // $fieldDef['default'] = '0';
1745 * @see DBManager::oneColumnSQLRep()
1747 protected function oneColumnSQLRep($fieldDef, $ignoreRequired = false, $table = '', $return_as_array = false)
1750 if(isset($fieldDef['name'])){
1751 $colType = $this->getFieldType($fieldDef);
1752 if(stristr($this->getFieldType($fieldDef), 'decimal') && isset($fieldDef['len'])){
1753 $fieldDef['len'] = min($fieldDef['len'],38);
1755 //bug: 39690 float(8) is interpreted as real and this generates a diff when doing repair
1756 if(stristr($colType, 'float') && isset($fieldDef['len']) && $fieldDef['len'] == 8){
1757 unset($fieldDef['len']);
1761 // always return as array for post-processing
1762 $ref = parent::oneColumnSQLRep($fieldDef, $ignoreRequired, $table, true);
1764 // Bug 24307 - Don't add precision for float fields.
1765 if ( stristr($ref['colType'],'float') )
1766 $ref['colType'] = preg_replace('/(,\d+)/','',$ref['colType']);
1768 if ( $return_as_array )
1771 return "{$ref['name']} {$ref['colType']} {$ref['default']} {$ref['required']} {$ref['auto_increment']}";
1775 * Saves changes to module's audit table
1777 * @param object $bean Sugarbean instance
1778 * @param array $changes changes
1780 public function save_audit_records(SugarBean $bean, $changes)
1782 //Bug 25078 fixed by Martin Hu: sqlserver haven't 'date' type, trim extra "00:00:00"
1783 if($changes['data_type'] == 'date'){
1784 $changes['before'] = str_replace(' 00:00:00','',$changes['before']);
1786 parent::save_audit_records($bean,$changes);
1790 * Disconnects from the database
1792 * Also handles any cleanup needed
1794 public function disconnect()
1796 $GLOBALS['log']->debug('Calling Mssql::disconnect()');
1797 if(!empty($this->database)){
1798 $this->freeResult();
1799 mssql_close($this->database);
1800 $this->database = null;
1805 * @see DBManager::freeDbResult()
1807 protected function freeDbResult($dbResult)
1809 if(!empty($dbResult))
1810 mssql_free_result($dbResult);
1815 * @see DBManager::lastDbError()
1817 public function lastDbError()
1819 $sqlmsg = mssql_get_last_message();
1820 if(empty($sqlmsg)) return false;
1821 global $app_strings;
1822 if (empty($app_strings)
1823 or !isset($app_strings['ERR_MSSQL_DB_CONTEXT'])
1824 or !isset($app_strings['ERR_MSSQL_WARNING']) ) {
1825 //ignore the message from sql-server if $app_strings array is empty. This will happen
1826 //only if connection if made before language is set.
1830 $sqlpos = strpos($sqlmsg, 'Changed database context to');
1831 $sqlpos2 = strpos($sqlmsg, 'Warning:');
1832 $sqlpos3 = strpos($sqlmsg, 'Checking identity information:');
1833 if ( $sqlpos !== false || $sqlpos2 !== false || $sqlpos3 !== false ) {
1836 global $app_strings;
1837 //ERR_MSSQL_DB_CONTEXT: localized version of 'Changed database context to' message
1838 if (empty($app_strings) or !isset($app_strings['ERR_MSSQL_DB_CONTEXT'])) {
1839 //ignore the message from sql-server if $app_strings array is empty. This will happen
1840 //only if connection if made before languge is set.
1841 $GLOBALS['log']->debug("Ignoring this database message: " . $sqlmsg);
1845 $sqlpos = strpos($sqlmsg, $app_strings['ERR_MSSQL_DB_CONTEXT']);
1846 if ( $sqlpos !== false )
1851 if ( strlen($sqlmsg) > 2 ) {
1852 return "SQL Server error: " . $sqlmsg;
1860 * @see DBManager::getDbInfo()
1862 public function getDbInfo()
1864 return array("version" => $this->version());
1869 * @see DBManager::validateQuery()
1871 public function validateQuery($query)
1873 if(!$this->isSelect($query)) {
1876 $this->query("SET SHOWPLAN_TEXT ON");
1877 $res = $this->getOne($query);
1878 $this->query("SET SHOWPLAN_TEXT OFF");
1879 return !empty($res);
1883 * This is a utility function to prepend the "N" character in front of SQL values that are
1884 * surrounded by single quotes.
1886 * @param $sql string SQL statement
1887 * @return string SQL statement with single quote values prepended with "N" character for nvarchar columns
1889 protected function _appendN($sql)
1891 // If there are no single quotes, don't bother, will just assume there is no character data
1892 if (strpos($sql, "'") === false)
1895 // Flag if there are odd number of single quotes, just continue without trying to append N
1896 if ((substr_count($sql, "'") & 1)) {
1897 $GLOBALS['log']->error("SQL statement[" . $sql . "] has odd number of single quotes.");
1901 //The only location of three subsequent ' will be at the beginning or end of a value.
1902 $sql = preg_replace('/(?<!\')(\'{3})(?!\')/', "'<@#@#@PAIR@#@#@>", $sql);
1904 // Remove any remaining '' and do not parse... replace later (hopefully we don't even have any)
1906 $regexp = '/(\'{2})/';
1907 $pair_matches = array();
1908 preg_match_all($regexp, $sql, $pair_matches);
1909 if ($pair_matches) {
1910 foreach (array_unique($pair_matches[0]) as $key=>$value) {
1911 $pairs['<@PAIR-'.$key.'@>'] = $value;
1913 if (!empty($pairs)) {
1914 $sql = str_replace($pairs, array_keys($pairs), $sql);
1918 $regexp = "/(N?'.+?')/is";
1920 preg_match_all($regexp, $sql, $matches);
1922 if (!empty($matches)) {
1923 foreach ($matches[0] as $value) {
1924 // We are assuming that all nvarchar columns are no more than 200 characters in length
1925 // One problem we face is the image column type in reports which cannot accept nvarchar data
1926 if (!empty($value) && !is_numeric(trim(str_replace(array("'", ","), "", $value))) && !preg_match('/^\'[\,]\'$/', $value)) {
1927 $replace[$value] = 'N' . trim($value, "N");
1932 if (!empty($replace))
1933 $sql = str_replace(array_keys($replace), $replace, $sql);
1936 $sql = str_replace(array_keys($pairs), $pairs, $sql);
1938 if(strpos($sql, "<@#@#@PAIR@#@#@>"))
1939 $sql = str_replace(array('<@#@#@PAIR@#@#@>'), array("''"), $sql);
1945 * Quote SQL Server search term
1946 * @param string $term
1949 protected function quoteTerm($term)
1951 $term = str_replace("%", "*", $term); // Mssql wildcard is *
1952 return '"'.$term.'"';
1956 * Generate fulltext query from set of terms
1957 * @param string $fields Field to search against
1958 * @param array $terms Search terms that may be or not be in the result
1959 * @param array $must_terms Search terms that have to be in the result
1960 * @param array $exclude_terms Search terms that have to be not in the result
1962 public function getFulltextQuery($field, $terms, $must_terms = array(), $exclude_terms = array())
1964 $condition = $or_condition = array();
1965 foreach($must_terms as $term) {
1966 $condition[] = $this->quoteTerm($term);
1969 foreach($terms as $term) {
1970 $or_condition[] = $this->quoteTerm($term);
1973 if(!empty($or_condition)) {
1974 $condition[] = "(".join(" | ", $or_condition).")";
1977 foreach($exclude_terms as $term) {
1978 $condition[] = " NOT ".$this->quoteTerm($term);
1980 $condition = $this->quoted(join(" AND ",$condition));
1981 return "CONTAINS($field, $condition)";
1985 * Check if certain database exists
1986 * @param string $dbname
1988 public function dbExists($dbname)
1990 $db = $this->getOne("SELECT name FROM master..sysdatabases WHERE name = N".$this->quoted($dbname));
1996 * @param string $dbname
1998 protected function selectDb($dbname)
2000 return mssql_select_db($dbname);
2004 * Check if certain DB user exists
2005 * @param string $username
2007 public function userExists($username)
2009 $this->selectDb("master");
2010 $user = $this->getOne("select count(*) from sys.sql_logins where name =".$this->quoted($username));
2011 // FIXME: go back to the original DB
2012 return !empty($user);
2017 * @param string $database_name
2018 * @param string $host_name
2019 * @param string $user
2020 * @param string $password
2022 public function createDbUser($database_name, $host_name, $user, $password)
2024 $qpassword = $this->quote($password);
2025 $this->selectDb($database_name);
2026 $this->query("CREATE LOGIN $user WITH PASSWORD = '$qpassword'", true);
2027 $this->query("CREATE USER $user FOR LOGIN $user", true);
2028 $this->query("EXEC sp_addRoleMember 'db_ddladmin ', '$user'", true);
2029 $this->query("EXEC sp_addRoleMember 'db_datareader','$user'", true);
2030 $this->query("EXEC sp_addRoleMember 'db_datawriter','$user'", true);
2035 * @param string $dbname
2037 public function createDatabase($dbname)
2039 return $this->query("CREATE DATABASE $dbname", true);
2044 * @param string $dbname
2046 public function dropDatabase($dbname)
2048 return $this->query("DROP DATABASE $dbname", true);
2052 * Check if this driver can be used
2055 public function valid()
2057 return function_exists("mssql_connect");
2061 * Check if this DB name is valid
2063 * @param string $name
2066 public function isDatabaseNameValid($name)
2068 // No funny chars, does not begin with number
2069 return preg_match('/^[0-9#@]+|[\"\'\*\/\\?\:\\<\>\-\ \&\!\(\)\[\]\{\}\;\,\.\`\~\|\\\\]+/', $name)==0;
2072 public function installConfig()
2075 'LBL_DBCONFIG_MSG3' => array(
2076 "setup_db_database_name" => array("label" => 'LBL_DBCONF_DB_NAME', "required" => true),
2078 'LBL_DBCONFIG_MSG2' => array(
2079 "setup_db_host_name" => array("label" => 'LBL_DBCONF_HOST_NAME', "required" => true),
2080 "setup_db_host_instance" => array("label" => 'LBL_DBCONF_HOST_INSTANCE'),
2082 'LBL_DBCONF_TITLE_USER_INFO' => array(),
2083 'LBL_DBCONFIG_B_MSG1' => array(
2084 "setup_db_admin_user_name" => array("label" => 'LBL_DBCONF_DB_ADMIN_USER', "required" => true),
2085 "setup_db_admin_password" => array("label" => 'LBL_DBCONF_DB_ADMIN_PASSWORD', "type" => "password"),
2091 * Returns a DB specific FROM clause which can be used to select against functions.
2092 * Note that depending on the database that this may also be an empty string.
2095 public function getFromDummyTable()
2101 * Returns a DB specific piece of SQL which will generate GUID (UUID)
2102 * This string can be used in dynamic SQL to do multiple inserts with a single query.
2103 * I.e. generate a unique Sugar id in a sub select of an insert statement.
2107 public function getGuidSQL()