aboutsummaryrefslogtreecommitdiffhomepage
path: root/application/api
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2016-12-22 14:36:45 +0100
committerArthurHoaro <arthur@hoa.ro>2017-01-15 13:55:22 +0100
commitc3b00963fe22479e87998c82bc83827a54c8d972 (patch)
tree4c3f47697f8e58e2c60aa94bdcb506c770e4bd5e /application/api
parentfc11ab2f290a3712b766d78fdbcd354625a35d0a (diff)
downloadShaarli-c3b00963fe22479e87998c82bc83827a54c8d972.tar.gz
Shaarli-c3b00963fe22479e87998c82bc83827a54c8d972.tar.zst
Shaarli-c3b00963fe22479e87998c82bc83827a54c8d972.zip
REST API: implement getLinks service
See http://shaarli.github.io/api-documentation/#links-links-collection-get
Diffstat (limited to 'application/api')
-rw-r--r--application/api/ApiUtils.php31
-rw-r--r--application/api/controllers/Links.php86
2 files changed, 117 insertions, 0 deletions
diff --git a/application/api/ApiUtils.php b/application/api/ApiUtils.php
index fbb1e72f..d0242919 100644
--- a/application/api/ApiUtils.php
+++ b/application/api/ApiUtils.php
@@ -48,4 +48,35 @@ class ApiUtils
48 throw new ApiAuthorizationException('Invalid JWT issued time'); 48 throw new ApiAuthorizationException('Invalid JWT issued time');
49 } 49 }
50 } 50 }
51
52 /**
53 * Format a Link for the REST API.
54 *
55 * @param array $link Link data read from the datastore.
56 * @param string $indexUrl Shaarli's index URL (used for relative URL).
57 *
58 * @return array Link data formatted for the REST API.
59 */
60 public static function formatLink($link, $indexUrl)
61 {
62 $out['id'] = $link['id'];
63 // Not an internal link
64 if ($link['url'][0] != '?') {
65 $out['url'] = $link['url'];
66 } else {
67 $out['url'] = $indexUrl . $link['url'];
68 }
69 $out['shorturl'] = $link['shorturl'];
70 $out['title'] = $link['title'];
71 $out['description'] = $link['description'];
72 $out['tags'] = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY);
73 $out['private'] = $link['private'] == true;
74 $out['created'] = $link['created']->format(\DateTime::ATOM);
75 if (! empty($link['updated'])) {
76 $out['updated'] = $link['updated']->format(\DateTime::ATOM);
77 } else {
78 $out['updated'] = '';
79 }
80 return $out;
81 }
51} 82}
diff --git a/application/api/controllers/Links.php b/application/api/controllers/Links.php
new file mode 100644
index 00000000..1c7b41cd
--- /dev/null
+++ b/application/api/controllers/Links.php
@@ -0,0 +1,86 @@
1<?php
2
3namespace Shaarli\Api\Controllers;
4
5use Shaarli\Api\ApiUtils;
6use Shaarli\Api\Exceptions\ApiBadParametersException;
7use Slim\Http\Request;
8use Slim\Http\Response;
9
10/**
11 * Class Links
12 *
13 * REST API Controller: all services related to links collection.
14 *
15 * @package Api\Controllers
16 * @see http://shaarli.github.io/api-documentation/#links-links-collection
17 */
18class Links extends ApiController
19{
20 /**
21 * @var int Number of links returned if no limit is provided.
22 */
23 public static $DEFAULT_LIMIT = 20;
24
25 /**
26 * Retrieve a list of links, allowing different filters.
27 *
28 * @param Request $request Slim request.
29 * @param Response $response Slim response.
30 *
31 * @return Response response.
32 *
33 * @throws ApiBadParametersException Invalid parameters.
34 */
35 public function getLinks($request, $response)
36 {
37 $private = $request->getParam('private');
38 $links = $this->linkDb->filterSearch(
39 [
40 'searchtags' => $request->getParam('searchtags', ''),
41 'searchterm' => $request->getParam('searchterm', ''),
42 ],
43 false,
44 $private === 'true' || $private === '1'
45 );
46
47 // Return links from the {offset}th link, starting from 0.
48 $offset = $request->getParam('offset');
49 if (! empty($offset) && ! ctype_digit($offset)) {
50 throw new ApiBadParametersException('Invalid offset');
51 }
52 $offset = ! empty($offset) ? intval($offset) : 0;
53 if ($offset > count($links)) {
54 return $response->withJson([], 200, $this->jsonStyle);
55 }
56
57 // limit parameter is either a number of links or 'all' for everything.
58 $limit = $request->getParam('limit');
59 if (empty($limit)) {
60 $limit = self::$DEFAULT_LIMIT;
61 }
62 else if (ctype_digit($limit)) {
63 $limit = intval($limit);
64 } else if ($limit === 'all') {
65 $limit = count($links);
66 } else {
67 throw new ApiBadParametersException('Invalid limit');
68 }
69
70 // 'environment' is set by Slim and encapsulate $_SERVER.
71 $index = index_url($this->ci['environment']);
72
73 $out = [];
74 $cpt = 0;
75 foreach ($links as $link) {
76 if (count($out) >= $limit) {
77 break;
78 }
79 if ($cpt++ >= $offset) {
80 $out[] = ApiUtils::formatLink($link, $index);
81 }
82 }
83
84 return $response->withJson($out, 200, $this->jsonStyle);
85 }
86}