L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'MDL-74165' of https://github.com/paulholden/moodle

Browse Source
This commit is contained in:
Ilya Tregubov
2022-05-19 08:02:17 +06:00
parent 7cda6e3641 bc206fdec3
commit 938e8cf5d5
6 changed files with 121 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
reportbuilder/classes/local/filters/date.php
+3 -3
View File
@@ -199,10 +199,10 @@ class date extends base {
return ['', []];
}
$paramdatefrom = database::generate_param_name();
$paramdateto = database::generate_param_name();
// Generate parameters and SQL clause for the relative date comparison.
[$paramdatefrom, $paramdateto] = database::generate_param_names(2);
$sql = "{$fieldsql} >= :{$paramdatefrom} AND {$fieldsql} <= :{$paramdateto}";
[
$params[$paramdatefrom],
$params[$paramdateto],
reportbuilder/classes/local/filters/number.php
+2 -2
View File
@@ -123,8 +123,8 @@ class number extends base {
return ['', []];
}
$param = database::generate_param_name();
$param2 = database::generate_param_name();
[$param, $param2] = database::generate_param_names(2);
$fieldsql = $this->filter->get_field_sql();
$params = $this->filter->get_field_params();
reportbuilder/classes/local/helpers/database.php
+25
View File
@@ -46,6 +46,19 @@ class database {
return static::GENERATE_ALIAS_PREFIX . ($aliascount++);
}
/**
* Generate multiple unique table/column aliases, see {@see generate_alias} for info
*
* @param int $count
* @return string[]
*/
public static function generate_aliases(int $count): array {
return array_map([
static::class, 'generate_alias'
], array_fill(0, $count, null));
}
/**
* Generates unique parameter name that must be used in generated SQL
*
@@ -57,6 +70,18 @@ class database {
return static::GENERATE_PARAM_PREFIX . ($paramcount++);
}
/**
* Generate multiple unique parameter names, see {@see generate_param_name} for info
*
* @param int $count
* @return string[]
*/
public static function generate_param_names(int $count): array {
return array_map([
static::class, 'generate_param_name'
], array_fill(0, $count, null));
}
/**
* Validate that parameter names were generated using {@see generate_param_name}.
*
reportbuilder/classes/reportbuilder/audience/systemrole.php
+7 -7
View File
@@ -57,17 +57,17 @@ class systemrole extends base {
$prefix = database::generate_param_name() . '_';
[$insql, $inparams] = $DB->get_in_or_equal($roles, SQL_PARAMS_NAMED, $prefix);
$contextid = database::generate_param_name();
$ra = database::generate_alias();
$ctx = database::generate_alias();
// Ensure parameter names and aliases are unique, as the same audience type can be added multiple times to a report.
$paramcontextid = database::generate_param_name();
[$roleassignments, $context] = database::generate_aliases(2);
$join = "
JOIN {role_assignments} {$ra} ON {$ra}.userid = {$usertablealias}.id
JOIN {context} {$ctx} ON {$ctx}.id = {$ra}.contextid";
JOIN {role_assignments} {$roleassignments} ON {$roleassignments}.userid = {$usertablealias}.id
JOIN {context} {$context} ON {$context}.id = {$roleassignments}.contextid";
$where = "{$ra}.contextid = :{$contextid} AND {$ra}.roleid {$insql}";
$where = "{$roleassignments}.contextid = :{$paramcontextid} AND {$roleassignments}.roleid {$insql}";
return [$join, $where, $inparams + [$contextid => context_system::instance()->id]];
return [$join, $where, $inparams + [$paramcontextid => context_system::instance()->id]];
}
/**
reportbuilder/tests/local/helpers/database_test.php
+82 -21
View File
@@ -33,41 +33,67 @@ use core_user;
class database_test extends advanced_testcase {
/**
* Test generating table alias and parameter names
* Test generating alias
*/
public function test_generate_alias_params(): void {
global $DB;
public function test_generate_alias(): void {
$this->assertMatchesRegularExpression('/^rbalias(\d+)$/', database::generate_alias());
}
$admin = core_user::get_user_by_username('admin');
/**
* Test generating multiple aliases
*/
public function test_generate_aliases(): void {
$aliases = database::generate_aliases(3);
$usertablealias = database::generate_alias();
$usertablealiasjoin = database::generate_alias();
$useridalias = database::generate_alias();
$paramuserid = database::generate_param_name();
$paramuserdeleted = database::generate_param_name();
$this->assertCount(3, $aliases);
[$aliasone, $aliastwo, $aliasthree] = $aliases;
// Ensure they are different.
$this->assertNotEquals($usertablealias, $usertablealiasjoin);
$this->assertNotEquals($paramuserid, $paramuserdeleted);
$this->assertNotEquals($aliasone, $aliastwo);
$this->assertNotEquals($aliasone, $aliasthree);
$this->assertNotEquals($aliastwo, $aliasthree);
}
$sql = "SELECT {$usertablealias}.id AS {$useridalias}
FROM {user} {$usertablealias}
JOIN {user} {$usertablealiasjoin} ON {$usertablealiasjoin}.id = {$usertablealias}.id
WHERE {$usertablealias}.id = :{$paramuserid} AND {$usertablealias}.deleted = :{$paramuserdeleted}";
$params = [$paramuserid => $admin->id, $paramuserdeleted => 0];
/**
* Test generating parameter name
*/
public function test_generate_param_name(): void {
$this->assertMatchesRegularExpression('/^rbparam(\d+)$/', database::generate_param_name());
}
$validated = database::validate_params($params);
$this->assertTrue($validated);
/**
* Test generating multiple parameter names
*/
public function test_generate_param_names(): void {
$params = database::generate_param_names(3);
$record = $DB->get_record_sql($sql, $params);
$this->assertEquals($admin->id, $record->{$useridalias});
$this->assertCount(3, $params);
[$paramone, $paramtwo, $paramthree] = $params;
// Ensure they are different.
$this->assertNotEquals($paramone, $paramtwo);
$this->assertNotEquals($paramone, $paramthree);
$this->assertNotEquals($paramtwo, $paramthree);
}
/**
* Test parameter validation
*/
public function test_validate_params(): void {
[$paramone, $paramtwo] = database::generate_param_names(2);
$params = [
$paramone => 1,
$paramtwo => 2,
];
$this->assertTrue(database::validate_params($params));
}
/**
* Test parameter validation for invalid parameters
*/
public function test_validate_params_invalid(): void {
$params = [
database::generate_param_name() => 1,
'invalidfoo' => 2,
@@ -78,4 +104,39 @@ class database_test extends advanced_testcase {
$this->expectExceptionMessage('Invalid parameter names (invalidfoo, invalidbar)');
database::validate_params($params);
}
/**
* Generate aliases and parameters and confirm they can be used within a query
*/
public function test_generated_data_in_query(): void {
global $DB;
// Unique aliases.
[
$usertablealias,
$userfieldalias,
] = database::generate_aliases(2);
// Unique parameters.
[
$paramuserid,
$paramuserdeleted,
] = database::generate_param_names(2);
// Simple query to retrieve the admin user.
$sql = "SELECT {$usertablealias}.id AS {$userfieldalias}
FROM {user} {$usertablealias}
WHERE {$usertablealias}.id = :{$paramuserid}
AND {$usertablealias}.deleted = :{$paramuserdeleted}";
$admin = core_user::get_user_by_username('admin');
$params = [
$paramuserid => $admin->id,
$paramuserdeleted => 0,
];
$record = $DB->get_record_sql($sql, $params);
$this->assertEquals($admin->id, $record->{$userfieldalias});
}
}
reportbuilder/upgrade.txt
+2
View File
@@ -7,3 +7,5 @@ Information provided here is intended especially for developers.
* Added two new methods in the datasource class:
- add_all_from_entity() to add all columns/filters/conditions from the given entity to the report at once
- add_all_from_entities() to add all columns/filters/conditions from all the entities added to the report at once
=======
* New database helper methods for generating multiple unique values: `generate_aliases` and `generate_param_names`