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

 * @subpackage YouTube

 * @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: YouTube.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * @see Zend_Gdata_Media

 */

require_once 'Zend/Gdata/Media.php';

/**

 * @see Zend_Gdata_YouTube_VideoEntry

 */

require_once 'Zend/Gdata/YouTube/VideoEntry.php';

/**

 * @see Zend_Gdata_YouTube_VideoFeed

 */

require_once 'Zend/Gdata/YouTube/VideoFeed.php';

/**

 * @see Zend_Gdata_YouTube_CommentFeed

 */

require_once 'Zend/Gdata/YouTube/CommentFeed.php';

/**

 * @see Zend_Gdata_YouTube_PlaylistListFeed

 */

require_once 'Zend/Gdata/YouTube/PlaylistListFeed.php';

/**

 * @see Zend_Gdata_YouTube_SubscriptionFeed

 */

require_once 'Zend/Gdata/YouTube/SubscriptionFeed.php';

/**

 * @see Zend_Gdata_YouTube_ContactFeed

 */

require_once 'Zend/Gdata/YouTube/ContactFeed.php';

/**

 * @see Zend_Gdata_YouTube_PlaylistVideoFeed

 */

require_once 'Zend/Gdata/YouTube/PlaylistVideoFeed.php';

/**

 * @see Zend_Gdata_YouTube_ActivityFeed

 */

require_once 'Zend/Gdata/YouTube/ActivityFeed.php';

/**

 * @see Zend_Gdata_YouTube_InboxFeed

 */

require_once 'Zend/Gdata/YouTube/InboxFeed.php';

