4 * @file src/Core/Acl.php
7 namespace Friendica\Core;
9 use Friendica\App\Page;
10 use Friendica\BaseObject;
11 use Friendica\Database\DBA;
13 use Friendica\Model\Contact;
14 use Friendica\Model\Group;
17 * Handle ACL management and display
19 * @author Hypolite Petovan <hypolite@mrpetovan.com>
21 class ACL extends BaseObject
24 * Returns a select input tag with all the contact of the local user
26 * @param string $selname Name attribute of the select input tag
27 * @param string $selclass Class attribute of the select input tag
28 * @param array $options Available options:
29 * - size: length of the select box
30 * - mutual_friends: Only used for the hook
31 * - single: Only used for the hook
32 * - exclude: Only used for the hook
33 * @param array $preselected Contact ID that should be already selected
37 public static function getSuggestContactSelectHTML($selname, $selclass, array $options = [], array $preselected = [])
43 $size = ($options['size'] ?? 0) ?: 4;
44 $mutual = !empty($options['mutual_friends']);
45 $single = !empty($options['single']) && empty($options['multiple']);
46 $exclude = $options['exclude'] ?? false;
48 switch (($options['networks'] ?? '') ?: Protocol::PHANTOM) {
50 $networks = [Protocol::DFRN];
54 $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA];
58 if (!empty($a->user['prvnets'])) {
59 $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA];
61 $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA, Protocol::OSTATUS];
65 default: /// @TODO Maybe log this call?
69 $x = ['options' => $options, 'size' => $size, 'single' => $single, 'mutual' => $mutual, 'exclude' => $exclude, 'networks' => $networks];
71 Hook::callAll('contact_select_options', $x);
77 if (!empty($x['mutual'])) {
78 $sql_extra .= sprintf(" AND `rel` = %d ", intval(Contact::FRIEND));
81 if (!empty($x['exclude'])) {
82 $sql_extra .= sprintf(" AND `id` != %d ", intval($x['exclude']));
85 if (!empty($x['networks'])) {
86 /// @TODO rewrite to foreach()
87 array_walk($x['networks'], function (&$value) {
88 $value = "'" . DBA::escape($value) . "'";
90 $str_nets = implode(',', $x['networks']);
91 $sql_extra .= " AND `network` IN ( $str_nets ) ";
94 $tabindex = (!empty($options['tabindex']) ? 'tabindex="' . $options["tabindex"] . '"' : '');
96 if (!empty($x['single'])) {
97 $o .= "<select name=\"$selname\" id=\"$selclass\" class=\"$selclass\" size=\"" . $x['size'] . "\" $tabindex >\r\n";
99 $o .= "<select name=\"{$selname}[]\" id=\"$selclass\" class=\"$selclass\" multiple=\"multiple\" size=\"" . $x['size'] . "$\" $tabindex >\r\n";
102 $stmt = DBA::p("SELECT `id`, `name`, `url`, `network` FROM `contact`
103 WHERE `uid` = ? AND NOT `self` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND NOT `deleted` AND `notify` != ''
105 ORDER BY `name` ASC ", intval(local_user())
108 $contacts = DBA::toArray($stmt);
110 $arr = ['contact' => $contacts, 'entry' => $o];
112 // e.g. 'network_pre_contact_deny', 'profile_pre_contact_allow'
113 Hook::callAll($a->module . '_pre_' . $selname, $arr);
115 if (DBA::isResult($contacts)) {
116 foreach ($contacts as $contact) {
117 if (in_array($contact['id'], $preselected)) {
118 $selected = ' selected="selected" ';
123 $trimmed = mb_substr($contact['name'], 0, 20);
125 $o .= "<option value=\"{$contact['id']}\" $selected title=\"{$contact['name']}|{$contact['url']}\" >$trimmed</option>\r\n";
129 $o .= '</select>' . PHP_EOL;
131 Hook::callAll($a->module . '_post_' . $selname, $o);
137 * Returns a select input tag with all the contact of the local user
139 * @param string $selname Name attribute of the select input tag
140 * @param string $selclass Class attribute of the select input tag
141 * @param array $preselected Contact IDs that should be already selected
142 * @param int $size Length of the select box
143 * @param int $tabindex Select input tag tabindex attribute
147 public static function getMessageContactSelectHTML($selname, $selclass, array $preselected = [], $size = 4, $tabindex = null)
153 // When used for private messages, we limit correspondence to mutual DFRN/Friendica friends and the selector
154 // to one recipient. By default our selector allows multiple selects amongst all contacts.
155 $sql_extra = sprintf(" AND `rel` = %d ", intval(Contact::FRIEND));
156 $sql_extra .= sprintf(" AND `network` IN ('%s' , '%s') ", Protocol::DFRN, Protocol::DIASPORA);
158 $tabindex_attr = !empty($tabindex) ? ' tabindex="' . intval($tabindex) . '"' : '';
160 $hidepreselected = '';
162 $sql_extra .= " AND `id` IN (" . implode(",", $preselected) . ")";
163 $hidepreselected = ' style="display: none;"';
166 $o .= "<select name=\"$selname\" id=\"$selclass\" class=\"$selclass\" size=\"$size\"$tabindex_attr$hidepreselected>\r\n";
168 $stmt = DBA::p("SELECT `id`, `name`, `url`, `network` FROM `contact`
169 WHERE `uid` = ? AND NOT `self` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND NOT `deleted` AND `notify` != ''
171 ORDER BY `name` ASC ", intval(local_user())
174 $contacts = DBA::toArray($stmt);
176 $arr = ['contact' => $contacts, 'entry' => $o];
178 // e.g. 'network_pre_contact_deny', 'profile_pre_contact_allow'
179 Hook::callAll($a->module . '_pre_' . $selname, $arr);
183 if (DBA::isResult($contacts)) {
184 foreach ($contacts as $contact) {
185 if (in_array($contact['id'], $preselected)) {
186 $selected = ' selected="selected"';
191 $trimmed = Protocol::formatMention($contact['url'], $contact['name']);
193 $receiverlist[] = $trimmed;
195 $o .= "<option value=\"{$contact['id']}\"$selected title=\"{$contact['name']}|{$contact['url']}\" >$trimmed</option>\r\n";
199 $o .= '</select>' . PHP_EOL;
202 $o .= implode(', ', $receiverlist);
205 Hook::callAll($a->module . '_post_' . $selname, $o);
210 private static function fixACL(&$item)
212 $item = intval(str_replace(['<', '>'], ['', ''], $item));
216 * Return the default permission of the provided user array
219 * @return array Hash of contact id lists
222 public static function getDefaultUserPermissions(array $user = null)
226 $acl_regex = '/<([0-9]+)>/i';
228 preg_match_all($acl_regex, $user['allow_cid'] ?? '', $matches);
229 $allow_cid = $matches[1];
230 preg_match_all($acl_regex, $user['allow_gid'] ?? '', $matches);
231 $allow_gid = $matches[1];
232 preg_match_all($acl_regex, $user['deny_cid'] ?? '', $matches);
233 $deny_cid = $matches[1];
234 preg_match_all($acl_regex, $user['deny_gid'] ?? '', $matches);
235 $deny_gid = $matches[1];
237 // Reformats the ACL data so that it is accepted by the JS frontend
238 array_walk($allow_cid, 'self::fixACL');
239 array_walk($allow_gid, 'self::fixACL');
240 array_walk($deny_cid, 'self::fixACL');
241 array_walk($deny_gid, 'self::fixACL');
243 Contact::pruneUnavailable($allow_cid);
246 'allow_cid' => $allow_cid,
247 'allow_gid' => $allow_gid,
248 'deny_cid' => $deny_cid,
249 'deny_gid' => $deny_gid,
254 * Returns the ACL list of contacts for a given user id
256 * @param int $user_id
260 public static function getContactListByUserId(int $user_id)
262 $fields = ['id', 'name', 'addr', 'micro'];
263 $params = ['order' => ['name']];
264 $acl_contacts = Contact::selectToArray($fields,
265 ['uid' => $user_id, 'self' => false, 'blocked' => false, 'archive' => false, 'deleted' => false,
266 'pending' => false, 'rel' => [Contact::FOLLOWER, Contact::FRIEND]], $params
269 $acl_forums = Contact::selectToArray($fields,
270 ['uid' => $user_id, 'self' => false, 'blocked' => false, 'archive' => false, 'deleted' => false,
271 'pending' => false, 'contact-type' => Contact::TYPE_COMMUNITY], $params
274 $acl_contacts = array_merge($acl_forums, $acl_contacts);
276 array_walk($acl_contacts, function (&$value) {
277 $value['type'] = 'contact';
280 return $acl_contacts;
284 * Returns the ACL list of groups (including meta-groups) for a given user id
286 * @param int $user_id
289 public static function getGroupListByUserId(int $user_id)
293 'id' => Group::FOLLOWERS,
294 'name' => L10n::t('Followers'),
296 'micro' => 'images/twopeople.png',
300 'id' => Group::MUTUALS,
301 'name' => L10n::t('Mutuals'),
303 'micro' => 'images/twopeople.png',
307 foreach (Group::getByUserId($user_id) as $group) {
309 'id' => $group['id'],
310 'name' => $group['name'],
312 'micro' => 'images/twopeople.png',
321 * Return the full jot ACL selector HTML
324 * @param array $user User array
325 * @param bool $for_federation
326 * @param array $default_permissions Static defaults permission array:
332 * 'hidewall' => true/false
335 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
337 public static function getFullSelectorHTML(Page $page, array $user = null, bool $for_federation = false, array $default_permissions = [])
339 if (empty($user['uid'])) {
343 $page->registerFooterScript(Theme::getPathForFile('asset/typeahead.js/dist/typeahead.bundle.js'));
344 $page->registerFooterScript(Theme::getPathForFile('js/friendica-tagsinput/friendica-tagsinput.js'));
345 $page->registerStylesheet(Theme::getPathForFile('js/friendica-tagsinput/friendica-tagsinput.css'));
346 $page->registerStylesheet(Theme::getPathForFile('js/friendica-tagsinput/friendica-tagsinput-typeahead.css'));
348 // Defaults user permissions
349 if (empty($default_permissions)) {
350 $default_permissions = self::getDefaultUserPermissions($user);
353 $default_permissions = [
354 'allow_cid' => $default_permissions['allow_cid'] ?? [],
355 'allow_gid' => $default_permissions['allow_gid'] ?? [],
356 'deny_cid' => $default_permissions['deny_cid'] ?? [],
357 'deny_gid' => $default_permissions['deny_gid'] ?? [],
358 'hidewall' => $default_permissions['hidewall'] ?? false,
361 if (count($default_permissions['allow_cid'])
362 + count($default_permissions['allow_gid'])
363 + count($default_permissions['deny_cid'])
364 + count($default_permissions['deny_gid'])) {
365 $visibility = 'custom';
367 $visibility = 'public';
368 // Default permission display for custom panel
369 $default_permissions['allow_gid'] = [Group::FOLLOWERS];
372 $jotnets_fields = [];
373 if ($for_federation) {
374 $mail_enabled = false;
375 $pubmail_enabled = false;
377 if (function_exists('imap_open') && !Config::get('system', 'imap_disabled')) {
378 $mailacct = DBA::selectFirst('mailacct', ['pubmail'], ['`uid` = ? AND `server` != ""', $user['uid']]);
379 if (DBA::isResult($mailacct)) {
380 $mail_enabled = true;
381 $pubmail_enabled = !empty($mailacct['pubmail']);
385 if (!$default_permissions['hidewall']) {
387 $jotnets_fields[] = [
388 'type' => 'checkbox',
391 L10n::t('Post to Email'),
397 Hook::callAll('jot_networks', $jotnets_fields);
401 $acl_contacts = self::getContactListByUserId($user['uid']);
403 $acl_groups = self::getGroupListByUserId($user['uid']);
405 $acl_list = array_merge($acl_groups, $acl_contacts);
407 $tpl = Renderer::getMarkupTemplate('acl_selector.tpl');
408 $o = Renderer::replaceMacros($tpl, [
409 '$public_title' => L10n::t('Public'),
410 '$public_desc' => L10n::t('This content will be shown to all your followers and can be seen in the community pages and by anyone with its link.'),
411 '$custom_title' => L10n::t('Limited/Private'),
412 '$custom_desc' => L10n::t('This content will be shown only to the people in the first box, to the exception of the people mentioned in the second box. It won\'t appear anywhere public.'),
413 '$allow_label' => L10n::t('Show to:'),
414 '$deny_label' => L10n::t('Except to:'),
415 '$emailcc' => L10n::t('CC: email addresses'),
416 '$emtitle' => L10n::t('Example: bob@example.com, mary@example.com'),
417 '$jotnets_summary' => L10n::t('Connectors'),
418 '$jotnets_disabled_label' => L10n::t('Connectors disabled, since "%s" is enabled.', L10n::t('Hide your profile details from unknown viewers?')),
419 '$visibility' => $visibility,
420 '$acl_contacts' => $acl_contacts,
421 '$acl_groups' => $acl_groups,
422 '$acl_list' => $acl_list,
423 '$contact_allow' => implode(',', $default_permissions['allow_cid']),
424 '$group_allow' => implode(',', $default_permissions['allow_gid']),
425 '$contact_deny' => implode(',', $default_permissions['deny_cid']),
426 '$group_deny' => implode(',', $default_permissions['deny_gid']),
427 '$for_federation' => $for_federation,
428 '$jotnets_fields' => $jotnets_fields,
429 '$user_hidewall' => $default_permissions['hidewall'],