GMail

Complexity

Total Complexity

40

Size/Duplication

Total Lines	296
Duplicated Lines	0 %

Importance

Changes	11
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	watch()	0	21	5
A	init()	0	4	1
A	__construct()	0	4	2
A	getProfile()	0	7	2
B	getMessages()	0	31	9
A	process_response()	0	4	1
A	getMessage()	0	16	5
A	endWatch()	0	8	2
A	getToken()	0	30	3
A	getAuthorizeUrl()	0	13	3
A	getLabels()	0	10	2
A	setAccessToken()	0	2	1
A	getClientId()	0	2	1
A	refreshAccessToken()	0	28	3

<?php
declare(strict_types=1);
defined('BASEPATH') OR exit('No direct script access allowed');

require_once('GMailScopes.php');
require_once('GMailUtil.php');
require_once('Message.php');

class GMail {

  const AUTH_URL  = 'https://accounts.google.com/o/oauth2/auth';
  const TOKEN_URL = 'https://www.googleapis.com/oauth2/v4/token';
  const API       = 'https://www.googleapis.com/gmail/v1/users/';
  const HTTP_CODE = 'http_code';
  private $clientId;
  private $clientSecret;
  private $redirectUri = 'urn:ietf:wg:oauth:2.0:oob';
  private $token;
  private $userAgent = 'CodeIgniter GMail API';

  function __construct($params=null) {
    get_instance()->load->splint('francis94c/ci-gmail', '%curl');

The function get_instance was not found. Maybe you did not declare it correctly or list all dependencies?

    get_instance()->load->splint('francis94c/ci-gmail', '%base64');
    if ($params != null) $this->init($params);
  }

