You are here

Home » API reference » Rocket.Chat 8.2 » ApiClient.php

class ApiClient in Rocket.Chat 8.2

Same name and namespace in other branches
  1. 8 modules/rocket_chat_api/src/RocketChat/ApiClient.php \Drupal\rocket_chat_api\RocketChat\ApiClient

Class ApiClient.

This class connects the php to the RocketChat Server though its REST-API.

@package RocketChat

Hierarchy

  • class \Drupal\rocket_chat_api\RocketChat\ApiClient

Expanded class hierarchy of ApiClient

11 files declare their use of ApiClient
ApiTestForm.php in modules/rocket_chat_api_test/src/Form/ApiTestForm.php
Contains \Drupal\rocket_chat_api_test\Form\ApiTestForm.
Channel.php in modules/rocket_chat_api/src/RocketChat/Element/Channel.php
Channels.php in modules/rocket_chat_api/src/RocketChat/Collection/Channels.php
GroupChannel.php in modules/rocket_chat_group/src/Plugin/Field/FieldType/GroupChannel.php
Groups.php in modules/rocket_chat_api/src/RocketChat/Collection/Groups.php

... See full list

File

modules/rocket_chat_api/src/RocketChat/ApiClient.php, line 37

Namespace

Drupal\rocket_chat_api\RocketChat
View source 
class ApiClient {

  /**
   * The HTTP Verb for Getting stuff. WARNING This will be part of the URL!
   */
  const HTTP_GET = 'GET';

  /**
   * The HTTP Verb for Creating. and sometimes Updating.
   */
  const HTTP_POST = 'POST';

  /**
   * GuzzleClient Object.
   *
   * @var GuzzleClient
   *  This object is a reference to the Guzzle Client.
   */
  private $client;

  /**
   * Config Object.
   *
   * @var \Drupal\rocket_chat_api\RocketChat\RocketChatConfigInterface
   *   RocketChatConfigInterface object.
   */
  private $config;
  private $loggedIn = FALSE;

  /**
   * Is the Client Logged in.
   *
   * @return bool
   *   Are we Logged in?
   */
  public function isLoggedIn() : bool {
    return $this->loggedIn;
  }

  /**
   * ApiClient constructor.
   *
   *  Loads in the configuration from the Drupal Variables and preparers the
   *  Client with some defaults and base values for ease of use.
   *
   * @param \Drupal\rocket_chat_api\RocketChat\RocketChatConfigInterface $config
   *   class that holds the glue between the implementation's of this Code.
   * @param bool $login
   *   When true the stored login tokens will not be used. when false the
   *   stored login tokens will be used. This is to facilitate login and
   *   non-auth calls. Or in other words, is this a login call.
   */
  public function __construct(RocketChatConfigInterface $config, $login = FALSE) {
    $this->config = $config;
    if (!empty($config)) {
      $this->client = $this
        ->createClient($login);
      $userToken = $this->config
        ->getElement("rocket_chat_uit");
      if (empty($userToken)) {
        $this->loggedIn = FALSE;
      }
      else {
        $this->loggedIn = TRUE;
      }
    }
    else {
      $this->config = NULL;
    }
  }

  /**
   * Create a Guzzle client Object.
   *
   * @param bool $login
   *   Filter out the login credentials.
   *
   * @return GuzzleClient
   *   New HTTP Client.
   */
  private function createClient($login = FALSE) {
    $userId = $this->config
      ->getElement("rocket_chat_uid");
    $userToken = $this->config
      ->getElement("rocket_chat_uit");
    $guzzleConfig = [
      'base_uri' => $this->config
        ->getElement('rocket_chat_url', "http://localhost:3000") . '/api/',
      // NOTE: v1/ removed for info. as its Deprecated in 1.0.0
      'allow_redirects' => FALSE,
      'timeout' => 60,
      'debug' => $this->config
        ->isDebug(),
      'headers' => [
        'X-Auth-Token' => $userToken,
        'X-User-Id' => $userId,
      ],
    ];
    if ($login) {

      //Doing a fresh 'login' run.
      unset($guzzleConfig['headers']);
    }
    $guzzleConfig['headers']['Content-Type'] = 'application/json';
    return new GuzzleClient($guzzleConfig);
  }

