mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
c57ce5f1a4
ENHANCEMENT Using CliDebugView to report errors on ajax requests (with plaintext output) ENHANCEMENT Removed "ERROR:" prefix hack for ajax error responses - clientside evaluation should inspect HTTP status codes instead git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@62467 467b73ca-7a2a-4603-9d3b-597d59a354a9
462 lines
13 KiB
PHP
462 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* MySQL connector class.
|
|
* @package sapphire
|
|
* @subpackage model
|
|
*/
|
|
class MySQLDatabase extends Database {
|
|
/**
|
|
* Connection to the DBMS.
|
|
* @var resource
|
|
*/
|
|
private $dbConn;
|
|
|
|
/**
|
|
* True if we are connected to a database.
|
|
* @var boolean
|
|
*/
|
|
private $active;
|
|
|
|
/**
|
|
* The name of the database.
|
|
* @var string
|
|
*/
|
|
private $database;
|
|
|
|
/**
|
|
* Connect to a MySQL 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
|
|
*/
|
|
public function __construct($parameters) {
|
|
$this->dbConn = mysql_connect($parameters['server'], $parameters['username'], $parameters['password']);
|
|
$this->active = mysql_select_db($parameters['database'], $this->dbConn);
|
|
$this->database = $parameters['database'];
|
|
if(!$this->dbConn) {
|
|
$this->databaseError("Couldn't connect to MySQL database");
|
|
}
|
|
|
|
parent::__construct();
|
|
}
|
|
|
|
/**
|
|
* Not implemented, needed for PDO
|
|
*/
|
|
public function getConnect($parameters) {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns true if this database supports collations
|
|
* @return boolean
|
|
*/
|
|
public function supportsCollations() {
|
|
return $this->getVersion() >= 4.1;
|
|
}
|
|
|
|
/**
|
|
* The version of MySQL.
|
|
* @var float
|
|
*/
|
|
private $mysqlVersion;
|
|
|
|
/**
|
|
* Get the version of MySQL.
|
|
* @return float
|
|
*/
|
|
public function getVersion() {
|
|
if(!$this->mysqlVersion) {
|
|
$this->mysqlVersion = (float)$this->query("SELECT VERSION()")->value();
|
|
}
|
|
return $this->mysqlVersion;
|
|
}
|
|
|
|
/**
|
|
* Get the database server, namely mysql.
|
|
* @return string
|
|
*/
|
|
public function getDatabaseServer() {
|
|
return "mysql";
|
|
}
|
|
|
|
public function query($sql, $errorLevel = E_USER_ERROR) {
|
|
if(isset($_REQUEST['previewwrite']) && in_array(strtolower(substr($sql,0,strpos($sql,' '))), array('insert','update','delete','replace'))) {
|
|
Debug::message("Will execute: $sql");
|
|
return;
|
|
}
|
|
|
|
if(isset($_REQUEST['showqueries'])) {
|
|
$starttime = microtime(true);
|
|
}
|
|
|
|
$handle = mysql_query($sql, $this->dbConn);
|
|
|
|
if(isset($_REQUEST['showqueries'])) {
|
|
$endtime = round(microtime(true) - $starttime,4);
|
|
Debug::message("\n$sql\n{$endtime}ms\n", false);
|
|
}
|
|
|
|
if(!$handle && $errorLevel) $this->databaseError("Couldn't run query: $sql | " . mysql_error($this->dbConn), $errorLevel);
|
|
return new MySQLQuery($this, $handle);
|
|
}
|
|
|
|
public function getGeneratedID($table) {
|
|
return mysql_insert_id($this->dbConn);
|
|
}
|
|
|
|
/**
|
|
* OBSOLETE: Get the ID for the next new record for the table.
|
|
*
|
|
* @var string $table The name od the table.
|
|
* @return int
|
|
*/
|
|
public function getNextID($table) {
|
|
user_error('getNextID is OBSOLETE (and will no longer work properly)', E_USER_WARNING);
|
|
$result = $this->query("SELECT MAX(ID)+1 FROM `$table`")->value();
|
|
return $result ? $result : 1;
|
|
}
|
|
|
|
public function isActive() {
|
|
return $this->active ? true : false;
|
|
}
|
|
|
|
public function createDatabase() {
|
|
$this->query("CREATE DATABASE $this->database");
|
|
$this->query("USE $this->database");
|
|
|
|
$this->tableList = $this->fieldList = $this->indexList = null;
|
|
|
|
if(mysql_select_db($this->database, $this->dbConn)) {
|
|
$this->active = true;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Drop the database that this object is currently connected to.
|
|
* Use with caution.
|
|
*/
|
|
public function dropDatabase() {
|
|
$this->query("DROP DATABASE $this->database");
|
|
}
|
|
|
|
/**
|
|
* Returns the name of the currently selected database
|
|
*/
|
|
public function currentDatabase() {
|
|
return $this->database;
|
|
}
|
|
|
|
/**
|
|
* Switches to the given database.
|
|
* If the database doesn't exist, you should call createDatabase() after calling selectDatabase()
|
|
*/
|
|
public function selectDatabase($dbname) {
|
|
$this->database = $dbname;
|
|
if($this->databaseExists($this->database)) {
|
|
if(mysql_select_db($this->database, $this->dbConn)) $this->active = true;
|
|
}
|
|
$this->tableList = $this->fieldList = $this->indexList = null;
|
|
}
|
|
|
|
/**
|
|
* Returns true if the named database exists.
|
|
*/
|
|
public function databaseExists($name) {
|
|
$SQL_name = Convert::raw2sql($name);
|
|
return $this->query("SHOW DATABASES LIKE '$SQL_name'")->value() ? true : false;
|
|
}
|
|
|
|
public function createTable($tableName, $fields = null, $indexes = null) {
|
|
$fieldSchemas = $indexSchemas = "";
|
|
if($fields) foreach($fields as $k => $v) $fieldSchemas .= "`$k` $v,\n";
|
|
if($indexes) foreach($indexes as $k => $v) $fieldSchemas .= $this->getIndexSqlDefinition($k, $v) . ",\n";
|
|
|
|
$this->query("CREATE TABLE `$tableName` (
|
|
ID int(11) not null auto_increment,
|
|
$fieldSchemas
|
|
$indexSchemas
|
|
primary key (ID)
|
|
) TYPE=MyISAM");
|
|
}
|
|
|
|
/**
|
|
* 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) {
|
|
$fieldSchemas = $indexSchemas = "";
|
|
|
|
if($newFields) foreach($newFields as $k => $v) $alterList[] .= "ADD `$k` $v";
|
|
if($newIndexes) foreach($newIndexes as $k => $v) $alterList[] .= "ADD " . $this->getIndexSqlDefinition($k, $v);
|
|
if($alteredFields) foreach($alteredFields as $k => $v) $alterList[] .= "CHANGE `$k` `$k` $v";
|
|
if($alteredIndexes) foreach($alteredIndexes as $k => $v) {
|
|
$alterList[] .= "DROP INDEX `$k`";
|
|
$alterList[] .= "ADD ". $this->getIndexSqlDefinition($k, $v);
|
|
}
|
|
|
|
$alterations = implode(",\n", $alterList);
|
|
$this->query("ALTER TABLE `$tableName` " . $alterations);
|
|
}
|
|
|
|
public function renameTable($oldTableName, $newTableName) {
|
|
$this->query("ALTER TABLE `$oldTableName` RENAME `$newTableName`");
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Checks a table's integrity and repairs it if necessary.
|
|
* @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) {
|
|
if(!$this->runTableCheckCommand("CHECK TABLE `$tableName`")) {
|
|
Database::alteration_message("Table $tableName: repaired","repaired");
|
|
return $this->runTableCheckCommand("REPAIR TABLE `$tableName` USE_FRM");
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper function used by checkAndRepairTable.
|
|
* @param string $sql Query to run.
|
|
* @return boolean Returns if the query returns a successful result.
|
|
*/
|
|
protected function runTableCheckCommand($sql) {
|
|
$testResults = $this->query($sql);
|
|
foreach($testResults as $testRecord) {
|
|
if(strtolower($testRecord['Msg_text']) != 'ok') {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
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 wee function was built for MoT. It will preserve the binary format of the content,
|
|
// but change the character set
|
|
/*
|
|
$changes = $this->query("SELECT ID, `$fieldName` FROM `$tableName`")->map();
|
|
*/
|
|
|
|
$this->query("ALTER TABLE `$tableName` CHANGE `$fieldName` `$fieldName` $fieldSpec");
|
|
|
|
// This wee function was built for MoT. It will preserve the binary format of the content,
|
|
// but change the character set
|
|
/*
|
|
echo "<li>Fixing " . sizeof($changes) . " page's contnet";
|
|
foreach($changes as $id => $text) {
|
|
$SQL_text = Convert::raw2sql($text);
|
|
$this->query("UPDATE `$tableName` SET `$fieldName` = '$SQL_text' WHERE ID = '$id'");
|
|
}
|
|
*/
|
|
}
|
|
|
|
public function fieldList($table) {
|
|
$fields = DB::query("SHOW FULL FIELDS IN `$table`");
|
|
foreach($fields as $field) {
|
|
$fieldSpec = $field['Type'];
|
|
if(!$field['Null'] || $field['Null'] == 'NO') {
|
|
$fieldSpec .= ' not null';
|
|
}
|
|
|
|
if($field['Collation'] && $field['Collation'] != 'NULL') {
|
|
$collInfo = DB::query("SHOW COLLATION LIKE '$field[Collation]'")->record();
|
|
$fieldSpec .= " character set $collInfo[Charset] collate $field[Collation]";
|
|
}
|
|
|
|
if($field['Default'] || $field['Default'] === "0") {
|
|
$fieldSpec .= " default '" . addslashes($field['Default']) . "'";
|
|
}
|
|
if($field['Extra']) $fieldSpec .= " $field[Extra]";
|
|
|
|
$fieldList[$field['Field']] = $fieldSpec;
|
|
}
|
|
return $fieldList;
|
|
}
|
|
|
|
/**
|
|
* 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 Database::requireIndex() for more details.
|
|
*/
|
|
public function createIndex($tableName, $indexName, $indexSpec) {
|
|
$this->query("ALTER TABLE `$tableName` ADD " . $this->getIndexSqlDefinition($indexName, $indexSpec));
|
|
}
|
|
|
|
protected function getIndexSqlDefinition($indexName, $indexSpec) {
|
|
$indexSpec = trim($indexSpec);
|
|
if($indexSpec[0] != '(') list($indexType, $indexFields) = explode(' ',$indexSpec,2);
|
|
else $indexFields = $indexSpec;
|
|
if(!isset($indexType)) {
|
|
$indexType = "index";
|
|
}
|
|
return "$indexType `$indexName` $indexFields";
|
|
}
|
|
|
|
/**
|
|
* Alter 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 Database::requireIndex() for more details.
|
|
*/
|
|
public function alterIndex($tableName, $indexName, $indexSpec) {
|
|
$indexSpec = trim($indexSpec);
|
|
if($indexSpec[0] != '(') {
|
|
list($indexType, $indexFields) = explode(' ',$indexSpec,2);
|
|
} else {
|
|
$indexFields = $indexSpec;
|
|
}
|
|
|
|
if(!$indexType) {
|
|
$indexType = "index";
|
|
}
|
|
|
|
$this->query("ALTER TABLE `$tableName` DROP INDEX `$indexName`");
|
|
$this->query("ALTER TABLE `$tableName` ADD $indexType `$indexName` $indexFields");
|
|
}
|
|
|
|
/**
|
|
* Return the list of indexes in a table.
|
|
* @param string $table The table name.
|
|
* @return array
|
|
*/
|
|
public function indexList($table) {
|
|
$indexes = DB::query("SHOW INDEXES IN `$table`");
|
|
|
|
foreach($indexes as $index) {
|
|
$groupedIndexes[$index['Key_name']]['fields'][$index['Seq_in_index']] = $index['Column_name'];
|
|
|
|
if($index['Index_type'] == 'FULLTEXT') {
|
|
$groupedIndexes[$index['Key_name']]['type'] = 'fulltext ';
|
|
} else if(!$index['Non_unique']) {
|
|
$groupedIndexes[$index['Key_name']]['type'] = 'unique ';
|
|
} else {
|
|
$groupedIndexes[$index['Key_name']]['type'] = '';
|
|
}
|
|
}
|
|
|
|
foreach($groupedIndexes as $index => $details) {
|
|
ksort($details['fields']);
|
|
$indexList[$index] = $details['type'] . '(' . implode(',',$details['fields']) . ')';
|
|
}
|
|
|
|
return $indexList;
|
|
}
|
|
|
|
/**
|
|
* Returns a list of all the tables in the database.
|
|
* Table names will all be in lowercase.
|
|
* @return array
|
|
*/
|
|
public function tableList() {
|
|
$tables = array();
|
|
foreach($this->query("SHOW TABLES") as $record) {
|
|
$table = strtolower(reset($record));
|
|
$tables[$table] = $table;
|
|
}
|
|
return $tables;
|
|
}
|
|
|
|
/**
|
|
* Return the number of rows affected by the previous operation.
|
|
* @return int
|
|
*/
|
|
public function affectedRows() {
|
|
return mysql_affected_rows($this->dbConn);
|
|
}
|
|
|
|
function databaseError($msg, $errorLevel = E_USER_ERROR) {
|
|
// try to extract and format query
|
|
if(preg_match('/Couldn\'t run query: ([^\|]*)\|\s*(.*)/', $msg, $matches)) {
|
|
$formatter = new SQLFormatter();
|
|
$msg = "Couldn't run query: \n" . $formatter->formatPlain($matches[1]) . "\n\n" . $matches[2];
|
|
}
|
|
|
|
user_error($msg, $errorLevel);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A result-set from a MySQL database.
|
|
* @package sapphire
|
|
* @subpackage model
|
|
*/
|
|
class MySQLQuery extends Query {
|
|
/**
|
|
* The MySQLDatabase object that created this result set.
|
|
* @var MySQLDatabase
|
|
*/
|
|
private $database;
|
|
|
|
/**
|
|
* The internal MySQL 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 database The database object that created this query.
|
|
* @param handle the internal mysql handle that is points to the resultset.
|
|
*/
|
|
public function __construct(MySQLDatabase $database, $handle) {
|
|
$this->database = $database;
|
|
$this->handle = $handle;
|
|
parent::__construct();
|
|
}
|
|
|
|
public function __destroy() {
|
|
mysql_free_result($this->handle);
|
|
}
|
|
|
|
public function seek($row) {
|
|
return mysql_data_seek($this->handle, $row);
|
|
}
|
|
|
|
public function numRecords() {
|
|
return mysql_num_rows($this->handle);
|
|
}
|
|
|
|
public function nextRecord() {
|
|
// Coalesce rather than replace common fields.
|
|
if($data = mysql_fetch_row($this->handle)) {
|
|
foreach($data as $columnIdx => $value) {
|
|
$columnName = mysql_field_name($this->handle, $columnIdx);
|
|
// $value || !$ouput[$columnName] means that the *last* occurring value is shown
|
|
// !$ouput[$columnName] means that the *first* occurring value is shown
|
|
if(isset($value) || !isset($output[$columnName])) {
|
|
$output[$columnName] = $value;
|
|
}
|
|
}
|
|
return $output;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
}
|
|
|
|
?>
|