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

 * @subpackage Amazon_S3

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

 */

require_once 'Zend/Crypt/Hmac.php';

/**

 * Amazon S3 PHP connection class

 *

 * @category   Zend

 * @package    Zend_Service

 * @subpackage Amazon_S3

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

 * @see        http://docs.amazonwebservices.com/AmazonS3/2006-03-01/

 */

class Zend_Service_Amazon_S3 extends Zend_Service_Amazon_Abstract

{

    /**

     * Store for stream wrapper clients

     *

     * @var array

     */

    protected static $_wrapperClients = array();

    /**

     * Endpoint for the service

     *

     * @var Zend_Uri_Http

     */

    protected $_endpoint;

    const S3_ENDPOINT = 's3.amazonaws.com';

    const S3_ACL_PRIVATE = 'private';

    const S3_ACL_PUBLIC_READ = 'public-read';

    const S3_ACL_PUBLIC_WRITE = 'public-read-write';

    const S3_ACL_AUTH_READ = 'authenticated-read';

    const S3_REQUESTPAY_HEADER = 'x-amz-request-payer';

    const S3_ACL_HEADER = 'x-amz-acl';

    const S3_CONTENT_TYPE_HEADER = 'Content-Type';

    /**

     * Set S3 endpoint to use

     *

     * @param string|Zend_Uri_Http $endpoint

     * @return Zend_Service_Amazon_S3

     */

    public function setEndpoint($endpoint)

    {

        if (!($endpoint instanceof Zend_Uri_Http)) {

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

        }

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

            /**

             * @see Zend_Service_Amazon_S3_Exception

             */

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

            throw new Zend_Service_Amazon_S3_Exception('Invalid endpoint supplied');

        }

        $this->_endpoint = $endpoint;

