mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-03 23:42:39 +02:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-58584-master' of git://github.com/rezaies/moodle

Browse Source
This commit is contained in:
Andrew Nicols 2020-02-04 10:30:32 +08:00
commit 5f21e45f9f
15 changed files with 143 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/ddl/database_manager.php
View File

@ -330,6 +330,8 @@ class database_manager {
throw new ddl_exception('ddlunknownerror', null, 'table drop sql not generated');
}
$this->execute_sql_arr($sqlarr, array($xmldb_table->getName()));
$this->generator->cleanup_after_drop($xmldb_table);
}
/**

15
lib/ddl/mssql_sql_generator.php
View File

@ -183,21 +183,6 @@ class mssql_sql_generator extends sql_generator {
return $sqlarr;
}
/**
* Given one correct xmldb_table, returns the SQL statements
* to drop it (inside one array).
*
* @param xmldb_table $xmldb_table The table to drop.
* @return array SQL statement(s) for dropping the specified table.
*/
public function getDropTableSQL($xmldb_table) {
$sqlarr = parent::getDropTableSQL($xmldb_table);
if ($this->temptables->is_temptable($xmldb_table->getName())) {
$this->temptables->delete_temptable($xmldb_table->getName());
}
return $sqlarr;
}
/**
* Given one XMLDB Type, length and decimals, returns the DB proper SQL type.
*

1
lib/ddl/mysql_sql_generator.php
View File

@ -384,7 +384,6 @@ class mysql_sql_generator extends sql_generator {
$sqlarr = parent::getDropTableSQL($xmldb_table);
if ($this->temptables->is_temptable($xmldb_table->getName())) {
$sqlarr = preg_replace('/^DROP TABLE/', "DROP TEMPORARY TABLE", $sqlarr);
$this->temptables->delete_temptable($xmldb_table->getName());
}
return $sqlarr;
}

1
lib/ddl/oracle_sql_generator.php
View File

@ -211,7 +211,6 @@ class oracle_sql_generator extends sql_generator {
$sqlarr = parent::getDropTableSQL($xmldb_table);
if ($this->temptables->is_temptable($xmldb_table->getName())) {
array_unshift($sqlarr, "TRUNCATE TABLE ". $this->getTableName($xmldb_table)); // oracle requires truncate before being able to drop a temp table
$this->temptables->delete_temptable($xmldb_table->getName());
}
return $sqlarr;
}

15
lib/ddl/postgres_sql_generator.php
View File

@ -103,21 +103,6 @@ class postgres_sql_generator extends sql_generator {
return $sqlarr;
}
/**
* Given one correct xmldb_table, returns the SQL statements
* to drop it (inside one array).
*
* @param xmldb_table $xmldb_table The table to drop.
* @return array SQL statement(s) for dropping the specified table.
*/
public function getDropTableSQL($xmldb_table) {
$sqlarr = parent::getDropTableSQL($xmldb_table);
if ($this->temptables->is_temptable($xmldb_table->getName())) {
$this->temptables->delete_temptable($xmldb_table->getName());
}
return $sqlarr;
}
/**
* Given one correct xmldb_index, returns the SQL statements
* needed to create it (in array).

13
lib/ddl/sql_generator.php
View File

@ -653,7 +653,7 @@ abstract class sql_generator {
}
/**
* Given one correct xmldb_table and the new name, returns the SQL statements
* Given one correct xmldb_table, returns the SQL statements
* to drop it (inside one array). Works also for temporary tables.
*
* @param xmldb_table $xmldb_table The table to drop.
@ -674,6 +674,17 @@ abstract class sql_generator {
return $results;
}
/**
* Performs any clean up that needs to be done after a table is dropped.
*
* @param xmldb_table $table
*/
public function cleanup_after_drop(xmldb_table $table): void {
if ($this->temptables->is_temptable($table->getName())) {
$this->temptables->delete_temptable($table->getName());
}
}
/**
* Given one xmldb_table and one xmldb_field, return the SQL statements needed to add the field to the table.
*

68
lib/ddl/tests/ddl_test.php
View File

@ -1828,6 +1828,74 @@ class core_ddl_testcase extends database_driver_testcase {
$this->assertFalse($dbman->table_exists('test_table1'));
}
/**
* get_columns should return an empty array for ex-temptables.
*/
public function test_leftover_temp_tables_columns() {
$DB = $this->tdb; // Do not use global $DB!
$dbman = $this->tdb->get_manager();
// Create temp table0.
$table0 = $this->tables['test_table0'];
$dbman->create_temp_table($table0);
$dbman->drop_table($table0);
// Get columns and perform some basic tests.
$columns = $DB->get_columns('test_table0');
$this->assertEquals([], $columns);
}
/**
* Deleting a temp table should not purge the whole cache
*/
public function test_leftover_temp_tables_cache() {
$DB = $this->tdb; // Do not use global $DB!
$dbman = $this->tdb->get_manager();
// Create 2 temp tables.
$table0 = $this->tables['test_table0'];
$dbman->create_temp_table($table0);
$table1 = $this->tables['test_table1'];
$dbman->create_temp_table($table1);
// Create a normal table.
$table2 = new xmldb_table ('test_table2');
$table2->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table2->add_field('course', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
$table2->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
$table2->setComment("This is a test'n drop table. You can drop it safely");
$this->tables[$table2->getName()] = $table2;
$dbman->create_table($table2);
// Get columns for the tables, so that relevant caches are populated with their data.
$DB->get_columns('test_table0');
$DB->get_columns('test_table1');
$DB->get_columns('test_table2');
$dbman->drop_table($table0);
$rc = new ReflectionClass('moodle_database');
$rcm = $rc->getMethod('get_temp_tables_cache');
$rcm->setAccessible(true);
$metacachetemp = $rcm->invokeArgs($DB, []);
// Data of test_table0 should be removed from the cache.
$this->assertEquals(false, $metacachetemp->has('test_table0'));
// Data of test_table1 should be intact.
$this->assertEquals(true, $metacachetemp->has('test_table1'));
$rc = new ReflectionClass('moodle_database');
$rcm = $rc->getMethod('get_metacache');
$rcm->setAccessible(true);
$metacache = $rcm->invokeArgs($DB, []);
// Data of test_table2 should be intact.
$this->assertEquals(true, $metacache->has('test_table2'));
}
public function test_reset_sequence() {
$DB = $this->tdb;
$dbman = $DB->get_manager();

39
lib/dml/moodle_database.php
View File

@ -1094,11 +1094,48 @@ abstract class moodle_database {
/**
* Returns detailed information about columns in table. This information is cached internally.
*
* @param string $table The table's name.
* @param bool $usecache Flag to use internal cacheing. The default is true.
* @return database_column_info[] of database_column_info objects indexed with column names
*/
public abstract function get_columns($table, $usecache=true);
public function get_columns($table, $usecache = true): array {
if (!$table) { // Table not specified, return empty array directly.
return [];
}
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
if ($data = $this->get_temp_tables_cache()->get($table)) {
return $data;
}
} else {
if ($data = $this->get_metacache()->get($table)) {
return $data;
}
}
}
$structure = $this->fetch_columns($table);
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
$this->get_temp_tables_cache()->set($table, $structure);
} else {
$this->get_metacache()->set($table, $structure);
}
}
return $structure;
}
/**
* Returns detailed information about columns in table. This information is cached internally.
*
* @param string $table The table's name.
* @return database_column_info[] of database_column_info objects indexed with column names
*/
protected abstract function fetch_columns(string $table): array;
/**
* Normalise values based on varying RDBMS's dependencies (booleans, LOBs...)

26
lib/dml/mysqli_native_moodle_database.php
View File

@ -700,24 +700,12 @@ class mysqli_native_moodle_database extends moodle_database {
}
/**
* Returns detailed information about columns in table. This information is cached internally.
* Fetches detailed information about columns in table.
*
* @param string $table name
* @param bool $usecache
* @return database_column_info[] array of database_column_info objects indexed with column names
*/
public function get_columns($table, $usecache=true) {
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
if ($data = $this->get_temp_tables_cache()->get($table)) {
return $data;
}
} else {
if ($data = $this->get_metacache()->get($table)) {
return $data;
}
}
}
protected function fetch_columns(string $table): array {
$structure = array();
$sql = "SELECT column_name, data_type, character_maximum_length, numeric_precision,
@ -821,14 +809,6 @@ class mysqli_native_moodle_database extends moodle_database {
$result->close();
}
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
$this->get_temp_tables_cache()->set($table, $structure);
} else {
$this->get_metacache()->set($table, $structure);
}
}
return $structure;
}

