Fixed #3792

craftcms · Feb 21, 2019 · be381c8 · be381c8
1 parent f6f29d2
commit be381c8
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 22 deletions.
diff --git a/CHANGELOG-v3.md b/CHANGELOG-v3.md
@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+### Fixed
+- Fixed an error where the `dateModified` key was updated in project config when there was no point in doing that. ([#3792](https://github.com/craftcms/cms/issues/3792))
+
 ### Security
 - Fixed a bug where sensitive environment variable values weren’t getting redacted correctly.
 

diff --git a/src/helpers/ProjectConfig.php b/src/helpers/ProjectConfig.php
@@ -110,4 +110,33 @@ public static function ensureAllUserGroupsProcessed()
             }
         }
     }
+
+    /**
+     * Traverse and clean a config array, removing empty values and sorting keys.
+     *
+     * @param array $config Config array to clean
+     *
+     * @return array
+     */
+    public static function cleanupConfig(array $config) {
+        $remove = [];
+        foreach ($config as $key => &$value) {
+            if (\is_array($value)) {
+                $value = static::cleanupConfig($value);
+
+                if (empty($value)) {
+                    $remove[] = $key;
+                }
+            }
+        }
+
+        // Remove empty stuff
+        foreach ($remove as $removeKey) {
+            unset($config[$removeKey]);
+        }
+
+        ksort($config);
+
+        return $config;
+    }
 }
diff --git a/src/services/ProjectConfig.php b/src/services/ProjectConfig.php
@@ -14,12 +14,12 @@
 use craft\helpers\DateTimeHelper;
 use craft\helpers\FileHelper;
 use craft\helpers\Json;
+use craft\helpers\ProjectConfig as ProjectConfigHelper;
 use craft\helpers\Path as PathHelper;
 use Symfony\Component\Yaml\Yaml;
 use yii\base\Application;
 use yii\base\Component;
 use yii\base\ErrorException;
-use yii\base\Event;
 use yii\base\Exception;
 use yii\base\NotSupportedException;
 use yii\web\ServerErrorHttpException;
@@ -341,6 +341,10 @@ public function get(string $path = null, $getFromYaml = false)
      */
     public function set(string $path, $value)
     {
+        if (\is_array($value)) {
+            $value = ProjectConfigHelper::cleanupConfig($value);
+        }
+
         if ($value !== $this->get($path)) {
             if ($this->readOnly) {
                 throw new NotSupportedException('Changes to the project config are not possible while in read-only mode.');
@@ -585,38 +589,19 @@ public function updateParsedConfigTimes(): bool
      */
     public function saveModifiedConfigData()
     {
-        $traverseAndClean = function(&$array) use (&$traverseAndClean) {
-            $remove = [];
-            foreach ($array as $key => &$value) {
-                if (\is_array($value)) {
-                    $traverseAndClean($value);
-                    if (empty($value)) {
-                        $remove[] = $key;
-                    }
-                }
-            }
-
-            // Remove empty stuff
-            foreach ($remove as $removeKey) {
-                unset($array[$removeKey]);
-            }
-
-            ksort($array);
-        };
-
         if (!empty($this->_modifiedYamlFiles) && $this->_useConfigFile()) {
             // Save modified yaml files
 
             foreach (array_keys($this->_modifiedYamlFiles) as $filePath) {
                 $data = $this->_parsedConfigs[$filePath];
-                $traverseAndClean($data);
+                $data = ProjectConfigHelper::cleanupConfig($data);
                 FileHelper::writeToFile($filePath, Yaml::dump($data, 20, 2));
             }
         }
 
         if (($this->_updateConfigMap && $this->_useConfigFile()) || $this->_updateConfig) {
             $previousConfig = $this->_getStoredConfig();
-            $traverseAndClean($previousConfig);
+            $value = ProjectConfigHelper::cleanupConfig($previousConfig);
             $this->_storeYamlHistory($previousConfig);
 
             $info = Craft::$app->getInfo();