feature #16735 [WIP] [Ldap] Marked the Ldap component as internal (csarrazi)

fabpot · fabpot · commit afe1668b41bb · 2015-11-29T11:47:37.000+01:00
This PR was merged into the 2.8 branch. Discussion ---------- [WIP] [Ldap] Marked the Ldap component as internal | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | yes | Deprecations? | no | Tests pass? | no | Fixed tickets | no | License | MIT | Doc PR | not yet As mentioned earlier, the LDAP component suffers from a few problems, addressed in PR #15994 However, as raised by @Tobion, the component does not yet have tests (they can be added at a later time, though), and is not considered stable yet. Commits ------- 3f89b2c Marked the Ldap component as internal and removed Ldap constants polyfill
diff --git a/src/Symfony/Component/Ldap/Exception/ConnectionException.php b/src/Symfony/Component/Ldap/Exception/ConnectionException.php
@@ -15,6 +15,8 @@
  * ConnectionException is throw if binding to ldap can not be established.
  *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @internal
  */
 class ConnectionException extends \RuntimeException
 {
diff --git a/src/Symfony/Component/Ldap/Exception/LdapException.php b/src/Symfony/Component/Ldap/Exception/LdapException.php
@@ -15,6 +15,8 @@
  * LdapException is throw if php ldap module is not loaded.
  *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @internal
  */
 class LdapException extends \RuntimeException
 {
diff --git a/src/Symfony/Component/Ldap/LdapClient.php b/src/Symfony/Component/Ldap/LdapClient.php
@@ -18,6 +18,8 @@
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  * @author Francis Besset <francis.besset@gmail.com>
  * @author Charles Sarrazin <charles@sarraz.in>
+ *
+ * @internal
  */
 class LdapClient implements LdapClientInterface
 {
diff --git a/src/Symfony/Component/Ldap/LdapClientInterface.php b/src/Symfony/Component/Ldap/LdapClientInterface.php
@@ -18,12 +18,11 @@
  *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  * @author Charles Sarrazin <charles@sarraz.in>
+ *
+ * @internal
  */
 interface LdapClientInterface
 {
-    const LDAP_ESCAPE_FILTER = 0x01;
-    const LDAP_ESCAPE_DN = 0x02;
-
     /**
      * Return a connection bound to the ldap.
      *
diff --git a/src/Symfony/Component/Ldap/README.md b/src/Symfony/Component/Ldap/README.md
@@ -1,10 +1,14 @@
 Ldap Component
-=============
+==============
 
 A Ldap client for PHP on top of PHP's ldap extension.
 
-This component also provides a stub for the missing
-`ldap_escape` function in PHP versions lower than 5.6.
+Disclaimer
+----------
+
+This component is currently marked as internal, as it
+still needs some work. Breaking changes will be introduced
+in the next minor version of Symfony.
 
 Documentation
 -------------
diff --git a/src/Symfony/Component/Security/Core/Authentication/Provider/LdapBindAuthenticationProvider.php b/src/Symfony/Component/Security/Core/Authentication/Provider/LdapBindAuthenticationProvider.php
@@ -74,7 +74,7 @@ protected function checkAuthentication(UserInterface $user, UsernamePasswordToke
         $password = $token->getCredentials();
 
         try {
-            $username = $this->ldap->escape($username, '', LdapClientInterface::LDAP_ESCAPE_DN);
+            $username = $this->ldap->escape($username, '', LDAP_ESCAPE_DN);
             $dn = str_replace('{username}', $username, $this->dnString);
 
             $this->ldap->bind($dn, $password);
diff --git a/src/Symfony/Component/Security/Core/User/LdapUserProvider.php b/src/Symfony/Component/Security/Core/User/LdapUserProvider.php
@@ -57,7 +57,7 @@ public function loadUserByUsername($username)
     {
         try {
             $this->ldap->bind($this->searchDn, $this->searchPassword);
-            $username = $this->ldap->escape($username, '', LdapClientInterface::LDAP_ESCAPE_FILTER);
+            $username = $this->ldap->escape($username, '', LDAP_ESCAPE_FILTER);
             $query = str_replace('{username}', $username, $this->defaultSearch);
             $search = $this->ldap->find($this->baseDn, $query);
         } catch (ConnectionException $e) {

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@`
`15`	`15`	`* ConnectionException is throw if binding to ldap can not be established.`
`16`	`16`	`*`
`17`	`17`	`* @author Grégoire Pineau <lyrixx@lyrixx.info>`
	`18`	`+ *`
	`19`	`+ * @internal`
`18`	`20`	`*/`
`19`	`21`	`class ConnectionException extends \RuntimeException`
`20`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@`
`18`	`18`	`* @author Grégoire Pineau <lyrixx@lyrixx.info>`
`19`	`19`	`* @author Francis Besset <francis.besset@gmail.com>`
`20`	`20`	`* @author Charles Sarrazin <charles@sarraz.in>`
	`21`	`+ *`
	`22`	`+ * @internal`
`21`	`23`	`*/`
`22`	`24`	`class LdapClient implements LdapClientInterface`
`23`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,12 +18,11 @@`
`18`	`18`	`*`
`19`	`19`	`* @author Grégoire Pineau <lyrixx@lyrixx.info>`
`20`	`20`	`* @author Charles Sarrazin <charles@sarraz.in>`
	`21`	`+ *`
	`22`	`+ * @internal`
`21`	`23`	`*/`
`22`	`24`	`interface LdapClientInterface`
`23`	`25`	`{`
`24`		`- const LDAP_ESCAPE_FILTER = 0x01;`
`25`		`- const LDAP_ESCAPE_DN = 0x02;`
`26`		`-`
`27`	`26`	`/**`
`28`	`27`	`* Return a connection bound to the ldap.`
`29`	`28`	`*`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public function loadUserByUsername($username)`
`57`	`57`	`{`
`58`	`58`	`try {`
`59`	`59`	`$this->ldap->bind($this->searchDn, $this->searchPassword);`
`60`		`- $username = $this->ldap->escape($username, '', LdapClientInterface::LDAP_ESCAPE_FILTER);`
	`60`	`+ $username = $this->ldap->escape($username, '', LDAP_ESCAPE_FILTER);`
`61`	`61`	`$query = str_replace('{username}', $username, $this->defaultSearch);`
`62`	`62`	`$search = $this->ldap->find($this->baseDn, $query);`
`63`	`63`	`} catch (ConnectionException $e) {`