yetangitu/PrivateBin
1
0
Fork 0
mirror of https://github.com/PrivateBin/PrivateBin.git synced 2025-10-03 01:39:15 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: moved proxy classes to different folder and namespaces

Browse source
This commit is contained in:
Karthik Kasturi 2025-08-19 20:34:39 +01:00
parent 4a39a2ad0f
commit 7ec8bc6ef1
7 changed files with 91 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

17
lib/Controller.php
View file

@ -14,6 +14,9 @@ namespace PrivateBin;
use Exception;
use PrivateBin\Persistence\ServerSalt;
use PrivateBin\Persistence\TrafficLimiter;
use PrivateBin\Proxy\AbstractProxy;
use PrivateBin\Proxy\ShlinkProxy;
use PrivateBin\Proxy\YourlsProxy;
/**
* Controller
@ -149,10 +152,10 @@ class Controller
$this->_jsonld($this->_request->getParam('jsonld'));
return;
case 'yourlsproxy':
$this->_shortenerproxy($this->_request->getParam('link'), YourlsProxy::class);
$this->_shortenerproxy(new YourlsProxy($this->_conf, $this->_request->getParam('link')));
break;
case 'shlinkproxy':
$this->_shortenerproxy($this->_request->getParam('link'), ShlinkProxy::class);
$this->_shortenerproxy(new ShlinkProxy($this->_conf, $this->_request->getParam('link')));
break;
}
@ -539,16 +542,10 @@ class Controller
* Proxies a link using the specified proxy class, and updates the status or error with the response.
*
* @access private
* @param string $link The link to be proxied.
* @param string $proxyClass The fully qualified class name of the proxy to use.
* @param AbstractProxy $proxy The instance of the proxy class.
*/
private function _shortenerproxy($link, $proxyClass)
private function _shortenerproxy(AbstractProxy $proxy)
{
if (!is_subclass_of($proxyClass, AbstractProxy::class)) {
$this->_error = 'Invalid proxy class.';
return;
}
$proxy = new $proxyClass($this->_conf, $link);
if ($proxy->isError()) {
$this->_error = $proxy->getError();
} else {

49
lib/AbstractProxy.php → lib/Proxy/AbstractProxy.php
View file

@ -9,14 +9,16 @@
* @license https://www.opensource.org/licenses/zlib-license.php The zlib/libpng License
*/
namespace PrivateBin;
namespace PrivateBin\Proxy;
use Exception;
use PrivateBin\Configuration;
use PrivateBin\Json;
/**
* AbstractProxy
*
* Forwards a URL for shortening to shlink and stores the result.
* Forwards a URL for shortening and stores the result.
*/
abstract class AbstractProxy
{
@ -42,20 +44,35 @@ abstract class AbstractProxy
* initializes and runs the proxy class
*
* @access public
* @param Configuration $conf
* @param string $link
*/
public function __construct(Configuration $conf, $link)
public function __construct(Configuration $conf, string $link)
{
if (!str_starts_with($link, $conf->getKey('basepath') . '?')) {
$this->_error = 'Trying to shorten a URL that isn\'t pointing at our instance.';
return;
}
$data = $this->_getcontents($conf, $link);
$proxyUrl = $this->_getProxyUrl($conf);
if (empty($proxyUrl)) {
$this->_error = 'Error calling proxy. Probably a configuration issue, like missing api url';
error_log($this->_error);
return;
}
$data = file_get_contents($proxyUrl, false,
stream_context_create(
array(
'http' => $this->_getProxyPayload($conf, $link),
)
)
);
if ($data == null) {
$this->_error = 'Error calling proxy. Probably a configuration issue';
error_log('Error calling proxy: ' . $this->_error);
error_log($this->_error);
return;
}
@ -66,22 +83,23 @@ abstract class AbstractProxy
$statusCode = $matches[1];
}
$this->_error = 'Error calling proxy. HTTP request failed. Status code: ' . $statusCode;
error_log('Error calling proxy: ' . $this->_error);
error_log($this->_error);
return;
}
try {
$data = Json::decode($data);
$jsonData = Json::decode($data);
} catch (Exception $e) {
$this->_error = 'Error calling proxy. Probably a configuration issue, like wrong or missing config keys.';
error_log('Error calling proxy: ' . $e->getMessage());
return;
}
$url = $this->_extractShortUrl($data);
$url = $this->_extractShortUrl($jsonData);
if ($url === null) {
$this->_error = 'Error calling proxy. Probably a configuration issue, like wrong or missing config keys.';
error_log('Error calling proxy: ' . $data);
} else {
$this->_url = $url;
}
@ -121,13 +139,14 @@ abstract class AbstractProxy
}
/**
* Abstract method to get contents from a URL.
* Abstract method to get the payload to send to the URL Shortener
*
* @access protected
* @param Configuration $conf
* @param string $link
* @return mixed
* @return array
*/
abstract protected function _getcontents(Configuration $conf, string $link);
abstract protected function _getProxyPayload(Configuration $conf, string $link): array;
/**
* Abstract method to extract the shortUrl from the response
@ -136,4 +155,12 @@ abstract class AbstractProxy
* @return ?string
*/
abstract protected function _extractShortUrl(array $data): ?string;
/**
* Abstract method to get the proxy URL
*
* @param Configuration $conf
* @return string
*/
abstract protected function _getProxyUrl(Configuration $conf): string;
}

