]>
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;
124 * - terms surrounded by quotes " are exact terms search.
125 * - terms starting with a dash - are excluded (except exact terms).
128 * print_r($mydb->filterFulltext('hollandais'));
130 * mb_convert_case($val, MB_CASE_LOWER, 'UTF-8')
131 * - allows to perform searches on Unicode text
132 * - see https://github.com/shaarli/Shaarli/issues/75 for examples
134 * @param string $searchterms search query.
135 * @param bool $privateonly return only private links if true.
137 * @return array search results.
139 private function filterFulltext($searchterms, $privateonly = false)
142 $search = mb_convert_case(html_entity_decode($searchterms), MB_CASE_LOWER
, 'UTF-8');
143 $exactRegex = '/"([^"]+)"/';
144 // Retrieve exact search terms.
145 preg_match_all($exactRegex, $search, $exactSearch);
146 $exactSearch = array_values(array_filter($exactSearch[1]));
148 // Remove exact search terms to get AND terms search.
149 $explodedSearchAnd = explode(' ', trim(preg_replace($exactRegex, '', $search)));
150 $explodedSearchAnd = array_values(array_filter($explodedSearchAnd));
152 // Filter excluding terms and update andSearch.
153 $excludeSearch = array();
154 $andSearch = array();
155 foreach ($explodedSearchAnd as $needle) {
156 if ($needle[0] == '-' && strlen($needle) > 1) {
157 $excludeSearch[] = substr($needle, 1);
159 $andSearch[] = $needle;
163 $keys = array('title', 'description', 'url', 'tags');
165 // Iterate over every stored link.
166 foreach ($this->links
as $link) {
168 // ignore non private links when 'privatonly' is on.
169 if (! $link['private'] && $privateonly === true) {
173 // Concatenate link fields to search across fields.
174 // Adds a '\' separator for exact search terms.
176 foreach ($keys as $key) {
177 $content .= mb_convert_case($link[$key], MB_CASE_LOWER
, 'UTF-8') . '\\';
183 // First, we look for exact term search
184 for ($i = 0; $i < count($exactSearch) && $found; $i++
) {
185 $found = strpos($content, $exactSearch[$i]) !== false;
188 // Iterate over keywords, if keyword is not found,
189 // no need to check for the others. We want all or nothing.
190 for ($i = 0; $i < count($andSearch) && $found; $i++
) {
191 $found = strpos($content, $andSearch[$i]) !== false;
195 for ($i = 0; $i < count($excludeSearch) && $found; $i++
) {
196 $found = strpos($content, $excludeSearch[$i]) === false;
200 $filtered[$link['linkdate']] = $link;
209 * Returns the list of links associated with a given list of tags
211 * You can specify one or more tags, separated by space or a comma, e.g.
212 * print_r($mydb->filterTags('linux programming'));
214 * @param string $tags list of tags separated by commas or blank spaces.
215 * @param bool $casesensitive ignore case if false.
216 * @param bool $privateonly returns private links only.
218 * @return array filtered links.
220 public function filterTags($tags, $casesensitive = false, $privateonly = false)
222 $searchtags = self
::tagsStrToArray($tags, $casesensitive);
224 if (empty($searchtags)) {
228 foreach ($this->links
as $link) {
229 // ignore non private links when 'privatonly' is on.
230 if (! $link['private'] && $privateonly === true) {
234 $linktags = self
::tagsStrToArray($link['tags'], $casesensitive);
237 for ($i = 0 ; $i < count($searchtags) && $found; $i++
) {
238 // Exclusive search, quit if tag found.
239 // Or, tag not found in the link, quit.
240 if (($searchtags[$i][0] == '-' && in_array(substr($searchtags[$i], 1), $linktags))
241 || ($searchtags[$i][0] != '-') && ! in_array($searchtags[$i], $linktags)
248 $filtered[$link['linkdate']] = $link;
256 * Returns the list of articles for a given day, chronologically sorted
258 * Day must be in the form 'YYYYMMDD' (e.g. '20120125'), e.g.
259 * print_r($mydb->filterDay('20120125'));
261 * @param string $day day to filter.
263 * @return array all link matching given day.
265 * @throws Exception if date format is invalid.
267 public function filterDay($day)
269 if (! checkDateFormat('Ymd', $day)) {
270 throw new Exception('Invalid date format');
274 foreach ($this->links
as $l) {
275 if (startsWith($l['linkdate'], $day)) {
276 $filtered[$l['linkdate']] = $l;
284 * Convert a list of tags (str) to an array. Also
285 * - handle case sensitivity.
286 * - accepts spaces commas as separator.
288 * @param string $tags string containing a list of tags.
289 * @param bool $casesensitive will convert everything to lowercase if false.
291 * @return array filtered tags string.
293 public static function tagsStrToArray($tags, $casesensitive)
295 // We use UTF-8 conversion to handle various graphemes (i.e. cyrillic, or greek)
296 $tagsOut = $casesensitive ? $tags : mb_convert_case($tags, MB_CASE_LOWER
, 'UTF-8');
297 $tagsOut = str_replace(',', ' ', $tagsOut);
299 return array_filter(explode(' ', trim($tagsOut)), 'strlen');