  /**
   * Do a Login on the Rocket Chat REST API.
   *
   * @param string $id
   *   The Username.
   * @param string $token
   *   The Authentication token. aka password.
   *
   * @return bool
   *   Was the login successful or not.
   */
  public function login($id = NULL, $token = NULL) {
    $rocket = $this->config
      ->getElement('rocket_chat_url', "http://localhost:3000");
    $oldClient = $this->client;
    $this->client = $this
      ->createClient(TRUE);
    $params = [
      'user' => $id,
      'password' => $token,
    ];
    $result = $this
      ->postToRocketChat('login', [
      'json' => $params,
    ]);
    $validReturn = self::validateReturn($result);
    if (!$validReturn && $result['body']['status'] !== 'success') {
      $this->config
        ->notify("Login to {$rocket} was Unsuccessful.", 'error');
      unset($this->client);
      $this->client = $oldClient;
      return FALSE;
    }
    else {
      unset($oldClient);
      $this->config
        ->setElement("rocket_chat_uid", $result['body']['data']['userId']);
      unset($result['body']['data']['userId']);
      $this->config
        ->setElement("rocket_chat_uit", $result['body']['data']['authToken']);
      unset($result['body']['data']['authToken']);
      $this->config
        ->notify("Login to {$rocket} was Successful.", 'status');
      $this->client = $this
        ->createClient(FALSE);
      $this->loggedIn = TRUE;
      return TRUE;
    }
  }

  /**
   * This function does a simple call to the backend and checks if it succeeeds.
   * @return bool
   */
  public function ping() {
    return $this
      ->info()['code'] === 200;
  }

  /**
   * Send message to Rocket Chat.
   *
   * @param string $method
   *   The method to call (so the part after '/api/v1/').
   * @param array $options
   *   Optional Data payload. for HTTP_POST calls.
   *
   * @return array
   *   Result array.
   */
  public function postToRocketChat($method = "info", array $options = []) {
    return $this
      ->sendToRocketChat(ApiClient::HTTP_POST, $method, $options);
  }

  /**
   * Simple low level helper to GET or POST to the rocketchat.
   *
   * @param string $httpVerb
   *   one of the HTTP_* Verbs to use for this call.
   * @param string $method
   *   The method to call (so the part after '/api/v1/').
   * @param array $options
   *   Optional Data payload. for HTTP_POST calls.
   *
   * @return array
   *   Result array.
   */
  private function sendToRocketChat($httpVerb = ApiClient::HTTP_GET, $method = "info", array $options = []) {
    $result = new stdClass();
    if ($method !== "info") {
      $method = "v1/{$method}";
    }
    $resultHeader = [];
    $resultString = "";
    $resultStatus = "BROKEN";
    $resultCode = 0;
    try {
      switch ($httpVerb) {
        case ApiClient::HTTP_GET:
          $result = $this->client
            ->get($method, $options);
          break;
        case ApiClient::HTTP_POST:
          $result = $this->client
            ->post($method, $options);
          break;
        default:
          throw new ClientException("HTTP Verb is unsupported", NULL, NULL, NULL, NULL);
      }
      $resultString = (string) $result
        ->getBody();

      // HTTP Headers.
      $resultHeader = $result
        ->getHeaders();

      // HTTP Response Code (like 200).
      $resultCode = $result
        ->getStatusCode();

      // HTTP Response String (like OK).
      $resultStatus = $result
        ->getReasonPhrase();
    } catch (ServerException $e) {
      $resultStatus = $e
        ->getMessage();
      $resultCode = $e
        ->getCode();
      $resultString = [];
      $resultString['status'] = 'failed';
      $resultString['response'] = $e
        ->getResponse();
      $resultHeader['content-type'][0] = "Error";
    } catch (ClientException $e) {
      $resultStatus = $e
        ->getMessage();
      $resultCode = $e
        ->getCode();
      $resultString = [];
      $resultString['status'] = 'failed';
      $resultString['response'] = $e
        ->getResponse();
      $resultHeader['content-type'][0] = "Error";
    } catch (Exception $e) {
      Drupal::messenger()
        ->addError("ERROR " . $e
        ->getMessage());
    }
    if (isset($resultHeader['content-type']) && !isset($resultHeader['Content-Type'])) {

      // Quick fix to prevent errors due to capitalization of content-type
      // in the header.
      $resultHeader['Content-Type'] = $resultHeader['content-type'];
    }
    if ($resultHeader['Content-Type'][0] == 'application/json') {
      $jsonDecoder = $this->config
        ->getJsonDecoder();
      $resultString = $jsonDecoder($resultString);
    }
    $returnValue = [];
    $returnValue['result'] = $result;
    $returnValue['body'] = $resultString;
    $returnValue['status'] = $resultStatus;
    $returnValue['code'] = $resultCode;
    return $returnValue;
  }

  /**
   * Checks for several different type of error states.
   *
   * @param array $result
   *   Result to check.
   *
   * @return bool
   *   does the Return seem ok?
   */
  public static function validateReturn(array &$result) {
    if (!isset($result)) {
      return FALSE;
    }
    if (empty($result)) {
      return FALSE;
    }
    if (!is_array($result)) {
      return FALSE;
    }
    if (!isset($result['status'])) {
      return FALSE;
    }
    if ($result['status'] = 'failed') {
      return FALSE;
    }

    // All seems OK, so returning TRUE.
    return TRUE;
  }

