]> git.mxchange.org Git - friendica.git/blob - src/Core/ACL.php
Merge pull request #6598 from annando/worker-index
[friendica.git] / src / Core / ACL.php
1 <?php
2
3 /**
4  * @file src/Core/Acl.php
5  */
6
7 namespace Friendica\Core;
8
9 use Friendica\BaseObject;
10 use Friendica\Content\Feature;
11 use Friendica\Database\DBA;
12 use Friendica\Model\Contact;
13 use Friendica\Model\GContact;
14 use Friendica\Util\Network;
15
16 /**
17  * Handle ACL management and display
18  *
19  * @author Hypolite Petovan <hypolite@mrpetovan.com>
20  */
21 class ACL extends BaseObject
22 {
23         /**
24          * Returns a select input tag with all the contact of the local user
25          *
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
34          * @return string
35          * @throws \Exception
36          */
37         public static function getSuggestContactSelectHTML($selname, $selclass, array $options = [], array $preselected = [])
38         {
39                 $a = self::getApp();
40
41                 $networks = null;
42
43                 $size = defaults($options, 'size', 4);
44                 $mutual = !empty($options['mutual_friends']);
45                 $single = !empty($options['single']) && empty($options['multiple']);
46                 $exclude = defaults($options, 'exclude', false);
47
48                 switch (defaults($options, 'networks', Protocol::PHANTOM)) {
49                         case 'DFRN_ONLY':
50                                 $networks = [Protocol::DFRN];
51                                 break;
52
53                         case 'PRIVATE':
54                                 $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA];
55                                 break;
56
57                         case 'TWO_WAY':
58                                 if (!empty($a->user['prvnets'])) {
59                                         $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA];
60                                 } else {
61                                         $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA, Protocol::OSTATUS];
62                                 }
63                                 break;
64
65                         default: /// @TODO Maybe log this call?
66                                 break;
67                 }
68
69                 $x = ['options' => $options, 'size' => $size, 'single' => $single, 'mutual' => $mutual, 'exclude' => $exclude, 'networks' => $networks];
70
71                 Hook::callAll('contact_select_options', $x);
72
73                 $o = '';
74
75                 $sql_extra = '';
76
77                 if (!empty($x['mutual'])) {
78                         $sql_extra .= sprintf(" AND `rel` = %d ", intval(Contact::FRIEND));
79                 }
80
81                 if (!empty($x['exclude'])) {
82                         $sql_extra .= sprintf(" AND `id` != %d ", intval($x['exclude']));
83                 }
84
85                 if (!empty($x['networks'])) {
86                         /// @TODO rewrite to foreach()
87                         array_walk($x['networks'], function (&$value) {
88                                 $value = "'" . DBA::escape($value) . "'";
89                         });
90                         $str_nets = implode(',', $x['networks']);
91                         $sql_extra .= " AND `network` IN ( $str_nets ) ";
92                 }
93
94                 $tabindex = (!empty($options['tabindex']) ? 'tabindex="' . $options["tabindex"] . '"' : '');
95
96                 if (!empty($x['single'])) {
97                         $o .= "<select name=\"$selname\" id=\"$selclass\" class=\"$selclass\" size=\"" . $x['size'] . "\" $tabindex >\r\n";
98                 } else {
99                         $o .= "<select name=\"{$selname}[]\" id=\"$selclass\" class=\"$selclass\" multiple=\"multiple\" size=\"" . $x['size'] . "$\" $tabindex >\r\n";
100                 }
101
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` != ''
104                         $sql_extra
105                         ORDER BY `name` ASC ", intval(local_user())
106                 );
107
108                 $contacts = DBA::toArray($stmt);
109
110                 $arr = ['contact' => $contacts, 'entry' => $o];
111
112                 // e.g. 'network_pre_contact_deny', 'profile_pre_contact_allow'
113                 Hook::callAll($a->module . '_pre_' . $selname, $arr);
114
115                 if (DBA::isResult($contacts)) {
116                         foreach ($contacts as $contact) {
117                                 if (in_array($contact['id'], $preselected)) {
118                                         $selected = ' selected="selected" ';
119                                 } else {
120                                         $selected = '';
121                                 }
122
123                                 $trimmed = mb_substr($contact['name'], 0, 20);
124
125                                 $o .= "<option value=\"{$contact['id']}\" $selected title=\"{$contact['name']}|{$contact['url']}\" >$trimmed</option>\r\n";
126                         }
127                 }
128
129                 $o .= '</select>' . PHP_EOL;
130
131                 Hook::callAll($a->module . '_post_' . $selname, $o);
132
133                 return $o;
134         }
135
136         /**
137          * Returns a select input tag with all the contact of the local user
138          *
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
144          * @return string
145          * @throws \Exception
146          */
147         public static function getMessageContactSelectHTML($selname, $selclass, array $preselected = [], $size = 4, $tabindex = null)
148         {
149                 $a = self::getApp();
150
151                 $o = '';
152
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);
157
158                 $tabindex_attr = !empty($tabindex) ? ' tabindex="' . intval($tabindex) . '"' : '';
159
160                 $hidepreselected = '';
161                 if ($preselected) {
162                         $sql_extra .= " AND `id` IN (" . implode(",", $preselected) . ")";
163                         $hidepreselected = ' style="display: none;"';
164                 }
165
166                 $o .= "<select name=\"$selname\" id=\"$selclass\" class=\"$selclass\" size=\"$size\"$tabindex_attr$hidepreselected>\r\n";
167
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` != ''
170                         $sql_extra
171                         ORDER BY `name` ASC ", intval(local_user())
172                 );
173
174                 $contacts = DBA::toArray($stmt);
175
176                 $arr = ['contact' => $contacts, 'entry' => $o];
177
178                 // e.g. 'network_pre_contact_deny', 'profile_pre_contact_allow'
179                 Hook::callAll($a->module . '_pre_' . $selname, $arr);
180
181                 $receiverlist = [];
182
183                 if (DBA::isResult($contacts)) {
184                         foreach ($contacts as $contact) {
185                                 if (in_array($contact['id'], $preselected)) {
186                                         $selected = ' selected="selected"';
187                                 } else {
188                                         $selected = '';
189                                 }
190
191                                 $trimmed = Protocol::formatMention($contact['url'], $contact['name']);
192
193                                 $receiverlist[] = $trimmed;
194
195                                 $o .= "<option value=\"{$contact['id']}\"$selected title=\"{$contact['name']}|{$contact['url']}\" >$trimmed</option>\r\n";
196                         }
197                 }
198
199                 $o .= '</select>' . PHP_EOL;
200
201                 if ($preselected) {
202                         $o .= implode(', ', $receiverlist);
203                 }
204
205                 Hook::callAll($a->module . '_post_' . $selname, $o);
206
207                 return $o;
208         }
209
210         private static function fixACL(&$item)
211         {
212                 $item = intval(str_replace(['<', '>'], ['', ''], $item));
213         }
214
215         /**
216          * Return the default permission of the provided user array
217          *
218          * @param array $user
219          * @return array Hash of contact id lists
220          * @throws \Exception
221          */
222         public static function getDefaultUserPermissions(array $user = null)
223         {
224                 $matches = [];
225
226                 $acl_regex = '/<([0-9]+)>/i';
227
228                 preg_match_all($acl_regex, defaults($user, 'allow_cid', ''), $matches);
229                 $allow_cid = $matches[1];
230                 preg_match_all($acl_regex, defaults($user, 'allow_gid', ''), $matches);
231                 $allow_gid = $matches[1];
232                 preg_match_all($acl_regex, defaults($user, 'deny_cid', ''), $matches);
233                 $deny_cid = $matches[1];
234                 preg_match_all($acl_regex, defaults($user, 'deny_gid', ''), $matches);
235                 $deny_gid = $matches[1];
236
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');
242
243                 Contact::pruneUnavailable($allow_cid);
244
245                 return [
246                         'allow_cid' => $allow_cid,
247                         'allow_gid' => $allow_gid,
248                         'deny_cid' => $deny_cid,
249                         'deny_gid' => $deny_gid,
250                 ];
251         }
252
253         /**
254          * Return the full jot ACL selector HTML
255          *
256          * @param array $user                User array
257          * @param bool  $show_jotnets
258          * @param array $default_permissions Static defaults permission array: ['allow_cid' => '', 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '']
259          * @return string
260          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
261          */
262         public static function getFullSelectorHTML(array $user, $show_jotnets = false, array $default_permissions = [])
263         {
264                 // Defaults user permissions
265                 if (empty($default_permissions)) {
266                         $default_permissions = self::getDefaultUserPermissions($user);
267                 }
268
269                 $jotnets = '';
270                 if ($show_jotnets) {
271                         $imap_disabled = !function_exists('imap_open') || Config::get('system', 'imap_disabled');
272
273                         $mail_enabled = false;
274                         $pubmail_enabled = false;
275
276                         if (!$imap_disabled) {
277                                 $mailacct = DBA::selectFirst('mailacct', ['pubmail'], ['`uid` = ? AND `server` != ""', local_user()]);
278                                 if (DBA::isResult($mailacct)) {
279                                         $mail_enabled = true;
280                                         $pubmail_enabled = !empty($mailacct['pubmail']);
281                                 }
282                         }
283
284                         if (empty($default_permissions['hidewall'])) {
285                                 if ($mail_enabled) {
286                                         $selected = $pubmail_enabled ? ' checked="checked"' : '';
287                                         $jotnets .= '<div class="profile-jot-net"><input type="checkbox" name="pubmail_enable"' . $selected . ' value="1" /> ' . L10n::t("Post to Email") . '</div>';
288                                 }
289
290                                 Hook::callAll('jot_networks', $jotnets);
291                         } else {
292                                 $jotnets .= L10n::t('Connectors disabled, since "%s" is enabled.',
293                                                 L10n::t('Hide your profile details from unknown viewers?'));
294                         }
295                 }
296
297                 $tpl = Renderer::getMarkupTemplate('acl_selector.tpl');
298                 $o = Renderer::replaceMacros($tpl, [
299                         '$showall' => L10n::t('Visible to everybody'),
300                         '$show' => L10n::t('show'),
301                         '$hide' => L10n::t('don\'t show'),
302                         '$allowcid' => json_encode(defaults($default_permissions, 'allow_cid', '')),
303                         '$allowgid' => json_encode(defaults($default_permissions, 'allow_gid', '')),
304                         '$denycid' => json_encode(defaults($default_permissions, 'deny_cid', '')),
305                         '$denygid' => json_encode(defaults($default_permissions, 'deny_gid', '')),
306                         '$networks' => $show_jotnets,
307                         '$emailcc' => L10n::t('CC: email addresses'),
308                         '$emtitle' => L10n::t('Example: bob@example.com, mary@example.com'),
309                         '$jotnets' => $jotnets,
310                         '$aclModalTitle' => L10n::t('Permissions'),
311                         '$aclModalDismiss' => L10n::t('Close'),
312                         '$features' => [
313                                 'aclautomention' => Feature::isEnabled($user['uid'], 'aclautomention') ? 'true' : 'false'
314                         ],
315                 ]);
316
317                 return $o;
318         }
319
320         /**
321          * Searching for global contacts for autocompletion
322          *
323          * @brief Searching for global contacts for autocompletion
324          * @param string $search Name or part of a name or nick
325          * @param string $mode   Search mode (e.g. "community")
326          * @return array with the search results
327          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
328          */
329         public static function contactAutocomplete($search, $mode)
330         {
331                 if (Config::get('system', 'block_public') && !local_user() && !remote_user()) {
332                         return [];
333                 }
334
335                 // don't search if search term has less than 2 characters
336                 if (!$search || mb_strlen($search) < 2) {
337                         return [];
338                 }
339
340                 if (substr($search, 0, 1) === '@') {
341                         $search = substr($search, 1);
342                 }
343
344                 // check if searching in the local global contact table is enabled
345                 if (Config::get('system', 'poco_local_search')) {
346                         $return = GContact::searchByName($search, $mode);
347                 } else {
348                         $p = defaults($_GET, 'page', 1) != 1 ? '&p=' . defaults($_GET, 'page', 1) : '';
349
350                         $curlResult = Network::curl(get_server() . '/lsearch?f=' . $p . '&search=' . urlencode($search));
351                         if ($curlResult->isSuccess()) {
352                                 $lsearch = json_decode($curlResult->getBody(), true);
353                                 if (!empty($lsearch['results'])) {
354                                         $return = $lsearch['results'];
355                                 }
356                         }
357                 }
358
359                 return defaults($return, []);
360         }
361 }