        return $this;

    }

    /**

     * Get current S3 endpoint

     *

     * @return Zend_Uri_Http

     */

    public function getEndpoint()

    {

        return $this->_endpoint;

    }

    /**

     * Constructor

     *

     * @param string $accessKey

     * @param string $secretKey

     * @param string $region

     */

    public function __construct($accessKey=null, $secretKey=null, $region=null)

    {

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

        $this->setEndpoint('http://'.self::S3_ENDPOINT);

    }

    /**

     * Verify if the bucket name is valid

     *

     * @param string $bucket

     * @return boolean

     */

    public function _validBucketName($bucket)

    {

        $len = strlen($bucket);

        if ($len < 3 || $len > 255) {

            /**

             * @see Zend_Service_Amazon_S3_Exception

             */

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

            throw new Zend_Service_Amazon_S3_Exception("Bucket name \"$bucket\" must be between 3 and 255 characters long");

        }

        if (preg_match('/[^a-z0-9\._-]/', $bucket)) {

            /**

             * @see Zend_Service_Amazon_S3_Exception

             */

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

            throw new Zend_Service_Amazon_S3_Exception("Bucket name \"$bucket\" contains invalid characters");

        }

        if (preg_match('/(\d){1,3}\.(\d){1,3}\.(\d){1,3}\.(\d){1,3}/', $bucket)) {

            /**

             * @see Zend_Service_Amazon_S3_Exception

             */

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

            throw new Zend_Service_Amazon_S3_Exception("Bucket name \"$bucket\" cannot be an IP address");

        }

        return true;

    }

    /**

     * Add a new bucket

     *

     * @param  string $bucket

     * @return boolean

     */

    public function createBucket($bucket, $location = null)

    {

        $this->_validBucketName($bucket);

        $headers=array();

        if($location) {

            $data = '<CreateBucketConfiguration><LocationConstraint>'.$location.'</LocationConstraint></CreateBucketConfiguration>';

            $headers[self::S3_CONTENT_TYPE_HEADER]= 'text/plain';

            $headers['Content-size']= strlen($data);

        } else {

            $data = null;

        }

        $response = $this->_makeRequest('PUT', $bucket, null, $headers, $data);

        return ($response->getStatus() == 200);

    }

    /**

     * Checks if a given bucket name is available

     *

     * @param  string $bucket

     * @return boolean

     */

    public function isBucketAvailable($bucket)

    {

        $response = $this->_makeRequest('HEAD', $bucket, array('max-keys'=>0));

        return ($response->getStatus() != 404);

    }

    /**

     * Checks if a given object exists

     *

     * @param  string $object

     * @return boolean

     */

    public function isObjectAvailable($object)

    {

        $object = $this->_fixupObjectName($object);

        $response = $this->_makeRequest('HEAD', $object);

        return ($response->getStatus() == 200);

    }

    /**

     * Remove a given bucket. All objects in the bucket must be removed prior

     * to removing the bucket.

     *

     * @param  string $bucket

     * @return boolean

     */

    public function removeBucket($bucket)

    {

        $response = $this->_makeRequest('DELETE', $bucket);

        // Look for a 204 No Content response

        return ($response->getStatus() == 204);

    }

    /**

     * Get metadata information for a given object

     *

     * @param  string $object

     * @return array|false

     */

    public function getInfo($object)

    {

        $info = array();

        $object = $this->_fixupObjectName($object);

        $response = $this->_makeRequest('HEAD', $object);

        if ($response->getStatus() == 200) {

            $info['type'] = $response->getHeader('Content-type');

            $info['size'] = $response->getHeader('Content-length');

            $info['mtime'] = strtotime($response->getHeader('Last-modified'));

            $info['etag'] = $response->getHeader('ETag');

        }

        else {

            return false;

        }

        return $info;

    }

    /**

     * List the S3 buckets

     *

     * @return array|false

     */

    public function getBuckets()

    {

        $response = $this->_makeRequest('GET');

        if ($response->getStatus() != 200) {

            return false;

        }

        $xml = new SimpleXMLElement($response->getBody());

        $buckets = array();

        foreach ($xml->Buckets->Bucket as $bucket) {

            $buckets[] = (string)$bucket->Name;

        }

        return $buckets;

    }

    /**

     * Remove all objects in the bucket.

     *

     * @param string $bucket

     * @return boolean

     */

    public function cleanBucket($bucket)

    {

        $objects = $this->getObjectsByBucket($bucket);

        if (!$objects) {

            return false;

        }

        while (!empty($objects)) {

            foreach ($objects as $object) {

                $this->removeObject("$bucket/$object");

            }

            $params= array (

                'marker' => $objects[count($objects)-1]

            );

            $objects = $this->getObjectsByBucket($bucket,$params);

        }

        return true;

    }

    /**

     * List the objects in a bucket.

     *

     * Provides the list of object keys that are contained in the bucket.  Valid params include the following.

     * prefix - Limits the response to keys which begin with the indicated prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders.

     * marker - Indicates where in the bucket to begin listing. The list will only include keys that occur lexicographically after marker. This is convenient for pagination: To get the next page of results use the last key of the current page as the marker.

     * max-keys - The maximum number of keys you'd like to see in the response body. The server might return fewer than this many keys, but will not return more.

     * delimiter - Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response.

     *

     * @param  string $bucket

     * @param array $params S3 GET Bucket Paramater

     * @return array|false

     */

    public function getObjectsByBucket($bucket, $params = array())

    {

        $response = $this->_makeRequest('GET', $bucket, $params);

        if ($response->getStatus() != 200) {

            return false;

        }

        $xml = new SimpleXMLElement($response->getBody());

        $objects = array();

        if (isset($xml->Contents)) {

            foreach ($xml->Contents as $contents) {

                foreach ($contents->Key as $object) {

                    $objects[] = (string)$object;

                }

            }

        }

        return $objects;

    }

     /**

     * List the objects and common prefixes in a bucket.

     *

     * Provides the list of object keys and common prefixes that are contained in the bucket.  Valid params include the following.

     * prefix - Limits the response to keys which begin with the indicated prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders.

     * marker - Indicates where in the bucket to begin listing. The list will only include keys that occur lexicographically after marker. This is convenient for pagination: To get the next page of results use the last key of the current page as the marker.

     * max-keys - The maximum number of keys you'd like to see in the response body. The server might return fewer than this many keys, but will not return more.

     * delimiter - Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response.

     *

     * @see ZF-11401

     * @param  string $bucket

     * @param array $params S3 GET Bucket Paramater

     * @return array|false

     */

    public function getObjectsAndPrefixesByBucket($bucket, $params = array())

    {

        $response = $this->_makeRequest('GET', $bucket, $params);

        if ($response->getStatus() != 200) {

            return false;

        }

        $xml = new SimpleXMLElement($response->getBody());

        $objects = array();

        if (isset($xml->Contents)) {

            foreach ($xml->Contents as $contents) {

                foreach ($contents->Key as $object) {

                    $objects[] = (string)$object;

                }

            }

        }

        $prefixes = array();

        if (isset($xml->CommonPrefixes)) {

            foreach ($xml->CommonPrefixes as $prefix) {

                foreach ($prefix->Prefix as $object) {

                    $prefixes[] = (string)$object;

                }

            }

        }

        return array(

            'objects'  => $objects,

            'prefixes' => $prefixes

        );

    }

    /**

     * Make sure the object name is valid

     *

     * @param  string $object

     * @return string

     */

    protected function _fixupObjectName($object)

    {

        $nameparts = explode('/', $object);

        $this->_validBucketName($nameparts[0]);

        $firstpart = array_shift($nameparts);

        if (count($nameparts) == 0) {

            return $firstpart;

        }

        return $firstpart.'/'.join('/', array_map('rawurlencode', $nameparts));

    }

    /**

     * Get an object

     *

     * @param  string $object

     * @param  bool   $paidobject This is "requestor pays" object

     * @return string|false

     */

    public function getObject($object, $paidobject=false)

    {

        $object = $this->_fixupObjectName($object);

        if ($paidobject) {

            $response = $this->_makeRequest('GET', $object, null, array(self::S3_REQUESTPAY_HEADER => 'requester'));

        }

        else {

            $response = $this->_makeRequest('GET', $object);

        }

        if ($response->getStatus() != 200) {

            return false;

        }

        return $response->getBody();

    }

    /**

     * Get an object using streaming

     *

     * Can use either provided filename for storage or create a temp file if none provided.

     *

     * @param  string $object Object path

     * @param  string $streamfile File to write the stream to

     * @param  bool   $paidobject This is "requestor pays" object

     * @return Zend_Http_Response_Stream|false

     */

    public function getObjectStream($object, $streamfile = null, $paidobject=false)

    {

        $object = $this->_fixupObjectName($object);

        self::getHttpClient()->setStream($streamfile?$streamfile:true);

        if ($paidobject) {

            $response = $this->_makeRequest('GET', $object, null, array(self::S3_REQUESTPAY_HEADER => 'requester'));

        }

        else {

            $response = $this->_makeRequest('GET', $object);

        }

        self::getHttpClient()->setStream(null);

        if ($response->getStatus() != 200 || !($response instanceof Zend_Http_Response_Stream)) {