DoL\LdapBundle\Driver\ZendLdapDriver

Complexity

Total Complexity

13

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Test Coverage

Coverage

81.63%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	search()	0	21	2
A	bind()	0	21	4
A	init()	0	3	1
A	zendExceptionHandler()	0	14	3
A	logDebug()	0	4	2

<?php

namespace DoL\LdapBundle\Driver;

use Zend\Ldap\Ldap;
use Zend\Ldap\Exception\LdapException as ZendLdapException;
use DoL\LdapBundle\Model\LdapUserInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\Security\Core\User\UserInterface;

/**
 * This class adapt ldap calls to Zend Framework Ldap library functions.
 * Also prevent information disclosure catching Zend Ldap Exceptions and passing
 * them to the logger.
 *
 * @since v2.0.0
 *
 * @author DarwinOnLine
 * @author Maks3w
 *
 * @see https://github.com/DarwinOnLine/DoLLdapBundle
 */
class ZendLdapDriver implements LdapDriverInterface
{
    /**
     * @var Ldap
     */
    private $driver;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @param Ldap            $driver Initialized Zend::Ldap Object
     * @param LoggerInterface $logger optional logger for write debug messages
     */
    public function __construct(Ldap $driver, LoggerInterface $logger = null)
    {
        $this->driver = $driver;
        $this->logger = $logger;
    }

    /**
     * {@inheritdoc}
     */
    public function init(array $options)
    {
        $this->driver->disconnect()->setOptions($options);
    }

    /**
     * {@inheritdoc}
     */
    public function search($baseDn, $filter, array $attributes = array())
    {
        $this->logDebug('{action}({base_dn}, {filter}, {attributes})', [
            'action' => 'ldap_search',
            'base_dn' => $baseDn,
            'filter' => $filter,
            'attributes' => $attributes,
        ]);

        try {
            $entries = $this->driver->searchEntries($filter, $baseDn, Ldap::SEARCH_SCOPE_SUB, $attributes);
            // searchEntries don't return 'count' key as specified by php native
            // function ldap_get_entries()

50% of this comment could be valid code. Did you maybe forget this after debugging?

            $entries['count'] = count($entries);
        } catch (ZendLdapException $exception) {
            $this->zendExceptionHandler($exception);

            throw new LdapDriverException('An error occur with the search operation.');
        }

        return $entries;
    }

    /**
     * {@inheritdoc}
     */
    public function bind(UserInterface $user, $password)
    {
        if ($user instanceof LdapUserInterface && $user->getDn()) {
            $bind_rdn = $user->getDn();
        } else {
            $bind_rdn = $user->getUsername();
        }

        try {
            $this->logDebug('{action}({bind_rdn}, ****)', [
                'action' => 'ldap_bind',
                'bind_rdn' => $bind_rdn,
            ]);
            $bind = $this->driver->bind($bind_rdn, $password);

            return $bind instanceof Ldap;
        } catch (ZendLdapException $exception) {
            $this->zendExceptionHandler($exception);
        }

        return false;
    }

    /**
     * Treat a Zend Ldap Exception.
     *
     * @param ZendLdapException $exception
     */
    protected function zendExceptionHandler(ZendLdapException $exception)
    {
        switch ($exception->getCode()) {
            // Error level codes
            case ZendLdapException::LDAP_SERVER_DOWN:
                if ($this->logger) {
                    $this->logger->error('{exception}', ['exception' => $exception]);
                }
                break;

            // Other level codes
            default:
                $this->logDebug('{exception}', ['exception' => $exception]);
                break;
        }
    }

    /**
     * Log debug messages if the logger is set.
     *
     * @param string $message
     * @param array  $context
     */
    private function logDebug($message, array $context = [])
    {
        if ($this->logger) {
            $this->logger->debug($message, $context);
        }
    }
}