  /**
   * Retrieve the information about myself, the 'me' command.
   *
   * @return array
   *   Result array.
   */
  public function whoAmI() {
    return $this
      ->getFromRocketChat('me');
  }

  /**
   * Low Level GET request to the rocketchat.
   *
   * @param string $method
   *   The method to call (so the part after '/api/v1/').
   * @param array $options
   *   Optional Data payload. for HTTP_POST calls.
   *
   * @return array
   *   Result array.
   */
  public function getFromRocketChat($method = "info", array $options = []) {
    return $this
      ->sendToRocketChat(ApiClient::HTTP_GET, $method, $options);
  }

  /**
   * Retrieve the Rocket chat status info.
   *
   * @return array
   *   Result array.
   */
  public function info() {
    return $this
      ->getFromRocketChat('info');
  }

  /**
   * Logout a session.
   *
   * @return array
   *   Result array.
   */
  public function logout() {
    $logoutResult = $this
      ->postToRocketChat('logout');
    if (self::validateReturn($logoutResult)) {
      $this->loggedIn = FALSE;
    }
    return $logoutResult;
  }

  /**
   * Execute as different user.
   *
   * @param string $otherUserId
   *   UserID of user to sudo as.
   * @param string $functionName
   *   Function Name to call.
   * @param array $args
   *   Function Arguments.
   *
   * @return mixed
   *   Result of Call.
   *
   * @throws \Exception
   *   When there is an exception in the call, it is rethrown after cleanup.
   */
  public function sudo($otherUserId, $functionName, ...$args) {
    $empty = "";
    if ($functionName == 'login' || $functionName == 'logout') {
      throw new BadFunctionCallException("{$functionName} must be used directly not through sudo.", 502);
    }
    $returnValue = NULL;
    $originalConfig = $this->config;
    $newConfig = new InMemoryConfig($this->config, $empty, $empty);
    try {
      $authToken = $this
        ->postToRocketChat('users.createToken', [
        'json' => [
          'userId' => $otherUserId,
        ],
      ]);
      $newConfig
        ->setElement('rocket_chat_uid', $authToken['body']['data']['userId']);
      $newConfig
        ->setElement('rocket_chat_uit', $authToken['body']['data']['authToken']);
      $this->config = $newConfig;
      $this->client = $this
        ->createClient(FALSE);

      // Do Function call!
      $returnValue = $this
        ->{$functionName}(...$args);
    } catch (Exception $e) {
      throw $e;
    } finally {
      $this->config = $originalConfig;
      $this->client = $this
        ->createClient(FALSE);
    }
    return $returnValue;
  }

  /**
   * Retrieve User information.
   *
   * @param string $userId
   *   The userId to look up.
   * @param string $userName
   *   The username to look up.
   *
   * @return array
   *   Result array.
   */
  public function usersInfo($userId = NULL, $userName = NULL) {
    $req = [];
    $req['query'] = [];
    if (!empty($userId)) {
      $req['query']['userId'] = $userId;
    }
    if (!empty($userName)) {
      $req['query']['username'] = $userName;
    }
    return $this
      ->getFromRocketChat('users.info', $req);
  }

  /**
   * Logout a session.
   *
   * @return array
   *   Result array
   */
  public function usersList() {
    return $this
      ->getFromRocketChat('users.list');
  }

  /**
   * Create a new Channel.
   *
   * @param string $name
   *   The new channel name.
   * @param array $members
   *   The list of the users of this channel.
   *
   * @return array
   *   Result array.
   */
  public function channelsCreate($name, array $members = []) {
    $options["name"] = $name;
    if (!empty($members)) {
      $options['members'] = $members;
    }
    return $this
      ->postToRocketChat('channels.create', [
      'json' => $options,
    ]);
  }

  /**
   * Retrieve User information.
   *
   * @param string $offset
   *   What offset do you want to use, 0-based.
   * @param string $count
   *   How many do you want to retrieve.
   *
   * @return array
   *   Result array.
   */
  public function channelsList($offset = NULL, $count = NULL) {
    $req = [];
    $req['query'] = [];
    if (!empty($offset)) {
      $req['query']['offset'] = $offset;
    }
    if (!empty($count)) {
      $req['query']['count'] = $count;
    }
    if (empty($req)) {
      unset($req);
      $req = NULL;
    }
    return $this
      ->getFromRocketChat('channels.list', $req);
  }

