]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/LinkFilter.php
6 * Perform search and filter operation on link data list.
11 * @var string permalinks.
13 public static $FILTER_HASH = 'permalink';
16 * @var string text search.
18 public static $FILTER_TEXT = 'fulltext';
21 * @var string tag filter.
23 public static $FILTER_TAG = 'tags';
26 * @var string filter by day.
28 public static $FILTER_DAY = 'FILTER_DAY';
31 * @var array all available links.
36 * @param array $links initialization.
38 public function __construct($links)
40 $this->links
= $links;
44 * Filter links according to parameters.
46 * @param string $type Type of filter (eg. tags, permalink, etc.).
47 * @param string $request Filter content.
48 * @param bool $casesensitive Optional: Perform case sensitive filter if true.
49 * @param bool $privateonly Optional: Only returns private links if true.
51 * @return array filtered link list.
53 public function filter($type, $request, $casesensitive = false, $privateonly = false)
56 case self
::$FILTER_HASH:
57 return $this->filterSmallHash($request);
59 case self
::$FILTER_TEXT:
60 return $this->filterFulltext($request, $privateonly);
62 case self
::$FILTER_TAG:
63 return $this->filterTags($request, $casesensitive, $privateonly);
65 case self
::$FILTER_DAY:
66 return $this->filterDay($request);
69 return $this->noFilter($privateonly);
74 * Unknown filter, but handle private only.
76 * @param bool $privateonly returns private link only if true.
78 * @return array filtered links.
80 private function noFilter($privateonly = false)
88 foreach ($this->links
as $value) {
89 if ($value['private']) {
90 $out[$value['linkdate']] = $value;
99 * Returns the shaare corresponding to a smallHash.
101 * @param string $smallHash permalink hash.
103 * @return array $filtered array containing permalink data.
105 private function filterSmallHash($smallHash)
108 foreach ($this->links
as $l) {
109 if ($smallHash == smallHash($l['linkdate'])) {
110 // Yes, this is ugly and slow
111 $filtered[$l['linkdate']] = $l;
119 * Returns the list of links corresponding to a full-text search
122 * - in the URLs, title and description;
123 * - are case-insensitive.
126 * print_r($mydb->filterFulltext('hollandais'));
128 * mb_convert_case($val, MB_CASE_LOWER, 'UTF-8')
129 * - allows to perform searches on Unicode text
130 * - see https://github.com/shaarli/Shaarli/issues/75 for examples
132 * @param string $searchterms search query.
133 * @param bool $privateonly return only private links if true.
135 * @return array search results.
137 private function filterFulltext($searchterms, $privateonly = false)
139 $search = mb_convert_case(html_entity_decode($searchterms), MB_CASE_LOWER
, 'UTF-8');
140 $explodedSearch = explode(' ', trim($search));
141 $keys = array('title', 'description', 'url', 'tags');
143 $searchExactPhrase = false;
145 // Check if we're using double-quotes to search for the exact string
146 if ($search[0] == '"' && $search[strlen($search) - 1] == '"') {
147 $searchExactPhrase = true;
149 // Remove the double-quotes as they are not what we search for
150 $search = substr($search, 1, -1);
152 // Iterate over every stored link.
153 foreach ($this->links
as $link) {
155 // ignore non private links when 'privatonly' is on.
156 if (! $link['private'] && $privateonly === true) {
160 // Iterate over searchable link fields.
161 foreach ($keys as $key) {
165 // FIXME: Find a better word for where you're searching in
166 $haystack = mb_convert_case($link[$key], MB_CASE_LOWER
, 'UTF-8');
168 // When searching for the phrase, check if it's in the haystack...
169 if ( $searchExactPhrase && strpos($haystack, $search) !== false) {
173 // Iterate over keywords, if keyword is not found,
174 // no need to check for the others. We want all or nothing.
175 foreach($explodedSearch as $keyword) {
176 if(strpos($haystack, $keyword) === false) {
183 // One of the fields of the link matches, no need to check the other.
190 $filtered[$link['linkdate']] = $link;
199 * Returns the list of links associated with a given list of tags
201 * You can specify one or more tags, separated by space or a comma, e.g.
202 * print_r($mydb->filterTags('linux programming'));
204 * @param string $tags list of tags separated by commas or blank spaces.
205 * @param bool $casesensitive ignore case if false.
206 * @param bool $privateonly returns private links only.
208 * @return array filtered links.
210 public function filterTags($tags, $casesensitive = false, $privateonly = false)
212 $searchtags = $this->tagsStrToArray($tags, $casesensitive);
215 foreach ($this->links
as $l) {
216 // ignore non private links when 'privatonly' is on.
217 if (! $l['private'] && $privateonly === true) {
221 $linktags = $this->tagsStrToArray($l['tags'], $casesensitive);
223 if (count(array_intersect($linktags, $searchtags)) == count($searchtags)) {
224 $filtered[$l['linkdate']] = $l;
232 * Returns the list of articles for a given day, chronologically sorted
234 * Day must be in the form 'YYYYMMDD' (e.g. '20120125'), e.g.
235 * print_r($mydb->filterDay('20120125'));
237 * @param string $day day to filter.
239 * @return array all link matching given day.
241 * @throws Exception if date format is invalid.
243 public function filterDay($day)
245 if (! checkDateFormat('Ymd', $day)) {
246 throw new Exception('Invalid date format');
250 foreach ($this->links
as $l) {
251 if (startsWith($l['linkdate'], $day)) {
252 $filtered[$l['linkdate']] = $l;
260 * Convert a list of tags (str) to an array. Also
261 * - handle case sensitivity.
262 * - accepts spaces commas as separator.
263 * - remove private tags for loggedout users.
265 * @param string $tags string containing a list of tags.
266 * @param bool $casesensitive will convert everything to lowercase if false.
268 * @return array filtered tags string.
270 public function tagsStrToArray($tags, $casesensitive)
272 // We use UTF-8 conversion to handle various graphemes (i.e. cyrillic, or greek)
273 $tagsOut = $casesensitive ? $tags : mb_convert_case($tags, MB_CASE_LOWER
, 'UTF-8');
274 $tagsOut = str_replace(',', ' ', $tagsOut);
276 return explode(' ', trim($tagsOut));