5 use Shaarli\Api\Exceptions\ApiAuthorizationException
;
6 use Shaarli\Bookmark\Bookmark
;
7 use Shaarli\Http\Base64Url
;
15 * Validates a JWT token authenticity.
17 * @param string $token JWT token extracted from the headers.
18 * @param string $secret API secret set in the settings.
20 * @return bool true on success
22 * @throws ApiAuthorizationException the token is not valid.
24 public static function validateJwtToken($token, $secret)
26 $parts = explode('.', $token);
27 if (count($parts) != 3 || strlen($parts[0]) == 0 || strlen($parts[1]) == 0) {
28 throw new ApiAuthorizationException('Malformed JWT token');
31 $genSign = Base64Url
::encode(hash_hmac('sha512', $parts[0] . '.' . $parts[1], $secret, true));
32 if ($parts[2] != $genSign) {
33 throw new ApiAuthorizationException('Invalid JWT signature');
36 $header = json_decode(Base64Url
::decode($parts[0]));
37 if ($header === null) {
38 throw new ApiAuthorizationException('Invalid JWT header');
41 $payload = json_decode(Base64Url
::decode($parts[1]));
42 if ($payload === null) {
43 throw new ApiAuthorizationException('Invalid JWT payload');
48 || $payload->iat
> time()
49 || time() - $payload->iat
> ApiMiddleware
::$TOKEN_DURATION
51 throw new ApiAuthorizationException('Invalid JWT issued time');
58 * Format a Link for the REST API.
60 * @param Bookmark $bookmark Bookmark data read from the datastore.
61 * @param string $indexUrl Shaarli's index URL (used for relative URL).
63 * @return array Link data formatted for the REST API.
65 public static function formatLink($bookmark, $indexUrl)
67 $out['id'] = $bookmark->getId();
68 // Not an internal link
69 if (! $bookmark->isNote()) {
70 $out['url'] = $bookmark->getUrl();
72 $out['url'] = rtrim($indexUrl, '/') . '/' . ltrim($bookmark->getUrl(), '/');
74 $out['shorturl'] = $bookmark->getShortUrl();
75 $out['title'] = $bookmark->getTitle();
76 $out['description'] = $bookmark->getDescription();
77 $out['tags'] = $bookmark->getTags();
78 $out['private'] = $bookmark->isPrivate();
79 $out['created'] = $bookmark->getCreated()->format(\DateTime
::ATOM
);
80 if (! empty($bookmark->getUpdated())) {
81 $out['updated'] = $bookmark->getUpdated()->format(\DateTime
::ATOM
);
89 * Convert a link given through a request, to a valid Bookmark for the datastore.
91 * If no URL is provided, it will generate a local note URL.
92 * If no title is provided, it will use the URL as title.
94 * @param array|null $input Request Link.
95 * @param bool $defaultPrivate Setting defined if a bookmark is private by default.
96 * @param string $tagsSeparator Tags separator loaded from the config file.
98 * @return Bookmark instance.
100 public static function buildBookmarkFromRequest(
102 bool $defaultPrivate,
103 string $tagsSeparator
105 $bookmark = new Bookmark();
106 $url = ! empty($input['url']) ? cleanup_url($input['url']) : '';
107 if (isset($input['private'])) {
108 $private = filter_var($input['private'], FILTER_VALIDATE_BOOLEAN
);
110 $private = $defaultPrivate;
113 $bookmark->setTitle(! empty($input['title']) ? $input['title'] : '');
114 $bookmark->setUrl($url);
115 $bookmark->setDescription(! empty($input['description']) ? $input['description'] : '');
117 // Be permissive with provided tags format
118 if (is_string($input['tags'] ?? null)) {
119 $input['tags'] = tags_str2array($input['tags'], $tagsSeparator);
121 if (is_array($input['tags'] ?? null) && count($input['tags']) === 1 && is_string($input['tags'][0])) {
122 $input['tags'] = tags_str2array($input['tags'][0], $tagsSeparator);
125 $bookmark->setTags(! empty($input['tags']) ? $input['tags'] : []);
126 $bookmark->setPrivate($private);
128 $created = \DateTime
::createFromFormat(\DateTime
::ATOM
, $input['created'] ?? '');
129 if ($created instanceof \DateTimeInterface
) {
130 $bookmark->setCreated($created);
132 $updated = \DateTime
::createFromFormat(\DateTime
::ATOM
, $input['updated'] ?? '');
133 if ($updated instanceof \DateTimeInterface
) {
134 $bookmark->setUpdated($updated);
141 * Update link fields using an updated link object.
143 * @param Bookmark $oldLink data
144 * @param Bookmark $newLink data
146 * @return Bookmark $oldLink updated with $newLink values
148 public static function updateLink($oldLink, $newLink)
150 $oldLink->setTitle($newLink->getTitle());
151 $oldLink->setUrl($newLink->getUrl());
152 $oldLink->setDescription($newLink->getDescription());
153 $oldLink->setTags($newLink->getTags());
154 $oldLink->setPrivate($newLink->isPrivate());
160 * Format a Tag for the REST API.
162 * @param string $tag Tag name
163 * @param int $occurrences Number of bookmarks using this tag
165 * @return array Link data formatted for the REST API.
167 public static function formatTag($tag, $occurences)
171 'occurrences' => $occurences,