File models/business/rest_client_model.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

<?php
/*-----8<--------------------------------------------------------------------
 * 
 * BEdita - a semantic content management framework
 * 
 * Copyright 2008-2013 ChannelWeb Srl, Chialab Srl
 * 
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published 
 * by the Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License 
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 * 
 *------------------------------------------------------------------->8-----
 */

/**
 * REST client model
 * uses internally "curl" or cake HttpSocket if "curl" module not available
 */
class RestClientModel extends BEAppModel {
    
    public $useTable = false;
    
    public $httpReady = false;
    public $client;
    public $useCurl = false;
    public $callHeaders = array();
    public $lastStatusCode = null;

    /**
     * options used when a request (get/post) is done
     * @var array
     */
    protected $requestOptions = array();
    
    /**
     * setup rest client
     * if curl available setup RestClientModel to use it
     * else setup RestClientModel to use CakePHP HttpSocket class
     */
    public function setup() {
        if (!$this->httpReady) {    
            
            if (function_exists("curl_init")) {
                $this->client = curl_init();
                $setupCurlOptions = array(
                    CURLOPT_HEADER => false,
                    CURLOPT_RETURNTRANSFER => true,
                    CURLOPT_USERAGENT => "BEdita agent",
                    CURLOPT_FOLLOWLOCATION => true,
                    CURLOPT_MAXREDIRS => 100,
                );
                if (Configure::read("proxyOptions") != null) {
                    $proxyOpts = Configure::read("proxyOptions");
                    $setupCurlOptions[CURLOPT_PROXY] = $proxyOpts["host"];
                    if(!empty($proxyOpts["type"]) && ($proxyOpts["type"] === "socks5") ) {
                        $setupCurlOptions[CURLOPT_PROXYTYPE] = CURLPROXY_SOCKS5;
                    }
                    if(!empty($proxyOpts["auth"])) {
                        $setupCurlOptions[CURLOPT_PROXYUSERPWD] = $proxyOpts["auth"];
                    }   
                }
                curl_setopt_array($this->client, $setupCurlOptions);
                $this->useCurl = true;          
            } else {
                App::import('Core', 'HttpSocket');
                $this->client = new HttpSocket();
                $this->useCurl = false; 
            }
            App::import('Core', 'Xml');
            $this->httpReady = true;
        }
    }

    /**
     * set self::requestOptions
     *
     * @param array   $options
     * @param boolean $merge   true if $options has to be merged with self::requestOptions. Default false
     */
    public function setOptions(array $options = array(), $merge = false) {
        if ($merge) {
            $this->requestOptions = array_merge($this->requestOptions, $options);
        } else {
            $this->requestOptions = $options;
        }
    }

    /**
     * Set headers for a call (get/post). After the call, reset headers
     */
    public function setHeaders(array $headers = array()) {
        $this->callHeaders = $headers;
    }

