<?php

require_once(BASE."wcmf/lib/presentation/class.Controller.php");
require_once(BASE."wcmf/lib/util/class.InifileParser.php");
require_once(BASE."wcmf/lib/security/class.AuthUser.php");
require_once(BASE."wcmf/lib/security/class.UserManager.php");
require_once(BASE."wcmf/lib/persistence/class.LockManager.php");
require_once(BASE."wcmf/lib/util/class.SessionData.php");

/**
 * @class LoginController
 * @ingroup Controller
 * @brief LoginController is a controller that handles the login process.
 * 
 * <b>Input actions:</b>
 * - @em login Present the login dialog
 * - @em dologin Try to login the user with the given credentials
 * - @em logout Terminate the user session
 *
 * <b>Output actions:</b>
 * - @em ok If login succeeded
 * - @em login If login failed
 * 
 * @param[in] login The users login name
 * @param[in] password The user's password
 * @param[in] remember_me If given with any value a login cookie will be created in the browser
 * @param[in] password_is_encrypted True/False wether the given password is encrypted on not (default: false)
 * @param[out] loginmessage A message if login failed
 *
 * @author 	ingo herwig <ingo@wemove.com>
 */
class LoginController extends Controller
{
  var $_anonymous = 0; // in anonymous mode all authorization requests answered positive
	                   // and AuthUser is an instance of AnonymousUser
	                   // The mode is set in configuration section 'cms' key 'anonymous'
  var $NUM_LOGINTRIES_VARNAME = 'LoginController.logintries';
  var $LOGINMESSAGE_VARNAME = 'LoginController.loginmessage';

  /**
   * @see Controller::initialize()
   */
  function initialize(&$request, &$response)
  {
	// delete all data, if not in login process
	if ($request->getAction() != 'dologin')
	  $request->clearValues();

	$parser = &InifileParser::getInstance();
	$this->_anonymous = $parser->getValue('anonymous', 'cms');
	  
	parent::initialize($request, $response);
  }
  /**
   * @see Controller::validate()
   */
  function validate()
  {
	if ($this->_request->getAction() == 'dologin' && !$this->_anonymous)
	{
	  if(!$this->_request->hasValue('login'))
	  {
	    $this->setErrorMsg("No 'login' given in data.");
	    return false;
	  }
	  if(!$this->_request->hasValue('password'))
	  {
	    $this->setErrorMsg("No 'password' given in data.");
	    return false;
	  }
	}
	return true;
  }
  /**
   * @see Controller::hasView()
   */
  function hasView()
  {
	if ($this->_request->getAction() == 'dologin' || $this->_anonymous || $this->isCookieLogin())
	  return false;
	else
	  return true;
  }
  /**
   * If called with any usr_action except 'dologin' this Controller presents the login dialog else
   * if usr_action is 'dologin' it checks the login data ('login' & 'password') and creates AuthUser object in the Session on
   * success (session variable name: auth_user).
   * @return Array of given context and action 'ok' on success, action 'failure' on failure.
   *         False if the login dialog is presented (Stop action processing chain).
   *         In case of 'failure' a detailed description is provided by getErrorMsg().
   * @see Controller::executeKernel()
   */
  function executeKernel()
  {
  	$session = &SessionData::getInstance();

	// return immediately if anonymous
	if ($this->_anonymous)
	{
	  $this->_response->setAction('ok');
	  return true;
	}

	if ($this->_request->getAction() == 'login')
	{
	  // preserve login failure details
	  $loginTries = $session->get($this->NUM_LOGINTRIES_VARNAME);
	  $loginMessage = $session->get($this->LOGINMESSAGE_VARNAME);
	  $session->clear();
	  $session->set($this->NUM_LOGINTRIES_VARNAME, $loginTries);
	  $session->set($this->LOGINMESSAGE_VARNAME, $loginMessage);
	}
	
	if ($this->_request->getAction() == 'dologin')
	{
	  // create AuthUser instance
	  $authUser = new AuthUser();

	  $isPasswordEncrypted = false;
	  if ($this->_request->hasValue('password_is_encrypted'))
	    $isPasswordEncrypted = $this->_request->getValue('password_is_encrypted');

	  if ($authUser->login($this->_request->getValue('login'), $this->_request->getValue('password'), $isPasswordEncrypted))
	  {
	    // login succeeded
	  	$session->clear();
	    $session->set('auth_user', $authUser);

	    // did this user check the 'remember me' checkbox?
	    if($this->_request->getValue('remember_me'))
	    {
	      // if yes store the password login combination in a cookie
	      $expire = time() + 1728000; // expire in 20 days
	      $cookiePassword = UserManager::encryptPassword($this->_request->getValue('password'));
	      
	      setcookie('login', $this->_request->getValue('login'), $expire);
	      setcookie('password', $cookiePassword, $expire);
	    }
	    $this->_response->setAction('ok');
	    return true;
	  }
	  else
	  {
	    // login failed
	  	$logintries = $session->get($this->NUM_LOGINTRIES_VARNAME)+1;
	    $session->set($this->NUM_LOGINTRIES_VARNAME, $logintries);
	    $this->setErrorMsg(Message::get("Login failed. Try again."));
	    $session->set($this->LOGINMESSAGE_VARNAME, $this->getErrorMsg());

	    $this->_response->setAction('login');
	    return true;
	  }
	}
	elseif ($this->_request->getAction() == 'logout')
	{
	  // release all locks
	  $lockManager = &LockManager::getInstance();
	  $lockManager->releaseAllLocks();

	  // delete cookies
	  setcookie('login', '', time()-3600, '/');
	  setcookie('password', '', time()-3600, '/');
	  setcookie(session_name(), '', time()-3600, '/');
	  
	  // clear all session data
	  $session->destroy();

	  // empty response
	  $this->_response->clearValues();
	  return false;
	}
	else
	{
	  // check if the login and password is stored in a cookie
	  if ($this->isCookieLogin())
	  {
	    // if yes redirect to login process
	    $this->_response->setValue('login', $_COOKIE['login']);
	    $this->_response->setValue('password', $_COOKIE['password']);
	    $this->_response->setValue('password_is_encrypted', true);

	    $this->_response->setAction('dologin');
	    return true;
	  }

	  // present login dialog
	  $loginMessage = $session->get($this->LOGINMESSAGE_VARNAME);
		if (strlen($loginMessage) > 0)
	  {
	    $msg = $loginMessage;
	    if ($session->exist($this->NUM_LOGINTRIES_VARNAME))
	      $msg .= " (".Message::get("Attempt")." #".($session->get($this->NUM_LOGINTRIES_VARNAME)+1).")";
	    $this->_response->setValue('loginmessage', $msg);
	  }
	  return false;
	}
  }

  /**
   * Check if the user logs in via cookies
   * @return True/False
   */
  function isCookieLogin()
  {
	return ($this->_request->getAction() == 'login' && isset($_COOKIE['login'], $_COOKIE['password']));
  }
}
?>