<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Service

 * @subpackage Twitter

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

/**

 * @see Zend_Http_Client

 */

require_once 'Zend/Http/Client.php';

/**

 * @see Zend_Http_CookieJar

 */

require_once 'Zend/Http/CookieJar.php';

/**

 * @see Zend_Oauth_Consumer

 */

require_once 'Zend/Oauth/Consumer.php';

/**

 * @see Zend_Oauth_Token_Access

 */

require_once 'Zend/Oauth/Token/Access.php';

/**

 * @see Zend_Service_Twitter_Response

 */

require_once 'Zend/Service/Twitter/Response.php';

/**

 * @category   Zend

 * @package    Zend_Service

 * @subpackage Twitter

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Service_Twitter

{

    /**

     * Base URI for all API calls

     */

    const API_BASE_URI = 'https://api.twitter.com/1.1/';

    /**

     * OAuth Endpoint

     */

    const OAUTH_BASE_URI = 'https://api.twitter.com/oauth';

    /**

     * 246 is the current limit for a status message, 140 characters are displayed

     * initially, with the remainder linked from the web UI or client. The limit is

     * applied to a html encoded UTF-8 string (i.e. entities are counted in the limit

     * which may appear unusual but is a security measure).

     *

     * This should be reviewed in the future...

     */

    const STATUS_MAX_CHARACTERS = 246;

    /**

     * @var array

     */

    protected $cookieJar;

    /**

     * Date format for 'since' strings

     *

     * @var string

     */

    protected $dateFormat = 'D, d M Y H:i:s T';

    /**

     * @var Zend_Http_Client

     */

    protected $httpClient = null;

    /**

     * Current method type (for method proxying)

     *

     * @var string

     */

    protected $methodType;

    /**

     * Oauth Consumer

     *

     * @var Zend_Oauth_Consumer

     */

    protected $oauthConsumer = null;

    /**

     * Types of API methods

     *

     * @var array

     */

    protected $methodTypes = array(

        'account',

        'application',

        'blocks',

        'directmessages',

        'favorites',

        'friendships',

        'search',

        'statuses',

        'users',

    );

    /**

     * Options passed to constructor

     *

     * @var array

     */

    protected $options = array();

    /**

     * Username

     *

     * @var string

     */

    protected $username;

    /**

     * Constructor

     *

     * @param  null|array|Zend_Config $options

     * @param  null|Zend_Oauth_Consumer $consumer

     * @param  null|Zend_Http_Client $httpClient

     */

    public function __construct($options = null, Zend_Oauth_Consumer $consumer = null, Zend_Http_Client $httpClient = null)

    {

        if ($options instanceof Zend_Config) {

            $options = $options->toArray();

        }

        if (!is_array($options)) {

            $options = array();

        }

        $this->options = $options;

        if (isset($options['username'])) {

            $this->setUsername($options['username']);

        }

        $accessToken = false;

        if (isset($options['accessToken'])) {

            $accessToken = $options['accessToken'];

        } elseif (isset($options['access_token'])) {

            $accessToken = $options['access_token'];

        }

        $oauthOptions = array();

        if (isset($options['oauthOptions'])) {

            $oauthOptions = $options['oauthOptions'];

        } elseif (isset($options['oauth_options'])) {

            $oauthOptions = $options['oauth_options'];

        }

        $oauthOptions['siteUrl'] = self::OAUTH_BASE_URI;

        $httpClientOptions = array();

        if (isset($options['httpClientOptions'])) {

            $httpClientOptions = $options['httpClientOptions'];

        } elseif (isset($options['http_client_options'])) {

            $httpClientOptions = $options['http_client_options'];

        }

        // If we have an OAuth access token, use the HTTP client it provides

        if ($accessToken && is_array($accessToken)

            && (isset($accessToken['token']) && isset($accessToken['secret']))

        ) {

            $token = new Zend_Oauth_Token_Access();

            $token->setToken($accessToken['token']);

            $token->setTokenSecret($accessToken['secret']);

            $accessToken = $token;

        }

        if ($accessToken && $accessToken instanceof Zend_Oauth_Token_Access) {

            $oauthOptions['token'] = $accessToken;

            $this->setHttpClient($accessToken->getHttpClient($oauthOptions, self::OAUTH_BASE_URI, $httpClientOptions));

            return;

        }

        // See if we were passed an http client

        if (isset($options['httpClient']) && null === $httpClient) {

            $httpClient = $options['httpClient'];

        } elseif (isset($options['http_client']) && null === $httpClient) {

            $httpClient = $options['http_client'];

        }

        if ($httpClient instanceof Zend_Http_Client) {

            $this->httpClient = $httpClient;

        } else {

            $this->setHttpClient(new Zend_Http_Client(null, $httpClientOptions));

        }

        // Set the OAuth consumer

        if ($consumer === null) {

            $consumer = new Zend_Oauth_Consumer($oauthOptions);

        }

        $this->oauthConsumer = $consumer;

    }

    /**

     * Proxy service methods

     *

     * @param  string $type

     * @return Twitter

     * @throws Exception\DomainException If method not in method types list

     */

    public function __get($type)

    {

        $type = strtolower($type);

        $type = str_replace('_', '', $type);

        if (!in_array($type, $this->methodTypes)) {

            require_once 'Zend/Service/Twitter/Exception.php';

            throw new Zend_Service_Twitter_Exception(

                'Invalid method type "' . $type . '"'

            );

        }

        $this->methodType = $type;

        return $this;

    }

    /**

     * Method overloading

     *

     * @param  string $method

     * @param  array $params

     * @return mixed

     * @throws Exception\BadMethodCallException if unable to find method

     */

    public function __call($method, $params)

    {

        if (method_exists($this->oauthConsumer, $method)) {

            $return = call_user_func_array(array($this->oauthConsumer, $method), $params);

            if ($return instanceof Zend_Oauth_Token_Access) {

                $this->setHttpClient($return->getHttpClient($this->options));

            }

            return $return;

        }

        if (empty($this->methodType)) {

            require_once 'Zend/Service/Twitter/Exception.php';

            throw new Zend_Service_Twitter_Exception(

                'Invalid method "' . $method . '"'

            );

        }

        $test = str_replace('_', '', strtolower($method));

        $test = $this->methodType . $test;

        if (!method_exists($this, $test)) {

            require_once 'Zend/Service/Twitter/Exception.php';

            throw new Zend_Service_Twitter_Exception(

                'Invalid method "' . $test . '"'

            );

        }

        return call_user_func_array(array($this, $test), $params);

    }

    /**

     * Set HTTP client

     *

     * @param Zend_Http_Client $client

     * @return self

     */

    public function setHttpClient(Zend_Http_Client $client)

    {

        $this->httpClient = $client;

        $this->httpClient->setHeaders(array('Accept-Charset' => 'ISO-8859-1,utf-8'));

        return $this;

    }

    /**

     * Get the HTTP client

     *

     * Lazy loads one if none present

     *

     * @return Zend_Http_Client

     */

    public function getHttpClient()

    {

        if (null === $this->httpClient) {

            $this->setHttpClient(new Zend_Http_Client());

        }

        return $this->httpClient;

    }

    /**

     * Retrieve username

     *

     * @return string

     */

    public function getUsername()

    {

        return $this->username;

    }

    /**

     * Set username

     *

     * @param  string $value

     * @return self

     */

    public function setUsername($value)

    {

        $this->username = $value;

        return $this;

    }

    /**

     * Checks for an authorised state

     *

     * @return bool

     */

    public function isAuthorised()

    {

        if ($this->getHttpClient() instanceof Zend_Oauth_Client) {

            return true;

        }

        return false;

    }

    /**

     * Verify Account Credentials

     *

     * @throws Zend_Http_Client_Exception if HTTP request fails or times out

     * @throws Exception\DomainException if unable to decode JSON payload

     * @return Zend_Service_Twitter_Response

     */

    public function accountVerifyCredentials()

    {

        $this->init();

        $response = $this->get('account/verify_credentials');

        return new Zend_Service_Twitter_Response($response);

    }

    /**

     * Returns the number of api requests you have left per hour.

     *

     * @todo   Have a separate payload object to represent rate limits

     * @throws Zend_Http_Client_Exception if HTTP request fails or times out

     * @throws Exception\DomainException if unable to decode JSON payload

     * @return Zend_Service_Twitter_Response

     */

    public function applicationRateLimitStatus()

    {

        $this->init();

        $response = $this->get('application/rate_limit_status');

        return new Zend_Service_Twitter_Response($response);

    }

    /**

     * Blocks the user specified in the ID parameter as the authenticating user.

     * Destroys a friendship to the blocked user if it exists.

     *

     * @param  integer|string $id       The ID or screen name of a user to block.

     * @throws Exception\DomainException if unable to decode JSON payload

     * @return Zend_Service_Twitter_Response

     */

    public function blocksCreate($id)

    {

        $this->init();

        $path     = 'blocks/create';

        $params   = $this->createUserParameter($id, array());

        $response = $this->post($path, $params);

        return new Zend_Service_Twitter_Response($response);

    }

    /**

     * Un-blocks the user specified in the ID parameter for the authenticating user

     *

     * @param  integer|string $id       The ID or screen_name of the user to un-block.

     * @throws Exception\DomainException if unable to decode JSON payload

     * @return Zend_Service_Twitter_Response

     */

    public function blocksDestroy($id)

    {

        $this->init();

        $path   = 'blocks/destroy';

        $params = $this->createUserParameter($id, array());

        $response = $this->post($path, $params);

        return new Zend_Service_Twitter_Response($response);

    }

    /**

     * Returns an array of user ids that the authenticating user is blocking

     *

     * @param  integer $cursor  Optional. Specifies the cursor position at which to begin listing ids; defaults to first "page" of results.

     * @throws Exception\DomainException if unable to decode JSON payload

     * @return Zend_Service_Twitter_Response

     */

    public function blocksIds($cursor = -1)

    {

        $this->init();

        $path = 'blocks/ids';

        $response = $this->get($path, array('cursor' => $cursor));

        return new Zend_Service_Twitter_Response($response);

    }

    /**

     * Returns an array of user objects that the authenticating user is blocking

     *

     * @param  integer $cursor  Optional. Specifies the cursor position at which to begin listing ids; defaults to first "page" of results.

     * @throws Exception\DomainException if unable to decode JSON payload

     * @return Zend_Service_Twitter_Response

     */

    public function blocksList($cursor = -1)

    {

        $this->init();

        $path = 'blocks/list';

        $response = $this->get($path, array('cursor' => $cursor));

        return new Zend_Service_Twitter_Response($response);