  /**
   * Retrieve User information.
   *
   * @param string $roomId
   *   The roomId to look up.
   * @param string $roomName
   *   The room name to look up.
   *
   * @return array
   *   Result array
   */
  public function channelsInfo($roomId = NULL, $roomName = NULL) {
    $req = [];
    $req['query'] = [];
    if (!empty($roomId)) {
      $req['query']['roomId'] = $roomId;
    }
    if (!empty($roomName)) {
      $req['query']['roomName'] = $roomName;
    }
    return $this
      ->getFromRocketChat('channels.info', $req);
  }

  /**
   * Retrieve the message history information.
   *
   * @param string $roomId
   *   The roomId to look up.
   * @param bool $unreads
   *   Include the amount of unreads.
   * @param bool $inclusive
   *   Are the limits inclusive or exclusive.
   * @param int $count
   *   How many to retrieve max.
   * @param string $latest
   *   Timestring for the jongest message to retrieve.
   * @param string $oldest
   *   Timestring for the max age of a message.
   *
   * @return array
   *   Result Array.
   */
  public function channelsHistory($roomId, $unreads = NULL, $inclusive = NULL, $count = NULL, $latest = NULL, $oldest = NULL) {

    // Time Example = "1970-01-01T01:00:00.00Z".
    $req = [];
    $req['query'] = [];
    $req['query']['roomId'] = $roomId;
    if (!empty($latest)) {
      $req['query']['latest'] = $latest;
    }
    if (!empty($oldest)) {
      $req['query']['oldest'] = $oldest;
    }
    if (isset($inclusive)) {
      $req['query']['inclusive'] = $inclusive;
    }
    if (!empty($count)) {
      $req['query']['count'] = $count;
    }
    if (isset($unreads)) {
      $req['query']['unreads'] = $unreads;
    }
    return $this
      ->getFromRocketChat('channels.history', $req);
  }

  /**
   * Send a Message to the rocketchat.
   *
   * @param string $roomId
   *   Room ID.
   * @param string $channel
   *   Channel Name.
   * @param string $text
   *   Text.
   * @param string $alias
   *   Alias.
   * @param string $emoji
   *   Emoji.
   * @param string $avatar
   *   Avatar link.
   * @param mixed $attachments
   *   Attachments array.
   *
   * @return array
   *   Result array
   */
  public function postMessage($roomId = NULL, $channel = NULL, $text = NULL, $alias = NULL, $emoji = NULL, $avatar = NULL, $attachments = NULL) {
    $params = [];
    if (!empty($roomId)) {
      $params['roomId'] = $roomId;
    }
    if (!empty($channel)) {
      $params['channel'] = $channel;
    }
    if (!empty($text)) {
      $params['text'] = $text;
    }
    if (!empty($alias)) {
      $params['alias'] = $alias;
    }
    if (!empty($emoji)) {
      $params['emoji'] = $emoji;
    }
    if (!empty($avatar)) {
      $params['avatar'] = $avatar;
    }
    if (!empty($attachments)) {
      $params['attachments'] = $attachments;
    }
    return $this
      ->postToRocketChat('chat.postMessage', [
      'json' => $params,
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ApiClient::$client private property GuzzleClient Object.
ApiClient::$config private property Config Object.
ApiClient::$loggedIn private property
ApiClient::channelsCreate public function Create a new Channel.
ApiClient::channelsHistory public function Retrieve the message history information.
ApiClient::channelsInfo public function Retrieve User information.
ApiClient::channelsList public function Retrieve User information.
ApiClient::createClient private function Create a Guzzle client Object.
ApiClient::getFromRocketChat public function Low Level GET request to the rocketchat.
ApiClient::HTTP_GET constant The HTTP Verb for Getting stuff. WARNING This will be part of the URL!
ApiClient::HTTP_POST constant The HTTP Verb for Creating. and sometimes Updating.
ApiClient::info public function Retrieve the Rocket chat status info.
ApiClient::isLoggedIn public function Is the Client Logged in.
ApiClient::login public function Do a Login on the Rocket Chat REST API.
ApiClient::logout public function Logout a session.
ApiClient::ping public function This function does a simple call to the backend and checks if it succeeeds.
ApiClient::postMessage public function Send a Message to the rocketchat.
ApiClient::postToRocketChat public function Send message to Rocket Chat.
ApiClient::sendToRocketChat private function Simple low level helper to GET or POST to the rocketchat.
ApiClient::sudo public function Execute as different user.
ApiClient::usersInfo public function Retrieve User information.
ApiClient::usersList public function Logout a session.
ApiClient::validateReturn public static function Checks for several different type of error states.
ApiClient::whoAmI public function Retrieve the information about myself, the 'me' command.
ApiClient::__construct public function ApiClient constructor.