MDL-71463 dml: escape square brackets for SQL Server LIKE operator.

This commit is contained in:
Paul Holden 2021-04-28 21:36:07 +01:00
parent a5f0b354e7
commit 586cc05bce
2 changed files with 60 additions and 0 deletions

View File

@ -1408,6 +1408,25 @@ class sqlsrv_native_moodle_database extends moodle_database {
return "$fieldname COLLATE $collation $LIKE $param ESCAPE '$escapechar'";
}
/**
* Escape common SQL LIKE special characters like '_' or '%', plus '[' & ']' which are also supported in SQL Server
*
* Note that '^' and '-' also have meaning within a LIKE, but only when enclosed within square brackets. As this syntax
* is not supported on all databases and the brackets are always escaped, we don't need special handling of them
*
* @param string $text
* @param string $escapechar
* @return string
*/
public function sql_like_escape($text, $escapechar = '\\') {
$text = parent::sql_like_escape($text, $escapechar);
$text = str_replace('[', $escapechar . '[', $text);
$text = str_replace(']', $escapechar . ']', $text);
return $text;
}
public function sql_concat() {
$arr = func_get_args();

View File

@ -4141,6 +4141,47 @@ EOD;
// $this->assertEquals(3, count($records), 'Accent insensitive LIKE searches may not be supported in all databases, this is not a problem.');
}
/**
* Test DML libraries sql_like_escape method
*/
public function test_sql_like_escape(): void {
$DB = $this->tdb;
$dbman = $DB->get_manager();
$table = $this->get_test_table();
$table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
$table->add_key('primary', XMLDB_KEY_PRIMARY, ['id']);
$dbman->create_table($table);
$tablename = $table->getName();
// Two of the records contain LIKE characters (%_), plus square brackets supported only by SQL Server (and '^-' which
// should be ignored by SQL Server given they only have meaning inside square brackets).
$DB->insert_record($tablename, (object) ['name' => 'lionel']);
$DB->insert_record($tablename, (object) ['name' => 'lionel%_^-[0]']);
$DB->insert_record($tablename, (object) ['name' => 'rick']);
$DB->insert_record($tablename, (object) ['name' => 'rick%_^-[0]']);
$select = $DB->sql_like('name', ':namelike');
$params = ['namelike' => '%' . $DB->sql_like_escape('%_^-[0]')];
// All drivers should return our two records containing wildcard characters.
$this->assertEqualsCanonicalizing([
'lionel%_^-[0]',
'rick%_^-[0]',
], $DB->get_fieldset_select($tablename, 'name', $select, $params));
// Test for unbalanced brackets.
$select = $DB->sql_like('name', ':namelike');
$params = ['namelike' => '%' . $DB->sql_like_escape('[') . '%'];
$this->assertEqualsCanonicalizing([
'lionel%_^-[0]',
'rick%_^-[0]',
], $DB->get_fieldset_select($tablename, 'name', $select, $params));
}
public function test_coalesce() {
$DB = $this->tdb;