3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Module\Search;
24 use Friendica\BaseModule;
25 use Friendica\Content\Widget;
26 use Friendica\Core\Hook;
27 use Friendica\Core\Logger;
28 use Friendica\Core\Protocol;
29 use Friendica\Core\Search;
30 use Friendica\Database\DBA;
32 use Friendica\Model\Contact;
33 use Friendica\Model\Item;
34 use Friendica\Network\HTTPException;
35 use Friendica\Util\Strings;
38 * ACL selector json backend
40 * @package Friendica\Module\Search
42 class Acl extends BaseModule
44 const TYPE_GLOBAL_CONTACT = 'x';
45 const TYPE_MENTION_CONTACT = 'c';
46 const TYPE_MENTION_GROUP = 'g';
47 const TYPE_MENTION_CONTACT_GROUP = '';
48 const TYPE_MENTION_FORUM = 'f';
49 const TYPE_PRIVATE_MESSAGE = 'm';
50 const TYPE_ANY_CONTACT = 'a';
52 public static function rawContent(array $parameters = [])
55 throw new HTTPException\UnauthorizedException(DI::l10n()->t('You must be logged in to use this module.'));
58 $type = $_REQUEST['type'] ?? self::TYPE_MENTION_CONTACT_GROUP;
59 if ($type === self::TYPE_GLOBAL_CONTACT) {
60 $o = self::globalContactSearch();
62 $o = self::regularContactSearch($type);
69 private static function globalContactSearch()
71 // autocomplete for global contact search (e.g. navbar search)
72 $search = Strings::escapeTags(trim($_REQUEST['search']));
73 $mode = $_REQUEST['smode'];
74 $page = $_REQUEST['page'] ?? 1;
76 $result = Search::searchContact($search, $mode, $page);
79 foreach ($result as $contact) {
81 'photo' => Contact::getMicro($contact),
82 'name' => htmlspecialchars($contact['name']),
83 'nick' => $contact['addr'] ?: $contact['url'],
84 'network' => $contact['network'],
85 'link' => $contact['url'],
86 'forum' => $contact['contact-type'] == Contact::TYPE_COMMUNITY,
91 'start' => ($page - 1) * 20,
99 private static function regularContactSearch(string $type)
101 $start = $_REQUEST['start'] ?? 0;
102 $count = $_REQUEST['count'] ?? 100;
103 $search = $_REQUEST['search'] ?? '';
104 $conv_id = $_REQUEST['conversation'] ?? null;
106 // For use with jquery.textcomplete for private mail completion
107 if (!empty($_REQUEST['query'])) {
109 $type = self::TYPE_PRIVATE_MESSAGE;
111 $search = $_REQUEST['query'];
114 Logger::info('ACL {action} - {subaction}', ['module' => 'acl', 'action' => 'content', 'subaction' => 'search', 'search' => $search, 'type' => $type, 'conversation' => $conv_id]);
120 $sql_extra = "AND `name` LIKE '%%" . DBA::escape($search) . "%%'";
121 $sql_extra2 = "AND (`attag` LIKE '%%" . DBA::escape($search) . "%%' OR `name` LIKE '%%" . DBA::escape($search) . "%%' OR `nick` LIKE '%%" . DBA::escape($search) . "%%')";
124 // count groups and contacts
126 if ($type == self::TYPE_MENTION_CONTACT_GROUP || $type == self::TYPE_MENTION_GROUP) {
127 $r = q("SELECT COUNT(*) AS g FROM `group` WHERE NOT `deleted` AND `uid` = %d $sql_extra",
130 $group_count = (int) $r[0]['g'];
133 $sql_extra2 .= ' ' . Widget::unavailableNetworks();
137 case self::TYPE_MENTION_CONTACT_GROUP:
138 case self::TYPE_MENTION_CONTACT:
139 // autocomplete for editor mentions
140 $r = q("SELECT COUNT(*) AS c FROM `contact`
141 WHERE `uid` = %d AND NOT `self` AND NOT `deleted`
142 AND NOT `blocked` AND NOT `pending` AND NOT `archive`
143 AND `notify` != '' $sql_extra2",
146 $contact_count = (int) $r[0]['c'];
149 case self::TYPE_MENTION_FORUM:
150 // autocomplete for editor mentions of forums
151 $r = q("SELECT COUNT(*) AS c FROM `contact`
152 WHERE `uid` = %d AND NOT `self` AND NOT `deleted`
153 AND NOT `blocked` AND NOT `pending` AND NOT `archive`
154 AND (`forum` OR `prv`)
155 AND `notify` != '' $sql_extra2",
158 $contact_count = (int) $r[0]['c'];
161 case self::TYPE_PRIVATE_MESSAGE:
162 // autocomplete for Private Messages
163 $r = q("SELECT COUNT(*) AS c FROM `contact`
164 WHERE `uid` = %d AND NOT `self` AND NOT `deleted`
165 AND NOT `blocked` AND NOT `pending` AND NOT `archive`
166 AND `network` IN ('%s', '%s', '%s') $sql_extra2",
167 intval(local_user()),
168 DBA::escape(Protocol::ACTIVITYPUB),
169 DBA::escape(Protocol::DFRN),
170 DBA::escape(Protocol::DIASPORA)
172 $contact_count = (int) $r[0]['c'];
175 case self::TYPE_ANY_CONTACT:
177 // autocomplete for Contacts
178 $r = q("SELECT COUNT(*) AS c FROM `contact`
179 WHERE `uid` = %d AND NOT `self`
180 AND NOT `pending` AND NOT `deleted` $sql_extra2",
183 $contact_count = (int) $r[0]['c'];
187 $tot = $group_count + $contact_count;
192 if ($type == self::TYPE_MENTION_CONTACT_GROUP || $type == self::TYPE_MENTION_GROUP) {
193 /// @todo We should cache this query.
194 // This can be done when we can delete cache entries via wildcard
195 $r = q("SELECT `group`.`id`, `group`.`name`, GROUP_CONCAT(DISTINCT `group_member`.`contact-id` SEPARATOR ',') AS uids
197 INNER JOIN `group_member` ON `group_member`.`gid`=`group`.`id`
198 WHERE NOT `group`.`deleted` AND `group`.`uid` = %d
200 GROUP BY `group`.`name`, `group`.`id`
201 ORDER BY `group`.`name`
203 intval(local_user()),
211 'photo' => 'images/twopeople.png',
212 'name' => htmlspecialchars($g['name']),
213 'id' => intval($g['id']),
214 'uids' => array_map('intval', explode(',', $g['uids'])),
219 if ((count($groups) > 0) && ($search == '')) {
220 $groups[] = ['separator' => true];
226 case self::TYPE_MENTION_CONTACT_GROUP:
227 $r = q("SELECT `id`, `name`, `nick`, `avatar`, `micro`, `network`, `url`, `attag`, `addr`, `forum`, `prv`, (`prv` OR `forum`) AS `frm` FROM `contact`
228 WHERE `uid` = %d AND NOT `self` AND NOT `deleted` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND `notify` != ''
229 AND NOT (`network` IN ('%s', '%s'))
232 intval(local_user()),
233 DBA::escape(Protocol::OSTATUS),
234 DBA::escape(Protocol::STATUSNET)
238 case self::TYPE_MENTION_CONTACT:
239 $r = q("SELECT `id`, `name`, `nick`, `avatar`, `micro`, `network`, `url`, `attag`, `addr`, `forum`, `prv` FROM `contact`
240 WHERE `uid` = %d AND NOT `self` AND NOT `deleted` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND `notify` != ''
241 AND NOT (`network` IN ('%s'))
244 intval(local_user()),
245 DBA::escape(Protocol::STATUSNET)
249 case self::TYPE_MENTION_FORUM:
250 $r = q("SELECT `id`, `name`, `nick`, `avatar`, `micro`, `network`, `url`, `attag`, `addr`, `forum`, `prv` FROM `contact`
251 WHERE `uid` = %d AND NOT `self` AND NOT `deleted` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND `notify` != ''
252 AND NOT (`network` IN ('%s'))
253 AND (`forum` OR `prv`)
256 intval(local_user()),
257 DBA::escape(Protocol::STATUSNET)
261 case self::TYPE_PRIVATE_MESSAGE:
262 $r = q("SELECT `id`, `name`, `nick`, `avatar`, `micro`, `network`, `url`, `attag`, `addr` FROM `contact`
263 WHERE `uid` = %d AND NOT `self` AND NOT `deleted` AND NOT `blocked` AND NOT `pending` AND NOT `archive`
264 AND `network` IN ('%s', '%s', '%s')
267 intval(local_user()),
268 DBA::escape(Protocol::ACTIVITYPUB),
269 DBA::escape(Protocol::DFRN),
270 DBA::escape(Protocol::DIASPORA)
274 case self::TYPE_ANY_CONTACT:
276 $r = q("SELECT `id`, `name`, `nick`, `avatar`, `micro`, `network`, `url`, `attag`, `addr`, `forum`, `prv`, `avatar` FROM `contact`
277 WHERE `uid` = %d AND NOT `deleted` AND NOT `pending` AND NOT `archive`
285 if (DBA::isResult($r)) {
290 'photo' => Contact::getMicro($g),
291 'name' => htmlspecialchars($g['name']),
292 'id' => intval($g['id']),
293 'network' => $g['network'],
295 'nick' => htmlentities(($g['attag'] ?? '') ?: $g['nick']),
296 'addr' => htmlentities(($g['addr'] ?? '') ?: $g['url']),
297 'forum' => !empty($g['forum']) || !empty($g['prv']) ? 1 : 0,
299 if ($entry['forum']) {
302 $contacts[] = $entry;
305 if (count($forums) > 0) {
307 $forums[] = ['separator' => true];
309 $contacts = array_merge($forums, $contacts);
313 $items = array_merge($groups, $contacts);
316 // In multi threaded posts the conv_id is not the parent of the whole thread
317 $parent_item = Item::selectFirst(['parent'], ['id' => $conv_id]);
318 if (DBA::isResult($parent_item)) {
319 $conv_id = $parent_item['parent'];
323 * if $conv_id is set, get unknown contacts in thread
324 * but first get known contacts url to filter them out
326 $known_contacts = array_map(function ($i) {
330 $unknown_contacts = [];
332 $condition = ["`parent` = ?", $conv_id];
333 $params = ['order' => ['author-name' => true]];
334 $authors = Item::selectForUser(local_user(), ['author-link'], $condition, $params);
336 while ($author = Item::fetch($authors)) {
337 $item_authors[$author['author-link']] = $author['author-link'];
339 DBA::close($authors);
341 foreach ($item_authors as $author) {
342 if (in_array($author, $known_contacts)) {
346 $contact = Contact::getByURL($author, false, ['micro', 'name', 'id', 'network', 'nick', 'addr', 'url', 'forum', 'avatar']);
348 if (count($contact) > 0) {
349 $unknown_contacts[] = [
351 'photo' => Contact::getMicro($contact),
352 'name' => htmlspecialchars($contact['name']),
353 'id' => intval($contact['cid']),
354 'network' => $contact['network'],
355 'link' => $contact['url'],
356 'nick' => htmlentities(($contact['nick'] ?? '') ?: $contact['addr']),
357 'addr' => htmlentities(($contact['addr'] ?? '') ?: $contact['url']),
358 'forum' => $contact['forum']
363 $items = array_merge($items, $unknown_contacts);
364 $tot += count($unknown_contacts);
372 'contacts' => $contacts,
378 Hook::callAll('acl_lookup_end', $results);
381 'tot' => $results['tot'],
382 'start' => $results['start'],
383 'count' => $results['count'],
384 'items' => $results['items'],