class.PrincipalController.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.PrincipalController.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once(BASE."wcmf/lib/presentation/class.Controller.php");
require_once(BASE."wcmf/lib/presentation/class.WCMFInifileParser.php");
require_once(BASE."wcmf/lib/persistence/class.PersistenceFacade.php");
require_once(BASE."wcmf/lib/model/class.Node.php");
require_once(BASE."wcmf/lib/util/class.ObjectFactory.php");
require_once(BASE."wcmf/lib/presentation/ListboxFunctions.php");

/**
 * @class PrincipalController
 * @ingroup Controller
 * @brief PrincipalController is used to edit users and roles.
 *
 * <b>Input actions:</b>
 * - @em newprincipal Create a new principal of the given type
 * - @em editprincipal Edit a given principal
 * - @em save Save changes to the given principal
 * - @em delprincipal Delete the given principal
 *
 * <b>Output actions:</b>
 * - @em overview If the action was delprincipal
 * - @em ok In any other case
 *
 * @param[in,out] newtype The principal type to create (user or role)
 * @param[in] deleteoids A comma separated list of principal object ids to delete
 * @param[in,out] oid The object id of the principal to edit
 * @param[in] <oid> A node defining what to save. The node should only contain those values, that should be changed
 *                  This may be achived by creating the node using the node constructor (instead of using PersistenceFacade::create)
 *                  and setting the values on it.
 * @param[in] changepassword If given, the password will tried to be changed
 * @param[in] newpassword1 The new password of the current user
 * @param[in] newpassword2 The new password of the current user repeated
 * @param[in] principals The list of all users that should belong to the displayed role or
 *              the list of all roles that the displayed user should have
 * @param[out] principal The principal to display
 * @param[out] principalBaseList The list of all users, if a role is displayed or 
 *              the list of all roles if a user is displayed
 * @param[out] principalList The list of all users that belong to the displayed role or
 *              the list of all roles that the displayed user has
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class PrincipalController extends Controller
{
  var $_userManager = null;
  
  /**
   * @see Controller::initialize()
   */
  function initialize(&$request, &$response)
  {
    if (strlen($request->getContext()) == 0)
    {
      $request->setContext('user');
      $response->setContext('user');
    }
    
    parent::initialize($request, $response);

    // create UserManager instance
    $objectFactory = &ObjectFactory::getInstance();
    $this->_userManager = &$objectFactory->createInstanceFromConfig('implementation', 'UserManager');
  }
  /**
   * @see Controller::validate()
   */
  function validate()
  {
    if($this->_request->getAction() == 'newprincipal')
    {
      if(strlen($this->_request->getValue('newtype')) == 0)
      {
        $this->setErrorMsg("No 'newtype' given in data.");
        return false;
      }
    }
    if(in_array($this->_request->getAction(), array('editprincipal', 'save')))
    {
      if(strlen($this->_request->getValue('oid')) == 0)
      {
        $this->setErrorMsg("No 'oid' given in data.");
        return false;
      }
    }
    if($this->_request->getAction() == 'delprincipal')
    {
      if(strlen($this->_request->getValue('deleteoids')) == 0)
      {
        $this->setErrorMsg("No 'deleteoids' given in data.");
        return false;
      }
    }
    return true;
  }
  /**
   * @see Controller::hasView()
   */
  function hasView()
  {
    if ($this->_request->getAction() == 'delprincipal')
      return false;
    else
      return true;
  }
  /**
   * Process action and assign data to View.
   * @return Array of given context and action 'overview' on delete.
   *         False else (Stop action processing chain).
   * @see Controller::executeKernel()
   */
  function executeKernel()
  {
    $persistenceFacade = &PersistenceFacade::getInstance();
    $this->_userManager->startTransaction();
    
    // process actions

    // DELETE
    if($this->_request->getAction() == 'delprincipal')
    {
      $deleteOIDs = split(',', $this->_request->getValue('deleteoids'));
      foreach($deleteOIDs as $oid)
      {
        $this->beforeDelete($this->_userManager->getPrincipal($oid));
        $this->_userManager->removePrincipal($oid);
      }
      // return
      $this->_userManager->commitTransaction();
      $this->_response->setAction('overview');
      return true;
    }

    // NEW
    if($this->_request->getAction() == 'newprincipal')
    {
      $newType = $this->_request->getValue('newtype');
      $newNode = new Node($newType);

      if($newType == 'user')
        $newPrincipal = &$this->_userManager->createUser('', '', $newNode->getOID(), '', '');
      else
        $newPrincipal = &$this->_userManager->createRole($newNode->getOID());

      // set the login/name to the oid
      if($newType == 'user')
        $this->_userManager->setUserProperty($newNode->getOID(), USER_PROPERTY_LOGIN, 'user'.$newPrincipal->getDBID());
      else
        $this->_userManager->setRoleProperty($newNode->getOID(), ROLE_PROPERTY_NAME, 'role'.$newPrincipal->getDBID());
      $newPrincipal->save();

      $this->afterInsert($newPrincipal);

      // redirect to edit view by changing the request parameters for the following code
      $this->_request->setAction('editprincipal');
      $this->_request->setValue('oid', $newPrincipal->getOID());
    }

    // EDIT, SAVE
    if (in_array($this->_request->getAction(), array('editprincipal', 'save')) || in_array($this->_request->getContext(), array('user', 'role')))
    {
      // load model
      $principal = &$this->_userManager->getPrincipal($this->_request->getValue('oid'));
      
      // save changes
      if ($this->_request->getAction() == 'save')
      {
        $saveNode = &$this->_request->getValue($this->_request->getValue('oid'));

        if (strtolower(get_class($principal)) == strtolower(UserManager::getUserClassName()))
        {          
          // properties
          foreach(array(USER_PROPERTY_LOGIN, USER_PROPERTY_NAME, USER_PROPERTY_FIRSTNAME, USER_PROPERTY_CONFIG) as $property)
          {
            $value = $saveNode->getValue($property, DATATYPE_ATTRIBUTE);
              if ($value != $principal->getValue($property, DATATYPE_ATTRIBUTE))
              {
                $this->_userManager->setUserProperty($principal->getLogin(), $property, $value);
                $principal->setValue($property, $value, DATATYPE_ATTRIBUTE);
              }
            }
          // password
          if ($this->_request->hasValue('changepassword'))
          {
            $this->_userManager->resetPassword($principal->getLogin(), $this->_request->getValue('newpassword1'), 
                                                 $this->_request->getValue('newpassword2'));
          }
          // roles
          $roles = $this->_userManager->listRoles();
          $userRoles = $this->_userManager->listUserRoles($principal->getLogin());
          $principals = $this->_request->getValue('principals');
          foreach($roles as $curRole)
          {
            if ((is_array($principals) && in_array($curRole, $principals)) && (!is_array($userRoles) || !in_array($curRole, $userRoles)))
              $this->_userManager->addUserToRole($curRole, $principal->getLogin());
            if ((!is_array($principals) || !in_array($curRole, $principals)) && (is_array($userRoles) && in_array($curRole, $userRoles)))
              $this->_userManager->removeUserFromRole($curRole, $principal->getLogin());
          }
        }
        if (strtolower(get_class($principal)) == strtolower(UserManager::getRoleClassName()))
        {
          // properties
          foreach(array(ROLE_PROPERTY_NAME) as $property)
          {
            $value = $saveNode->getValue($property, DATATYPE_ATTRIBUTE);
              if ($value != $principal->getValue($property, DATATYPE_ATTRIBUTE))
              {
                $this->_userManager->setRoleProperty($principal->getName(), $property, $value);
                $principal->setValue($property, $value, DATATYPE_ATTRIBUTE);
            }
          }
          // members
          $users = $this->_userManager->listUsers();
          $roleMembers = $this->_userManager->listRoleMembers($principal->getName());
          $principals = $this->_request->getValue('principals');
          foreach($users as $curUser)
          {
            if (in_array($curUser, $principals) && !in_array($curUser, $roleMembers))
              $this->_userManager->addUserToRole($principal->getName(), $curUser);
            if (!in_array($curUser, $principals) && in_array($curUser, $roleMembers))
              $this->_userManager->removeUserFromRole($principal->getName(), $curUser);
          }
        }
        $this->afterUpdate($this->_userManager->getPrincipal($this->_request->getValue('oid')));
      }

      // reload model
      $principal = &$this->_userManager->getPrincipal($this->_request->getValue('oid'));
      if (strtolower(get_class($principal)) == strtolower(UserManager::getUserClassName()))
      {
        $principalBaseList = $this->_userManager->listRoles();
        $principalList = $this->_userManager->listUserRoles($principal->getLogin());
      }
      elseif (strtolower(get_class($principal)) == strtolower(UserManager::getRoleClassName()))
      {
        $principalBaseList = $this->_userManager->listUsers();
        $principalList = $this->_userManager->listRoleMembers($principal->getName());
      }

      // assign model to view
      $this->_response->setValue('oid', $this->_request->getValue('oid'));
      $this->_response->setValue('newtype', $this->_request->getValue('newtype'));
      $this->_response->setValue('principal', $principal);
      $this->_response->setValue('principalBaseList', join("|", $principalBaseList));
      $this->_response->setValue('principalList', join(",", $principalList));

      $configFiles = WCMFInifileParser::getIniFiles();
      array_push($configFiles, '');
      $this->_response->setValue('configFiles', join("|", $configFiles));
    }

    $this->_userManager->commitTransaction();

    // success
    $this->_response->setAction('ok');
    return false;
  }
  /**
   * Called before deleting an exisiting principal.
   * @note subclasses will override this to implement special application requirements.
   * @param principal A reference to the principal to delete (@see UserManager::getPrincipal).
   */
  function beforeDelete(&$principal) {}
  /**
   * Called after inserting a new principal.
   * @note subclasses will override this to implement special application requirements.
   * @param principal A reference to the principal inserted (@see UserManager::getPrincipal).
   */
  function afterInsert(&$principal) {}
  /**
   * Called after updating an existing principal.
   * @note subclasses will override this to implement special application requirements.
   * @param principal A reference to the principal updated (@see UserManager::getPrincipal).
   */
  function afterUpdate(&$principal) {}
}
?>