  /**
   * [init Initialize library with cofigs. Can be called multiple times to set
   *       config items]
   * @param array $config Associative Config Array.
   */
  public function init(array $config):void {
    $this->clientId = $config['client_id'] ?? $this->clientId;
    $this->clientSecret = $config['client_secret'] ?? $this->clientSecret;
    $this->redirectUri = $config['redirect_uri'] ?? $this->redirectUri;
  }
  /**
   * [setAccessToken description]
   * @param string $token [description]
   */
  public function setAccessToken(string $token):void {
    $this->token = $token;
  }
  /**
   * [getClientId Get Client ID.]
   * @return null|string Client ID.
   */
  public function getClientId():?string {
    return $this->clientId;
  }
  /**
   * [getAuthorizeUrl Gets/composes the authorize url to direct users to so they
   *                  can give your application access to their GMail accounts
   *                  based on the given scopes.]
   * @param  string $scope        Access Scope.
   * @param  string $redirectUri  URL to redirect to after access is granted.
   * @param  string $responseType Response type. 'code' by default.
   * @param  bool   $prompt       Add the prompt=consent query to the URL.
   * @return string               Authorize URL
   */
  public function getAuthorizeUrl(string $scope, string $redirectUri=null, string $responseType='code', string $accessType='offline', bool $prompt=false):string
  {
    $redirectUri = $redirectUri ?? $this->redirectUri;
    if ($scope == null) throw new Exception("GMail scope cannot be null");
    $params = [
      'client_id'     => $this->clientId,
      'redirect_uri'  => $redirectUri,
      'scope'         => $scope,
      'response_type' => $responseType,
      'access_type'   => $accessType
    ];
    if ($prompt) $params['prompt'] = 'consent';
    return self::AUTH_URL . build_url_query($params, false);
  }
  /**
   * [getToken description]
   * @param  string $code [description]
   * @return [type]       [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

   */
  public function getToken(string $code, string $redirectUri=null):?array
  {
    $redirectUri = $redirectUri ?? $this->redirectUri;

The assignment to $redirectUri is dead and can be removed.

    $ch = curl_init(self::TOKEN_URL);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

    curl_setopt($ch, CURLINFO_HEADER_OUT, true);
    if (ENVIRONMENT == 'development') {

The constant ENVIRONMENT was not found. Maybe you did not declare it correctly or list all dependencies?

      curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    }
    $body = http_build_query([
      'code'          => $code,
      'client_id'     => $this->clientId,
      'client_secret' => $this->clientSecret,
      'redirect_uri'  => $this->redirectUri,
      'grant_type'    => 'authorization_code'
    ]);
    $header = [
      'Content-Type: application/x-www-form-urlencoded',
      'Content-Length: ' . strlen($body)
    ];
    curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
    curl_setopt($ch, CURLOPT_USERAGENT, $this->userAgent);
    // Request Method and Body.
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
    $response = curl_exec($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

It seems like $ch can also be of type false; however, parameter $ch of curl_getinfo() does only seem to accept resource, maybe add an additional type check?

    curl_close($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_close() does only seem to accept resource, maybe add an additional type check?

    if ($response !== false) return $this->process_response($code, $response);

It seems like $response can also be of type true; however, parameter $response of GMail::process_response() does only seem to accept string, maybe add an additional type check?

    return null;
  }
  /**
   * [refreshAccessToken description]
   * @param  string $refreshToken [description]
   * @return [type]               [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

   */
  public function refreshAccessToken(string $refreshToken):?array {
    $ch = curl_init(self::TOKEN_URL);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

    curl_setopt($ch, CURLINFO_HEADER_OUT, true);
    if (ENVIRONMENT == 'development') {

The constant ENVIRONMENT was not found. Maybe you did not declare it correctly or list all dependencies?

      curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    }
    $body = http_build_query([
      'refresh_token' => $refreshToken,
      'client_id'     => $this->clientId,
      'client_secret' => $this->clientSecret,
      'grant_type'    => 'refresh_token'
    ]);
    $header = [
      'Content-Type: application/x-www-form-urlencoded',
      'Content-Length: ' . strlen($body)
    ];
    curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
    curl_setopt($ch, CURLOPT_USERAGENT, $this->userAgent);
    // Request Method and Body.
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
    // Exec.
    $response = curl_exec($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

It seems like $ch can also be of type false; however, parameter $ch of curl_getinfo() does only seem to accept resource, maybe add an additional type check?

    curl_close($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_close() does only seem to accept resource, maybe add an additional type check?

    if ($response !== false) return $this->process_response($code, $response);

It seems like $response can also be of type true; however, parameter $response of GMail::process_response() does only seem to accept string, maybe add an additional type check?

    return null;
  }
  /**
   * [getProfile Get user's profile
   * see https://developers.google.com/gmail/api/v1/reference/users/getProfile]
   * @param  string $user [description]
   * @return [type]       [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

   */
  public function getProfile(string $user='me'):?array {
    list($code, $response) = (new GMailCURL(GMailCURL::GET))(
      self::API . "$user/profile",
      ["Authorization: Bearer $this->token"]
    );
    if ($response !== false) return $this->process_response($code, $response);
    return null;
  }
  /**
   * [watch Causes push notifications to be sent on events which occur in the
   * user's mailbox. Requires Google Cloud PubSub.
   * see https://developers.google.com/gmail/api/v1/reference/users/watch]
   * @param  string $topic             Topic to push events to.
   * @param  mixed  $labelIds          Narrow down labels in the mailbox, whose
   *                                   mailbox event, are being listened to.
   *                                   events are to be listened to.
   * @param  string $userId            The ID/Email address of the user.
   * @param  string $labelFilterAction [description]
   * @return [type]                    [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

   */
  public function watch(string $topic, $labelIds=null, string $userId='me', string $labelFilterAction='include'):?array {
    $body = [
      'topicName'         => $topic,
      'labelFilterAction' => $labelFilterAction
    ];

    if ($labelIds != null) {
      if (is_scalar($labelIds)) {
        $body['labelIds'] = [$labelIds];
      } elseif (is_array($labelIds)) {
        $body['labelIds'] = $labelIds;
      }
    }

    list($code, $response) = (new GMailCURL(GMailCURL::POST))(
      self::API . "$userId/watch",
      ["Authorization: Bearer $this->token"],
      $body
    );
    if ($response !== false) return $this->process_response($code, $response);
    return null;
  }
  /**
   * [endWatch stop watch operations on given email ID]
   * @date   2019-11-20
   * @param  string     $userId ID or Email Address of the user.
   * @return bool               [description]
   */
  public function endWatch(string $userId='me'):bool
  {
    list($code, $response) = (new GMailCURL(GMailCURL::POST))(
      self::API . "$userId/stop",
      ["Authorization: Bearer $this->token"]
    );
    if ($response !== false) return $code == 204;
    return false;
  }
  /**
   * [getLabels description]
   * @date   2019-11-20
   * @param  string     $userID [description]
   * @return null|array         [description]
   */
  public function getLabels(string $userId='me'):?array
  {
    list($code, $response) = (new GMailCURL(GMailCURL::GET))(
      self::API . "$userId/labels",
      ["Authorization: Bearer $this->token"]
    );
    if ($response !== false) {
      return json_decode($response)->labels;
    }
    return null;
  }
  /**
   * [getMessages description]
   * @date   2019-11-21
   * @param  string     $userId           [description]
   * @param  [type]     $labelIds         [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

   * @param  [type]     $q                [description]
   * @param  [type]     $maxMessages      [description]
   * @param  [type]     $pageToken        [description]
   * @param  boolean    $includeSpamTrash [description]
   * @param  [type]     $truncateAfter    [description]
   * @return [type]                       [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

   */
  public function getMessages(string $userId='me', array $labelIds=null,
  string $q=null, int $maxMessages=null, string $pageToken=null, bool $includeSpamTrash=false,
  $truncateAfter=null):?object
  {
    $query = [];

    if ($labelIds != null) $query['labelIds'] = $labelIds;
    if ($includeSpamTrash) $query['includeSpamTrash'] = $includeSpamTrash;
    if ($q != null) $query['q'] = $q;

It seems like you are loosely comparing $q of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.

    if ($pageToken != null) $query['pageToken'] = $pageToken;

It seems like you are loosely comparing $pageToken of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.

    if ($maxMessages != null) $query['maxResults'] = $maxMessages;

It seems like you are loosely comparing $maxMessages of type integer|null against null; this is ambiguous if the integer can be zero. Consider using a strict comparison !== instead.

    list($code, $response) = (new GMailCURL(GMailCURL::GET))(
      self::API . "$userId/messages?" . http_build_query($query),
      ["Authorization: Bearer $this->token"]
    );

    if ($response !== false) {
      if ($truncateAfter != null && $code == 200) {
        $response = json_decode($response);
        $response->messages = array_filter($response->messages, function ($e) use ($truncateAfter) {
          return strcmp($truncateAfter, $e->id) <= 0;
        });
        $response->{self::HTTP_CODE} = $code;
        return $response;
      }

      return $this->process_response($code, $response);
    }

    return null;
  }
  /**
   * [getMessage description]
   * @date   2019-11-21
   * @param  string       $userId          [description]
   * @param  string       $messageId       [description]
   * @param  string       $format          [description]
   * @param  [type]       $metadataHeaders [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

   * @return Message|null                  [description]
   */
  public function getMessage(string $userId='me', string $messageId,
  string $format='full', array $metadataHeaders=null):?Message
  {
    $query = [];

    if ($format != 'full' && $format != null) $query['format'] = $format;
    if ($metadataHeaders != null) $query['metadataHeaders'] = $metadataHeaders;

    list($code, $response) = (new GMailCURL(GMailCURL::GET))(
      self::API . "$userId/messages/$messageId?" . http_build_query($query),
      ["Authorization: Bearer $this->token"]
    );

    if ($response !== false) return new Message($response);

    return null;
  }
  /**
   * [process_response description]
   * @param  int    $code   [description]
   * @param  string $response [description]
   * @return [type]         [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

   */
  private function process_response(int $code, string $response) {
    $response = json_decode($response);
    $response->{self::HTTP_CODE} = $code;
    return $response;
  }
}
?>

It is not recommended to use PHP's closing tag ?> in files other than templates.