Current File : //opt/alt/php55/usr/share/pear/Object/Freezer/Storage/CouchDB.php
<?php
/**
* Object_Freezer
*
* Copyright (c) 2008-2011, Sebastian Bergmann <sb@sebastian-bergmann.de>.
* 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.
*
* * Neither the name of Sebastian Bergmann nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* 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.
*
* @package Object_Freezer
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @copyright 2008-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @since File available since Release 1.0.0
*/
require_once 'Object/Freezer/Storage.php';
/**
* Object storage that uses Apache CouchDB as its backend.
*
* @package Object_Freezer
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @copyright 2008-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.0.0
* @link http://github.com/sebastianbergmann/php-object-freezer/
* @since Class available since Release 1.0.0
*/
class Object_Freezer_Storage_CouchDB extends Object_Freezer_Storage
{
/**
* @var string
*/
protected $database;
/**
* @var string
*/
protected $host;
/**
* @var int
*/
protected $port;
/**
* @var array
*/
protected $revisions = array();
/**
* @var boolean
*/
protected $debug = FALSE;
/**
* Constructor.
*
* @param string $database
* Name of the database to be used
* @param Object_Freezer $freezer
* Object_Freezer instance to be used
* @param Object_Freezer_Cache $cache
* Object_Freezer_Cache instance to be used
* @param boolean $useLazyLoad
* Flag that controls whether objects are
* fetched using lazy load or not
* @param string $host
* Hostname of the CouchDB instance to be used
* @param int $port
* Port of the CouchDB instance to be used
* @throws InvalidArgumentException
*/
public function __construct($database, Object_Freezer $freezer = NULL, Object_Freezer_Cache $cache = NULL, $useLazyLoad = FALSE, $host = 'localhost', $port = 5984)
{
parent::__construct($freezer, $cache, $useLazyLoad);
// Bail out if a non-string was passed.
if (!is_string($database)) {
throw Object_Freezer_Util::getInvalidArgumentException(1, 'string');
}
// Bail out if a non-string was passed.
if (!is_string($host)) {
throw Object_Freezer_Util::getInvalidArgumentException(4, 'string');
}
// Bail out if a non-integer was passed.
if (!is_int($port)) {
throw Object_Freezer_Util::getInvalidArgumentException(
5, 'integer'
);
}
$this->database = $database;
$this->host = $host;
$this->port = $port;
}
/**
* Freezes an object and stores it in the object storage.
*
* @param array $frozenObject
*/
protected function doStore(array $frozenObject)
{
$payload = array('docs' => array());
foreach ($frozenObject['objects'] as $id => $object) {
if ($object['isDirty'] !== FALSE) {
$revision = NULL;
if (isset($this->revisions[$id])) {
$revision = $this->revisions[$id];
}
$data = array(
'_id' => $id,
'_rev' => $revision,
'class' => $object['className'],
'state' => $object['state']
);
if (!$data['_rev']) {
unset($data['_rev']);
}
$payload['docs'][] = $data;
}
}
if (!empty($payload['docs'])) {
$response = $this->send(
'POST',
'/' . $this->database . '/_bulk_docs',
json_encode($payload)
);
if (strpos($response['headers'], 'HTTP/1.1 201 Created') !== 0) {
// @codeCoverageIgnoreStart
throw new RuntimeException('Could not save objects.');
// @codeCoverageIgnoreEnd
}
$data = json_decode($response['body'], TRUE);
foreach ($data as $state) {
if (isset($state['error'])) {
// @codeCoverageIgnoreStart
throw new RuntimeException(
sprintf(
'Could not save object "%s": %s - %s',
$state['id'],
$state['error'],
$state['reason']
)
);
// @codeCoverageIgnoreEnd
} else {
$this->revisions[$state['id']] = $state['rev'];
}
}
}
}
/**
* Fetches a frozen object from the object storage and thaws it.
*
* @param string $id The ID of the object that is to be fetched.
* @param array $objects Only used internally.
* @return object
* @throws InvalidArgumentException
* @throws RuntimeException
*/
protected function doFetch($id, array &$objects = array())
{
$isRoot = empty($objects);
if (!isset($objects[$id])) {
$response = $this->send(
'GET', '/' . $this->database . '/' . urlencode($id)
);
if (strpos($response['headers'], 'HTTP/1.1 200 OK') !== 0) {
throw new RuntimeException(
sprintf('Object with id "%s" could not be fetched.', $id)
);
}
$object = json_decode($response['body'], TRUE);
$this->revisions[$object['_id']] = $object['_rev'];
$objects[$id] = array(
'className' => $object['class'],
'isDirty' => FALSE,
'state' => $object['state']
);
if (!$this->lazyLoad) {
$this->fetchArray($object['state'], $objects);
}
}
if ($isRoot) {
return array('root' => $id, 'objects' => $objects);
}
}
/**
* Sends an HTTP request to the CouchDB server.
*
* @param string $method
* @param string $url
* @param string $payload
* @return array
* @throws RuntimeException
*/
public function send($method, $url, $payload = NULL)
{
$socket = @fsockopen($this->host, $this->port, $errno, $errstr);
if (!$socket) {
throw new RuntimeException($errno . ': ' . $errstr);
}
$request = sprintf(
"%s %s HTTP/1.1\r\nHost: %s:%d\r\nContent-Type: application/json\r\nConnection: close\r\n",
$method,
$url,
$this->host,
$this->port
);
if ($payload !== NULL) {
$request .= 'Content-Length: ' . strlen($payload) . "\r\n\r\n" .
$payload;
}
$request .= "\r\n";
// @codeCoverageIgnoreStart
if ($this->debug) {
print $request;
}
// @codeCoverageIgnoreEnd
fwrite($socket, $request);
$buffer = '';
while (!feof($socket)) {
$buffer .= fgets($socket);
}
list($headers, $body) = explode("\r\n\r\n", $buffer);
return array('headers' => $headers, 'body' => $body);
}
/**
* Sets the flag that controls whether or not debug messages are printed.
*
* @param boolean $flag
* @throws InvalidArgumentException
*/
public function setDebug($flag)
{
// Bail out if a non-boolean was passed.
if (!is_bool($flag)) {
throw Object_Freezer_Util::getInvalidArgumentException(
1, 'boolean'
);
}
$this->debug = $flag;
}
}
Mini Shell