[LDAP] implemented LDAP entry rename for ExtLdap adapter

fruitwasp · fruitwasp · commit 2d8eeb200fac · 2017-01-13T14:07:40.000+01:00
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -390,3 +390,8 @@ Yaml
    the `!php/object` tag.
 
  * Duplicate mapping keys lead to a `ParseException`.
+
+Ldap
+--------------
+ 
+  * The `RenameEntryInterface` has been deprecated, and merged with `EntryManagerInterface`
diff --git a/src/Symfony/Component/Ldap/Adapter/ExtLdap/EntryManager.php b/src/Symfony/Component/Ldap/Adapter/ExtLdap/EntryManager.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Ldap\Adapter\ExtLdap;
 
 use Symfony\Component\Ldap\Adapter\EntryManagerInterface;
+use Symfony\Component\Ldap\Adapter\RenameEntryInterface;
 use Symfony\Component\Ldap\Entry;
 use Symfony\Component\Ldap\Exception\LdapException;
 use Symfony\Component\Ldap\Exception\NotBoundException;
@@ -20,7 +21,7 @@
  * @author Charles Sarrazin <charles@sarraz.in>
  * @author Bob van de Vijver <bobvandevijver@hotmail.com>
  */
-class EntryManager implements EntryManagerInterface
+class EntryManager implements EntryManagerInterface, RenameEntryInterface
 {
     private $connection;
 
@@ -67,6 +68,18 @@ public function remove(Entry $entry)
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function rename(Entry $entry, $newRdn, $removeOldRdn = true)
+    {
+        $con = $this->getConnectionResource();
+
+        if (!@ldap_rename($con, $entry->getDn(), $newRdn, null, $removeOldRdn)) {
+            throw new LdapException(sprintf('Could not rename entry "%s" to "%s": %s', $entry->getDn(), $newRdn, ldap_error($con)));
+        }
+    }
+
     /**
      * Get the connection resource, but first check if the connection is bound.
      */
diff --git a/src/Symfony/Component/Ldap/Adapter/RenameEntryInterface.php b/src/Symfony/Component/Ldap/Adapter/RenameEntryInterface.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Symfony\Component\Ldap\Adapter;
+
+use Symfony\Component\Ldap\Entry;
+
+/**
+ * @deprecated This interface will be deprecated in 4.0, and merged with `EntryManagerInterface`
+ *
+ * @author Kevin Schuurmans <kevin.schuurmans@freshheads.com>
+ */
+interface RenameEntryInterface
+{
+    /**
+     * Renames an entry on the Ldap server.
+     *
+     * @param Entry  $entry
+     * @param string $newRdn
+     * @param bool   $removeOldRdn
+     */
+    public function rename(Entry $entry, $newRdn, $removeOldRdn = true);
+}
diff --git a/src/Symfony/Component/Ldap/Tests/Adapter/ExtLdap/LdapManagerTest.php b/src/Symfony/Component/Ldap/Tests/Adapter/ExtLdap/LdapManagerTest.php
@@ -147,4 +147,49 @@ private function executeSearchQuery($expectedResults = 1)
 
         return $results;
     }
+
+    /**
+     * @group functional
+     */
+    public function testLdapRename()
+    {
+        $result = $this->executeSearchQuery(1);
+
+        $entry = $result[0];
+
+        $entryManager = $this->adapter->getEntryManager();
+        $entryManager->rename($entry, 'cn=Kevin');
+
+        $result = $this->executeSearchQuery(1);
+        $renamedEntry = $result[0];
+        $this->assertEquals($renamedEntry->getAttribute('cn')[0], 'Kevin');
+
+        $oldRdn = $entry->getAttribute('cn')[0];
+        $entryManager->rename($renamedEntry, 'cn='.$oldRdn);
+        $this->executeSearchQuery(1);
+    }
+
+    /**
+     * @group functional
+     */
+    public function testLdapRenameWithoutRemovingOldRdn()
+    {
+        $result = $this->executeSearchQuery(1);
+
+        $entry = $result[0];
+
+        $entryManager = $this->adapter->getEntryManager();
+        $entryManager->rename($entry, 'cn=Kevin', false);
+
+        $result = $this->executeSearchQuery(1);
+
+        $newEntry = $result[0];
+        $originalCN = $entry->getAttribute('cn')[0];
+
+        $this->assertContains($originalCN, $newEntry->getAttribute('cn'));
+
+        $entryManager->rename($newEntry, 'cn='.$originalCN);
+
+        $this->executeSearchQuery(1);
+    }
 }
