Riiak.php

<?php

namespace riiak;

use \CApplicationComponent,
    \CJSON,
    \Yii;

/**
 * The Riiak object holds information necessary to connect to
 * Riak. The Riak API uses HTTP, so there is no persistent
 * connection, and the Riiak object is extremely lightweight.
 * @package riiak
 *
 * @property-read bool $isAlive
 * @property-read bool $isMultiBackendSupport
 * @property-read bool $isSecondaryIndexSupport
 * @property-read array $configuration Riak server configuration
 * @property-read \riiak\Transport $transport Riiak Transport layer
 * @property-read \riiak\MapReduce $mapReduce Map/Reduce object
 */
class Riiak extends CApplicationComponent {

    /**
     * Hostname or IP address
     *
     * @var string Default: '127.0.0.1'
     */
    public $host = '127.0.0.1';

    /**
     * Port number
     *
     * @var int Default: 8098
     */
    public $port = 8098;

    /**
     * Whether SSL is enabled
     *
     * @var bool Default: false
     */
    public $ssl = false;

    /**
     * Interface prefix
     *
     * @var string Default: 'riak'
     */
    public $prefix = 'riak';

    /**
     * Riak key stream url prefix
     *
     * @var string Default: 'buckets'
     */
    public $bucketPrefix = 'buckets';

    /**
     * Riak key for secondary indexes implementation
     *
     * @var string Default: 'index'
     */
    public $indexPrefix = 'index';

    /**
     * Riak key stream prefix
     *
     * @var string
     */
    public $keyPrefix = 'keys';

    /**
     * MapReduce prefix
     *
     * @var string Default: 'mapred'
     */
    public $mapredPrefix = 'mapred';
    public $pingPrefix = 'ping';
    public $statsPrefix = 'stats';

    /**
     * The clientID for this Riak client instance.
     * Only specify if you know what you're doing.
     *
     * @var string
     */
    public $clientId;

    /**
     * R-Value setting for client.
     * Used by other Riiak class components as fallback value.
     *
     * @var int Default: 2
     */
    public $r = 2;

    /**
     * W-Value setting for client.
     * Used by other Riiak class components as fallback value.
     *
     * @var int Default: 2
     */
    public $w = 2;

    /**
     * DW-Value setting for client.
     * Used by other Riiak class components as fallback value.
     *
     * @var int Default: 2
     */
    public $dw = 2;

    /**
     * When enabled, profiles requests using Yii::beginProfile && Yii::endProfile
     *
     * @var bool
     */
    public $enableProfiling = false;

    /**
     * @var \riiak\MapReduce
     */
    protected $_mr;

    /**
     * Riak configuration details
     *
     * @var array
     */
    protected $_config;

    /**
     * Transport layer object
     *
     * @var \riiak\Transport
     */
    protected $_transport;

    /**
     * Define transport layer protocol
     *
     * @var string Default: http
     */
    public $protocol = 'HTTP';

    /**
     * Define transport layer processing method.
     *
     * @var string Default: Curl
     */
    public $protocolMethod = 'CURL';

    /**
     * Initialise Riiak
     */
    public function init() {
        parent::init();
        /**
         * Default the value of clientId if not already specified
         */
        if (empty($this->clientId))
            $this->clientId = 'php_' . base64_encode(rand(1, 1073741824));
    }

    /**
     * Get bucket by name
     *
     * @param string $name
     * @return \riiak\Bucket
     */
    public function bucket($name) {
        return new Bucket($this, $name);
    }

    /**
     * Return array of Bucket objects
     *
     * @return array
     */
    public function buckets() {
        Yii::log('Bucket listing is a very intensive operation, and should never occur in production!', \CLogger::LEVEL_WARNING);
        Yii::trace('Fetching list of buckets', 'ext.riiak.Riiak');
        return array_map(array($this, 'bucket'), $this->transport->listBuckets());
    }

    /**
     * Check if Riak server is alive
     *
     * @return bool
     */
    public function getIsAlive() {
        Yii::trace('Pinging Riak server', 'ext.riiak.Riiak');
        return $this->transport->getIsAlive();
    }

    /**
     * Returns the Transport instance (created if not exists)
     *
     * @return \riiak\Transport
     */
    public function getTransport() {
        if (!($this->_transport instanceof Transport)) {
            switch ($this->protocol) {
                default:
                case 'HTTP':
                    /**
                     * Get processing method object for HTTP protocol.
                     */
                    switch ($this->protocolMethod) {
                        default:
                        case 'CURL':
                            $this->_transport = new \riiak\transport\http\Curl($this);
                            break;
                        case 'FOPEN':
                            break;
                        case 'PHPSTREAM':
                            break;
                    }
                    break;
                case 'PBC':
                    /**
                     * Protocol Buffer Transport layer class object.
                     */
                    break;
            }
        }
        return $this->_transport;
    }

    /**
     * Returns riak server configuration
     *
     * @return array
     */
    public function getConfiguration() {
        if (!is_array($this->_config))
            $this->_config = $this->getTransport()->getRiakConfiguration();
        return $this->_config;
    }

    /**
     * Returns the MapReduce instance (created if not exists)
     *
     * @param bool $reset Whether to create a new MapReduce instance
     * @return \riiak\MapReduce
     */
    public function getMapReduce($reset = false) {
        if ($reset || !($this->_mr instanceof MapReduce))
            $this->_mr = new MapReduce($this);
        return $this->_mr;
    }

    /**
     * Check whether riak supports multi-backend or not.
     *
     * @todo Find better solution for this
     *
     * @return bool
     */
    public function getIsMultiBackendSupport() {
        Yii::trace('Checking multi-backend support', 'ext.riiak.Riiak');
        return $this->transport->getIsMultiBackendSupport();
    }

    /**
     * Check whether riak supports secondary index or not.
     *
     * @todo Find better solution for this
     *
     * @return bool
     */
    public function getIsSecondaryIndexSupport() {
        Yii::trace('Checking Secondary Index support', 'ext.riiak.Riiak');
        return $this->transport->getIsSecondaryIndexSupport();
    }

}