class DrupalOAuthToken in OAuth 1.0 6.3

Hierarchy

• class \OAuthToken
  • class \DrupalOAuthToken

File

includes/DrupalOAuthToken.inc, line 3

class DrupalOAuthToken extends OAuthToken {
  public $tid = 0;
  public $expires = 0;
  public $type = OAUTH_COMMON_TOKEN_TYPE_REQUEST;
  public $uid = 0;
  public $created = 0;
  public $changed = 0;
  public $services = array();
  public $authorized = 0;
  public $in_database = FALSE;
  public function __construct($key, $secret, $consumer, $params = array()) {
    foreach ($params as $param_key => $value) {
      if (isset($this->{$param_key})) {
        $this->{$param_key} = $value;
      }
    }

    // Backwards compatibility with 6.x-3.0-beta3
    if (empty($consumer) || is_array($consumer)) {
      if (is_array($consumer)) {
        $params = $consumer;
      }
      if (!empty($params['csid'])) {
        $consumer = DrupalOAuthConsumer::loadById($params['csid'], isset($params['services']));
      }
    }
    if (!is_object($consumer)) {
      throw new OAuthException("Needs an associated consumer");
    }
    else {
      $this->consumer = $consumer;
    }
    parent::__construct($key, $secret);
  }

  /**
   * Writes the token to the database
   *
   * @return void
   */
  public function write() {
    $update = !empty($this->tid);
    $primary = $update ? array(
      'tid',
    ) : array();
    if ($this->consumer->provider_consumer) {
      $this->changed = time();
      $values = array(
        'token_key' => $this->key,
        'changed' => $this->changed,
        'services' => json_encode($this->services),
        'authorized' => $this->authorized,
      );
      if ($update) {
        $values['tid'] = $this->tid;
      }
      else {
        $this->created = time();
        $values['created'] = $this->created;
      }
      $ready = drupal_write_record('oauth_common_provider_token', $values, $primary);
      if (!$ready) {
        throw new OAuthException("Couldn't save token");
      }
    }
    $values = array(
      'csid' => $this->consumer->csid,
      'key_hash' => sha1($this->key),
      'token_key' => $this->key,
      'secret' => $this->secret,
      'expires' => $this->expires,
      'type' => $this->type,
      'uid' => $this->uid,
    );
    if ($update) {
      $values['tid'] = $this->tid;
    }
    drupal_write_record('oauth_common_token', $values, $primary);
    $this->tid = $values['tid'];
    $this->in_database = TRUE;
    if (!$update) {
      $values = array(
        'tid' => $this->tid,
        'token_key' => $this->key,
      );
      drupal_write_record('oauth_common_provider_token', $values, array(
        'token_key',
      ));
    }
  }

  /**
   * Deletes the token from the database
   *
   * @return void
   */
  public function delete() {
    self::deleteToken($this->key, $this->consumer);
  }

  /**
   * Deletes the token with the key from the database
   *
   * @param string $key
   *  The key of the token to delete.
   * @param object $consumer
   *  The consumer for which to fetch a token
   * @return void
   */
  public static function deleteToken($key, $consumer) {

    //TODO: Ensure backwards compatibility
    db_query("DELETE t, pt FROM {oauth_common_token} t LEFT JOIN {oauth_common_provider_token} pt ON t.tid = pt.tid\n      WHERE t.key_hash = '%s' AND t.csid = %d", array(
      ':key_hash' => sha1($key),
      ':consumer' => $consumer->csid,
    ));
  }

  /**
   * Deprecated - Gets the token with the specified key
   *
   * @param string $key
   * The key of the token to get
   * @param bool $provider_token
   * Whether the token to load is a provider token.
   * @return DrupalOAuthToken
   * The loaded token object or FALSE if load failed
   */
  public static function load($key, $provider_token = TRUE) {
    return DrupalOAuthToken::loadByKey($key, !$provider_token, FALSE);
  }