31
lib/dml/oci_native_moodle_database.php
View File

@ -468,29 +468,12 @@ class oci_native_moodle_database extends moodle_database {
}
/**
* Returns detailed information about columns in table. This information is cached internally.
* Fetches detailed information about columns in table.
*
* @param string $table name
* @param bool $usecache
* @return array array of database_column_info objects indexed with column names
*/
public function get_columns($table, $usecache=true) {
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
if ($data = $this->get_temp_tables_cache()->get($table)) {
return $data;
}
} else {
if ($data = $this->get_metacache()->get($table)) {
return $data;
}
}
}
if (!$table) { // table not specified, return empty array directly
return array();
}
protected function fetch_columns(string $table): array {
$structure = array();
// We give precedence to CHAR_LENGTH for VARCHAR2 columns over WIDTH because the former is always
@ -673,14 +656,6 @@ class oci_native_moodle_database extends moodle_database {
$structure[$info->name] = new database_column_info($info);
}
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
$this->get_temp_tables_cache()->set($table, $structure);
} else {
$this->get_metacache()->set($table, $structure);
}
}
return $structure;
}

26
lib/dml/pgsql_native_moodle_database.php
View File

@ -388,24 +388,12 @@ class pgsql_native_moodle_database extends moodle_database {
}
/**
* Returns detailed information about columns in table. This information is cached internally.
* Returns detailed information about columns in table.
*
* @param string $table name
* @param bool $usecache
* @return database_column_info[] array of database_column_info objects indexed with column names
*/
public function get_columns($table, $usecache=true) {
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
if ($data = $this->get_temp_tables_cache()->get($table)) {
return $data;
}
} else {
if ($data = $this->get_metacache()->get($table)) {
return $data;
}
}
}
protected function fetch_columns(string $table): array {
$structure = array();
$tablename = $this->prefix.$table;
@ -605,14 +593,6 @@ class pgsql_native_moodle_database extends moodle_database {
pg_free_result($result);
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
$this->get_temp_tables_cache()->set($table, $structure);
} else {
$this->get_metacache()->set($table, $structure);
}
}
return $structure;
}

