| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391 |
- <?php
- /**
- * $Id$
- *
- * Copyright (c) 2013, Donovan Schönknecht. 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.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
- *
- * Amazon S3 is a trademark of Amazon.com, Inc. or its affiliates.
- */
- /**
- * Amazon S3 PHP class
- *
- * @link http://undesigned.org.za/2007/10/22/amazon-s3-php-class
- * @version 0.5.1
- */
- class S3
- {
- // ACL flags
- const ACL_PRIVATE = 'private';
- const ACL_PUBLIC_READ = 'public-read';
- const ACL_PUBLIC_READ_WRITE = 'public-read-write';
- const ACL_AUTHENTICATED_READ = 'authenticated-read';
- const STORAGE_CLASS_STANDARD = 'STANDARD';
- const STORAGE_CLASS_RRS = 'REDUCED_REDUNDANCY';
- const STORAGE_CLASS_STANDARD_IA = 'STANDARD_IA';
- const SSE_NONE = '';
- const SSE_AES256 = 'AES256';
- /**
- * The AWS Access key
- *
- * @var string
- * @access private
- * @static
- */
- private static $__accessKey = null;
- /**
- * AWS Secret Key
- *
- * @var string
- * @access private
- * @static
- */
- private static $__secretKey = null;
- /**
- * SSL Client key
- *
- * @var string
- * @access private
- * @static
- */
- private static $__sslKey = null;
- /**
- * Default delimiter to be used, for example while getBucket().
- * @var string
- * @access public
- * @static
- */
- public static $defDelimiter = null;
- /**
- * AWS URI
- *
- * @var string
- * @acess public
- * @static
- */
- public static $endpoint = 's3.amazonaws.com';
- /**
- * Proxy information
- *
- * @var null|array
- * @access public
- * @static
- */
- public static $proxy = null;
- /**
- * Connect using SSL?
- *
- * @var bool
- * @access public
- * @static
- */
- public static $useSSL = false;
- /**
- * Use SSL validation?
- *
- * @var bool
- * @access public
- * @static
- */
- public static $useSSLValidation = true;
- /**
- * Use SSL version
- *
- * @var const
- * @access public
- * @static
- */
- public static $useSSLVersion = CURL_SSLVERSION_TLSv1;
- /**
- * Use PHP exceptions?
- *
- * @var bool
- * @access public
- * @static
- */
- public static $useExceptions = false;
- /**
- * Time offset applied to time()
- * @access private
- * @static
- */
- private static $__timeOffset = 0;
- /**
- * SSL client key
- *
- * @var bool
- * @access public
- * @static
- */
- public static $sslKey = null;
-
- /**
- * SSL client certfificate
- *
- * @var string
- * @acess public
- * @static
- */
- public static $sslCert = null;
-
- /**
- * SSL CA cert (only required if you are having problems with your system CA cert)
- *
- * @var string
- * @access public
- * @static
- */
- public static $sslCACert = null;
-
- /**
- * AWS Key Pair ID
- *
- * @var string
- * @access private
- * @static
- */
- private static $__signingKeyPairId = null;
-
- /**
- * Key resource, freeSigningKey() must be called to clear it from memory
- *
- * @var bool
- * @access private
- * @static
- */
- private static $__signingKeyResource = false;
- /**
- * Constructor - if you're not using the class statically
- *
- * @param string $accessKey Access key
- * @param string $secretKey Secret key
- * @param boolean $useSSL Enable SSL
- * @param string $endpoint Amazon URI
- * @return void
- */
- public function __construct($accessKey = null, $secretKey = null, $useSSL = false, $endpoint = 's3.amazonaws.com')
- {
- if ($accessKey !== null && $secretKey !== null)
- self::setAuth($accessKey, $secretKey);
- self::$useSSL = $useSSL;
- self::$endpoint = $endpoint;
- }
- /**
- * Set the service endpoint
- *
- * @param string $host Hostname
- * @return void
- */
- public function setEndpoint($host)
- {
- self::$endpoint = $host;
- }
- /**
- * Set AWS access key and secret key
- *
- * @param string $accessKey Access key
- * @param string $secretKey Secret key
- * @return void
- */
- public static function setAuth($accessKey, $secretKey)
- {
- self::$__accessKey = $accessKey;
- self::$__secretKey = $secretKey;
- }
- /**
- * Check if AWS keys have been set
- *
- * @return boolean
- */
- public static function hasAuth() {
- return (self::$__accessKey !== null && self::$__secretKey !== null);
- }
- /**
- * Set SSL on or off
- *
- * @param boolean $enabled SSL enabled
- * @param boolean $validate SSL certificate validation
- * @return void
- */
- public static function setSSL($enabled, $validate = true)
- {
- self::$useSSL = $enabled;
- self::$useSSLValidation = $validate;
- }
- /**
- * Set SSL client certificates (experimental)
- *
- * @param string $sslCert SSL client certificate
- * @param string $sslKey SSL client key
- * @param string $sslCACert SSL CA cert (only required if you are having problems with your system CA cert)
- * @return void
- */
- public static function setSSLAuth($sslCert = null, $sslKey = null, $sslCACert = null)
- {
- self::$sslCert = $sslCert;
- self::$sslKey = $sslKey;
- self::$sslCACert = $sslCACert;
- }
- /**
- * Set proxy information
- *
- * @param string $host Proxy hostname and port (localhost:1234)
- * @param string $user Proxy username
- * @param string $pass Proxy password
- * @param constant $type CURL proxy type
- * @return void
- */
- public static function setProxy($host, $user = null, $pass = null, $type = CURLPROXY_SOCKS5)
- {
- self::$proxy = array('host' => $host, 'type' => $type, 'user' => $user, 'pass' => $pass);
- }
- /**
- * Set the error mode to exceptions
- *
- * @param boolean $enabled Enable exceptions
- * @return void
- */
- public static function setExceptions($enabled = true)
- {
- self::$useExceptions = $enabled;
- }
- /**
- * Set AWS time correction offset (use carefully)
- *
- * This can be used when an inaccurate system time is generating
- * invalid request signatures. It should only be used as a last
- * resort when the system time cannot be changed.
- *
- * @param string $offset Time offset (set to zero to use AWS server time)
- * @return void
- */
- public static function setTimeCorrectionOffset($offset = 0)
- {
- if ($offset == 0)
- {
- $rest = new S3Request('HEAD');
- $rest = $rest->getResponse();
- $awstime = $rest->headers['date'];
- $systime = time();
- $offset = $systime > $awstime ? -($systime - $awstime) : ($awstime - $systime);
- }
- self::$__timeOffset = $offset;
- }
- /**
- * Set signing key
- *
- * @param string $keyPairId AWS Key Pair ID
- * @param string $signingKey Private Key
- * @param boolean $isFile Load private key from file, set to false to load string
- * @return boolean
- */
- public static function setSigningKey($keyPairId, $signingKey, $isFile = true)
- {
- self::$__signingKeyPairId = $keyPairId;
- if ((self::$__signingKeyResource = openssl_pkey_get_private($isFile ?
- file_get_contents($signingKey) : $signingKey)) !== false) return true;
- self::__triggerError('S3::setSigningKey(): Unable to open load private key: '.$signingKey, __FILE__, __LINE__);
- return false;
- }
- /**
- * Free signing key from memory, MUST be called if you are using setSigningKey()
- *
- * @return void
- */
- public static function freeSigningKey()
- {
- if (self::$__signingKeyResource !== false)
- openssl_free_key(self::$__signingKeyResource);
- }
- /**
- * Internal error handler
- *
- * @internal Internal error handler
- * @param string $message Error message
- * @param string $file Filename
- * @param integer $line Line number
- * @param integer $code Error code
- * @return void
- */
- private static function __triggerError($message, $file, $line, $code = 0)
- {
- if (self::$useExceptions)
- throw new S3Exception($message, $file, $line, $code);
- else
- trigger_error($message, E_USER_WARNING);
- }
- /**
- * Get a list of buckets
- *
- * @param boolean $detailed Returns detailed bucket list when true
- * @return array | false
- */
- public static function listBuckets($detailed = false)
- {
- $rest = new S3Request('GET', '', '', self::$endpoint);
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::listBuckets(): [%s] %s", $rest->error['code'],
- $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- $results = array();
- if (!isset($rest->body->Buckets)) return $results;
- if ($detailed)
- {
- if (isset($rest->body->Owner, $rest->body->Owner->ID, $rest->body->Owner->DisplayName))
- $results['owner'] = array(
- 'id' => (string)$rest->body->Owner->ID, 'name' => (string)$rest->body->Owner->DisplayName
- );
- $results['buckets'] = array();
- foreach ($rest->body->Buckets->Bucket as $b)
- $results['buckets'][] = array(
- 'name' => (string)$b->Name, 'time' => strtotime((string)$b->CreationDate)
- );
- } else
- foreach ($rest->body->Buckets->Bucket as $b) $results[] = (string)$b->Name;
- return $results;
- }
- /**
- * Get contents for a bucket
- *
- * If maxKeys is null this method will loop through truncated result sets
- *
- * @param string $bucket Bucket name
- * @param string $prefix Prefix
- * @param string $marker Marker (last file listed)
- * @param string $maxKeys Max keys (maximum number of keys to return)
- * @param string $delimiter Delimiter
- * @param boolean $returnCommonPrefixes Set to true to return CommonPrefixes
- * @return array | false
- */
- public static function getBucket($bucket, $prefix = null, $marker = null, $maxKeys = null, $delimiter = null, $returnCommonPrefixes = false)
- {
- $rest = new S3Request('GET', $bucket, '', self::$endpoint);
- if ($maxKeys == 0) $maxKeys = null;
- if ($prefix !== null && $prefix !== '') $rest->setParameter('prefix', $prefix);
- if ($marker !== null && $marker !== '') $rest->setParameter('marker', $marker);
- if ($maxKeys !== null && $maxKeys !== '') $rest->setParameter('max-keys', $maxKeys);
- if ($delimiter !== null && $delimiter !== '') $rest->setParameter('delimiter', $delimiter);
- else if (!empty(self::$defDelimiter)) $rest->setParameter('delimiter', self::$defDelimiter);
- $response = $rest->getResponse();
- if ($response->error === false && $response->code !== 200)
- $response->error = array('code' => $response->code, 'message' => 'Unexpected HTTP status');
- if ($response->error !== false)
- {
- self::__triggerError(sprintf("S3::getBucket(): [%s] %s",
- $response->error['code'], $response->error['message']), __FILE__, __LINE__);
- return false;
- }
- $results = array();
- $nextMarker = null;
- if (isset($response->body, $response->body->Contents))
- foreach ($response->body->Contents as $c)
- {
- $results[(string)$c->Key] = array(
- 'name' => (string)$c->Key,
- 'time' => strtotime((string)$c->LastModified),
- 'size' => (int)$c->Size,
- 'hash' => substr((string)$c->ETag, 1, -1)
- );
- $nextMarker = (string)$c->Key;
- }
- if ($returnCommonPrefixes && isset($response->body, $response->body->CommonPrefixes))
- foreach ($response->body->CommonPrefixes as $c)
- $results[(string)$c->Prefix] = array('prefix' => (string)$c->Prefix);
- if (isset($response->body, $response->body->IsTruncated) &&
- (string)$response->body->IsTruncated == 'false') return $results;
- if (isset($response->body, $response->body->NextMarker))
- $nextMarker = (string)$response->body->NextMarker;
- // Loop through truncated results if maxKeys isn't specified
- if ($maxKeys == null && $nextMarker !== null && (string)$response->body->IsTruncated == 'true')
- do
- {
- $rest = new S3Request('GET', $bucket, '', self::$endpoint);
- if ($prefix !== null && $prefix !== '') $rest->setParameter('prefix', $prefix);
- $rest->setParameter('marker', $nextMarker);
- if ($delimiter !== null && $delimiter !== '') $rest->setParameter('delimiter', $delimiter);
- if (($response = $rest->getResponse()) == false || $response->code !== 200) break;
- if (isset($response->body, $response->body->Contents))
- foreach ($response->body->Contents as $c)
- {
- $results[(string)$c->Key] = array(
- 'name' => (string)$c->Key,
- 'time' => strtotime((string)$c->LastModified),
- 'size' => (int)$c->Size,
- 'hash' => substr((string)$c->ETag, 1, -1)
- );
- $nextMarker = (string)$c->Key;
- }
- if ($returnCommonPrefixes && isset($response->body, $response->body->CommonPrefixes))
- foreach ($response->body->CommonPrefixes as $c)
- $results[(string)$c->Prefix] = array('prefix' => (string)$c->Prefix);
- if (isset($response->body, $response->body->NextMarker))
- $nextMarker = (string)$response->body->NextMarker;
- } while ($response !== false && (string)$response->body->IsTruncated == 'true');
- return $results;
- }
- /**
- * Put a bucket
- *
- * @param string $bucket Bucket name
- * @param constant $acl ACL flag
- * @param string $location Set as "EU" to create buckets hosted in Europe
- * @return boolean
- */
- public static function putBucket($bucket, $acl = self::ACL_PRIVATE, $location = false)
- {
- $rest = new S3Request('PUT', $bucket, '', self::$endpoint);
- $rest->setAmzHeader('x-amz-acl', $acl);
- if ($location !== false)
- {
- $dom = new DOMDocument;
- $createBucketConfiguration = $dom->createElement('CreateBucketConfiguration');
- $locationConstraint = $dom->createElement('LocationConstraint', $location);
- $createBucketConfiguration->appendChild($locationConstraint);
- $dom->appendChild($createBucketConfiguration);
- $rest->data = $dom->saveXML();
- $rest->size = strlen($rest->data);
- $rest->setHeader('Content-Type', 'application/xml');
- }
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::putBucket({$bucket}, {$acl}, {$location}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return true;
- }
- /**
- * Delete an empty bucket
- *
- * @param string $bucket Bucket name
- * @return boolean
- */
- public static function deleteBucket($bucket)
- {
- $rest = new S3Request('DELETE', $bucket, '', self::$endpoint);
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 204)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::deleteBucket({$bucket}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return true;
- }
- /**
- * Create input info array for putObject()
- *
- * @param string $file Input file
- * @param mixed $md5sum Use MD5 hash (supply a string if you want to use your own)
- * @return array | false
- */
- public static function inputFile($file, $md5sum = true)
- {
- if (!file_exists($file) || !is_file($file) || !is_readable($file))
- {
- self::__triggerError('S3::inputFile(): Unable to open input file: '.$file, __FILE__, __LINE__);
- return false;
- }
- clearstatcache(false, $file);
- return array('file' => $file, 'size' => filesize($file), 'md5sum' => $md5sum !== false ?
- (is_string($md5sum) ? $md5sum : base64_encode(md5_file($file, true))) : '');
- }
- /**
- * Create input array info for putObject() with a resource
- *
- * @param string $resource Input resource to read from
- * @param integer $bufferSize Input byte size
- * @param string $md5sum MD5 hash to send (optional)
- * @return array | false
- */
- public static function inputResource(&$resource, $bufferSize = false, $md5sum = '')
- {
- if (!is_resource($resource) || (int)$bufferSize < 0)
- {
- self::__triggerError('S3::inputResource(): Invalid resource or buffer size', __FILE__, __LINE__);
- return false;
- }
- // Try to figure out the bytesize
- if ($bufferSize === false)
- {
- if (fseek($resource, 0, SEEK_END) < 0 || ($bufferSize = ftell($resource)) === false)
- {
- self::__triggerError('S3::inputResource(): Unable to obtain resource size', __FILE__, __LINE__);
- return false;
- }
- fseek($resource, 0);
- }
- $input = array('size' => $bufferSize, 'md5sum' => $md5sum);
- $input['fp'] =& $resource;
- return $input;
- }
- /**
- * Put an object
- *
- * @param mixed $input Input data
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @param constant $acl ACL constant
- * @param array $metaHeaders Array of x-amz-meta-* headers
- * @param array $requestHeaders Array of request headers or content type as a string
- * @param constant $storageClass Storage class constant
- * @param constant $serverSideEncryption Server-side encryption
- * @return boolean
- */
- public static function putObject($input, $bucket, $uri, $acl = self::ACL_PRIVATE, $metaHeaders = array(), $requestHeaders = array(), $storageClass = self::STORAGE_CLASS_STANDARD, $serverSideEncryption = self::SSE_NONE)
- {
- if ($input === false) return false;
- $rest = new S3Request('PUT', $bucket, $uri, self::$endpoint);
- if (!is_array($input)) $input = array(
- 'data' => $input, 'size' => strlen($input),
- 'md5sum' => base64_encode(md5($input, true))
- );
- // Data
- if (isset($input['fp']))
- $rest->fp =& $input['fp'];
- elseif (isset($input['file']))
- $rest->fp = @fopen($input['file'], 'rb');
- elseif (isset($input['data']))
- $rest->data = $input['data'];
- // Content-Length (required)
- if (isset($input['size']) && $input['size'] >= 0)
- $rest->size = $input['size'];
- else {
- if (isset($input['file'])) {
- clearstatcache(false, $input['file']);
- $rest->size = filesize($input['file']);
- }
- elseif (isset($input['data']))
- $rest->size = strlen($input['data']);
- }
- // Custom request headers (Content-Type, Content-Disposition, Content-Encoding)
- if (is_array($requestHeaders))
- foreach ($requestHeaders as $h => $v)
- strpos($h, 'x-amz-') === 0 ? $rest->setAmzHeader($h, $v) : $rest->setHeader($h, $v);
- elseif (is_string($requestHeaders)) // Support for legacy contentType parameter
- $input['type'] = $requestHeaders;
- // Content-Type
- if (!isset($input['type']))
- {
- if (isset($requestHeaders['Content-Type']))
- $input['type'] =& $requestHeaders['Content-Type'];
- elseif (isset($input['file']))
- $input['type'] = self::__getMIMEType($input['file']);
- else
- $input['type'] = 'application/octet-stream';
- }
- if ($storageClass !== self::STORAGE_CLASS_STANDARD) // Storage class
- $rest->setAmzHeader('x-amz-storage-class', $storageClass);
- if ($serverSideEncryption !== self::SSE_NONE) // Server-side encryption
- $rest->setAmzHeader('x-amz-server-side-encryption', $serverSideEncryption);
- // We need to post with Content-Length and Content-Type, MD5 is optional
- if ($rest->size >= 0 && ($rest->fp !== false || $rest->data !== false))
- {
- $rest->setHeader('Content-Type', $input['type']);
- if (isset($input['md5sum'])) $rest->setHeader('Content-MD5', $input['md5sum']);
- $rest->setAmzHeader('x-amz-acl', $acl);
- foreach ($metaHeaders as $h => $v) $rest->setAmzHeader('x-amz-meta-'.$h, $v);
- $rest->getResponse();
- } else
- $rest->response->error = array('code' => 0, 'message' => 'Missing input parameters');
- if ($rest->response->error === false && $rest->response->code !== 200)
- $rest->response->error = array('code' => $rest->response->code, 'message' => 'Unexpected HTTP status');
- if ($rest->response->error !== false)
- {
- self::__triggerError(sprintf("S3::putObject(): [%s] %s",
- $rest->response->error['code'], $rest->response->error['message']), __FILE__, __LINE__);
- return false;
- }
- return true;
- }
- /**
- * Put an object from a file (legacy function)
- *
- * @param string $file Input file path
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @param constant $acl ACL constant
- * @param array $metaHeaders Array of x-amz-meta-* headers
- * @param string $contentType Content type
- * @return boolean
- */
- public static function putObjectFile($file, $bucket, $uri, $acl = self::ACL_PRIVATE, $metaHeaders = array(), $contentType = null)
- {
- return self::putObject(self::inputFile($file), $bucket, $uri, $acl, $metaHeaders, $contentType);
- }
- /**
- * Put an object from a string (legacy function)
- *
- * @param string $string Input data
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @param constant $acl ACL constant
- * @param array $metaHeaders Array of x-amz-meta-* headers
- * @param string $contentType Content type
- * @return boolean
- */
- public static function putObjectString($string, $bucket, $uri, $acl = self::ACL_PRIVATE, $metaHeaders = array(), $contentType = 'text/plain')
- {
- return self::putObject($string, $bucket, $uri, $acl, $metaHeaders, $contentType);
- }
- /**
- * Get an object
- *
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @param mixed $saveTo Filename or resource to write to
- * @return mixed
- */
- public static function getObject($bucket, $uri, $saveTo = false)
- {
- $rest = new S3Request('GET', $bucket, $uri, self::$endpoint);
- if ($saveTo !== false)
- {
- if (is_resource($saveTo))
- $rest->fp =& $saveTo;
- else
- if (($rest->fp = @fopen($saveTo, 'wb')) !== false)
- $rest->file = realpath($saveTo);
- else
- $rest->response->error = array('code' => 0, 'message' => 'Unable to open save file for writing: '.$saveTo);
- }
- if ($rest->response->error === false) $rest->getResponse();
- if ($rest->response->error === false && $rest->response->code !== 200)
- $rest->response->error = array('code' => $rest->response->code, 'message' => 'Unexpected HTTP status');
- if ($rest->response->error !== false)
- {
- self::__triggerError(sprintf("S3::getObject({$bucket}, {$uri}): [%s] %s",
- $rest->response->error['code'], $rest->response->error['message']), __FILE__, __LINE__);
- return false;
- }
- return $rest->response;
- }
- /**
- * Get object information
- *
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @param boolean $returnInfo Return response information
- * @return mixed | false
- */
- public static function getObjectInfo($bucket, $uri, $returnInfo = true)
- {
- $rest = new S3Request('HEAD', $bucket, $uri, self::$endpoint);
- $rest = $rest->getResponse();
- if ($rest->error === false && ($rest->code !== 200 && $rest->code !== 404))
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::getObjectInfo({$bucket}, {$uri}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return $rest->code == 200 ? $returnInfo ? $rest->headers : true : false;
- }
- /**
- * Copy an object
- *
- * @param string $srcBucket Source bucket name
- * @param string $srcUri Source object URI
- * @param string $bucket Destination bucket name
- * @param string $uri Destination object URI
- * @param constant $acl ACL constant
- * @param array $metaHeaders Optional array of x-amz-meta-* headers
- * @param array $requestHeaders Optional array of request headers (content type, disposition, etc.)
- * @param constant $storageClass Storage class constant
- * @return mixed | false
- */
- public static function copyObject($srcBucket, $srcUri, $bucket, $uri, $acl = self::ACL_PRIVATE, $metaHeaders = array(), $requestHeaders = array(), $storageClass = self::STORAGE_CLASS_STANDARD)
- {
- $rest = new S3Request('PUT', $bucket, $uri, self::$endpoint);
- $rest->setHeader('Content-Length', 0);
- foreach ($requestHeaders as $h => $v)
- strpos($h, 'x-amz-') === 0 ? $rest->setAmzHeader($h, $v) : $rest->setHeader($h, $v);
- foreach ($metaHeaders as $h => $v) $rest->setAmzHeader('x-amz-meta-'.$h, $v);
- if ($storageClass !== self::STORAGE_CLASS_STANDARD) // Storage class
- $rest->setAmzHeader('x-amz-storage-class', $storageClass);
- $rest->setAmzHeader('x-amz-acl', $acl);
- $rest->setAmzHeader('x-amz-copy-source', sprintf('/%s/%s', $srcBucket, rawurlencode($srcUri)));
- if (sizeof($requestHeaders) > 0 || sizeof($metaHeaders) > 0)
- $rest->setAmzHeader('x-amz-metadata-directive', 'REPLACE');
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::copyObject({$srcBucket}, {$srcUri}, {$bucket}, {$uri}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return isset($rest->body->LastModified, $rest->body->ETag) ? array(
- 'time' => strtotime((string)$rest->body->LastModified),
- 'hash' => substr((string)$rest->body->ETag, 1, -1)
- ) : false;
- }
- /**
- * Set up a bucket redirection
- *
- * @param string $bucket Bucket name
- * @param string $location Target host name
- * @return boolean
- */
- public static function setBucketRedirect($bucket = NULL, $location = NULL)
- {
- $rest = new S3Request('PUT', $bucket, '', self::$endpoint);
- if( empty($bucket) || empty($location) ) {
- self::__triggerError("S3::setBucketRedirect({$bucket}, {$location}): Empty parameter.", __FILE__, __LINE__);
- return false;
- }
- $dom = new DOMDocument;
- $websiteConfiguration = $dom->createElement('WebsiteConfiguration');
- $redirectAllRequestsTo = $dom->createElement('RedirectAllRequestsTo');
- $hostName = $dom->createElement('HostName', $location);
- $redirectAllRequestsTo->appendChild($hostName);
- $websiteConfiguration->appendChild($redirectAllRequestsTo);
- $dom->appendChild($websiteConfiguration);
- $rest->setParameter('website', null);
- $rest->data = $dom->saveXML();
- $rest->size = strlen($rest->data);
- $rest->setHeader('Content-Type', 'application/xml');
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::setBucketRedirect({$bucket}, {$location}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return true;
- }
- /**
- * Set logging for a bucket
- *
- * @param string $bucket Bucket name
- * @param string $targetBucket Target bucket (where logs are stored)
- * @param string $targetPrefix Log prefix (e,g; domain.com-)
- * @return boolean
- */
- public static function setBucketLogging($bucket, $targetBucket, $targetPrefix = null)
- {
- // The S3 log delivery group has to be added to the target bucket's ACP
- if ($targetBucket !== null && ($acp = self::getAccessControlPolicy($targetBucket, '')) !== false)
- {
- // Only add permissions to the target bucket when they do not exist
- $aclWriteSet = false;
- $aclReadSet = false;
- foreach ($acp['acl'] as $acl)
- if ($acl['type'] == 'Group' && $acl['uri'] == 'http://acs.amazonaws.com/groups/s3/LogDelivery')
- {
- if ($acl['permission'] == 'WRITE') $aclWriteSet = true;
- elseif ($acl['permission'] == 'READ_ACP') $aclReadSet = true;
- }
- if (!$aclWriteSet) $acp['acl'][] = array(
- 'type' => 'Group', 'uri' => 'http://acs.amazonaws.com/groups/s3/LogDelivery', 'permission' => 'WRITE'
- );
- if (!$aclReadSet) $acp['acl'][] = array(
- 'type' => 'Group', 'uri' => 'http://acs.amazonaws.com/groups/s3/LogDelivery', 'permission' => 'READ_ACP'
- );
- if (!$aclReadSet || !$aclWriteSet) self::setAccessControlPolicy($targetBucket, '', $acp);
- }
- $dom = new DOMDocument;
- $bucketLoggingStatus = $dom->createElement('BucketLoggingStatus');
- $bucketLoggingStatus->setAttribute('xmlns', 'http://s3.amazonaws.com/doc/2006-03-01/');
- if ($targetBucket !== null)
- {
- if ($targetPrefix == null) $targetPrefix = $bucket . '-';
- $loggingEnabled = $dom->createElement('LoggingEnabled');
- $loggingEnabled->appendChild($dom->createElement('TargetBucket', $targetBucket));
- $loggingEnabled->appendChild($dom->createElement('TargetPrefix', $targetPrefix));
- // TODO: Add TargetGrants?
- $bucketLoggingStatus->appendChild($loggingEnabled);
- }
- $dom->appendChild($bucketLoggingStatus);
- $rest = new S3Request('PUT', $bucket, '', self::$endpoint);
- $rest->setParameter('logging', null);
- $rest->data = $dom->saveXML();
- $rest->size = strlen($rest->data);
- $rest->setHeader('Content-Type', 'application/xml');
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::setBucketLogging({$bucket}, {$targetBucket}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return true;
- }
- /**
- * Get logging status for a bucket
- *
- * This will return false if logging is not enabled.
- * Note: To enable logging, you also need to grant write access to the log group
- *
- * @param string $bucket Bucket name
- * @return array | false
- */
- public static function getBucketLogging($bucket)
- {
- $rest = new S3Request('GET', $bucket, '', self::$endpoint);
- $rest->setParameter('logging', null);
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::getBucketLogging({$bucket}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- if (!isset($rest->body->LoggingEnabled)) return false; // No logging
- return array(
- 'targetBucket' => (string)$rest->body->LoggingEnabled->TargetBucket,
- 'targetPrefix' => (string)$rest->body->LoggingEnabled->TargetPrefix,
- );
- }
- /**
- * Disable bucket logging
- *
- * @param string $bucket Bucket name
- * @return boolean
- */
- public static function disableBucketLogging($bucket)
- {
- return self::setBucketLogging($bucket, null);
- }
- /**
- * Get a bucket's location
- *
- * @param string $bucket Bucket name
- * @return string | false
- */
- public static function getBucketLocation($bucket)
- {
- $rest = new S3Request('GET', $bucket, '', self::$endpoint);
- $rest->setParameter('location', null);
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::getBucketLocation({$bucket}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return (isset($rest->body[0]) && (string)$rest->body[0] !== '') ? (string)$rest->body[0] : 'US';
- }
- /**
- * Set object or bucket Access Control Policy
- *
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @param array $acp Access Control Policy Data (same as the data returned from getAccessControlPolicy)
- * @return boolean
- */
- public static function setAccessControlPolicy($bucket, $uri = '', $acp = array())
- {
- $dom = new DOMDocument;
- $dom->formatOutput = true;
- $accessControlPolicy = $dom->createElement('AccessControlPolicy');
- $accessControlList = $dom->createElement('AccessControlList');
- // It seems the owner has to be passed along too
- $owner = $dom->createElement('Owner');
- $owner->appendChild($dom->createElement('ID', $acp['owner']['id']));
- $owner->appendChild($dom->createElement('DisplayName', $acp['owner']['name']));
- $accessControlPolicy->appendChild($owner);
- foreach ($acp['acl'] as $g)
- {
- $grant = $dom->createElement('Grant');
- $grantee = $dom->createElement('Grantee');
- $grantee->setAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
- if (isset($g['id']))
- { // CanonicalUser (DisplayName is omitted)
- $grantee->setAttribute('xsi:type', 'CanonicalUser');
- $grantee->appendChild($dom->createElement('ID', $g['id']));
- }
- elseif (isset($g['email']))
- { // AmazonCustomerByEmail
- $grantee->setAttribute('xsi:type', 'AmazonCustomerByEmail');
- $grantee->appendChild($dom->createElement('EmailAddress', $g['email']));
- }
- elseif ($g['type'] == 'Group')
- { // Group
- $grantee->setAttribute('xsi:type', 'Group');
- $grantee->appendChild($dom->createElement('URI', $g['uri']));
- }
- $grant->appendChild($grantee);
- $grant->appendChild($dom->createElement('Permission', $g['permission']));
- $accessControlList->appendChild($grant);
- }
- $accessControlPolicy->appendChild($accessControlList);
- $dom->appendChild($accessControlPolicy);
- $rest = new S3Request('PUT', $bucket, $uri, self::$endpoint);
- $rest->setParameter('acl', null);
- $rest->data = $dom->saveXML();
- $rest->size = strlen($rest->data);
- $rest->setHeader('Content-Type', 'application/xml');
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::setAccessControlPolicy({$bucket}, {$uri}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return true;
- }
- /**
- * Get object or bucket Access Control Policy
- *
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @return mixed | false
- */
- public static function getAccessControlPolicy($bucket, $uri = '')
- {
- $rest = new S3Request('GET', $bucket, $uri, self::$endpoint);
- $rest->setParameter('acl', null);
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::getAccessControlPolicy({$bucket}, {$uri}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- $acp = array();
- if (isset($rest->body->Owner, $rest->body->Owner->ID, $rest->body->Owner->DisplayName))
- $acp['owner'] = array(
- 'id' => (string)$rest->body->Owner->ID, 'name' => (string)$rest->body->Owner->DisplayName
- );
- if (isset($rest->body->AccessControlList))
- {
- $acp['acl'] = array();
- foreach ($rest->body->AccessControlList->Grant as $grant)
- {
- foreach ($grant->Grantee as $grantee)
- {
- if (isset($grantee->ID, $grantee->DisplayName)) // CanonicalUser
- $acp['acl'][] = array(
- 'type' => 'CanonicalUser',
- 'id' => (string)$grantee->ID,
- 'name' => (string)$grantee->DisplayName,
- 'permission' => (string)$grant->Permission
- );
- elseif (isset($grantee->EmailAddress)) // AmazonCustomerByEmail
- $acp['acl'][] = array(
- 'type' => 'AmazonCustomerByEmail',
- 'email' => (string)$grantee->EmailAddress,
- 'permission' => (string)$grant->Permission
- );
- elseif (isset($grantee->URI)) // Group
- $acp['acl'][] = array(
- 'type' => 'Group',
- 'uri' => (string)$grantee->URI,
- 'permission' => (string)$grant->Permission
- );
- else continue;
- }
- }
- }
- return $acp;
- }
- /**
- * Delete an object
- *
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @return boolean
- */
- public static function deleteObject($bucket, $uri)
- {
- $rest = new S3Request('DELETE', $bucket, $uri, self::$endpoint);
- $rest = $rest->getResponse();
- if ($rest->error === false && $rest->code !== 204)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::deleteObject(): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return true;
- }
- /**
- * Get a query string authenticated URL
- *
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @param integer $lifetime Lifetime in seconds
- * @param boolean $hostBucket Use the bucket name as the hostname
- * @param boolean $https Use HTTPS ($hostBucket should be false for SSL verification)
- * @return string
- */
- public static function getAuthenticatedURL($bucket, $uri, $lifetime, $hostBucket = false, $https = false)
- {
- $expires = self::__getTime() + $lifetime;
- $uri = str_replace(array('%2F', '%2B'), array('/', '+'), rawurlencode($uri));
- return sprintf(($https ? 'https' : 'http').'://%s/%s?AWSAccessKeyId=%s&Expires=%u&Signature=%s',
-
- // $hostBucket ? $bucket : self::$endpoint.'/'.$bucket, $uri, self::$__accessKey, $expires,
- $hostBucket ? $bucket : $bucket . '.' . self::$endpoint, $uri, self::$__accessKey, $expires,
- urlencode(self::__getHash("GET\n\n\n{$expires}\n/{$bucket}/{$uri}")));
- }
- /**
- * Get a CloudFront signed policy URL
- *
- * @param array $policy Policy
- * @return string
- */
- public static function getSignedPolicyURL($policy)
- {
- $data = json_encode($policy);
- $signature = '';
- if (!openssl_sign($data, $signature, self::$__signingKeyResource)) return false;
- $encoded = str_replace(array('+', '='), array('-', '_', '~'), base64_encode($data));
- $signature = str_replace(array('+', '='), array('-', '_', '~'), base64_encode($signature));
- $url = $policy['Statement'][0]['Resource'] . '?';
- foreach (array('Policy' => $encoded, 'Signature' => $signature, 'Key-Pair-Id' => self::$__signingKeyPairId) as $k => $v)
- $url .= $k.'='.str_replace('%2F', '/', rawurlencode($v)).'&';
- return substr($url, 0, -1);
- }
- /**
- * Get a CloudFront canned policy URL
- *
- * @param string $url URL to sign
- * @param integer $lifetime URL lifetime
- * @return string
- */
- public static function getSignedCannedURL($url, $lifetime)
- {
- return self::getSignedPolicyURL(array(
- 'Statement' => array(
- array('Resource' => $url, 'Condition' => array(
- 'DateLessThan' => array('AWS:EpochTime' => self::__getTime() + $lifetime)
- ))
- )
- ));
- }
- /**
- * Get upload POST parameters for form uploads
- *
- * @param string $bucket Bucket name
- * @param string $uriPrefix Object URI prefix
- * @param constant $acl ACL constant
- * @param integer $lifetime Lifetime in seconds
- * @param integer $maxFileSize Maximum filesize in bytes (default 5MB)
- * @param string $successRedirect Redirect URL or 200 / 201 status code
- * @param array $amzHeaders Array of x-amz-meta-* headers
- * @param array $headers Array of request headers or content type as a string
- * @param boolean $flashVars Includes additional "Filename" variable posted by Flash
- * @return object
- */
- public static function getHttpUploadPostParams($bucket, $uriPrefix = '', $acl = self::ACL_PRIVATE, $lifetime = 3600,
- $maxFileSize = 5242880, $successRedirect = "201", $amzHeaders = array(), $headers = array(), $flashVars = false)
- {
- // Create policy object
- $policy = new stdClass;
- $policy->expiration = gmdate('Y-m-d\TH:i:s\Z', (self::__getTime() + $lifetime));
- $policy->conditions = array();
- $obj = new stdClass; $obj->bucket = $bucket; array_push($policy->conditions, $obj);
- $obj = new stdClass; $obj->acl = $acl; array_push($policy->conditions, $obj);
- $obj = new stdClass; // 200 for non-redirect uploads
- if (is_numeric($successRedirect) && in_array((int)$successRedirect, array(200, 201)))
- $obj->success_action_status = (string)$successRedirect;
- else // URL
- $obj->success_action_redirect = $successRedirect;
- array_push($policy->conditions, $obj);
- if ($acl !== self::ACL_PUBLIC_READ)
- array_push($policy->conditions, array('eq', '$acl', $acl));
- array_push($policy->conditions, array('starts-with', '$key', $uriPrefix));
- if ($flashVars) array_push($policy->conditions, array('starts-with', '$Filename', ''));
- foreach (array_keys($headers) as $headerKey)
- array_push($policy->conditions, array('starts-with', '$'.$headerKey, ''));
- foreach ($amzHeaders as $headerKey => $headerVal)
- {
- $obj = new stdClass;
- $obj->{$headerKey} = (string)$headerVal;
- array_push($policy->conditions, $obj);
- }
- array_push($policy->conditions, array('content-length-range', 0, $maxFileSize));
- $policy = base64_encode(str_replace('\/', '/', json_encode($policy)));
- // Create parameters
- $params = new stdClass;
- $params->AWSAccessKeyId = self::$__accessKey;
- $params->key = $uriPrefix.'${filename}';
- $params->acl = $acl;
- $params->policy = $policy; unset($policy);
- $params->signature = self::__getHash($params->policy);
- if (is_numeric($successRedirect) && in_array((int)$successRedirect, array(200, 201)))
- $params->success_action_status = (string)$successRedirect;
- else
- $params->success_action_redirect = $successRedirect;
- foreach ($headers as $headerKey => $headerVal) $params->{$headerKey} = (string)$headerVal;
- foreach ($amzHeaders as $headerKey => $headerVal) $params->{$headerKey} = (string)$headerVal;
- return $params;
- }
- /**
- * Create a CloudFront distribution
- *
- * @param string $bucket Bucket name
- * @param boolean $enabled Enabled (true/false)
- * @param array $cnames Array containing CNAME aliases
- * @param string $comment Use the bucket name as the hostname
- * @param string $defaultRootObject Default root object
- * @param string $originAccessIdentity Origin access identity
- * @param array $trustedSigners Array of trusted signers
- * @return array | false
- */
- public static function createDistribution($bucket, $enabled = true, $cnames = array(), $comment = null, $defaultRootObject = null, $originAccessIdentity = null, $trustedSigners = array())
- {
- if (!extension_loaded('openssl'))
- {
- self::__triggerError(sprintf("S3::createDistribution({$bucket}, ".(int)$enabled.", [], '$comment'): %s",
- "CloudFront functionality requires SSL"), __FILE__, __LINE__);
- return false;
- }
- $useSSL = self::$useSSL;
- self::$useSSL = true; // CloudFront requires SSL
- $rest = new S3Request('POST', '', '2010-11-01/distribution', 'cloudfront.amazonaws.com');
- $rest->data = self::__getCloudFrontDistributionConfigXML(
- $bucket.'.s3.amazonaws.com',
- $enabled,
- (string)$comment,
- (string)microtime(true),
- $cnames,
- $defaultRootObject,
- $originAccessIdentity,
- $trustedSigners
- );
- $rest->size = strlen($rest->data);
- $rest->setHeader('Content-Type', 'application/xml');
- $rest = self::__getCloudFrontResponse($rest);
- self::$useSSL = $useSSL;
- if ($rest->error === false && $rest->code !== 201)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::createDistribution({$bucket}, ".(int)$enabled.", [], '$comment'): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- } elseif ($rest->body instanceof SimpleXMLElement)
- return self::__parseCloudFrontDistributionConfig($rest->body);
- return false;
- }
- /**
- * Get CloudFront distribution info
- *
- * @param string $distributionId Distribution ID from listDistributions()
- * @return array | false
- */
- public static function getDistribution($distributionId)
- {
- if (!extension_loaded('openssl'))
- {
- self::__triggerError(sprintf("S3::getDistribution($distributionId): %s",
- "CloudFront functionality requires SSL"), __FILE__, __LINE__);
- return false;
- }
- $useSSL = self::$useSSL;
- self::$useSSL = true; // CloudFront requires SSL
- $rest = new S3Request('GET', '', '2010-11-01/distribution/'.$distributionId, 'cloudfront.amazonaws.com');
- $rest = self::__getCloudFrontResponse($rest);
- self::$useSSL = $useSSL;
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::getDistribution($distributionId): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- elseif ($rest->body instanceof SimpleXMLElement)
- {
- $dist = self::__parseCloudFrontDistributionConfig($rest->body);
- $dist['hash'] = $rest->headers['hash'];
- $dist['id'] = $distributionId;
- return $dist;
- }
- return false;
- }
- /**
- * Update a CloudFront distribution
- *
- * @param array $dist Distribution array info identical to output of getDistribution()
- * @return array | false
- */
- public static function updateDistribution($dist)
- {
- if (!extension_loaded('openssl'))
- {
- self::__triggerError(sprintf("S3::updateDistribution({$dist['id']}): %s",
- "CloudFront functionality requires SSL"), __FILE__, __LINE__);
- return false;
- }
- $useSSL = self::$useSSL;
- self::$useSSL = true; // CloudFront requires SSL
- $rest = new S3Request('PUT', '', '2010-11-01/distribution/'.$dist['id'].'/config', 'cloudfront.amazonaws.com');
- $rest->data = self::__getCloudFrontDistributionConfigXML(
- $dist['origin'],
- $dist['enabled'],
- $dist['comment'],
- $dist['callerReference'],
- $dist['cnames'],
- $dist['defaultRootObject'],
- $dist['originAccessIdentity'],
- $dist['trustedSigners']
- );
- $rest->size = strlen($rest->data);
- $rest->setHeader('If-Match', $dist['hash']);
- $rest = self::__getCloudFrontResponse($rest);
- self::$useSSL = $useSSL;
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::updateDistribution({$dist['id']}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- } else {
- $dist = self::__parseCloudFrontDistributionConfig($rest->body);
- $dist['hash'] = $rest->headers['hash'];
- return $dist;
- }
- return false;
- }
- /**
- * Delete a CloudFront distribution
- *
- * @param array $dist Distribution array info identical to output of getDistribution()
- * @return boolean
- */
- public static function deleteDistribution($dist)
- {
- if (!extension_loaded('openssl'))
- {
- self::__triggerError(sprintf("S3::deleteDistribution({$dist['id']}): %s",
- "CloudFront functionality requires SSL"), __FILE__, __LINE__);
- return false;
- }
- $useSSL = self::$useSSL;
- self::$useSSL = true; // CloudFront requires SSL
- $rest = new S3Request('DELETE', '', '2008-06-30/distribution/'.$dist['id'], 'cloudfront.amazonaws.com');
- $rest->setHeader('If-Match', $dist['hash']);
- $rest = self::__getCloudFrontResponse($rest);
- self::$useSSL = $useSSL;
- if ($rest->error === false && $rest->code !== 204)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::deleteDistribution({$dist['id']}): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- return true;
- }
- /**
- * Get a list of CloudFront distributions
- *
- * @return array
- */
- public static function listDistributions()
- {
- if (!extension_loaded('openssl'))
- {
- self::__triggerError(sprintf("S3::listDistributions(): [%s] %s",
- "CloudFront functionality requires SSL"), __FILE__, __LINE__);
- return false;
- }
- $useSSL = self::$useSSL;
- self::$useSSL = true; // CloudFront requires SSL
- $rest = new S3Request('GET', '', '2010-11-01/distribution', 'cloudfront.amazonaws.com');
- $rest = self::__getCloudFrontResponse($rest);
- self::$useSSL = $useSSL;
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- self::__triggerError(sprintf("S3::listDistributions(): [%s] %s",
- $rest->error['code'], $rest->error['message']), __FILE__, __LINE__);
- return false;
- }
- elseif ($rest->body instanceof SimpleXMLElement && isset($rest->body->DistributionSummary))
- {
- $list = array();
- if (isset($rest->body->Marker, $rest->body->MaxItems, $rest->body->IsTruncated))
- {
- //$info['marker'] = (string)$rest->body->Marker;
- //$info['maxItems'] = (int)$rest->body->MaxItems;
- //$info['isTruncated'] = (string)$rest->body->IsTruncated == 'true' ? true : false;
- }
- foreach ($rest->body->DistributionSummary as $summary)
- $list[(string)$summary->Id] = self::__parseCloudFrontDistributionConfig($summary);
- return $list;
- }
- return array();
- }
- /**
- * List CloudFront Origin Access Identities
- *
- * @return array
- */
- public static function listOriginAccessIdentities()
- {
- if (!extension_loaded('openssl'))
- {
- self::__triggerError(sprintf("S3::listOriginAccessIdentities(): [%s] %s",
- "CloudFront functionality requires SSL"), __FILE__, __LINE__);
- return false;
- }
- self::$useSSL = true; // CloudFront requires SSL
- $rest = new S3Request('GET', '', '2010-11-01/origin-access-identity/cloudfront', 'cloudfront.amazonaws.com');
- $rest = self::__getCloudFrontResponse($rest);
- $useSSL = self::$useSSL;
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- trigger_error(sprintf("S3::listOriginAccessIdentities(): [%s] %s",
- $rest->error['code'], $rest->error['message']), E_USER_WARNING);
- return false;
- }
- if (isset($rest->body->CloudFrontOriginAccessIdentitySummary))
- {
- $identities = array();
- foreach ($rest->body->CloudFrontOriginAccessIdentitySummary as $identity)
- if (isset($identity->S3CanonicalUserId))
- $identities[(string)$identity->Id] = array('id' => (string)$identity->Id, 's3CanonicalUserId' => (string)$identity->S3CanonicalUserId);
- return $identities;
- }
- return false;
- }
- /**
- * Invalidate objects in a CloudFront distribution
- *
- * Thanks to Martin Lindkvist for S3::invalidateDistribution()
- *
- * @param string $distributionId Distribution ID from listDistributions()
- * @param array $paths Array of object paths to invalidate
- * @return boolean
- */
- public static function invalidateDistribution($distributionId, $paths)
- {
- if (!extension_loaded('openssl'))
- {
- self::__triggerError(sprintf("S3::invalidateDistribution(): [%s] %s",
- "CloudFront functionality requires SSL"), __FILE__, __LINE__);
- return false;
- }
- $useSSL = self::$useSSL;
- self::$useSSL = true; // CloudFront requires SSL
- $rest = new S3Request('POST', '', '2010-08-01/distribution/'.$distributionId.'/invalidation', 'cloudfront.amazonaws.com');
- $rest->data = self::__getCloudFrontInvalidationBatchXML($paths, (string)microtime(true));
- $rest->size = strlen($rest->data);
- $rest = self::__getCloudFrontResponse($rest);
- self::$useSSL = $useSSL;
- if ($rest->error === false && $rest->code !== 201)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- trigger_error(sprintf("S3::invalidate('{$distributionId}',{$paths}): [%s] %s",
- $rest->error['code'], $rest->error['message']), E_USER_WARNING);
- return false;
- }
- return true;
- }
- /**
- * Get a InvalidationBatch DOMDocument
- *
- * @internal Used to create XML in invalidateDistribution()
- * @param array $paths Paths to objects to invalidateDistribution
- * @param int $callerReference
- * @return string
- */
- private static function __getCloudFrontInvalidationBatchXML($paths, $callerReference = '0')
- {
- $dom = new DOMDocument('1.0', 'UTF-8');
- $dom->formatOutput = true;
- $invalidationBatch = $dom->createElement('InvalidationBatch');
- foreach ($paths as $path)
- $invalidationBatch->appendChild($dom->createElement('Path', $path));
- $invalidationBatch->appendChild($dom->createElement('CallerReference', $callerReference));
- $dom->appendChild($invalidationBatch);
- return $dom->saveXML();
- }
- /**
- * List your invalidation batches for invalidateDistribution() in a CloudFront distribution
- *
- * http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/ListInvalidation.html
- * returned array looks like this:
- * Array
- * (
- * [I31TWB0CN9V6XD] => InProgress
- * [IT3TFE31M0IHZ] => Completed
- * [I12HK7MPO1UQDA] => Completed
- * [I1IA7R6JKTC3L2] => Completed
- * )
- *
- * @param string $distributionId Distribution ID from listDistributions()
- * @return array
- */
- public static function getDistributionInvalidationList($distributionId)
- {
- if (!extension_loaded('openssl'))
- {
- self::__triggerError(sprintf("S3::getDistributionInvalidationList(): [%s] %s",
- "CloudFront functionality requires SSL"), __FILE__, __LINE__);
- return false;
- }
- $useSSL = self::$useSSL;
- self::$useSSL = true; // CloudFront requires SSL
- $rest = new S3Request('GET', '', '2010-11-01/distribution/'.$distributionId.'/invalidation', 'cloudfront.amazonaws.com');
- $rest = self::__getCloudFrontResponse($rest);
- self::$useSSL = $useSSL;
- if ($rest->error === false && $rest->code !== 200)
- $rest->error = array('code' => $rest->code, 'message' => 'Unexpected HTTP status');
- if ($rest->error !== false)
- {
- trigger_error(sprintf("S3::getDistributionInvalidationList('{$distributionId}'): [%s]",
- $rest->error['code'], $rest->error['message']), E_USER_WARNING);
- return false;
- }
- elseif ($rest->body instanceof SimpleXMLElement && isset($rest->body->InvalidationSummary))
- {
- $list = array();
- foreach ($rest->body->InvalidationSummary as $summary)
- $list[(string)$summary->Id] = (string)$summary->Status;
- return $list;
- }
- return array();
- }
- /**
- * Get a DistributionConfig DOMDocument
- *
- * http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/index.html?PutConfig.html
- *
- * @internal Used to create XML in createDistribution() and updateDistribution()
- * @param string $bucket S3 Origin bucket
- * @param boolean $enabled Enabled (true/false)
- * @param string $comment Comment to append
- * @param string $callerReference Caller reference
- * @param array $cnames Array of CNAME aliases
- * @param string $defaultRootObject Default root object
- * @param string $originAccessIdentity Origin access identity
- * @param array $trustedSigners Array of trusted signers
- * @return string
- */
- private static function __getCloudFrontDistributionConfigXML($bucket, $enabled, $comment, $callerReference = '0', $cnames = array(), $defaultRootObject = null, $originAccessIdentity = null, $trustedSigners = array())
- {
- $dom = new DOMDocument('1.0', 'UTF-8');
- $dom->formatOutput = true;
- $distributionConfig = $dom->createElement('DistributionConfig');
- $distributionConfig->setAttribute('xmlns', 'http://cloudfront.amazonaws.com/doc/2010-11-01/');
- $origin = $dom->createElement('S3Origin');
- $origin->appendChild($dom->createElement('DNSName', $bucket));
- if ($originAccessIdentity !== null) $origin->appendChild($dom->createElement('OriginAccessIdentity', $originAccessIdentity));
- $distributionConfig->appendChild($origin);
- if ($defaultRootObject !== null) $distributionConfig->appendChild($dom->createElement('DefaultRootObject', $defaultRootObject));
- $distributionConfig->appendChild($dom->createElement('CallerReference', $callerReference));
- foreach ($cnames as $cname)
- $distributionConfig->appendChild($dom->createElement('CNAME', $cname));
- if ($comment !== '') $distributionConfig->appendChild($dom->createElement('Comment', $comment));
- $distributionConfig->appendChild($dom->createElement('Enabled', $enabled ? 'true' : 'false'));
- $trusted = $dom->createElement('TrustedSigners');
- foreach ($trustedSigners as $id => $type)
- $trusted->appendChild($id !== '' ? $dom->createElement($type, $id) : $dom->createElement($type));
- $distributionConfig->appendChild($trusted);
- $dom->appendChild($distributionConfig);
- //var_dump($dom->saveXML());
- return $dom->saveXML();
- }
- /**
- * Parse a CloudFront distribution config
- *
- * See http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/index.html?GetDistribution.html
- *
- * @internal Used to parse the CloudFront DistributionConfig node to an array
- * @param object &$node DOMNode
- * @return array
- */
- private static function __parseCloudFrontDistributionConfig(&$node)
- {
- if (isset($node->DistributionConfig))
- return self::__parseCloudFrontDistributionConfig($node->DistributionConfig);
- $dist = array();
- if (isset($node->Id, $node->Status, $node->LastModifiedTime, $node->DomainName))
- {
- $dist['id'] = (string)$node->Id;
- $dist['status'] = (string)$node->Status;
- $dist['time'] = strtotime((string)$node->LastModifiedTime);
- $dist['domain'] = (string)$node->DomainName;
- }
- if (isset($node->CallerReference))
- $dist['callerReference'] = (string)$node->CallerReference;
- if (isset($node->Enabled))
- $dist['enabled'] = (string)$node->Enabled == 'true' ? true : false;
- if (isset($node->S3Origin))
- {
- if (isset($node->S3Origin->DNSName))
- $dist['origin'] = (string)$node->S3Origin->DNSName;
- $dist['originAccessIdentity'] = isset($node->S3Origin->OriginAccessIdentity) ?
- (string)$node->S3Origin->OriginAccessIdentity : null;
- }
- $dist['defaultRootObject'] = isset($node->DefaultRootObject) ? (string)$node->DefaultRootObject : null;
- $dist['cnames'] = array();
- if (isset($node->CNAME))
- foreach ($node->CNAME as $cname)
- $dist['cnames'][(string)$cname] = (string)$cname;
- $dist['trustedSigners'] = array();
- if (isset($node->TrustedSigners))
- foreach ($node->TrustedSigners as $signer)
- {
- if (isset($signer->Self))
- $dist['trustedSigners'][''] = 'Self';
- elseif (isset($signer->KeyPairId))
- $dist['trustedSigners'][(string)$signer->KeyPairId] = 'KeyPairId';
- elseif (isset($signer->AwsAccountNumber))
- $dist['trustedSigners'][(string)$signer->AwsAccountNumber] = 'AwsAccountNumber';
- }
- $dist['comment'] = isset($node->Comment) ? (string)$node->Comment : null;
- return $dist;
- }
- /**
- * Grab CloudFront response
- *
- * @internal Used to parse the CloudFront S3Request::getResponse() output
- * @param object &$rest S3Request instance
- * @return object
- */
- private static function __getCloudFrontResponse(&$rest)
- {
- $rest->getResponse();
- if ($rest->response->error === false && isset($rest->response->body) &&
- is_string($rest->response->body) && substr($rest->response->body, 0, 5) == '<?xml')
- {
- $rest->response->body = simplexml_load_string($rest->response->body);
- // Grab CloudFront errors
- if (isset($rest->response->body->Error, $rest->response->body->Error->Code,
- $rest->response->body->Error->Message))
- {
- $rest->response->error = array(
- 'code' => (string)$rest->response->body->Error->Code,
- 'message' => (string)$rest->response->body->Error->Message
- );
- unset($rest->response->body);
- }
- }
- return $rest->response;
- }
- /**
- * Get MIME type for file
- *
- * To override the putObject() Content-Type, add it to $requestHeaders
- *
- * To use fileinfo, ensure the MAGIC environment variable is set
- *
- * @internal Used to get mime types
- * @param string &$file File path
- * @return string
- */
- private static function __getMIMEType(&$file)
- {
- static $exts = array(
- 'jpg' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'gif' => 'image/gif',
- 'png' => 'image/png', 'ico' => 'image/x-icon', 'pdf' => 'application/pdf',
- 'tif' => 'image/tiff', 'tiff' => 'image/tiff', 'svg' => 'image/svg+xml',
- 'svgz' => 'image/svg+xml', 'swf' => 'application/x-shockwave-flash',
- 'zip' => 'application/zip', 'gz' => 'application/x-gzip',
- 'tar' => 'application/x-tar', 'bz' => 'application/x-bzip',
- 'bz2' => 'application/x-bzip2', 'rar' => 'application/x-rar-compressed',
- 'exe' => 'application/x-msdownload', 'msi' => 'application/x-msdownload',
- 'cab' => 'application/vnd.ms-cab-compressed', 'txt' => 'text/plain',
- 'asc' => 'text/plain', 'htm' => 'text/html', 'html' => 'text/html',
- 'css' => 'text/css', 'js' => 'text/javascript',
- 'xml' => 'text/xml', 'xsl' => 'application/xsl+xml',
- 'ogg' => 'application/ogg', 'mp3' => 'audio/mpeg', 'wav' => 'audio/x-wav',
- 'avi' => 'video/x-msvideo', 'mpg' => 'video/mpeg', 'mpeg' => 'video/mpeg',
- 'mov' => 'video/quicktime', 'flv' => 'video/x-flv', 'php' => 'text/x-php'
- );
- $ext = strtolower(pathinfo($file, PATHINFO_EXTENSION));
- if (isset($exts[$ext])) return $exts[$ext];
- // Use fileinfo if available
- if (extension_loaded('fileinfo') && isset($_ENV['MAGIC']) &&
- ($finfo = finfo_open(FILEINFO_MIME, $_ENV['MAGIC'])) !== false)
- {
- if (($type = finfo_file($finfo, $file)) !== false)
- {
- // Remove the charset and grab the last content-type
- $type = explode(' ', str_replace('; charset=', ';charset=', $type));
- $type = array_pop($type);
- $type = explode(';', $type);
- $type = trim(array_shift($type));
- }
- finfo_close($finfo);
- if ($type !== false && strlen($type) > 0) return $type;
- }
- return 'application/octet-stream';
- }
- /**
- * Get the current time
- *
- * @internal Used to apply offsets to sytem time
- * @return integer
- */
- public static function __getTime()
- {
- return time() + self::$__timeOffset;
- }
- /**
- * Generate the auth string: "AWS AccessKey:Signature"
- *
- * @internal Used by S3Request::getResponse()
- * @param string $string String to sign
- * @return string
- */
- public static function __getSignature($string)
- {
- return 'AWS '.self::$__accessKey.':'.self::__getHash($string);
- }
- /**
- * Creates a HMAC-SHA1 hash
- *
- * This uses the hash extension if loaded
- *
- * @internal Used by __getSignature()
- * @param string $string String to sign
- * @return string
- */
- private static function __getHash($string)
- {
- return base64_encode(extension_loaded('hash') ?
- hash_hmac('sha1', $string, self::$__secretKey, true) : pack('H*', sha1(
- (str_pad(self::$__secretKey, 64, chr(0x00)) ^ (str_repeat(chr(0x5c), 64))) .
- pack('H*', sha1((str_pad(self::$__secretKey, 64, chr(0x00)) ^
- (str_repeat(chr(0x36), 64))) . $string)))));
- }
- }
- /**
- * S3 Request class
- *
- * @link http://undesigned.org.za/2007/10/22/amazon-s3-php-class
- * @version 0.5.0-dev
- */
- final class S3Request
- {
- /**
- * AWS URI
- *
- * @var string
- * @access private
- */
- private $endpoint;
-
- /**
- * Verb
- *
- * @var string
- * @access private
- */
- private $verb;
-
- /**
- * S3 bucket name
- *
- * @var string
- * @access private
- */
- private $bucket;
-
- /**
- * Object URI
- *
- * @var string
- * @access private
- */
- private $uri;
-
- /**
- * Final object URI
- *
- * @var string
- * @access private
- */
- private $resource = '';
-
- /**
- * Additional request parameters
- *
- * @var array
- * @access private
- */
- private $parameters = array();
-
- /**
- * Amazon specific request headers
- *
- * @var array
- * @access private
- */
- private $amzHeaders = array();
- /**
- * HTTP request headers
- *
- * @var array
- * @access private
- */
- private $headers = array(
- 'Host' => '', 'Date' => '', 'Content-MD5' => '', 'Content-Type' => ''
- );
- /**
- * Use HTTP PUT?
- *
- * @var bool
- * @access public
- */
- public $fp = false;
- /**
- * PUT file size
- *
- * @var int
- * @access public
- */
- public $size = 0;
- /**
- * PUT post fields
- *
- * @var array
- * @access public
- */
- public $data = false;
- /**
- * S3 request respone
- *
- * @var object
- * @access public
- */
- public $response;
- /**
- * Constructor
- *
- * @param string $verb Verb
- * @param string $bucket Bucket name
- * @param string $uri Object URI
- * @param string $endpoint AWS endpoint URI
- * @return mixed
- */
- function __construct($verb, $bucket = '', $uri = '', $endpoint = 's3.amazonaws.com')
- {
-
- $this->endpoint = $endpoint;
- $this->verb = $verb;
- $this->bucket = $bucket;
- $this->uri = $uri !== '' ? '/'.str_replace('%2F', '/', rawurlencode($uri)) : '/';
- //if ($this->bucket !== '')
- // $this->resource = '/'.$this->bucket.$this->uri;
- //else
- // $this->resource = $this->uri;
- if ($this->bucket !== '')
- {
- if ($this->__dnsBucketName($this->bucket))
- {
- $this->headers['Host'] = $this->bucket.'.'.$this->endpoint;
- $this->resource = '/'.$this->bucket.$this->uri;
- }
- else
- {
- $this->headers['Host'] = $this->endpoint;
- $this->uri = $this->uri;
- if ($this->bucket !== '') $this->uri = '/'.$this->bucket.$this->uri;
- $this->bucket = '';
- $this->resource = $this->uri;
- }
- }
- else
- {
- $this->headers['Host'] = $this->endpoint;
- $this->resource = $this->uri;
- }
- $this->headers['Date'] = gmdate('D, d M Y H:i:s T');
- $this->response = new STDClass;
- $this->response->error = false;
- $this->response->body = null;
- $this->response->headers = array();
- }
- /**
- * Set request parameter
- *
- * @param string $key Key
- * @param string $value Value
- * @return void
- */
- public function setParameter($key, $value)
- {
- $this->parameters[$key] = $value;
- }
- /**
- * Set request header
- *
- * @param string $key Key
- * @param string $value Value
- * @return void
- */
- public function setHeader($key, $value)
- {
- $this->headers[$key] = $value;
- }
- /**
- * Set x-amz-meta-* header
- *
- * @param string $key Key
- * @param string $value Value
- * @return void
- */
- public function setAmzHeader($key, $value)
- {
- $this->amzHeaders[$key] = $value;
- }
- /**
- * Get the S3 response
- *
- * @return object | false
- */
- public function getResponse()
- {
- $query = '';
- if (sizeof($this->parameters) > 0)
- {
- $query = substr($this->uri, -1) !== '?' ? '?' : '&';
- foreach ($this->parameters as $var => $value)
- if ($value == null || $value == '') $query .= $var.'&';
- else $query .= $var.'='.rawurlencode($value).'&';
- $query = substr($query, 0, -1);
- $this->uri .= $query;
- if (array_key_exists('acl', $this->parameters) ||
- array_key_exists('location', $this->parameters) ||
- array_key_exists('torrent', $this->parameters) ||
- array_key_exists('website', $this->parameters) ||
- array_key_exists('logging', $this->parameters))
- $this->resource .= $query;
- }
- $url = (S3::$useSSL ? 'https://' : 'http://') . ($this->headers['Host'] !== '' ? $this->headers['Host'] : $this->endpoint) . $this->uri;
- //var_dump('bucket: ' . $this->bucket, 'uri: ' . $this->uri, 'resource: ' . $this->resource, 'url: ' . $url);
- // Basic setup
- $curl = curl_init();
- curl_setopt($curl, CURLOPT_USERAGENT, 'S3/php');
- if (S3::$useSSL)
- {
- // Set protocol version
- curl_setopt($curl, CURLOPT_SSLVERSION, S3::$useSSLVersion);
- // SSL Validation can now be optional for those with broken OpenSSL installations
- curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, S3::$useSSLValidation ? 2 : 0);
- curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, S3::$useSSLValidation ? 1 : 0);
- if (S3::$sslKey !== null) curl_setopt($curl, CURLOPT_SSLKEY, S3::$sslKey);
- if (S3::$sslCert !== null) curl_setopt($curl, CURLOPT_SSLCERT, S3::$sslCert);
- if (S3::$sslCACert !== null) curl_setopt($curl, CURLOPT_CAINFO, S3::$sslCACert);
- }
- curl_setopt($curl, CURLOPT_URL, $url);
- if (S3::$proxy != null && isset(S3::$proxy['host']))
- {
- curl_setopt($curl, CURLOPT_PROXY, S3::$proxy['host']);
- curl_setopt($curl, CURLOPT_PROXYTYPE, S3::$proxy['type']);
- if (isset(S3::$proxy['user'], S3::$proxy['pass']) && S3::$proxy['user'] != null && S3::$proxy['pass'] != null)
- curl_setopt($curl, CURLOPT_PROXYUSERPWD, sprintf('%s:%s', S3::$proxy['user'], S3::$proxy['pass']));
- }
- // Headers
- $headers = array(); $amz = array();
- foreach ($this->amzHeaders as $header => $value)
- if (strlen($value) > 0) $headers[] = $header.': '.$value;
- foreach ($this->headers as $header => $value)
- if (strlen($value) > 0) $headers[] = $header.': '.$value;
- // Collect AMZ headers for signature
- foreach ($this->amzHeaders as $header => $value)
- if (strlen($value) > 0) $amz[] = strtolower($header).':'.$value;
- // AMZ headers must be sorted
- if (sizeof($amz) > 0)
- {
- //sort($amz);
- usort($amz, array(&$this, '__sortMetaHeadersCmp'));
- $amz = "\n".implode("\n", $amz);
- } else $amz = '';
- if (S3::hasAuth())
- {
- // Authorization string (CloudFront stringToSign should only contain a date)
- if ($this->headers['Host'] == 'cloudfront.amazonaws.com')
- $headers[] = 'Authorization: ' . S3::__getSignature($this->headers['Date']);
- else
- {
- $headers[] = 'Authorization: ' . S3::__getSignature(
- $this->verb."\n".
- $this->headers['Content-MD5']."\n".
- $this->headers['Content-Type']."\n".
- $this->headers['Date'].$amz."\n".
- $this->resource
- );
- }
- }
- curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
- curl_setopt($curl, CURLOPT_HEADER, false);
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, false);
- curl_setopt($curl, CURLOPT_WRITEFUNCTION, array(&$this, '__responseWriteCallback'));
- curl_setopt($curl, CURLOPT_HEADERFUNCTION, array(&$this, '__responseHeaderCallback'));
- curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
- // Request types
- switch ($this->verb)
- {
- case 'GET': break;
- case 'PUT': case 'POST': // POST only used for CloudFront
- if ($this->fp !== false)
- {
- curl_setopt($curl, CURLOPT_PUT, true);
- curl_setopt($curl, CURLOPT_INFILE, $this->fp);
- if ($this->size >= 0)
- curl_setopt($curl, CURLOPT_INFILESIZE, $this->size);
- }
- elseif ($this->data !== false)
- {
- curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $this->verb);
- curl_setopt($curl, CURLOPT_POSTFIELDS, $this->data);
- }
- else
- curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $this->verb);
- break;
- case 'HEAD':
- curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'HEAD');
- curl_setopt($curl, CURLOPT_NOBODY, true);
- break;
- case 'DELETE':
- curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
- break;
- default: break;
- }
- // Execute, grab errors
- if (curl_exec($curl))
- $this->response->code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
- else
- $this->response->error = array(
- 'code' => curl_errno($curl),
- 'message' => curl_error($curl),
- 'resource' => $this->resource
- );
- @curl_close($curl);
- // Parse body into XML
- if ($this->response->error === false && isset($this->response->headers['type']) &&
- $this->response->headers['type'] == 'application/xml' && isset($this->response->body))
- {
- $this->response->body = simplexml_load_string($this->response->body);
- // Grab S3 errors
- if (!in_array($this->response->code, array(200, 204, 206)) &&
- isset($this->response->body->Code, $this->response->body->Message))
- {
- $this->response->error = array(
- 'code' => (string)$this->response->body->Code,
- 'message' => (string)$this->response->body->Message
- );
- if (isset($this->response->body->Resource))
- $this->response->error['resource'] = (string)$this->response->body->Resource;
- unset($this->response->body);
- }
- }
- // Clean up file resources
- if ($this->fp !== false && is_resource($this->fp)) fclose($this->fp);
- return $this->response;
- }
- /**
- * Sort compare for meta headers
- *
- * @internal Used to sort x-amz meta headers
- * @param string $a String A
- * @param string $b String B
- * @return integer
- */
- private function __sortMetaHeadersCmp($a, $b)
- {
- $lenA = strpos($a, ':');
- $lenB = strpos($b, ':');
- $minLen = min($lenA, $lenB);
- $ncmp = strncmp($a, $b, $minLen);
- if ($lenA == $lenB) return $ncmp;
- if (0 == $ncmp) return $lenA < $lenB ? -1 : 1;
- return $ncmp;
- }
- /**
- * CURL write callback
- *
- * @param resource &$curl CURL resource
- * @param string &$data Data
- * @return integer
- */
- private function __responseWriteCallback(&$curl, &$data)
- {
- if (in_array($this->response->code, array(200, 206)) && $this->fp !== false)
- return fwrite($this->fp, $data);
- else
- $this->response->body .= $data;
- return strlen($data);
- }
- /**
- * Check DNS conformity
- *
- * @param string $bucket Bucket name
- * @return boolean
- */
- private function __dnsBucketName($bucket)
- {
- if (strlen($bucket) > 63 || preg_match("/[^a-z0-9\.-]/", $bucket) > 0) return false;
- if (S3::$useSSL && strstr($bucket, '.') !== false) return false;
- if (strstr($bucket, '-.') !== false) return false;
- if (strstr($bucket, '..') !== false) return false;
- if (!preg_match("/^[0-9a-z]/", $bucket)) return false;
- if (!preg_match("/[0-9a-z]$/", $bucket)) return false;
- return true;
- }
- /**
- * CURL header callback
- *
- * @param resource $curl CURL resource
- * @param string $data Data
- * @return integer
- */
- private function __responseHeaderCallback($curl, $data)
- {
- if (($strlen = strlen($data)) <= 2) return $strlen;
- if (substr($data, 0, 4) == 'HTTP')
- $this->response->code = (int)substr($data, 9, 3);
- else
- {
- $data = trim($data);
- if (strpos($data, ': ') === false) return $strlen;
- list($header, $value) = explode(': ', $data, 2);
- if ($header == 'Last-Modified')
- $this->response->headers['time'] = strtotime($value);
- elseif ($header == 'Date')
- $this->response->headers['date'] = strtotime($value);
- elseif ($header == 'Content-Length')
- $this->response->headers['size'] = (int)$value;
- elseif ($header == 'Content-Type')
- $this->response->headers['type'] = $value;
- elseif ($header == 'ETag')
- $this->response->headers['hash'] = $value[0] == '"' ? substr($value, 1, -1) : $value;
- elseif (preg_match('/^x-amz-meta-.*$/', $header))
- $this->response->headers[$header] = $value;
- }
- return $strlen;
- }
- }
- /**
- * S3 exception class
- *
- * @link http://undesigned.org.za/2007/10/22/amazon-s3-php-class
- * @version 0.5.0-dev
- */
- class S3Exception extends Exception {
- /**
- * Class constructor
- *
- * @param string $message Exception message
- * @param string $file File in which exception was created
- * @param string $line Line number on which exception was created
- * @param int $code Exception code
- */
- function __construct($message, $file, $line, $code = 0)
- {
- parent::__construct($message, $code);
- $this->file = $file;
- $this->line = $line;
- }
- }
|