Source of file AbstractCallback.php
Size: 9,202 Bytes - Last Modified: 2014-03-12T23:21:18+01:00
/home/theseer/Downloads/ZendFramework-2.3.0/library/Zend/Feed/PubSubHubbub/AbstractCallback.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292 | <?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\Feed\PubSubHubbub; use Traversable; use Zend\Http\PhpEnvironment\Response as PhpResponse; use Zend\Stdlib\ArrayUtils; abstract class AbstractCallback implements CallbackInterface { /** * An instance of Zend\Feed\Pubsubhubbub\Model\SubscriptionPersistenceInterface * used to background save any verification tokens associated with a subscription * or other. * * @var Model\SubscriptionPersistenceInterface */ protected $storage = null; /** * An instance of a class handling Http Responses. This is implemented in * Zend\Feed\Pubsubhubbub\HttpResponse which shares an unenforced interface with * (i.e. not inherited from) Zend\Controller\Response\Http. * * @var HttpResponse|PhpResponse */ protected $httpResponse = null; /** * The number of Subscribers for which any updates are on behalf of. * * @var int */ protected $subscriberCount = 1; /** * Constructor; accepts an array or Traversable object to preset * options for the Subscriber without calling all supported setter * methods in turn. * * @param array|Traversable $options Options array or Traversable object */ public function __construct($options = null) { if ($options !== null) { $this->setOptions($options); } } /** * Process any injected configuration options * * @param array|Traversable $options Options array or Traversable object * @return AbstractCallback * @throws Exception\InvalidArgumentException */ public function setOptions($options) { if ($options instanceof Traversable) { $options = ArrayUtils::iteratorToArray($options); } if (!is_array($options)) { throw new Exception\InvalidArgumentException('Array or Traversable object' . 'expected, got ' . gettype($options)); } if (is_array($options)) { $this->setOptions($options); } if (array_key_exists('storage', $options)) { $this->setStorage($options['storage']); } return $this; } /** * Send the response, including all headers. * If you wish to handle this via Zend\Http, use the getter methods * to retrieve any data needed to be set on your HTTP Response object, or * simply give this object the HTTP Response instance to work with for you! * * @return void */ public function sendResponse() { $this->getHttpResponse()->send(); } /** * Sets an instance of Zend\Feed\Pubsubhubbub\Model\SubscriptionPersistence used * to background save any verification tokens associated with a subscription * or other. * * @param Model\SubscriptionPersistenceInterface $storage * @return AbstractCallback */ public function setStorage(Model\SubscriptionPersistenceInterface $storage) { $this->storage = $storage; return $this; } /** * Gets an instance of Zend\Feed\Pubsubhubbub\Model\SubscriptionPersistence used * to background save any verification tokens associated with a subscription * or other. * * @return Model\SubscriptionPersistenceInterface * @throws Exception\RuntimeException */ public function getStorage() { if ($this->storage === null) { throw new Exception\RuntimeException('No storage object has been' . ' set that subclasses Zend\Feed\Pubsubhubbub\Model\SubscriptionPersistence'); } return $this->storage; } /** * An instance of a class handling Http Responses. This is implemented in * Zend\Feed\Pubsubhubbub\HttpResponse which shares an unenforced interface with * (i.e. not inherited from) Zend\Controller\Response\Http. * * @param HttpResponse|PhpResponse $httpResponse * @return AbstractCallback * @throws Exception\InvalidArgumentException */ public function setHttpResponse($httpResponse) { if (!$httpResponse instanceof HttpResponse && !$httpResponse instanceof PhpResponse) { throw new Exception\InvalidArgumentException('HTTP Response object must' . ' implement one of Zend\Feed\Pubsubhubbub\HttpResponse or' . ' Zend\Http\PhpEnvironment\Response'); } $this->httpResponse = $httpResponse; return $this; } /** * An instance of a class handling Http Responses. This is implemented in * Zend\Feed\Pubsubhubbub\HttpResponse which shares an unenforced interface with * (i.e. not inherited from) Zend\Controller\Response\Http. * * @return HttpResponse|PhpResponse */ public function getHttpResponse() { if ($this->httpResponse === null) { $this->httpResponse = new HttpResponse; } return $this->httpResponse; } /** * Sets the number of Subscribers for which any updates are on behalf of. * In other words, is this class serving one or more subscribers? How many? * Defaults to 1 if left unchanged. * * @param string|int $count * @return AbstractCallback * @throws Exception\InvalidArgumentException */ public function setSubscriberCount($count) { $count = intval($count); if ($count <= 0) { throw new Exception\InvalidArgumentException('Subscriber count must be' . ' greater than zero'); } $this->subscriberCount = $count; return $this; } /** * Gets the number of Subscribers for which any updates are on behalf of. * In other words, is this class serving one or more subscribers? How many? * * @return int */ public function getSubscriberCount() { return $this->subscriberCount; } /** * Attempt to detect the callback URL (specifically the path forward) * @return string */ protected function _detectCallbackUrl() { $callbackUrl = ''; if (isset($_SERVER['HTTP_X_ORIGINAL_URL'])) { $callbackUrl = $_SERVER['HTTP_X_ORIGINAL_URL']; } elseif (isset($_SERVER['HTTP_X_REWRITE_URL'])) { $callbackUrl = $_SERVER['HTTP_X_REWRITE_URL']; } elseif (isset($_SERVER['REQUEST_URI'])) { $callbackUrl = $_SERVER['REQUEST_URI']; $scheme = 'http'; if ($_SERVER['HTTPS'] == 'on') { $scheme = 'https'; } $schemeAndHttpHost = $scheme . '://' . $this->_getHttpHost(); if (strpos($callbackUrl, $schemeAndHttpHost) === 0) { $callbackUrl = substr($callbackUrl, strlen($schemeAndHttpHost)); } } elseif (isset($_SERVER['ORIG_PATH_INFO'])) { $callbackUrl= $_SERVER['ORIG_PATH_INFO']; if (!empty($_SERVER['QUERY_STRING'])) { $callbackUrl .= '?' . $_SERVER['QUERY_STRING']; } } return $callbackUrl; } /** * Get the HTTP host * * @return string */ protected function _getHttpHost() { if (!empty($_SERVER['HTTP_HOST'])) { return $_SERVER['HTTP_HOST']; } $scheme = 'http'; if ($_SERVER['HTTPS'] == 'on') { $scheme = 'https'; } $name = $_SERVER['SERVER_NAME']; $port = $_SERVER['SERVER_PORT']; if (($scheme == 'http' && $port == 80) || ($scheme == 'https' && $port == 443) ) { return $name; } return $name . ':' . $port; } /** * Retrieve a Header value from either $_SERVER or Apache * * @param string $header * @return bool|string */ protected function _getHeader($header) { $temp = strtoupper(str_replace('-', '_', $header)); if (!empty($_SERVER[$temp])) { return $_SERVER[$temp]; } $temp = 'HTTP_' . strtoupper(str_replace('-', '_', $header)); if (!empty($_SERVER[$temp])) { return $_SERVER[$temp]; } if (function_exists('apache_request_headers')) { $headers = apache_request_headers(); if (!empty($headers[$header])) { return $headers[$header]; } } return false; } /** * Return the raw body of the request * * @return string|false Raw body, or false if not present */ protected function _getRawBody() { $body = file_get_contents('php://input'); if (strlen(trim($body)) == 0 && isset($GLOBALS['HTTP_RAW_POST_DATA'])) { $body = $GLOBALS['HTTP_RAW_POST_DATA']; } if (strlen(trim($body)) > 0) { return $body; } return false; } } |