<?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

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

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

 * @version    $Id: Twitter.php 23312 2010-11-08 19:45:00Z matthew $

 */

/**

 * @see Zend_Rest_Client

 */

require_once 'Zend/Rest/Client.php';

/**

 * @see Zend_Rest_Client_Result

 */

require_once 'Zend/Rest/Client/Result.php';

/**

 * @see Zend_Oauth_Consumer

 */

require_once 'Zend/Oauth/Consumer.php';

/**

 * @category   Zend

 * @package    Zend_Service

 * @subpackage Twitter

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

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

 */

class Zend_Service_Twitter extends Zend_Rest_Client

{

    /**

     * 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;

    /**

     * OAuth Endpoint

     */

    const OAUTH_BASE_URI = 'http://twitter.com/oauth';

    /**

     * @var Zend_Http_CookieJar

     */

    protected $_cookieJar;

    /**

     * Date format for 'since' strings

     *

     * @var string

     */

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

    /**

     * Username

     *

     * @var string

     */

    protected $_username;

    /**

     * Current method type (for method proxying)

     *

     * @var string

     */

    protected $_methodType;

    /**

     * Zend_Oauth Consumer

     *

     * @var Zend_Oauth_Consumer

     */

    protected $_oauthConsumer = null;

    /**

     * Types of API methods

     *

     * @var array

     */

    protected $_methodTypes = array(

        'status',

        'user',

        'directMessage',

        'friendship',

        'account',

        'favorite',

        'block'

    );

    /**

     * Options passed to constructor

     *

     * @var array

     */

    protected $_options = array();

    /**

     * Local HTTP Client cloned from statically set client

     *

     * @var Zend_Http_Client

     */

    protected $_localHttpClient = null;

    /**

     * Constructor

     *

     * @param  array $options Optional options array

     * @return void

     */

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

    {

        $this->setUri('http://api.twitter.com');

        if (!is_array($options)) $options = array();

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

        if ($options instanceof Zend_Config) {

            $options = $options->toArray();

        }

        $this->_options = $options;

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

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

        }

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

