/**
* Class Links
*
- * REST API Controller: all services related to links collection.
+ * REST API Controller: all services related to bookmarks collection.
*
* @package Api\Controllers
* @see http://shaarli.github.io/api-documentation/#links-links-collection
class Links extends ApiController
{
/**
- * @var int Number of links returned if no limit is provided.
+ * @var int Number of bookmarks returned if no limit is provided.
*/
public static $DEFAULT_LIMIT = 20;
/**
- * Retrieve a list of links, allowing different filters.
+ * Retrieve a list of bookmarks, allowing different filters.
*
* @param Request $request Slim request.
* @param Response $response Slim response.
public function getLinks($request, $response)
{
$private = $request->getParam('visibility');
- $links = $this->linkDb->filterSearch(
+ $bookmarks = $this->bookmarkService->search(
[
'searchtags' => $request->getParam('searchtags', ''),
'searchterm' => $request->getParam('searchterm', ''),
],
- false,
$private
);
- // Return links from the {offset}th link, starting from 0.
+ // Return bookmarks from the {offset}th link, starting from 0.
$offset = $request->getParam('offset');
if (! empty($offset) && ! ctype_digit($offset)) {
throw new ApiBadParametersException('Invalid offset');
}
$offset = ! empty($offset) ? intval($offset) : 0;
- if ($offset > count($links)) {
+ if ($offset > count($bookmarks)) {
return $response->withJson([], 200, $this->jsonStyle);
}
- // limit parameter is either a number of links or 'all' for everything.
+ // limit parameter is either a number of bookmarks or 'all' for everything.
$limit = $request->getParam('limit');
if (empty($limit)) {
$limit = self::$DEFAULT_LIMIT;
- } else if (ctype_digit($limit)) {
+ } elseif (ctype_digit($limit)) {
$limit = intval($limit);
- } else if ($limit === 'all') {
- $limit = count($links);
+ } elseif ($limit === 'all') {
+ $limit = count($bookmarks);
} else {
throw new ApiBadParametersException('Invalid limit');
}
// 'environment' is set by Slim and encapsulate $_SERVER.
- $index = index_url($this->ci['environment']);
+ $indexUrl = index_url($this->ci['environment']);
$out = [];
- $cpt = 0;
- foreach ($links as $link) {
+ $index = 0;
+ foreach ($bookmarks as $bookmark) {
if (count($out) >= $limit) {
break;
}
- if ($cpt++ >= $offset) {
- $out[] = ApiUtils::formatLink($link, $index);
+ if ($index++ >= $offset) {
+ $out[] = ApiUtils::formatLink($bookmark, $indexUrl);
}
}
*/
public function getLink($request, $response, $args)
{
- if (!isset($this->linkDb[$args['id']])) {
+ $id = is_integer_mixed($args['id']) ? (int) $args['id'] : null;
+ if ($id === null || ! $this->bookmarkService->exists($id)) {
throw new ApiLinkNotFoundException();
}
$index = index_url($this->ci['environment']);
- $out = ApiUtils::formatLink($this->linkDb[$args['id']], $index);
+ $out = ApiUtils::formatLink($this->bookmarkService->get($id), $index);
return $response->withJson($out, 200, $this->jsonStyle);
}
*/
public function postLink($request, $response)
{
- $data = $request->getParsedBody();
- $link = ApiUtils::buildLinkFromRequest($data, $this->conf->get('privacy.default_private_links'));
+ $data = (array) ($request->getParsedBody() ?? []);
+ $bookmark = ApiUtils::buildBookmarkFromRequest($data, $this->conf->get('privacy.default_private_links'));
// duplicate by URL, return 409 Conflict
- if (! empty($link['url']) && ! empty($dup = $this->linkDb->getLinkFromUrl($link['url']))) {
+ if (! empty($bookmark->getUrl())
+ && ! empty($dup = $this->bookmarkService->findByUrl($bookmark->getUrl()))
+ ) {
return $response->withJson(
ApiUtils::formatLink($dup, index_url($this->ci['environment'])),
409,
);
}
- $link['id'] = $this->linkDb->getNextId();
- $link['shorturl'] = link_small_hash($link['created'], $link['id']);
-
- // note: general relative URL
- if (empty($link['url'])) {
- $link['url'] = '?' . $link['shorturl'];
- }
-
- if (empty($link['title'])) {
- $link['title'] = $link['url'];
- }
-
- $this->linkDb[$link['id']] = $link;
- $this->linkDb->save($this->conf->get('resource.page_cache'));
- $out = ApiUtils::formatLink($link, index_url($this->ci['environment']));
- $redirect = $this->ci->router->relativePathFor('getLink', ['id' => $link['id']]);
+ $this->bookmarkService->add($bookmark);
+ $out = ApiUtils::formatLink($bookmark, index_url($this->ci['environment']));
+ $redirect = $this->ci->router->pathFor('getLink', ['id' => $bookmark->getId()]);
return $response->withAddedHeader('Location', $redirect)
->withJson($out, 201, $this->jsonStyle);
}
*/
public function putLink($request, $response, $args)
{
- if (! isset($this->linkDb[$args['id']])) {
+ $id = is_integer_mixed($args['id']) ? (int) $args['id'] : null;
+ if ($id === null || !$this->bookmarkService->exists($id)) {
throw new ApiLinkNotFoundException();
}
$index = index_url($this->ci['environment']);
$data = $request->getParsedBody();
- $requestLink = ApiUtils::buildLinkFromRequest($data, $this->conf->get('privacy.default_private_links'));
+ $requestBookmark = ApiUtils::buildBookmarkFromRequest($data, $this->conf->get('privacy.default_private_links'));
// duplicate URL on a different link, return 409 Conflict
- if (! empty($requestLink['url'])
- && ! empty($dup = $this->linkDb->getLinkFromUrl($requestLink['url']))
- && $dup['id'] != $args['id']
+ if (! empty($requestBookmark->getUrl())
+ && ! empty($dup = $this->bookmarkService->findByUrl($requestBookmark->getUrl()))
+ && $dup->getId() != $id
) {
return $response->withJson(
ApiUtils::formatLink($dup, $index),
);
}
- $responseLink = $this->linkDb[$args['id']];
- $responseLink = ApiUtils::updateLink($responseLink, $requestLink);
- $this->linkDb[$responseLink['id']] = $responseLink;
- $this->linkDb->save($this->conf->get('resource.page_cache'));
+ $responseBookmark = $this->bookmarkService->get($id);
+ $responseBookmark = ApiUtils::updateLink($responseBookmark, $requestBookmark);
+ $this->bookmarkService->set($responseBookmark);
- $out = ApiUtils::formatLink($responseLink, $index);
+ $out = ApiUtils::formatLink($responseBookmark, $index);
return $response->withJson($out, 200, $this->jsonStyle);
}
+
+ /**
+ * Delete an existing link by its ID.
+ *
+ * @param Request $request Slim request.
+ * @param Response $response Slim response.
+ * @param array $args Path parameters. including the ID.
+ *
+ * @return Response response.
+ *
+ * @throws ApiLinkNotFoundException generating a 404 error.
+ */
+ public function deleteLink($request, $response, $args)
+ {
+ $id = is_integer_mixed($args['id']) ? (int) $args['id'] : null;
+ if ($id === null || !$this->bookmarkService->exists($id)) {
+ throw new ApiLinkNotFoundException();
+ }
+ $bookmark = $this->bookmarkService->get($id);
+ $this->bookmarkService->remove($bookmark);
+
+ return $response->withStatus(204);
+ }
}
projects / github / shaarli / Shaarli.git / blobdiff