  /**
   * Gets the token with the specified key
   *
   * @param string $key
   *  The key of the token to get
   * @param boolean|object $consumer
   *  The consumer for which to fetch a token or FALSE to fetch a provider token
   * @param int $type
   *  Used internally for backwards compatibility with ::load()
   * @return DrupalOAuthToken
   *  The loaded token object or FALSE if load failed
   */
  public static function loadByKey($key, $consumer = FALSE, $type = OAUTH_COMMON_TOKEN_TYPE_ACCESS) {
    $fields = 't.*';
    $join = '';
    $where = "t.key_hash = '%s'";
    $values = array(
      ':key_hash' => sha1($key),
    );

    // Only add if defined - needed for backwards compatibility with deprecated DrupalOAuthToken::load() from 6.x-3.0-beta3
    if ($type !== FALSE) {
      $where .= ' AND t.type = %d';
      $values[':type'] = $type;
    }
    if (!$consumer || is_object($consumer) && $consumer->provider_consumer) {
      $fields .= ', pt.created, pt.changed, pt.services, pt.authorized';
      $join = 'INNER JOIN {oauth_common_provider_token} pt ON pt.tid = t.tid';
    }

    // Only fetch non-provider tokens - needed for backwards compatibility with deprecated DrupalOAuthToken::load() from 6.x-3.0-beta3
    if ($consumer === TRUE) {
      $join = 'LEFT JOIN {oauth_common_provider_token} pt ON pt.tid = t.tid';
      $where .= ' AND pt.tid IS NULL';
    }
    else {
      if ($consumer) {
        $where .= ' AND t.csid = %d';
        $values[':consumer'] = $consumer->csid;
      }
    }
    return self::fromResult(db_query("SELECT " . $fields . " FROM {oauth_common_token} t " . $join . " WHERE " . $where, $values), $consumer);
  }

  /**
   * Gets the token with the specified id
   *
   * @param int $id
   *  The id of the token to get
   * @param boolean $load_provider_data
   *  Whether to load provider related data or not
   * @return DrupalOAuthToken
   *  The loaded token object or FALSE if load failed
   */
  public static function loadById($tid, $load_provider_data = TRUE) {
    $fields = 't.*';
    $join = '';
    if ($load_provider_data) {
      $fields .= ', pt.created, pt.changed, pt.services, pt.authorized';
      $join = 'INNER JOIN {oauth_common_provider_token} pt ON pt.tid = t.tid';
    }
    return self::fromResult(db_query("SELECT " . $fields . " FROM {oauth_common_token} t " . $join . " WHERE t.tid = %d", array(
      ':tid' => $tid,
    )));
  }

  /**
   * Constructs a token from a db-result resource
   *
   * @param resource $res
   *  A database result resource
   * @return DrupalOAuthToken
   *  The constructed token object or NULL if no rows could be read or construction failed
   */
  public static function fromResult($res, $consumer = FALSE) {

    //TODO: Ensure this works with old inputs?
    if ($data = db_fetch_array($res)) {
      if (isset($data['services'])) {
        $data['services'] = json_decode($data['services']);
      }
      $data['in_database'] = TRUE;
      if (is_object($consumer) && $consumer->csid == $data['csid']) {
        $token_consumer = $consumer;
      }
      else {
        $token_consumer = DrupalOAuthConsumer::loadById($data['csid'], isset($data['services']));
      }
      return new DrupalOAuthToken($data['token_key'], $data['secret'], $token_consumer, $data);
    }
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DrupalOAuthToken::$authorized	public	property
DrupalOAuthToken::$changed	public	property
DrupalOAuthToken::$created	public	property
DrupalOAuthToken::$expires	public	property
DrupalOAuthToken::$in_database	public	property
DrupalOAuthToken::$services	public	property
DrupalOAuthToken::$tid	public	property
DrupalOAuthToken::$type	public	property
DrupalOAuthToken::$uid	public	property
DrupalOAuthToken::delete	public	function	Deletes the token from the database
DrupalOAuthToken::deleteToken	public static	function	Deletes the token with the key from the database
DrupalOAuthToken::fromResult	public static	function	Constructs a token from a db-result resource
DrupalOAuthToken::load	public static	function	Deprecated - Gets the token with the specified key
DrupalOAuthToken::loadById	public static	function	Gets the token with the specified id
DrupalOAuthToken::loadByKey	public static	function	Gets the token with the specified key
DrupalOAuthToken::write	public	function	Writes the token to the database
DrupalOAuthToken::__construct	public	function	key = the token secret = the token secret Overrides OAuthToken::__construct
OAuthToken::$key	public	property
OAuthToken::$secret	public	property
OAuthToken::to_string		function	generates the basic string serialization of a token that a server would respond to request_token and access_token calls with
OAuthToken::__toString		function