nextcloud-swarm-plugin/lib/Utils/Curl.php
Henry Bergström 63221db916
Release 20250307 (#114)
* Improving github and NC app store documentation (#102)

* fix(curl): upload SSL verification (#105)

- remove: verify parameters to default to curl
- add: only in dev env

* feat(upload): add filename as meta param when uploading (#103)

* Improve settings information (#104)

* Improve settings information

* feat(settings): add server host URL as default value

* style(settings): remove extra wordings

---------

Co-authored-by: Mahyar Iranibazaz <mahiarirani@pm.me>

* Feature: secure API communication upgrade (#107)

* feat(exception): throw separate exceptions

* feat(api): separate token from api link
- update: merge getLink into a single function
- add: Dto for Links results
- pass: token in authorization header
- update: upload and download to use new api links
- refactor: remove extra isVersion input

* chore: fix code style

---------

Co-authored-by: mahiarirani <10583381+mahiarirani@users.noreply.github.com>

* bugfix: exception handling to ensure the response is handled correctly (#109)

* bugfix: correct exception handling to ensure the response is handled correclty by calling test() function.
- update: do not assume an array (json) response from the api. The response is not always json which cause the json_decode() to return null;
- add: use StorageNotAvailableException to ensure a user-friendly error message to be displayed on the front.end;
- update: return value can be a string

* chore: fix code style

* feat(api): check status
- update: response based on status code
- add: specific error for invalid code

* chore: fix code style

---------

Co-authored-by: Take one <rontrevor@hotmail.com>
Co-authored-by: Mahyar Iranibazaz <mahiarirani@pm.me>
Co-authored-by: mahiarirani <10583381+mahiarirani@users.noreply.github.com>

* feat(docker): add install ocs api viewer app (#108)

* bugfix/correct-install-docker-windows (#106)

* - Correction to docker-compose for Windows installations.
- Added README for known issues

* Update README.md

bugfix(correct-install-docker-windows): add supporting images

* - add: formatting changes to README.md

---------

Co-authored-by: Take one <rontrevor@hotmail.com>

* Feature #1192 feedback form js (#111)

* Adding Feedback form

* Not working yet.
Probably need to change strategy and send request to nc first

* Feedback js working.
Something might be improved:
// TODO - Get API Url from beeswarmtrait or another place
// TODO - Improve layout with css
// TODO - Remove wiget when not is not in swarm folders

* chore: fix code style

* feat(env): upgrade get
- update: return null if key is not found

* feat(feedback): add api url
- add: app const
- add: env example

* feat(curl): add post and get methods
- update: swarm endpoints to use new methods

* feat(feedback): update feedback request

* refactor(curl): rename curl to request

* feat(curl): add accept headers to getLink
- refactor: use get for download instead of exec

* style(feedback): improve feedback from ui

* style(feedback): improve feedback from ui

* feat(feedback): use custom exception

* feat(feedback): add status code to exception

* feat(feedback): return correct status code

* feat(feedback): add feedback js as dependency
- remove: manual added js file
- add: npm package
- update: the code usage

---------

Co-authored-by: JoaoSRaposo <1598265+JoaoSRaposo@users.noreply.github.com>
Co-authored-by: Mahyar Iranibazaz <mahiarirani@pm.me>

* feat(curl): check url for protocol

* bugfix(feedback): remove the removed script load

* feat(toast): add nextcloud dialogs (#112)

- add: library package
- update: fileactions.js usage
- update: swarm logo remove xml

* Fix/#1085  adding moodle to the documentation (#100)

* Adding moodle documentation

* FIxing link formating  error

---------

Co-authored-by: JoaoSRaposo <joaosraposo@gmail.com>
Co-authored-by: Mahyar Iranibazaz <mahiarirani@pm.me>
Co-authored-by: mahiarirani <10583381+mahiarirani@users.noreply.github.com>
Co-authored-by: retrevor <75954541+retrevor@users.noreply.github.com>
Co-authored-by: Take one <rontrevor@hotmail.com>
Co-authored-by: JoaoSRaposo <1598265+JoaoSRaposo@users.noreply.github.com>
2025-03-07 16:44:03 +01:00

154 lines
3.6 KiB
PHP

<?php
namespace OCA\Files_External_Ethswarm\Utils;
use CurlHandle;
use OCA\Files_External_Ethswarm\Exception\CurlException;
class Curl {
private const DEFAULT_OPTIONS = [
CURLOPT_MAXREDIRS => 10,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_RETURNTRANSFER => true,
];
protected CurlHandle $handler;
protected string $url;
protected array $options = [];
protected array $headers = [];
protected ?string $authorization = null;
protected int $authorizationType = CURLAUTH_NONE;
public function __construct(string $url, array $options = [], array $headers = [], ?string $authorization = null) {
if (!preg_match('/^https?:\/\//', $url)) {
$url = 'https://'.$url;
}
$this->url = $url;
$this->options = $options + self::getDefaultOptions();
$this->headers = $headers;
$this->setAuthorization($authorization);
$this->init();
}
/**
* set authorization.
*/
public function setAuthorization(?string $authorization, int $authorizationType = CURLAUTH_BEARER): void {
$this->authorization = $authorization;
if (!$authorization) {
$this->authorizationType = CURLAUTH_NONE;
} else {
$this->authorizationType = $authorizationType;
}
}
/**
* execute curl request.
*
* @param mixed $headers
*
* @throws CurlException
*/
public function exec(bool $array = false, array $options = [], array $headers = []): array|string {
$this->setOptions($options);
$this->setHeaders($headers);
$response = curl_exec($this->handler);
$this->checkResponse();
return $array ? json_decode($response, true) : $response;
}
/**
* @throws CurlException
*/
public function post(array $data = [], bool $array = false): array|string {
return $this->exec($array, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $data,
], ['accept: application/json']);
}
/**
* @throws CurlException
*/
public function get(bool $array = false): array|string {
return $this->exec($array);
}
/**
* get curl info.
*/
public function getInfo(?int $option = null): mixed {
return curl_getinfo($this->handler, $option);
}
/**
* @throws CurlException
*/
public function isResponseSuccessful(): bool {
if (0 === $this->getStatusCode()) {
throw new CurlException('Curl handler has not been executed');
}
return $this->getStatusCode() < 400;
}
public function getStatusCode(): int {
return $this->getInfo(CURLINFO_HTTP_CODE);
}
private static function getDefaultOptions(): array {
return self::checkSSLOption() + self::DEFAULT_OPTIONS;
}
/**
* @return bool[]
*/
private static function checkSSLOption(): array {
return Env::isDevelopment() ? [
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_SSL_VERIFYPEER => false,
] : [];
}
/**
* initializes a curl handler.
*/
private function init(): void {
$this->handler = curl_init();
curl_setopt($this->handler, CURLOPT_URL, $this->url);
}
/**
* set curl options.
*/
private function setOptions(array $options = []): void {
$options = self::getDefaultOptions() + $this->options + $options;
curl_setopt_array($this->handler, $options);
}
private function setHeaders(array $headers = []): void {
$headers = $this->headers + $headers;
if ($this->authorization) {
$headers[] = match ($this->authorizationType) {
CURLAUTH_BEARER => 'Authorization: Bearer '.$this->authorization,
default => 'Authorization: '.$this->authorization
};
}
curl_setopt($this->handler, CURLOPT_HTTPHEADER, $headers);
}
/**
* check response results for error.
*
* @throws CurlException
*/
private function checkResponse(): void {
if (0 !== curl_errno($this->handler)) {
curl_close($this->handler);
throw new CurlException(curl_error($this->handler));
}
}
}