2016-12-15 10:13:00 +01:00
|
|
|
<?php
|
2023-05-24 11:35:15 +02:00
|
|
|
|
2016-12-15 10:13:00 +01:00
|
|
|
namespace Shaarli\Api;
|
|
|
|
|
|
|
|
use Shaarli\Api\Exceptions\ApiAuthorizationException;
|
2023-05-24 11:35:15 +02:00
|
|
|
use Shaarli\Bookmark\Bookmark;
|
2019-01-12 23:55:38 +01:00
|
|
|
use Shaarli\Http\Base64Url;
|
2016-12-15 10:13:00 +01:00
|
|
|
|
|
|
|
/**
|
2017-01-04 11:41:05 +01:00
|
|
|
* REST API utilities
|
2016-12-15 10:13:00 +01:00
|
|
|
*/
|
|
|
|
class ApiUtils
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Validates a JWT token authenticity.
|
|
|
|
*
|
2018-12-03 00:16:10 +01:00
|
|
|
* @param string $token JWT token extracted from the headers.
|
2016-12-15 10:13:00 +01:00
|
|
|
* @param string $secret API secret set in the settings.
|
|
|
|
*
|
2023-05-24 11:35:15 +02:00
|
|
|
* @return bool true on success
|
|
|
|
*
|
2016-12-15 10:13:00 +01:00
|
|
|
* @throws ApiAuthorizationException the token is not valid.
|
|
|
|
*/
|
|
|
|
public static function validateJwtToken($token, $secret)
|
|
|
|
{
|
|
|
|
$parts = explode('.', $token);
|
|
|
|
if (count($parts) != 3 || strlen($parts[0]) == 0 || strlen($parts[1]) == 0) {
|
|
|
|
throw new ApiAuthorizationException('Malformed JWT token');
|
|
|
|
}
|
|
|
|
|
2023-05-24 11:35:15 +02:00
|
|
|
$genSign = Base64Url::encode(hash_hmac('sha512', $parts[0] . '.' . $parts[1], $secret, true));
|
2016-12-15 10:13:00 +01:00
|
|
|
if ($parts[2] != $genSign) {
|
|
|
|
throw new ApiAuthorizationException('Invalid JWT signature');
|
|
|
|
}
|
|
|
|
|
2017-01-04 11:41:05 +01:00
|
|
|
$header = json_decode(Base64Url::decode($parts[0]));
|
2016-12-15 10:13:00 +01:00
|
|
|
if ($header === null) {
|
|
|
|
throw new ApiAuthorizationException('Invalid JWT header');
|
|
|
|
}
|
|
|
|
|
2017-01-04 11:41:05 +01:00
|
|
|
$payload = json_decode(Base64Url::decode($parts[1]));
|
2016-12-15 10:13:00 +01:00
|
|
|
if ($payload === null) {
|
|
|
|
throw new ApiAuthorizationException('Invalid JWT payload');
|
|
|
|
}
|
|
|
|
|
2023-05-24 11:35:15 +02:00
|
|
|
if (
|
|
|
|
empty($payload->iat)
|
2016-12-15 10:13:00 +01:00
|
|
|
|| $payload->iat > time()
|
|
|
|
|| time() - $payload->iat > ApiMiddleware::$TOKEN_DURATION
|
|
|
|
) {
|
|
|
|
throw new ApiAuthorizationException('Invalid JWT issued time');
|
|
|
|
}
|
2023-05-24 11:35:15 +02:00
|
|
|
|
|
|
|
return true;
|
2016-12-15 10:13:00 +01:00
|
|
|
}
|
2016-12-22 14:36:45 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Format a Link for the REST API.
|
|
|
|
*
|
2023-05-24 11:35:15 +02:00
|
|
|
* @param Bookmark $bookmark Bookmark data read from the datastore.
|
|
|
|
* @param string $indexUrl Shaarli's index URL (used for relative URL).
|
2016-12-22 14:36:45 +01:00
|
|
|
*
|
|
|
|
* @return array Link data formatted for the REST API.
|
|
|
|
*/
|
2023-05-24 11:35:15 +02:00
|
|
|
public static function formatLink($bookmark, $indexUrl)
|
2016-12-22 14:36:45 +01:00
|
|
|
{
|
2023-05-24 11:35:15 +02:00
|
|
|
$out['id'] = $bookmark->getId();
|
2016-12-22 14:36:45 +01:00
|
|
|
// Not an internal link
|
2023-05-24 11:35:15 +02:00
|
|
|
if (! $bookmark->isNote()) {
|
|
|
|
$out['url'] = $bookmark->getUrl();
|
2016-12-22 14:36:45 +01:00
|
|
|
} else {
|
2023-05-24 11:35:15 +02:00
|
|
|
$out['url'] = rtrim($indexUrl, '/') . '/' . ltrim($bookmark->getUrl(), '/');
|
2016-12-22 14:36:45 +01:00
|
|
|
}
|
2023-05-24 11:35:15 +02:00
|
|
|
$out['shorturl'] = $bookmark->getShortUrl();
|
|
|
|
$out['title'] = $bookmark->getTitle();
|
|
|
|
$out['description'] = $bookmark->getDescription();
|
|
|
|
$out['tags'] = $bookmark->getTags();
|
|
|
|
$out['private'] = $bookmark->isPrivate();
|
|
|
|
$out['created'] = $bookmark->getCreated()->format(\DateTime::ATOM);
|
|
|
|
if (! empty($bookmark->getUpdated())) {
|
|
|
|
$out['updated'] = $bookmark->getUpdated()->format(\DateTime::ATOM);
|
2016-12-22 14:36:45 +01:00
|
|
|
} else {
|
|
|
|
$out['updated'] = '';
|
|
|
|
}
|
|
|
|
return $out;
|
|
|
|
}
|
2017-01-05 15:58:24 +01:00
|
|
|
|
|
|
|
/**
|
2023-05-24 11:35:15 +02:00
|
|
|
* Convert a link given through a request, to a valid Bookmark for the datastore.
|
2017-01-05 15:58:24 +01:00
|
|
|
*
|
|
|
|
* If no URL is provided, it will generate a local note URL.
|
|
|
|
* If no title is provided, it will use the URL as title.
|
|
|
|
*
|
2023-05-24 11:35:15 +02:00
|
|
|
* @param array|null $input Request Link.
|
|
|
|
* @param bool $defaultPrivate Setting defined if a bookmark is private by default.
|
|
|
|
* @param string $tagsSeparator Tags separator loaded from the config file.
|
2017-01-05 15:58:24 +01:00
|
|
|
*
|
2023-05-24 11:35:15 +02:00
|
|
|
* @return Bookmark instance.
|
2017-01-05 15:58:24 +01:00
|
|
|
*/
|
2023-05-24 11:35:15 +02:00
|
|
|
public static function buildBookmarkFromRequest(
|
|
|
|
?array $input,
|
|
|
|
bool $defaultPrivate,
|
|
|
|
string $tagsSeparator
|
|
|
|
): Bookmark {
|
|
|
|
$bookmark = new Bookmark();
|
|
|
|
$url = ! empty($input['url']) ? cleanup_url($input['url']) : '';
|
2017-01-05 15:58:24 +01:00
|
|
|
if (isset($input['private'])) {
|
|
|
|
$private = filter_var($input['private'], FILTER_VALIDATE_BOOLEAN);
|
|
|
|
} else {
|
|
|
|
$private = $defaultPrivate;
|
|
|
|
}
|
|
|
|
|
2023-05-24 11:35:15 +02:00
|
|
|
$bookmark->setTitle(! empty($input['title']) ? $input['title'] : '');
|
|
|
|
$bookmark->setUrl($url);
|
|
|
|
$bookmark->setDescription(! empty($input['description']) ? $input['description'] : '');
|
|
|
|
|
|
|
|
// Be permissive with provided tags format
|
|
|
|
if (is_string($input['tags'] ?? null)) {
|
|
|
|
$input['tags'] = tags_str2array($input['tags'], $tagsSeparator);
|
|
|
|
}
|
|
|
|
if (is_array($input['tags'] ?? null) && count($input['tags']) === 1 && is_string($input['tags'][0])) {
|
|
|
|
$input['tags'] = tags_str2array($input['tags'][0], $tagsSeparator);
|
|
|
|
}
|
|
|
|
|
|
|
|
$bookmark->setTags(! empty($input['tags']) ? $input['tags'] : []);
|
|
|
|
$bookmark->setPrivate($private);
|
|
|
|
|
|
|
|
$created = \DateTime::createFromFormat(\DateTime::ATOM, $input['created'] ?? '');
|
|
|
|
if ($created instanceof \DateTimeInterface) {
|
|
|
|
$bookmark->setCreated($created);
|
|
|
|
}
|
|
|
|
$updated = \DateTime::createFromFormat(\DateTime::ATOM, $input['updated'] ?? '');
|
|
|
|
if ($updated instanceof \DateTimeInterface) {
|
|
|
|
$bookmark->setUpdated($updated);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $bookmark;
|
2017-01-05 15:58:24 +01:00
|
|
|
}
|
2017-04-01 11:11:25 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Update link fields using an updated link object.
|
|
|
|
*
|
2023-05-24 11:35:15 +02:00
|
|
|
* @param Bookmark $oldLink data
|
|
|
|
* @param Bookmark $newLink data
|
2017-04-01 11:11:25 +02:00
|
|
|
*
|
2023-05-24 11:35:15 +02:00
|
|
|
* @return Bookmark $oldLink updated with $newLink values
|
2017-04-01 11:11:25 +02:00
|
|
|
*/
|
|
|
|
public static function updateLink($oldLink, $newLink)
|
|
|
|
{
|
2023-05-24 11:35:15 +02:00
|
|
|
$oldLink->setTitle($newLink->getTitle());
|
|
|
|
$oldLink->setUrl($newLink->getUrl());
|
|
|
|
$oldLink->setDescription($newLink->getDescription());
|
|
|
|
$oldLink->setTags($newLink->getTags());
|
|
|
|
$oldLink->setPrivate($newLink->isPrivate());
|
2017-04-01 11:11:25 +02:00
|
|
|
|
|
|
|
return $oldLink;
|
|
|
|
}
|
2018-05-19 15:04:04 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Format a Tag for the REST API.
|
|
|
|
*
|
|
|
|
* @param string $tag Tag name
|
2023-05-24 11:35:15 +02:00
|
|
|
* @param int $occurrences Number of bookmarks using this tag
|
2018-05-19 15:04:04 +02:00
|
|
|
*
|
|
|
|
* @return array Link data formatted for the REST API.
|
|
|
|
*/
|
|
|
|
public static function formatTag($tag, $occurences)
|
|
|
|
{
|
|
|
|
return [
|
|
|
|
'name' => $tag,
|
|
|
|
'occurrences' => $occurences,
|
|
|
|
];
|
|
|
|
}
|
2016-12-15 10:13:00 +01:00
|
|
|
}
|