/vendor/Microsoft/WindowsAzure/Storage/Queue.php

<?php

/**

 * Copyright (c) 2009 - 2011, RealDolmen

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 *     * Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above copyright

 *       notice, this list of conditions and the following disclaimer in the

 *       documentation and/or other materials provided with the distribution.

 *     * Neither the name of RealDolmen nor the

 *       names of its contributors may be used to endorse or promote products

 *       derived from this software without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY RealDolmen ''AS IS'' AND ANY

 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

 * DISCLAIMED. IN NO EVENT SHALL RealDolmen BE LIABLE FOR ANY

 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 *

 * @category   Microsoft

 * @package    Microsoft_WindowsAzure

 * @subpackage Storage

 * @copyright  Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)

 * @license    http://todo     name_todo

 * @version    $Id: Blob.php 24241 2009-07-22 09:43:13Z unknown $

 */



/**

 * @see Microsoft_AutoLoader

 */

require_once dirname(__FILE__) . '/../../AutoLoader.php';





/**

 * @category   Microsoft

 * @package    Microsoft_WindowsAzure

 * @subpackage Storage

 * @copyright  Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)

 * @license    http://phpazure.codeplex.com/license

 */

class Microsoft_WindowsAzure_Storage_Queue extends Microsoft_WindowsAzure_Storage

{

	/**

	 * Maximal message size (in bytes)

	 */

	const MAX_MESSAGE_SIZE = 8388608;

	

	/**

	 * Maximal message ttl (in seconds)

	 */

	const MAX_MESSAGE_TTL = 604800;

	

	/**

	 * Creates a new Microsoft_WindowsAzure_Storage_Queue instance

	 *

	 * @param string $host Storage host name

	 * @param string $accountName Account name for Windows Azure

	 * @param string $accountKey Account key for Windows Azure

	 * @param boolean $usePathStyleUri Use path-style URI's

	 * @param Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy Retry policy to use when making requests

	 */

	public function __construct($host = Microsoft_WindowsAzure_Storage::URL_DEV_QUEUE, $accountName = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri = false, Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null)

	{

		parent::__construct($host, $accountName, $accountKey, $usePathStyleUri, $retryPolicy);

		

		// API version

		$this->_apiVersion = '2009-09-19';

	}

	

	/**

	 * Check if a queue exists

	 * 

	 * @param string $queueName Queue name

	 * @return boolean

	 */

