<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Service_WindowsAzure

 * @subpackage Management

 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id$

 */

/**

 * @see Zend_Service_WindowsAzure_Management_OperationStatusInstance

 */

require_once 'Zend/Service/WindowsAzure/Management/OperationStatusInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Management_SubscriptionOperationInstance

 */

require_once 'Zend/Service/WindowsAzure/Management/SubscriptionOperationInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Management_DeploymentInstance

 */

require_once 'Zend/Service/WindowsAzure/Management/DeploymentInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Storage_Blob

 */

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

/**

 * @see Zend_Service_WindowsAzure_Storage_Table

 */

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

/**

 * @see Zend_Service_WindowsAzure_Management_HostedServiceInstance

 */

require_once 'Zend/Service/WindowsAzure/Management/HostedServiceInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Management_CertificateInstance

 */

require_once 'Zend/Service/WindowsAzure/Management/CertificateInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Management_AffinityGroupInstance

 */

require_once 'Zend/Service/WindowsAzure/Management/AffinityGroupInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Management_LocationInstance

 */

require_once 'Zend/Service/WindowsAzure/Management/LocationInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Management_OperatingSystemInstance

 */

require_once 'Zend/Service/WindowsAzure/Management/OperatingSystemInstance.php';

/**

 * @see Zend_Service_WindowsAzure_Management_OperatingSystemFamilyInstance

 */

require_once 'Zend/Service/WindowsAzure/Management/OperatingSystemFamilyInstance.php';

