<?php
-
/**
- * @file src/Core/Acl.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
namespace Friendica\Core;
-use Friendica\BaseObject;
-use Friendica\Content\Feature;
-use Friendica\Core\Protocol;
-use Friendica\Core\Renderer;
+use Friendica\App\Page;
use Friendica\Database\DBA;
+use Friendica\DI;
use Friendica\Model\Contact;
-use Friendica\Model\GContact;
-use Friendica\Util\Network;
+use Friendica\Model\Group;
/**
* Handle ACL management and display
- *
- * @author Hypolite Petovan <hypolite@mrpetovan.com>
*/
-class ACL extends BaseObject
+class ACL
{
- /**
- * Returns a select input tag with all the contact of the local user
- *
- * @param string $selname Name attribute of the select input tag
- * @param string $selclass Class attribute of the select input tag
- * @param array $options Available options:
- * - size: length of the select box
- * - mutual_friends: Only used for the hook
- * - single: Only used for the hook
- * - exclude: Only used for the hook
- * @param array $preselected Contact ID that should be already selected
- * @return string
- */
- public static function getSuggestContactSelectHTML($selname, $selclass, array $options = [], array $preselected = [])
- {
- $a = self::getApp();
-
- $networks = null;
-
- $size = defaults($options, 'size', 4);
- $mutual = !empty($options['mutual_friends']);
- $single = !empty($options['single']) && empty($options['multiple']);
- $exclude = defaults($options, 'exclude', false);
-
- switch (defaults($options, 'networks', Protocol::PHANTOM)) {
- case 'DFRN_ONLY':
- $networks = [Protocol::DFRN];
- break;
-
- case 'PRIVATE':
- $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA];
- break;
-
- case 'TWO_WAY':
- if (!empty($a->user['prvnets'])) {
- $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA];
- } else {
- $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA, Protocol::OSTATUS];
- }
- break;
-
- default: /// @TODO Maybe log this call?
- break;
- }
-
- $x = ['options' => $options, 'size' => $size, 'single' => $single, 'mutual' => $mutual, 'exclude' => $exclude, 'networks' => $networks];
-
- Addon::callHooks('contact_select_options', $x);
-
- $o = '';
-
- $sql_extra = '';
-
- if (!empty($x['mutual'])) {
- $sql_extra .= sprintf(" AND `rel` = %d ", intval(Contact::FRIEND));
- }
-
- if (!empty($x['exclude'])) {
- $sql_extra .= sprintf(" AND `id` != %d ", intval($x['exclude']));
- }
-
- if (!empty($x['networks'])) {
- /// @TODO rewrite to foreach()
- array_walk($x['networks'], function (&$value) {
- $value = "'" . DBA::escape($value) . "'";
- });
- $str_nets = implode(',', $x['networks']);
- $sql_extra .= " AND `network` IN ( $str_nets ) ";
- }
-
- $tabindex = (!empty($options['tabindex']) ? 'tabindex="' . $options["tabindex"] . '"' : '');
-
- if (!empty($x['single'])) {
- $o .= "<select name=\"$selname\" id=\"$selclass\" class=\"$selclass\" size=\"" . $x['size'] . "\" $tabindex >\r\n";
- } else {
- $o .= "<select name=\"{$selname}[]\" id=\"$selclass\" class=\"$selclass\" multiple=\"multiple\" size=\"" . $x['size'] . "$\" $tabindex >\r\n";
- }
-
- $stmt = DBA::p("SELECT `id`, `name`, `url`, `network` FROM `contact`
- WHERE `uid` = ? AND NOT `self` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND `notify` != ''
- $sql_extra
- ORDER BY `name` ASC ", intval(local_user())
- );
-
- $contacts = DBA::toArray($stmt);
-
- $arr = ['contact' => $contacts, 'entry' => $o];
-
- // e.g. 'network_pre_contact_deny', 'profile_pre_contact_allow'
- Addon::callHooks($a->module . '_pre_' . $selname, $arr);
-
- if (DBA::isResult($contacts)) {
- foreach ($contacts as $contact) {
- if (in_array($contact['id'], $preselected)) {
- $selected = ' selected="selected" ';
- } else {
- $selected = '';
- }
-
- $trimmed = mb_substr($contact['name'], 0, 20);
-
- $o .= "<option value=\"{$contact['id']}\" $selected title=\"{$contact['name']}|{$contact['url']}\" >$trimmed</option>\r\n";
- }
- }
-
- $o .= '</select>' . PHP_EOL;
-
- Addon::callHooks($a->module . '_post_' . $selname, $o);
-
- return $o;
- }
-
/**
* Returns a select input tag with all the contact of the local user
*
* @param int $size Length of the select box
* @param int $tabindex Select input tag tabindex attribute
* @return string
+ * @throws \Exception
*/
public static function getMessageContactSelectHTML($selname, $selclass, array $preselected = [], $size = 4, $tabindex = null)
{
- $a = self::getApp();
+ $a = DI::app();
$o = '';
$o .= "<select name=\"$selname\" id=\"$selclass\" class=\"$selclass\" size=\"$size\"$tabindex_attr$hidepreselected>\r\n";
$stmt = DBA::p("SELECT `id`, `name`, `url`, `network` FROM `contact`
- WHERE `uid` = ? AND NOT `self` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND `notify` != ''
+ WHERE `uid` = ? AND NOT `self` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND NOT `deleted` AND `notify` != ''
$sql_extra
ORDER BY `name` ASC ", intval(local_user())
);
$arr = ['contact' => $contacts, 'entry' => $o];
// e.g. 'network_pre_contact_deny', 'profile_pre_contact_allow'
- Addon::callHooks($a->module . '_pre_' . $selname, $arr);
+ Hook::callAll(DI::module()->getName() . '_pre_' . $selname, $arr);
$receiverlist = [];
$o .= implode(', ', $receiverlist);
}
- Addon::callHooks($a->module . '_post_' . $selname, $o);
+ Hook::callAll(DI::module()->getName() . '_post_' . $selname, $o);
return $o;
}
- private static function fixACL(&$item)
- {
- $item = intval(str_replace(['<', '>'], ['', ''], $item));
- }
-
/**
* Return the default permission of the provided user array
*
* @param array $user
* @return array Hash of contact id lists
+ * @throws \Exception
*/
public static function getDefaultUserPermissions(array $user = null)
{
- $matches = [];
+ $aclFormatter = DI::aclFormatter();
- $acl_regex = '/<([0-9]+)>/i';
+ return [
+ 'allow_cid' => Contact::pruneUnavailable($aclFormatter->expand($user['allow_cid'] ?? '')),
+ 'allow_gid' => $aclFormatter->expand($user['allow_gid'] ?? ''),
+ 'deny_cid' => $aclFormatter->expand($user['deny_cid'] ?? ''),
+ 'deny_gid' => $aclFormatter->expand($user['deny_gid'] ?? ''),
+ ];
+ }
- preg_match_all($acl_regex, defaults($user, 'allow_cid', ''), $matches);
- $allow_cid = $matches[1];
- preg_match_all($acl_regex, defaults($user, 'allow_gid', ''), $matches);
- $allow_gid = $matches[1];
- preg_match_all($acl_regex, defaults($user, 'deny_cid', ''), $matches);
- $deny_cid = $matches[1];
- preg_match_all($acl_regex, defaults($user, 'deny_gid', ''), $matches);
- $deny_gid = $matches[1];
+ /**
+ * Returns the ACL list of contacts for a given user id
+ *
+ * @param int $user_id
+ * @param array $condition Additional contact lookup table conditions
+ * @return array
+ * @throws \Exception
+ */
+ public static function getContactListByUserId(int $user_id, array $condition = [])
+ {
+ $fields = ['id', 'name', 'addr', 'micro'];
+ $params = ['order' => ['name']];
+ $acl_contacts = Contact::selectToArray(
+ $fields,
+ array_merge([
+ 'uid' => $user_id,
+ 'self' => false,
+ 'blocked' => false,
+ 'archive' => false,
+ 'deleted' => false,
+ 'pending' => false,
+ 'rel' => [Contact::FOLLOWER, Contact::FRIEND]
+ ], $condition),
+ $params
+ );
- // Reformats the ACL data so that it is accepted by the JS frontend
- array_walk($allow_cid, 'self::fixACL');
- array_walk($allow_gid, 'self::fixACL');
- array_walk($deny_cid, 'self::fixACL');
- array_walk($deny_gid, 'self::fixACL');
+ $acl_yourself = Contact::selectFirst($fields, ['uid' => $user_id, 'self' => true]);
+ $acl_yourself['name'] = DI::l10n()->t('Yourself');
- Contact::pruneUnavailable($allow_cid);
+ $acl_contacts[] = $acl_yourself;
- return [
- 'allow_cid' => $allow_cid,
- 'allow_gid' => $allow_gid,
- 'deny_cid' => $deny_cid,
- 'deny_gid' => $deny_gid,
+ $acl_forums = Contact::selectToArray($fields,
+ ['uid' => $user_id, 'self' => false, 'blocked' => false, 'archive' => false, 'deleted' => false,
+ 'pending' => false, 'contact-type' => Contact::TYPE_COMMUNITY], $params
+ );
+
+ $acl_contacts = array_merge($acl_forums, $acl_contacts);
+
+ array_walk($acl_contacts, function (&$value) {
+ $value['type'] = 'contact';
+ });
+
+ return $acl_contacts;
+ }
+
+ /**
+ * Returns the ACL list of groups (including meta-groups) for a given user id
+ *
+ * @param int $user_id
+ * @return array
+ */
+ public static function getGroupListByUserId(int $user_id)
+ {
+ $acl_groups = [
+ [
+ 'id' => Group::FOLLOWERS,
+ 'name' => DI::l10n()->t('Followers'),
+ 'addr' => '',
+ 'micro' => 'images/twopeople.png',
+ 'type' => 'group',
+ ],
+ [
+ 'id' => Group::MUTUALS,
+ 'name' => DI::l10n()->t('Mutuals'),
+ 'addr' => '',
+ 'micro' => 'images/twopeople.png',
+ 'type' => 'group',
+ ]
];
+ foreach (Group::getByUserId($user_id) as $group) {
+ $acl_groups[] = [
+ 'id' => $group['id'],
+ 'name' => $group['name'],
+ 'addr' => '',
+ 'micro' => 'images/twopeople.png',
+ 'type' => 'group',
+ ];
+ }
+
+ return $acl_groups;
}
/**
* Return the full jot ACL selector HTML
*
- * @param array $user User array
- * @param array $default_permissions Static defaults permission array: ['allow_cid' => '', 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '']
- * @param bool $show_jotnets
+ * @param Page $page
+ * @param array $user User array
+ * @param bool $for_federation
+ * @param array $default_permissions Static defaults permission array:
+ * [
+ * 'allow_cid' => [],
+ * 'allow_gid' => [],
+ * 'deny_cid' => [],
+ * 'deny_gid' => [],
+ * 'hidewall' => true/false
+ * ]
+ * @param array $condition
+ * @param string $form_prefix
* @return string
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function getFullSelectorHTML(array $user, $show_jotnets = false, array $default_permissions = [])
- {
+ public static function getFullSelectorHTML(
+ Page $page,
+ array $user = null,
+ bool $for_federation = false,
+ array $default_permissions = [],
+ array $condition = [],
+ $form_prefix = ''
+ ) {
+ if (empty($user['uid'])) {
+ return '';
+ }
+
+ static $input_group_id = 0;
+
+ $input_group_id++;
+
+ $page->registerFooterScript(Theme::getPathForFile('asset/typeahead.js/dist/typeahead.bundle.js'));
+ $page->registerFooterScript(Theme::getPathForFile('js/friendica-tagsinput/friendica-tagsinput.js'));
+ $page->registerStylesheet(Theme::getPathForFile('js/friendica-tagsinput/friendica-tagsinput.css'));
+ $page->registerStylesheet(Theme::getPathForFile('js/friendica-tagsinput/friendica-tagsinput-typeahead.css'));
+
// Defaults user permissions
if (empty($default_permissions)) {
$default_permissions = self::getDefaultUserPermissions($user);
}
- $jotnets = '';
- if ($show_jotnets) {
- $imap_disabled = !function_exists('imap_open') || Config::get('system', 'imap_disabled');
+ $default_permissions = [
+ 'allow_cid' => $default_permissions['allow_cid'] ?? [],
+ 'allow_gid' => $default_permissions['allow_gid'] ?? [],
+ 'deny_cid' => $default_permissions['deny_cid'] ?? [],
+ 'deny_gid' => $default_permissions['deny_gid'] ?? [],
+ 'hidewall' => $default_permissions['hidewall'] ?? false,
+ ];
+
+ if (count($default_permissions['allow_cid'])
+ + count($default_permissions['allow_gid'])
+ + count($default_permissions['deny_cid'])
+ + count($default_permissions['deny_gid'])) {
+ $visibility = 'custom';
+ } else {
+ $visibility = 'public';
+ // Default permission display for custom panel
+ $default_permissions['allow_gid'] = [Group::FOLLOWERS];
+ }
+ $jotnets_fields = [];
+ if ($for_federation) {
$mail_enabled = false;
$pubmail_enabled = false;
- if (!$imap_disabled) {
- $mailacct = DBA::selectFirst('mailacct', ['pubmail'], ['`uid` = ? AND `server` != ""', local_user()]);
+ if (function_exists('imap_open') && !DI::config()->get('system', 'imap_disabled')) {
+ $mailacct = DBA::selectFirst('mailacct', ['pubmail'], ['`uid` = ? AND `server` != ""', $user['uid']]);
if (DBA::isResult($mailacct)) {
$mail_enabled = true;
$pubmail_enabled = !empty($mailacct['pubmail']);
}
}
- if (empty($default_permissions['hidewall'])) {
+ if (!$default_permissions['hidewall']) {
if ($mail_enabled) {
- $selected = $pubmail_enabled ? ' checked="checked"' : '';
- $jotnets .= '<div class="profile-jot-net"><input type="checkbox" name="pubmail_enable"' . $selected . ' value="1" /> ' . L10n::t("Post to Email") . '</div>';
+ $jotnets_fields[] = [
+ 'type' => 'checkbox',
+ 'field' => [
+ 'pubmail_enable',
+ DI::l10n()->t('Post to Email'),
+ $pubmail_enabled
+ ]
+ ];
}
- Addon::callHooks('jot_networks', $jotnets);
- } else {
- $jotnets .= L10n::t('Connectors disabled, since "%s" is enabled.',
- L10n::t('Hide your profile details from unknown viewers?'));
+ Hook::callAll('jot_networks', $jotnets_fields);
}
}
- $tpl = Renderer::getMarkupTemplate('acl_selector.tpl');
- $o = Renderer::replaceMacros($tpl, [
- '$showall' => L10n::t('Visible to everybody'),
- '$show' => L10n::t('show'),
- '$hide' => L10n::t('don\'t show'),
- '$allowcid' => json_encode(defaults($default_permissions, 'allow_cid', '')),
- '$allowgid' => json_encode(defaults($default_permissions, 'allow_gid', '')),
- '$denycid' => json_encode(defaults($default_permissions, 'deny_cid', '')),
- '$denygid' => json_encode(defaults($default_permissions, 'deny_gid', '')),
- '$networks' => $show_jotnets,
- '$emailcc' => L10n::t('CC: email addresses'),
- '$emtitle' => L10n::t('Example: bob@example.com, mary@example.com'),
- '$jotnets' => $jotnets,
- '$aclModalTitle' => L10n::t('Permissions'),
- '$aclModalDismiss' => L10n::t('Close'),
- '$features' => [
- 'aclautomention' => Feature::isEnabled($user['uid'], 'aclautomention') ? 'true' : 'false'
- ],
- ]);
+ $acl_contacts = self::getContactListByUserId($user['uid'], $condition);
- return $o;
- }
+ $acl_groups = self::getGroupListByUserId($user['uid']);
- /**
- * Searching for global contacts for autocompletion
- *
- * @brief Searching for global contacts for autocompletion
- * @param string $search Name or part of a name or nick
- * @param string $mode Search mode (e.g. "community")
- * @return array with the search results
- */
- public static function contactAutocomplete($search, $mode)
- {
- if (Config::get('system', 'block_public') && !local_user() && !remote_user()) {
- return [];
- }
-
- // don't search if search term has less than 2 characters
- if (!$search || mb_strlen($search) < 2) {
- return [];
- }
+ $acl_list = array_merge($acl_groups, $acl_contacts);
- if (substr($search, 0, 1) === '@') {
- $search = substr($search, 1);
- }
-
- // check if searching in the local global contact table is enabled
- if (Config::get('system', 'poco_local_search')) {
- $return = GContact::searchByName($search, $mode);
- } else {
- $p = defaults($_GET, 'page', 1) != 1 ? '&p=' . defaults($_GET, 'page', 1) : '';
+ $input_names = [
+ 'visibility' => $form_prefix ? $form_prefix . '[visibility]' : 'visibility',
+ 'group_allow' => $form_prefix ? $form_prefix . '[group_allow]' : 'group_allow',
+ 'contact_allow' => $form_prefix ? $form_prefix . '[contact_allow]' : 'contact_allow',
+ 'group_deny' => $form_prefix ? $form_prefix . '[group_deny]' : 'group_deny',
+ 'contact_deny' => $form_prefix ? $form_prefix . '[contact_deny]' : 'contact_deny',
+ 'emailcc' => $form_prefix ? $form_prefix . '[emailcc]' : 'emailcc',
+ ];
- $curlResult = Network::curl(get_server() . '/lsearch?f=' . $p . '&search=' . urlencode($search));
- if ($curlResult->isSuccess()) {
- $lsearch = json_decode($curlResult->getBody(), true);
- if (!empty($lsearch['results'])) {
- $return = $lsearch['results'];
- }
- }
- }
+ $tpl = Renderer::getMarkupTemplate('acl_selector.tpl');
+ $o = Renderer::replaceMacros($tpl, [
+ '$public_title' => DI::l10n()->t('Public'),
+ '$public_desc' => DI::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.'),
+ '$custom_title' => DI::l10n()->t('Limited/Private'),
+ '$custom_desc' => DI::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.'),
+ '$allow_label' => DI::l10n()->t('Show to:'),
+ '$deny_label' => DI::l10n()->t('Except to:'),
+ '$emailcc' => DI::l10n()->t('CC: email addresses'),
+ '$emtitle' => DI::l10n()->t('Example: bob@example.com, mary@example.com'),
+ '$jotnets_summary' => DI::l10n()->t('Connectors'),
+ '$jotnets_disabled_label' => DI::l10n()->t('Connectors disabled, since "%s" is enabled.', DI::l10n()->t('Hide your profile details from unknown viewers?')),
+ '$visibility' => $visibility,
+ '$acl_contacts' => $acl_contacts,
+ '$acl_groups' => $acl_groups,
+ '$acl_list' => $acl_list,
+ '$contact_allow' => implode(',', $default_permissions['allow_cid']),
+ '$group_allow' => implode(',', $default_permissions['allow_gid']),
+ '$contact_deny' => implode(',', $default_permissions['deny_cid']),
+ '$group_deny' => implode(',', $default_permissions['deny_gid']),
+ '$for_federation' => $for_federation,
+ '$jotnets_fields' => $jotnets_fields,
+ '$user_hidewall' => $default_permissions['hidewall'],
+ '$input_names' => $input_names,
+ '$input_group_id' => $input_group_id,
+ ]);
- return defaults($return, []);
+ return $o;
}
}