Skip to content

Create the cURL handle at a single place to avoid code redundancy #99

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.

Sign up for GitHub

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

Merged
msyk merged 1 commit into from
Sep 10, 2024
Merged

Create the cURL handle at a single place to avoid code redundancy #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
202 changes: 108 additions & 94 deletions src/Supporting/CommunicationProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace INTERMediator\FileMakerServer\RESTAPI\Supporting;

use Exception;
use CurlHandle;

/**
* Class CommunicationProvider is for internal use to communicate with FileMaker Server.
Expand Down Expand Up @@ -258,31 +259,27 @@ public function __construct(string $solution, string $user, string $password, ?

/**
* @param array $params Array to build the API path. Ex: `["layouts" => null]` or `["sessions" => $this->accessToken]`.
* @param null|array $request The query parameters as `"key" => "value"`.
* @param array|null $request The query parameters as `"key" => "value"`.
* @param string $methodLower The method in lowercase. Ex: `"get"`, `"delete"`, etc.
* @param bool $isSystem If the query is for the system (sessions, databases, etc) or for a database.
* @param false|string $directPath If we don't want to build the path with the other parameters, you can provide the direct path.
* @param string|null|false $directPath If we don't want to build the path with the other parameters, you can provide the direct path.
* @return string
* @ignore
*/
public function getURL(array $params, string|array|null $request, string $methodLower,
bool $isSystem = false, bool $directPath = false): string
public function getURL(array $params, ?array $request, string $methodLower,
bool $isSystem = false, string|null|false $directPath = null): string
{
$vStr = $this->vNum < 1 ? 'Latest' : strval($this->vNum);
$url = "$this->protocol://$this->host:$this->port";
if ($directPath) {
if (!empty($directPath)) {
$url .= $directPath;
} else {
$url .= "/fmi/data/v$vStr" . ((!$isSystem) ? "/databases/$this->solution" : "");
}
foreach ($params as $key => $value) {
$url .= "/$key" . (is_null($value) ? "" : "/$value");
}
if (!is_string($request) &&
in_array($methodLower, array('get', 'delete')) &&
!is_null($request) &&
(count($request) > 0)
) {
if (!empty($request) && in_array($methodLower, array('get', 'delete'))) {
$url .= '?';
foreach ($request as $key => $value) {
if (key($request) !== $key) {
Expand All @@ -293,7 +290,7 @@ public function getURL(array $params, string|array|null $request, string $method
if ($sortParam !== '[]') {
$url .= '_' . $key . '=' . $sortParam;
}
} else if ($key === 'limit' || $key === 'offset') {
} elseif ($key === 'limit' || $key === 'offset') {
$url .= '_' . $key . '=' . (is_array($value) ? json_encode($value) : $value);
} else {
// handling portal object name etc.
Expand Down Expand Up @@ -361,7 +358,7 @@ public function justifyRequest(?array $request): array

if (isset($result['sort'])) {
$sort = [];
foreach ($result['sort'] as $sortKey => $sortCondition) {
foreach ($result['sort'] as $sortCondition) {
if (isset($sortCondition[0])) {
$sortOrder = 'ascend';
if (isset($sortCondition[1])) {
Expand Down Expand Up @@ -490,14 +487,12 @@ public function getScriptNames(): null|array

/**
* @throws Exception In case of any error, an exception arises.
* @return bool
* @ignore
*/
public function login()
public function login(): bool
{
if ($this->keepAuth) {
return true;
}
if (!is_null($this->accessToken)) {
if ($this->keepAuth || !is_null($this->accessToken)) {
return true;
}

Expand All @@ -509,7 +504,10 @@ public function login()
];
} else {
$value = "Basic " . base64_encode("{$this->user}:{$this->password}");
$headers = ["Content-Type" => "application/json", "Authorization" => $value];
$headers = [
"Content-Type" => "application/json",
"Authorization" => $value
];
}
$params = ["sessions" => null];
$request = [];
Expand All @@ -531,6 +529,7 @@ public function login()
/**
*
* @throws Exception In case of any error, an exception arises.
* @return void
* @ignore
*/
public function logout()
Expand Down Expand Up @@ -564,16 +563,21 @@ private function getSupportingProviders()
private function getOAuthIdentifier($provider)
{
try {
$this->callRestAPI([], [
"trackingID" => rand(10000000, 99999999),
"provider" => $provider,
"address" => "127.0.0.1",
"X-FMS-OAuth-AuthType" => 2
], 'GET', [], [
"X-FMS-Application-Type" => 9,
"X-FMS-Application-Version" => 15,
"X-FMS-Return-URL" => "http://127.0.0.1/",
], false, "/oauth/getoauthurl");
$this->callRestAPI(
[], false, 'GET',
[
"trackingID" => rand(10000000, 99999999),
"provider" => $provider,
"address" => "127.0.0.1",
"X-FMS-OAuth-AuthType" => 2
],
[
"X-FMS-Application-Type" => 9,
"X-FMS-Application-Version" => 15,
"X-FMS-Return-URL" => "http://127.0.0.1/",
],
false, "/oauth/getoauthurl"
);
$result = [];
foreach ($this->responseBody as $key => $item) {

Expand All @@ -585,55 +589,38 @@ private function getOAuthIdentifier($provider)
}

/**
* @param $params
* @param $layout
* @param boolean $isAddToken
* @param array $params
* @param bool $isAddToken
* @param string $method
* @param array $request
* @param array $addHeader
* @param boolean $isSystem for Metadata
* @param array|null $request
* @param array|null $addHeader
* @param bool $isSystem for Metadata
* @param string|null|false $directPath
* @return void
* @throws Exception In case of any error, an exception arises.
* @ignore
*/
public function callRestAPI($params, $isAddToken, $method = 'GET', $request = null, $addHeader = null, $isSystem = false, $directPath = false)
public function callRestAPI(array $params, bool $isAddToken, string $method = 'GET', $request = null,
$addHeader = null, $isSystem = false, string|null|false $directPath = null)
{
$methodLower = strtolower($method);
$url = $this->getURL($params, $request, $methodLower, $isSystem, $directPath);
$header = $this->getHeaders($isAddToken, $addHeader);
$jsonEncoding = true;
if (is_string($request)) {
$jsonEncoding = false;
} else if ($methodLower !== 'get' && !is_null($request)) {
} elseif ($methodLower !== 'get' && !is_null($request)) {
$request = $this->justifyRequest($request);
}
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
$ch = $this->_createCurlHandle($url);
curl_setopt($ch, CURLOPT_VERBOSE, 0);
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_DEFAULT);
curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
if ($methodLower == 'post') {
curl_setopt($ch, CURLOPT_POST, 1);
} elseif (in_array($methodLower, ['put', 'patch', 'delete', 'get'], true)) {
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, strtoupper($methodLower));
}
if ($this->isCertValidating) {
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
// Use the OS native certificate authorities, if possible.
// This fixes SSL validation errors if `php.ini` doesn't have
// [curl] `curl.cainfo` set properly of if this PEM file isn't
// up to date. Better rely on the OS certificate authorities, which
// is maintained automatically.
if (defined('CURLSSLOPT_NATIVE_CA')
&& version_compare(curl_version()['version'], '7.71', '>=')) {
curl_setopt($ch, CURLOPT_SSL_OPTIONS, CURLSSLOPT_NATIVE_CA);
}
} else {
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
}
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
if ($methodLower != 'get') {
if ($jsonEncoding) {
Expand All @@ -648,9 +635,6 @@ public function callRestAPI($params, $isAddToken, $method = 'GET', $request = nu
curl_setopt($ch, CURLOPT_POSTFIELDS, $request);
}
}
if (!is_null($this->timeout)) {
curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
}
$response = curl_exec($ch);
$this->curlInfo = curl_getinfo($ch);
$this->curlErrorNumber = curl_errno($ch);
Expand Down Expand Up @@ -699,55 +683,37 @@ public function callRestAPI($params, $isAddToken, $method = 'GET', $request = nu
/**
* Return the base64 encoded data in container field.
* Thanks to 'base64bits' as https://github.com/msyk/FMDataAPI/issues/18.
* @param string $name The container field name.
* The table occurrence name of the portal can be the portal name, and also the object name of the portal.
* @param string $toName The table occurrence name of the portal as the prefix of the field name.
* @param string $url
* @return string The base64 encoded data in container field.
* @ignore
*/
public function accessToContainer($url)
public function accessToContainer(string $url): string
{
$cookieFile = tempnam(sys_get_temp_dir(), "CURLCOOKIE"); //create a cookie file
$cookieFile = tempnam(sys_get_temp_dir(), "CURLCOOKIE"); // Create a cookie file.

$ch = curl_init($url); //visit the container URL to set the cookie
// Visit the container URL to set the cookie.
$ch = $this->_createCurlHandle($url);
curl_setopt($ch, CURLOPT_COOKIEJAR, $cookieFile);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
if ($this->isCertValidating) {
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
} else {
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
}
if (!is_null($this->timeout)) {
curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
}
curl_exec($ch);
if (curl_errno($ch) !== 0) {
$errMsg = curl_error($ch);
curl_close($ch);
throw new Exception("Error in creating cookie file. {$errMsg}");
}
curl_close($ch);

$ch = curl_init($url); //visit container URL again
// Visit the container URL again.
$ch = $this->_createCurlHandle($url);
curl_setopt($ch, CURLOPT_COOKIEFILE, $cookieFile);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
if ($this->isCertValidating) {
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
} else {
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
}
if (!is_null($this->timeout)) {
curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
}
$output = curl_exec($ch);
if (curl_errno($ch) !== 0) {
$errMsg = curl_error($ch);
curl_close($ch);
throw new Exception("Error in downloading content of file. {$errMsg}");
}
curl_close($ch);

return base64_encode($output); //process the image data as need it
return base64_encode($output); // Process the data as needed.
}

/**
Expand Down Expand Up @@ -811,11 +777,11 @@ public function storeToProperties()
* @return string
* @ignore
*/
public function adjustSortDirection($direction)
public function adjustSortDirection($direction): string
{
if (strtoupper($direction) == 'ASC') {
$direction = 'ascend';
} else if (strtoupper($direction) == 'DESC') {
} elseif (strtoupper($direction) == 'DESC') {
$direction = 'descend';
}

Expand All @@ -837,7 +803,7 @@ public function getCurlInfo($key)
* @return string
* @ignore
*/
public function debugOutput($isReturnValue = false)
public function debugOutput(bool $isReturnValue = false): string
{
$str = "<div style='background-color: #DDDDDD'>URL: ";
$str .= $this->method . ' ' . htmlspecialchars($this->url);
Expand Down Expand Up @@ -872,7 +838,7 @@ public function debugOutput($isReturnValue = false)
* @return string
* @ignore
*/
private function _buildSortParameters($value)
private function _buildSortParameters(array $value): string
{
$param = '[';
foreach ($value as $sortCondition) {
Expand All @@ -899,7 +865,7 @@ private function _buildSortParameters($value)
* @return string
* @ignore
*/
private function _json_urlencode($value)
private function _json_urlencode(array $value): string
{
$str = '[';
if (count($value) > 0) {
Expand All @@ -914,4 +880,52 @@ private function _json_urlencode($value)

return $str;
}

/**
* To create and configure cURL at a single place, avoiding code redundancy.
* If later we need some specific settings for some cases, then add new
* parameters to this function.
*
* @param string|null $url The URL you want to access.
* @param bool $returnTransfer By default, sets CURLOPT_RETURNTRANSFER to `true`.
* But it can be set to false if needed.
* @return CurlHandle
*/
private function _createCurlHandle(string|null $url = null, bool $returnTransfer = true): CurlHandle
{
$ch = curl_init();

if (!is_null($url)) {
curl_setopt($ch, CURLOPT_URL, $url);
}

if ($returnTransfer) {
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
}

curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_DEFAULT);

if ($this->isCertValidating) {
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
// Use the OS native certificate authorities, if possible.
// This fixes SSL validation errors if `php.ini` doesn't have
// [curl] `curl.cainfo` set properly of if this PEM file isn't
// up to date. Better rely on the OS certificate authorities, which
// is maintained automatically.
if (defined('CURLSSLOPT_NATIVE_CA')
&& version_compare(curl_version()['version'], '7.71', '>=')) {
curl_setopt($ch, CURLOPT_SSL_OPTIONS, CURLSSLOPT_NATIVE_CA);
}
} else {
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
}

if (!is_null($this->timeout)) {
curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
}

return $ch;
}
}
Loading