Added shlink integration

This commit is contained in:
Karthik Kasturi 2025-08-15 00:07:51 +01:00
parent ebe275d509
commit 0808052acf
10 changed files with 215 additions and 2 deletions

View file

@ -107,6 +107,10 @@ class Configuration
'signature' => '',
'apiurl' => '',
),
'shlink' => array(
'apikey' => '',
'apiurl' => '',
),
// update this array when adding/changing/removing js files
'sri' => array(
'js/base-x-5.0.1.js' => 'sha512-FmhlnjIxQyxkkxQmzf0l6IRGsGbgyCdgqPxypFsEtHMF1naRqaLLo6mcyN5rEaT16nKx1PeJ4g7+07D6gnk/Tg==',

View file

@ -151,6 +151,9 @@ class Controller
case 'yourlsproxy':
$this->_yourlsproxy($this->_request->getParam('link'));
break;
case 'shlinkproxy':
$this->_shlinkproxy($this->_request->getParam('link'));
break;
}
$this->_setCacheHeaders();
@ -454,6 +457,11 @@ class Controller
$page->draw('yourlsproxy');
return;
}
if ($this->_request->getOperation() === 'shlinkproxy') {
$page->assign('SHORTURL', $this->_status);
$page->draw('shlinkproxy');
return;
}
$page->assign('BASEPATH', I18n::_($this->_conf->getKey('basepath')));
$page->assign('STATUS', I18n::_($this->_status));
$page->assign('ISDELETED', I18n::_(json_encode($this->_is_deleted)));
@ -543,6 +551,22 @@ class Controller
}
}
/**
* proxies link to SHLINK, updates status or error with response
*
* @access private
* @param string $link
*/
private function _shlinkproxy($link)
{
$shlink = new ShlinkProxy($this->_conf, $link);
if ($shlink->isError()) {
$this->_error = $shlink->getError();
} else {
$this->_status = $shlink->getUrl();
}
}
/**
* prepares JSON encoded status message
*

View file

@ -124,6 +124,7 @@ class Request
'link' => FILTER_SANITIZE_URL,
'pasteid' => FILTER_SANITIZE_SPECIAL_CHARS,
'shortenviayourls' => FILTER_SANITIZE_SPECIAL_CHARS,
'shortenviashlink' => FILTER_SANITIZE_SPECIAL_CHARS,
), false);
}
if (
@ -149,6 +150,9 @@ class Request
if (str_contains($this->getRequestUri(), '/shortenviayourls') || array_key_exists('shortenviayourls', $this->_params)) {
$this->_operation = 'yourlsproxy';
}
if (str_contains($this->getRequestUri(), '/shortenviashlink') || array_key_exists('shortenviashlink', $this->_params)) {
$this->_operation = 'shlinkproxy';
}
}
}

140
lib/ShlinkProxy.php Normal file
View file

@ -0,0 +1,140 @@
<?php declare(strict_types=1);
/**
* PrivateBin
*
* a zero-knowledge paste bin
*
* @link https://github.com/PrivateBin/PrivateBin
* @copyright 2012 Sébastien SAUVAGE (sebsauvage.net)
* @license https://www.opensource.org/licenses/zlib-license.php The zlib/libpng License
*/
namespace PrivateBin;
use Exception;
/**
* ShlinkProxy
*
* Forwards a URL for shortening to shlink and stores the result.
*/
class ShlinkProxy
{
/**
* error message
*
* @access private
* @var string
*/
private $_error = '';
/**
* shortened URL
*
* @access private
* @var string
*/
private $_url = '';
/**
* constructor
*
* initializes and runs PrivateBin
*
* @access public
* @param string $link
*/
public function __construct(Configuration $conf, $link)
{
if (!str_starts_with($link, $conf->getKey('basepath') . '?')) {
$this->_error = 'Trying to shorten a URL that isn\'t pointing at our instance.';
return;
}
$shlink_api_url = $conf->getKey('apiurl', 'shlink');
$shlink_api_key = $conf->getKey('apikey', 'shlink');
if (empty($shlink_api_url) || empty($shlink_api_key)) {
$this->_error = 'Error calling Shlink. Probably a configuration issue, like wrong or missing "apiurl" or "apikey".';
return;
}
$data = 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(
array(
'longUrl' => $link,
)
),
),
)
)
);
if ($data === false) {
$http_response_header = $http_response_header ?? [];
$statusCode = '';
if (!empty($http_response_header) && preg_match('/HTTP\/\d+\.\d+\s+(\d+)/', $http_response_header[0], $matches)) {
$statusCode = $matches[1];
}
$this->_error = 'Error calling shlink. HTTP request failed for URL ' . $shlink_api_url . '. Status code: ' . $statusCode;
error_log('Error calling shlink: HTTP request failed for URL ' . $shlink_api_url . '. Status code: ' . $statusCode);
return;
}
try {
$data = Json::decode($data);
} catch (Exception $e) {
$this->_error = 'Error calling shlink. Probably a configuration issue, like wrong or missing "apiurl" or "apikey".';
error_log('Error calling shlink: ' . $e->getMessage());
return;
}
if (
!is_null($data) &&
// array_key_exists('statusCode', $data) &&
// $data['statusCode'] == 200 &&
array_key_exists('shortUrl', $data)
) {
$this->_url = $data['shortUrl'];
} else {
$this->_error = 'Error parsing shlink response.';
}
}
/**
* Returns the (untranslated) error message
*
* @access public
* @return string
*/
public function getError()
{
return $this->_error;
}
/**
* Returns the shortened URL
*
* @access public
* @return string
*/
public function getUrl()
{
return $this->_url;
}
/**
* Returns true if any error has occurred
*
* @access public
* @return bool
*/
public function isError()
{
return !empty($this->_error);
}
}