-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Ldap] Add write support for the Ldap component #17817
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
src/Symfony/Component/Ldap/Adapter/EntryManagerInterface.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<?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\Adapter; | ||
|
||
use Symfony\Component\Ldap\Entry; | ||
|
||
/** | ||
* Entry manager interface. | ||
* | ||
* @author Charles Sarrazin <charles@sarraz.in> | ||
*/ | ||
interface EntryManagerInterface | ||
{ | ||
/** | ||
* Adds a new entry in the Ldap server. | ||
* | ||
* @param Entry $entry | ||
*/ | ||
public function add(Entry $entry); | ||
|
||
/** | ||
* Updates an entry from the Ldap server. | ||
* | ||
* @param Entry $entry | ||
*/ | ||
public function update(Entry $entry); | ||
|
||
/** | ||
* Removes an entry from the Ldap server. | ||
* | ||
* @param Entry $entry | ||
*/ | ||
public function remove(Entry $entry); | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
src/Symfony/Component/Ldap/Adapter/ExtLdap/EntryManager.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
<?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\Adapter\ExtLdap; | ||
|
||
use Symfony\Component\Ldap\Adapter\EntryManagerInterface; | ||
use Symfony\Component\Ldap\Entry; | ||
use Symfony\Component\Ldap\Exception\LdapException; | ||
|
||
/** | ||
* @author Charles Sarrazin <charles@sarraz.in> | ||
*/ | ||
class EntryManager implements EntryManagerInterface | ||
{ | ||
private $connection; | ||
|
||
public function __construct(Connection $connection) | ||
{ | ||
$this->connection = $connection; | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function add(Entry $entry) | ||
{ | ||
$con = $this->connection->getResource(); | ||
|
||
if (!@ldap_add($con, $entry->getDn(), $entry->getAttributes())) { | ||
throw new LdapException(sprintf('Could not add entry "%s": %s', $entry->getDn(), ldap_error($con))); | ||
} | ||
|
||
return $this; | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function update(Entry $entry) | ||
{ | ||
$con = $this->connection->getResource(); | ||
|
||
if (!@ldap_modify($con, $entry->getDn(), $entry->getAttributes())) { | ||
throw new LdapException(sprintf('Could not update entry "%s": %s', $entry->getDn(), ldap_error($con))); | ||
} | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function remove(Entry $entry) | ||
{ | ||
$con = $this->connection->getResource(); | ||
|
||
if (!@ldap_delete($con, $entry->getDn())) { | ||
throw new LdapException(sprintf('Could not remove entry "%s": %s', $entry->getDn(), ldap_error($con))); | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -59,4 +59,25 @@ public function getAttributes() | |
{ | ||
return $this->attributes; | ||
} | ||
|
||
/** | ||
* Sets a value for the given attribute. | ||
* | ||
* @param $name | ||
* @param array $value | ||
*/ | ||
public function setAttribute($name, array $value) | ||
{ | ||
$this->attributes[$name] = $value; | ||
} | ||
|
||
/** | ||
* Removes a given attribute. | ||
* | ||
* @param $name | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same here |
||
*/ | ||
public function removeAttribute($name) | ||
{ | ||
unset($this->attributes[$name]); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
src/Symfony/Component/Ldap/Tests/Adapter/ExtLdap/LdapManagerTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
<?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\Tests; | ||
|
||
use Symfony\Component\Ldap\Adapter\ExtLdap\Adapter; | ||
use Symfony\Component\Ldap\Adapter\ExtLdap\Collection; | ||
use Symfony\Component\Ldap\Entry; | ||
use Symfony\Component\Ldap\Exception\LdapException; | ||
|
||
/** | ||
* @requires extension ldap | ||
*/ | ||
class LdapManagerTest extends \PHPUnit_Framework_TestCase | ||
{ | ||
/** @var Adapter */ | ||
private $adapter; | ||
|
||
protected function setUp() | ||
{ | ||
$this->adapter = new Adapter(array('host' => 'localhost', 'port' => 3389)); | ||
$this->adapter->getConnection()->bind('cn=admin,dc=symfony,dc=com', 'symfony'); | ||
} | ||
|
||
/** | ||
* @group functional | ||
*/ | ||
public function testLdapAddAndRemove() | ||
{ | ||
$this->executeSearchQuery(1); | ||
|
||
$entry = new Entry('cn=Charles Sarrazin,dc=symfony,dc=com', array( | ||
'sn' => array('csarrazi'), | ||
'objectclass' => array( | ||
'inetOrgPerson', | ||
), | ||
)); | ||
|
||
$em = $this->adapter->getEntryManager(); | ||
$em->add($entry); | ||
|
||
$this->executeSearchQuery(2); | ||
|
||
$em->remove($entry); | ||
$this->executeSearchQuery(1); | ||
} | ||
|
||
/** | ||
* @group functional | ||
*/ | ||
public function testLdapAddInvalidEntry() | ||
{ | ||
$this->setExpectedException(LdapException::class); | ||
$this->executeSearchQuery(1); | ||
|
||
// The entry is missing a subject name | ||
$entry = new Entry('cn=Charles Sarrazin,dc=symfony,dc=com', array( | ||
'objectclass' => array( | ||
'inetOrgPerson', | ||
), | ||
)); | ||
|
||
$em = $this->adapter->getEntryManager(); | ||
$em->add($entry); | ||
} | ||
|
||
/** | ||
* @group functional | ||
*/ | ||
public function testLdapUpdate() | ||
{ | ||
$result = $this->executeSearchQuery(1); | ||
|
||
$entry = $result[0]; | ||
$this->assertNull($entry->getAttribute('email')); | ||
|
||
$em = $this->adapter->getEntryManager(); | ||
$em->update($entry); | ||
|
||
$result = $this->executeSearchQuery(1); | ||
|
||
$entry = $result[0]; | ||
$this->assertNull($entry->getAttribute('email')); | ||
|
||
$entry->removeAttribute('email'); | ||
$em->update($entry); | ||
|
||
$result = $this->executeSearchQuery(1); | ||
$entry = $result[0]; | ||
$this->assertNull($entry->getAttribute('email')); | ||
} | ||
|
||
/** | ||
* @return Collection|Entry[] | ||
*/ | ||
private function executeSearchQuery($expectedResults = 1) | ||
{ | ||
$results = $this | ||
->adapter | ||
->createQuery('dc=symfony,dc=com', '(objectclass=person)') | ||
->execute() | ||
; | ||
|
||
$this->assertCount($expectedResults, $results); | ||
|
||
return $results; | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing type