diff --git a/code/MSSQLAzureDatabase.php b/code/MSSQLAzureDatabase.php index f47b566..9b9c734 100644 --- a/code/MSSQLAzureDatabase.php +++ b/code/MSSQLAzureDatabase.php @@ -1,105 +1,111 @@ - - * @package mssql - */ -class MSSQLAzureDatabase extends MSSQLDatabase { - - /** - * List of parameters used to create new Azure connections between databases - * - * @var array - */ - protected $parameters = array(); - - public function fullTextEnabled() { - return false; - } - - public function __construct($parameters) { - $this->connectDatabase($parameters); - } - - /** - * Connect to a SQL Azure database with the given parameters. - * @param array $parameters Connection parameters set by environment - * - server: The server, eg, localhost - * - username: The username to log on with - * - password: The password to log on with - * - database: The database to connect to - * - windowsauthentication: Not supported for Azure - */ - protected function connect($parameters) { - $this->parameters = $parameters; - $this->connectDatabase($parameters['database']); - } - - /** - * Connect to a database using the provided parameters - * - * @param string $database - */ - protected function connectDatabase($database) { - $parameters = $this->parameters; - $parameters['database'] = $database; - $parameters['multipleactiveresultsets'] = 0; - - // Ensure that driver is available (required by PDO) - if(empty($parameters['driver'])) { - $parameters['driver'] = $this->getDatabaseServer(); - } - - // Notify connector of parameters, instructing the connector - // to connect immediately to the Azure database - $this->connector->connect($parameters, true); - - // Configure the connection - $this->query('SET QUOTED_IDENTIFIER ON'); - $this->query('SET TEXTSIZE 2147483647'); - } - - /** - * Switches to the given database. - * - * IMPORTANT: SQL Azure doesn't support "USE", so we need - * to reinitialize the database connection with the requested - * database name. - * @see http://msdn.microsoft.com/en-us/library/windowsazure/ee336288.aspx - * - * @param type $name The database name to switch to - * @param type $create - * @param type $errorLevel - */ - public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR) { - $this->fullTextEnabled = null; - if (!$this->schemaManager->databaseExists($name)) { - // Check DB creation permisson - if (!$create) { - if ($errorLevel !== false) { - user_error("Attempted to connect to non-existing database \"$name\"", $errorLevel); - } - // Unselect database - $this->connector->unloadDatabase(); - return false; - } - $this->schemaManager->createDatabase($name); - } - $this->connectDatabase($name); - return true; - } -} + + * @package mssql + */ +class MSSQLAzureDatabase extends MSSQLDatabase +{ + + /** + * List of parameters used to create new Azure connections between databases + * + * @var array + */ + protected $parameters = array(); + + public function fullTextEnabled() + { + return false; + } + + public function __construct($parameters) + { + $this->connectDatabase($parameters); + } + + /** + * Connect to a SQL Azure database with the given parameters. + * @param array $parameters Connection parameters set by environment + * - server: The server, eg, localhost + * - username: The username to log on with + * - password: The password to log on with + * - database: The database to connect to + * - windowsauthentication: Not supported for Azure + */ + protected function connect($parameters) + { + $this->parameters = $parameters; + $this->connectDatabase($parameters['database']); + } + + /** + * Connect to a database using the provided parameters + * + * @param string $database + */ + protected function connectDatabase($database) + { + $parameters = $this->parameters; + $parameters['database'] = $database; + $parameters['multipleactiveresultsets'] = 0; + + // Ensure that driver is available (required by PDO) + if (empty($parameters['driver'])) { + $parameters['driver'] = $this->getDatabaseServer(); + } + + // Notify connector of parameters, instructing the connector + // to connect immediately to the Azure database + $this->connector->connect($parameters, true); + + // Configure the connection + $this->query('SET QUOTED_IDENTIFIER ON'); + $this->query('SET TEXTSIZE 2147483647'); + } + + /** + * Switches to the given database. + * + * IMPORTANT: SQL Azure doesn't support "USE", so we need + * to reinitialize the database connection with the requested + * database name. + * @see http://msdn.microsoft.com/en-us/library/windowsazure/ee336288.aspx + * + * @param type $name The database name to switch to + * @param type $create + * @param type $errorLevel + */ + public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR) + { + $this->fullTextEnabled = null; + if (!$this->schemaManager->databaseExists($name)) { + // Check DB creation permisson + if (!$create) { + if ($errorLevel !== false) { + user_error("Attempted to connect to non-existing database \"$name\"", $errorLevel); + } + // Unselect database + $this->connector->unloadDatabase(); + return false; + } + $this->schemaManager->createDatabase($name); + } + $this->connectDatabase($name); + return true; + } +} diff --git a/code/MSSQLDatabase.php b/code/MSSQLDatabase.php index e68c1b3..27bf4aa 100644 --- a/code/MSSQLDatabase.php +++ b/code/MSSQLDatabase.php @@ -38,542 +38,603 @@ * * @package mssql */ -class MSSQLDatabase extends SS_Database { +class MSSQLDatabase extends SS_Database +{ - /** - * Words that will trigger an error if passed to a SQL Server fulltext search - */ - public static $noiseWords = array('about', '1', 'after', '2', 'all', 'also', '3', 'an', '4', 'and', '5', 'another', '6', 'any', '7', 'are', '8', 'as', '9', 'at', '0', 'be', '$', 'because', 'been', 'before', 'being', 'between', 'both', 'but', 'by', 'came', 'can', 'come', 'could', 'did', 'do', 'does', 'each', 'else', 'for', 'from', 'get', 'got', 'has', 'had', 'he', 'have', 'her', 'here', 'him', 'himself', 'his', 'how', 'if', 'in', 'into', 'is', 'it', 'its', 'just', 'like', 'make', 'many', 'me', 'might', 'more', 'most', 'much', 'must', 'my', 'never', 'no', 'now', 'of', 'on', 'only', 'or', 'other', 'our', 'out', 'over', 're', 'said', 'same', 'see', 'should', 'since', 'so', 'some', 'still', 'such', 'take', 'than', 'that', 'the', 'their', 'them', 'then', 'there', 'these', 'they', 'this', 'those', 'through', 'to', 'too', 'under', 'up', 'use', 'very', 'want', 'was', 'way', 'we', 'well', 'were', 'what', 'when', 'where', 'which', 'while', 'who', 'will', 'with', 'would', 'you', 'your', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'); + /** + * Words that will trigger an error if passed to a SQL Server fulltext search + */ + public static $noiseWords = array('about', '1', 'after', '2', 'all', 'also', '3', 'an', '4', 'and', '5', 'another', '6', 'any', '7', 'are', '8', 'as', '9', 'at', '0', 'be', '$', 'because', 'been', 'before', 'being', 'between', 'both', 'but', 'by', 'came', 'can', 'come', 'could', 'did', 'do', 'does', 'each', 'else', 'for', 'from', 'get', 'got', 'has', 'had', 'he', 'have', 'her', 'here', 'him', 'himself', 'his', 'how', 'if', 'in', 'into', 'is', 'it', 'its', 'just', 'like', 'make', 'many', 'me', 'might', 'more', 'most', 'much', 'must', 'my', 'never', 'no', 'now', 'of', 'on', 'only', 'or', 'other', 'our', 'out', 'over', 're', 'said', 'same', 'see', 'should', 'since', 'so', 'some', 'still', 'such', 'take', 'than', 'that', 'the', 'their', 'them', 'then', 'there', 'these', 'they', 'this', 'those', 'through', 'to', 'too', 'under', 'up', 'use', 'very', 'want', 'was', 'way', 'we', 'well', 'were', 'what', 'when', 'where', 'which', 'while', 'who', 'will', 'with', 'would', 'you', 'your', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'); - /** - * Transactions will work with FreeTDS, but not entirely with sqlsrv driver on Windows with MARS enabled. - * TODO: - * - after the test fails with open transaction, the transaction should be rolled back, - * otherwise other tests will break claiming that transaction is still open. - * - figure out SAVEPOINTS - * - READ ONLY transactions - */ - protected $supportsTransactions = true; + /** + * Transactions will work with FreeTDS, but not entirely with sqlsrv driver on Windows with MARS enabled. + * TODO: + * - after the test fails with open transaction, the transaction should be rolled back, + * otherwise other tests will break claiming that transaction is still open. + * - figure out SAVEPOINTS + * - READ ONLY transactions + */ + protected $supportsTransactions = true; - /** - * Cached flag to determine if full-text is enabled. This is set by - * {@link MSSQLDatabase::fullTextEnabled()} - * - * @var boolean - */ - protected $fullTextEnabled = null; + /** + * Cached flag to determine if full-text is enabled. This is set by + * {@link MSSQLDatabase::fullTextEnabled()} + * + * @var boolean + */ + protected $fullTextEnabled = null; - /** - * Set the default collation of the MSSQL nvarchar fields that we create. - * We don't apply this to the database as a whole, so that we can use unicode collations. - * - * @param string $collation - */ - public static function set_collation($collation) { - Config::inst()->update('MSSQLDatabase', 'collation', $collation); - } - - /** - * The default collation of the MSSQL nvarchar fields that we create. - * We don't apply this to the database as a whole, so that we can use - * unicode collations. - * - * @return string - */ - public static function get_collation() { - return Config::inst()->get('MSSQLDatabase', 'collation'); - } + /** + * Set the default collation of the MSSQL nvarchar fields that we create. + * We don't apply this to the database as a whole, so that we can use unicode collations. + * + * @param string $collation + */ + public static function set_collation($collation) + { + Config::inst()->update('MSSQLDatabase', 'collation', $collation); + } + + /** + * The default collation of the MSSQL nvarchar fields that we create. + * We don't apply this to the database as a whole, so that we can use + * unicode collations. + * + * @return string + */ + public static function get_collation() + { + return Config::inst()->get('MSSQLDatabase', 'collation'); + } - /** - * Connect to a MS SQL database. - * @param array $parameters An map of parameters, which should include: - * - server: The server, eg, localhost - * - username: The username to log on with - * - password: The password to log on with - * - database: The database to connect to - * - windowsauthentication: Set to true to use windows authentication - * instead of username/password - */ - public function connect($parameters) { - parent::connect($parameters); + /** + * Connect to a MS SQL database. + * @param array $parameters An map of parameters, which should include: + * - server: The server, eg, localhost + * - username: The username to log on with + * - password: The password to log on with + * - database: The database to connect to + * - windowsauthentication: Set to true to use windows authentication + * instead of username/password + */ + public function connect($parameters) + { + parent::connect($parameters); - // Configure the connection - $this->query('SET QUOTED_IDENTIFIER ON'); - $this->query('SET TEXTSIZE 2147483647'); - } + // Configure the connection + $this->query('SET QUOTED_IDENTIFIER ON'); + $this->query('SET TEXTSIZE 2147483647'); + } - /** - * Checks whether the current SQL Server version has full-text - * support installed and full-text is enabled for this database. - * - * @return boolean - */ - public function fullTextEnabled() { - if($this->fullTextEnabled === null) { - $this->fullTextEnabled = $this->updateFullTextEnabled(); - } - return $this->fullTextEnabled; - } - - /** - * Checks whether the current SQL Server version has full-text - * support installed and full-text is enabled for this database. - * - * @return boolean - */ - protected function updateFullTextEnabled() { - // Check if installed - $isInstalled = $this->query("SELECT fulltextserviceproperty('isfulltextinstalled')")->value(); - if(!$isInstalled) return false; - - // Check if current database is enabled - $database = $this->getSelectedDatabase(); - $enabledForDb = $this->preparedQuery( - "SELECT is_fulltext_enabled FROM sys.databases WHERE name = ?", - array($database) - )->value(); - return $enabledForDb; - } + /** + * Checks whether the current SQL Server version has full-text + * support installed and full-text is enabled for this database. + * + * @return boolean + */ + public function fullTextEnabled() + { + if ($this->fullTextEnabled === null) { + $this->fullTextEnabled = $this->updateFullTextEnabled(); + } + return $this->fullTextEnabled; + } + + /** + * Checks whether the current SQL Server version has full-text + * support installed and full-text is enabled for this database. + * + * @return boolean + */ + protected function updateFullTextEnabled() + { + // Check if installed + $isInstalled = $this->query("SELECT fulltextserviceproperty('isfulltextinstalled')")->value(); + if (!$isInstalled) { + return false; + } + + // Check if current database is enabled + $database = $this->getSelectedDatabase(); + $enabledForDb = $this->preparedQuery( + "SELECT is_fulltext_enabled FROM sys.databases WHERE name = ?", + array($database) + )->value(); + return $enabledForDb; + } - public function supportsCollations() { - return true; - } + public function supportsCollations() + { + return true; + } - public function supportsTimezoneOverride() { - return true; - } + public function supportsTimezoneOverride() + { + return true; + } - public function getDatabaseServer() { - return "sqlsrv"; - } - - public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR) { - $this->fullTextEnabled = null; - - return parent::selectDatabase($name, $create, $errorLevel); - } + public function getDatabaseServer() + { + return "sqlsrv"; + } + + public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR) + { + $this->fullTextEnabled = null; + + return parent::selectDatabase($name, $create, $errorLevel); + } - public function clearTable($table) { - $this->query("TRUNCATE TABLE \"$table\""); - } + public function clearTable($table) + { + $this->query("TRUNCATE TABLE \"$table\""); + } - /** - * SQL Server uses CURRENT_TIMESTAMP for the current date/time. - */ - function now() { - return 'CURRENT_TIMESTAMP'; - } + /** + * SQL Server uses CURRENT_TIMESTAMP for the current date/time. + */ + public function now() + { + return 'CURRENT_TIMESTAMP'; + } - /** - * Returns the database-specific version of the random() function - */ - function random(){ - return 'RAND()'; - } + /** + * Returns the database-specific version of the random() function + */ + public function random() + { + return 'RAND()'; + } - /** - * The core search engine configuration. - * Picks up the fulltext-indexed tables from the database and executes search on all of them. - * Results are obtained as ID-ClassName pairs which is later used to reconstruct the DataObjectSet. - * - * @param array classesToSearch computes all descendants and includes them. Check is done via WHERE clause. - * @param string $keywords Keywords as a space separated string - * @return object DataObjectSet of result pages - */ - public function searchEngine($classesToSearch, $keywords, $start, $pageLength, $sortBy = "Relevance DESC", $extraFilter = "", $booleanSearch = false, $alternativeFileFilter = "", $invertedMatch = false) { - if(isset($objects)) $results = new ArrayList($objects); - else $results = new ArrayList(); + /** + * The core search engine configuration. + * Picks up the fulltext-indexed tables from the database and executes search on all of them. + * Results are obtained as ID-ClassName pairs which is later used to reconstruct the DataObjectSet. + * + * @param array classesToSearch computes all descendants and includes them. Check is done via WHERE clause. + * @param string $keywords Keywords as a space separated string + * @return object DataObjectSet of result pages + */ + public function searchEngine($classesToSearch, $keywords, $start, $pageLength, $sortBy = "Relevance DESC", $extraFilter = "", $booleanSearch = false, $alternativeFileFilter = "", $invertedMatch = false) + { + if (isset($objects)) { + $results = new ArrayList($objects); + } else { + $results = new ArrayList(); + } - if (!$this->fullTextEnabled()) return $results; - if (!in_array(substr($sortBy, 0, 9), array('"Relevanc', 'Relevance'))) user_error("Non-relevance sort not supported.", E_USER_ERROR); + if (!$this->fullTextEnabled()) { + return $results; + } + if (!in_array(substr($sortBy, 0, 9), array('"Relevanc', 'Relevance'))) { + user_error("Non-relevance sort not supported.", E_USER_ERROR); + } - $allClassesToSearch = array(); - foreach ($classesToSearch as $class) { - $allClassesToSearch = array_merge($allClassesToSearch, array_values(ClassInfo::dataClassesFor($class))); - } - $allClassesToSearch = array_unique($allClassesToSearch); + $allClassesToSearch = array(); + foreach ($classesToSearch as $class) { + $allClassesToSearch = array_merge($allClassesToSearch, array_values(ClassInfo::dataClassesFor($class))); + } + $allClassesToSearch = array_unique($allClassesToSearch); - //Get a list of all the tables and columns we'll be searching on: - $fulltextColumns = $this->query('EXEC sp_help_fulltext_columns'); - $queries = array(); + //Get a list of all the tables and columns we'll be searching on: + $fulltextColumns = $this->query('EXEC sp_help_fulltext_columns'); + $queries = array(); - // Sort the columns back into tables. - $tables = array(); - foreach($fulltextColumns as $column) { - // Skip extension tables. - if(substr($column['TABLE_NAME'], -5) == '_Live' || substr($column['TABLE_NAME'], -9) == '_versions') continue; + // Sort the columns back into tables. + $tables = array(); + foreach ($fulltextColumns as $column) { + // Skip extension tables. + if (substr($column['TABLE_NAME'], -5) == '_Live' || substr($column['TABLE_NAME'], -9) == '_versions') { + continue; + } - // Add the column to table. - $table = &$tables[$column['TABLE_NAME']]; - if (!$table) { - $table = array($column['FULLTEXT_COLUMN_NAME']); - } else { - array_push($table, $column['FULLTEXT_COLUMN_NAME']); - } - } + // Add the column to table. + $table = &$tables[$column['TABLE_NAME']]; + if (!$table) { + $table = array($column['FULLTEXT_COLUMN_NAME']); + } else { + array_push($table, $column['FULLTEXT_COLUMN_NAME']); + } + } - // Create one query per each table, $columns not used. We want just the ID and the ClassName of the object from this query. - foreach($tables as $tableName => $columns){ - $baseClass = ClassInfo::baseDataClass($tableName); + // Create one query per each table, $columns not used. We want just the ID and the ClassName of the object from this query. + foreach ($tables as $tableName => $columns) { + $baseClass = ClassInfo::baseDataClass($tableName); - $join = $this->fullTextSearchMSSQL($tableName, $keywords); - if (!$join) return $results; // avoid "Null or empty full-text predicate" + $join = $this->fullTextSearchMSSQL($tableName, $keywords); + if (!$join) { + return $results; + } // avoid "Null or empty full-text predicate" - // Check if we need to add ShowInSearch - $where = null; - if(strpos($tableName, 'SiteTree') === 0) { - $where = array("\"$tableName\".\"ShowInSearch\"!=0"); - } elseif(strpos($tableName, 'File') === 0) { - // File.ShowInSearch was added later, keep the database driver backwards compatible - // by checking for its existence first - $fields = $this->fieldList($tableName); - if(array_key_exists('ShowInSearch', $fields)) { - $where = array("\"$tableName\".\"ShowInSearch\"!=0"); - } - } + // Check if we need to add ShowInSearch + $where = null; + if (strpos($tableName, 'SiteTree') === 0) { + $where = array("\"$tableName\".\"ShowInSearch\"!=0"); + } elseif (strpos($tableName, 'File') === 0) { + // File.ShowInSearch was added later, keep the database driver backwards compatible + // by checking for its existence first + $fields = $this->fieldList($tableName); + if (array_key_exists('ShowInSearch', $fields)) { + $where = array("\"$tableName\".\"ShowInSearch\"!=0"); + } + } - $queries[$tableName] = DataList::create($tableName)->where($where, '')->dataQuery()->query(); - $queries[$tableName]->setOrderBy(array()); - - // Join with CONTAINSTABLE, a full text searcher that includes relevance factor - $queries[$tableName]->setFrom(array("\"$tableName\" INNER JOIN $join AS \"ft\" ON \"$tableName\".\"ID\"=\"ft\".\"KEY\"")); - // Join with the base class if needed, as we want to test agains the ClassName - if ($tableName != $baseClass) { - $queries[$tableName]->setFrom("INNER JOIN \"$baseClass\" ON \"$baseClass\".\"ID\"=\"$tableName\".\"ID\""); - } + $queries[$tableName] = DataList::create($tableName)->where($where, '')->dataQuery()->query(); + $queries[$tableName]->setOrderBy(array()); + + // Join with CONTAINSTABLE, a full text searcher that includes relevance factor + $queries[$tableName]->setFrom(array("\"$tableName\" INNER JOIN $join AS \"ft\" ON \"$tableName\".\"ID\"=\"ft\".\"KEY\"")); + // Join with the base class if needed, as we want to test agains the ClassName + if ($tableName != $baseClass) { + $queries[$tableName]->setFrom("INNER JOIN \"$baseClass\" ON \"$baseClass\".\"ID\"=\"$tableName\".\"ID\""); + } - $queries[$tableName]->setSelect(array("\"$tableName\".\"ID\"")); - $queries[$tableName]->selectField("'$tableName'", 'Source'); - $queries[$tableName]->selectField('Rank', 'Relevance'); - if ($extraFilter) { - $queries[$tableName]->addWhere($extraFilter); - } - if (count($allClassesToSearch)) { - $classesPlaceholder = DB::placeholders($allClassesToSearch); - $queries[$tableName]->addWhere(array( - "\"$baseClass\".\"ClassName\" IN ($classesPlaceholder)" => - $allClassesToSearch - )); - } - // Reset the parameters that would get in the way - } + $queries[$tableName]->setSelect(array("\"$tableName\".\"ID\"")); + $queries[$tableName]->selectField("'$tableName'", 'Source'); + $queries[$tableName]->selectField('Rank', 'Relevance'); + if ($extraFilter) { + $queries[$tableName]->addWhere($extraFilter); + } + if (count($allClassesToSearch)) { + $classesPlaceholder = DB::placeholders($allClassesToSearch); + $queries[$tableName]->addWhere(array( + "\"$baseClass\".\"ClassName\" IN ($classesPlaceholder)" => + $allClassesToSearch + )); + } + // Reset the parameters that would get in the way + } - // Generate SQL - $querySQLs = array(); - $queryParameters = array(); - foreach($queries as $query) { - $querySQLs[] = $query->sql($parameters); - $queryParameters = array_merge($queryParameters, $parameters); - } + // Generate SQL + $querySQLs = array(); + $queryParameters = array(); + foreach ($queries as $query) { + $querySQLs[] = $query->sql($parameters); + $queryParameters = array_merge($queryParameters, $parameters); + } - // Unite the SQL - $fullQuery = implode(" UNION ", $querySQLs) . " ORDER BY $sortBy"; + // Unite the SQL + $fullQuery = implode(" UNION ", $querySQLs) . " ORDER BY $sortBy"; - // Perform the search - $result = $this->preparedQuery($fullQuery, $queryParameters); + // Perform the search + $result = $this->preparedQuery($fullQuery, $queryParameters); - // Regenerate DataObjectSet - watch out, numRecords doesn't work on sqlsrv driver on Windows. - $current = -1; - $objects = array(); - foreach ($result as $row) { - $current++; + // Regenerate DataObjectSet - watch out, numRecords doesn't work on sqlsrv driver on Windows. + $current = -1; + $objects = array(); + foreach ($result as $row) { + $current++; - // Select a subset for paging - if ($current >= $start && $current < $start + $pageLength) { - $objects[] = DataObject::get_by_id($row['Source'], $row['ID']); - } - } + // Select a subset for paging + if ($current >= $start && $current < $start + $pageLength) { + $objects[] = DataObject::get_by_id($row['Source'], $row['ID']); + } + } - if(isset($objects)) $results = new ArrayList($objects); - else $results = new ArrayList(); - $list = new PaginatedList($results); - $list->setPageStart($start); - $list->setPageLength($pageLength); - $list->setTotalItems($current+1); - return $list; - } + if (isset($objects)) { + $results = new ArrayList($objects); + } else { + $results = new ArrayList(); + } + $list = new PaginatedList($results); + $list->setPageStart($start); + $list->setPageLength($pageLength); + $list->setTotalItems($current+1); + return $list; + } - /** - * Allow auto-increment primary key editing on the given table. - * Some databases need to enable this specially. - * - * @param $table The name of the table to have PK editing allowed on - * @param $allow True to start, false to finish - */ - function allowPrimaryKeyEditing($table, $allow = true) { - $this->query("SET IDENTITY_INSERT \"$table\" " . ($allow ? "ON" : "OFF")); - } + /** + * Allow auto-increment primary key editing on the given table. + * Some databases need to enable this specially. + * + * @param $table The name of the table to have PK editing allowed on + * @param $allow True to start, false to finish + */ + public function allowPrimaryKeyEditing($table, $allow = true) + { + $this->query("SET IDENTITY_INSERT \"$table\" " . ($allow ? "ON" : "OFF")); + } - /** - * Returns a SQL fragment for querying a fulltext search index - * - * @param $tableName specific - table name - * @param $keywords string The search query - * @param $fields array The list of field names to search on, or null to include all - * - * @returns null if keyword set is empty or the string with JOIN clause to be added to SQL query - */ - public function fullTextSearchMSSQL($tableName, $keywords, $fields = null) { - // Make sure we are getting an array of fields - if (isset($fields) && !is_array($fields)) $fields = array($fields); + /** + * Returns a SQL fragment for querying a fulltext search index + * + * @param $tableName specific - table name + * @param $keywords string The search query + * @param $fields array The list of field names to search on, or null to include all + * + * @returns null if keyword set is empty or the string with JOIN clause to be added to SQL query + */ + public function fullTextSearchMSSQL($tableName, $keywords, $fields = null) + { + // Make sure we are getting an array of fields + if (isset($fields) && !is_array($fields)) { + $fields = array($fields); + } - // Strip unfriendly characters, SQLServer "CONTAINS" predicate will crash on & and | and ignore others anyway. - if (function_exists('mb_ereg_replace')) { - $keywords = mb_ereg_replace('[^\w\s]', '', trim($keywords)); - } else { - $keywords = $this->escapeString(str_replace(array('&','|','!','"','\''), '', trim($keywords))); - } + // Strip unfriendly characters, SQLServer "CONTAINS" predicate will crash on & and | and ignore others anyway. + if (function_exists('mb_ereg_replace')) { + $keywords = mb_ereg_replace('[^\w\s]', '', trim($keywords)); + } else { + $keywords = $this->escapeString(str_replace(array('&', '|', '!', '"', '\''), '', trim($keywords))); + } - // Remove stopwords, concat with ANDs - $keywordList = explode(' ', $keywords); - $keywordList = $this->removeStopwords($keywordList); - - // remove any empty values from the array - $keywordList = array_filter($keywordList); - if(empty($keywordList)) return null; + // Remove stopwords, concat with ANDs + $keywordList = explode(' ', $keywords); + $keywordList = $this->removeStopwords($keywordList); + + // remove any empty values from the array + $keywordList = array_filter($keywordList); + if (empty($keywordList)) { + return null; + } - $keywords = implode(' AND ', $keywordList); - if ($fields) $fieldNames = '"' . implode('", "', $fields) . '"'; - else $fieldNames = "*"; + $keywords = implode(' AND ', $keywordList); + if ($fields) { + $fieldNames = '"' . implode('", "', $fields) . '"'; + } else { + $fieldNames = "*"; + } - return "CONTAINSTABLE(\"$tableName\", ($fieldNames), '$keywords')"; - } + return "CONTAINSTABLE(\"$tableName\", ($fieldNames), '$keywords')"; + } - /** - * Remove stopwords that would kill a MSSQL full-text query - * - * @param array $keywords - * - * @return array $keywords with stopwords removed - */ - public function removeStopwords($keywords) { - $goodKeywords = array(); - foreach($keywords as $keyword) { - if (in_array($keyword, self::$noiseWords)) continue; - $goodKeywords[] = trim($keyword); - } - return $goodKeywords; - } + /** + * Remove stopwords that would kill a MSSQL full-text query + * + * @param array $keywords + * + * @return array $keywords with stopwords removed + */ + public function removeStopwords($keywords) + { + $goodKeywords = array(); + foreach ($keywords as $keyword) { + if (in_array($keyword, self::$noiseWords)) { + continue; + } + $goodKeywords[] = trim($keyword); + } + return $goodKeywords; + } - /** - * Does this database support transactions? - */ - public function supportsTransactions(){ - return $this->supportsTransactions; - } + /** + * Does this database support transactions? + */ + public function supportsTransactions() + { + return $this->supportsTransactions; + } - /** - * This is a quick lookup to discover if the database supports particular extensions - * Currently, MSSQL supports no extensions - * - * @param array $extensions List of extensions to check for support of. The key of this array - * will be an extension name, and the value the configuration for that extension. This - * could be one of partitions, tablespaces, or clustering - * @return boolean Flag indicating support for all of the above - */ - public function supportsExtensions($extensions = array('partitions', 'tablespaces', 'clustering')){ - if(isset($extensions['partitions'])) - return false; - elseif(isset($extensions['tablespaces'])) - return false; - elseif(isset($extensions['clustering'])) - return false; - else - return false; - } - - /** - * Start transaction. READ ONLY not supported. - */ - public function transactionStart($transactionMode = false, $sessionCharacteristics = false){ - if($this->connector instanceof SQLServerConnector) { - $this->connector->transactionStart(); - } else { - $this->query('BEGIN TRANSACTION'); - } - } + /** + * This is a quick lookup to discover if the database supports particular extensions + * Currently, MSSQL supports no extensions + * + * @param array $extensions List of extensions to check for support of. The key of this array + * will be an extension name, and the value the configuration for that extension. This + * could be one of partitions, tablespaces, or clustering + * @return boolean Flag indicating support for all of the above + */ + public function supportsExtensions($extensions = array('partitions', 'tablespaces', 'clustering')) + { + if (isset($extensions['partitions'])) { + return false; + } elseif (isset($extensions['tablespaces'])) { + return false; + } elseif (isset($extensions['clustering'])) { + return false; + } else { + return false; + } + } + + /** + * Start transaction. READ ONLY not supported. + */ + public function transactionStart($transactionMode = false, $sessionCharacteristics = false) + { + if ($this->connector instanceof SQLServerConnector) { + $this->connector->transactionStart(); + } else { + $this->query('BEGIN TRANSACTION'); + } + } - public function transactionSavepoint($savepoint){ - $this->query("SAVE TRANSACTION \"$savepoint\""); - } + public function transactionSavepoint($savepoint) + { + $this->query("SAVE TRANSACTION \"$savepoint\""); + } - public function transactionRollback($savepoint = false) { - if($savepoint) { - $this->query("ROLLBACK TRANSACTION \"$savepoint\""); - } elseif($this->connector instanceof SQLServerConnector) { - $this->connector->transactionRollback(); - } else { - $this->query('ROLLBACK TRANSACTION'); - } - } - - public function transactionEnd($chain = false) { - if($this->connector instanceof SQLServerConnector) { - $this->connector->transactionEnd(); - } else { - $this->query('COMMIT TRANSACTION'); - } - } - - public function comparisonClause($field, $value, $exact = false, $negate = false, $caseSensitive = null, $parameterised = false) { - if($exact) { - $comp = ($negate) ? '!=' : '='; - } else { - $comp = 'LIKE'; - if($negate) $comp = 'NOT ' . $comp; - } - - // Field definitions are case insensitive by default, - // change used collation for case sensitive searches. - $collateClause = ''; - if($caseSensitive === true) { - if(self::get_collation()) { - $collation = preg_replace('/_CI_/', '_CS_', self::get_collation()); - } else { - $collation = 'Latin1_General_CS_AS'; - } - $collateClause = ' COLLATE ' . $collation; - } elseif($caseSensitive === false) { - if(self::get_collation()) { - $collation = preg_replace('/_CS_/', '_CI_', self::get_collation()); - } else { - $collation = 'Latin1_General_CI_AS'; - } - $collateClause = ' COLLATE ' . $collation; - } + public function transactionRollback($savepoint = false) + { + if ($savepoint) { + $this->query("ROLLBACK TRANSACTION \"$savepoint\""); + } elseif ($this->connector instanceof SQLServerConnector) { + $this->connector->transactionRollback(); + } else { + $this->query('ROLLBACK TRANSACTION'); + } + } + + public function transactionEnd($chain = false) + { + if ($this->connector instanceof SQLServerConnector) { + $this->connector->transactionEnd(); + } else { + $this->query('COMMIT TRANSACTION'); + } + } + + public function comparisonClause($field, $value, $exact = false, $negate = false, $caseSensitive = null, $parameterised = false) + { + if ($exact) { + $comp = ($negate) ? '!=' : '='; + } else { + $comp = 'LIKE'; + if ($negate) { + $comp = 'NOT ' . $comp; + } + } + + // Field definitions are case insensitive by default, + // change used collation for case sensitive searches. + $collateClause = ''; + if ($caseSensitive === true) { + if (self::get_collation()) { + $collation = preg_replace('/_CI_/', '_CS_', self::get_collation()); + } else { + $collation = 'Latin1_General_CS_AS'; + } + $collateClause = ' COLLATE ' . $collation; + } elseif ($caseSensitive === false) { + if (self::get_collation()) { + $collation = preg_replace('/_CS_/', '_CI_', self::get_collation()); + } else { + $collation = 'Latin1_General_CI_AS'; + } + $collateClause = ' COLLATE ' . $collation; + } - $clause = sprintf("%s %s %s", $field, $comp, $parameterised ? '?' : "'$value'"); - if($collateClause) $clause .= $collateClause; + $clause = sprintf("%s %s %s", $field, $comp, $parameterised ? '?' : "'$value'"); + if ($collateClause) { + $clause .= $collateClause; + } - return $clause; - } + return $clause; + } - /** - * Function to return an SQL datetime expression for MSSQL - * used for querying a datetime in a certain format - * - * @param string $date to be formated, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' - * @param string $format to be used, supported specifiers: - * %Y = Year (four digits) - * %m = Month (01..12) - * %d = Day (01..31) - * %H = Hour (00..23) - * %i = Minutes (00..59) - * %s = Seconds (00..59) - * %U = unix timestamp, can only be used on it's own - * @return string SQL datetime expression to query for a formatted datetime - */ - function formattedDatetimeClause($date, $format) { - preg_match_all('/%(.)/', $format, $matches); - foreach($matches[1] as $match) if(array_search($match, array('Y','m','d','H','i','s','U')) === false) user_error('formattedDatetimeClause(): unsupported format character %' . $match, E_USER_WARNING); + /** + * Function to return an SQL datetime expression for MSSQL + * used for querying a datetime in a certain format + * + * @param string $date to be formated, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' + * @param string $format to be used, supported specifiers: + * %Y = Year (four digits) + * %m = Month (01..12) + * %d = Day (01..31) + * %H = Hour (00..23) + * %i = Minutes (00..59) + * %s = Seconds (00..59) + * %U = unix timestamp, can only be used on it's own + * @return string SQL datetime expression to query for a formatted datetime + */ + public function formattedDatetimeClause($date, $format) + { + preg_match_all('/%(.)/', $format, $matches); + foreach ($matches[1] as $match) { + if (array_search($match, array('Y', 'm', 'd', 'H', 'i', 's', 'U')) === false) { + user_error('formattedDatetimeClause(): unsupported format character %' . $match, E_USER_WARNING); + } + } - if(preg_match('/^now$/i', $date)) { - $date = "CURRENT_TIMESTAMP"; - } else if(preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date)) { - $date = "'$date.000'"; - } + if (preg_match('/^now$/i', $date)) { + $date = "CURRENT_TIMESTAMP"; + } elseif (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date)) { + $date = "'$date.000'"; + } - if($format == '%U') { - return "DATEDIFF(s, '1970-01-01 00:00:00', DATEADD(hour, DATEDIFF(hour, GETDATE(), GETUTCDATE()), $date))"; - } + if ($format == '%U') { + return "DATEDIFF(s, '1970-01-01 00:00:00', DATEADD(hour, DATEDIFF(hour, GETDATE(), GETUTCDATE()), $date))"; + } - $trans = array( - 'Y' => 'yy', - 'm' => 'mm', - 'd' => 'dd', - 'H' => 'hh', - 'i' => 'mi', - 's' => 'ss', - ); + $trans = array( + 'Y' => 'yy', + 'm' => 'mm', + 'd' => 'dd', + 'H' => 'hh', + 'i' => 'mi', + 's' => 'ss', + ); - $strings = array(); - $buffer = $format; - while(strlen($buffer)) { - if(substr($buffer,0,1) == '%') { - $f = substr($buffer,1,1); - $flen = $f == 'Y' ? 4 : 2; - $strings[] = "RIGHT('0' + CAST(DATEPART({$trans[$f]},$date) AS VARCHAR), $flen)"; - $buffer = substr($buffer, 2); - } else { - $pos = strpos($buffer, '%'); - if($pos === false) { - $strings[] = $buffer; - $buffer = ''; - } else { - $strings[] = "'".substr($buffer, 0, $pos)."'"; - $buffer = substr($buffer, $pos); - } - } - } + $strings = array(); + $buffer = $format; + while (strlen($buffer)) { + if (substr($buffer, 0, 1) == '%') { + $f = substr($buffer, 1, 1); + $flen = $f == 'Y' ? 4 : 2; + $strings[] = "RIGHT('0' + CAST(DATEPART({$trans[$f]},$date) AS VARCHAR), $flen)"; + $buffer = substr($buffer, 2); + } else { + $pos = strpos($buffer, '%'); + if ($pos === false) { + $strings[] = $buffer; + $buffer = ''; + } else { + $strings[] = "'".substr($buffer, 0, $pos)."'"; + $buffer = substr($buffer, $pos); + } + } + } - return '(' . implode(' + ', $strings) . ')'; + return '(' . implode(' + ', $strings) . ')'; + } - } + /** + * Function to return an SQL datetime expression for MSSQL. + * used for querying a datetime addition + * + * @param string $date, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' + * @param string $interval to be added, use the format [sign][integer] [qualifier], e.g. -1 Day, +15 minutes, +1 YEAR + * supported qualifiers: + * - years + * - months + * - days + * - hours + * - minutes + * - seconds + * This includes the singular forms as well + * @return string SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of the addition + */ + public function datetimeIntervalClause($date, $interval) + { + $trans = array( + 'year' => 'yy', + 'month' => 'mm', + 'day' => 'dd', + 'hour' => 'hh', + 'minute' => 'mi', + 'second' => 'ss', + ); - /** - * Function to return an SQL datetime expression for MSSQL. - * used for querying a datetime addition - * - * @param string $date, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' - * @param string $interval to be added, use the format [sign][integer] [qualifier], e.g. -1 Day, +15 minutes, +1 YEAR - * supported qualifiers: - * - years - * - months - * - days - * - hours - * - minutes - * - seconds - * This includes the singular forms as well - * @return string SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of the addition - */ - function datetimeIntervalClause($date, $interval) { - $trans = array( - 'year' => 'yy', - 'month' => 'mm', - 'day' => 'dd', - 'hour' => 'hh', - 'minute' => 'mi', - 'second' => 'ss', - ); + $singularinterval = preg_replace('/(year|month|day|hour|minute|second)s/i', '$1', $interval); - $singularinterval = preg_replace('/(year|month|day|hour|minute|second)s/i', '$1', $interval); + if ( + !($params = preg_match('/([-+]\d+) (\w+)/i', $singularinterval, $matches)) || + !isset($trans[strtolower($matches[2])]) + ) { + user_error('datetimeIntervalClause(): invalid interval ' . $interval, E_USER_WARNING); + } - if( - !($params = preg_match('/([-+]\d+) (\w+)/i', $singularinterval, $matches)) || - !isset($trans[strtolower($matches[2])]) - ) user_error('datetimeIntervalClause(): invalid interval ' . $interval, E_USER_WARNING); + if (preg_match('/^now$/i', $date)) { + $date = "CURRENT_TIMESTAMP"; + } elseif (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date)) { + $date = "'$date'"; + } - if(preg_match('/^now$/i', $date)) { - $date = "CURRENT_TIMESTAMP"; - } else if(preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date)) { - $date = "'$date'"; - } + return "CONVERT(VARCHAR, DATEADD(" . $trans[strtolower($matches[2])] . ", " . (int)$matches[1] . ", $date), 120)"; + } - return "CONVERT(VARCHAR, DATEADD(" . $trans[strtolower($matches[2])] . ", " . (int)$matches[1] . ", $date), 120)"; - } + /** + * Function to return an SQL datetime expression for MSSQL. + * used for querying a datetime substraction + * + * @param string $date1, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' + * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' + * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which is the result of the substraction + */ + public function datetimeDifferenceClause($date1, $date2) + { + if (preg_match('/^now$/i', $date1)) { + $date1 = "CURRENT_TIMESTAMP"; + } elseif (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date1)) { + $date1 = "'$date1'"; + } - /** - * Function to return an SQL datetime expression for MSSQL. - * used for querying a datetime substraction - * - * @param string $date1, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' - * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' - * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which is the result of the substraction - */ - function datetimeDifferenceClause($date1, $date2) { + if (preg_match('/^now$/i', $date2)) { + $date2 = "CURRENT_TIMESTAMP"; + } elseif (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date2)) { + $date2 = "'$date2'"; + } - if(preg_match('/^now$/i', $date1)) { - $date1 = "CURRENT_TIMESTAMP"; - } else if(preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date1)) { - $date1 = "'$date1'"; - } - - if(preg_match('/^now$/i', $date2)) { - $date2 = "CURRENT_TIMESTAMP"; - } else if(preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/i', $date2)) { - $date2 = "'$date2'"; - } - - return "DATEDIFF(s, $date2, $date1)"; - } + return "DATEDIFF(s, $date2, $date1)"; + } } diff --git a/code/MSSQLDatabaseConfigurationHelper.php b/code/MSSQLDatabaseConfigurationHelper.php index ec5f0fb..e949df3 100644 --- a/code/MSSQLDatabaseConfigurationHelper.php +++ b/code/MSSQLDatabaseConfigurationHelper.php @@ -8,211 +8,229 @@ * * @package mssql */ -class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper { - - protected function isAzure($databaseConfig) { - return $databaseConfig['type'] === 'MSSQLAzureDatabase'; - } - - /** - * Create a connection of the appropriate type - * - * @param array $databaseConfig - * @param string $error Error message passed by value - * @return mixed|null Either the connection object, or null if error - */ - protected function createConnection($databaseConfig, &$error) { - $error = null; - try { - switch($databaseConfig['type']) { - case 'MSSQLDatabase': - case 'MSSQLAzureDatabase': - $parameters = array( - 'UID' => $databaseConfig['username'], - 'PWD' => $databaseConfig['password'] - ); - - // Azure has additional parameter requirements - if($this->isAzure($databaseConfig)) { - $parameters['database'] = $databaseConfig['database']; - $parameters['multipleactiveresultsets'] = 0; - } - $conn = @sqlsrv_connect($databaseConfig['server'], $parameters); - if($conn) return $conn; - - // Get error - if($errors = sqlsrv_errors()) { - $error = ''; - foreach($errors as $detail) { - $error .= "{$detail['message']}\n"; - } - } else { - $error = 'Unknown connection error'; - } - return null; - case 'MSSQLPDODatabase': - // May throw a PDOException if fails - $conn = @new PDO('sqlsrv:Server='.$databaseConfig['server'], $databaseConfig['username'], $databaseConfig['password']); - if($conn) { - return $conn; - } else { - $error = 'Unknown connection error'; - return null; - } - default: - $error = 'Invalid connection type'; - return null; - } - } catch(Exception $ex) { - $error = $ex->getMessage(); - return null; - } - } - - /** - * Helper function to quote a string value - * - * @param mixed $conn Connection object/resource - * @param string $value Value to quote - * @return string Quoted strieng - */ - protected function quote($conn, $value) { - if($conn instanceof PDO) { - return $conn->quote($value); - } elseif(is_resource($conn)) { - $value = str_replace("'", "''", $value); - $value = str_replace("\0", "[NULL]", $value); - return "N'$value'"; - } else { - user_error('Invalid database connection', E_USER_ERROR); - } - } - - /** - * Helper function to execute a query - * - * @param mixed $conn Connection object/resource - * @param string $sql SQL string to execute - * @return array List of first value from each resulting row - */ - protected function query($conn, $sql) { - $items = array(); - if($conn instanceof PDO) { - $result = $conn->query($sql); - if($result) foreach($result as $row) { - $items[] = $row[0]; - } - } elseif(is_resource($conn)) { - $result = sqlsrv_query($conn, $sql); - if($result) while ($row = sqlsrv_fetch_array($result, SQLSRV_FETCH_NUMERIC)) { - $items[] = $row[0]; - } - } - return $items; - } +class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper +{ + + protected function isAzure($databaseConfig) + { + return $databaseConfig['type'] === 'MSSQLAzureDatabase'; + } + + /** + * Create a connection of the appropriate type + * + * @param array $databaseConfig + * @param string $error Error message passed by value + * @return mixed|null Either the connection object, or null if error + */ + protected function createConnection($databaseConfig, &$error) + { + $error = null; + try { + switch ($databaseConfig['type']) { + case 'MSSQLDatabase': + case 'MSSQLAzureDatabase': + $parameters = array( + 'UID' => $databaseConfig['username'], + 'PWD' => $databaseConfig['password'] + ); + + // Azure has additional parameter requirements + if ($this->isAzure($databaseConfig)) { + $parameters['database'] = $databaseConfig['database']; + $parameters['multipleactiveresultsets'] = 0; + } + $conn = @sqlsrv_connect($databaseConfig['server'], $parameters); + if ($conn) { + return $conn; + } + + // Get error + if ($errors = sqlsrv_errors()) { + $error = ''; + foreach ($errors as $detail) { + $error .= "{$detail['message']}\n"; + } + } else { + $error = 'Unknown connection error'; + } + return null; + case 'MSSQLPDODatabase': + // May throw a PDOException if fails + $conn = @new PDO('sqlsrv:Server='.$databaseConfig['server'], $databaseConfig['username'], $databaseConfig['password']); + if ($conn) { + return $conn; + } else { + $error = 'Unknown connection error'; + return null; + } + default: + $error = 'Invalid connection type'; + return null; + } + } catch (Exception $ex) { + $error = $ex->getMessage(); + return null; + } + } + + /** + * Helper function to quote a string value + * + * @param mixed $conn Connection object/resource + * @param string $value Value to quote + * @return string Quoted strieng + */ + protected function quote($conn, $value) + { + if ($conn instanceof PDO) { + return $conn->quote($value); + } elseif (is_resource($conn)) { + $value = str_replace("'", "''", $value); + $value = str_replace("\0", "[NULL]", $value); + return "N'$value'"; + } else { + user_error('Invalid database connection', E_USER_ERROR); + } + } + + /** + * Helper function to execute a query + * + * @param mixed $conn Connection object/resource + * @param string $sql SQL string to execute + * @return array List of first value from each resulting row + */ + protected function query($conn, $sql) + { + $items = array(); + if ($conn instanceof PDO) { + $result = $conn->query($sql); + if ($result) { + foreach ($result as $row) { + $items[] = $row[0]; + } + } + } elseif (is_resource($conn)) { + $result = sqlsrv_query($conn, $sql); + if ($result) { + while ($row = sqlsrv_fetch_array($result, SQLSRV_FETCH_NUMERIC)) { + $items[] = $row[0]; + } + } + } + return $items; + } - public function requireDatabaseFunctions($databaseConfig) { - $data = DatabaseAdapterRegistry::get_adapter($databaseConfig['type']); - return !empty($data['supported']); - } + public function requireDatabaseFunctions($databaseConfig) + { + $data = DatabaseAdapterRegistry::get_adapter($databaseConfig['type']); + return !empty($data['supported']); + } - public function requireDatabaseServer($databaseConfig) { - $conn = $this->createConnection($databaseConfig, $error); - $success = !empty($conn); - - return array( - 'success' => $success, - 'error' => $error - ); - } + public function requireDatabaseServer($databaseConfig) + { + $conn = $this->createConnection($databaseConfig, $error); + $success = !empty($conn); + + return array( + 'success' => $success, + 'error' => $error + ); + } - public function requireDatabaseConnection($databaseConfig) { - $conn = $this->createConnection($databaseConfig, $error); - $success = !empty($conn); - - return array( - 'success' => $success, - 'connection' => $conn, - 'error' => $error - ); - } + public function requireDatabaseConnection($databaseConfig) + { + $conn = $this->createConnection($databaseConfig, $error); + $success = !empty($conn); + + return array( + 'success' => $success, + 'connection' => $conn, + 'error' => $error + ); + } - public function getDatabaseVersion($databaseConfig) { - $conn = $this->createConnection($databaseConfig, $error); - $result = $this->query($conn, "SELECT CONVERT(char(15), SERVERPROPERTY('ProductVersion'))"); - return empty($result) ? 0 : reset($result); - } + public function getDatabaseVersion($databaseConfig) + { + $conn = $this->createConnection($databaseConfig, $error); + $result = $this->query($conn, "SELECT CONVERT(char(15), SERVERPROPERTY('ProductVersion'))"); + return empty($result) ? 0 : reset($result); + } - /** - * Ensure that the SQL Server version is at least 10.00.2531 (SQL Server 2008 SP1). - * - * @see http://www.sqlteam.com/article/sql-server-versions - * @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc - * @return array Result - e.g. array('success' => true, 'error' => 'details of error') - */ - public function requireDatabaseVersion($databaseConfig) { - $success = false; - $error = ''; - $version = $this->getDatabaseVersion($databaseConfig); + /** + * Ensure that the SQL Server version is at least 10.00.2531 (SQL Server 2008 SP1). + * + * @see http://www.sqlteam.com/article/sql-server-versions + * @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc + * @return array Result - e.g. array('success' => true, 'error' => 'details of error') + */ + public function requireDatabaseVersion($databaseConfig) + { + $success = false; + $error = ''; + $version = $this->getDatabaseVersion($databaseConfig); - if($version) { - $success = version_compare($version, '10.00.2531', '>='); - if(!$success) { - $error = "Your SQL Server version is $version. It's recommended you use at least 10.00.2531 (SQL Server 2008 SP1)."; - } - } else { - $error = "Your SQL Server version could not be determined."; - } + if ($version) { + $success = version_compare($version, '10.00.2531', '>='); + if (!$success) { + $error = "Your SQL Server version is $version. It's recommended you use at least 10.00.2531 (SQL Server 2008 SP1)."; + } + } else { + $error = "Your SQL Server version could not be determined."; + } - return array( - 'success' => $success, - 'error' => $error - ); - } + return array( + 'success' => $success, + 'error' => $error + ); + } - public function requireDatabaseOrCreatePermissions($databaseConfig) { - $conn = $this->createConnection($databaseConfig, $error); - if(empty($conn)) { - $success = false; - $alreadyExists = false; - } elseif($databaseConfig['type'] == 'MSSQLAzureDatabase') { - // Don't bother with DB selection for azure, as it's not supported - $success = true; - $alreadyExists = true; - } else { - // does this database exist already? - $list = $this->query($conn, 'SELECT NAME FROM sys.sysdatabases'); - if(in_array($databaseConfig['database'], $list)) { - $success = true; - $alreadyExists = true; - } else { - $permissions = $this->query($conn, "select COUNT(*) from sys.fn_my_permissions('','') where permission_name like 'CREATE ANY DATABASE' or permission_name like 'CREATE DATABASE';"); - $success = $permissions[0] > 0; - $alreadyExists = false; - } - } + public function requireDatabaseOrCreatePermissions($databaseConfig) + { + $conn = $this->createConnection($databaseConfig, $error); + if (empty($conn)) { + $success = false; + $alreadyExists = false; + } elseif ($databaseConfig['type'] == 'MSSQLAzureDatabase') { + // Don't bother with DB selection for azure, as it's not supported + $success = true; + $alreadyExists = true; + } else { + // does this database exist already? + $list = $this->query($conn, 'SELECT NAME FROM sys.sysdatabases'); + if (in_array($databaseConfig['database'], $list)) { + $success = true; + $alreadyExists = true; + } else { + $permissions = $this->query($conn, "select COUNT(*) from sys.fn_my_permissions('','') where permission_name like 'CREATE ANY DATABASE' or permission_name like 'CREATE DATABASE';"); + $success = $permissions[0] > 0; + $alreadyExists = false; + } + } - return array( - 'success' => $success, - 'alreadyExists' => $alreadyExists - ); - } + return array( + 'success' => $success, + 'alreadyExists' => $alreadyExists + ); + } - public function requireDatabaseAlterPermissions($databaseConfig) { - $success = false; - $conn = $this->createConnection($databaseConfig, $error); - if(!empty($conn)) { - if(!$this->isAzure($databaseConfig)) { - // Make sure to select the current database when checking permission against this database - $this->query($conn, "USE \"{$databaseConfig['database']}\""); - } - $permissions = $this->query($conn, "select COUNT(*) from sys.fn_my_permissions(NULL,'DATABASE') WHERE permission_name like 'create table';"); - $success = $permissions[0] > 0; - } - - return array( - 'success' => $success, - 'applies' => true - ); - } + public function requireDatabaseAlterPermissions($databaseConfig) + { + $success = false; + $conn = $this->createConnection($databaseConfig, $error); + if (!empty($conn)) { + if (!$this->isAzure($databaseConfig)) { + // Make sure to select the current database when checking permission against this database + $this->query($conn, "USE \"{$databaseConfig['database']}\""); + } + $permissions = $this->query($conn, "select COUNT(*) from sys.fn_my_permissions(NULL,'DATABASE') WHERE permission_name like 'create table';"); + $success = $permissions[0] > 0; + } + + return array( + 'success' => $success, + 'applies' => true + ); + } } diff --git a/code/MSSQLQueryBuilder.php b/code/MSSQLQueryBuilder.php index d42b944..f01efea 100644 --- a/code/MSSQLQueryBuilder.php +++ b/code/MSSQLQueryBuilder.php @@ -5,108 +5,116 @@ * * @package mssql */ -class MSSQLQueryBuilder extends DBQueryBuilder { - - protected function buildSelectQuery(SQLSelect $query, array &$parameters) { - list($limit, $offset) = $this->parseLimit($query); - - // If not using ofset then query generation is quite straightforward - if(empty($offset)) { - $sql = parent::buildSelectQuery($query, $parameters); - // Inject limit into SELECT fragment - if(!empty($limit)) { - $sql = preg_replace('/^(SELECT (DISTINCT)?)/i', '${1} TOP '.$limit, $sql); - } - return $sql; - } - - // When using offset we must use a subselect - // @see http://stackoverflow.com/questions/2135418/equivalent-of-limit-and-offset-for-sql-server - $orderby = $query->getOrderBy(); +class MSSQLQueryBuilder extends DBQueryBuilder +{ + + protected function buildSelectQuery(SQLSelect $query, array &$parameters) + { + list($limit, $offset) = $this->parseLimit($query); + + // If not using ofset then query generation is quite straightforward + if (empty($offset)) { + $sql = parent::buildSelectQuery($query, $parameters); + // Inject limit into SELECT fragment + if (!empty($limit)) { + $sql = preg_replace('/^(SELECT (DISTINCT)?)/i', '${1} TOP '.$limit, $sql); + } + return $sql; + } + + // When using offset we must use a subselect + // @see http://stackoverflow.com/questions/2135418/equivalent-of-limit-and-offset-for-sql-server + $orderby = $query->getOrderBy(); - // workaround for subselect not working with alias functions - // just use the function directly in the order by instead of the alias - $selects = $query->getSelect(); - foreach($orderby as $field => $dir) { - if(preg_match('/_SortColumn/', $field)) { - unset($orderby[$field]); - $orderby[$selects[str_replace('"', '', $field)]] = $dir; - } - } + // workaround for subselect not working with alias functions + // just use the function directly in the order by instead of the alias + $selects = $query->getSelect(); + foreach ($orderby as $field => $dir) { + if (preg_match('/_SortColumn/', $field)) { + unset($orderby[$field]); + $orderby[$selects[str_replace('"', '', $field)]] = $dir; + } + } - // Create order expression, using the first column if none explicitly specified - if($orderby) { - // Simple implementation of buildOrderByFragment - $statements = array(); - foreach ($orderby as $clause => $dir) { - $statements[] = trim("$clause $dir"); - } - $orderByClause = "ORDER BY " . implode(', ', $statements); - } else { - $selects = $query->getSelect(); - $firstCol = reset($selects); - $orderByClause = "ORDER BY $firstCol"; - } - - // Build main query SQL - $sql = parent::buildSelectQuery($query, $parameters); - - // Inject row number into selection - $sql = preg_replace('/^(SELECT (DISTINCT)?)/i', '${1} ROW_NUMBER() OVER ('.$orderByClause.') AS Number, ', $sql); - - // Sub-query this SQL - if(empty($limit)) { - $limitCondition = "Number > ?"; - $parameters[] = $offset; - } else { - $limitCondition = "Number BETWEEN ? AND ?"; - $parameters[] = $offset + 1; - $parameters[] = $offset + $limit; - } - return "SELECT * FROM ($sql) AS Numbered WHERE $limitCondition ORDER BY Number"; - } - - public function buildLimitFragment(SQLSelect $query, array &$parameters) { - // Limit is handled at the buildSelectQuery level - return ''; - } - - public function buildOrderByFragment(SQLSelect $query, array &$parameters) { - // If doing a limit/offset at the same time then don't build the orde by fragment here - list($offset, $limit) = $this->parseLimit($query); - if(empty($offset) || empty($limit)) { - return parent::buildOrderByFragment($query, $parameters); - } - return ''; - } - - /** - * Extracts the limit and offset from the limit clause - * - * @param SQLSelect $query - * @return array Two item array with $limit and $offset as values - * @throws InvalidArgumentException - */ - protected function parseLimit(SQLSelect $query) { - - $limit = ''; - $offset = '0'; - if(is_array($query->getLimit())) { - $limitArr = $query->getLimit(); - if(isset($limitArr['limit'])) $limit = $limitArr['limit']; - if(isset($limitArr['start'])) $offset = $limitArr['start']; - } else if(preg_match('/^([0-9]+) offset ([0-9]+)$/i', trim($query->getLimit()), $matches)) { - $limit = $matches[1]; - $offset = $matches[2]; - } else { - //could be a comma delimited string - $bits = explode(',', $query->getLimit()); - if(sizeof($bits) > 1) { - list($offset, $limit) = $bits; - } else { - $limit = $bits[0]; - } - } - return array($limit, $offset); - } + // Create order expression, using the first column if none explicitly specified + if ($orderby) { + // Simple implementation of buildOrderByFragment + $statements = array(); + foreach ($orderby as $clause => $dir) { + $statements[] = trim("$clause $dir"); + } + $orderByClause = "ORDER BY " . implode(', ', $statements); + } else { + $selects = $query->getSelect(); + $firstCol = reset($selects); + $orderByClause = "ORDER BY $firstCol"; + } + + // Build main query SQL + $sql = parent::buildSelectQuery($query, $parameters); + + // Inject row number into selection + $sql = preg_replace('/^(SELECT (DISTINCT)?)/i', '${1} ROW_NUMBER() OVER ('.$orderByClause.') AS Number, ', $sql); + + // Sub-query this SQL + if (empty($limit)) { + $limitCondition = "Number > ?"; + $parameters[] = $offset; + } else { + $limitCondition = "Number BETWEEN ? AND ?"; + $parameters[] = $offset + 1; + $parameters[] = $offset + $limit; + } + return "SELECT * FROM ($sql) AS Numbered WHERE $limitCondition ORDER BY Number"; + } + + public function buildLimitFragment(SQLSelect $query, array &$parameters) + { + // Limit is handled at the buildSelectQuery level + return ''; + } + + public function buildOrderByFragment(SQLSelect $query, array &$parameters) + { + // If doing a limit/offset at the same time then don't build the orde by fragment here + list($offset, $limit) = $this->parseLimit($query); + if (empty($offset) || empty($limit)) { + return parent::buildOrderByFragment($query, $parameters); + } + return ''; + } + + /** + * Extracts the limit and offset from the limit clause + * + * @param SQLSelect $query + * @return array Two item array with $limit and $offset as values + * @throws InvalidArgumentException + */ + protected function parseLimit(SQLSelect $query) + { + $limit = ''; + $offset = '0'; + if (is_array($query->getLimit())) { + $limitArr = $query->getLimit(); + if (isset($limitArr['limit'])) { + $limit = $limitArr['limit']; + } + if (isset($limitArr['start'])) { + $offset = $limitArr['start']; + } + } elseif (preg_match('/^([0-9]+) offset ([0-9]+)$/i', trim($query->getLimit()), $matches)) { + $limit = $matches[1]; + $offset = $matches[2]; + } else { + //could be a comma delimited string + $bits = explode(',', $query->getLimit()); + if (sizeof($bits) > 1) { + list($offset, $limit) = $bits; + } else { + $limit = $bits[0]; + } + } + return array($limit, $offset); + } } diff --git a/code/MSSQLSchemaManager.php b/code/MSSQLSchemaManager.php index 6d066a1..da1b13f 100644 --- a/code/MSSQLSchemaManager.php +++ b/code/MSSQLSchemaManager.php @@ -5,129 +5,143 @@ * * @package mssql */ -class MSSQLSchemaManager extends DBSchemaManager { +class MSSQLSchemaManager extends DBSchemaManager +{ - /** - * Stores per-request cached constraint checks that come from the database. - * - * @var array - */ - protected static $cached_checks = array(); - - /** - * Builds the internal MS SQL Server index name given the silverstripe table and index name - * - * @param string $tableName - * @param string $indexName - * @param string $prefix The optional prefix for the index. Defaults to "ix" for indexes. - * @return string The name of the index - */ - function buildMSSQLIndexName($tableName, $indexName, $prefix = 'ix') { + /** + * Stores per-request cached constraint checks that come from the database. + * + * @var array + */ + protected static $cached_checks = array(); + + /** + * Builds the internal MS SQL Server index name given the silverstripe table and index name + * + * @param string $tableName + * @param string $indexName + * @param string $prefix The optional prefix for the index. Defaults to "ix" for indexes. + * @return string The name of the index + */ + public function buildMSSQLIndexName($tableName, $indexName, $prefix = 'ix') + { - // Cleanup names of namespaced tables - $tableName = str_replace('\\', '_', $tableName); - $indexName = str_replace('\\', '_', $indexName); + // Cleanup names of namespaced tables + $tableName = str_replace('\\', '_', $tableName); + $indexName = str_replace('\\', '_', $indexName); - return "{$prefix}_{$tableName}_{$indexName}"; - } + return "{$prefix}_{$tableName}_{$indexName}"; + } - /** - * This will set up the full text search capabilities. - * - * @param string $name Name of full text catalog to use - */ - function createFullTextCatalog($name = 'ftCatalog') { - $result = $this->fullTextCatalogExists(); - if(!$result) $this->query("CREATE FULLTEXT CATALOG \"$name\" AS DEFAULT;"); - } + /** + * This will set up the full text search capabilities. + * + * @param string $name Name of full text catalog to use + */ + public function createFullTextCatalog($name = 'ftCatalog') + { + $result = $this->fullTextCatalogExists(); + if (!$result) { + $this->query("CREATE FULLTEXT CATALOG \"$name\" AS DEFAULT;"); + } + } - /** - * Check that a fulltext catalog has been created yet. - * - * @param string $name Name of full text catalog to use - * @return boolean - */ - public function fullTextCatalogExists($name = 'ftCatalog') { - return (bool) $this->preparedQuery( - "SELECT name FROM sys.fulltext_catalogs WHERE name = ?;", - array($name) - )->value(); - } + /** + * Check that a fulltext catalog has been created yet. + * + * @param string $name Name of full text catalog to use + * @return boolean + */ + public function fullTextCatalogExists($name = 'ftCatalog') + { + return (bool) $this->preparedQuery( + "SELECT name FROM sys.fulltext_catalogs WHERE name = ?;", + array($name) + )->value(); + } - /** - * Sleep until the catalog has been fully rebuilt. This is a busy wait designed for situations - * when you need to be sure the index is up to date - for example in unit tests. - * - * TODO: move this to Database class? Can we assume this will be useful for all databases? - * Also see the wrapper functions "waitUntilIndexingFinished" in SearchFormTest and TranslatableSearchFormTest - * - * @param int $maxWaitingTime Time in seconds to wait for the database. - */ - function waitUntilIndexingFinished($maxWaitingTime = 15) { - if(!$this->database->fullTextEnabled()) return; - - $this->query("EXEC sp_fulltext_catalog 'ftCatalog', 'Rebuild';"); + /** + * Sleep until the catalog has been fully rebuilt. This is a busy wait designed for situations + * when you need to be sure the index is up to date - for example in unit tests. + * + * TODO: move this to Database class? Can we assume this will be useful for all databases? + * Also see the wrapper functions "waitUntilIndexingFinished" in SearchFormTest and TranslatableSearchFormTest + * + * @param int $maxWaitingTime Time in seconds to wait for the database. + */ + public function waitUntilIndexingFinished($maxWaitingTime = 15) + { + if (!$this->database->fullTextEnabled()) { + return; + } + + $this->query("EXEC sp_fulltext_catalog 'ftCatalog', 'Rebuild';"); - // Busy wait until it's done updating, but no longer than 15 seconds. - $start = time(); - while(time() - $start < $maxWaitingTime) { - $status = $this->query("EXEC sp_help_fulltext_catalogs 'ftCatalog';")->first(); + // Busy wait until it's done updating, but no longer than 15 seconds. + $start = time(); + while (time() - $start < $maxWaitingTime) { + $status = $this->query("EXEC sp_help_fulltext_catalogs 'ftCatalog';")->first(); - if (isset($status['STATUS']) && $status['STATUS'] == 0) { - // Idle! - break; - } - sleep(1); - } - } + if (isset($status['STATUS']) && $status['STATUS'] == 0) { + // Idle! + break; + } + sleep(1); + } + } - /** - * Check if a fulltext index exists on a particular table name. - * - * @param string $tableName - * @return boolean TRUE index exists | FALSE index does not exist | NULL no support - */ - function fulltextIndexExists($tableName) { - // Special case for no full text index support - if(!$this->database->fullTextEnabled()) return null; + /** + * Check if a fulltext index exists on a particular table name. + * + * @param string $tableName + * @return boolean TRUE index exists | FALSE index does not exist | NULL no support + */ + public function fulltextIndexExists($tableName) + { + // Special case for no full text index support + if (!$this->database->fullTextEnabled()) { + return null; + } - return (bool) $this->preparedQuery(" + return (bool) $this->preparedQuery(" SELECT 1 FROM sys.fulltext_indexes i JOIN sys.objects o ON i.object_id = o.object_id WHERE o.name = ?", - array($tableName) - )->value(); - } + array($tableName) + )->value(); + } - /** - * MSSQL stores the primary key column with an internal identifier, - * so a lookup needs to be done to determine it. - * - * @param string $tableName Name of table with primary key column "ID" - * @return string Internal identifier for primary key - */ - function getPrimaryKey($tableName){ - $indexes = $this->query("EXEC sp_helpindex '$tableName';"); - $indexName = ''; - foreach($indexes as $index) { - if($index['index_keys'] == 'ID') { - $indexName = $index['index_name']; - break; - } - } + /** + * MSSQL stores the primary key column with an internal identifier, + * so a lookup needs to be done to determine it. + * + * @param string $tableName Name of table with primary key column "ID" + * @return string Internal identifier for primary key + */ + public function getPrimaryKey($tableName) + { + $indexes = $this->query("EXEC sp_helpindex '$tableName';"); + $indexName = ''; + foreach ($indexes as $index) { + if ($index['index_keys'] == 'ID') { + $indexName = $index['index_name']; + break; + } + } - return $indexName; - } + return $indexName; + } - /** - * Gets the identity column of a table - * - * @param string $tableName - * @return string|null - */ - function getIdentityColumn($tableName) { - return $this->preparedQuery(" + /** + * Gets the identity column of a table + * + * @param string $tableName + * @return string|null + */ + public function getIdentityColumn($tableName) + { + return $this->preparedQuery(" SELECT TABLE_NAME + '.' + COLUMN_NAME, TABLE_NAME @@ -138,160 +152,195 @@ class MSSQLSchemaManager extends DBSchemaManager { COLUMNPROPERTY(object_id(TABLE_NAME), COLUMN_NAME, 'IsIdentity') = 1 AND TABLE_NAME = ? ", array('dbo', $tableName))->value(); - } + } - public function createDatabase($name) { - $this->query("CREATE DATABASE \"$name\""); - } - - public function dropDatabase($name) { - $this->query("DROP DATABASE \"$name\""); - } + public function createDatabase($name) + { + $this->query("CREATE DATABASE \"$name\""); + } + + public function dropDatabase($name) + { + $this->query("DROP DATABASE \"$name\""); + } - public function databaseExists($name) { - $databases = $this->databaseList(); - foreach($databases as $dbname) { - if($dbname == $name) return true; - } - return false; - } - - public function databaseList() { - return $this->query('SELECT NAME FROM sys.sysdatabases')->column(); - } + public function databaseExists($name) + { + $databases = $this->databaseList(); + foreach ($databases as $dbname) { + if ($dbname == $name) { + return true; + } + } + return false; + } + + public function databaseList() + { + return $this->query('SELECT NAME FROM sys.sysdatabases')->column(); + } - /** - * Create a new table. - * @param $tableName The name of the table - * @param $fields A map of field names to field types - * @param $indexes A map of indexes - * @param $options An map of additional options. The available keys are as follows: - * - 'MSSQLDatabase'/'MySQLDatabase'/'PostgreSQLDatabase' - database-specific options such as "engine" for MySQL. - * - 'temporary' - If true, then a temporary table will be created - * @return The table name generated. This may be different from the table name, for example with temporary tables. - */ - public function createTable($tableName, $fields = null, $indexes = null, $options = null, $advancedOptions = null) { - $fieldSchemas = $indexSchemas = ""; - if($fields) foreach($fields as $k => $v) $fieldSchemas .= "\"$k\" $v,\n"; + /** + * Create a new table. + * @param $tableName The name of the table + * @param $fields A map of field names to field types + * @param $indexes A map of indexes + * @param $options An map of additional options. The available keys are as follows: + * - 'MSSQLDatabase'/'MySQLDatabase'/'PostgreSQLDatabase' - database-specific options such as "engine" for MySQL. + * - 'temporary' - If true, then a temporary table will be created + * @return The table name generated. This may be different from the table name, for example with temporary tables. + */ + public function createTable($tableName, $fields = null, $indexes = null, $options = null, $advancedOptions = null) + { + $fieldSchemas = $indexSchemas = ""; + if ($fields) { + foreach ($fields as $k => $v) { + $fieldSchemas .= "\"$k\" $v,\n"; + } + } - // Temporary tables start with "#" in MSSQL-land - if(!empty($options['temporary'])) { - // Randomize the temp table name to avoid conflicts in the tempdb table which derived databases share - $tableName = "#$tableName" . '-' . rand(1000000, 9999999); - } + // Temporary tables start with "#" in MSSQL-land + if (!empty($options['temporary'])) { + // Randomize the temp table name to avoid conflicts in the tempdb table which derived databases share + $tableName = "#$tableName" . '-' . rand(1000000, 9999999); + } - $this->query("CREATE TABLE \"$tableName\" ( + $this->query("CREATE TABLE \"$tableName\" ( $fieldSchemas primary key (\"ID\") );"); - //we need to generate indexes like this: CREATE INDEX IX_vault_to_export ON vault (to_export); - //This needs to be done AFTER the table creation, so we can set up the fulltext indexes correctly - if($indexes) foreach($indexes as $k => $v) { - $indexSchemas .= $this->getIndexSqlDefinition($tableName, $k, $v) . "\n"; - } + //we need to generate indexes like this: CREATE INDEX IX_vault_to_export ON vault (to_export); + //This needs to be done AFTER the table creation, so we can set up the fulltext indexes correctly + if ($indexes) { + foreach ($indexes as $k => $v) { + $indexSchemas .= $this->getIndexSqlDefinition($tableName, $k, $v) . "\n"; + } + } - if($indexSchemas) $this->query($indexSchemas); + if ($indexSchemas) { + $this->query($indexSchemas); + } - return $tableName; - } + return $tableName; + } - /** - * Alter a table's schema. - * @param $table The name of the table to alter - * @param $newFields New fields, a map of field name => field schema - * @param $newIndexes New indexes, a map of index name => index type - * @param $alteredFields Updated fields, a map of field name => field schema - * @param $alteredIndexes Updated indexes, a map of index name => index type - */ - public function alterTable($tableName, $newFields = null, $newIndexes = null, $alteredFields = null, $alteredIndexes = null, $alteredOptions=null, $advancedOptions=null) { - $alterList = array(); + /** + * Alter a table's schema. + * @param $table The name of the table to alter + * @param $newFields New fields, a map of field name => field schema + * @param $newIndexes New indexes, a map of index name => index type + * @param $alteredFields Updated fields, a map of field name => field schema + * @param $alteredIndexes Updated indexes, a map of index name => index type + */ + public function alterTable($tableName, $newFields = null, $newIndexes = null, $alteredFields = null, $alteredIndexes = null, $alteredOptions=null, $advancedOptions=null) + { + $alterList = array(); - // drop any fulltext indexes that exist on the table before altering the structure - if($this->fullTextIndexExists($tableName)) { - $alterList[] = "\nDROP FULLTEXT INDEX ON \"$tableName\";"; - } + // drop any fulltext indexes that exist on the table before altering the structure + if ($this->fullTextIndexExists($tableName)) { + $alterList[] = "\nDROP FULLTEXT INDEX ON \"$tableName\";"; + } - if($newFields) foreach($newFields as $k => $v) $alterList[] = "ALTER TABLE \"$tableName\" ADD \"$k\" $v"; + if ($newFields) { + foreach ($newFields as $k => $v) { + $alterList[] = "ALTER TABLE \"$tableName\" ADD \"$k\" $v"; + } + } - if($alteredFields) foreach($alteredFields as $k => $v) $alterList[] = $this->alterTableAlterColumn($tableName, $k, $v); - if($alteredIndexes) foreach($alteredIndexes as $k => $v) $alterList[] = $this->getIndexSqlDefinition($tableName, $k, $v); - if($newIndexes) foreach($newIndexes as $k => $v) $alterList[] = $this->getIndexSqlDefinition($tableName, $k, $v); + if ($alteredFields) { + foreach ($alteredFields as $k => $v) { + $alterList[] = $this->alterTableAlterColumn($tableName, $k, $v); + } + } + if ($alteredIndexes) { + foreach ($alteredIndexes as $k => $v) { + $alterList[] = $this->getIndexSqlDefinition($tableName, $k, $v); + } + } + if ($newIndexes) { + foreach ($newIndexes as $k => $v) { + $alterList[] = $this->getIndexSqlDefinition($tableName, $k, $v); + } + } - if($alterList) { - foreach($alterList as $alteration) { - if($alteration != '') { - $this->query($alteration); - } - } - } - } + if ($alterList) { + foreach ($alterList as $alteration) { + if ($alteration != '') { + $this->query($alteration); + } + } + } + } - /** - * Given the table and column name, retrieve the constraint name for that column - * in the table. - * - * @param string $tableName Table name column resides in - * @param string $columnName Column name the constraint is for - * @return string|null - */ - public function getConstraintName($tableName, $columnName) { - return $this->preparedQuery(" + /** + * Given the table and column name, retrieve the constraint name for that column + * in the table. + * + * @param string $tableName Table name column resides in + * @param string $columnName Column name the constraint is for + * @return string|null + */ + public function getConstraintName($tableName, $columnName) + { + return $this->preparedQuery(" SELECT CONSTRAINT_NAME FROM INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE WHERE TABLE_NAME = ? AND COLUMN_NAME = ?", - array($tableName, $columnName) - )->value(); - } + array($tableName, $columnName) + )->value(); + } - /** - * Given a table and column name, return a check constraint clause for that column in - * the table. - * - * This is an expensive query, so it is cached per-request and stored by table. The initial - * call for a table that has not been cached will query all columns and store that - * so subsequent calls are fast. - * - * @param string $tableName Table name column resides in - * @param string $columnName Column name the constraint is for - * @return string The check string - */ - public function getConstraintCheckClause($tableName, $columnName) { - // Check already processed table columns - if(isset(self::$cached_checks[$tableName])) { - if(!isset(self::$cached_checks[$tableName][$columnName])) { - return null; - } - return self::$cached_checks[$tableName][$columnName]; - } + /** + * Given a table and column name, return a check constraint clause for that column in + * the table. + * + * This is an expensive query, so it is cached per-request and stored by table. The initial + * call for a table that has not been cached will query all columns and store that + * so subsequent calls are fast. + * + * @param string $tableName Table name column resides in + * @param string $columnName Column name the constraint is for + * @return string The check string + */ + public function getConstraintCheckClause($tableName, $columnName) + { + // Check already processed table columns + if (isset(self::$cached_checks[$tableName])) { + if (!isset(self::$cached_checks[$tableName][$columnName])) { + return null; + } + return self::$cached_checks[$tableName][$columnName]; + } - // Regenerate cehcks for this table - $checks = array(); - foreach($this->preparedQuery(" + // Regenerate cehcks for this table + $checks = array(); + foreach ($this->preparedQuery(" SELECT CAST(CHECK_CLAUSE AS TEXT) AS CHECK_CLAUSE, COLUMN_NAME FROM INFORMATION_SCHEMA.CHECK_CONSTRAINTS AS CC INNER JOIN INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE AS CCU ON CCU.CONSTRAINT_NAME = CC.CONSTRAINT_NAME WHERE TABLE_NAME = ?", - array($tableName) - ) as $record) { - $checks[$record['COLUMN_NAME']] = $record['CHECK_CLAUSE']; - } - self::$cached_checks[$tableName] = $checks; - - // Return via cached records - return $this->getConstraintCheckClause($tableName, $columnName); - } + array($tableName) + ) as $record) { + $checks[$record['COLUMN_NAME']] = $record['CHECK_CLAUSE']; + } + self::$cached_checks[$tableName] = $checks; + + // Return via cached records + return $this->getConstraintCheckClause($tableName, $columnName); + } - /** - * Return the name of the default constraint applied to $tableName.$colName. - * Will return null if no such constraint exists - * - * @param string $tableName Name of the table - * @param string $colName Name of the column - * @return string|null - */ - protected function defaultConstraintName($tableName, $colName) { - return $this->preparedQuery(" + /** + * Return the name of the default constraint applied to $tableName.$colName. + * Will return null if no such constraint exists + * + * @param string $tableName Name of the table + * @param string $colName Name of the column + * @return string|null + */ + protected function defaultConstraintName($tableName, $colName) + { + return $this->preparedQuery(" SELECT s.name --default name FROM sys.sysobjects s join sys.syscolumns c ON s.parent_obj = c.id @@ -299,558 +348,591 @@ class MSSQLSchemaManager extends DBSchemaManager { and c.cdefault = s.id and parent_obj = OBJECT_ID(?) and c.name = ?", - array($tableName, $colName) - )->value(); - } + array($tableName, $colName) + )->value(); + } - /** - * Get enum values from a constraint check clause. - * - * @param string $clause Check clause to parse values from - * @return array Enum values - */ - protected function enumValuesFromCheckClause($clause) { - $segments = preg_split('/ +OR *\[/i', $clause); - $constraints = array(); - foreach($segments as $segment) { - $bits = preg_split('/ *= */', $segment); - for($i = 1; $i < sizeof($bits); $i += 2) { - array_unshift($constraints, substr(rtrim($bits[$i], ')'), 1, -1)); - } - } - return $constraints; - } + /** + * Get enum values from a constraint check clause. + * + * @param string $clause Check clause to parse values from + * @return array Enum values + */ + protected function enumValuesFromCheckClause($clause) + { + $segments = preg_split('/ +OR *\[/i', $clause); + $constraints = array(); + foreach ($segments as $segment) { + $bits = preg_split('/ *= */', $segment); + for ($i = 1; $i < sizeof($bits); $i += 2) { + array_unshift($constraints, substr(rtrim($bits[$i], ')'), 1, -1)); + } + } + return $constraints; + } - /* - * Creates an ALTER expression for a column in MS SQL - * - * @param string $tableName Name of the table to be altered - * @param string $colName Name of the column to be altered - * @param string $colSpec String which contains conditions for a column - * @return string - */ - protected function alterTableAlterColumn($tableName, $colName, $colSpec){ + /* + * Creates an ALTER expression for a column in MS SQL + * + * @param string $tableName Name of the table to be altered + * @param string $colName Name of the column to be altered + * @param string $colSpec String which contains conditions for a column + * @return string + */ + protected function alterTableAlterColumn($tableName, $colName, $colSpec) + { - // First, we split the column specifications into parts - // TODO: this returns an empty array for the following string: int(11) not null auto_increment - // on second thoughts, why is an auto_increment field being passed through? - $pattern = '/^(?[\w()]+)\s?(?(?:not\s)?null)?\s?(?default\s[\w\']+)?\s?(?check\s?[\w()\'",\s]+)?$/i'; - $matches = array(); - preg_match($pattern, $colSpec, $matches); + // First, we split the column specifications into parts + // TODO: this returns an empty array for the following string: int(11) not null auto_increment + // on second thoughts, why is an auto_increment field being passed through? + $pattern = '/^(?[\w()]+)\s?(?(?:not\s)?null)?\s?(?default\s[\w\']+)?\s?(?check\s?[\w()\'",\s]+)?$/i'; + $matches = array(); + preg_match($pattern, $colSpec, $matches); - // drop the index if it exists - $alterQueries = array(); + // drop the index if it exists + $alterQueries = array(); - // drop *ALL* indexes on a table before proceeding - // this won't drop primary keys, though - $indexes = $this->indexNames($tableName); - foreach($indexes as $indexName) { - $alterQueries[] = "DROP INDEX \"$indexName\" ON \"$tableName\";"; - } + // drop *ALL* indexes on a table before proceeding + // this won't drop primary keys, though + $indexes = $this->indexNames($tableName); + foreach ($indexes as $indexName) { + $alterQueries[] = "DROP INDEX \"$indexName\" ON \"$tableName\";"; + } - $prefix = "ALTER TABLE \"$tableName\" "; + $prefix = "ALTER TABLE \"$tableName\" "; - // Remove the old default prior to adjusting the column. - if($defaultConstraintName = $this->defaultConstraintName($tableName, $colName)) { - $alterQueries[] = "$prefix DROP CONSTRAINT \"$defaultConstraintName\";"; - } + // Remove the old default prior to adjusting the column. + if ($defaultConstraintName = $this->defaultConstraintName($tableName, $colName)) { + $alterQueries[] = "$prefix DROP CONSTRAINT \"$defaultConstraintName\";"; + } - if(isset($matches['definition'])) { - //We will prevent any changes being made to the ID column. Primary key indexes will have a fit if we do anything here. - if($colName != 'ID'){ + if (isset($matches['definition'])) { + //We will prevent any changes being made to the ID column. Primary key indexes will have a fit if we do anything here. + if ($colName != 'ID') { - // SET null / not null - $nullFragment = empty($matches['null']) ? '' : " {$matches['null']}"; - $alterQueries[] = "$prefix ALTER COLUMN \"$colName\" {$matches['definition']}$nullFragment;"; - - // Add a default back - if(!empty($matches['default'])) { - $alterQueries[] = "$prefix ADD {$matches['default']} FOR \"$colName\";"; - } + // SET null / not null + $nullFragment = empty($matches['null']) ? '' : " {$matches['null']}"; + $alterQueries[] = "$prefix ALTER COLUMN \"$colName\" {$matches['definition']}$nullFragment;"; + + // Add a default back + if (!empty($matches['default'])) { + $alterQueries[] = "$prefix ADD {$matches['default']} FOR \"$colName\";"; + } - // SET check constraint (The constraint HAS to be dropped) - if(!empty($matches['check'])) { - $constraint = $this->getConstraintName($tableName, $colName); - if($constraint) { - $alterQueries[] = "$prefix DROP CONSTRAINT {$constraint};"; - } + // SET check constraint (The constraint HAS to be dropped) + if (!empty($matches['check'])) { + $constraint = $this->getConstraintName($tableName, $colName); + if ($constraint) { + $alterQueries[] = "$prefix DROP CONSTRAINT {$constraint};"; + } - //NOTE: 'with nocheck' seems to solve a few problems I've been having for modifying existing tables. - $alterQueries[] = "$prefix WITH NOCHECK ADD CONSTRAINT \"{$tableName}_{$colName}_check\" {$matches['check']};"; - } - } - } + //NOTE: 'with nocheck' seems to solve a few problems I've been having for modifying existing tables. + $alterQueries[] = "$prefix WITH NOCHECK ADD CONSTRAINT \"{$tableName}_{$colName}_check\" {$matches['check']};"; + } + } + } - return implode("\n", $alterQueries); - } + return implode("\n", $alterQueries); + } - public function renameTable($oldTableName, $newTableName) { - $this->query("EXEC sp_rename \"$oldTableName\", \"$newTableName\""); - } + public function renameTable($oldTableName, $newTableName) + { + $this->query("EXEC sp_rename \"$oldTableName\", \"$newTableName\""); + } - /** - * Checks a table's integrity and repairs it if necessary. - * NOTE: MSSQL does not appear to support any vacuum or optimise commands - * - * @var string $tableName The name of the table. - * @return boolean Return true if the table has integrity after the method is complete. - */ - public function checkAndRepairTable($tableName) { - return true; - } + /** + * Checks a table's integrity and repairs it if necessary. + * NOTE: MSSQL does not appear to support any vacuum or optimise commands + * + * @var string $tableName The name of the table. + * @return boolean Return true if the table has integrity after the method is complete. + */ + public function checkAndRepairTable($tableName) + { + return true; + } - public function createField($tableName, $fieldName, $fieldSpec) { - $this->query("ALTER TABLE \"$tableName\" ADD \"$fieldName\" $fieldSpec"); - } + public function createField($tableName, $fieldName, $fieldSpec) + { + $this->query("ALTER TABLE \"$tableName\" ADD \"$fieldName\" $fieldSpec"); + } - /** - * Change the database type of the given field. - * @param string $tableName The name of the tbale the field is in. - * @param string $fieldName The name of the field to change. - * @param string $fieldSpec The new field specification - */ - public function alterField($tableName, $fieldName, $fieldSpec) { - $this->query("ALTER TABLE \"$tableName\" CHANGE \"$fieldName\" \"$fieldName\" $fieldSpec"); - } + /** + * Change the database type of the given field. + * @param string $tableName The name of the tbale the field is in. + * @param string $fieldName The name of the field to change. + * @param string $fieldSpec The new field specification + */ + public function alterField($tableName, $fieldName, $fieldSpec) + { + $this->query("ALTER TABLE \"$tableName\" CHANGE \"$fieldName\" \"$fieldName\" $fieldSpec"); + } - public function renameField($tableName, $oldName, $newName) { - $this->query("EXEC sp_rename @objname = '$tableName.$oldName', @newname = '$newName', @objtype = 'COLUMN'"); - } + public function renameField($tableName, $oldName, $newName) + { + $this->query("EXEC sp_rename @objname = '$tableName.$oldName', @newname = '$newName', @objtype = 'COLUMN'"); + } - public function fieldList($table) { - //This gets us more information than we need, but I've included it all for the moment.... - $fieldRecords = $this->preparedQuery("SELECT ordinal_position, column_name, data_type, column_default, + public function fieldList($table) + { + //This gets us more information than we need, but I've included it all for the moment.... + $fieldRecords = $this->preparedQuery("SELECT ordinal_position, column_name, data_type, column_default, is_nullable, character_maximum_length, numeric_precision, numeric_scale, collation_name FROM information_schema.columns WHERE table_name = ? ORDER BY ordinal_position;", - array($table) - ); + array($table) + ); - // Cache the records from the query - otherwise a lack of multiple active result sets - // will cause subsequent queries to fail in this method - $fields = array(); - $output = array(); - foreach($fieldRecords as $record) { - $fields[] = $record; - } + // Cache the records from the query - otherwise a lack of multiple active result sets + // will cause subsequent queries to fail in this method + $fields = array(); + $output = array(); + foreach ($fieldRecords as $record) { + $fields[] = $record; + } - foreach($fields as $field) { - // Update the data_type field to be a complete column definition string for use by - // SS_Database::requireField() - switch($field['data_type']){ - case 'int': - case 'bigint': - case 'numeric': - case 'float': - case 'bit': - if($field['data_type'] != 'bigint' && $field['data_type'] != 'int' && $sizeSuffix = $field['numeric_precision']) { - $field['data_type'] .= "($sizeSuffix)"; - } + foreach ($fields as $field) { + // Update the data_type field to be a complete column definition string for use by + // SS_Database::requireField() + switch ($field['data_type']) { + case 'int': + case 'bigint': + case 'numeric': + case 'float': + case 'bit': + if ($field['data_type'] != 'bigint' && $field['data_type'] != 'int' && $sizeSuffix = $field['numeric_precision']) { + $field['data_type'] .= "($sizeSuffix)"; + } - if($field['is_nullable'] == 'YES') { - $field['data_type'] .= ' null'; - } else { - $field['data_type'] .= ' not null'; - } - if($field['column_default']) { - $default=substr($field['column_default'], 2, -2); - $field['data_type'] .= " default $default"; - } - break; + if ($field['is_nullable'] == 'YES') { + $field['data_type'] .= ' null'; + } else { + $field['data_type'] .= ' not null'; + } + if ($field['column_default']) { + $default=substr($field['column_default'], 2, -2); + $field['data_type'] .= " default $default"; + } + break; - case 'decimal': - if($field['numeric_precision']) { - $sizeSuffix = $field['numeric_precision'] . ',' . $field['numeric_scale']; - $field['data_type'] .= "($sizeSuffix)"; - } + case 'decimal': + if ($field['numeric_precision']) { + $sizeSuffix = $field['numeric_precision'] . ',' . $field['numeric_scale']; + $field['data_type'] .= "($sizeSuffix)"; + } - if($field['is_nullable'] == 'YES') { - $field['data_type'] .= ' null'; - } else { - $field['data_type'] .= ' not null'; - } - if($field['column_default']) { - $default=substr($field['column_default'], 2, -2); - $field['data_type'] .= " default $default"; - } - break; + if ($field['is_nullable'] == 'YES') { + $field['data_type'] .= ' null'; + } else { + $field['data_type'] .= ' not null'; + } + if ($field['column_default']) { + $default=substr($field['column_default'], 2, -2); + $field['data_type'] .= " default $default"; + } + break; - case 'nvarchar': - case 'varchar': - //Check to see if there's a constraint attached to this column: - $clause = $this->getConstraintCheckClause($table, $field['column_name']); - if($clause) { - $constraints = $this->enumValuesFromCheckClause($clause); - $default=substr($field['column_default'], 2, -2); - $field['data_type'] = $this->enum(array( - 'default' => $default, - 'name' => $field['column_name'], - 'enums' => $constraints, - 'table' => $table - )); - break; - } + case 'nvarchar': + case 'varchar': + //Check to see if there's a constraint attached to this column: + $clause = $this->getConstraintCheckClause($table, $field['column_name']); + if ($clause) { + $constraints = $this->enumValuesFromCheckClause($clause); + $default=substr($field['column_default'], 2, -2); + $field['data_type'] = $this->enum(array( + 'default' => $default, + 'name' => $field['column_name'], + 'enums' => $constraints, + 'table' => $table + )); + break; + } - default: - $sizeSuffix = $field['character_maximum_length']; - if($sizeSuffix == '-1') $sizeSuffix = 'max'; - if($sizeSuffix) { - $field['data_type'] .= "($sizeSuffix)"; - } + default: + $sizeSuffix = $field['character_maximum_length']; + if ($sizeSuffix == '-1') { + $sizeSuffix = 'max'; + } + if ($sizeSuffix) { + $field['data_type'] .= "($sizeSuffix)"; + } - if($field['is_nullable'] == 'YES') { - $field['data_type'] .= ' null'; - } else { - $field['data_type'] .= ' not null'; - } - if($field['column_default']) { - $default=substr($field['column_default'], 2, -2); - $field['data_type'] .= " default '$default'"; - } - } - $output[$field['column_name']] = $field; + if ($field['is_nullable'] == 'YES') { + $field['data_type'] .= ' null'; + } else { + $field['data_type'] .= ' not null'; + } + if ($field['column_default']) { + $default=substr($field['column_default'], 2, -2); + $field['data_type'] .= " default '$default'"; + } + } + $output[$field['column_name']] = $field; + } - } + return $output; + } - return $output; - } + /** + * Create an index on a table. + * @param string $tableName The name of the table. + * @param string $indexName The name of the index. + * @param string $indexSpec The specification of the index, see SS_Database::requireIndex() for more details. + */ + public function createIndex($tableName, $indexName, $indexSpec) + { + $this->query($this->getIndexSqlDefinition($tableName, $indexName, $indexSpec)); + } + + /** + * Return SQL for dropping and recreating an index + * + * @param string $tableName Name of table to create this index against + * @param string $indexName Name of this index + * @param array|string $indexSpec Index specification, either as a raw string + * or parsed array form + * @return string The SQL required to generate this index + */ + protected function getIndexSqlDefinition($tableName, $indexName, $indexSpec) + { - /** - * Create an index on a table. - * @param string $tableName The name of the table. - * @param string $indexName The name of the index. - * @param string $indexSpec The specification of the index, see SS_Database::requireIndex() for more details. - */ - public function createIndex($tableName, $indexName, $indexSpec) { - $this->query($this->getIndexSqlDefinition($tableName, $indexName, $indexSpec)); - } - - /** - * Return SQL for dropping and recreating an index - * - * @param string $tableName Name of table to create this index against - * @param string $indexName Name of this index - * @param array|string $indexSpec Index specification, either as a raw string - * or parsed array form - * @return string The SQL required to generate this index - */ - protected function getIndexSqlDefinition($tableName, $indexName, $indexSpec) { + // Determine index name + $index = $this->buildMSSQLIndexName($tableName, $indexName); - // Determine index name - $index = $this->buildMSSQLIndexName($tableName, $indexName); + // Consolidate/Cleanup spec into array format + $indexSpec = $this->parseIndexSpec($indexName, $indexSpec); - // Consolidate/Cleanup spec into array format - $indexSpec = $this->parseIndexSpec($indexName, $indexSpec); + $drop = "IF EXISTS (SELECT name FROM sys.indexes WHERE name = '$index') DROP INDEX $index ON \"$tableName\";"; - $drop = "IF EXISTS (SELECT name FROM sys.indexes WHERE name = '$index') DROP INDEX $index ON \"$tableName\";"; + // create a type-specific index + if ($indexSpec['type'] == 'fulltext' && $this->database->fullTextEnabled()) { + // enable fulltext on this table + $this->createFullTextCatalog(); + $primary_key = $this->getPrimaryKey($tableName); - // create a type-specific index - if($indexSpec['type'] == 'fulltext' && $this->database->fullTextEnabled()) { - // enable fulltext on this table - $this->createFullTextCatalog(); - $primary_key = $this->getPrimaryKey($tableName); + if ($primary_key) { + return "$drop CREATE FULLTEXT INDEX ON \"$tableName\" ({$indexSpec['value']})" + . "KEY INDEX $primary_key WITH CHANGE_TRACKING AUTO;"; + } + } - if($primary_key) { - return "$drop CREATE FULLTEXT INDEX ON \"$tableName\" ({$indexSpec['value']})" - . "KEY INDEX $primary_key WITH CHANGE_TRACKING AUTO;"; - } - } + if ($indexSpec['type'] == 'unique') { + return "$drop CREATE UNIQUE INDEX $index ON \"$tableName\" ({$indexSpec['value']});"; + } - if($indexSpec['type'] == 'unique') { - return "$drop CREATE UNIQUE INDEX $index ON \"$tableName\" ({$indexSpec['value']});"; - } + return "$drop CREATE INDEX $index ON \"$tableName\" ({$indexSpec['value']});"; + } - return "$drop CREATE INDEX $index ON \"$tableName\" ({$indexSpec['value']});"; - } + public function alterIndex($tableName, $indexName, $indexSpec) + { + $this->createIndex($tableName, $indexName, $indexSpec); + } - public function alterIndex($tableName, $indexName, $indexSpec) { - $this->createIndex($tableName, $indexName, $indexSpec); - } + /** + * Return the list of indexes in a table. + * @param string $table The table name. + * @return array + */ + public function indexList($table) + { + $indexes = $this->query("EXEC sp_helpindex '$table';"); + $indexList = array(); - /** - * Return the list of indexes in a table. - * @param string $table The table name. - * @return array - */ - public function indexList($table) { - $indexes = $this->query("EXEC sp_helpindex '$table';"); - $indexList = array(); + // Enumerate all basic indexes + foreach ($indexes as $index) { + if (strpos($index['index_description'], 'unique') !== false) { + $indexType = 'unique '; + } else { + $indexType = 'index '; + } - // Enumerate all basic indexes - foreach($indexes as $index) { - if(strpos($index['index_description'], 'unique') !== false) { - $indexType = 'unique '; - } else { - $indexType = 'index '; - } + // Extract name from index + $baseIndexName = $this->buildMSSQLIndexName($table, ''); + $indexName = substr($index['index_name'], strlen($baseIndexName)); - // Extract name from index - $baseIndexName = $this->buildMSSQLIndexName($table, ''); - $indexName = substr($index['index_name'], strlen($baseIndexName)); + // Extract columns + $columns = $this->quoteColumnSpecString($index['index_keys']); + $indexList[$indexName] = $this->parseIndexSpec($indexName, array( + 'name' => $indexName, + 'value' => $columns, + 'type' => $indexType + )); + } - // Extract columns - $columns = $this->quoteColumnSpecString($index['index_keys']); - $indexList[$indexName] = $this->parseIndexSpec($indexName, array( - 'name' => $indexName, - 'value' => $columns, - 'type' => $indexType - )); - } + // Now we need to check to see if we have any fulltext indexes attached to this table: + if ($this->database->fullTextEnabled()) { + $result = $this->query('EXEC sp_help_fulltext_columns;'); - // Now we need to check to see if we have any fulltext indexes attached to this table: - if($this->database->fullTextEnabled()) { - $result = $this->query('EXEC sp_help_fulltext_columns;'); + // Extract columns from this fulltext definition + $columns = array(); + foreach ($result as $row) { + if ($row['TABLE_NAME'] == $table) { + $columns[] = $row['FULLTEXT_COLUMN_NAME']; + } + } - // Extract columns from this fulltext definition - $columns = array(); - foreach($result as $row) { - if($row['TABLE_NAME'] == $table) { - $columns[] = $row['FULLTEXT_COLUMN_NAME']; - } - } + if (!empty($columns)) { + $indexList['SearchFields'] = $this->parseIndexSpec('SearchFields', array( + 'name' => 'SearchFields', + 'value' => $this->implodeColumnList($columns), + 'type' => 'fulltext' + )); + } + } - if(!empty($columns)) { - $indexList['SearchFields'] = $this->parseIndexSpec('SearchFields', array( - 'name' => 'SearchFields', - 'value' => $this->implodeColumnList($columns), - 'type' => 'fulltext' - )); - } - } + return $indexList; + } - return $indexList; - } - - /** - * For a given table name, get all the internal index names, - * except for those that are primary keys and fulltext indexes. - * - * @return array - */ - public function indexNames($tableName) { - return $this->preparedQuery(' + /** + * For a given table name, get all the internal index names, + * except for those that are primary keys and fulltext indexes. + * + * @return array + */ + public function indexNames($tableName) + { + return $this->preparedQuery(' SELECT ind.name FROM sys.indexes ind INNER JOIN sys.tables t ON ind.object_id = t.object_id WHERE is_primary_key = 0 AND t.name = ?', - array($tableName) - )->column(); - } - - public function tableList() { - $tables = array(); - foreach($this->query("EXEC sp_tables @table_owner = 'dbo';") as $record) { - $tables[strtolower($record['TABLE_NAME'])] = $record['TABLE_NAME']; - } - return $tables; - } + array($tableName) + )->column(); + } + + public function tableList() + { + $tables = array(); + foreach ($this->query("EXEC sp_tables @table_owner = 'dbo';") as $record) { + $tables[strtolower($record['TABLE_NAME'])] = $record['TABLE_NAME']; + } + return $tables; + } - /** - * Return a boolean type-formatted string - * We use 'bit' so that we can do numeric-based comparisons - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function boolean($values) { - $default = ($values['default']) ? '1' : '0'; - return 'bit not null default ' . $default; - } + /** + * Return a boolean type-formatted string + * We use 'bit' so that we can do numeric-based comparisons + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function boolean($values) + { + $default = ($values['default']) ? '1' : '0'; + return 'bit not null default ' . $default; + } - /** - * Return a date type-formatted string. - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function date($values) { - return 'date null'; - } + /** + * Return a date type-formatted string. + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function date($values) + { + return 'date null'; + } - /** - * Return a decimal type-formatted string - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function decimal($values) { - // Avoid empty strings being put in the db - if($values['precision'] == '') { - $precision = 1; - } else { - $precision = $values['precision']; - } + /** + * Return a decimal type-formatted string + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function decimal($values) + { + // Avoid empty strings being put in the db + if ($values['precision'] == '') { + $precision = 1; + } else { + $precision = $values['precision']; + } - $defaultValue = '0'; - if(isset($values['default']) && is_numeric($values['default'])) { - $defaultValue = $values['default']; - } + $defaultValue = '0'; + if (isset($values['default']) && is_numeric($values['default'])) { + $defaultValue = $values['default']; + } - return "decimal($precision) not null default $defaultValue"; - } + return "decimal($precision) not null default $defaultValue"; + } - /** - * Return a enum type-formatted string - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function enum($values) { - // Enums are a bit different. We'll be creating a varchar(255) with a constraint of all the - // usual enum options. - // NOTE: In this one instance, we are including the table name in the values array + /** + * Return a enum type-formatted string + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function enum($values) + { + // Enums are a bit different. We'll be creating a varchar(255) with a constraint of all the + // usual enum options. + // NOTE: In this one instance, we are including the table name in the values array - $maxLength = max(array_map('strlen', $values['enums'])); + $maxLength = max(array_map('strlen', $values['enums'])); - return "varchar($maxLength) not null default '" . $values['default'] - . "' check(\"" . $values['name'] . "\" in ('" . implode("','", $values['enums']) - . "'))"; - } + return "varchar($maxLength) not null default '" . $values['default'] + . "' check(\"" . $values['name'] . "\" in ('" . implode("','", $values['enums']) + . "'))"; + } - /** - * @todo Make this work like {@link MySQLDatabase::set()} - */ - public function set($values) { - return $this->enum($values); - } + /** + * @todo Make this work like {@link MySQLDatabase::set()} + */ + public function set($values) + { + return $this->enum($values); + } - /** - * Return a float type-formatted string. - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function float($values) { - return 'float(53) not null default ' . $values['default']; - } + /** + * Return a float type-formatted string. + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function float($values) + { + return 'float(53) not null default ' . $values['default']; + } - /** - * Return a int type-formatted string - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function int($values) { - return 'int not null default ' . (int) $values['default']; - } + /** + * Return a int type-formatted string + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function int($values) + { + return 'int not null default ' . (int) $values['default']; + } - /** - * Return a bigint type-formatted string - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function bigint($values) { - return 'bigint not null default ' . (int) $values['default']; - } + /** + * Return a bigint type-formatted string + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function bigint($values) + { + return 'bigint not null default ' . (int) $values['default']; + } - /** - * Return a datetime type-formatted string - * For MS SQL, we simply return the word 'timestamp', no other parameters are necessary - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function ss_datetime($values) { - return 'datetime null'; - } + /** + * Return a datetime type-formatted string + * For MS SQL, we simply return the word 'timestamp', no other parameters are necessary + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function ss_datetime($values) + { + return 'datetime null'; + } - /** - * Return a text type-formatted string - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function text($values) { - $collation = MSSQLDatabase::get_collation(); - $collationSQL = $collation ? " COLLATE $collation" : ""; - return "nvarchar(max)$collationSQL null"; - } + /** + * Return a text type-formatted string + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function text($values) + { + $collation = MSSQLDatabase::get_collation(); + $collationSQL = $collation ? " COLLATE $collation" : ""; + return "nvarchar(max)$collationSQL null"; + } - /** - * Return a time type-formatted string. - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function time($values){ - return 'time null'; - } + /** + * Return a time type-formatted string. + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function time($values) + { + return 'time null'; + } - /** - * Return a varchar type-formatted string - * - * @params array $values Contains a tokenised list of info about this data type - * @return string - */ - public function varchar($values) { - $collation = MSSQLDatabase::get_collation(); - $collationSQL = $collation ? " COLLATE $collation" : ""; - return "nvarchar(" . $values['precision'] . ")$collationSQL null"; - } + /** + * Return a varchar type-formatted string + * + * @params array $values Contains a tokenised list of info about this data type + * @return string + */ + public function varchar($values) + { + $collation = MSSQLDatabase::get_collation(); + $collationSQL = $collation ? " COLLATE $collation" : ""; + return "nvarchar(" . $values['precision'] . ")$collationSQL null"; + } - /** - * Return a 4 digit numeric type. - * @return string - */ - public function year($values) { - return 'numeric(4)'; - } + /** + * Return a 4 digit numeric type. + * @return string + */ + public function year($values) + { + return 'numeric(4)'; + } - /** - * This returns the column which is the primary key for each table - * @return string - */ - function IdColumn($asDbValue = false, $hasAutoIncPK = true){ - if($asDbValue) { - return 'int not null'; - } else if($hasAutoIncPK) { - return 'int identity(1,1)'; - } else { - return 'int not null'; - } - } + /** + * This returns the column which is the primary key for each table + * @return string + */ + public function IdColumn($asDbValue = false, $hasAutoIncPK = true) + { + if ($asDbValue) { + return 'int not null'; + } elseif ($hasAutoIncPK) { + return 'int identity(1,1)'; + } else { + return 'int not null'; + } + } - function hasTable($tableName) { - return (bool)$this->preparedQuery( - "SELECT table_name FROM information_schema.tables WHERE table_name = ?", - array($tableName) - )->value(); - } + public function hasTable($tableName) + { + return (bool)$this->preparedQuery( + "SELECT table_name FROM information_schema.tables WHERE table_name = ?", + array($tableName) + )->value(); + } - /** - * Returns the values of the given enum field - * NOTE: Experimental; introduced for db-abstraction and may changed before 2.4 is released. - */ - public function enumValuesForField($tableName, $fieldName) { - $classes = array(); + /** + * Returns the values of the given enum field + * NOTE: Experimental; introduced for db-abstraction and may changed before 2.4 is released. + */ + public function enumValuesForField($tableName, $fieldName) + { + $classes = array(); - // Get the enum of all page types from the SiteTree table - $clause = $this->getConstraintCheckClause($tableName, $fieldName); - if($clause) { - $classes = $this->enumValuesFromCheckClause($clause); - } + // Get the enum of all page types from the SiteTree table + $clause = $this->getConstraintCheckClause($tableName, $fieldName); + if ($clause) { + $classes = $this->enumValuesFromCheckClause($clause); + } - return $classes; - } + return $classes; + } - /** - * This is a lookup table for data types. - * - * For instance, MSSQL uses 'BIGINT', while MySQL uses 'UNSIGNED' - * and PostgreSQL uses 'INT'. - */ - function dbDataType($type){ - $values = array( - 'unsigned integer'=>'BIGINT' - ); - if(isset($values[$type])) { - return $values[$type]; - } else { - return ''; - } - } - - protected function indexKey($table, $index, $spec) { - return $index; - } + /** + * This is a lookup table for data types. + * + * For instance, MSSQL uses 'BIGINT', while MySQL uses 'UNSIGNED' + * and PostgreSQL uses 'INT'. + */ + public function dbDataType($type) + { + $values = array( + 'unsigned integer'=>'BIGINT' + ); + if (isset($values[$type])) { + return $values[$type]; + } else { + return ''; + } + } + + protected function indexKey($table, $index, $spec) + { + return $index; + } } diff --git a/code/SQLServerConnector.php b/code/SQLServerConnector.php index 27e0687..315093f 100644 --- a/code/SQLServerConnector.php +++ b/code/SQLServerConnector.php @@ -5,188 +5,208 @@ * * @package mssql */ -class SQLServerConnector extends DBConnector { - - /** - * Connection to the DBMS. - * - * @var resource - */ - protected $dbConn = null; +class SQLServerConnector extends DBConnector +{ + + /** + * Connection to the DBMS. + * + * @var resource + */ + protected $dbConn = null; - /** - * Stores the affected rows of the last query. - * Used by sqlsrv functions only, as sqlsrv_rows_affected - * accepts a result instead of a database handle. - * - * @var integer - */ - protected $lastAffectedRows; - - /** - * Name of the currently selected database - * - * @var string - */ - protected $selectedDatabase = null; + /** + * Stores the affected rows of the last query. + * Used by sqlsrv functions only, as sqlsrv_rows_affected + * accepts a result instead of a database handle. + * + * @var integer + */ + protected $lastAffectedRows; + + /** + * Name of the currently selected database + * + * @var string + */ + protected $selectedDatabase = null; - public function connect($parameters, $selectDB = false) { - // Disable default warnings as errors behaviour for sqlsrv to keep it in line with mssql functions - if(ini_get('sqlsrv.WarningsReturnAsErrors')) { - ini_set('sqlsrv.WarningsReturnAsErrors', 'Off'); - } + public function connect($parameters, $selectDB = false) + { + // Disable default warnings as errors behaviour for sqlsrv to keep it in line with mssql functions + if (ini_get('sqlsrv.WarningsReturnAsErrors')) { + ini_set('sqlsrv.WarningsReturnAsErrors', 'Off'); + } - $charset = isset($parameters['charset']) ? $parameters : 'UTF-8'; - $multiResultSets = isset($parameters['multipleactiveresultsets']) - ? $parameters['multipleactiveresultsets'] - : true; - $options = array( - 'CharacterSet' => $charset, - 'MultipleActiveResultSets' => $multiResultSets - ); - - if( !(defined('MSSQL_USE_WINDOWS_AUTHENTICATION') && MSSQL_USE_WINDOWS_AUTHENTICATION == true) - && empty($parameters['windowsauthentication']) - ) { - $options['UID'] = $parameters['username']; - $options['PWD'] = $parameters['password']; - } - - // Required by MS Azure database - if($selectDB && !empty($parameters['database'])) { - $options['Database'] = $parameters['database']; - } + $charset = isset($parameters['charset']) ? $parameters : 'UTF-8'; + $multiResultSets = isset($parameters['multipleactiveresultsets']) + ? $parameters['multipleactiveresultsets'] + : true; + $options = array( + 'CharacterSet' => $charset, + 'MultipleActiveResultSets' => $multiResultSets + ); + + if (!(defined('MSSQL_USE_WINDOWS_AUTHENTICATION') && MSSQL_USE_WINDOWS_AUTHENTICATION == true) + && empty($parameters['windowsauthentication']) + ) { + $options['UID'] = $parameters['username']; + $options['PWD'] = $parameters['password']; + } + + // Required by MS Azure database + if ($selectDB && !empty($parameters['database'])) { + $options['Database'] = $parameters['database']; + } - $this->dbConn = sqlsrv_connect($parameters['server'], $options); - - if(empty($this->dbConn)) { - $this->databaseError("Couldn't connect to SQL Server database"); - } elseif($selectDB && !empty($parameters['database'])) { - // Check selected database (Azure) - $this->selectedDatabase = $parameters['database']; - } - } - - /** - * Start transaction. READ ONLY not supported. - */ - public function transactionStart(){ - $result = sqlsrv_begin_transaction($this->dbConn); - if (!$result) { - $this->databaseError("Couldn't start the transaction."); - } - } - - /** - * Commit everything inside this transaction so far - */ - public function transactionEnd() { - $result = sqlsrv_commit($this->dbConn); - if (!$result) { - $this->databaseError("Couldn't commit the transaction."); - } - } - - /** - * Rollback or revert to a savepoint if your queries encounter problems - * If you encounter a problem at any point during a transaction, you may - * need to rollback that particular query, or return to a savepoint - */ - public function transactionRollback(){ - $result = sqlsrv_rollback($this->dbConn); - if (!$result) { - $this->databaseError("Couldn't rollback the transaction."); - } - } + $this->dbConn = sqlsrv_connect($parameters['server'], $options); + + if (empty($this->dbConn)) { + $this->databaseError("Couldn't connect to SQL Server database"); + } elseif ($selectDB && !empty($parameters['database'])) { + // Check selected database (Azure) + $this->selectedDatabase = $parameters['database']; + } + } + + /** + * Start transaction. READ ONLY not supported. + */ + public function transactionStart() + { + $result = sqlsrv_begin_transaction($this->dbConn); + if (!$result) { + $this->databaseError("Couldn't start the transaction."); + } + } + + /** + * Commit everything inside this transaction so far + */ + public function transactionEnd() + { + $result = sqlsrv_commit($this->dbConn); + if (!$result) { + $this->databaseError("Couldn't commit the transaction."); + } + } + + /** + * Rollback or revert to a savepoint if your queries encounter problems + * If you encounter a problem at any point during a transaction, you may + * need to rollback that particular query, or return to a savepoint + */ + public function transactionRollback() + { + $result = sqlsrv_rollback($this->dbConn); + if (!$result) { + $this->databaseError("Couldn't rollback the transaction."); + } + } - public function affectedRows() { - return $this->lastAffectedRows; - } - - public function getLastError() { - $errorMessages = array(); - $errors = sqlsrv_errors(); - if($errors) foreach($errors as $info) { - $errorMessages[] = implode(', ', array($info['SQLSTATE'], $info['code'], $info['message'])); - } - return implode('; ', $errorMessages); - } + public function affectedRows() + { + return $this->lastAffectedRows; + } + + public function getLastError() + { + $errorMessages = array(); + $errors = sqlsrv_errors(); + if ($errors) { + foreach ($errors as $info) { + $errorMessages[] = implode(', ', array($info['SQLSTATE'], $info['code'], $info['message'])); + } + } + return implode('; ', $errorMessages); + } - public function isActive() { - return $this->dbConn && $this->selectedDatabase; - } + public function isActive() + { + return $this->dbConn && $this->selectedDatabase; + } - public function preparedQuery($sql, $parameters, $errorLevel = E_USER_ERROR) { - // Reset state - $this->lastAffectedRows = 0; - - // Run query - $parsedParameters = $this->parameterValues($parameters); - if(empty($parsedParameters)) { - $handle = sqlsrv_query($this->dbConn, $sql); - } else { - $handle = sqlsrv_query($this->dbConn, $sql, $parsedParameters); - } - - // Check for error - if(!$handle) { - $this->databaseError($this->getLastError(), $errorLevel, $sql, $parsedParameters); - return null; - } - - // Report result - $this->lastAffectedRows = sqlsrv_rows_affected($handle); - return new SQLServerQuery($this, $handle); - } + public function preparedQuery($sql, $parameters, $errorLevel = E_USER_ERROR) + { + // Reset state + $this->lastAffectedRows = 0; + + // Run query + $parsedParameters = $this->parameterValues($parameters); + if (empty($parsedParameters)) { + $handle = sqlsrv_query($this->dbConn, $sql); + } else { + $handle = sqlsrv_query($this->dbConn, $sql, $parsedParameters); + } + + // Check for error + if (!$handle) { + $this->databaseError($this->getLastError(), $errorLevel, $sql, $parsedParameters); + return null; + } + + // Report result + $this->lastAffectedRows = sqlsrv_rows_affected($handle); + return new SQLServerQuery($this, $handle); + } - public function query($sql, $errorLevel = E_USER_ERROR) { - return $this->preparedQuery($sql, array(), $errorLevel); - } + public function query($sql, $errorLevel = E_USER_ERROR) + { + return $this->preparedQuery($sql, array(), $errorLevel); + } - public function selectDatabase($name) { - $this->query("USE \"$name\""); - $this->selectedDatabase = $name; - return true; - } + public function selectDatabase($name) + { + $this->query("USE \"$name\""); + $this->selectedDatabase = $name; + return true; + } - public function __destruct() { - if(is_resource($this->dbConn)) { - sqlsrv_close($this->dbConn); - } - } + public function __destruct() + { + if (is_resource($this->dbConn)) { + sqlsrv_close($this->dbConn); + } + } - public function getVersion() { - // @todo - use sqlsrv_server_info? - return trim($this->query("SELECT CONVERT(char(15), SERVERPROPERTY('ProductVersion'))")->value()); - } + public function getVersion() + { + // @todo - use sqlsrv_server_info? + return trim($this->query("SELECT CONVERT(char(15), SERVERPROPERTY('ProductVersion'))")->value()); + } - public function getGeneratedID($table) { - return $this->query("SELECT IDENT_CURRENT('$table')")->value(); - } + public function getGeneratedID($table) + { + return $this->query("SELECT IDENT_CURRENT('$table')")->value(); + } - public function getSelectedDatabase() { - return $this->selectedDatabase; - } + public function getSelectedDatabase() + { + return $this->selectedDatabase; + } - public function unloadDatabase() { - $this->selectDatabase('Master'); - $this->selectedDatabase = null; - } - - /** - * Quotes a string, including the "N" prefix so unicode - * strings are saved to the database correctly. - * - * @param string $string String to be encoded - * @return string Processed string ready for DB - */ - public function quoteString($value) { - return "N'" . $this->escapeString($value) . "'"; - } - - public function escapeString($value) { - $value = str_replace("'", "''", $value); - $value = str_replace("\0", "[NULL]", $value); - return $value; - } + public function unloadDatabase() + { + $this->selectDatabase('Master'); + $this->selectedDatabase = null; + } + + /** + * Quotes a string, including the "N" prefix so unicode + * strings are saved to the database correctly. + * + * @param string $string String to be encoded + * @return string Processed string ready for DB + */ + public function quoteString($value) + { + return "N'" . $this->escapeString($value) . "'"; + } + + public function escapeString($value) + { + $value = str_replace("'", "''", $value); + $value = str_replace("\0", "[NULL]", $value); + return $value; + } } diff --git a/code/SQLServerQuery.php b/code/SQLServerQuery.php index 10cebda..70c7c9d 100644 --- a/code/SQLServerQuery.php +++ b/code/SQLServerQuery.php @@ -5,72 +5,85 @@ * * @package mssql */ -class SQLServerQuery extends SS_Query { +class SQLServerQuery extends SS_Query +{ - /** - * The SQLServerConnector object that created this result set. - * - * @var SQLServerConnector - */ - private $connector; + /** + * The SQLServerConnector object that created this result set. + * + * @var SQLServerConnector + */ + private $connector; - /** - * The internal MSSQL handle that points to the result set. - * - * @var resource - */ - private $handle; + /** + * The internal MSSQL handle that points to the result set. + * + * @var resource + */ + private $handle; - /** - * Hook the result-set given into a Query class, suitable for use by sapphire. - * @param SQLServerConnector $connector The database object that created this query. - * @param resource $handle the internal mssql handle that is points to the resultset. - */ - public function __construct(SQLServerConnector $connector, $handle) { - $this->connector = $connector; - $this->handle = $handle; - } + /** + * Hook the result-set given into a Query class, suitable for use by sapphire. + * @param SQLServerConnector $connector The database object that created this query. + * @param resource $handle the internal mssql handle that is points to the resultset. + */ + public function __construct(SQLServerConnector $connector, $handle) + { + $this->connector = $connector; + $this->handle = $handle; + } - public function __destruct() { - if(is_resource($this->handle)) { - sqlsrv_free_stmt($this->handle); - } - } + public function __destruct() + { + if (is_resource($this->handle)) { + sqlsrv_free_stmt($this->handle); + } + } - public function seek($row) { - if(!is_resource($this->handle)) return false; + public function seek($row) + { + if (!is_resource($this->handle)) { + return false; + } - user_error('MSSQLQuery::seek() not supported in sqlsrv', E_USER_WARNING); - } + user_error('MSSQLQuery::seek() not supported in sqlsrv', E_USER_WARNING); + } - public function numRecords() { - if(!is_resource($this->handle)) return false; + public function numRecords() + { + if (!is_resource($this->handle)) { + return false; + } - // WARNING: This will only work if the cursor type is scrollable! - if(function_exists('sqlsrv_num_rows')) { - return sqlsrv_num_rows($this->handle); - } else { - user_error('MSSQLQuery::numRecords() not supported in this version of sqlsrv', E_USER_WARNING); - } - } + // WARNING: This will only work if the cursor type is scrollable! + if (function_exists('sqlsrv_num_rows')) { + return sqlsrv_num_rows($this->handle); + } else { + user_error('MSSQLQuery::numRecords() not supported in this version of sqlsrv', E_USER_WARNING); + } + } - public function nextRecord() { - if(!is_resource($this->handle)) return false; + public function nextRecord() + { + if (!is_resource($this->handle)) { + return false; + } - if($data = sqlsrv_fetch_array($this->handle, SQLSRV_FETCH_ASSOC)) { - // special case for sqlsrv - date values are DateTime coming out of the sqlsrv drivers, - // so we convert to the usual Y-m-d H:i:s value! - foreach($data as $name => $value) { - if($value instanceof DateTime) $data[$name] = $value->format('Y-m-d H:i:s'); - } - return $data; - } else { - // Free the handle if there are no more results - sqlsrv crashes if there are too many handles - sqlsrv_free_stmt($this->handle); - $this->handle = null; - } - - return false; - } + if ($data = sqlsrv_fetch_array($this->handle, SQLSRV_FETCH_ASSOC)) { + // special case for sqlsrv - date values are DateTime coming out of the sqlsrv drivers, + // so we convert to the usual Y-m-d H:i:s value! + foreach ($data as $name => $value) { + if ($value instanceof DateTime) { + $data[$name] = $value->format('Y-m-d H:i:s'); + } + } + return $data; + } else { + // Free the handle if there are no more results - sqlsrv crashes if there are too many handles + sqlsrv_free_stmt($this->handle); + $this->handle = null; + } + return false; + } } diff --git a/tests/MSSQLDatabaseQueryTest.php b/tests/MSSQLDatabaseQueryTest.php index 68f4ba7..7be352f 100644 --- a/tests/MSSQLDatabaseQueryTest.php +++ b/tests/MSSQLDatabaseQueryTest.php @@ -1,28 +1,30 @@ objFromFixture('MSSQLDatabaseQueryTestDataObject', 'test-data-1'); - $this->assertEquals('2012-01-01', $obj->obj('TestDate')->Format('Y-m-d'), 'Date field value is formatted correctly (Y-m-d)'); - } - - public function testDatetimeValueFormatting() { - $obj = $this->objFromFixture('MSSQLDatabaseQueryTestDataObject', 'test-data-1'); - $this->assertEquals('2012-01-01 10:30:00', $obj->obj('TestDatetime')->Format('Y-m-d H:i:s'), 'Datetime field value is formatted correctly (Y-m-d H:i:s)'); - } + public function testDateValueFormatting() + { + $obj = $this->objFromFixture('MSSQLDatabaseQueryTestDataObject', 'test-data-1'); + $this->assertEquals('2012-01-01', $obj->obj('TestDate')->Format('Y-m-d'), 'Date field value is formatted correctly (Y-m-d)'); + } + public function testDatetimeValueFormatting() + { + $obj = $this->objFromFixture('MSSQLDatabaseQueryTestDataObject', 'test-data-1'); + $this->assertEquals('2012-01-01 10:30:00', $obj->obj('TestDatetime')->Format('Y-m-d H:i:s'), 'Datetime field value is formatted correctly (Y-m-d H:i:s)'); + } } -class MSSQLDatabaseQueryTestDataObject extends DataObject implements TestOnly { - - public static $db = array( - 'TestDate' => 'Date', - 'TestDatetime' => 'SS_Datetime' - ); +class MSSQLDatabaseQueryTestDataObject extends DataObject implements TestOnly +{ + public static $db = array( + 'TestDate' => 'Date', + 'TestDatetime' => 'SS_Datetime' + ); }