src/Core/ACL.php

   1 <?php
   2
   3 /**
   4  * @file src/Core/Acl.php
   5  */
   6
   7 namespace Friendica\Core;
   8
   9 use Friendica\App\Page;
  10 use Friendica\BaseObject;
  11 use Friendica\Database\DBA;
  12 use Friendica\Model\Contact;
  13 use Friendica\Model\Group;
  14
  15 /**
  16  * Handle ACL management and display
  17  *
  18  * @author Hypolite Petovan <hypolite@mrpetovan.com>
  19  */
  20 class ACL extends BaseObject
  21 {
  22         /**
  23          * Returns a select input tag with all the contact of the local user
  24          *
  25          * @param string $selname     Name attribute of the select input tag
  26          * @param string $selclass    Class attribute of the select input tag
  27          * @param array  $options     Available options:
  28          *                            - size: length of the select box
  29          *                            - mutual_friends: Only used for the hook
  30          *                            - single: Only used for the hook
  31          *                            - exclude: Only used for the hook
  32          * @param array  $preselected Contact ID that should be already selected
  33          * @return string
  34          * @throws \Exception
  35          */
  36         public static function getSuggestContactSelectHTML($selname, $selclass, array $options = [], array $preselected = [])
  37         {
  38                 $a = self::getApp();
  39
  40                 $networks = null;
  41
  42                 $size = ($options['size'] ?? 0) ?: 4;
  43                 $mutual = !empty($options['mutual_friends']);
  44                 $single = !empty($options['single']) && empty($options['multiple']);
  45                 $exclude = $options['exclude'] ?? false;
  46
  47                 switch (($options['networks'] ?? '') ?: Protocol::PHANTOM) {
  48                         case 'DFRN_ONLY':
  49                                 $networks = [Protocol::DFRN];
  50                                 break;
  51
  52                         case 'PRIVATE':
  53                                 $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA];
  54                                 break;
  55
  56                         case 'TWO_WAY':
  57                                 if (!empty($a->user['prvnets'])) {
  58                                         $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA];
  59                                 } else {
  60                                         $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA, Protocol::OSTATUS];
  61                                 }
  62                                 break;
  63
  64                         default: /// @TODO Maybe log this call?
  65                                 break;
  66                 }
  67
  68                 $x = ['options' => $options, 'size' => $size, 'single' => $single, 'mutual' => $mutual, 'exclude' => $exclude, 'networks' => $networks];
  69
  70                 Hook::callAll('contact_select_options', $x);
  71
  72                 $o = '';
  73
  74                 $sql_extra = '';
  75
  76                 if (!empty($x['mutual'])) {
  77                         $sql_extra .= sprintf(" AND `rel` = %d ", intval(Contact::FRIEND));
  78                 }
  79
  80                 if (!empty($x['exclude'])) {
  81                         $sql_extra .= sprintf(" AND `id` != %d ", intval($x['exclude']));
  82                 }
  83
  84                 if (!empty($x['networks'])) {
  85                         /// @TODO rewrite to foreach()
  86                         array_walk($x['networks'], function (&$value) {
  87                                 $value = "'" . DBA::escape($value) . "'";
  88                         });
  89                         $str_nets = implode(',', $x['networks']);
  90                         $sql_extra .= " AND `network` IN ( $str_nets ) ";
  91                 }
  92
  93                 $tabindex = (!empty($options['tabindex']) ? 'tabindex="' . $options["tabindex"] . '"' : '');
  94
  95                 if (!empty($x['single'])) {
  96                         $o .= "<select name=\"$selname\" id=\"$selclass\" class=\"$selclass\" size=\"" . $x['size'] . "\" $tabindex >\r\n";
  97                 } else {
  98                         $o .= "<select name=\"{$selname}[]\" id=\"$selclass\" class=\"$selclass\" multiple=\"multiple\" size=\"" . $x['size'] . "$\" $tabindex >\r\n";
  99                 }
 100
 101                 $stmt = DBA::p("SELECT `id`, `name`, `url`, `network` FROM `contact`
 102                         WHERE `uid` = ? AND NOT `self` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND NOT `deleted` AND `notify` != ''
 103                         $sql_extra
 104                         ORDER BY `name` ASC ", intval(local_user())
 105                 );
 106
 107                 $contacts = DBA::toArray($stmt);
 108
 109                 $arr = ['contact' => $contacts, 'entry' => $o];
 110
 111                 // e.g. 'network_pre_contact_deny', 'profile_pre_contact_allow'
 112                 Hook::callAll($a->module . '_pre_' . $selname, $arr);
 113
 114                 if (DBA::isResult($contacts)) {
 115                         foreach ($contacts as $contact) {
 116                                 if (in_array($contact['id'], $preselected)) {
 117                                         $selected = ' selected="selected" ';
 118                                 } else {
 119                                         $selected = '';
 120                                 }
 121
 122                                 $trimmed = mb_substr($contact['name'], 0, 20);
 123
 124                                 $o .= "<option value=\"{$contact['id']}\" $selected title=\"{$contact['name']}|{$contact['url']}\" >$trimmed</option>\r\n";
 125                         }
 126                 }
 127
 128                 $o .= '</select>' . PHP_EOL;
 129
 130                 Hook::callAll($a->module . '_post_' . $selname, $o);
 131
 132                 return $o;
 133         }
 134
 135         /**
 136          * Returns a select input tag with all the contact of the local user
 137          *
 138          * @param string $selname     Name attribute of the select input tag
 139          * @param string $selclass    Class attribute of the select input tag
 140          * @param array  $preselected Contact IDs that should be already selected
 141          * @param int    $size        Length of the select box
 142          * @param int    $tabindex    Select input tag tabindex attribute
 143          * @return string
 144          * @throws \Exception
 145          */
 146         public static function getMessageContactSelectHTML($selname, $selclass, array $preselected = [], $size = 4, $tabindex = null)
 147         {
 148                 $a = self::getApp();
 149
 150                 $o = '';
 151
 152                 // When used for private messages, we limit correspondence to mutual DFRN/Friendica friends and the selector
 153                 // to one recipient. By default our selector allows multiple selects amongst all contacts.
 154                 $sql_extra = sprintf(" AND `rel` = %d ", intval(Contact::FRIEND));
 155                 $sql_extra .= sprintf(" AND `network` IN ('%s' , '%s') ", Protocol::DFRN, Protocol::DIASPORA);
 156
 157                 $tabindex_attr = !empty($tabindex) ? ' tabindex="' . intval($tabindex) . '"' : '';
 158
 159                 $hidepreselected = '';
 160                 if ($preselected) {
 161                         $sql_extra .= " AND `id` IN (" . implode(",", $preselected) . ")";
 162                         $hidepreselected = ' style="display: none;"';
 163                 }
 164
 165                 $o .= "<select name=\"$selname\" id=\"$selclass\" class=\"$selclass\" size=\"$size\"$tabindex_attr$hidepreselected>\r\n";
 166
 167                 $stmt = DBA::p("SELECT `id`, `name`, `url`, `network` FROM `contact`
 168                         WHERE `uid` = ? AND NOT `self` AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND NOT `deleted` AND `notify` != ''
 169                         $sql_extra
 170                         ORDER BY `name` ASC ", intval(local_user())
 171                 );
 172
 173                 $contacts = DBA::toArray($stmt);
 174
 175                 $arr = ['contact' => $contacts, 'entry' => $o];
 176
 177                 // e.g. 'network_pre_contact_deny', 'profile_pre_contact_allow'
 178                 Hook::callAll($a->module . '_pre_' . $selname, $arr);
 179
 180                 $receiverlist = [];
 181
 182                 if (DBA::isResult($contacts)) {
 183                         foreach ($contacts as $contact) {
 184                                 if (in_array($contact['id'], $preselected)) {
 185                                         $selected = ' selected="selected"';
 186                                 } else {
 187                                         $selected = '';
 188                                 }
 189
 190                                 $trimmed = Protocol::formatMention($contact['url'], $contact['name']);
 191
 192                                 $receiverlist[] = $trimmed;
 193
 194                                 $o .= "<option value=\"{$contact['id']}\"$selected title=\"{$contact['name']}|{$contact['url']}\" >$trimmed</option>\r\n";
 195                         }
 196                 }
 197
 198                 $o .= '</select>' . PHP_EOL;
 199
 200                 if ($preselected) {
 201                         $o .= implode(', ', $receiverlist);
 202                 }
 203
 204                 Hook::callAll($a->module . '_post_' . $selname, $o);
 205
 206                 return $o;
 207         }
 208
 209         private static function fixACL(&$item)
 210         {
 211                 $item = intval(str_replace(['<', '>'], ['', ''], $item));
 212         }
 213
 214         /**
 215          * Return the default permission of the provided user array
 216          *
 217          * @param array $user
 218          * @return array Hash of contact id lists
 219          * @throws \Exception
 220          */
 221         public static function getDefaultUserPermissions(array $user = null)
 222         {
 223                 $matches = [];
 224
 225                 $acl_regex = '/<([0-9]+)>/i';
 226
 227                 preg_match_all($acl_regex, $user['allow_cid'] ?? '', $matches);
 228                 $allow_cid = $matches[1];
 229                 preg_match_all($acl_regex, $user['allow_gid'] ?? '', $matches);
 230                 $allow_gid = $matches[1];
 231                 preg_match_all($acl_regex, $user['deny_cid'] ?? '', $matches);
 232                 $deny_cid = $matches[1];
 233                 preg_match_all($acl_regex, $user['deny_gid'] ?? '', $matches);
 234                 $deny_gid = $matches[1];
 235
 236                 // Reformats the ACL data so that it is accepted by the JS frontend
 237                 array_walk($allow_cid, 'self::fixACL');
 238                 array_walk($allow_gid, 'self::fixACL');
 239                 array_walk($deny_cid, 'self::fixACL');
 240                 array_walk($deny_gid, 'self::fixACL');
 241
 242                 Contact::pruneUnavailable($allow_cid);
 243
 244                 return [
 245                         'allow_cid' => $allow_cid,
 246                         'allow_gid' => $allow_gid,
 247                         'deny_cid' => $deny_cid,
 248                         'deny_gid' => $deny_gid,
 249                 ];
 250         }
 251
 252         /**
 253          * Returns the ACL list of contacts for a given user id
 254          *
 255          * @param int $user_id
 256          * @return array
 257          * @throws \Exception
 258          */
 259         public static function getContactListByUserId(int $user_id)
 260         {
 261                 $acl_contacts = Contact::selectToArray(
 262                         ['id', 'name', 'addr', 'micro'],
 263                         ['uid' => $user_id, 'pending' => false, 'rel' => [Contact::FOLLOWER, Contact::FRIEND]]
 264                 );
 265                 array_walk($acl_contacts, function (&$value) {
 266                         $value['type'] = 'contact';
 267                 });
 268
 269                 return $acl_contacts;
 270         }
 271
 272         /**
 273          * Returns the ACL list of groups (including meta-groups) for a given user id
 274          *
 275          * @param int $user_id
 276          * @return array
 277          */
 278         public static function getGroupListByUserId(int $user_id)
 279         {
 280                 $acl_groups = [
 281                         [
 282                                 'id' => Group::FOLLOWERS,
 283                                 'name' => L10n::t('Followers'),
 284                                 'addr' => '',
 285                                 'micro' => 'images/twopeople.png',
 286                                 'type' => 'group',
 287                         ],
 288                         [
 289                                 'id' => Group::MUTUALS,
 290                                 'name' => L10n::t('Mutuals'),
 291                                 'addr' => '',
 292                                 'micro' => 'images/twopeople.png',
 293                                 'type' => 'group',
 294                         ]
 295                 ];
 296                 foreach (Group::getByUserId($user_id) as $group) {
 297                         $acl_groups[] = [
 298                                 'id' => $group['id'],
 299                                 'name' => $group['name'],
 300                                 'addr' => '',
 301                                 'micro' => 'images/twopeople.png',
 302                                 'type' => 'group',
 303                         ];
 304                 }
 305
 306                 return $acl_groups;
 307         }
 308
 309         /**
 310          * Return the full jot ACL selector HTML
 311          *
 312          * @param Page  $page
 313          * @param array $user                User array
 314          * @param bool  $for_federation
 315          * @param array $default_permissions Static defaults permission array:
 316          *                                   [
 317          *                                      'allow_cid' => [],
 318          *                                      'allow_gid' => [],
 319          *                                      'deny_cid' => [],
 320          *                                      'deny_gid' => [],
 321          *                                      'hidewall' => true/false
 322          *                                   ]
 323          * @return string
 324          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 325          */
 326         public static function getFullSelectorHTML(Page $page, array $user = null, bool $for_federation = false, array $default_permissions = [])
 327         {
 328                 $page->registerFooterScript(Theme::getPathForFile('asset/typeahead.js/dist/typeahead.bundle.js'));
 329                 $page->registerFooterScript(Theme::getPathForFile('js/friendica-tagsinput/friendica-tagsinput.js'));
 330                 $page->registerStylesheet(Theme::getPathForFile('js/friendica-tagsinput/friendica-tagsinput.css'));
 331                 $page->registerStylesheet(Theme::getPathForFile('js/friendica-tagsinput/friendica-tagsinput-typeahead.css'));
 332
 333                 // Defaults user permissions
 334                 if (empty($default_permissions)) {
 335                         $default_permissions = self::getDefaultUserPermissions($user);
 336                 } else {
 337                         $default_permissions = [
 338                                 'allow_cid' => $default_permissions['allow_cid'] ?? [],
 339                                 'allow_gid' => $default_permissions['allow_gid'] ?? [],
 340                                 'deny_cid'  => $default_permissions['deny_cid']  ?? [],
 341                                 'deny_gid'  => $default_permissions['deny_gid']  ?? [],
 342                         ];
 343                 }
 344
 345                 if (count($default_permissions['allow_cid'])
 346                         + count($default_permissions['allow_gid'])
 347                         + count($default_permissions['deny_cid'])
 348                         + count($default_permissions['deny_gid'])) {
 349                         $visibility = 'custom';
 350                 } else {
 351                         $visibility = 'public';
 352                         // Default permission display for custom panel
 353                         $default_permissions['allow_gid'] = [Group::FOLLOWERS];
 354                 }
 355
 356                 $jotnets_fields = [];
 357                 if ($for_federation) {
 358                         $mail_enabled = false;
 359                         $pubmail_enabled = false;
 360
 361                         if (function_exists('imap_open') && !Config::get('system', 'imap_disabled')) {
 362                                 $mailacct = DBA::selectFirst('mailacct', ['pubmail'], ['`uid` = ? AND `server` != ""', $user['úid']]);
 363                                 if (DBA::isResult($mailacct)) {
 364                                         $mail_enabled = true;
 365                                         $pubmail_enabled = !empty($mailacct['pubmail']);
 366                                 }
 367                         }
 368
 369                         if (empty($default_permissions['hidewall'])) {
 370                                 if ($mail_enabled) {
 371                                         $jotnets_fields[] = [
 372                                                 'type' => 'checkbox',
 373                                                 'field' => [
 374                                                         'pubmail_enable',
 375                                                         L10n::t('Post to Email'),
 376                                                         $pubmail_enabled
 377                                                 ]
 378                                         ];
 379                                 }
 380
 381                                 Hook::callAll('jot_networks', $jotnets_fields);
 382                         }
 383                 }
 384
 385                 $acl_contacts = self::getContactListByUserId($user['uid']);
 386
 387                 $acl_groups = self::getGroupListByUserId($user['uid']);
 388
 389                 $acl_list = array_merge($acl_groups, $acl_contacts);
 390
 391                 $tpl = Renderer::getMarkupTemplate('acl_selector.tpl');
 392                 $o = Renderer::replaceMacros($tpl, [
 393                         '$public_title'   => L10n::t('Public'),
 394                         '$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.'),
 395                         '$custom_title'   => L10n::t('Limited/Private'),
 396                         '$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.'),
 397                         '$allow_label'    => L10n::t('Show to:'),
 398                         '$deny_label'     => L10n::t('Except to:'),
 399                         '$emailcc'        => L10n::t('CC: email addresses'),
 400                         '$emtitle'        => L10n::t('Example: bob@example.com, mary@example.com'),
 401                         '$jotnets_summary' => L10n::t('Connectors'),
 402                         '$jotnets_disabled_label' => L10n::t('Connectors disabled, since "%s" is enabled.', L10n::t('Hide your profile details from unknown viewers?')),
 403                         '$visibility'     => $visibility,
 404                         '$acl_contacts'   => $acl_contacts,
 405                         '$acl_groups'     => $acl_groups,
 406                         '$acl_list'       => $acl_list,
 407                         '$contact_allow'  => implode(',', $default_permissions['allow_cid']),
 408                         '$group_allow'    => implode(',', $default_permissions['allow_gid']),
 409                         '$contact_deny'   => implode(',', $default_permissions['deny_cid']),
 410                         '$group_deny'     => implode(',', $default_permissions['deny_gid']),
 411                         '$for_federation' => $for_federation,
 412                         '$jotnets_fields' => $jotnets_fields,
 413                         '$user_hidewall'  => $default_permissions['hidewall'],
 414                 ]);
 415
 416                 return $o;
 417         }
 418 }