<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Ldap

 * @subpackage Node

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Node.php 22662 2010-07-24 17:37:36Z mabe $

 */

/**

 * @see Zend_Ldap

 */

require_once 'Zend/Ldap.php';

/**

 * @see Zend_Ldap_Node_Abstract

 */

require_once 'Zend/Ldap/Node/Abstract.php';

/**

 * Zend_Ldap_Node provides an object oriented view into a LDAP node.

 *

 * @category   Zend

 * @package    Zend_Ldap

 * @subpackage Node

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Ldap_Node extends Zend_Ldap_Node_Abstract implements Iterator, RecursiveIterator

{

    /**

     * Holds the node's new DN if node is renamed.

     *

     * @var Zend_Ldap_Dn

     */

    protected $_newDn;

    /**

     * Holds the node's orginal attributes (as loaded).

     *

     * @var array

     */

    protected $_originalData;

    /**

     * This node will be added

     *

     * @var boolean

     */

    protected $_new;

    /**

     * This node will be deleted

     *

     * @var boolean

     */

    protected $_delete;

    /**

     * Holds the connection to the LDAP server if in connected mode.

     *

     * @var Zend_Ldap

     */

    protected $_ldap;

    /**

     * Holds an array of the current node's children.

     *

     * @var array

     */

    protected $_children;

    /**

     * Controls iteration status

     *

     * @var boolean

     */

    private $_iteratorRewind = false;

    /**

     * Constructor.

     *

     * Constructor is protected to enforce the use of factory methods.

     *

     * @param  Zend_Ldap_Dn $dn

     * @param  array        $data

     * @param  boolean      $fromDataSource

     * @param  Zend_Ldap    $ldap

     * @throws Zend_Ldap_Exception

     */

    protected function __construct(Zend_Ldap_Dn $dn, array $data, $fromDataSource, Zend_Ldap $ldap = null)

    {

        parent::__construct($dn, $data, $fromDataSource);

        if ($ldap !== null) $this->attachLdap($ldap);

        else $this->detachLdap();

    }

    /**

     * Serialization callback

     *

     * Only DN and attributes will be serialized.

     *

     * @return array

     */

    public function __sleep()

    {

        return array('_dn', '_currentData', '_newDn', '_originalData',

            '_new', '_delete', '_children');

    }

    /**

     * Deserialization callback

     *

     * Enforces a detached node.

     *

     * @return null

     */

    public function __wakeup()

    {

        $this->detachLdap();

    }

    /**

     * Gets the current LDAP connection.

     *

     * @return Zend_Ldap

     * @throws Zend_Ldap_Exception

     */

    public function getLdap()

    {

        if ($this->_ldap === null) {

            /**

             * @see Zend_Ldap_Exception

             */

            require_once 'Zend/Ldap/Exception.php';

            throw new Zend_Ldap_Exception(null, 'No LDAP connection specified.', Zend_Ldap_Exception::LDAP_OTHER);

        }

        else return $this->_ldap;

    }

    /**

     * Attach node to an LDAP connection

     *

     * This is an offline method.

     *

     * @uses   Zend_Ldap_Dn::isChildOf()

     * @param  Zend_Ldap $ldap

     * @return Zend_Ldap_Node Provides a fluid interface

     * @throws Zend_Ldap_Exception

     */

    public function attachLdap(Zend_Ldap $ldap)

    {

        if (!Zend_Ldap_Dn::isChildOf($this->_getDn(), $ldap->getBaseDn())) {

            /**

             * @see Zend_Ldap_Exception

             */

            require_once 'Zend/Ldap/Exception.php';

            throw new Zend_Ldap_Exception(null, 'LDAP connection is not responsible for given node.',

                Zend_Ldap_Exception::LDAP_OTHER);

        }

        if ($ldap !== $this->_ldap) {

            $this->_ldap = $ldap;

            if (is_array($this->_children)) {

                foreach ($this->_children as $child) {

                    $child->attachLdap($ldap);

                }

            }

        }

        return $this;

    }

    /**

     * Detach node from LDAP connection

     *

     * This is an offline method.

     *

     * @return Zend_Ldap_Node Provides a fluid interface

     */

    public function detachLdap()

    {

        $this->_ldap = null;

        if (is_array($this->_children)) {

            foreach ($this->_children as $child) {

                $child->detachLdap();

            }

        }

        return $this;

    }

    /**

     * Checks if the current node is attached to a LDAP server.

     *

     * This is an offline method.

     *

     * @return boolean

     */

    public function isAttached()

    {

        return ($this->_ldap !== null);

    }

    /**

     * @param  array   $data

     * @param  boolean $fromDataSource

     * @throws Zend_Ldap_Exception

     */

    protected function _loadData(array $data, $fromDataSource)

    {

        parent::_loadData($data, $fromDataSource);

        if ($fromDataSource === true) {

            $this->_originalData = $data;

        } else {

            $this->_originalData = array();

        }

        $this->_children = null;

        $this->_markAsNew(($fromDataSource === true) ? false : true);

        $this->_markAsToBeDeleted(false);

    }

    /**

     * Factory method to create a new detached Zend_Ldap_Node for a given DN.

     *

     * @param  string|array|Zend_Ldap_Dn $dn

     * @param  array                     $objectClass

     * @return Zend_Ldap_Node

     * @throws Zend_Ldap_Exception

     */

    public static function create($dn, array $objectClass = array())

    {

        if (is_string($dn) || is_array($dn)) {

            $dn = Zend_Ldap_Dn::factory($dn);

        } else if ($dn instanceof Zend_Ldap_Dn) {

            $dn = clone $dn;

        } else {

            /**

             * @see Zend_Ldap_Exception

             */

            require_once 'Zend/Ldap/Exception.php';

            throw new Zend_Ldap_Exception(null, '$dn is of a wrong data type.');

        }

        $new = new self($dn, array(), false, null);

        $new->_ensureRdnAttributeValues();

        $new->setAttribute('objectClass', $objectClass);

        return $new;

    }

    /**

     * Factory method to create an attached Zend_Ldap_Node for a given DN.

     *

     * @param  string|array|Zend_Ldap_Dn $dn

     * @param  Zend_Ldap                 $ldap

     * @return Zend_Ldap_Node|null

     * @throws Zend_Ldap_Exception

     */

    public static function fromLdap($dn, Zend_Ldap $ldap)

    {

        if (is_string($dn) || is_array($dn)) {

            $dn = Zend_Ldap_Dn::factory($dn);

        } else if ($dn instanceof Zend_Ldap_Dn) {

            $dn = clone $dn;

        } else {

            /**

             * @see Zend_Ldap_Exception

             */

            require_once 'Zend/Ldap/Exception.php';

            throw new Zend_Ldap_Exception(null, '$dn is of a wrong data type.');

        }

        $data = $ldap->getEntry($dn, array('*', '+'), true);

        if ($data === null) {

            return null;

        }

        $entry = new self($dn, $data, true, $ldap);

        return $entry;

    }

    /**

     * Factory method to create a detached Zend_Ldap_Node from array data.

     *

     * @param  array   $data

     * @param  boolean $fromDataSource

     * @return Zend_Ldap_Node

     * @throws Zend_Ldap_Exception

     */

    public static function fromArray(array $data, $fromDataSource = false)

    {

        if (!array_key_exists('dn', $data)) {

            /**

             * @see Zend_Ldap_Exception

             */

            require_once 'Zend/Ldap/Exception.php';

            throw new Zend_Ldap_Exception(null, '\'dn\' key is missing in array.');

        }

        if (is_string($data['dn']) || is_array($data['dn'])) {

            $dn = Zend_Ldap_Dn::factory($data['dn']);

        } else if ($data['dn'] instanceof Zend_Ldap_Dn) {

            $dn = clone $data['dn'];

        } else {

            /**

             * @see Zend_Ldap_Exception

             */

            require_once 'Zend/Ldap/Exception.php';

            throw new Zend_Ldap_Exception(null, '\'dn\' key is of a wrong data type.');

        }

        $fromDataSource = ($fromDataSource === true) ? true : false;

        $new = new self($dn, $data, $fromDataSource, null);

        $new->_ensureRdnAttributeValues();

        return $new;

    }

    /**

     * Ensures that teh RDN attributes are correctly set.

     *

     * @return void

     */

    protected function _ensureRdnAttributeValues()

    {

        foreach ($this->getRdnArray() as $key => $value) {

            Zend_Ldap_Attribute::setAttribute($this->_currentData, $key, $value, false);

        }

    }

    /**

     * Marks this node as new.

     *

     * Node will be added (instead of updated) on calling update() if $new is true.

     *

     * @param boolean $new

     */

    protected function _markAsNew($new)

    {

        $this->_new = ($new === false) ? false : true;

    }

    /**

     * Tells if the node is consiedered as new (not present on the server)

     *

     * Please note, that this doesn't tell you if the node is present on the server.

     * Use {@link exits()} to see if a node is already there.

     *

     * @return boolean

     */

    public function isNew()

    {

        return $this->_new;

    }

    /**

     * Marks this node as to be deleted.

     *

     * Node will be deleted on calling update() if $delete is true.

     *

     * @param boolean $delete

     */

    protected function _markAsToBeDeleted($delete)

    {

        $this->_delete = ($delete === true) ? true : false;

    }

    /**

    * Is this node going to be deleted once update() is called?

    *

    * @return boolean

    */

    public function willBeDeleted()

    {

        return $this->_delete;

    }

    /**

     * Marks this node as to be deleted

     *

     * Node will be deleted on calling update() if $delete is true.

     *

     * @return Zend_Ldap_Node Provides a fluid interface

     */

    public function delete()

    {

        $this->_markAsToBeDeleted(true);

        return $this;

    }

    /**

    * Is this node going to be moved once update() is called?

    *

    * @return boolean

    */

    public function willBeMoved()

    {

        if ($this->isNew() || $this->willBeDeleted()) {

            return false;

        } else if ($this->_newDn !== null) {

            return ($this->_dn != $this->_newDn);

        } else {

            return false;

        }

    }

    /**

     * Sends all pending changes to the LDAP server

     *

     * @param  Zend_Ldap $ldap

     * @return Zend_Ldap_Node Provides a fluid interface

     * @throws Zend_Ldap_Exception

     */

    public function update(Zend_Ldap $ldap = null)

    {

        if ($ldap !== null) {

            $this->attachLdap($ldap);

        }

        $ldap = $this->getLdap();

        if (!($ldap instanceof Zend_Ldap)) {

            /**

             * @see Zend_Ldap_Exception

             */

            require_once 'Zend/Ldap/Exception.php';

            throw new Zend_Ldap_Exception(null, 'No LDAP connection available');

        }

        if ($this->willBeDeleted()) {

            if ($ldap->exists($this->_dn)) {

                $ldap->delete($this->_dn);

            }

            return $this;

        }

        if ($this->isNew()) {

            $data = $this->getData();

            $ldap->add($this->_getDn(), $data);

            $this->_loadData($data, true);

            return $this;

        }

        $changedData = $this->getChangedData();

        if ($this->willBeMoved()) {

            $recursive = $this->hasChildren();

            $ldap->rename($this->_dn, $this->_newDn, $recursive, false);

            foreach ($this->_newDn->getRdn() as $key => $value) {