	public function queueExists($queueName = '')

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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);

        foreach ($queues as $queue) {

            if ($queue->Name == $queueName) {

                return true;

            }

        }

        

        return false;

	}

	

	/**

	 * Create queue

	 *

	 * @param string $queueName Queue name

	 * @param array  $metadata  Key/value pairs of meta data

	 * @return object Queue properties

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function createQueue($queueName = '', $metadata = array())

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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, array(), Microsoft_Http_Client::PUT, $headers);	

		if ($response->isSuccessful()) {

		    return new Microsoft_WindowsAzure_Storage_QueueInstance(

		        $queueName,

		        $metadata

		    );

		} else {

			throw new Microsoft_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 Microsoft_WindowsAzure_Exception

	 */

	public function createQueueIfNotExists($queueName = '', $metadata = array())

	{

		if (!$this->queueExists($queueName)) {

			$this->createQueue($queueName, $metadata);

		}

	}

	

	/**

	 * Get queue

	 * 

	 * @param string $queueName  Queue name

	 * @return Microsoft_WindowsAzure_Storage_QueueInstance

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function getQueue($queueName = '')

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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, array('comp' => 'metadata'), Microsoft_Http_Client::GET);	

		if ($response->isSuccessful()) {

		    // Parse metadata

		    $metadata = $this->_parseMetadataHeaders($response->getHeaders());



		    // Return queue

		    $queue = new Microsoft_WindowsAzure_Storage_QueueInstance(

		        $queueName,

		        $metadata

		    );

		    $queue->ApproximateMessageCount = intval($response->getHeader('x-ms-approximate-message-count'));

		    return $queue;

		} else {

		    throw new Microsoft_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	

	/**

	 * Get queue metadata

	 * 

	 * @param string $queueName  Queue name

	 * @return array Key/value pairs of meta data

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function getQueueMetadata($queueName = '')

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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;

	}

	

	/**

	 * Set queue metadata

	 * 

	 * Calling the Set Queue Metadata operation overwrites all existing metadata that is associated with the queue. It's not possible to modify an individual name/value pair.

	 *

	 * @param string $queueName  Queue name

	 * @param array  $metadata       Key/value pairs of meta data

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function setQueueMetadata($queueName = '', $metadata = array())

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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;

		}

		    

		// Create metadata headers

		$headers = array();

		$headers = array_merge($headers, $this->_generateMetadataHeaders($metadata)); 

		

		// Perform request

		$response = $this->_performRequest($queueName, array('comp' => 'metadata'), Microsoft_Http_Client::PUT, $headers);



		if (!$response->isSuccessful()) {

			throw new Microsoft_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	

	/**

	 * Delete queue

	 *

	 * @param string $queueName Queue name

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function deleteQueue($queueName = '')

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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, array(), Microsoft_Http_Client::DELETE);

		if (!$response->isSuccessful()) {

			throw new Microsoft_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	

	/**

	 * List queues

	 *

	 * @param string $prefix     Optional. Filters the results to return only queues whose name begins with the specified prefix.

	 * @param int    $maxResults Optional. Specifies the maximum number of queues to return per call to Azure storage. This does NOT affect list size returned by this function. (maximum: 5000)

	 * @param string $marker     Optional string value that identifies the portion of the list to be returned with the next list operation.

	 * @param string $include    Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. (allowed values: '', 'metadata')

	 * @param int    $currentResultCount Current result count (internal use)

	 * @return array

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function listQueues($prefix = null, $maxResults = null, $marker = null, $include = null, $currentResultCount = 0)

	{

	    // Build query string

		$query = array('comp' => 'list');

        if (!is_null($prefix)) {

	        $query['prefix'] = $prefix;

        }

	    if (!is_null($maxResults)) {

	        $query['maxresults'] = $maxResults;

	    }

	    if (!is_null($marker)) {

	        $query['marker'] = $marker;

	    }

		if (!is_null($include)) {

	        $query['include'] = $include;

	    }

	        

		// Perform request

		$response = $this->_performRequest('', $query, Microsoft_Http_Client::GET);	

		if ($response->isSuccessful()) {

			$xmlQueues = $this->_parseResponse($response)->Queues->Queue;

			$xmlMarker = (string)$this->_parseResponse($response)->NextMarker;



			$queues = array();

			if (!is_null($xmlQueues)) {

				for ($i = 0; $i < count($xmlQueues); $i++) {

					$queues[] = new Microsoft_WindowsAzure_Storage_QueueInstance(

						(string)$xmlQueues[$i]->Name,

						$this->_parseMetadataElement($xmlQueues[$i])

					);

				}

			}

			$currentResultCount = $currentResultCount + count($queues);

			if (!is_null($maxResults) && $currentResultCount < $maxResults) {

    			if (!is_null($xmlMarker) && $xmlMarker != '') {

    			    $queues = array_merge($queues, $this->listQueues($prefix, $maxResults, $xmlMarker, $include, $currentResultCount));

    			}

			}

			if (!is_null($maxResults) && count($queues) > $maxResults) {

			    $queues = array_slice($queues, 0, $maxResults);

			}

			    

			return $queues;

		} else {

			throw new Microsoft_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	

	/**

	 * Put message into queue

	 *

	 * @param string $queueName  Queue name

	 * @param string $message    Message

	 * @param int    $ttl        Message Time-To-Live (in seconds). Defaults to 7 days if the parameter is omitted.

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function putMessage($queueName = '', $message = '', $ttl = null)

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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) {

		    throw new Microsoft_WindowsAzure_Exception('Message is too big. Message content should be < 8KB.');

		}

		if ($message == '') {

		    throw new Microsoft_WindowsAzure_Exception('Message is not specified.');

		}

		if (!is_null($ttl) && ($ttl <= 0 || $ttl > self::MAX_MESSAGE_SIZE)) {

		    throw new Microsoft_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

		$query = array();

        if (!is_null($ttl)) {

	        $query['messagettl'] = $ttl;

        }

	        

	    // Build body

	    $rawData = '';

	    $rawData .= '<QueueMessage>';

	    $rawData .= '    <MessageText>' . base64_encode($message) . '</MessageText>';

	    $rawData .= '</QueueMessage>';

	        

		// Perform request

		$response = $this->_performRequest($queueName . '/messages', $query, Microsoft_Http_Client::POST, array(), false, $rawData);



		if (!$response->isSuccessful()) {

			throw new Microsoft_WindowsAzure_Exception('Error putting message into queue.');

		}

	}

	

	/**

	 * Get queue messages

	 *

	 * @param string $queueName         Queue name

	 * @param string $numOfMessages     Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. By default, a single message is retrieved from the queue with this operation.

	 * @param int    $visibilityTimeout Optional. An integer value that specifies the message's visibility timeout in seconds. The maximum value is 2 hours. The default message visibility timeout is 30 seconds.

	 * @param string $peek              Peek only?

	 * @return array

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function getMessages($queueName = '', $numOfMessages = 1, $visibilityTimeout = null, $peek = false)

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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) {

		    throw new Microsoft_WindowsAzure_Exception('Invalid number of messages to retrieve.');

		}

		if (!is_null($visibilityTimeout) && ($visibilityTimeout <= 0 || $visibilityTimeout > 7200)) {

		    throw new Microsoft_WindowsAzure_Exception('Visibility timeout is invalid. Maximum value is 2 hours (7200 seconds) and should be greater than zero.');

		}

		    

	    // Build query string

		$query = array();

    	if ($peek) {

    	    $query['peekonly'] = 'true';

    	}

    	if ($numOfMessages > 1) {

	        $query['numofmessages'] = $numOfMessages;

    	}

    	if (!$peek && !is_null($visibilityTimeout)) {

	        $query['visibilitytimeout'] = $visibilityTimeout;

    	}  

	        

		// Perform request

		$response = $this->_performRequest($queueName . '/messages', $query, Microsoft_Http_Client::GET);	

		if ($response->isSuccessful()) {

		    // Parse results

			$result = $this->_parseResponse($response);

		    if (!$result) {

		        return array();

		    }



		    $xmlMessages = null;

		    if (count($result->QueueMessage) > 1) {

    		    $xmlMessages = $result->QueueMessage;

    		} else {

    		    $xmlMessages = array($result->QueueMessage);

    		}



			$messages = array();

			for ($i = 0; $i < count($xmlMessages); $i++) {

				$messages[] = new Microsoft_WindowsAzure_Storage_QueueMessage(

					(string)$xmlMessages[$i]->MessageId,

					(string)$xmlMessages[$i]->InsertionTime,

					(string)$xmlMessages[$i]->ExpirationTime,

					($peek ? '' : (string)$xmlMessages[$i]->PopReceipt),

					($peek ? '' : (string)$xmlMessages[$i]->TimeNextVisible),

					(string)$xmlMessages[$i]->DequeueCount,

					base64_decode((string)$xmlMessages[$i]->MessageText)

			    );

			}

			    

			return $messages;

		} else {

			throw new Microsoft_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	

	/**

	 * Peek queue messages

	 *

	 * @param string $queueName         Queue name

	 * @param string $numOfMessages     Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. By default, a single message is retrieved from the queue with this operation.

	 * @return array

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function peekMessages($queueName = '', $numOfMessages = 1)

	{

	    return $this->getMessages($queueName, $numOfMessages, null, true);

	}

	

	/**

	 * Checks to see if a given queue has messages

	 *

	 * @param string $queueName         Queue name

	 * @return boolean

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function hasMessages($queueName = '')

	{

		return count($this->peekMessages($queueName)) > 0;

	}

	

	/**

	 * Clear queue messages

	 *

	 * @param string $queueName         Queue name

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function clearMessages($queueName = '')

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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', array(), Microsoft_Http_Client::DELETE);	

		if (!$response->isSuccessful()) {

			throw new Microsoft_WindowsAzure_Exception('Error clearing messages from queue.');

		}

	}

	

	/**

	 * Delete queue message

	 *

	 * @param string $queueName         					Queue name

	 * @param Microsoft_WindowsAzure_Storage_QueueMessage $message Message to delete from queue. A message retrieved using "peekMessages" can NOT be deleted!

	 * @throws Microsoft_WindowsAzure_Exception

	 */

	public function deleteMessage($queueName = '', Microsoft_WindowsAzure_Storage_QueueMessage $message)

	{

		if ($queueName === '') {

			throw new Microsoft_WindowsAzure_Exception('Queue name is not specified.');

		}

		if (!self::isValidQueueName($queueName)) {

		    throw new Microsoft_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 == '') {

		    throw new Microsoft_WindowsAzure_Exception('A message retrieved using "peekMessages" can NOT be deleted! Use "getMessages" instead.');

		}



		// Perform request

		$response = $this->_performRequest($queueName . '/messages/' . $message->MessageId, array('popreceipt' => $message->PopReceipt), Microsoft_Http_Client::DELETE);	

		if (!$response->isSuccessful()) {

			throw new Microsoft_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));

		}

	}

	

	/**

	 * Is valid queue name?

	 *

	 * @param string $queueName Queue name

	 * @return boolean

	 */

    public static function isValidQueueName($queueName = '')

    {

        if (preg_match("/^[a-z0-9][a-z0-9-]*$/", $queueName) === 0) {

            return false;

        }

    

        if (strpos($queueName, '--') !== false) {

            return false;

        }

    

        if (strtolower($queueName) != $queueName) {

            return false;

        }

    

        if (strlen($queueName) < 3 || strlen($queueName) > 63) {

            return false;

        }

            

        if (substr($queueName, -1) == '-') {

            return false;

        }

    

        return true;

    }

    

	/**

	 * Get error message from Microsoft_Http_Response

	 * 

	 * @param Microsoft_Http_Response $response Repsonse

	 * @param string $alternativeError Alternative error message

	 * @return string

	 */

	protected function _getErrorMessage(Microsoft_Http_Response $response, $alternativeError = 'Unknown error.')

	{

		$response = $this->_parseResponse($response);

		if ($response && $response->Message) {

		    return (string)$response->Message;

		} else {

		    return $alternativeError;

		}

	}

}