mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-21 00:12:56 +02:00
Code Issues Projects Releases Wiki Activity

MDL-67167 block: Force returned configuration values to be JSON encoded

Browse Source 
Contributed plugins may set non-scalar values as valid instance configuration values (the core RSS client block does the same)
This commit is contained in:
Juan Leyva 2019-11-07 13:29:52 +01:00
parent 01aa126848
commit ff490afbff
2 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
blocks/classes/external.php
View File

@ -71,7 +71,7 @@ class core_block_external extends external_api {
new external_single_structure(
array(
'name' => new external_value(PARAM_RAW, 'Name.'),
'value' => new external_value(PARAM_RAW, 'Value.'),
'value' => new external_value(PARAM_RAW, 'JSON encoded representation of the config value.'),
'type' => new external_value(PARAM_ALPHA, 'Type (instance or plugin).'),
)
),
@ -125,7 +125,7 @@ class core_block_external extends external_api {
foreach ((array) $data as $name => $value) {
$block['configs'][] = [
'name' => $name,
'value' => $value,
'value' => json_encode($value), // Always JSON encode, we may receive non-scalar values.
'type' => $type,
];
}

19
blocks/tests/externallib_test.php
View File

@ -177,6 +177,9 @@ class core_block_externallib_testcase extends externallib_advanced_testcase {
$blocks = $page->blocks->get_blocks_for_region($page->blocks->get_default_region());
$block = end($blocks);
$block = block_instance('html', $block->instance);
$nonscalar = [
'something' => true,
];
$configdata = (object) [
'title' => $title,
'text' => [
@ -184,6 +187,7 @@ class core_block_externallib_testcase extends externallib_advanced_testcase {
'text' => $body,
'format' => $bodyformat,
],
'nonscalar' => $nonscalar
];
$block->instance_config_save((object) $configdata);
$filename = 'img.png';
@ -215,17 +219,20 @@ class core_block_externallib_testcase extends externallib_advanced_testcase {
$this->assertEquals($newblock, $result['blocks'][0]['name']);
$configcounts = 0;
foreach ($result['blocks'][0]['configs'] as $config) {
if ($config['type'] = 'plugin' && $config['name'] == 'allowcssclasses' && $config['value'] == 0) {
if ($config['type'] = 'plugin' && $config['name'] == 'allowcssclasses' && $config['value'] == json_encode('0')) {
$configcounts++;
} else if ($config['type'] = 'instance' && $config['name'] == 'text' && $config['value'] == $body) {
} else if ($config['type'] = 'instance' && $config['name'] == 'text' && $config['value'] == json_encode($body)) {
$configcounts++;
} else if ($config['type'] = 'instance' && $config['name'] == 'title' && $config['value'] == $title) {
} else if ($config['type'] = 'instance' && $config['name'] == 'title' && $config['value'] == json_encode($title)) {
$configcounts++;
} else if ($config['type'] = 'instance' && $config['name'] == 'format' && $config['value'] == 0) {
} else if ($config['type'] = 'instance' && $config['name'] == 'format' && $config['value'] == json_encode('0')) {
$configcounts++;
} else if ($config['type'] = 'instance' && $config['name'] == 'nonscalar' &&
$config['value'] == json_encode($nonscalar)) {
$configcounts++;
}
}
$this->assertEquals(4, $configcounts);
$this->assertEquals(5, $configcounts);
}
/**
@ -261,7 +268,7 @@ class core_block_externallib_testcase extends externallib_advanced_testcase {
// Check the configuration returned for this default block.
if ($block['name'] == 'recentlyaccessedcourses') {
$this->assertEquals('displaycategories', $block['configs'][0]['name']);
$this->assertEquals(0, $block['configs'][0]['value']);
$this->assertEquals(json_encode('0'), $block['configs'][0]['value']);
$this->assertEquals('plugin', $block['configs'][0]['type']);
}
}