Fix context aware mode getting disabled when upgrading remotely.

muzzwood · muzzwood · commit 2ad482084c87 · 2022-09-16T11:02:02.000+08:00
diff --git a/_build/build.transport.php b/_build/build.transport.php
@@ -23,7 +23,7 @@ function getSnippetContent($filename = '') {
     /* define version */
     define('PKG_NAME','ClientConfig');
     define('PKG_NAME_LOWER',strtolower(PKG_NAME));
-    define('PKG_VERSION','2.3.2');
+    define('PKG_VERSION','2.3.3');
     define('PKG_RELEASE','pl');
 
     /* load modx */
diff --git a/_build/resolvers/setupoptions.resolver.php b/_build/resolvers/setupoptions.resolver.php
@@ -1,14 +1,19 @@
 <?php
-
+/**
+ * @var array $options
+ */
 // Convenience
 if (!isset($modx) && isset($object) && isset($object->xpdo)) {
     $modx = $object->xpdo;
 }
 
+// Check if the setup options form was submitted
+$isSetupOptions = array_key_exists('clientconfig_setup_options', $options);
 $contextAware = array_key_exists('clientconfig_context_aware', $options) ? (bool)$options['clientconfig_context_aware'] : false;
 
-$setting = $modx->getObject('modSystemSetting', ['key' => 'clientconfig.context_aware']);
-if ($setting instanceof modSystemSetting) {
+$setting = $modx->getObject(modSystemSetting::class, ['key' => 'clientconfig.context_aware']);
+// Only update context aware value if set via setup options. Remote upgrades should keep the setting as is.
+if ($setting instanceof modSystemSetting && $isSetupOptions) {
     $setting->set('value', $contextAware);
     $setting->save();
 }
diff --git a/_build/setup.options.php b/_build/setup.options.php
@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * @var modX $modx
+ * @var array $options
+ */
 switch ($options[xPDOTransport::PACKAGE_ACTION]) {
     case xPDOTransport::ACTION_INSTALL:
     case xPDOTransport::ACTION_UPGRADE:
@@ -9,6 +12,7 @@
         $contextChecked = $isContextAware ? 'checked="checked"' : '';
 
         return <<<HTML
+<input type="hidden" name="clientconfig_setup_options" value="1">
 <p>ClientConfig 2.0 comes in two different flavours: global, and multi context mode. </p>
 <br>
 <ul style="list-style: disc; padding-left: 2em; padding-bottom: 1em;">
diff --git a/_packages/clientconfig-2.3.3-pl.transport.zip b/_packages/clientconfig-2.3.3-pl.transport.zip
diff --git a/core/components/clientconfig/docs/changelog.txt b/core/components/clientconfig/docs/changelog.txt
@@ -1,3 +1,9 @@
+ClientConfig 2.3.3-pl
+---------------------
+Released on 2022-09-
+
+- Fix context aware mode being disabled when upgrading remotely. [#177]
+
 ClientConfig 2.3.2-pl
 ---------------------
 Released on 2022-07-15
