composer package updates

[openemr.git] / vendor / adldap2 / adldap2 / src / Models / Attributes / DistinguishedName.php

<?php

namespace Adldap\Models\Attributes;

use Adldap\Utilities;
use Adldap\Schemas\ActiveDirectory;
use Adldap\Schemas\SchemaInterface;

class DistinguishedName
{
    /**
     * The common names in the DN.
     *
     * @var array
     */
    public $commonNames = [];

    /**
     * The uid's in the DN.
     *
     * @var array
     */
    public $userIds = [];

    /**
     * The organizational units in the DN.
     *
     * @var array
     */
    public $organizationUnits = [];

    /**
     * The domain components in the DN.
     *
     * @var array
     */
    public $domainComponents = [];

    /**
     * The organization names in the DN.
     *
     * @var array
     */
    public $organizationNames = [];

    /**
     * The current LDAP schema.
     *
     * @var SchemaInterface
     */
    protected $schema;

    /**
     * The RDN attribute types.
     *
     * @var array
     */
    protected $types = [
        'o',
        'dc',
        'ou',
        'uid',
        'cn',
    ];

    /**
     * Constructor.
     *
     * @param mixed           $baseDn
     * @param SchemaInterface $schema
     */
    public function __construct($baseDn = null, SchemaInterface $schema = null)
    {
        $this->setBase($baseDn)
            ->setSchema($schema);
    }

    /**
     * Returns the complete distinguished name.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->get();
    }

    /**
     * Returns the complete distinguished name.
     *
     * @return string
     */
    public function get()
    {
        return $this->assemble();
    }

    /**
     * Adds a domain component.
     *
     * @param string $dc
     *
     * @return DistinguishedName
     */
    public function addDc($dc)
    {
        $this->domainComponents[] = $dc;

        return $this;
    }

    /**
     * Removes a domain component.
     *
     * @param string $dc
     *
     * @return DistinguishedName
     */
    public function removeDc($dc)
    {
        $this->domainComponents = array_diff($this->domainComponents, [$dc]);

        return $this;
    }

    /**
     * Adds an organization name.
     *
     * @param string $o
     *
     * @return $this
     */
    public function addO($o)
    {
        $this->organizationNames[] = $o;

        return $this;
    }

    /**
     * Removes an organization name.
     *
     * @param string $o
     *
     * @return DistinguishedName
     */
    public function removeO($o)
    {
        $this->organizationNames = array_diff($this->organizationNames, [$o]);

        return $this;
    }

    /**
     * Add a user identifier.
     *
     * @param string $uid
     *
     * @return DistinguishedName
     */
    public function addUid($uid)
    {
        $this->userIds[] = $uid;

        return $this;
    }

    /**
     * Removes a user identifier.
     *
     * @param string $uid
     *
     * @return DistinguishedName
     */
    public function removeUid($uid)
    {
        $this->userIds = array_diff($this->userIds, [$uid]);

        return $this;
    }

    /**
     * Adds a common name.
     *
     * @param string $cn
     *
     * @return DistinguishedName
     */
    public function addCn($cn)
    {
        $this->commonNames[] = $cn;

        return $this;
    }

    /**
     * Removes a common name.
     *
     * @param string $cn
     *
     * @return DistinguishedName
     */
    public function removeCn($cn)
    {
        $this->commonNames = array_diff($this->commonNames, [$cn]);

        return $this;
    }

    /**
     * Adds an organizational unit.
     *
     * @param string $ou
     *
     * @return DistinguishedName
     */
    public function addOu($ou)
    {
        $this->organizationUnits[] = $ou;

        return $this;
    }

    /**
     * Removes an organizational unit.
     *
     * @param string $ou
     *
     * @return DistinguishedName
     */
    public function removeOu($ou)
    {
        $this->organizationUnits = array_diff($this->organizationUnits, [$ou]);

        return $this;
    }

    /**
     * Sets the base RDN of the distinguished name.
     *
     * @param string|DistinguishedName $base
     *
     * @return DistinguishedName
     */
    public function setBase($base)
    {
        // Typecast base to string in case we've been given
        // an instance of the distinguished name object.
        $base = (string) $base;

        // If the base DN isn't null we'll try to explode it.
        $base = Utilities::explodeDn($base, false) ?: [];

        // Remove the count key from the exploded distinguished name.
        unset($base['count']);

        foreach ($base as $key => $rdn) {
            // We'll break the RDN into pieces
            $pieces = explode('=', $rdn) ?: [];

            // If there's exactly 2 pieces, then we can work with it.
            if (count($pieces) === 2) {
                $attribute = ucfirst($pieces[0]);

                $method = 'add'.$attribute;

                if (method_exists($this, $method)) {
                    // We see what type of RDN it is and add each accordingly.
                    call_user_func_array([$this, $method], [$pieces[1]]);
                }
            }
        }

        return $this;
    }

    /**
     * Sets the schema for the distinguished name.
     *
     * @param SchemaInterface|null $schema
     *
     * @return DistinguishedName
     */
    public function setSchema(SchemaInterface $schema = null)
    {
        $this->schema = $schema ?: new ActiveDirectory();

        return $this;
    }

    /**
     * Assembles all of the RDNs and returns the result.
     *
     * @return string
     */
    public function assemble()
    {
        return implode(',', array_filter([
            $this->assembleCns(),
            $this->assembleUids(),
            $this->assembleOus(),
            $this->assembleDcs(),
            $this->assembleOs(),
        ]));
    }

    /**
     * Assembles the common names in the distinguished name.
     *
     * @return string
     */
    public function assembleCns()
    {
        return $this->assembleRdns($this->schema->commonName(), $this->commonNames);
    }

    /**
     * Assembles the user ID's in the distinguished name.
     *
     * @return string
     */
    public function assembleUids()
    {
        return $this->assembleRdns($this->schema->userId(), $this->userIds);
    }

    /**
     * Assembles the organizational units in the distinguished Name.
     *
     * @return string
     */
    public function assembleOus()
    {
        return $this->assembleRdns($this->schema->organizationalUnitShort(), $this->organizationUnits);
    }

    /**
     * Assembles the domain components in the distinguished Name.
     *
     * @return string
     */
    public function assembleDcs()
    {
        return $this->assembleRdns($this->schema->domainComponent(), $this->domainComponents);
    }

    /**
     * Assembles the organization names in the distinguished name.
     *
     * @return string
     */
    public function assembleOs()
    {
        return $this->assembleRdns($this->schema->organizationName(), $this->organizationNames);
    }

    /**
     * Assembles an RDN with the specified attribute and value.
     *
     * @param string $attribute
     * @param array  $values
     *
     * @return string
     */
    protected function assembleRdns($attribute, array $values = [])
    {
        return implode(',', array_map(function ($value) use ($attribute) {
            return sprintf('%s=%s', $attribute, Utilities::escape($value, '', 2));
        }, $values));
    }
}