<?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_Amazon

 * @subpackage SimpleDb

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

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

 */

/**

 * @see Zend_Service_Amazon_Abstract

 */

require_once 'Zend/Service/Amazon/Abstract.php';

/**

 * @see Zend_Service_Amazon_SimpleDb_Response

 */

require_once 'Zend/Service/Amazon/SimpleDb/Response.php';

/**

 * @see Zend_Service_Amazon_SimpleDb_Page

 */

require_once 'Zend/Service/Amazon/SimpleDb/Page.php';

/**

 * @see Zend_Service_Amazon_SimpleDb_Attribute

 */

require_once 'Zend/Service/Amazon/SimpleDb/Attribute.php';

/**

 * @see Zend_Service_Amazon_SimpleDb_Exception

 */

require_once 'Zend/Service/Amazon/SimpleDb/Exception.php';

/**

 * @see Zend_Crypt_Hmac

 */

require_once 'Zend/Crypt/Hmac.php';

/**

 * @category   Zend

 * @package    Zend_Service_Amazon

 * @subpackage SimpleDb

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

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

 */

class Zend_Service_Amazon_SimpleDb extends Zend_Service_Amazon_Abstract

{

    /* Notes */

    // TODO SSL is required

    /**

     * The HTTP query server

     */

    protected $_sdbEndpoint = 'sdb.amazonaws.com/';

    /**

     * Period after which HTTP request will timeout in seconds

     */

    protected $_httpTimeout = 10;

    /**

     * The API version to use

     */

    protected $_sdbApiVersion = '2009-04-15';

    /**

     * Signature Version

     */

    protected $_signatureVersion = '2';

    /**

     * Signature Encoding Method

     */

    protected $_signatureMethod = 'HmacSHA256';

    /**

     * Create Amazon SimpleDB client.

     *

     * @param  string $access_key       Override the default Access Key

     * @param  string $secret_key       Override the default Secret Key

     * @param  string $region           Sets the AWS Region

     * @return void

     */

    public function __construct($accessKey, $secretKey)

    {

        parent::__construct($accessKey, $secretKey);

        $this->setEndpoint("https://" . $this->_sdbEndpoint);

    }

	/**

     * Set SimpleDB endpoint to use

     *

     * @param string|Zend_Uri_Http $endpoint

     * @return Zend_Service_Amazon_SimpleDb

     */

    public function setEndpoint($endpoint)

    {

    	if(!($endpoint instanceof Zend_Uri_Http)) {

    		$endpoint = Zend_Uri::factory($endpoint);

    	}

    	if(!$endpoint->valid()) {

    		require_once 'Zend/Service/Amazon/SimpleDb/Exception.php';

    		throw new Zend_Service_Amazon_SimpleDb_Exception("Invalid endpoint supplied");

    	}

    	$this->_endpoint = $endpoint;

    	return $this;

    }

    /**

     * Get SimpleDB endpoint

     *

     * @return Zend_Uri_Http

     */

    public function getEndpoint() 

    {

    	return $this->_endpoint;

    }

    /**

     * Get attributes API method

     *

     * @param string $domainName Domain name within database

     * @param string 

     */

    public function getAttributes(

        $domainName, $itemName, $attributeName = null

    ) {

        $params               = array();

	    $params['Action']     = 'GetAttributes';

	    $params['DomainName'] = $domainName;

	    $params['ItemName']   = $itemName;

	    if (isset($attributeName)) {

	        $params['AttributeName'] = $attributeName;

	    }

	    $response = $this->_sendRequest($params);

        $document = $response->getSimpleXMLDocument();

        $attributeNodes = $document->GetAttributesResult->Attribute;

        // Return an array of arrays

        $attributes = array();

        foreach($attributeNodes as $attributeNode) {

            $name       = (string)$attributeNode->Name;

            $valueNodes = $attributeNode->Value;

            $data       = null;

            if (is_array($valueNodes) && !empty($valueNodes)) {

                $data = array();

                foreach($valueNodes as $valueNode) {

                    $data[] = (string)$valueNode;

                }

            } elseif (isset($valueNodes)) {

                $data = (string)$valueNodes;

            }

            if (isset($attributes[$name])) {

                $attributes[$name]->addValue($data);    

            } else {

                $attributes[$name] = new Zend_Service_Amazon_SimpleDb_Attribute($itemName, $name, $data);

            }

        }

        return $attributes;

    }

