tweet_live: comparison web/lib/Zend/Service/WindowsAzure/Storage/Queue.php

equal deleted inserted replaced

-:5e7a0fedabdf
+:877f952ae2bd
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Service_WindowsAzure
 * @subpackage Storage
-* @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+* @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://todo     name_todo
-* @version    $Id: Queue.php 23167 2010-10-19 17:53:31Z mabe $
+* @version    $Id: Queue.php 24593 2012-01-05 20:35:02Z matthew $
 */
 /**
-* @see Zend_Service_WindowsAzure_Credentials_SharedKey
+* see Zend_Service_WindowsAzure_Storage
-*/
-require_once 'Zend/Service/WindowsAzure/Credentials/SharedKey.php';
-/**
-* @see Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
-*/
-require_once 'Zend/Service/WindowsAzure/RetryPolicy/RetryPolicyAbstract.php';
-/**
-* @see Zend_Http_Client
-*/
-require_once 'Zend/Http/Client.php';
-/**
-* @see Zend_Http_Response
-*/
-require_once 'Zend/Http/Response.php';
-/**
-* @see Zend_Service_WindowsAzure_Storage
 */
 require_once 'Zend/Service/WindowsAzure/Storage.php';
 /**
-* Zend_Service_WindowsAzure_Storage_QueueInstance
+* @see Zend_Service_WindowsAzure_Storage_QueueInstance
 */
 require_once 'Zend/Service/WindowsAzure/Storage/QueueInstance.php';
 /**
-* Zend_Service_WindowsAzure_Storage_QueueMessage
+* @see Zend_Service_WindowsAzure_Storage_QueueMessage
 */
 require_once 'Zend/Service/WindowsAzure/Storage/QueueMessage.php';
