CouchDBConnector.php

<?php  

/*******************************************************************************************

Copyright 2011 Randy Melder. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:

   1. Redistributions of source code must retain the above copyright notice, this list of
      conditions and the following disclaimer.

   2. 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 Randy Melder ''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 Randy Melder 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.

The views and conclusions contained in the software and documentation are those of the
authors and should not be interpreted as representing official policies, either expressed
or implied, of Randy Melder.

*******************************************************************************************/

/**
 *  Utilize CouchDB's RESTful interface from PHP.
 *
 * @author  randymelder@gmail.com
 * @since   2011
 * @version 1.0
 * @license 
 *
 */

class CouchDBConnector
{
    private $host;
    private $port; 
    private $user;
    private $pass;
    private $db;
    private $sock;
    private $view;
    
    const DEBUG_ON = 0;
    
	/**
	 * Implementation is easy. Here's an example
	 * $relax = new CouchDBConnector(array('host'=>'my.host.name','port'=>5984));
	 * 
	 */
    public function __construct ($params)
    {
        $this->setHost($params['host']);
        $this->setPort($params['port']);
    }
    
    /**
     * Takes you literally.
     */
    public function setDb($dbname = NULL)
    {
        $this->db = $dbname;
    }
    
    public function setHost($h = NULL)
    {
        $this->host = $h;
    }
    
    public function setPort($p = NULL)
    {
        $this->port = $p;
    }
    
    public function setUser($u = NULL)
    {
        $this->user = $u;
    }
    
    public function setPass($p = NULL)
    {
        $this->pass = $p;
    }
    
    public function setView($v = NULL)
    {
        $this->view = $v;
    }
    /**
     * getNamedSubView() is probably 99% of everything you'll ever need. 
     * Returns a JSON string.
     * @param String $db
     * @param String $view
     * @param String $namedsubview
     * @param Array $arrParams
     * @return String 
     */
    public function getNamedSubView($db, $view, $namedsubview, $arrParams)
    {
        $args = '';
        if (is_array($arrParams))
        {
            foreach ($arrParams AS $key=>$val)
            {
                $args .= $key.'='.$val.'&';
            }
        }
        $url = '/'.$db.'/_design/'.$view.'/_view/'.$namedsubview.'?'.$args;
        
        return $this->stripHeadersToJSON($this->get($url));
    }
    
    
    /**
     * Make a new database/bucket named $data
     * @param String $data
     * @return type 
     */
    public function put($data = NULL)
    {
        if (NULL == $data) return -1;
        return $this->execute('PUT', '/'.$data);
    }
    
    /**
     * $url is anything you want.
     * @param String $url
     * @return String 
     */
    public function get($url = NULL)
    {
        if (NULL == $url) return -1;
        return $this->execute('GET', $url);
    }
    
    public function getUUID()
    {
        return $this->execute('GET', '/_uuids');
    }
    
    /**
     * Added a document to the current $this->db. 
     * Parameter: $data needs to be formatted JSON.
     * @param String $data
     * @return mixed 
     */
    public function post($data = NULL)
    {
        if (NULL == $data) return -1;
        return $this->execute('POST', '/'.$this->db, $data);
    }
    
    /**
     * Just asking to be overloaded
     * @param String $data
     * @return mixed
     */
    public function delete($data = NULL)
    {
        if (NULL == $data) return -1;
    }
    
    /**
     * 
     * @param String $method
     * @param String $url
     * @param String $data
     * @return String 
     */
    private function execute($method = 'GET', $url = '/', $data = NULL)
    {
        if(!$this->host || !$this->port)
        {
            throw new Exception ( 'NULL host in: '.__CLASS__.'::'.__FUNCTION__.' for URL: '.$url );
            return NULL;
        }
        $req = "{$method} {$url} HTTP/1.0\r\nHost: {$this->host}\r\n";
		
        if($this->user || $this->pass)
            $req    .= 'Authorization: Basic '
                    .base64_encode($this->username.':'.$this->password)."\r\n";

        if($data) {
            $req    .= 'Content-Length: '.strlen($data)."\r\n";
            $req    .= 'Content-Type: application/json'."\r\n\r\n";
            $req    .= $data."\r\n";
        } else {
            $req    .= "\r\n";
        }
        //open socket
        $err_num    = ''; $err_string = '';
        $this->sock = @fsockopen($this->host, $this->port, $err_num, $err_string);
        if(!$this->sock)            
            throw new Exception("fsockopen() failed."
                    .__CLASS__.__FUNCTION__.__LINE__
                    .' Error Num:'.$err_num.' Err String:'.$err_string);
        
        //write data
        fwrite($this->sock, $req);
        $response   = '';
        while(!feof($this->sock)) {
            $response .= fgets($this->sock);
        }
        
        //close socket
        fclose($this->sock);
        $this->sock = NULL;
        
        return $response;
    }
    
    /**
     * Takes a socket respons and strips down to JSON
     * @param String $data
     * @return String
     */
    public function stripHeadersToJSON($data)
    {
        $len    = strlen($data);
        $json   = '';
        for ($i = 0; $i < $len; ++$i)
        {
            if($data[$i] == '{')
            {
                $json = substr($data, $i);
                break;
            }
        }
        
        return strtr($json, "\r\n", "  ");
    }
    
    /**
     * Ask CouchDB for a uuid
     * @return String
     */
    public function getStringOfUUID()
    {
        $arr = json_decode($this->stripHeadersToJSON($this->getUUID()));
        
        return $arr->uuids[0];
    }
    
    public function getDocumentByID($id = NULL)
    {
        if (!is_string($id))
            throw new Exception("Invalid document id:".$id);
        
        return $this->get('/'.$this->db.'/'.$id);
    }
    
    public function jqplotNotationFromJSON($json)
    {
        $str = '';
        $arr = json_decode($json);
        if (trim($json) == '{"rows":[]}')
            return "[['NULL', 0]]";
        
        foreach($arr AS $top)
        {
            foreach($top AS $c)
            {
                $str .= "['".$c->key."',".$c->value."],";
            }
        }
        $str = substr($str, 0, strlen($str) - 1);
        return '[ '.$str.' ]';
    }
}