C:/xampp/htdocs/moodle/lib/zend/Zend/Service/WindowsAzure/Storage/Queue.php

Go to the documentation of this file.

<?php
require_once 'Zend/Service/WindowsAzure/Credentials/SharedKey.php';

require_once 'Zend/Service/WindowsAzure/RetryPolicy/RetryPolicyAbstract.php';

require_once 'Zend/Http/Client.php';

require_once 'Zend/Http/Response.php';

require_once 'Zend/Service/WindowsAzure/Storage.php';

require_once 'Zend/Service/WindowsAzure/Storage/QueueInstance.php';

require_once 'Zend/Service/WindowsAzure/Storage/QueueMessage.php';

require_once 'Zend/Service/WindowsAzure/Exception.php';


class Zend_Service_WindowsAzure_Storage_Queue extends Zend_Service_WindowsAzure_Storage
{
        const MAX_MESSAGE_SIZE = 8388608;
        
        const MAX_MESSAGE_TTL = 604800;
        
        public function __construct($host = Zend_Service_WindowsAzure_Storage::URL_DEV_QUEUE, $accountName = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri = false, Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null)
        {
                parent::__construct($host, $accountName, $accountKey, $usePathStyleUri, $retryPolicy);
                
                // API version
                $this->_apiVersion = '2009-04-14';
        }
        
        public function queueExists($queueName = '')
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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);
        foreach ($queues as $queue) {
            if ($queue->Name == $queueName) {
                return true;
            }
        }
        
        return false;
        }
        
        public function createQueue($queueName = '', $metadata = array())
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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 {
                        throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
                }
        }
        
        public function getQueue($queueName = '')
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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 {
                    throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
                }
        }
        
        public function getQueueMetadata($queueName = '')
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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;
        }
        
        public function setQueueMetadata($queueName = '', $metadata = array())
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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;
                }
                    
                // Create metadata headers
                $headers = array();
                $headers = array_merge($headers, $this->_generateMetadataHeaders($metadata)); 
                
                // Perform request
                $response = $this->_performRequest($queueName, '?comp=metadata', Zend_Http_Client::PUT, $headers);

                if (!$response->isSuccessful()) {
                        throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
                }
        }
        
        public function deleteQueue($queueName = '')
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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()) {
                        throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
                }
        }
        
        public function listQueues($prefix = null, $maxResults = null, $marker = null, $currentResultCount = 0)
        {
            // Build query string
            $queryString = '?comp=list';
            if (!is_null($prefix)) {
                $queryString .= '&prefix=' . $prefix;
            }
            if (!is_null($maxResults)) {
                $queryString .= '&maxresults=' . $maxResults;
            }
            if (!is_null($marker)) {
                $queryString .= '&marker=' . $marker;
            }
                
                // Perform request
                $response = $this->_performRequest('', $queryString, Zend_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 Zend_Service_WindowsAzure_Storage_QueueInstance(
                                                (string)$xmlQueues[$i]->QueueName
                                        );
                                }
                        }
                        $currentResultCount = $currentResultCount + count($queues);
                        if (!is_null($maxResults) && $currentResultCount < $maxResults) {
                        if (!is_null($xmlMarker) && $xmlMarker != '') {
                            $queues = array_merge($queues, $this->listQueues($prefix, $maxResults, $xmlMarker, $currentResultCount));
                        }
                        }
                        if (!is_null($maxResults) && count($queues) > $maxResults) {
                            $queues = array_slice($queues, 0, $maxResults);
                        }
                            
                        return $queues;
                } else {
                        throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
                }
        }
        
        public function putMessage($queueName = '', $message = '', $ttl = null)
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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) {
                    throw new Zend_Service_WindowsAzure_Exception('Message is too big. Message content should be < 8KB.');
                }
                if ($message == '') {
                    throw new Zend_Service_WindowsAzure_Exception('Message is not specified.');
                }
                if (!is_null($ttl) && ($ttl <= 0 || $ttl > self::MAX_MESSAGE_SIZE)) {
                    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 = '';
            if (!is_null($ttl)) {
                $queryString .= '?messagettl=' . $ttl;
            }
                
            // Build body
            $rawData = '';
            $rawData .= '<QueueMessage>';
            $rawData .= '    <MessageText>' . base64_encode($message) . '</MessageText>';
            $rawData .= '</QueueMessage>';
                
                // Perform request
                $response = $this->_performRequest($queueName . '/messages', $queryString, Zend_Http_Client::POST, array(), false, $rawData);

                if (!$response->isSuccessful()) {
                        throw new Zend_Service_WindowsAzure_Exception('Error putting message into queue.');
                }
        }
        
        public function getMessages($queueName = '', $numOfMessages = 1, $visibilityTimeout = null, $peek = false)
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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) {
                    throw new Zend_Service_WindowsAzure_Exception('Invalid number of messages to retrieve.');
                }
                if (!is_null($visibilityTimeout) && ($visibilityTimeout <= 0 || $visibilityTimeout > 7200)) {
                    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
            $query = array();
        if ($peek) {
            $query[] = 'peekonly=true';
        }
        if ($numOfMessages > 1) {
                $query[] = 'numofmessages=' . $numOfMessages;
        }
        if (!$peek && !is_null($visibilityTimeout)) {
                $query[] = 'visibilitytimeout=' . $visibilityTimeout;
        }   
        $queryString = '?' . implode('&', $query);
                
                // Perform request
                $response = $this->_performRequest($queueName . '/messages', $queryString, Zend_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 Zend_Service_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),
                                        base64_decode((string)$xmlMessages[$i]->MessageText)
                            );
                        }
                            
                        return $messages;
                } else {
                        throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
                }
        }
        
        public function peekMessages($queueName = '', $numOfMessages = 1)
        {
            return $this->getMessages($queueName, $numOfMessages, null, true);
        }
        
        public function clearMessages($queueName = '')
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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()) {
                        throw new Zend_Service_WindowsAzure_Exception('Error clearing messages from queue.');
                }
        }
        
        public function deleteMessage($queueName = '', Zend_Service_WindowsAzure_Storage_QueueMessage $message)
        {
                if ($queueName === '') {
                        throw new Zend_Service_WindowsAzure_Exception('Queue name is not specified.');
                }
                if (!self::isValidQueueName($queueName)) {
                    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 == '') {
                    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);   
                if (!$response->isSuccessful()) {
                        throw new Zend_Service_WindowsAzure_Exception($this->_getErrorMessage($response, 'Resource could not be accessed.'));
                }
        }
        
    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;
    }
    
        protected function _getErrorMessage(Zend_Http_Response $response, $alternativeError = 'Unknown error.')
        {
                $response = $this->_parseResponse($response);
                if ($response && $response->Message) {
                    return (string)$response->Message;
                } else {
                    return $alternativeError;
                }
        }
}