/**

 * @category   Zend

 * @package    Zend_Service_WindowsAzure

 * @subpackage Management

 * @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_Management_Client

{

	/**

	 * Management service URL

	 */

	const URL_MANAGEMENT        = "https://management.core.windows.net";

	/**

	 * Operations

	 */

	const OP_OPERATIONS                = "operations";

	const OP_STORAGE_ACCOUNTS          = "services/storageservices";

	const OP_HOSTED_SERVICES           = "services/hostedservices";

	const OP_AFFINITYGROUPS            = "affinitygroups";

	const OP_LOCATIONS                 = "locations";

	const OP_OPERATINGSYSTEMS          = "operatingsystems";

	const OP_OPERATINGSYSTEMFAMILIES   = "operatingsystemfamilies";

	/**

	 * Current API version

	 * 

	 * @var string

	 */

	protected $_apiVersion = '2011-02-25';

	/**

	 * Subscription ID

	 *

	 * @var string

	 */

	protected $_subscriptionId = '';

	/**

	 * Management certificate path (.PEM)

	 *

	 * @var string

	 */

	protected $_certificatePath = '';

	/**

	 * Management certificate passphrase

	 *

	 * @var string

	 */

	protected $_certificatePassphrase = '';

	/**

	 * Zend_Http_Client channel used for communication with REST services

	 * 

	 * @var Zend_Http_Client

	 */

	protected $_httpClientChannel = null;	

	/**

	 * Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract instance

	 * 

	 * @var Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

	 */

	protected $_retryPolicy = null;

	/**

	 * Returns the last request ID

	 * 

	 * @var string

	 */

	protected $_lastRequestId = null;

	/**

	 * Creates a new Zend_Service_WindowsAzure_Management instance

	 * 

	 * @param string $subscriptionId Subscription ID

	 * @param string $certificatePath Management certificate path (.PEM)

	 * @param string $certificatePassphrase Management certificate passphrase

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

	 */

	public function __construct(

		$subscriptionId,

		$certificatePath,

		$certificatePassphrase,

		Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null

	) {

		$this->_subscriptionId = $subscriptionId;

		$this->_certificatePath = $certificatePath;

		$this->_certificatePassphrase = $certificatePassphrase;

		$this->_retryPolicy = $retryPolicy;

		if (is_null($this->_retryPolicy)) {

		    $this->_retryPolicy = Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract::noRetry();

		}

		// Setup default Zend_Http_Client channel

		$options = array(

		    'adapter'       => 'Zend_Http_Client_Adapter_Socket',

		    'ssltransport'  => 'ssl',

			'sslcert'       => $this->_certificatePath,

			'sslpassphrase' => $this->_certificatePassphrase,

			'sslusecontext' => true,

		);

		if (function_exists('curl_init')) {

			// Set cURL options if cURL is used afterwards

			$options['curloptions'] = array(

					CURLOPT_FOLLOWLOCATION => true,

					CURLOPT_TIMEOUT => 120,

			);

		}

		$this->_httpClientChannel = new Zend_Http_Client(null, $options);

	}

	/**

	 * Set the HTTP client channel to use

	 * 

	 * @param Zend_Http_Client_Adapter_Interface|string $adapterInstance Adapter instance or adapter class name.

	 */

	public function setHttpClientChannel($adapterInstance = 'Zend_Http_Client_Adapter_Socket')

	{

		$this->_httpClientChannel->setAdapter($adapterInstance);

	}

    /**

     * Retrieve HTTP client channel

     * 

     * @return Zend_Http_Client_Adapter_Interface

     */

    public function getHttpClientChannel()

    {

        return $this->_httpClientChannel;

    }

	/**

	 * Returns the Windows Azure subscription ID

	 * 

	 * @return string

	 */

	public function getSubscriptionId()

	{

		return $this->_subscriptionId;

	}

	/**

	 * Returns the last request ID.

	 * 

	 * @return string

	 */

	public function getLastRequestId()

	{

		return $this->_lastRequestId;

	}

	/**

	 * Get base URL for creating requests

	 *

	 * @return string

	 */

	public function getBaseUrl()

	{

		return self::URL_MANAGEMENT . '/' . $this->_subscriptionId;

	}

	/**

	 * Perform request using Zend_Http_Client channel

	 *

	 * @param string $path Path

	 * @param string $queryString Query string

	 * @param string $httpVerb HTTP verb the request will use

	 * @param array $headers x-ms headers to add

	 * @param mixed $rawData Optional RAW HTTP data to be sent over the wire

	 * @return Zend_Http_Response

	 */

	protected function _performRequest(

		$path = '/',

		$queryString = '',

		$httpVerb = Zend_Http_Client::GET,

		$headers = array(),

		$rawData = null

	) {

	    // Clean path

		if (strpos($path, '/') !== 0) {

			$path = '/' . $path;

		}

		// Clean headers

		if (is_null($headers)) {

		    $headers = array();

		}

		// Ensure cUrl will also work correctly:

		//  - disable Content-Type if required

		//  - disable Expect: 100 Continue

		if (!isset($headers["Content-Type"])) {

			$headers["Content-Type"] = '';

		}

		//$headers["Expect"] = '';

		// Add version header

		$headers['x-ms-version'] = $this->_apiVersion;

		// URL encoding

		$path           = self::urlencode($path);

		$queryString    = self::urlencode($queryString);

		// Generate URL and sign request

		$requestUrl     = $this->getBaseUrl() . $path . $queryString;

		$requestHeaders = $headers;

		// Prepare request 

		$this->_httpClientChannel->resetParameters(true);

		$this->_httpClientChannel->setUri($requestUrl);

		$this->_httpClientChannel->setHeaders($requestHeaders);

		$this->_httpClientChannel->setRawData($rawData);

		// Execute request

		$response = $this->_retryPolicy->execute(

		    array($this->_httpClientChannel, 'request'),

		    array($httpVerb)

		);

		// Store request id

		$this->_lastRequestId = $response->getHeader('x-ms-request-id');

		return $response;

	}

	/** 

	 * Parse result from Zend_Http_Response

	 *

	 * @param Zend_Http_Response $response Response from HTTP call

	 * @return object

	 * @throws Zend_Service_WindowsAzure_Exception

	 */

	protected function _parseResponse(Zend_Http_Response $response = null)

	{

		if (is_null($response)) {

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

			throw new Zend_Service_WindowsAzure_Exception('Response should not be null.');

		}

        $xml = @simplexml_load_string($response->getBody());

        if ($xml !== false) {

            // Fetch all namespaces 

            $namespaces = array_merge($xml->getNamespaces(true), $xml->getDocNamespaces(true)); 

            // Register all namespace prefixes

            foreach ($namespaces as $prefix => $ns) { 

                if ($prefix != '') {

                    $xml->registerXPathNamespace($prefix, $ns);

                } 

            } 

        }

        return $xml;

	}

	/**

	 * URL encode function

	 * 

	 * @param  string $value Value to encode

	 * @return string        Encoded value

	 */

	public static function urlencode($value)

	{

	    return str_replace(' ', '%20', $value);

	}

    /**

     * Builds a query string from an array of elements

     * 

     * @param array     Array of elements

     * @return string   Assembled query string

     */

    public static function createQueryStringFromArray($queryString)

    {

    	return count($queryString) > 0 ? '?' . implode('&', $queryString) : '';

    }

	/**

	 * Get error message from Zend_Http_Response

	 *

	 * @param Zend_Http_Response $response Repsonse

	 * @param string $alternativeError Alternative error message

	 * @return string

	 */

	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;

		}

	}

    /**

     * The Get Operation Status operation returns the status of the specified operation.

     * After calling an asynchronous operation, you can call Get Operation Status to

     * determine whether the operation has succeed, failed, or is still in progress.

     *

     * @param string $requestId The request ID. If omitted, the last request ID will be used.

     * @return Zend_Service_WindowsAzure_Management_OperationStatusInstance

     * @throws Zend_Service_WindowsAzure_Management_Exception

     */

    public function getOperationStatus($requestId = '')

    {

    	if ($requestId == '') {

    		$requestId = $this->getLastRequestId();

    	}

    	$response = $this->_performRequest(self::OP_OPERATIONS . '/' . $requestId);

    	if ($response->isSuccessful()) {

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

			if (!is_null($result)) {

				return new Zend_Service_WindowsAzure_Management_OperationStatusInstance(

					(string)$result->ID,

					(string)$result->Status,

					($result->Error ? (string)$result->Error->Code : ''),

					($result->Error ? (string)$result->Error->Message : '')

				);

			}

			return null;

		} else {

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

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

		}

    }

    /**

     * The List Subscription Operations operation returns a list of create, update,

     * and delete operations that were performed on a subscription during the specified timeframe.

     * Documentation on the parameters can be found at http://msdn.microsoft.com/en-us/library/gg715318.aspx.

     *

     * @param string $startTime The start of the timeframe to begin listing subscription operations in UTC format. This parameter and the $endTime parameter indicate the timeframe to retrieve subscription operations. This parameter cannot indicate a start date of more than 90 days in the past.

     * @param string $endTime The end of the timeframe to begin listing subscription operations in UTC format. This parameter and the $startTime parameter indicate the timeframe to retrieve subscription operations. 

     * @param string $objectIdFilter Returns subscription operations only for the specified object type and object ID. 

     * @param string $operationResultFilter Returns subscription operations only for the specified result status, either Succeeded, Failed, or InProgress.

     * @param string $continuationToken Internal usage.

     * @return array Array of Zend_Service_WindowsAzure_Management_SubscriptionOperationInstance

     * @throws Zend_Service_WindowsAzure_Management_Exception

     */

    public function listSubscriptionOperations($startTime, $endTime, $objectIdFilter = null, $operationResultFilter = null, $continuationToken = null)

    {

    	if ($startTime == '' || is_null($startTime)) {

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

    		throw new Zend_Service_WindowsAzure_Management_Exception('Start time should be specified.');

    	}

    	if ($endTime == '' || is_null($endTime)) {

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

    		throw new Zend_Service_WindowsAzure_Management_Exception('End time should be specified.');

    	}

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

	        $operationResultFilter = strtolower($operationResultFilter);

	    	if ($operationResultFilter != 'succeeded' && $operationResultFilter != 'failed' && $operationResultFilter != 'inprogress') {

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

	    		throw new Zend_Service_WindowsAzure_Management_Exception('OperationResultFilter should be succeeded|failed|inprogress.');

	    	}

    	}

    	$parameters = array();

    	$parameters[] = 'StartTime=' . $startTime;

    	$parameters[] = 'EndTime=' . $endTime;

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

    		$parameters[] = 'ObjectIdFilter=' . $objectIdFilter;

    	}

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

    		$parameters[] = 'OperationResultFilter=' . ucfirst($operationResultFilter);

    	}

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

    		$parameters[] = 'ContinuationToken=' . $continuationToken;

    	}

    	$response = $this->_performRequest(self::OP_OPERATIONS, '?' . implode('&', $parameters));

    	if ($response->isSuccessful()) {

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

			$namespaces = $result->getDocNamespaces(); 

    		$result->registerXPathNamespace('__empty_ns', $namespaces['']);

			$xmlOperations = $result->xpath('//__empty_ns:SubscriptionOperation');

		    // Create return value

		    $returnValue = array();		    

		    foreach ($xmlOperations as $xmlOperation) {

		    	// Create operation instance

		    	$operation = new Zend_Service_WindowsAzure_Management_SubscriptionOperationInstance(

		    		$xmlOperation->OperationId,

		    		$xmlOperation->OperationObjectId,

		    		$xmlOperation->OperationName,

		    		array(),

		    		(array)$xmlOperation->OperationCaller,

		    		(array)$xmlOperation->OperationStatus

		    	);

		    	// Parse parameters

		    	$xmlOperation->registerXPathNamespace('__empty_ns', $namespaces['']); 

		    	$xmlParameters = $xmlOperation->xpath('.//__empty_ns:OperationParameter');

		    	foreach ($xmlParameters as $xmlParameter) {

		    		$xmlParameterDetails = $xmlParameter->children('http://schemas.datacontract.org/2004/07/Microsoft.Samples.WindowsAzure.ServiceManagement');

		    		$operation->addOperationParameter((string)$xmlParameterDetails->Name, (string)$xmlParameterDetails->Value);

		    	}

    		    // Add to result

    		    $returnValue[] = $operation;

		    }

			// More data?

		    if (!is_null($result->ContinuationToken) && $result->ContinuationToken != '') {

		    	$returnValue = array_merge($returnValue, $this->listSubscriptionOperations($startTime, $endTime, $objectIdFilter, $operationResultFilter, (string)$result->ContinuationToken));

		    }

		    // Return

		    return $returnValue;

		} else {

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

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

		}

    }

    /**

     * Wait for an operation to complete

     * 

     * @param string $requestId The request ID. If omitted, the last request ID will be used.

     * @param int $sleepInterval Sleep interval in milliseconds.

     * @return Zend_Service_WindowsAzure_Management_OperationStatusInstance

     * @throws Zend_Service_WindowsAzure_Management_Exception

     */

    public function waitForOperation($requestId = '', $sleepInterval = 250)

    {

    	if ($requestId == '') {

    		$requestId = $this->getLastRequestId();

    	}

    	if ($requestId == '' || is_null($requestId)) {

    		return null;

    	}

		$status = $this->getOperationStatus($requestId);

		while ($status->Status == 'InProgress') {

		  $status = $this->getOperationStatus($requestId);

		  usleep($sleepInterval);

		}

		return $status;