    /**
     * Do a HTTP GET request and returns output response. 
     * Output may be parsed (only xml/json) using $outType argument ("xml" or "json").
     * 
     * @param string $uri URL to GET
     * @param array $params, URL query parameters
     * @param string $outType, can be "xml" or "json", if present output will be parsed 
     *          if "xml" => php array, if "json" => json_decode is called
     * @param boolean $camelize, used if $outType = 'xml'
     *          true (default) camelize array keys corresponding to xml items that contain other xml items (CakePHP default behavior)
     *          false leave array keys equal to xml items
     * @param array $headers, header parameters
     */
    public function get($uri, $params = array(), $outType = null, $camelize = true, array $headers = array(), $verbose = false) {
        $this->setHeaders($headers);
        if(Configure::read('debug') > 0) {
            $this->log("HTTP REQUEST:\nuri " . $uri . "\nparams " . print_r($params, true), LOG_DEBUG);
        }
        if(!$this->useCurl) {
            // @todo: handle self::requestOptions
            $request = $this->callRequest();
            $out = $this->client->get($uri, $params, $request);
        } else {
            if($verbose) {
                curl_setopt($this->client, CURLOPT_VERBOSE, true);
            }
            if (Configure::read('debug') > 0) {
                $this->log('HTTP HEADERS:' . print_r($this->callHeaders, true), LOG_DEBUG);
            }
            $headers = array();
            foreach ($this->callHeaders as $headerKey => $headerVal) {
                $headers[] = $headerKey . ':' . $headerVal;
            }
            curl_setopt($this->client, CURLOPT_HTTPHEADER, $headers); 
            curl_setopt($this->client, CURLOPT_CUSTOMREQUEST, "GET");
            curl_setopt($this->client, CURLOPT_HTTPGET, true);

            // set self::requestOptions
            if (!empty($this->requestOptions)) {
                if (!curl_setopt_array($this->client, $this->requestOptions)) {
                    $this->log("curl_setopt_array error: fail to set curl options.\nOptions passed:" . print_r($this->requestOptions, true));
                }
            }

            if(is_array($params)) {
                $httpQuery = http_build_query($params);
            } else {
                $httpQuery = $params;
            }
            $queryParms = (empty($httpQuery)) ? "" : "?" . $httpQuery;
            curl_setopt($this->client, CURLOPT_URL, $uri . $queryParms);
            $out = curl_exec($this->client);
            $this->lastStatusCode = curl_getinfo($this->client, CURLINFO_HTTP_CODE);
            if(curl_errno($this->client)) {
                exit;
                $err = curl_error($this->client);
                $this->log("Error: " . $err);
            }
        }
        if(Configure::read('debug') > 0) {
            $this->log("HTTP RESPONSE:\n" . $out . "\n", LOG_DEBUG);
        }
        $this->setHeaders(); // reset headers
        return $this->output($out, $outType, $camelize);
    }
    
    /**
     * Do a HTTP POST request and returns output response. 
     * Output may be parsed (only xml/json) using $outType argument ("xml" or "json").
     * 
     * @param string $uri, HTTP POST URL
     * @param mixed $params, POST query parameters, if array is encoded with http_build_query
     * @param string $outType, can be "xml" or "json", if present output will be parsed 
     *  if "xml" => php array, if "json" => json_decode is called
     * @param boolean $camelize, used if $outType = 'xml'
     *          true (default) camelize array keys corresponding to xml items that contain other xml items (CakePHP default behavior)
     *          false leave array keys equal to xml items
     * @param array $headers, extra headers for call
     */
    public function post($uri, $params = array(), $outType = null, $camelize = true, array $headers = array()) {
        $this->setHeaders($headers);
        if(!$this->useCurl) {
            // @todo: handle self::requestOptions
            $request = $this->callRequest();
            $out = $this->client->post($uri, $params, $request);
            if(Configure::read('debug') > 0) {
                $this->log("HTTP REQUEST:\nuri " . $uri . "\nparams " . print_r($params, true), LOG_DEBUG);
            }
        } else {
            $headers = array(
                'Content-Type: application/x-www-form-urlencoded; charset=utf-8',
            );
            foreach ($this->callHeaders as $headerKey => $headerVal) {
                $headers[] = $headerKey . ': ' . $headerVal;
            }
            curl_setopt($this->client, CURLOPT_HTTPHEADER, $headers); 
            curl_setopt($this->client, CURLOPT_CUSTOMREQUEST, "POST");
            curl_setopt($this->client, CURLOPT_POST, true);

            // set self::requestOptions
            if (!empty($this->requestOptions)) {
                if (!curl_setopt_array($this->client, $this->requestOptions)) {
                    $this->log("curl_setopt_array error: fail to set curl options.\nOptions passed:" . print_r($this->requestOptions, true));
                }
            }

            if(is_array($params)) {
                $httpQuery = http_build_query($params);
            } else {
                $httpQuery = $params;
            }
            curl_setopt($this->client, CURLOPT_POSTFIELDS, $httpQuery);
            curl_setopt($this->client, CURLOPT_URL, $uri);
                    if(Configure::read('debug') > 0) {
                curl_setopt($this->client, CURLINFO_HEADER_OUT, true);
            }
            $out = curl_exec($this->client);
            $this->lastStatusCode = curl_getinfo($this->client, CURLINFO_HTTP_CODE);
            if(curl_errno($this->client)) {
                $err = curl_error($this->client);
                $this->log("Error: " . $err);
            }
            if(Configure::read('debug') > 0) {
                $info = curl_getinfo($this->client);
                $i = (!empty($info["request_header"]))? $info["request_header"] : "Missing Request Header";
                $this->log("HTTP REQUEST HEADER:\n" . $i, LOG_DEBUG);
                $this->log("HTTP POST QUERY:\n" . $httpQuery . "\n", LOG_DEBUG);
            }
        }

        if(Configure::read('debug') > 0) {
            $this->log("HTTP RESPONSE:\n" . $out . "\n", LOG_DEBUG);
        }
        $this->setHeaders();
        return $this->output($out, $outType, $camelize);
    }

