[LDAP] Check if bound before executing search/data edits.

bobvandevijver · bobvandevijver · commit 75435a7eb383 · 2016-12-18T16:34:12.000+01:00
diff --git a/src/Symfony/Component/Ldap/Adapter/EntryManagerInterface.php b/src/Symfony/Component/Ldap/Adapter/EntryManagerInterface.php
@@ -12,32 +12,44 @@
 namespace Symfony\Component\Ldap\Adapter;
 
 use Symfony\Component\Ldap\Entry;
+use Symfony\Component\Ldap\Exception\LdapException;
+use Symfony\Component\Ldap\Exception\NotBoundException;
 
 /**
  * Entry manager interface.
  *
  * @author Charles Sarrazin <charles@sarraz.in>
+ * @author Bob van de Vijver <bobvandevijver@hotmail.com>
  */
 interface EntryManagerInterface
 {
     /**
      * Adds a new entry in the Ldap server.
      *
      * @param Entry $entry
+     *
+     * @throws NotBoundException
+     * @throws LdapException
      */
     public function add(Entry $entry);
 
     /**
      * Updates an entry from the Ldap server.
      *
      * @param Entry $entry
+     *
+     * @throws NotBoundException
+     * @throws LdapException
      */
     public function update(Entry $entry);
 
     /**
      * Removes an entry from the Ldap server.
      *
      * @param Entry $entry
+     *
+     * @throws NotBoundException
+     * @throws LdapException
      */
     public function remove(Entry $entry);
 }
diff --git a/src/Symfony/Component/Ldap/Adapter/ExtLdap/EntryManager.php b/src/Symfony/Component/Ldap/Adapter/ExtLdap/EntryManager.php
@@ -14,9 +14,11 @@
 use Symfony\Component\Ldap\Adapter\EntryManagerInterface;
 use Symfony\Component\Ldap\Entry;
 use Symfony\Component\Ldap\Exception\LdapException;
+use Symfony\Component\Ldap\Exception\NotBoundException;
 
 /**
  * @author Charles Sarrazin <charles@sarraz.in>
+ * @author Bob van de Vijver <bobvandevijver@hotmail.com>
  */
 class EntryManager implements EntryManagerInterface
 {
@@ -32,7 +34,7 @@ public function __construct(Connection $connection)
      */
     public function add(Entry $entry)
     {
-        $con = $this->connection->getResource();
+        $con = $this->getConnectionResource();
 
         if (!@ldap_add($con, $entry->getDn(), $entry->getAttributes())) {
             throw new LdapException(sprintf('Could not add entry "%s": %s', $entry->getDn(), ldap_error($con)));
@@ -46,7 +48,7 @@ public function add(Entry $entry)
      */
     public function update(Entry $entry)
     {
-        $con = $this->connection->getResource();
+        $con = $this->getConnectionResource();
 
         if (!@ldap_modify($con, $entry->getDn(), $entry->getAttributes())) {
             throw new LdapException(sprintf('Could not update entry "%s": %s', $entry->getDn(), ldap_error($con)));
@@ -58,10 +60,22 @@ public function update(Entry $entry)
      */
     public function remove(Entry $entry)
     {
-        $con = $this->connection->getResource();
+        $con = $this->getConnectionResource();
 
         if (!@ldap_delete($con, $entry->getDn())) {
             throw new LdapException(sprintf('Could not remove entry "%s": %s', $entry->getDn(), ldap_error($con)));
         }
     }
+
+    /**
+     * Get the connection resource, but first check if the connection is bound
+     */
+    private function getConnectionResource(){
+        // If the connection is not bound, throw an exception. Users should use an explicit bind call first.
+        if (!$this->connection->isBound()) {
+            throw new NotBoundException("Query execution is not possible without binding the connection first.");
+        }
+
+        return $this->connection->getResource();
+    }
 }
diff --git a/src/Symfony/Component/Ldap/Adapter/ExtLdap/Query.php b/src/Symfony/Component/Ldap/Adapter/ExtLdap/Query.php
@@ -13,9 +13,11 @@
 
 use Symfony\Component\Ldap\Adapter\AbstractQuery;
 use Symfony\Component\Ldap\Exception\LdapException;
+use Symfony\Component\Ldap\Exception\NotBoundException;
 
 /**
  * @author Charles Sarrazin <charles@sarraz.in>
+ * @author Bob van de Vijver <bobvandevijver@hotmail.com>
  */
 class Query extends AbstractQuery
 {
@@ -53,9 +55,9 @@ public function __destruct()
     public function execute()
     {
         if (null === $this->search) {
-            // If the connection is not bound, then we try an anonymous bind.
+            // If the connection is not bound, throw an exception. Users should use an explicit bind call first.
             if (!$this->connection->isBound()) {
-                $this->connection->bind();
+                throw new NotBoundException("Query execution is not possible without binding the connection first.");
             }
 
             $con = $this->connection->getResource();
diff --git a/src/Symfony/Component/Ldap/Adapter/QueryInterface.php b/src/Symfony/Component/Ldap/Adapter/QueryInterface.php
@@ -12,9 +12,12 @@
 namespace Symfony\Component\Ldap\Adapter;
 
 use Symfony\Component\Ldap\Entry;
+use Symfony\Component\Ldap\Exception\LdapException;
+use Symfony\Component\Ldap\Exception\NotBoundException;
 
 /**
  * @author Charles Sarrazin <charles@sarraz.in>
+ * @author Bob van de Vijver <bobvandevijver@hotmail.com>
  */
 interface QueryInterface
 {
@@ -27,6 +30,9 @@ interface QueryInterface
      * Executes a query and returns the list of Ldap entries.
      *
      * @return CollectionInterface|Entry[]
+     *
+     * @throws NotBoundException
+     * @throws LdapException
      */
     public function execute();
 }
diff --git a/src/Symfony/Component/Ldap/Exception/NotBoundException.php b/src/Symfony/Component/Ldap/Exception/NotBoundException.php
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Ldap\Exception;
+
+/**
+ * NotBoundException is thrown if the connection with the LDAP server is not yet bound
+ *
+ * @author Bob van de Vijver <bobvandevijver@hotmail.com>
+ */
+class NotBoundException extends \RuntimeException implements ExceptionInterface
+{
+}