    /**

     * Push attributes

     *

     * @param  string $domainName

     * @param  string $itemName

     * @param  array|Traverable $attributes

     * @param  array $replace

     * @return void

     */

    public function putAttributes(

        $domainName, $itemName, $attributes, $replace = array()

    ) {

        $params               = array();

	    $params['Action']     = 'PutAttributes';

	    $params['DomainName'] = $domainName;

	    $params['ItemName']   = $itemName;

	    $index = 0;

	    foreach ($attributes as $attribute) {

	        $attributeName = $attribute->getName();

            foreach ($attribute->getValues() as $value) {

	            $params['Attribute.' . $index . '.Name']  = $attributeName;

                $params['Attribute.' . $index . '.Value'] = $value;

	            // Check if it should be replaced

                if(array_key_exists($attributeName, $replace) && $replace[$attributeName]) {

                    $params['Attribute.' . $index . '.Replace'] = 'true';

                }

                $index++;

            }

	    }

	    // Exception should get thrown if there's an error

        $response = $this->_sendRequest($params);

    }

    /**

     * Add many attributes at once

     * 

     * @param  array $items 

     * @param  string $domainName 

     * @param  array $replace 

     * @return void

     */

    public function batchPutAttributes($items, $domainName, array $replace = array()) 

    {

        $params               = array();

        $params['Action']     = 'BatchPutAttributes';

        $params['DomainName'] = $domainName;

        $itemIndex = 0;

        foreach ($items as $name => $attributes) {

            $params['Item.' . $itemIndex . '.ItemName'] = $name;

            $attributeIndex = 0;

            foreach ($attributes as $attribute) {

                // attribute value cannot be array, so when several items are passed

                // they are treated as separate values with the same attribute name

                foreach($attribute->getValues() as $value) {

                    $params['Item.' . $itemIndex . '.Attribute.' . $attributeIndex . '.Name'] = $attribute->getName();

                    $params['Item.' . $itemIndex . '.Attribute.' . $attributeIndex . '.Value'] = $value;

                    if (isset($replace[$name]) 

                        && isset($replace[$name][$attribute->getName()]) 

                        && $replace[$name][$attribute->getName()]

                    ) {

                        $params['Item.' . $itemIndex . '.Attribute.' . $attributeIndex . '.Replace'] = 'true';

                    }

                    $attributeIndex++;

                }

            }

            $itemIndex++;

        }

        $response = $this->_sendRequest($params);

    }

    /**

     * Delete attributes

     * 

     * @param  string $domainName 

     * @param  string $itemName 

     * @param  array $attributes 

     * @return void

     */

    public function deleteAttributes($domainName, $itemName, array $attributes = array()) 

    {

        $params               = array();

	    $params['Action']     = 'DeleteAttributes';

	    $params['DomainName'] = $domainName;

	    $params['ItemName']   = $itemName;

	    $attributeIndex = 0;

	    foreach ($attributes as $attribute) {

	        foreach ($attribute->getValues() as $value) {

	            $params['Attribute.' . $attributeIndex . '.Name'] = $attribute->getName();

	            $params['Attribute.' . $attributeIndex . '.Value'] = $value;

                $attributeIndex++;

	        }

	    }

        $response = $this->_sendRequest($params);

        return true;

    }

    /**

     * List domains

     *

     * @param $maxNumberOfDomains int

     * @param $nextToken          int

     * @return array              0 or more domain names

     */

    public function listDomains($maxNumberOfDomains = 100, $nextToken = null) 

