Current File : //data/www_bck/varak.net_bck/nextcloud.varak.net/apps/circles/lib/Tools/Traits/TNCRequest.php
<?php
declare(strict_types=1);
/**
* Circles - Bring cloud-users closer together.
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2022
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Circles\Tools\Traits;
use Exception;
use GuzzleHttp\Exception\ClientException;
use OC;
use OCA\Circles\Tools\Exceptions\RequestNetworkException;
use OCA\Circles\Tools\Model\NCRequest;
use OCA\Circles\Tools\Model\NCRequestResult;
use OCA\Circles\Tools\Model\Request;
use OCP\Http\Client\IClientService;
use OCP\Http\Client\IResponse;
trait TNCRequest {
use TNCLogger;
/**
* @param int $size
*/
public function setMaxDownloadSize(int $size) {
}
/**
* @param NCRequest $request
*
* @return array
* @throws RequestNetworkException
*/
public function retrieveJson(NCRequest $request): array {
$this->doRequest($request);
$requestResult = $request->getResult();
return $requestResult->getAsArray();
}
/**
* @param NCRequest $request
* @param bool $exceptionOnIssue
*
* @throws RequestNetworkException
*/
public function doRequest(NCRequest $request, bool $exceptionOnIssue = true): void {
$request->setClient(
$this->clientService()
->newClient()
);
$this->generationClientOptions($request);
$this->debug('doRequest initiated', ['request' => $request]);
foreach ($request->getProtocols() as $protocol) {
$request->setUsedProtocol($protocol);
try {
$response = $this->useClient($request);
$request->setResult(new NCRequestResult($response));
break;
} catch (ClientException $e) {
$request->setResult(new NCRequestResult(null, $e));
} catch (Exception $e) {
$this->exception($e, self::$DEBUG, ['request' => $request]);
}
}
$this->debug('doRequest done', ['request' => $request]);
if ($exceptionOnIssue && (!$request->hasResult() || $request->getResult()->hasException())) {
throw new RequestNetworkException();
}
}
/**
* @return IClientService
*/
public function clientService(): IClientService {
if (isset($this->clientService) && $this->clientService instanceof IClientService) {
return $this->clientService;
} else {
return OC::$server->get(IClientService::class);
}
}
/**
* @param NCRequest $request
*/
private function generationClientOptions(NCRequest $request) {
$options = [
'headers' => $request->getHeaders(),
'cookies' => $request->getCookies(),
'verify' => $request->isVerifyPeer(),
'timeout' => $request->getTimeout(),
'http_errors' => !$request->isHttpErrorsAllowed()
];
if (!empty($request->getData())) {
$options['body'] = $request->getDataBody();
}
if (!empty($request->getParams())) {
$options['form_params'] = $request->getParams();
}
if ($request->isLocalAddressAllowed()) {
$options['nextcloud']['allow_local_address'] = true;
}
if ($request->isFollowLocation()) {
$options['allow_redirects'] = [
'max' => 10,
'strict' => true,
'referer' => true,
];
} else {
$options['allow_redirects'] = false;
}
$request->setClientOptions($options);
}
/**
* @param NCRequest $request
*
* @return IResponse
* @throws Exception
*/
private function useClient(NCRequest $request): IResponse {
$client = $request->getClient();
switch ($request->getType()) {
case Request::TYPE_POST:
return $client->post($request->getCompleteUrl(), $request->getClientOptions());
case Request::TYPE_PUT:
return $client->put($request->getCompleteUrl(), $request->getClientOptions());
case Request::TYPE_DELETE:
return $client->delete($request->getCompleteUrl(), $request->getClientOptions());
case Request::TYPE_GET:
return $client->get(
$request->getCompleteUrl() . $request->getQueryString(), $request->getClientOptions()
);
default:
throw new Exception('unknown request type ' . json_encode($request));
}
}
}
Mini Shell