class Instagram in Drupagram 7
Same name and namespace in other branches
- 6 drupagram.lib.php \Instagram
Primary Instagram API implementation class Supports the full REST API for drupagram.
Hierarchy
- class \Instagram
Expanded class hierarchy of Instagram
3 string references to 'Instagram'
- drupagram_menu in ./
drupagram.module - Implements hook_menu().
- drupagram_views_data in ./
drupagram.views.inc - Implements hook_views_data().
- drupagram_views_default_views in ./
drupagram.views_default.inc - Implements hook_views_default_views().
File
- ./
drupagram.lib.php, line 75 - Classes to implement the full Instagram API
View source
class Instagram {
/**
* The name of the GET param that holds the authentication code
* @var string
*/
const RESPONSE_CODE_PARAM = 'code';
/**
* @var $format API format to use: can be json or xml
*/
protected $format = 'json';
/**
* @var $source the drupagram api 'source'
*/
protected $source = 'drupal';
/**
* @var $username Instagram username to use for authenticated requests
*/
protected $username;
/**
* @var $password Instagram password to use for authenticated requests
*/
protected $password;
/**
* JSON encoded OAuth token
* @var string
*/
protected $oauth_token = NULL;
/**
* Decoded plain access token
* @var string
*/
protected $access_token = NULL;
/**
* OAuth user object
* @var object
*/
protected $current_user = NULL;
protected $endpoints = array(
'authorize' => 'oauth/authorize/?client_id=!client_id&redirect_uri=!redirect_uri&response_type=!response_type',
'access_token' => 'oauth/access_token',
'user' => 'v1/users/!user_id/?access_token=!access_token',
'user_feed' => 'v1/users/self/feed?access_token=!access_token&min_id=!min_id&max_id=!max_id&count=!count',
'user_recent' => 'v1/users/!user_id/media/recent/?access_token=!access_token&max_id=!max_id&min_id=!min_id&max_timestamp=!max_timestamp&min_timestamp=!min_timestamp',
'user_search' => 'v1/users/search?q=!q&access_token=!access_token',
'user_follows' => 'v1/users/!user_id/follows?access_token=!access_token',
'user_followed_by' => 'v1/users/!user_id/followed-by?access_token=!access_token',
'user_requested_by' => 'v1/users/self/requested-by?access_token=!access_token',
'user_relationship' => 'v1/users/!user_id/relationship?access_token=!access_token',
'user_liked' => 'v1/users/self/media/liked?access_token=!access_token&max_like_id=!max_like_id&count=!count',
'modify_user_relationship' => 'v1/users/!user_id/relationship?action=%s&access_token=!access_token',
'media' => 'v1/media/!user_id?access_token=!access_token',
'media_search' => 'v1/media/search?lat=%s&lng=%s&max_timestamp=%d&min_timestamp=%d&distance=%d&access_token=!access_token',
'media_popular' => 'v1/media/popular?access_token=!access_token',
'media_comments' => 'v1/media/%d/comments?access_token=!access_token',
'post_media_comment' => 'v1/media/%d/comments?access_token=!access_token',
'delete_media_comment' => 'v1/media/%d/comments?comment_id=%d&access_token=!access_token',
'likes' => 'v1/media/%d/likes?access_token=!access_token',
'post_like' => 'v1/media/%d/likes',
'remove_like' => 'v1/media/%d/likes?access_token=!access_token',
'tags' => 'v1/tags/%s?access_token=!access_token',
'tags_recent' => 'v1/tags/%s/media/recent?max_id=%d&min_id=%d&access_token=!access_token',
'tags_search' => 'v1/tags/search?q=%s&access_token=!access_token',
'locations' => 'v1/locations/%d?access_token=!access_token',
'locations_recent' => 'v1/locations/%d/media/recent/?max_id=%d&min_id=%d&max_timestamp=%d&min_timestamp=%d&access_token=!access_token',
'locations_search' => 'v1/locations/search?lat=%s&lng=%s&foursquare_id=%d&distance=%d&access_token=!access_token',
'geographies' => 'v1/geographies/%d/media/recent?access_token=!access_token',
);
/**
* Constructor for the Instagram class
*/
public function __construct($username = NULL, $access_token = NULL) {
if (!empty($username) && !empty($access_token)) {
$this
->set_auth($username, $access_token);
}
}
/**
* Set the username and password
*/
public function set_auth($username, $access_token) {
$this->username = $username;
$this->access_token = $access_token;
}
/**
* Get an array of Instagram objects from an API endpoint
*/
protected function fetch($key, $params = array(), $use_auth = TRUE) {
$results = array();
if (array_key_exists($key, $this->endpoints)) {
$path = $this->endpoints[$key];
}
else {
watchdog('drupagram', 'Endpoint key not found: !key', array(
'!key' => $key,
), WATCHDOG_ERROR);
return FALSE;
}
$response = $this
->call($path, $params, 'GET', $use_auth);
// Determine the right class to use when returning the results for this key
switch ($key) {
case 'user':
case 'user_search':
case 'user_follows':
case 'user_followed_by':
$class = 'InstagramUser';
break;
default:
$class = 'InstagramMedia';
break;
}
if (isset($response) && is_array($response)) {
$response = array_filter($response);
}
// Check on successfull call
if (!empty($response)) {
foreach ($response as $key => $item) {
if ($key != 'data') {
continue;
}
elseif (!empty($item) && isset($item[0])) {
foreach ($item as $object) {
$results[] = new $class($object);
}
}
else {
$results[] = new $class($item);
}
}
}
// Call might return FALSE , e.g. on failed authentication but an exection
// will be raised, no need for us to do anything special here.
return $results;
}
/**
* Fetch a user's feed
*/
public function user_feed($id = 'self', $params = array(), $use_auth = TRUE) {
$params['!user_id'] = $id;
$params['!count'] = 10;
$result = $this
->fetch('user_feed', $params, $use_auth);
return $result;
}
/**
* Get basic information about a user.
*/
public function user_info($id = 'self', $params = array(), $use_auth = TRUE) {
if (is_numeric($id) || $id == 'self') {
$params['!user_id'] = $id;
}
elseif (is_string($id)) {
return $this
->user_lookup($id);
}
$result = $this
->fetch('user', $params, $use_auth);
return $result;
}
public function user_lookup($username, $params = array(), $use_auth = TRUE) {
$params['!q'] = $username;
$result = $this
->fetch('user_search', $params, $use_auth);
return $result;
}
/**
* See the authenticated user's feed.
* GET /users/self/feed
*
* PARAMETERS
* access_token A valid access token.
* max_id Return media earlier than this max_id
* min_id Return media later than this min_id
* count Count of media to return
*
* @example https://api.instagram.com/v1/users/self/feed?access_token=10920197.f59def8.6670c891a5b4477084ecf66a5aa8e67b
*/
public function self_feed($params = array(), $use_auth = TRUE) {
return $this
->fetch('user_feed', $params, $use_auth);
}
/**
* Get the most recent media published by a user.
* GET /users/{user-id}/media/recent
*
* PARAMETERS
* access_token A valid access token.
* max_id Return media earlier than this max_id
* min_id Return media later than this min_id
* count Count of media to return
* min_timestamp Return media after this UNIX timestamp
* max_timestamp Return media before this UNIX timestamp
*
* @example: https://api.instagram.com/v1/users/3/media/recent/?access_token=10920197.f59def8.6670c891a5b4477084ecf66a5aa8e67b
*/
public function user_recent($id = NULL, $params = array(), $use_auth = TRUE) {
if (empty($id)) {
$params['!user_id'] = 'self';
}
elseif (is_numeric($id)) {
$params['!user_id'] = $id;
}
elseif ($accounts = $this
->user_lookup($id)) {
$params['!user_id'] = $accounts[0]->id;
}
$params['count'] = 10;
// @TODO: Implement a way to remember each user's last image id so we can
// just fetch the images older than that one, hopefully saving requests.
return $this
->fetch('user_recent', $params, $use_auth);
}
/**
* See the authenticated user's list of media they've liked. Note that this
* list is ordered by the order in which the user liked the media. Private
* media is returned as long as the authenticated user has permission to view
* that media. Liked media lists are only available for the currently
* authenticated user.
* GET /users/self/media/liked
*
* PARAMETERS
* access_token A valid access token.
* max_like_id Return media liked before this id
* count Count of media to return
*/
public function self_liked($params = array(), $use_auth = TRUE) {
$params['user-id'] = 'self';
return $this
->fetch('user_liked', $params, $use_auth);
}
/**
* Search for a user by name.
* GET /users/search
*
* PARAMETERS
* q A query string.
* count Number of users to return
*
* @example: https://api.instagram.com/v1/users/search?q=jack&access_token=10920197.f59def8.6670c891a5b4477084ecf66a5aa8e67b
*/
public function user_search($q, $params = array(), $use_auth = TRUE) {
$params['!q'] = $q;
return $this
->fetch('user_search', $params, $use_auth);
}
/**
* Method for calling any drupagram api resource
*/
public function call($path, $params = array(), $method = 'GET', $use_auth = FALSE) {
$url = $this
->create_url($path, '');
try {
if ($use_auth) {
$response = $this
->auth_request($url, $params, $method);
}
else {
$response = $this
->request($url, $params, $method);
}
} catch (InstagramException $e) {
watchdog('drupagram', '!message', array(
'!message' => $e
->__toString(),
), WATCHDOG_ERROR);
return FALSE;
}
if (!$response) {
return FALSE;
}
return $this
->parse_response($response);
}
/**
* Perform an authentication required request.
*/
protected function auth_request($path, $params = array(), $method = 'GET') {
$params['!access_token'] = $this->access_token;
return $this
->request($path, $params, $method, TRUE);
}
/**
* Perform a request
*
* @param string $url
* @param array $params
* @param string $method. Can be one of: GET, POST, DELETE or PUT.
* @param bool $use_auth
* @return type
*/
protected function request($url, $params = array(), $method = 'GET', $use_auth = FALSE, $headers = array()) {
// @TODO: GET requests could potentially be cached.
$data = '';
if (!is_array($params)) {
$params = (array) $params;
}
if (count($params) > 0) {
if ($method == 'GET') {
if (is_array($params) && !empty($params)) {
$url = format_string($url, $params);
}
$url = preg_replace('/&?[a-z_]*=![a-z_]*/', '', $url, -1);
}
else {
$data = http_build_query($params, '', '&');
}
}
if (!is_array($headers)) {
$headers = (array) $headers;
}
// @TODO: implement headers when $use_auth == TRUE
$response = drupal_http_request($url, array(
'headers' => $headers,
'method' => $method,
'data' => $data,
));
if (!isset($response->error)) {
return $response->data;
}
else {
throw new InstagramException($response->error);
}
}
protected function parse_response($response, $format = NULL) {
if (empty($format)) {
$format = $this->format;
}
switch ($format) {
case 'json':
// http://drupal.org/node/985544 - json_decode large integer issue
// $length = strlen(PHP_INT_MAX);
// $response = preg_replace('/"(id|in_reply_to_status_id)":(\d{' . $length . ',})/', '"\1":"\2"', $response);
return json_decode($response, TRUE);
}
}
protected function create_url($path, $format = NULL) {
if (is_null($format)) {
$format = $this->format;
}
$conf = InstagramConf::instance();
$url = $conf
->get('apibase') . '/' . $path;
if (!empty($format)) {
$url .= '.' . $this->format;
}
return $url;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
Instagram:: |
protected | property | Decoded plain access token | 1 |
|
Instagram:: |
protected | property | OAuth user object | |
|
Instagram:: |
protected | property | ||
|
Instagram:: |
protected | property | ||
|
Instagram:: |
protected | property | JSON encoded OAuth token | |
|
Instagram:: |
protected | property | ||
|
Instagram:: |
protected | property | ||
|
Instagram:: |
protected | property | ||
|
Instagram:: |
protected | function | Perform an authentication required request. | 1 |
|
Instagram:: |
public | function | Method for calling any drupagram api resource | |
|
Instagram:: |
protected | function | ||
|
Instagram:: |
protected | function | Get an array of Instagram objects from an API endpoint | |
|
Instagram:: |
protected | function | ||
|
Instagram:: |
protected | function | Perform a request | |
|
Instagram:: |
constant | The name of the GET param that holds the authentication code | ||
|
Instagram:: |
public | function | See the authenticated user's feed. GET /users/self/feed | |
|
Instagram:: |
public | function | See the authenticated user's list of media they've liked. Note that this list is ordered by the order in which the user liked the media. Private media is returned as long as the authenticated user has permission to view that media. Liked… | |
|
Instagram:: |
public | function | Set the username and password | |
|
Instagram:: |
public | function | Fetch a user's feed | |
|
Instagram:: |
public | function | Get basic information about a user. | |
|
Instagram:: |
public | function | ||
|
Instagram:: |
public | function | Get the most recent media published by a user. GET /users/{user-id}/media/recent | |
|
Instagram:: |
public | function | Search for a user by name. GET /users/search | |
|
Instagram:: |
public | function | Constructor for the Instagram class | 1 |