    /**
     * Do a generic HTTP request using custom $method and returns output response.
     * Output may be parsed (only xml/json) using $outType argument ("xml" or "json").
     *
     * @param string $uri URL to request
     * @param string $methot HTTP request method, default "GET"
     * @param array $params, URL query parameters
     * @param string $outType, can be "xml" or "json", if present output will be parsed
     *          if "xml" => php array, if "json" => json_decode is called
     * @param boolean $camelize, used if $outType = 'xml'
     *          true (default) camelize array keys corresponding to xml items that contain other xml items (CakePHP default behavior)
     *          false leave array keys equal to xml items
     * @param array $headers Extra headers to be added to request.
     */
    public function request($uri, $method="GET", $params = array(), $outType = null, $camelize = true, array $headers = array()) {
        $this->setHeaders($headers);
        $method = strtoupper($method);
        if(Configure::read('debug') > 0) {
            $this->log("HTTP REQUEST:\nuri " . $uri . "\nmethod " . $uri .
                    "\nparams " . print_r($params, true), LOG_DEBUG);
        }
    
        if(!$this->useCurl) {
            $classMethod = strtolower($method);
            if(method_exists($this->client, $classMethod)) {
                $request = $this->callRequest();
                $out = $this->client->{$classMethod}($uri, $params, $request);
            } else {
                throw new BeditaException("Bad HTTP method: " . $method);
            }
        } else {
            if(is_array($params)) {
                $httpQuery = http_build_query($params);
            } else {
                $httpQuery = $params;
            }
            $queryParms = (empty($httpQuery)) ? "" : "?" . $httpQuery;
            
            $headers = array();
            foreach ($this->callHeaders as $headerKey => $headerVal) {
                $headers[] = $headerKey . ':' . $headerVal;
            }
            curl_setopt($this->client, CURLOPT_HTTPHEADER, $headers); 
            
            curl_setopt($this->client, CURLOPT_CUSTOMREQUEST, $method);
            curl_setopt($this->client, CURLOPT_URL, $uri . $queryParms);
            $out = curl_exec($this->client);
            $this->lastStatusCode = curl_getinfo($this->client, CURLINFO_HTTP_CODE);
            if(curl_errno($this->client)) {
                $err = curl_error($this->client);
                $this->log("Error: " . $err);
            }
        }
        if(Configure::read('debug') > 0) {
            $this->log("HTTP RESPONSE:\n" . $out . "\n", LOG_DEBUG);
        }
        $this->setHeaders();
        return $this->output($out, $outType, $camelize);
    }
    
    private function callRequest() {
        $request = array();
        if (!empty($this->callHeaders)) {
            $request = array('header' => $this->callHeaders);
        }
        return $request;
    }
    /**
     * Format response
     * 
     * @param string $out
     * @param string $outType, "xml" or "json"
     * @param boolean $camelize
     * @return string
     */
    private function output($out, $outType, $camelize) {
        if($outType != null) {
            if($outType === "xml") {
                $xml = new Xml($out);
                $out = $xml->toArray($camelize);
            } else if ($outType === "json") {
                $out = json_decode($out, true);
            }
        }
        return $out;
    }
}
?>

Classes

Interfaces

Exceptions