123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161 |
- <?php
- namespace Shaarli\Api\Controllers;
- use Shaarli\Api\ApiUtils;
- use Shaarli\Api\Exceptions\ApiBadParametersException;
- use Shaarli\Api\Exceptions\ApiLinkNotFoundException;
- use Shaarli\Api\Exceptions\ApiTagNotFoundException;
- use Slim\Http\Request;
- use Slim\Http\Response;
- /**
- * Class Tags
- *
- * REST API Controller: all services related to tags collection.
- *
- * @package Api\Controllers
- */
- class Tags extends ApiController
- {
- /**
- * @var int Number of links returned if no limit is provided.
- */
- public static $DEFAULT_LIMIT = 'all';
- /**
- * Retrieve a list of tags, allowing different filters.
- *
- * @param Request $request Slim request.
- * @param Response $response Slim response.
- *
- * @return Response response.
- *
- * @throws ApiBadParametersException Invalid parameters.
- */
- public function getTags($request, $response)
- {
- $visibility = $request->getParam('visibility');
- $tags = $this->linkDb->linksCountPerTag([], $visibility);
- // Return tags from the {offset}th tag, 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($tags)) {
- return $response->withJson([], 200, $this->jsonStyle);
- }
- // limit parameter is either a number of links or 'all' for everything.
- $limit = $request->getParam('limit');
- if (empty($limit)) {
- $limit = self::$DEFAULT_LIMIT;
- }
- if (ctype_digit($limit)) {
- $limit = intval($limit);
- } elseif ($limit === 'all') {
- $limit = count($tags);
- } else {
- throw new ApiBadParametersException('Invalid limit');
- }
- $out = [];
- $index = 0;
- foreach ($tags as $tag => $occurrences) {
- if (count($out) >= $limit) {
- break;
- }
- if ($index++ >= $offset) {
- $out[] = ApiUtils::formatTag($tag, $occurrences);
- }
- }
- return $response->withJson($out, 200, $this->jsonStyle);
- }
- /**
- * Return a single formatted tag by its name.
- *
- * @param Request $request Slim request.
- * @param Response $response Slim response.
- * @param array $args Path parameters. including the tag name.
- *
- * @return Response containing the link array.
- *
- * @throws ApiTagNotFoundException generating a 404 error.
- */
- public function getTag($request, $response, $args)
- {
- $tags = $this->linkDb->linksCountPerTag();
- if (!isset($tags[$args['tagName']])) {
- throw new ApiTagNotFoundException();
- }
- $out = ApiUtils::formatTag($args['tagName'], $tags[$args['tagName']]);
- return $response->withJson($out, 200, $this->jsonStyle);
- }
- /**
- * Rename a tag from the given name.
- * If the new name provided matches an existing tag, they will be merged.
- *
- * @param Request $request Slim request.
- * @param Response $response Slim response.
- * @param array $args Path parameters. including the tag name.
- *
- * @return Response response.
- *
- * @throws ApiTagNotFoundException generating a 404 error.
- * @throws ApiBadParametersException new tag name not provided
- */
- public function putTag($request, $response, $args)
- {
- $tags = $this->linkDb->linksCountPerTag();
- if (! isset($tags[$args['tagName']])) {
- throw new ApiTagNotFoundException();
- }
- $data = $request->getParsedBody();
- if (empty($data['name'])) {
- throw new ApiBadParametersException('New tag name is required in the request body');
- }
- $updated = $this->linkDb->renameTag($args['tagName'], $data['name']);
- $this->linkDb->save($this->conf->get('resource.page_cache'));
- foreach ($updated as $link) {
- $this->history->updateLink($link);
- }
- $tags = $this->linkDb->linksCountPerTag();
- $out = ApiUtils::formatTag($data['name'], $tags[$data['name']]);
- return $response->withJson($out, 200, $this->jsonStyle);
- }
- /**
- * Delete an existing tag by its name.
- *
- * @param Request $request Slim request.
- * @param Response $response Slim response.
- * @param array $args Path parameters. including the tag name.
- *
- * @return Response response.
- *
- * @throws ApiTagNotFoundException generating a 404 error.
- */
- public function deleteTag($request, $response, $args)
- {
- $tags = $this->linkDb->linksCountPerTag();
- if (! isset($tags[$args['tagName']])) {
- throw new ApiTagNotFoundException();
- }
- $updated = $this->linkDb->renameTag($args['tagName'], null);
- $this->linkDb->save($this->conf->get('resource.page_cache'));
- foreach ($updated as $link) {
- $this->history->updateLink($link);
- }
- return $response->withStatus(204);
- }
- }
|