class.User.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for
 * additional information.
 *
 * $Id: class.User.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once(BASE."wcmf/lib/model/class.Node.php");
require_once(BASE."wcmf/lib/persistence/class.PersistenceFacade.php");
require_once(BASE."wcmf/lib/model/class.NodeIterator.php");
require_once(BASE."wcmf/lib/visitor/class.CommitVisitor.php");

/**
 * @class User
 * @ingroup Security
 * @brief Abstract base class for user classes that represent a system user.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class User extends Node
{
  var $_cachedRoles = array();
  var $_hasOwnRolesLoaded = false;

  /**
   * Default constructor.
   */
  function User($oid=null, $type='User')
  {
    parent::Node($type, $oid);
  }

  /**
   * Get the user instance by login and password.
   * The default implementation searches the user using the PersistenceFacade.
   * This method may be called in a static way.
   * Subclasses will override this to implement special retrieval.
   * @return A reference to the instance or null if not found.
   */
  function &getUser($login, $password)
  {
    $persistenceFacade = &PersistenceFacade::getInstance();
    $oid = $persistenceFacade->getFirstOID(UserManager::getUserClassName(),
                  array('login' => $login, 'password' => $password), null);
    if ($oid != null)
    {
      $user = &$persistenceFacade->load($oid, BUILDDEPTH_SINGLE);
      // initially load roles
      $user->getRoles();
      return $user;
    }
    return null;
  }

  /**
   * Get the id of the user.
   * @return The id.
   */
  function getUserId()
  {
    return $this->getDBID();
  }

  /**
   * Set the login of the user.
   * @param login The login of the user.
   */
  function setLogin($login)
  {
    WCMFException::throwEx("setLogin() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Get the login of the user.
   * @return The login of the user.
   */
  function getLogin()
  {
    WCMFException::throwEx("getLogin() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Set the password of the user.
   * @param password The unencrypted password of the user.
   */
  function setPassword($password)
  {
    WCMFException::throwEx("setPassword() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Get the password of the user.
   * @return The unencrypted password of the user.
   */
  function getPassword()
  {
    WCMFException::throwEx("getPassword() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Set the name of the user.
   * @param name The name of the user.
   */
  function setName($name)
  {
    WCMFException::throwEx("setName() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Get name of the user.
   * @return The name of the user.
   */
  function getName()
  {
    WCMFException::throwEx("getName() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Set the firstname of the user.
   * @param firstname The firstname of the user.
   */
  function setFirstname($firstname)
  {
    WCMFException::throwEx("setFirstname() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Get the firstname of the user.
   * @return The firstname of the user.
   */
  function getFirstname()
  {
    WCMFException::throwEx("getFirstname() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Set the configuration file of the user.
   * @param config The configuration file of the user.
   */
  function setConfig($config)
  {
    WCMFException::throwEx("setConfig() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Get the configuration file of the user.
   * @return The configuration file of the user.
   */
  function getConfig()
  {
    WCMFException::throwEx("getConfig() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }

  /**
   * Assign a role to the user.
   * @param rolename The role name. e.g. "administrators"
   * @param commit True/False wether to commit the changes or not [default: false].
   */
  function addRole($rolename, $commit=false)
  {
    if ($this->hasRole($rolename))
      return;

    // add the role if existing
    $role = &$this->getRoleByName($rolename);
    if ($role != null)
      $this->addChild($role);

    // commit the changes if requested
    if ($commit)
    {
      $nIter = new NodeIterator($this);
      $cv = new CommitVisitor();
      $cv->startIterator($nIter);
    }
  }

  /**
   * Remove a role from the user.
   * @param rolename The role name. e.g. "administrators"
   * @param commit True/False wether to commit the changes or not [default: false].
   */
  function removeRole($rolename, $commit=false)
  {
    if (!$this->hasRole($rolename))
      return;

    // remove the role if existing
    $role = &$this->getRoleByName($rolename);
    if ($role != null)
    {
      // commit the changes if requested
      if ($commit)
      {
        // mark the child deleted first
        $this->deleteChild($role->getOID());
        $nIter = new NodeIterator($this);
        $cv = new CommitVisitor();
        $cv->startIterator($nIter);
      }

      $this->deleteChild($role->getOID(), true);
    }
  }

  /**
   * Check for a certain role in the user roles.
   * @param rolename The role name to check for. e.g. "administrators"
   * @return True/False whether the user has the role
   */
  function hasRole($rolename)
  {
    $roles = $this->getRoles();
    for ($i=0; $i<sizeof($roles); $i++)
      if ($roles[$i]->getName() == $rolename)
        return true;
    return false;
  }

  /**
   * Get the roles of a user.
   * @return An array holding the role names
   */
  function getRoles()
  {
    if (!$this->_hasOwnRolesLoaded)
    {
      // make sure that the roles are loaded

      // allow this in any case (prevent infinite loops when trying to authorize)
      $rightsManager = &RightsManager::getInstance();
      $isAnonymous = $rightsManager->isAnonymous();
      if (!$isAnonymous)
        $rightsManager->deactivate();

      $this->loadChildren(UserManager::getRoleClassName());

      // reactivate the RightsManager if necessary
      if (!$isAnonymous)
        $rightsManager->activate();

      $this->_hasOwnRolesLoaded = true;
    }
    return $this->getChildrenEx(null, UserManager::getRoleClassName(), null, null);
  }

  /**
   * Get a Role instance whose name is given
   * @param rolename The name of the role
   * @return A reference to the role or null if nor existing
   */
  function &getRoleByName($rolename)
  {
    if (!isset($this->_cachedRoles[$rolename]))
    {
      // load the role
      $persistenceFacade = &PersistenceFacade::getInstance();
      $role = &$persistenceFacade->loadFirstObject(UserManager::getRoleClassName(), BUILDDEPTH_SINGLE, array('name' => $rolename));
      if ($role != null)
        $this->_cachedRoles[$rolename] = &$role;
      else
        return null;
    }
    return $this->_cachedRoles[$rolename];
  }

  /**
   * This class caches loaded roles for performance reasons. After retrieving
   * an instance from the session, the cache is invalid and must be reseted using
   * this method.
   */
  function resetRoleCache()
  {
    $this->_cachedRoles = array();
    $this->_hasOwnRolesLoaded = false;
  }
}
?>