10000 [Ldap] Add write support for the Ldap component by csarrazi · Pull Request #17817 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

[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 1 commit into from
Feb 18, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/Symfony/Component/Ldap/Adapter/AdapterInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ public function getConnection();
*/
public function createQuery($dn, $query, array $options = array());

/**
* Fetches the entry manager instance.
*
* @return EntryManagerInterface
*/
public function getEntryManager();

/**
* Escape a string for use in an LDAP filter or DN.
*
Expand Down
43 changes: 43 additions & 0 deletions src/Symfony/Component/Ldap/Adapter/EntryManagerInterface.php
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);
}
13 changes: 13 additions & 0 deletions src/Symfony/Component/Ldap/Adapter/ExtLdap/Adapter.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ class Adapter implements AdapterInterface
{
private $config;
private $connection;
private $entryManager;

public function __construct(array $config = array())
{
Expand All @@ -43,6 +44,18 @@ public function getConnection()
return $this->connection;
}

/**
* {@inheritdoc}
*/
public function getEntryManager()
{
if (null === $this->entryManager) {
$this->entryManager = new EntryManager($this->connection);
}

return $this->entryManager;
}

/**
* {@inheritdoc}
*/
Expand Down
67 changes: 67 additions & 0 deletions src/Symfony/Component/Ldap/Adapter/ExtLdap/EntryManager.php
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)));
}
}
}
21 changes: 21 additions & 0 deletions src/Symfony/Component/Ldap/Entry.php
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,25 @@ public function getAttributes()
{
return $this->attributes;
}

/**
* Sets a value for the given attribute.
*
* @param $name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing type

* @param array $value
*/
public function setAttribute($name, array $value)
{
$this->attributes[$name] = $value;
}

/**
* Removes a given attribute.
*
* @param $name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

*/
public function removeAttribute($name)
{
unset($this->attributes[$name]);
}
}
8 changes: 8 additions & 0 deletions src/Symfony/Component/Ldap/Ldap.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ public function query($dn, $query, array $options = array())
return $this->adapter->createQuery($dn, $query, $options);
}

/**
* {@inheritdoc}
*/
public function getEntryManager()
{
return $this->adapter->getEntryManager();
}

/**
* {@inheritdoc}
*/
Expand Down
6 changes: 6 additions & 0 deletions src/Symfony/Component/Ldap/LdapInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

namespace Symfony\Component\Ldap;

use Symfony\Component\Ldap\Adapter\EntryManagerInterface;
use Symfony\Component\Ldap\Adapter\QueryInterface;

/**
Expand All @@ -33,4 +34,9 @@ interface LdapInterface extends BaseLdapInterface
* @return QueryInterface
*/
public function query($dn, $query, array $options = array());

/**
* @return EntryManagerInterface
*/
public function getEntryManager();
}
116 changes: 116 additions & 0 deletions src/Symfony/Component/Ldap/Tests/Adapter/ExtLdap/LdapManagerTest.php
C64E
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;
}
}
0