Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#465 use guzzle for http transport #618

Merged
merged 2 commits into from
May 25, 2014
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
},
"suggest": {
"munkie/elasticsearch-thrift-php": "Allow using thrift transport",
"guzzlehttp/guzzle": "Allow using guzzle 4.x as the http transport (requires php 5.4)",
"psr/log": "for logging",
"monolog/monolog": "Logging request"
},
Expand Down
51 changes: 51 additions & 0 deletions lib/Elastica/Exception/Connection/GuzzleException.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<?php

namespace Elastica\Exception\Connection;

use Elastica\Exception\ConnectionException;
use Elastica\Request;
use Elastica\Response;
use GuzzleHttp\Exception\TransferException;

/**
* Transport exception
*
* @package Elastica
* @author Milan Magudia <milan@magudia.com>
*/
class GuzzleException extends ConnectionException
{
/**
* @var TransferException
*/
protected $_guzzleException;

/**
* @param \GuzzleHttp\Exception\TransferException $guzzleException
* @param \Elastica\Request $request
* @param \Elastica\Response $response
*/
public function __construct(TransferException $guzzleException, Request $request = null, Response $response = null)
{
$this->_guzzleException = $guzzleException;
$message = $this->getErrorMessage($this->getGuzzleException());
parent::__construct($message, $request, $response);
}

/**
* @param \GuzzleHttp\Exception\TransferException $guzzleException
* @return string
*/
public function getErrorMessage(TransferException $guzzleException)
{
return $guzzleException->getMessage();
}

/**
* @return TransferException
*/
public function getGuzzleException()
{
return $this->_guzzleException;
}
}
179 changes: 179 additions & 0 deletions lib/Elastica/Transport/Guzzle.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
<?php

namespace Elastica\Transport;

use Elastica\Exception\Connection\HttpException;
use Elastica\Exception\Connection\GuzzleException;
use Elastica\Exception\PartialShardFailureException;
use Elastica\Exception\ResponseException;
use Elastica\Exception\InvalidException;
use Elastica\Connection;
use Elastica\Request;
use Elastica\Response;
use Elastica\JSON;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\TransferException;
use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Stream\Stream;

/**
* Elastica Guzzle Transport object
*
* @package Elastica
* @author Milan Magudia <milan@magudia.com>
*/
class Guzzle extends AbstractTransport
{
/**
* Http scheme
*
* @var string Http scheme
*/
protected $_scheme = 'http';

/**
* Curl resource to reuse
*
* @var resource Guzzle resource to reuse
*/
protected static $_guzzleClientConnection = null;

/**
* Makes calls to the elasticsearch server
*
* All calls that are made to the server are done through this function
*
* @param \Elastica\Request $request
* @param array $params Host, Port, ...
* @throws \Elastica\Exception\ConnectionException
* @throws \Elastica\Exception\ResponseException
* @throws \Elastica\Exception\Connection\HttpException
* @return \Elastica\Response Response object
*/
public function exec(Request $request, array $params)
{
$connection = $this->getConnection();

try {
$client = $this->getGuzzleClient($this->getBaseUrl($connection), $connection->isPersistent());

$options = array();
if ($connection->getTimeout()) {
$options['timeout'] = $connection->getTimeout();
}

if ($connection->getProxy()) {
$options['proxy'] = $connection->getProxy();
}

$req = $client->createRequest($request->getMethod(), $this->getActionPath($request), $options);
$req->setHeaders($connection->hasConfig('headers') ?: array());

$data = $request->getData();
if (isset($data) && !empty($data)) {

if ($req->getMethod() == Request::GET) {
$req->setMethod(Request::POST);
}

if ($this->hasParam('postWithRequestBody') && $this->getParam('postWithRequestBody') == true) {
$request->setMethod(Request::POST);
$req->setMethod(Request::POST);
}

if (is_array($data)) {
$content = JSON::stringify($data, 'JSON_ELASTICSEARCH');
} else {
$content = $data;
}
$req->setBody(Stream::factory($content));
}

$start = microtime(true);
$res = $client->send($req);
$end = microtime(true);

$response = new Response((string)$res->getBody(), $res->getStatusCode());

if (defined('DEBUG') && DEBUG) {
$response->setQueryTime($end - $start);
}

$response->setTransferInfo(
array(
'request_header' => $request->getMethod(),
'http_code' => $res->getStatusCode()
)
);

if ($response->hasError()) {
throw new ResponseException($request, $response);
}

if ($response->hasFailedShards()) {
throw new PartialShardFailureException($request, $response);
}

return $response;

} catch (ClientException $e) {
// ignore 4xx errors
} catch (TransferException $e) {
throw new GuzzleException($e, $request, new Response($e->getMessage()));
}

}

/**
* Return Guzzle resource
*
* @param bool $persistent False if not persistent connection
* @return resource Connection resource
*/
protected function getGuzzleClient($baseUrl, $persistent = true)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use the naming convention with _ for protected functions

{
if (!$persistent || !self::$_guzzleClientConnection) {
self::$_guzzleClientConnection = new Client(array('base_url' => $baseUrl));
}

return self::$_guzzleClientConnection;
}

/**
* Builds the base url for the guzzle connection
*
* @param \Elastica\Connection $connection
*/
protected function getBaseUrl(Connection $connection)
{
// If url is set, url is taken. Otherwise port, host and path
$url = $connection->hasConfig('url') ? $connection->getConfig('url') : '';

if (!empty($url)) {
$baseUri = $url;
} else {
$baseUri = $this->_scheme . '://' . $connection->getHost() . ':' . $connection->getPort() . '/' . $connection->getPath();
}
return rtrim($baseUri, '/');
}

/**
* Builds the action path url for each request
*
* @param \Elastica\Request $request
*/
protected function getActionPath(Request $request)
{
$action = $request->getPath();
if ($action) {
$action = '/'. ltrim($action, '/');
}
$query = $request->getQuery();

if (!empty($query)) {
$action .= '?' . http_build_query($query);
}

return $action;
}
}
Loading