        && $options['accessToken'] instanceof Zend_Oauth_Token_Access) {

            $this->setLocalHttpClient($options['accessToken']->getHttpClient($options));

        } else {

            $this->setLocalHttpClient(clone self::getHttpClient());

            if ($consumer === null) {

                $this->_oauthConsumer = new Zend_Oauth_Consumer($options);

            } else {

                $this->_oauthConsumer = $consumer;

            }

        }

    }

    /**

     * Set local HTTP client as distinct from the static HTTP client

     * as inherited from Zend_Rest_Client.

     *

     * @param Zend_Http_Client $client

     * @return self

     */

    public function setLocalHttpClient(Zend_Http_Client $client)

    {

        $this->_localHttpClient = $client;

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

        return $this;

    }

    /**

     * Get the local HTTP client as distinct from the static HTTP client

     * inherited from Zend_Rest_Client

     *

     * @return Zend_Http_Client

     */

    public function getLocalHttpClient()

    {

        return $this->_localHttpClient;

    }

    /**

     * Checks for an authorised state

     *

     * @return bool

     */

    public function isAuthorised()

    {

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

            return true;

        }

        return false;

    }

    /**

     * Retrieve username

     *

     * @return string

     */

    public function getUsername()

    {

        return $this->_username;

    }

    /**

     * Set username

     *

     * @param  string $value

     * @return Zend_Service_Twitter

     */

    public function setUsername($value)

    {

        $this->_username = $value;

        return $this;

    }

    /**

     * Proxy service methods

     *

     * @param  string $type

     * @return Zend_Service_Twitter

     * @throws Zend_Service_Twitter_Exception If method not in method types list

     */

    public function __get($type)

    {

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

            include_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 Zend_Service_Twitter_Exception 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->setLocalHttpClient($return->getHttpClient($this->_options));

            }

            return $return;

        }

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

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

            throw new Zend_Service_Twitter_Exception(

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

            );

        }

        $test = $this->_methodType . ucfirst($method);

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

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

            throw new Zend_Service_Twitter_Exception(

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

            );

        }

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

    }

    /**

     * Initialize HTTP authentication

     *

     * @return void

     */

    protected function _init()

    {

        if (!$this->isAuthorised() && $this->getUsername() !== null) {

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

            throw new Zend_Service_Twitter_Exception(

                'Twitter session is unauthorised. You need to initialize '

                . 'Zend_Service_Twitter with an OAuth Access Token or use '

                . 'its OAuth functionality to obtain an Access Token before '

                . 'attempting any API actions that require authorisation'

            );

        }

        $client = $this->_localHttpClient;

        $client->resetParameters();

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

            $client->setCookieJar();

            $this->_cookieJar = $client->getCookieJar();

        } else {

            $client->setCookieJar($this->_cookieJar);

        }

    }

    /**

     * Set date header

     *

     * @param  int|string $value

     * @deprecated Not supported by Twitter since April 08, 2009

     * @return void

     */

    protected function _setDate($value)

    {

        if (is_int($value)) {

            $date = date($this->_dateFormat, $value);

        } else {

            $date = date($this->_dateFormat, strtotime($value));

        }

        $this->_localHttpClient->setHeaders('If-Modified-Since', $date);

    }

    /**

     * Public Timeline status

     *

     * @throws Zend_Http_Client_Exception if HTTP request fails or times out

     * @return Zend_Rest_Client_Result

     */

    public function statusPublicTimeline()

    {

        $this->_init();

        $path = '/1/statuses/public_timeline.xml';

        $response = $this->_get($path);

        return new Zend_Rest_Client_Result($response->getBody());

    }

    /**

     * Friend Timeline Status

     *

     * $params may include one or more of the following keys

     * - id: ID of a friend whose timeline you wish to receive

     * - count: how many statuses to return

     * - since_id: return results only after the specific tweet

     * - page: return page X of results

     *

     * @param  array $params

     * @throws Zend_Http_Client_Exception if HTTP request fails or times out

     * @return void

     */

    public function statusFriendsTimeline(array $params = array())

    {

        $this->_init();

        $path = '/1/statuses/friends_timeline';

        $_params = array();

        foreach ($params as $key => $value) {

            switch (strtolower($key)) {

                case 'count':

                    $count = (int) $value;

                    if (0 >= $count) {

                        $count = 1;

                    } elseif (200 < $count) {

                        $count = 200;

                    }

                    $_params['count'] = (int) $count;

                    break;

                case 'since_id':

                    $_params['since_id'] = $this->_validInteger($value);

                    break;

                case 'page':

                    $_params['page'] = (int) $value;

                    break;

                default:

                    break;

            }

        }

        $path .= '.xml';

        $response = $this->_get($path, $_params);

        return new Zend_Rest_Client_Result($response->getBody());

    }

    /**

     * User Timeline status

     *

     * $params may include one or more of the following keys

     * - id: ID of a friend whose timeline you wish to receive

     * - since_id: return results only after the tweet id specified

     * - page: return page X of results

     * - count: how many statuses to return

     * - max_id: returns only statuses with an ID less than or equal to the specified ID

     * - user_id: specifies the ID of the user for whom to return the user_timeline

     * - screen_name: specfies the screen name of the user for whom to return the user_timeline

     * - include_rts: whether or not to return retweets

     * - trim_user: whether to return just the user ID or a full user object; omit to return full object

     * - include_entities: whether or not to return entities nodes with tweet metadata

     *

     * @throws Zend_Http_Client_Exception if HTTP request fails or times out

     * @return Zend_Rest_Client_Result

     */

    public function statusUserTimeline(array $params = array())

    {

        $this->_init();

        $path = '/1/statuses/user_timeline';

        $_params = array();

        foreach ($params as $key => $value) {

            switch (strtolower($key)) {

                case 'id':

                    $path .= '/' . $value;

                    break;

                case 'page':

                    $_params['page'] = (int) $value;

                    break;

                case 'count':

                    $count = (int) $value;

                    if (0 >= $count) {

                        $count = 1;

                    } elseif (200 < $count) {

                        $count = 200;

                    }

                    $_params['count'] = $count;

                    break;

                case 'user_id':

                    $_params['user_id'] = $this->_validInteger($value);

                    break;

                case 'screen_name':

                    $_params['screen_name'] = $this->_validateScreenName($value);

                    break;

                case 'since_id':

                    $_params['since_id'] = $this->_validInteger($value);

                    break;

                case 'max_id':

                    $_params['max_id'] = $this->_validInteger($value);

                    break;

                case 'include_rts':

                case 'trim_user':

                case 'include_entities':

                    $_params[strtolower($key)] = $value ? '1' : '0';

                    break;

                default:

                    break;

            }

        }

        $path .= '.xml';

        $response = $this->_get($path, $_params);

        return new Zend_Rest_Client_Result($response->getBody());

    }

    /**

     * Show a single status

     *

     * @param  int $id Id of status to show

     * @throws Zend_Http_Client_Exception if HTTP request fails or times out

     * @return Zend_Rest_Client_Result

     */

    public function statusShow($id)

    {

        $this->_init();

        $path = '/1/statuses/show/' . $this->_validInteger($id) . '.xml';