45
lib/ShlinkProxy.php → lib/Proxy/ShlinkProxy.php
View file

@ -9,7 +9,10 @@
* @license https://www.opensource.org/licenses/zlib-license.php The zlib/libpng License
*/
namespace PrivateBin;
namespace PrivateBin\Proxy;
use PrivateBin\Configuration;
use PrivateBin\Json;
/**
* ShlinkProxy
@ -19,48 +22,37 @@ namespace PrivateBin;
class ShlinkProxy extends AbstractProxy
{
/**
* constructor
* Overrides the abstract parent function to get the proxy URL.
*
* initializes and runs ShlinkProxy
*
* @access public
* @param string $link
* @param Configuration $conf
* @return string
*/
public function __construct(Configuration $conf, $link)
protected function _getProxyUrl(Configuration $conf): string
{
parent::__construct($conf, $link);
return $conf->getKey('apiurl', 'shlink');
}
/**
* Overrides the abstract parent function to get contents from Shlink API.
*
* @access protected
* @return string
* @param Configuration $conf
* @param string $link
* @return array
*/
protected function _getcontents(Configuration $conf, string $link)
protected function _getProxyPayload(Configuration $conf, string $link): array
{
$shlink_api_url = $conf->getKey('apiurl', 'shlink');
$shlink_api_key = $conf->getKey('apikey', 'shlink');
if (empty($shlink_api_url) || empty($shlink_api_key)) {
return;
}
$body = array(
'longUrl' => $link,
);
return file_get_contents(
$shlink_api_url, false, stream_context_create(
array(
'http' => array(
'method' => 'POST',
'header' => "Content-Type: application/json\r\n" .
'X-Api-Key: ' . $shlink_api_key . "\r\n",
'content' => Json::encode($body),
),
)
)
return array(
'method' => 'POST',
'header' => "Content-Type: application/json\r\n" .
'X-Api-Key: ' . $shlink_api_key . "\r\n",
'content' => Json::encode($body),
);
}
@ -74,7 +66,6 @@ class ShlinkProxy extends AbstractProxy
protected function _extractShortUrl(array $data): ?string
{
if (
!is_null($data) &&
array_key_exists('shortUrl', $data)
) {
return $data['shortUrl'];

53
lib/YourlsProxy.php → lib/Proxy/YourlsProxy.php
View file

@ -9,7 +9,9 @@
* @license https://www.opensource.org/licenses/zlib-license.php The zlib/libpng License
*/
namespace PrivateBin;
namespace PrivateBin\Proxy;
use PrivateBin\Configuration;
/**
* YourlsProxy
@ -20,49 +22,37 @@ namespace PrivateBin;
class YourlsProxy extends AbstractProxy
{
/**
* constructor
* Overrides the abstract parent function to get the proxy URL.
*
* initializes and runs YourlsProxy
*
* @access public
* @param string $link
* @param Configuration $conf
* @return string
*/
public function __construct(Configuration $conf, $link)
protected function _getProxyUrl(Configuration $conf): string
{
parent::__construct($conf, $link);
return $conf->getKey('apiurl', 'yourls');
}
/**
* Overrides the abstract parent function to get contents from YOURLS API.
*
* @access protected
* @return string
* @param Configuration $conf
* @param string $link
* @return array
*/
protected function _getcontents(Configuration $conf, string $link)
protected function _getProxyPayload(Configuration $conf, string $link): array
{
$yourls_api_url = $conf->getKey('apiurl', 'yourls');
if (empty($yourls_api_url)) {
return null;
}
return file_get_contents(
$yourls_api_url, false, stream_context_create(
return array(
'method' => 'POST',
'header' => "Content-Type: application/x-www-form-urlencoded\r\n",
'content' => http_build_query(
array(
'http' => array(
'method' => 'POST',
'header' => "Content-Type: application/x-www-form-urlencoded\r\n",
'content' => http_build_query(
array(
'signature' => $conf->getKey('signature', 'yourls'),
'format' => 'json',
'action' => 'shorturl',
'url' => $link,
)
),
),
'signature' => $conf->getKey('signature', 'yourls'),
'format' => 'json',
'action' => 'shorturl',
'url' => $link,
)
)
),
);
}
@ -76,7 +66,6 @@ class YourlsProxy extends AbstractProxy
protected function _extractShortUrl(array $data): ?string
{
if (
!is_null($data) &&
array_key_exists('statusCode', $data) &&
$data['statusCode'] == 200 &&
array_key_exists('shorturl', $data)

2
tst/YourlsProxyTest.php
View file

@ -2,7 +2,7 @@
use PHPUnit\Framework\TestCase;
use PrivateBin\Configuration;
use PrivateBin\YourlsProxy;
use PrivateBin\Proxy\YourlsProxy;
class YourlsProxyTest extends TestCase
{

6
vendor/composer/autoload_classmap.php vendored
View file

@ -66,7 +66,6 @@ return array(
'Jdenticon\\Shapes\\ShapeCategory' => $vendorDir . '/jdenticon/jdenticon/src/Shapes/ShapeCategory.php',
'Jdenticon\\Shapes\\ShapeDefinitions' => $vendorDir . '/jdenticon/jdenticon/src/Shapes/ShapeDefinitions.php',
'PhpToken' => $vendorDir . '/symfony/polyfill-php80/Resources/stubs/PhpToken.php',
'PrivateBin\\AbstractProxy' => $baseDir . '/lib/AbstractProxy.php',
'PrivateBin\\Configuration' => $baseDir . '/lib/Configuration.php',
'PrivateBin\\Controller' => $baseDir . '/lib/Controller.php',
'PrivateBin\\Data\\AbstractData' => $baseDir . '/lib/Data/AbstractData.php',
@ -86,12 +85,13 @@ return array(
'PrivateBin\\Persistence\\PurgeLimiter' => $baseDir . '/lib/Persistence/PurgeLimiter.php',
'PrivateBin\\Persistence\\ServerSalt' => $baseDir . '/lib/Persistence/ServerSalt.php',
'PrivateBin\\Persistence\\TrafficLimiter' => $baseDir . '/lib/Persistence/TrafficLimiter.php',
'PrivateBin\\Proxy\\AbstractProxy' => $baseDir . '/lib/Proxy/AbstractProxy.php',
'PrivateBin\\Proxy\\ShlinkProxy' => $baseDir . '/lib/Proxy/ShlinkProxy.php',
'PrivateBin\\Proxy\\YourlsProxy' => $baseDir . '/lib/Proxy/YourlsProxy.php',
'PrivateBin\\Request' => $baseDir . '/lib/Request.php',
'PrivateBin\\ShlinkProxy' => $baseDir . '/lib/ShlinkProxy.php',
'PrivateBin\\TemplateSwitcher' => $baseDir . '/lib/TemplateSwitcher.php',
'PrivateBin\\View' => $baseDir . '/lib/View.php',
'PrivateBin\\Vizhash16x16' => $baseDir . '/lib/Vizhash16x16.php',
'PrivateBin\\YourlsProxy' => $baseDir . '/lib/YourlsProxy.php',
'Stringable' => $vendorDir . '/symfony/polyfill-php80/Resources/stubs/Stringable.php',
'Symfony\\Polyfill\\Php80\\Php80' => $vendorDir . '/symfony/polyfill-php80/Php80.php',
'Symfony\\Polyfill\\Php80\\PhpToken' => $vendorDir . '/symfony/polyfill-php80/PhpToken.php',

6
vendor/composer/autoload_static.php vendored
View file

@ -114,7 +114,6 @@ class ComposerStaticInitDontChange
'Jdenticon\\Shapes\\ShapeCategory' => __DIR__ . '/..' . '/jdenticon/jdenticon/src/Shapes/ShapeCategory.php',
'Jdenticon\\Shapes\\ShapeDefinitions' => __DIR__ . '/..' . '/jdenticon/jdenticon/src/Shapes/ShapeDefinitions.php',
'PhpToken' => __DIR__ . '/..' . '/symfony/polyfill-php80/Resources/stubs/PhpToken.php',
'PrivateBin\\AbstractProxy' => __DIR__ . '/../..' . '/lib/AbstractProxy.php',
'PrivateBin\\Configuration' => __DIR__ . '/../..' . '/lib/Configuration.php',
'PrivateBin\\Controller' => __DIR__ . '/../..' . '/lib/Controller.php',
'PrivateBin\\Data\\AbstractData' => __DIR__ . '/../..' . '/lib/Data/AbstractData.php',
@ -134,12 +133,13 @@ class ComposerStaticInitDontChange
'PrivateBin\\Persistence\\PurgeLimiter' => __DIR__ . '/../..' . '/lib/Persistence/PurgeLimiter.php',
'PrivateBin\\Persistence\\ServerSalt' => __DIR__ . '/../..' . '/lib/Persistence/ServerSalt.php',
'PrivateBin\\Persistence\\TrafficLimiter' => __DIR__ . '/../..' . '/lib/Persistence/TrafficLimiter.php',
'PrivateBin\\Proxy\\AbstractProxy' => __DIR__ . '/../..' . '/lib/Proxy/AbstractProxy.php',
'PrivateBin\\Proxy\\ShlinkProxy' => __DIR__ . '/../..' . '/lib/Proxy/ShlinkProxy.php',
'PrivateBin\\Proxy\\YourlsProxy' => __DIR__ . '/../..' . '/lib/Proxy/YourlsProxy.php',
'PrivateBin\\Request' => __DIR__ . '/../..' . '/lib/Request.php',
'PrivateBin\\ShlinkProxy' => __DIR__ . '/../..' . '/lib/ShlinkProxy.php',
'PrivateBin\\TemplateSwitcher' => __DIR__ . '/../..' . '/lib/TemplateSwitcher.php',
'PrivateBin\\View' => __DIR__ . '/../..' . '/lib/View.php',
'PrivateBin\\Vizhash16x16' => __DIR__ . '/../..' . '/lib/Vizhash16x16.php',
'PrivateBin\\YourlsProxy' => __DIR__ . '/../..' . '/lib/YourlsProxy.php',
'Stringable' => __DIR__ . '/..' . '/symfony/polyfill-php80/Resources/stubs/Stringable.php',
'Symfony\\Polyfill\\Php80\\Php80' => __DIR__ . '/..' . '/symfony/polyfill-php80/Php80.php',
'Symfony\\Polyfill\\Php80\\PhpToken' => __DIR__ . '/..' . '/symfony/polyfill-php80/PhpToken.php',