From 7ace328737779cad938fca440f25a7261575721c Mon Sep 17 00:00:00 2001
From: Andrew Nicols <andrew@nicols.co.uk>
Date: Fri, 12 Sep 2014 15:13:46 +0800
Subject: [PATCH] MDL-47225 core: Add ability to normalize component names

---
 lib/classes/component.php    | 16 +++++++++++++++
 lib/tests/component_test.php | 38 ++++++++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)

diff --git a/lib/classes/component.php b/lib/classes/component.php
index fec31ec1474..f7b04545534 100644
--- a/lib/classes/component.php
+++ b/lib/classes/component.php
@@ -861,6 +861,22 @@ $cache = '.var_export($cache, true).';
         }
     }
 
+    /**
+     * Normalize the component name.
+     *
+     * Note: this does not verify the validity of the plugin or component.
+     *
+     * @param string $component
+     * @return string
+     */
+    public static function normalize_componentname($componentname) {
+        list($plugintype, $pluginname) = self::normalize_component($componentname);
+        if ($plugintype === 'core' && is_null($pluginname)) {
+            return $plugintype;
+        }
+        return $plugintype . '_' . $pluginname;
+    }
+
     /**
      * Normalize the component name using the "frankenstyle" rules.
      *
diff --git a/lib/tests/component_test.php b/lib/tests/component_test.php
index 2f57c457762..703e7dce653 100644
--- a/lib/tests/component_test.php
+++ b/lib/tests/component_test.php
@@ -225,6 +225,44 @@ class core_component_testcase extends advanced_testcase {
         $this->assertFalse(core_component::is_valid_plugin_name('tool', 'example__x1'));
     }
 
+    public function test_normalize_componentname() {
+        // Moodle core.
+        $this->assertSame('core', core_component::normalize_componentname('core'));
+        $this->assertSame('core', core_component::normalize_componentname('moodle'));
+        $this->assertSame('core', core_component::normalize_componentname(''));
+
+        // Moodle core subsystems.
+        $this->assertSame('core_admin', core_component::normalize_componentname('admin'));
+        $this->assertSame('core_admin', core_component::normalize_componentname('core_admin'));
+        $this->assertSame('core_admin', core_component::normalize_componentname('moodle_admin'));
+
+        // Activity modules and their subplugins.
+        $this->assertSame('mod_workshop', core_component::normalize_componentname('workshop'));
+        $this->assertSame('mod_workshop', core_component::normalize_componentname('mod_workshop'));
+        $this->assertSame('workshopform_accumulative', core_component::normalize_componentname('workshopform_accumulative'));
+        $this->assertSame('mod_quiz', core_component::normalize_componentname('quiz'));
+        $this->assertSame('quiz_grading', core_component::normalize_componentname('quiz_grading'));
+        $this->assertSame('mod_data', core_component::normalize_componentname('data'));
+        $this->assertSame('datafield_checkbox', core_component::normalize_componentname('datafield_checkbox'));
+
+        // Other plugin types.
+        $this->assertSame('auth_mnet', core_component::normalize_componentname('auth_mnet'));
+        $this->assertSame('enrol_self', core_component::normalize_componentname('enrol_self'));
+        $this->assertSame('block_html', core_component::normalize_componentname('block_html'));
+        $this->assertSame('block_mnet_hosts', core_component::normalize_componentname('block_mnet_hosts'));
+        $this->assertSame('local_amos', core_component::normalize_componentname('local_amos'));
+        $this->assertSame('local_admin', core_component::normalize_componentname('local_admin'));
+
+        // Unknown words without underscore are supposed to be activity modules.
+        $this->assertSame('mod_whoonearthwouldcomewithsuchastupidnameofcomponent',
+            core_component::normalize_componentname('whoonearthwouldcomewithsuchastupidnameofcomponent'));
+        // Module names can not contain underscores, this must be a subplugin.
+        $this->assertSame('whoonearth_wouldcomewithsuchastupidnameofcomponent',
+            core_component::normalize_componentname('whoonearth_wouldcomewithsuchastupidnameofcomponent'));
+        $this->assertSame('whoonearth_would_come_withsuchastupidnameofcomponent',
+            core_component::normalize_componentname('whoonearth_would_come_withsuchastupidnameofcomponent'));
+    }
+
     public function test_normalize_component() {
         // Moodle core.
         $this->assertSame(array('core', null), core_component::normalize_component('core'));