/**

 * Service class for interacting with the YouTube Data API.

 * @link http://code.google.com/apis/youtube/

 *

 * @category   Zend

 * @package    Zend_Gdata

 * @subpackage YouTube

 * @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_Gdata_YouTube extends Zend_Gdata_Media

{

    const AUTH_SERVICE_NAME = 'youtube';

    const CLIENTLOGIN_URL = 'https://www.google.com/youtube/accounts/ClientLogin';

    const STANDARD_TOP_RATED_URI = 'http://gdata.youtube.com/feeds/api/standardfeeds/top_rated';

    const STANDARD_MOST_VIEWED_URI = 'http://gdata.youtube.com/feeds/api/standardfeeds/most_viewed';

    const STANDARD_RECENTLY_FEATURED_URI = 'http://gdata.youtube.com/feeds/api/standardfeeds/recently_featured';

    const STANDARD_WATCH_ON_MOBILE_URI = 'http://gdata.youtube.com/feeds/api/standardfeeds/watch_on_mobile';

    const STANDARD_TOP_RATED_URI_V2 =

        'http://gdata.youtube.com/feeds/api/standardfeeds/top_rated';

    const STANDARD_MOST_VIEWED_URI_V2 =

        'http://gdata.youtube.com/feeds/api/standardfeeds/most_viewed';

    const STANDARD_RECENTLY_FEATURED_URI_V2 =

        'http://gdata.youtube.com/feeds/api/standardfeeds/recently_featured';

    const STANDARD_WATCH_ON_MOBILE_URI_V2 =

        'http://gdata.youtube.com/feeds/api/standardfeeds/watch_on_mobile';

    const USER_URI = 'http://gdata.youtube.com/feeds/api/users';

    const VIDEO_URI = 'http://gdata.youtube.com/feeds/api/videos';

    const PLAYLIST_REL = 'http://gdata.youtube.com/schemas/2007#playlist';

    const USER_UPLOADS_REL = 'http://gdata.youtube.com/schemas/2007#user.uploads';

    const USER_PLAYLISTS_REL = 'http://gdata.youtube.com/schemas/2007#user.playlists';

    const USER_SUBSCRIPTIONS_REL = 'http://gdata.youtube.com/schemas/2007#user.subscriptions';

    const USER_CONTACTS_REL = 'http://gdata.youtube.com/schemas/2007#user.contacts';

    const USER_FAVORITES_REL = 'http://gdata.youtube.com/schemas/2007#user.favorites';

    const VIDEO_RESPONSES_REL = 'http://gdata.youtube.com/schemas/2007#video.responses';

    const VIDEO_RATINGS_REL = 'http://gdata.youtube.com/schemas/2007#video.ratings';

    const VIDEO_COMPLAINTS_REL = 'http://gdata.youtube.com/schemas/2007#video.complaints';

    const ACTIVITY_FEED_URI = 'http://gdata.youtube.com/feeds/api/events';

    const FRIEND_ACTIVITY_FEED_URI =

        'http://gdata.youtube.com/feeds/api/users/default/friendsactivity';

    /**

     * The URI of the in-reply-to schema for comments in reply to

     * other comments.

     *

     * @var string

     */

     const IN_REPLY_TO_SCHEME =

         'http://gdata.youtube.com/schemas/2007#in-reply-to';

    /**

     * The URI of the inbox feed for the currently authenticated user.

     *

     * @var string

     */

    const INBOX_FEED_URI =

        'http://gdata.youtube.com/feeds/api/users/default/inbox';

    /**

     * The maximum number of users for which activity can be requested for,

     * as enforced by the API.

     *

     * @var integer

     */

    const ACTIVITY_FEED_MAX_USERS = 20;

    /**

     * The suffix for a feed of favorites.

     *

     * @var string

     */

    const FAVORITES_URI_SUFFIX = 'favorites';

    /**

     * The suffix for the user's upload feed.

     *

     * @var string

     */

    const UPLOADS_URI_SUFFIX = 'uploads';

    /**

     * The suffix for a feed of video responses.

     *

     * @var string

     */

    const RESPONSES_URI_SUFFIX = 'responses';

    /**

     * The suffix for a feed of related videos.

     *

     * @var string

     */

    const RELATED_URI_SUFFIX = 'related';

    /**

     * The suffix for a feed of messages (inbox entries).

     *

     * @var string

     */

    const INBOX_URI_SUFFIX = 'inbox';

    /**

     * Namespaces used for Zend_Gdata_YouTube

     *

     * @var array

     */

    public static $namespaces = array(

        array('yt', 'http://gdata.youtube.com/schemas/2007', 1, 0),

        array('georss', 'http://www.georss.org/georss', 1, 0),

        array('gml', 'http://www.opengis.net/gml', 1, 0),

        array('media', 'http://search.yahoo.com/mrss/', 1, 0)

    );

    /**

     * Create Zend_Gdata_YouTube object

     *

     * @param Zend_Http_Client $client (optional) The HTTP client to use when

     *          when communicating with the Google servers.

     * @param string $applicationId The identity of the app in the form of

     *        Company-AppName-Version

     * @param string $clientId The clientId issued by the YouTube dashboard

     * @param string $developerKey The developerKey issued by the YouTube dashboard

     */

    public function __construct($client = null,

        $applicationId = 'MyCompany-MyApp-1.0', $clientId = null,

        $developerKey = null)

    {

        $this->registerPackage('Zend_Gdata_YouTube');

        $this->registerPackage('Zend_Gdata_YouTube_Extension');

        $this->registerPackage('Zend_Gdata_Media');

        $this->registerPackage('Zend_Gdata_Media_Extension');

        // NOTE This constructor no longer calls the parent constructor

        $this->setHttpClient($client, $applicationId, $clientId, $developerKey);

    }

    /**

     * Set the Zend_Http_Client object used for communication

     *

     * @param Zend_Http_Client $client The client to use for communication

     * @throws Zend_Gdata_App_HttpException

     * @return Zend_Gdata_App Provides a fluent interface

     */

    public function setHttpClient($client,

        $applicationId = 'MyCompany-MyApp-1.0', $clientId = null,

        $developerKey = null)

    {

        if ($client === null) {

            $client = new Zend_Http_Client();

        }

        if (!$client instanceof Zend_Http_Client) {

            require_once 'Zend/Gdata/App/HttpException.php';

            throw new Zend_Gdata_App_HttpException(

                'Argument is not an instance of Zend_Http_Client.');

        }

        if ($clientId != null) {

            $client->setHeaders('X-GData-Client', $clientId);

        }

        if ($developerKey != null) {

            $client->setHeaders('X-GData-Key', 'key='. $developerKey);

        }

        return parent::setHttpClient($client, $applicationId);

    }

    /**

     * Retrieves a feed of videos.

     *

     * @param mixed $location (optional) The URL to query or a

     *         Zend_Gdata_Query object from which a URL can be determined

     * @return Zend_Gdata_YouTube_VideoFeed The feed of videos found at the

     *         specified URL.

     */

    public function getVideoFeed($location = null)

    {

        if ($location == null) {

            $uri = self::VIDEO_URI;

        } else if ($location instanceof Zend_Gdata_Query) {

            $uri = $location->getQueryUrl();

        } else {

            $uri = $location;

        }

        return parent::getFeed($uri, 'Zend_Gdata_YouTube_VideoFeed');

    }

    /**

     * Retrieves a specific video entry.

     *

     * @param mixed $videoId The ID of the video to retrieve.

     * @param mixed $location (optional) The URL to query or a

     *         Zend_Gdata_Query object from which a URL can be determined.

     * @param boolean $fullEntry (optional) Retrieve the full metadata for the

     *         entry. Only possible if entry belongs to currently authenticated

     *         user. An exception will be thrown otherwise.

     * @throws Zend_Gdata_App_HttpException

     * @return Zend_Gdata_YouTube_VideoEntry The video entry found at the

     *         specified URL.

     */

    public function getVideoEntry($videoId = null, $location = null,

        $fullEntry = false)

    {

        if ($videoId !== null) {

            if ($fullEntry) {

                return $this->getFullVideoEntry($videoId);

            } else {

                $uri = self::VIDEO_URI . "/" . $videoId;

            }

        } else if ($location instanceof Zend_Gdata_Query) {

            $uri = $location->getQueryUrl();

        } else {

            $uri = $location;

        }

        return parent::getEntry($uri, 'Zend_Gdata_YouTube_VideoEntry');

    }

    /**

     * Retrieves a video entry from the user's upload feed.

     *

     * @param mixed $videoID The ID of the video to retrieve.

     * @throws Zend_Gdata_App_HttpException

     * @return Zend_Gdata_YouTube_VideoEntry|null The video entry to be

     *          retrieved, or null if it was not found or the user requesting it

     *          did not have the appropriate permissions.

     */

    public function getFullVideoEntry($videoId)

    {

        $uri = self::USER_URI . "/default/" .

            self::UPLOADS_URI_SUFFIX . "/$videoId";

        return parent::getEntry($uri, 'Zend_Gdata_YouTube_VideoEntry');

    }

    /**

     * Retrieves a feed of videos related to the specified video ID.

     *

     * @param string $videoId The videoId of interest

     * @param mixed $location (optional) The URL to query or a

     *         Zend_Gdata_Query object from which a URL can be determined

     * @return Zend_Gdata_YouTube_VideoFeed The feed of videos found at the

     *         specified URL.

     */

    public function getRelatedVideoFeed($videoId = null, $location = null)

    {

        if ($videoId !== null) {

            $uri = self::VIDEO_URI . "/" . $videoId . "/" .

                self::RELATED_URI_SUFFIX;

        } else if ($location instanceof Zend_Gdata_Query) {

            $uri = $location->getQueryUrl();

        } else {

            $uri = $location;

        }

        return parent::getFeed($uri, 'Zend_Gdata_YouTube_VideoFeed');

    }

    /**

     * Retrieves a feed of video responses related to the specified video ID.

     *

     * @param string $videoId The videoId of interest

     * @param mixed $location (optional) The URL to query or a

     *         Zend_Gdata_Query object from which a URL can be determined

     * @return Zend_Gdata_YouTube_VideoFeed The feed of videos found at the

     *         specified URL.

     */

    public function getVideoResponseFeed($videoId = null, $location = null)

    {

        if ($videoId !== null) {

            $uri = self::VIDEO_URI . "/" . $videoId . "/" .

                self::RESPONSES_URI_SUFFIX;

        } else if ($location instanceof Zend_Gdata_Query) {

            $uri = $location->getQueryUrl();

        } else {

            $uri = $location;

        }

        return parent::getFeed($uri, 'Zend_Gdata_YouTube_VideoFeed');

    }

    /**

     * Retrieves a feed of comments related to the specified video ID.

     *

     * @param string $videoId The videoId of interest

     * @param mixed $location (optional) The URL to query or a

     *         Zend_Gdata_Query object from which a URL can be determined

     * @return Zend_Gdata_YouTube_CommentFeed The feed of videos found at the

     *         specified URL.

     */

    public function getVideoCommentFeed($videoId = null, $location = null)

    {

        if ($videoId !== null) {

            $uri = self::VIDEO_URI . "/" . $videoId . "/comments";

        } else if ($location instanceof Zend_Gdata_Query) {

            $uri = $location->getQueryUrl();

        } else {

            $uri = $location;

        }

        return parent::getFeed($uri, 'Zend_Gdata_YouTube_CommentFeed');

    }

    /**

     * Retrieves a feed of comments related to the specified video ID.

     *

     * @param mixed $location (optional) The URL to query or a

     *         Zend_Gdata_Query object from which a URL can be determined

     * @return Zend_Gdata_YouTube_CommentFeed The feed of videos found at the

     *         specified URL.

     */

    public function getTopRatedVideoFeed($location = null)

    {

        $standardFeedUri = self::STANDARD_TOP_RATED_URI;

        if ($this->getMajorProtocolVersion() == 2) {

            $standardFeedUri = self::STANDARD_TOP_RATED_URI_V2;

        }

        if ($location == null) {

            $uri = $standardFeedUri;

        } else if ($location instanceof Zend_Gdata_Query) {

            if ($location instanceof Zend_Gdata_YouTube_VideoQuery) {

                if (!isset($location->url)) {

                    $location->setFeedType('top rated');

                }

            }

            $uri = $location->getQueryUrl();

        } else {

            $uri = $location;

        }

        return parent::getFeed($uri, 'Zend_Gdata_YouTube_VideoFeed');

    }

    /**

     * Retrieves a feed of the most viewed videos.

     *

     * @param mixed $location (optional) The URL to query or a

     *         Zend_Gdata_Query object from which a URL can be determined

     * @return Zend_Gdata_YouTube_VideoFeed The feed of videos found at the

     *         specified URL.

     */

    public function getMostViewedVideoFeed($location = null)

    {

        $standardFeedUri = self::STANDARD_MOST_VIEWED_URI;

        if ($this->getMajorProtocolVersion() == 2) {

            $standardFeedUri = self::STANDARD_MOST_VIEWED_URI_V2;

        }

        if ($location == null) {

            $uri = $standardFeedUri;

        } else if ($location instanceof Zend_Gdata_Query) {

            if ($location instanceof Zend_Gdata_YouTube_VideoQuery) {

                if (!isset($location->url)) {

                    $location->setFeedType('most viewed');

                }

            }

            $uri = $location->getQueryUrl();

        } else {

            $uri = $location;

        }

        return parent::getFeed($uri, 'Zend_Gdata_YouTube_VideoFeed');

    }

    /**

     * Retrieves a feed of recently featured videos.

     *

     * @param mixed $location (optional) The URL to query or a

     *         Zend_Gdata_Query object from which a URL can be determined

     * @return Zend_Gdata_YouTube_VideoFeed The feed of videos found at the

     *         specified URL.

     */

    public function getRecentlyFeaturedVideoFeed($location = null)

    {

        $standardFeedUri = self::STANDARD_RECENTLY_FEATURED_URI;