class.HTTPClient.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$
 */
require_once(BASE."wcmf/lib/util/class.Log.php");
require_once(BASE."wcmf/lib/presentation/class.Request.php");
require_once(BASE."wcmf/lib/presentation/class.Response.php");
require_once BASE.'wcmf/3rdparty/zend/Zend/Http/Client.php';

set_include_path(get_include_path().PATH_SEPARATOR.BASE.'wcmf/3rdparty/zend');

/**
 * @class HTTPClient
 * @ingroup Remoting
 * @brief HTTPClient is used to do calls to other wCMF instances over HTTP.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class HTTPClient
{
  private $_client = null;
  private $_user = null;
  
  /**
   * Constructor
   * @param serverUrl The url of the other server instance.
   * @param user The remote user instance.
   */
  function __construct($serverUrl, $user)
  {
    $this->_client = new Zend_Http_Client($serverUrl, array(
        'keepalive' => true,
        'timeout' => 3600
      )
    );
    $this->_client->setMethod(Zend_Http_Client::POST);
    $this->_client->setCookieJar();
    $this->_user = $user;
  } 
  /**
   * Do a call to the remote server.
   * @param request A Request instance
   * @return A Response instance
   */
  function call($request)
  {
    $response = $this->doRemoteCall($request, false);
    return $response;
  }
  /**
   * Do a remote call.
   * @param request The Request instance
   * @param isLogin True/False wether this request is a login request or not
   * @return The Response instance
   */
  protected function doRemoteCall($request, $isLogin)
  {
    // initially login, if no cookie is set
    $cookyJar = $this->_client->getCookieJar();
    if (!$isLogin && sizeof($cookyJar->getAllCookies()) == 0) {
      $response = $this->doLogin();
    }
    
    // do the request
    $request->setResponseFormat(MSG_FORMAT_JSON);
    $this->_client->resetParameters();
    $this->_client->setParameterPost('controller', $request->getSender());
    $this->_client->setParameterPost('context', $request->getContext());
    $this->_client->setParameterPost('usr_action', $request->getAction());
    $this->_client->setParameterPost('format', $request->getFormat());
    $this->_client->setParameterPost('response_format', $request->getResponseFormat());
    $this->_client->setParameterPost($request->getData());
    try {
      $httpResponse = $this->_client->request();
    } 
    catch (Exception $ex) {
      Log::error("Error in remote call to ".$url.":\n".$ex, __FILE__, __LINE__);
      WCMFException::throwEx("Error in remote call to ".$url.": ".$ex->getMessage(), __FILE__, __LINE__);
    }
    
    // deserialize the response
    $responseData = JSONUtil::decode($httpResponse->getBody(), true);
    $response = new ControllerMessage('', '', '', $responseData);
    $response->setFormat(MSG_FORMAT_JSON);
    Formatter::deserialize($response);
    
    // handle errors
    if (!$response->getValue('success'))
    {
      $errorMsg = $response->getValue('errorMsg');
      // if the session expired, try to relogin
      if (strpos('Authorization failed', $errorMsg) === 0 && !$isLogin) {
        $this->doLogin();
      }
      $url = $this->_client->getUri();
      Log::error("Error in remote call to ".$url.": ".$errorMsg."\n".$response->toString(), __FILE__, __LINE__);
      throw new Exception("Error in remote call: $errorMsg");
      //WCMFException::throwEx("Error in remote call: ".$errorMsg, __FILE__, __LINE__);
    }
    return $response;
  }
  /**
   * Do the login request. If the request is successful,
   * the session id will be set.
   * @return True on success
   */
  protected function doLogin()
  {
    if ($this->_user)
    {
      $request = new Request(
        'LoginController', 
        '', 
        'dologin', 
        array(
          'login' => $this->_user->getLogin(), 
          'password' => $this->_user->getPassword(), 
          'password_is_encrypted' => true
        )
      );    
      $response = $this->doRemoteCall($request, true);
      if ($response->getValue('success')) {
        $this->_sessionId = $response->getValue('sid');
        return true;
      }
    }
    else {
      WCMFException::throwEx("Remote user required for remote call.", __FILE__, __LINE__);
    }
  }
  /**
   * Error handling method
   * @param response The Response instance
   */
  protected function handleError($response)
  {
    $errorMsg = $response->getValue('errorMsg');
    Log::error("Error in remote call to ".$this->_serverBase.": ".$errorMsg."\n".$response->toString(), __FILE__, __LINE__);
    WCMFException::throwEx("Error in remote call to ".$this->_serverBase.": ".$errorMsg, __FILE__, __LINE__);
  }
}
?>