[Ldap] Entry move support

symfony · fabpot · Mar 31, 2019 · Dec 4, 2018 · Mar 31, 2019 · 32743c850f901b77b81232b9239b2128d5c6f041
commit 32743c850f901b77b81232b9239b2128d5c6f041
diff --git a/src/Symfony/Component/Ldap/Adapter/EntryManagerInterface.php b/src/Symfony/Component/Ldap/Adapter/EntryManagerInterface.php
@@ -21,6 +21,8 @@
  * @author Charles Sarrazin <[email protected]>
  * @author Bob van de Vijver <[email protected]>
  * @author Kevin Schuurmans <[email protected]>
+ *
+ * @method void move(Entry $entry, string $newParent) Moves an entry on the Ldap server
  */
 interface EntryManagerInterface
 {

diff --git a/src/Symfony/Component/Ldap/Adapter/ExtLdap/EntryManager.php b/src/Symfony/Component/Ldap/Adapter/ExtLdap/EntryManager.php
@@ -110,6 +110,22 @@ public function rename(Entry $entry, $newRdn, $removeOldRdn = true)
         }
     }
 
+    /**
+     * Moves an entry on the Ldap server.
+     *
+     * @throws NotBoundException if the connection has not been previously bound.
+     * @throws LdapException if an error is thrown during the rename operation.
+     */
+    public function move(Entry $entry, string $newParent)
+    {
+        $con = $this->getConnectionResource();
+        $rdn = $this->parseRdnFromEntry($entry);
+        // deleteOldRdn does not matter here, since the Rdn will not be changing in the move.
+        if (!@ldap_rename($con, $entry->getDn(), $rdn, $newParent, true)) {
+            throw new LdapException(sprintf('Could not move entry "%s" to "%s": %s.', $entry->getDn(), $newParent, ldap_error($con)));
+        }
+    }
+
     /**
      * Get the connection resource, but first check if the connection is bound.
      */
@@ -139,4 +155,13 @@ public function applyOperations(string $dn, iterable $operations): void
             throw new UpdateOperationException(sprintf('Error executing UpdateOperation on "%s": "%s".', $dn, ldap_error($this->getConnectionResource())));
         }
     }
+
+   private function parseRdnFromEntry(Entry $entry)
+    {
+        if (!preg_match('/^([^,]+),/', $entry->getDn(), $matches)) {
+            throw new LdapException(sprintf('Entry "%s" malformed, could not parse RDN', $entry->getDn()));
+        }
+
+        return $matches[1];
+    }
 }
diff --git a/src/Symfony/Component/Ldap/CHANGELOG.md b/src/Symfony/Component/Ldap/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.3.0
+-----
+
+ * added `EntryManager::move`, not implementing it is deprecated
+
 4.2.0
 -----
 

diff --git a/src/Symfony/Component/Ldap/Tests/Adapter/ExtLdap/LdapManagerTest.php b/src/Symfony/Component/Ldap/Tests/Adapter/ExtLdap/LdapManagerTest.php
@@ -341,4 +341,22 @@ public function testUpdateOperationsThrowsExceptionWhenAddedDuplicatedValue()
 
         $entryManager->applyOperations($entry->getDn(), $duplicateIterator);
     }
+
+    /**
+     * @group functional
+     */
+    public function testLdapMove()
+    {
+        $result = $this->executeSearchQuery(1);
+
+        $entry = $result[0];
+        $this->assertNotContains('ou=Ldap', $entry->getDn());
+
+        $entryManager = $this->adapter->getEntryManager();
+        $entryManager->move($entry, 'ou=Ldap,ou=Components,dc=symfony,dc=com');
+
+        $result = $this->executeSearchQuery(1);
+        $movedEntry = $result[0];
+        $this->assertContains('ou=Ldap', $movedEntry->getDn());
+    }
 }