class LingotekSession in Lingotek Translation 6

Hierarchy

• class \LingotekSession

File

./lingotek.session.inc, line 11

Handles api calls, logging in and logging out of LingoTek

class LingotekSession {
  private $url;
  private $community;
  private $login_id;
  private $logged_in = FALSE;
  private $headers = array();

  //API calls that don't need to log in.
  private $sessionless = array(
    'login',
    'keyLogin',
  );

  /*
   * Constructor
   */
  function __construct() {
    $this->url = variable_get('lingotek_url', 'http://myaccount.lingotek.com') . "/lingopoint/api";
    $this->community = variable_get('lingotek_community', '');
    $this->login_id = variable_get('lingotek_login_id', '');
    $this->key = variable_get('lingotek_login_key', '');
    $this->password = variable_get('lingotek_password', '');
  }

  /*
   * Destructor which logs out of the lingotek platform
   */
  function __destruct() {
    if ($this
      ->isLoggedIn()) {
      $this
        ->logout();
    }
  }

  //--------------------

  //Public Functions

  /*
   * Determines if the user is currently logged in to the lingotek platform
   */
  public function isLoggedIn() {
    return $this->logged_in;
  }

  /*
   * Determines if the user can log in and if so, logs in
   */
  public function canLogIn() {
    if (!$this
      ->isLoggedIn()) {
      $this
        ->login();
    }
    return $this
      ->isLoggedIn();
  }

  /*
   * Makes a request to a Lingotek API
   *
   * @param $api
   *  name of the api to call
   * @param $params
   *  key/value pairs to call as parameters in the api
   * @param $data
   *  associative array with further information to use if there is an error
   * @param $returnJson
   *  default TRUE, return json response or the all of the data?
   *
   * @return
   *  object representing the json returned by the api
   */
  public function request($api, $params = NULL, $data = NULL, $returnJson = TRUE) {
    if (!$this
      ->isLoggedIn() && !in_array($api, $this->sessionless)) {
      $this
        ->login();
    }
    $query = "";
    if (isset($params)) {
      $query = http_build_query($params, '', '&');
    }
    $this->headers["Content-Type"] = "application/x-www-form-urlencoded;";
    $response = drupal_http_request($this->url . "/" . $api, $this->headers, 'POST', $query);
    if ($returnJson) {
      $json = json_decode($response->data);
      if ($json->results != "success") {
        lingotek_error('API ' . $api . ' FAILED', array(
          'params' => $params,
          'response' => $json,
        ), 1);
      }
      return $json;
    }
    else {
      return $response;
    }
  }

  /*
   * Downloads a document from Lingotek
   *
   * @param $api
   *  name of the api to call
   * @param $params
   *  key/value pairs to call as parameters in the api
   *
   * @return
   *  location of the file
   */
  public function download($api, $params) {
    $result = $this
      ->request($api, $params, NULL, FALSE);
    $tmpFile = tempnam(file_directory_temp(), "lingotek");
    $fp = fopen($tmpFile, 'w');
    fwrite($fp, $result->data);
    fclose($fp);
    $json = json_decode($result->data);
    if (isset($json->results)) {
      lingotek_error('Error downloading document', array(
        'params' => $params,
        'response' => $file_uri,
      ), 1);
      return "";
    }
    $text = "";
    $file = FALSE;

    //downloadDocument zips the file up
    if ($api == 'downloadDocument') {
      $zip = new ZipArchive();
      $zip
        ->open($tmpFile);
      $name = $zip
        ->getNameIndex(0);
      $file = $zip
        ->getStream($name);
    }
    else {
      $file = fopen($tmpFile, "r");
    }
    if ($file) {
      while (!feof($file)) {
        $text .= fread($file, 2);
      }
    }
    fclose($file);
    unlink($tmpFile);
    return $text;
  }

  //--------------------

  //Static Functions

  /*
   * Hash the key for logging in for this user.
   */
  public static function create_mac($json_msg) {
    $resp = base64_encode(hash_hmac('sha256', $json_msg, pack('H*', variable_get('lingotek_login_key', '')), TRUE));
    return $resp;
  }

  //--------------------

  //Private Functions

  /*
   * login to the lingotek platform
   */
  private function login($version = "3.11", $xml = FALSE) {
    if ($this->key == "") {
      $params = array(
        'userLogin' => $this->login_id,
        'password' => $this->password,
        'version' => $version,
        'community' => $this->community,
      );
      $login = 'login';
    }
    else {
      $arr = array(
        'community' => $this->community,
        'login_id' => $this->login_id,
        'time' => time(),
      );
      $json_str = json_encode($arr);
      $params = array(
        "auth_json" => $json_str,
        "hmac" => LingotekSession::create_mac($json_str),
        "version" => $version,
        "returnXML" => $xml,
      );
      $login = 'keyLogin';
    }
    $data = $this
      ->request($login, $params, NULL, FALSE);
    $response = json_decode($data->data);
    if ($response && $response->results == "success") {
      $this->headers = array(
        "Cookie" => $data->headers['Set-Cookie'],
      );
      $this->logged_in = TRUE;
    }
    else {
      $this->logged_in = FALSE;
      lingotek_error("Unable to log in", array(
        'params' => $params,
        'error' => isset($data->error) ? $data->error : "",
        'response' => $response,
      ), 2, WATCHDOG_WARNING);
    }
  }

  /*
   * logout from the lingotek platform
   */
  private function logout() {
    $json = $this
      ->request('logout');
    if ($json->results == "success") {
      $this->logged_in = FALSE;
    }
    else {
      $this->logged_in = TRUE;
      lingotek_error('Unable to log out.');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LingotekSession::$community	private	property
LingotekSession::$headers	private	property
LingotekSession::$logged_in	private	property
LingotekSession::$login_id	private	property
LingotekSession::$sessionless	private	property
LingotekSession::$url	private	property
LingotekSession::canLogIn	public	function
LingotekSession::create_mac	public static	function
LingotekSession::download	public	function
LingotekSession::isLoggedIn	public	function
LingotekSession::login	private	function
LingotekSession::logout	private	function
LingotekSession::request	public	function
LingotekSession::__construct		function
LingotekSession::__destruct		function