bug #54839 Fix exception thrown during LDAP_MODIFY_BATCH_REMOVE_ALL batch operations (phasdev)

fabpot · fabpot · commit ddf34899a9cf · 2024-05-04T19:13:16.000+02:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- Fix exception thrown during `LDAP_MODIFY_BATCH_REMOVE_ALL` batch operations | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #54829 | License | MIT Bugfix removes `values` array element for `LDAP_MODIFY_BATCH_REMOVE_ALL` operations. PHP throws an exception when this element is included. Testing this component is complicated by the fact that most tests are skipped unless there's a local LDAP server running. To create a test which demonstrated the issue and fix, I created a default GitHub Codespace and ran the attached shell commands. These commands install and configure a local OpenLDAP server. You'll probably need to do something similar to confirm the issue/fix. [setup-ldap-codespace.md](https://github.com/symfony/symfony/files/15208301/setup-ldap-codespace.md) Commits ------- 8ac1818 Fix exception thrown during `LDAP_MODIFY_BATCH_REMOVE_ALL` batch operations
diff --git a/src/Symfony/Component/Ldap/Adapter/ExtLdap/UpdateOperation.php b/src/Symfony/Component/Ldap/Adapter/ExtLdap/UpdateOperation.php
@@ -48,10 +48,15 @@ public function __construct(int $operationType, string $attribute, ?array $value
 
     public function toArray(): array
     {
-        return [
+        $op = [
             'attrib' => $this->attribute,
             'modtype' => $this->operationType,
-            'values' => $this->values,
         ];
+
+        if (\LDAP_MODIFY_BATCH_REMOVE_ALL !== $this->operationType) {
+            $op['values'] = $this->values;
+        }
+
+        return $op;
     }
 }
diff --git a/src/Symfony/Component/Ldap/Tests/Adapter/ExtLdap/LdapManagerTest.php b/src/Symfony/Component/Ldap/Tests/Adapter/ExtLdap/LdapManagerTest.php
@@ -266,6 +266,23 @@ public function testLdapAddAttributeValuesError()
         $entryManager->addAttributeValues($entry, 'mail', $entry->getAttribute('mail'));
     }
 
+    public function testLdapApplyOperationsRemoveAll()
+    {
+        $entryManager = $this->adapter->getEntryManager();
+
+        $result = $this->executeSearchQuery(1);
+        $entry = $result[0];
+
+        $entryManager->applyOperations($entry->getDn(), [new UpdateOperation(\LDAP_MODIFY_BATCH_REMOVE_ALL, 'mail', null)]);
+
+        $result = $this->executeSearchQuery(1);
+        $entry = $result[0];
+
+        $this->assertNull($entry->getAttribute('mail'));
+
+        $entryManager->addAttributeValues($entry, 'mail', ['fabpot@symfony.com', 'fabien@potencier.com']);
+    }
+
     public function testLdapApplyOperationsRemoveAllWithArrayError()
     {
         $entryManager = $this->adapter->getEntryManager();

Original file line number	Diff line number	Diff line change
`@@ -48,10 +48,15 @@ public function __construct(int $operationType, string $attribute, ?array $value`
`48`	`48`
`49`	`49`	`public function toArray(): array`
`50`	`50`	`{`
`51`		`- return [`
	`51`	`+ $op = [`
`52`	`52`	`'attrib' => $this->attribute,`
`53`	`53`	`'modtype' => $this->operationType,`
`54`		`- 'values' => $this->values,`
`55`	`54`	`];`
	`55`	`+`
	`56`	`+ if (\LDAP_MODIFY_BATCH_REMOVE_ALL !== $this->operationType) {`
	`57`	`+ $op['values'] = $this->values;`
	`58`	`+ }`
	`59`	`+`
	`60`	`+ return $op;`
`56`	`61`	`}`
`57`	`62`	`}`