Chris@0: <?php
Chris@0: /**
Chris@0:  * Zend Framework (http://framework.zend.com/)
Chris@0:  *
Chris@0:  * @link      http://github.com/zendframework/zf2 for the canonical source repository
Chris@0:  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
Chris@0:  * @license   http://framework.zend.com/license/new-bsd New BSD License
Chris@0:  */
Chris@0: 
Chris@0: namespace Zend\Feed\PubSubHubbub;
Chris@0: 
Chris@0: use Zend\Escaper\Escaper;
Chris@0: use Zend\Feed\Reader;
Chris@0: use Zend\Http;
Chris@0: 
Chris@0: class PubSubHubbub
Chris@0: {
Chris@0:     /**
Chris@0:      * Verification Modes
Chris@0:      */
Chris@0:     const VERIFICATION_MODE_SYNC  = 'sync';
Chris@0:     const VERIFICATION_MODE_ASYNC = 'async';
Chris@0: 
Chris@0:     /**
Chris@0:      * Subscription States
Chris@0:      */
Chris@0:     const SUBSCRIPTION_VERIFIED    = 'verified';
Chris@0:     const SUBSCRIPTION_NOTVERIFIED = 'not_verified';
Chris@0:     const SUBSCRIPTION_TODELETE    = 'to_delete';
Chris@0: 
Chris@0:     /**
Chris@0:      * @var Escaper
Chris@0:      */
Chris@0:     protected static $escaper;
Chris@0: 
Chris@0:     /**
Chris@0:      * Singleton instance if required of the HTTP client
Chris@0:      *
Chris@0:      * @var Http\Client
Chris@0:      */
Chris@0:     protected static $httpClient = null;
Chris@0: 
Chris@0:     /**
Chris@0:      * Simple utility function which imports any feed URL and
Chris@0:      * determines the existence of Hub Server endpoints. This works
Chris@0:      * best if directly given an instance of Zend\Feed\Reader\Atom|Rss
Chris@0:      * to leverage off.
Chris@0:      *
Chris@0:      * @param  \Zend\Feed\Reader\Feed\AbstractFeed|string $source
Chris@0:      * @return array
Chris@0:      * @throws Exception\InvalidArgumentException
Chris@0:      */
Chris@0:     public static function detectHubs($source)
Chris@0:     {
Chris@0:         if (is_string($source)) {
Chris@0:             $feed = Reader\Reader::import($source);
Chris@0:         } elseif ($source instanceof Reader\Feed\AbstractFeed) {
Chris@0:             $feed = $source;
Chris@0:         } else {
Chris@0:             throw new Exception\InvalidArgumentException('The source parameter was'
Chris@0:             . ' invalid, i.e. not a URL string or an instance of type'
Chris@0:             . ' Zend\Feed\Reader\Feed\AbstractFeed');
Chris@0:         }
Chris@0:         return $feed->getHubs();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Allows the external environment to make ZendOAuth use a specific
Chris@0:      * Client instance.
Chris@0:      *
Chris@0:      * @param  Http\Client $httpClient
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public static function setHttpClient(Http\Client $httpClient)
Chris@0:     {
Chris@0:         static::$httpClient = $httpClient;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Return the singleton instance of the HTTP Client. Note that
Chris@0:      * the instance is reset and cleared of previous parameters GET/POST.
Chris@0:      * Headers are NOT reset but handled by this component if applicable.
Chris@0:      *
Chris@0:      * @return Http\Client
Chris@0:      */
Chris@0:     public static function getHttpClient()
Chris@0:     {
Chris@12:         if (! isset(static::$httpClient)) {
Chris@0:             static::$httpClient = new Http\Client;
Chris@0:         } else {
Chris@0:             static::$httpClient->resetParameters();
Chris@0:         }
Chris@0:         return static::$httpClient;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Simple mechanism to delete the entire singleton HTTP Client instance
Chris@0:      * which forces a new instantiation for subsequent requests.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public static function clearHttpClient()
Chris@0:     {
Chris@0:         static::$httpClient = null;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set the Escaper instance
Chris@0:      *
Chris@0:      * If null, resets the instance
Chris@0:      *
Chris@0:      * @param  null|Escaper $escaper
Chris@0:      */
Chris@0:     public static function setEscaper(Escaper $escaper = null)
Chris@0:     {
Chris@0:         static::$escaper = $escaper;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Get the Escaper instance
Chris@0:      *
Chris@0:      * If none registered, lazy-loads an instance.
Chris@0:      *
Chris@0:      * @return Escaper
Chris@0:      */
Chris@0:     public static function getEscaper()
Chris@0:     {
Chris@0:         if (null === static::$escaper) {
Chris@0:             static::setEscaper(new Escaper());
Chris@0:         }
Chris@0:         return static::$escaper;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * RFC 3986 safe url encoding method
Chris@0:      *
Chris@0:      * @param  string $string
Chris@0:      * @return string
Chris@0:      */
Chris@0:     public static function urlencode($string)
Chris@0:     {
Chris@0:         $escaper    = static::getEscaper();
Chris@0:         $rawencoded = $escaper->escapeUrl($string);
Chris@0:         $rfcencoded = str_replace('%7E', '~', $rawencoded);
Chris@0:         return $rfcencoded;
Chris@0:     }
Chris@0: }