-/**
-* @see Zend_Service_WindowsAzure_Exception
-*/
-require_once 'Zend/Service/WindowsAzure/Exception.php';
 /**
 * @category   Zend
 * @package    Zend_Service_WindowsAzure
 * @subpackage Storage
-* @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+* @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
 class Zend_Service_WindowsAzure_Storage_Queue extends Zend_Service_WindowsAzure_Storage
 {
 	/**
 	 * @return boolean
 	 */
 	public function queueExists($queueName = '')
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 		// List queues
 $queues = $this->listQueues($queueName, 1);
 	 * @throws Zend_Service_WindowsAzure_Exception
 	 */
 	public function createQueue($queueName = '', $metadata = array())
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 		// Create metadata headers
 		$headers = array();
 		$headers = array_merge($headers, $this->_generateMetadataHeaders($metadata));
 		// Perform request
 		$response = $this->_performRequest($queueName, '', Zend_Http_Client::PUT, $headers);
 		if ($response->isSuccessful()) {
 		    return new Zend_Service_WindowsAzure_Storage_QueueInstance(
 		        $queueName,
 		        $metadata
 		    );
 		} else {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
+		}
+	}
+	/**
+	 * Create queue if it does not exist
+	 *
+	 * @param string $queueName Queue name
+	 * @param array  $metadata  Key/value pairs of meta data
+	 * @throws Zend_Service_WindowsAzure_Exception
+	 */
+	public function createQueueIfNotExists($queueName = '', $metadata = array())
+	{
+		if (!$this->queueExists($queueName)) {
+			$this->createQueue($queueName, $metadata);
 		}
 	}
 	/**
 	 * Get queue
 	 * @throws Zend_Service_WindowsAzure_Exception
 	 */
 	public function getQueue($queueName = '')
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 		// Perform request
 		$response = $this->_performRequest($queueName, '?comp=metadata', Zend_Http_Client::GET);
 		if ($response->isSuccessful()) {
 		    // Parse metadata
 		    $metadata = $this->_parseMetadataHeaders($response->getHeaders());
 		    // Return queue
 		    $queue = new Zend_Service_WindowsAzure_Storage_QueueInstance(
 		        $queueName,
 		        $metadata
 		    );
 		    $queue->ApproximateMessageCount = intval($response->getHeader('x-ms-approximate-message-count'));
 		    return $queue;
 		} else {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
 		}
 	}
 	/**
 	 * @throws Zend_Service_WindowsAzure_Exception
 	 */
 	public function getQueueMetadata($queueName = '')
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 	    return $this->getQueue($queueName)->Metadata;
 	}
 	 * @throws Zend_Service_WindowsAzure_Exception
 	 */
 	public function setQueueMetadata($queueName = '', $metadata = array())
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 		if (count($metadata) == 0) {
 		    return;
 		}
 		// Perform request
 		$response = $this->_performRequest($queueName, '?comp=metadata', Zend_Http_Client::PUT, $headers);
 		if (!$response->isSuccessful()) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
 		}
 	}
 	/**
 	 * @throws Zend_Service_WindowsAzure_Exception
 	 */
 	public function deleteQueue($queueName = '')
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 		// Perform request
 		$response = $this->_performRequest($queueName, '', Zend_Http_Client::DELETE);
 		if (!$response->isSuccessful()) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
 		}
 	}
 	/**
 	 */
 	public function listQueues($prefix = null, $maxResults = null, $marker = null, $include = null, $currentResultCount = 0)
 	{
 	    // Build query string
 		$queryString = array('comp=list');
-if ($prefix !== null) {
+if (!is_null($prefix)) {
 	        $queryString[] = 'prefix=' . $prefix;
 }
-	    if ($maxResults !== null) {
+	    if (!is_null($maxResults)) {
 	        $queryString[] = 'maxresults=' . $maxResults;
 	    }
-	    if ($marker !== null) {
+	    if (!is_null($marker)) {
 	        $queryString[] = 'marker=' . $marker;
 	    }
-		if ($include !== null) {
+		if (!is_null($include)) {
 	        $queryString[] = 'include=' . $include;
 	    }
 	    $queryString = self::createQueryStringFromArray($queryString);
 		// Perform request
 		if ($response->isSuccessful()) {
 			$xmlQueues = $this->_parseResponse($response)->Queues->Queue;
 			$xmlMarker = (string)$this->_parseResponse($response)->NextMarker;
 			$queues = array();
-			if ($xmlQueues !== null) {
+			if (!is_null($xmlQueues)) {
 				for ($i = 0; $i < count($xmlQueues); $i++) {
 					$queues[] = new Zend_Service_WindowsAzure_Storage_QueueInstance(
 						(string)$xmlQueues[$i]->Name,
 						$this->_parseMetadataElement($xmlQueues[$i])
 					);
 				}
 			}
 			$currentResultCount = $currentResultCount + count($queues);
-			if ($maxResults !== null && $currentResultCount < $maxResults) {
+			if (!is_null($maxResults) && $currentResultCount < $maxResults) {
-			if ($xmlMarker !== null && $xmlMarker != '') {
+			if (!is_null($xmlMarker) && $xmlMarker != '') {
 			    $queues = array_merge($queues, $this->listQueues($prefix, $maxResults, $xmlMarker, $include, $currentResultCount));
 			}
 			}
-			if ($maxResults !== null && count($queues) > $maxResults) {
+			if (!is_null($maxResults) && count($queues) > $maxResults) {
 			    $queues = array_slice($queues, 0, $maxResults);
 			}
 			return $queues;
 		} else {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
 		}
 	}
 	/**
 	 * @throws Zend_Service_WindowsAzure_Exception
 	 */
 	public function putMessage($queueName = '', $message = '', $ttl = null)
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 		if (strlen($message) > self::MAX_MESSAGE_SIZE) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Message is too big. Message content should be < 8KB.');
 		}
 		if ($message == '') {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Message is not specified.');
 		}
-		if ($ttl !== null && ($ttl <= 0 || $ttl > self::MAX_MESSAGE_SIZE)) {
+		if (!is_null($ttl) && ($ttl <= 0 || $ttl > self::MAX_MESSAGE_SIZE)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Message TTL is invalid. Maximal TTL is 7 days (' . self::MAX_MESSAGE_SIZE . ' seconds) and should be greater than zero.');
 		}
 	    // Build query string
 		$queryString = array();
-if ($ttl !== null) {
+if (!is_null($ttl)) {
 	        $queryString[] = 'messagettl=' . $ttl;
 }
 	    $queryString = self::createQueryStringFromArray($queryString);
 	    // Build body
 		// Perform request
 		$response = $this->_performRequest($queueName . '/messages', $queryString, Zend_Http_Client::POST, array(), false, $rawData);
 		if (!$response->isSuccessful()) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 			throw new Zend_Service_WindowsAzure_Exception('Error putting message into queue.');
 		}
 	}
 	/**
 	 * @throws Zend_Service_WindowsAzure_Exception
 	 */
 	public function getMessages($queueName = '', $numOfMessages = 1, $visibilityTimeout = null, $peek = false)
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 		if ($numOfMessages < 1 || $numOfMessages > 32 || intval($numOfMessages) != $numOfMessages) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Invalid number of messages to retrieve.');
 		}
-		if ($visibilityTimeout !== null && ($visibilityTimeout <= 0 || $visibilityTimeout > 7200)) {
+		if (!is_null($visibilityTimeout) && ($visibilityTimeout <= 0 || $visibilityTimeout > 7200)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Visibility timeout is invalid. Maximum value is 2 hours (7200 seconds) and should be greater than zero.');
 		}
 	    // Build query string
 		$queryString = array();
 	    $queryString[] = 'peekonly=true';
 	}
 	if ($numOfMessages > 1) {
 	        $queryString[] = 'numofmessages=' . $numOfMessages;
 	}
-	if (!$peek && $visibilityTimeout !== null) {
+	if (!$peek && !is_null($visibilityTimeout)) {
 	        $queryString[] = 'visibilitytimeout=' . $visibilityTimeout;
 	}
 	    $queryString = self::createQueryStringFromArray($queryString);
 		// Perform request
 		    if (count($result->QueueMessage) > 1) {
 		    $xmlMessages = $result->QueueMessage;
 		} else {
 		    $xmlMessages = array($result->QueueMessage);
 		}
 			$messages = array();
 			for ($i = 0; $i < count($xmlMessages); $i++) {
 				$messages[] = new Zend_Service_WindowsAzure_Storage_QueueMessage(
 					(string)$xmlMessages[$i]->MessageId,
 					(string)$xmlMessages[$i]->InsertionTime,
 			    );
 			}
 			return $messages;
 		} else {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
 		}
 	}
 	/**
 	{
 	    return $this->getMessages($queueName, $numOfMessages, null, true);
 	}
 	/**
+	 * Checks to see if a given queue has messages
+	 *
+	 * @param string $queueName         Queue name
+	 * @return boolean
+	 * @throws Zend_Service_WindowsAzure_Exception
+	 */
+	public function hasMessages($queueName = '')
+	{
+		return count($this->peekMessages($queueName)) > 0;
+	}
+	/**
 	 * Clear queue messages
 	 *
 	 * @param string $queueName         Queue name
 	 * @throws Zend_Service_WindowsAzure_Exception
 	 */
 	public function clearMessages($queueName = '')
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 		// Perform request
 		$response = $this->_performRequest($queueName . '/messages', '', Zend_Http_Client::DELETE);
 		if (!$response->isSuccessful()) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 			throw new Zend_Service_WindowsAzure_Exception('Error clearing messages from queue.');
 		}
 	}
 	/**
 	 * Delete queue message
 	 *
-	 * @param string $queueName         					Queue name
+	 * @param string $queueName Queue name
 	 * @param Zend_Service_WindowsAzure_Storage_QueueMessage $message Message to delete from queue. A message retrieved using "peekMessages" can NOT be deleted!
 	 * @throws Zend_Service_WindowsAzure_Exception
 	 */
 	public function deleteMessage($queueName = '', Zend_Service_WindowsAzure_Storage_QueueMessage $message)
 	{
 		if ($queueName === '') {
-			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
-		}
+			throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
-		if (!self::isValidQueueName($queueName)) {
+		}
+		if (!self::isValidQueueName($queueName)) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('Queue name does not adhere to queue naming conventions. See http://msdn.microsoft.com/en-us/library/dd179349.aspx for more information.');
 		}
 		if ($message->PopReceipt == '') {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 		    throw new Zend_Service_WindowsAzure_Exception('A message retrieved using "peekMessages" can NOT be deleted! Use "getMessages" instead.');
 		}
 		// Perform request
-		$response = $this->_performRequest($queueName . '/messages/' . $message->MessageId, '?popreceipt=' . $message->PopReceipt, Zend_Http_Client::DELETE);
+		$response = $this->_performRequest($queueName . '/messages/' . $message->MessageId, '?popreceipt=' . urlencode($message->PopReceipt), Zend_Http_Client::DELETE);
 		if (!$response->isSuccessful()) {
+			require_once 'Zend/Service/WindowsAzure/Exception.php';
 			throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
 		}
 	}
 	/**

changeset 807	877f952ae2bd
parent 207	621fa6caec0c
child 1230	68c69c656a2c