27
lib/dml/sqlite3_pdo_moodle_database.php
View File

@ -193,25 +193,12 @@ class sqlite3_pdo_moodle_database extends pdo_moodle_database {
}
/**
* Returns detailed information about columns in table. This information is cached internally.
* Returns detailed information about columns in table.
*
* @param string $table name
* @param bool $usecache
* @return array array of database_column_info objects indexed with column names
*/
public function get_columns($table, $usecache=true) {
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
if ($data = $this->get_temp_tables_cache()->get($table)) {
return $data;
}
} else {
if ($data = $this->get_metacache()->get($table)) {
return $data;
}
}
}
protected function fetch_columns(string $table): array {
$structure = array();
// get table's CREATE TABLE command (we'll need it for autoincrement fields)
@ -303,14 +290,6 @@ class sqlite3_pdo_moodle_database extends pdo_moodle_database {
$structure[$columninfo['name']] = new database_column_info($columninfo);
}
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
$this->get_temp_tables_cache()->set($table, $structure);
} else {
$this->get_metacache()->set($table, $structure);
}
}
return $structure;
}

30
lib/dml/sqlsrv_native_moodle_database.php
View File

@ -108,7 +108,7 @@ class sqlsrv_native_moodle_database extends moodle_database {
return 'mssql';
}
/**
/**
* Returns more specific database driver type
* Note: can be used before connect()
* @return string db type mysqli, pgsql, oci, mssql, sqlsrv
@ -117,7 +117,7 @@ class sqlsrv_native_moodle_database extends moodle_database {
return 'sqlsrv';
}
/**
/**
* Returns general database library name
* Note: can be used before connect()
* @return string db type pdo, native
@ -534,24 +534,12 @@ class sqlsrv_native_moodle_database extends moodle_database {
}
/**
* Returns detailed information about columns in table. This information is cached internally.
* Returns detailed information about columns in table.
*
* @param string $table name
* @param bool $usecache
* @return array array of database_column_info objects indexed with column names
*/
public function get_columns($table, $usecache = true) {
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
if ($data = $this->get_temp_tables_cache()->get($table)) {
return $data;
}
} else {
if ($data = $this->get_metacache()->get($table)) {
return $data;
}
}
}
protected function fetch_columns(string $table): array {
$structure = array();
if (!$this->temptables->is_temptable($table)) { // normal table, get metadata from own schema
@ -642,14 +630,6 @@ class sqlsrv_native_moodle_database extends moodle_database {
}
$this->free_result($result);
if ($usecache) {
if ($this->temptables->is_temptable($table)) {
$this->get_temp_tables_cache()->set($table, $structure);
} else {
$this->get_metacache()->set($table, $structure);
}
}
return $structure;
}

4
lib/dml/tests/dml_test.php
View File

@ -5712,7 +5712,9 @@ class moodle_database_for_testing extends moodle_database {
public function get_last_error() {}
public function get_tables($usecache=true) {}
public function get_indexes($table) {}
public function get_columns($table, $usecache=true) {}
protected function fetch_columns(string $table): array {
return [];
}
protected function normalise_value($column, $value) {}
public function set_debug($state) {}
public function get_debug() {}

3
lib/upgrade.txt
View File

@ -29,6 +29,9 @@ information provided here is intended especially for developers.
- mod_assign
- mod_quiz
* Added a native MySQL / MariaDB lock implementation
* The database drivers (moodle_database and subclasses) don't need to implement get_columns() anymore.
They have to implement fetch_columns instead.
* Added function cleanup_after_drop to the database_manager class to take care of all the cleanups that need to be done after a table is dropped.
=== 3.8 ===
* Add CLI option to notify all cron tasks to stop: admin/cli/cron.php --stop