Skip to content

Commit

Permalink
MDL-43896 admin: Fail validation of plugins with $module in version.php
Browse files Browse the repository at this point in the history
  • Loading branch information
@mudrd8mz
mudrd8mz committed Aug 31, 2015
1 parent 01889f0 commit f5f5a60
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 27 deletions.
40 changes: 16 additions & 24 deletions admin/tool/installaddon/classes/validator.php
View file
Expand Up @@ -300,38 +300,30 @@ protected function validate_version_php() {
$this->versionphp = array();
$info = $this->parse_version_php($fullpath);

if ($this->assertions['plugintype'] === 'mod') {
$type = 'module';
} else {
$type = 'plugin';
if (isset($info['module->version'])) {
$this->add_message(self::ERROR, 'versionphpsyntax', '$module');
return false;
}

if (!isset($info[$type.'->version'])) {
if ($type === 'module' and isset($info['plugin->version'])) {
// Expect the activity module using $plugin in version.php instead of $module.
$type = 'plugin';
$this->versionphp['version'] = $info[$type.'->version'];
$this->add_message(self::INFO, 'pluginversion', $this->versionphp['version']);
} else {
$this->add_message(self::ERROR, 'missingversion');
return false;
}
} else {
$this->versionphp['version'] = $info[$type.'->version'];
if (isset($info['plugin->version'])) {
$this->versionphp['version'] = $info['plugin->version'];
$this->add_message(self::INFO, 'pluginversion', $this->versionphp['version']);
} else {
$this->add_message(self::ERROR, 'missingversion');
return false;
}

if (isset($info[$type.'->requires'])) {
$this->versionphp['requires'] = $info[$type.'->requires'];
if (isset($info['plugin->requires'])) {
$this->versionphp['requires'] = $info['plugin->requires'];
if ($this->versionphp['requires'] > $this->assertions['moodleversion']) {
$this->add_message(self::ERROR, 'requiresmoodle', $this->versionphp['requires']);
return false;
}
$this->add_message(self::INFO, 'requiresmoodle', $this->versionphp['requires']);
}

if (isset($info[$type.'->component'])) {
$this->versionphp['component'] = $info[$type.'->component'];
if (isset($info['plugin->component'])) {
$this->versionphp['component'] = $info['plugin->component'];
list($reqtype, $reqname) = core_component::normalize_component($this->versionphp['component']);
if ($reqtype !== $this->assertions['plugintype']) {
$this->add_message(self::ERROR, 'componentmismatchtype', array(
Expand All @@ -346,17 +338,17 @@ protected function validate_version_php() {
$this->add_message(self::INFO, 'componentmatch', $this->versionphp['component']);
}

if (isset($info[$type.'->maturity'])) {
$this->versionphp['maturity'] = $info[$type.'->maturity'];
if (isset($info['plugin->maturity'])) {
$this->versionphp['maturity'] = $info['plugin->maturity'];
if ($this->versionphp['maturity'] === 'MATURITY_STABLE') {
$this->add_message(self::INFO, 'maturity', $this->versionphp['maturity']);
} else {
$this->add_message(self::WARNING, 'maturity', $this->versionphp['maturity']);
}
}

if (isset($info[$type.'->release'])) {
$this->versionphp['release'] = $info[$type.'->release'];
if (isset($info['plugin->release'])) {
$this->versionphp['release'] = $info['plugin->release'];
$this->add_message(self::INFO, 'release', $this->versionphp['release']);
}

Expand Down
1 change: 1 addition & 0 deletions admin/tool/installaddon/lang/en/tool_installaddon.php
View file
Expand Up @@ -91,6 +91,7 @@
$string['validationmsg_targetexists'] = 'Target location already exists';
$string['validationmsg_targetexists_help'] = 'The directory that the plugin is to be installed to must not yet exist.';
$string['validationmsg_unknowntype'] = 'Unknown plugin type';
$string['validationmsg_versionphpsyntax'] = 'Unsupported syntax detected in version.php file';
$string['validationmsglevel_debug'] = 'Debug';
$string['validationmsglevel_error'] = 'Error';
$string['validationmsglevel_info'] = 'OK';
Expand Down
1 change: 0 additions & 1 deletion admin/tool/installaddon/tests/fixtures/nolang/bah/version.php
View file
@@ -1,4 +1,3 @@
<?php

$module->version = 2014122455;
$plugin->version = 2014122455;
2 changes: 0 additions & 2 deletions admin/tool/installaddon/tests/fixtures/plugindir/foobar/version.php
View file
@@ -1,9 +1,7 @@
<?php

$module->version = 10; // Ignored, this should use $plugin
$plugin->version = 2013031900;
$plugin->component = 'local_foobar';
$plugin->requires = 2013031200;
$module->release = 'We are not an activity module!';
$plugin->maturity = MATURITY_ALPHA;
//$plugin->release = 'And this is commented';
3 changes: 3 additions & 0 deletions admin/tool/installaddon/tests/fixtures/plugindir/legacymod/lang/en/legacymod.php
View file
@@ -0,0 +1,3 @@
<?php

$string['modulename'] = 'Legacy activity module with $module in version.php';
4 changes: 4 additions & 0 deletions admin/tool/installaddon/tests/fixtures/plugindir/legacymod/version.php
View file
@@ -0,0 +1,4 @@
<?php

// Support for the $module has been dropped in Moodle 3.0.
$module->version = 2013031900;
11 changes: 11 additions & 0 deletions admin/tool/installaddon/tests/validator_test.php
View file
Expand Up @@ -134,6 +134,17 @@ public function test_validate_version_php() {
$this->assertFalse($validator->execute());
$this->assertTrue($this->has_message($validator->get_messages(), $validator::ERROR, 'missingversionphp'));

$validator = testable_tool_installaddon_validator::instance($fixtures.'/plugindir', array(
'legacymod/' => true,
'legacymod/version.php' => true,
'legacymod/lang/' => true,
'legacymod/lang/en/' => true,
'legacymod/lang/en/legacymod.php' => true));
$validator->assert_plugin_type('mod');
$validator->assert_moodle_version(0);
$this->assertFalse($validator->execute());
$this->assertTrue($this->has_message($validator->get_messages(), $validator::ERROR, 'versionphpsyntax', '$module'));

$validator = testable_tool_installaddon_validator::instance($fixtures.'/plugindir', array(
'foobar/' => true,
'foobar/version.php' => true,
Expand Down

0 comments on commit f5f5a60

Please sign in to comment.