    {

        $params                       = array();

	    $params['Action']             = 'ListDomains';

	    $params['MaxNumberOfDomains'] = $maxNumberOfDomains;

	    if (null !== $nextToken) {

	        $params['NextToken'] = $nextToken;

	    }

        $response = $this->_sendRequest($params);

        $domainNodes = $response->getSimpleXMLDocument()->ListDomainsResult->DomainName;

        $data = array();

        foreach ($domainNodes as $domain) {

            $data[] = (string)$domain;

        }

        $nextTokenNode = $response->getSimpleXMLDocument()->ListDomainsResult->NextToken;

        $nextToken     = (string)$nextTokenNode;

        $nextToken     = (trim($nextToken) === '') ? null : $nextToken;

        return new Zend_Service_Amazon_SimpleDb_Page($data, $nextToken);

    }

    /**

     * Retrieve domain metadata

     *

     * @param $domainName string Name of the domain for which metadata will be requested

     * @return array Key/value array of metadatum names and values.

     */

    public function domainMetadata($domainName) 

    {

        $params               = array();

	    $params['Action']     = 'DomainMetadata';

	    $params['DomainName'] = $domainName;

        $response             = $this->_sendRequest($params);

        $document = $response->getSimpleXMLDocument();

        $metadataNodes = $document->DomainMetadataResult->children();

        $metadata      = array();

        foreach ($metadataNodes as $metadataNode) {

            $name            = $metadataNode->getName();

            $metadata[$name] = (string)$metadataNode;

        }

        return $metadata;

    }

    /**

     * Create a new domain

     *

     * @param $domainName	string	Valid domain name of the domain to create

     * @return 				boolean True if successful, false if not

     */

	public function createDomain($domainName) 

	{

        $params               = array();

	    $params['Action']     = 'CreateDomain';

	    $params['DomainName'] = $domainName;

        $response             = $this->_sendRequest($params);

        return $response->getHttpResponse()->isSuccessful();

    }

    /**

     * Delete a domain

     *

     * @param 	$domainName string  Valid domain name of the domain to delete

     * @return 				boolean True if successful, false if not

     */

	public function deleteDomain($domainName) 

	{

	    $params               = array();

	    $params['Action']     = 'DeleteDomain';

	    $params['DomainName'] = $domainName;

        $response             = $this->_sendRequest($params);

        return $response->getHttpResponse()->isSuccessful();

    }

    /**

     * Select items from the database

     *

     * @param  string $selectExpression

     * @param  null|string $nextToken

     * @return Zend_Service_Amazon_SimpleDb_Page

     */

	public function select($selectExpression, $nextToken = null) 

	{

        $params                     = array();

	    $params['Action']           = 'Select';

	    $params['SelectExpression'] = $selectExpression;

	    if (null !== $nextToken) {

	        $params['NextToken'] = $nextToken;

	    }

        $response = $this->_sendRequest($params);

        $xml      = $response->getSimpleXMLDocument();

        $attributes = array();

        foreach ($xml->SelectResult->Item as $item) {

            $itemName = (string)$item->Name;

            foreach ($item->Attribute as $attribute) {

                $attributeName = (string)$attribute->Name;

                $values = array();

                foreach ($attribute->Value as $value) {

                    $values[] = (string)$value;

                }

                $attributes[$itemName][$attributeName] = new Zend_Service_Amazon_SimpleDb_Attribute($itemName, $attributeName, $values);

            }

        }

        $nextToken = (string)$xml->NextToken;

        return new Zend_Service_Amazon_SimpleDb_Page($attributes, $nextToken);

    }

	/**

	 * Quote SDB value

	 * 

	 * Wraps it in ''

	 * 

	 * @param string $value

	 * @return string

	 */

    public function quote($value)

    {

    	// wrap in single quotes and convert each ' inside to ''

    	return "'" . str_replace("'", "''", $value) . "'";

    }

	/**

	 * Quote SDB column or table name

	 * 

	 * Wraps it in ``

	 * @param string $name

	 * @return string

	 */

    public function quoteName($name)

    {

    	if (preg_match('/^[a-z_$][a-z0-9_$-]*$/i', $name) == false) {

    		throw new Zend_Service_Amazon_SimpleDb_Exception("Invalid name: can contain only alphanumeric characters, \$ and _");

    	}