Improve notifications for announced posts
[friendica.git/.git] / include / enotify.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2020, Friendica
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
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.
11  *
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.
16  *
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/>.
19  *
20  */
21
22 use Friendica\Content\Text\BBCode;
23 use Friendica\Core\Hook;
24 use Friendica\Core\Logger;
25 use Friendica\Core\Renderer;
26 use Friendica\Core\System;
27 use Friendica\Database\DBA;
28 use Friendica\DI;
29 use Friendica\Model\Item;
30 use Friendica\Model\ItemContent;
31 use Friendica\Model\Notify;
32 use Friendica\Model\User;
33 use Friendica\Model\UserItem;
34 use Friendica\Protocol\Activity;
35
36 /**
37  * Creates a notification entry and possibly sends a mail
38  *
39  * @param array $params Array with the elements:
40  *                      uid, item, parent, type, otype, verb, event,
41  *                      link, subject, body, to_name, to_email, source_name,
42  *                      source_link, activity, preamble, notify_flags,
43  *                      language, show_in_notification_page
44  * @return bool
45  * @throws \Friendica\Network\HTTPException\InternalServerErrorException
46  */
47 function notification($params)
48 {
49         /** @var string the common prefix of a notification subject */
50         $subjectPrefix = DI::l10n()->t('[Friendica:Notify]');
51
52         // Temporary logging for finding the origin
53         if (!isset($params['uid'])) {
54                 Logger::notice('Missing parameters "uid".', ['params' => $params, 'callstack' => System::callstack()]);
55         }
56
57         // Ensure that the important fields are set at any time
58         $fields = ['notify-flags', 'language', 'username', 'email'];
59         $user = DBA::selectFirst('user', $fields, ['uid' => $params['uid']]);
60
61         if (!DBA::isResult($user)) {
62                 Logger::error('Unknown user', ['uid' =>  $params['uid']]);
63                 return false;
64         }
65
66         $params['notify_flags'] = ($params['notify_flags'] ?? '') ?: $user['notify-flags'];
67         $params['language']     = ($params['language']     ?? '') ?: $user['language'];
68         $params['to_name']      = ($params['to_name']      ?? '') ?: $user['username'];
69         $params['to_email']     = ($params['to_email']     ?? '') ?: $user['email'];
70
71         // from here on everything is in the recipients language
72         $l10n = DI::l10n()->withLang($params['language']);
73
74         $siteurl = DI::baseUrl()->get(true);
75         $sitename = DI::config()->get('config', 'sitename');
76
77         $hostname = DI::baseUrl()->getHostname();
78         if (strpos($hostname, ':')) {
79                 $hostname = substr($hostname, 0, strpos($hostname, ':'));
80         }
81
82         $user = User::getById($params['uid'], ['nickname', 'page-flags']);
83
84         // There is no need to create notifications for forum accounts
85         if (!DBA::isResult($user) || in_array($user["page-flags"], [User::PAGE_FLAGS_COMMUNITY, User::PAGE_FLAGS_PRVGROUP])) {
86                 return false;
87         }
88         $nickname = $user["nickname"];
89
90         // with $params['show_in_notification_page'] == false, the notification isn't inserted into
91         // the database, and an email is sent if applicable.
92         // default, if not specified: true
93         $show_in_notification_page = isset($params['show_in_notification_page']) ? $params['show_in_notification_page'] : true;
94
95         $additional_mail_header = "X-Friendica-Account: <".$nickname."@".$hostname.">\n";
96
97         if (array_key_exists('item', $params)) {
98                 $title = $params['item']['title'];
99                 $body = $params['item']['body'];
100         } else {
101                 $title = $body = '';
102         }
103
104         if (isset($params['item']['id'])) {
105                 $item_id = $params['item']['id'];
106         } else {
107                 $item_id = 0;
108         }
109
110         if (isset($params['item']['uri-id'])) {
111                 $uri_id = $params['item']['uri-id'];
112         } else {
113                 $uri_id = 0;
114         }
115
116         if (isset($params['parent'])) {
117                 $parent_id = $params['parent'];
118         } else {
119                 $parent_id = 0;
120         }
121
122         if (isset($params['item']['parent-uri-id'])) {
123                 $parent_uri_id = $params['item']['parent-uri-id'];
124         } else {
125                 $parent_uri_id = 0;
126         }
127
128         $epreamble = '';
129         $preamble  = '';
130         $subject   = '';
131         $sitelink  = '';
132         $tsitelink = '';
133         $hsitelink = '';
134         $itemlink  = '';
135
136         if ($params['type'] == Notify\Type::MAIL) {
137                 $itemlink = $siteurl.'/message/'.$params['item']['id'];
138                 $params["link"] = $itemlink;
139
140                 $subject = $l10n->t('%s New mail received at %s', $subjectPrefix, $sitename);
141
142                 $preamble = $l10n->t('%1$s sent you a new private message at %2$s.', $params['source_name'], $sitename);
143                 $epreamble = $l10n->t('%1$s sent you %2$s.', '[url='.$params['source_link'].']'.$params['source_name'].'[/url]', '[url=' . $itemlink . ']' . $l10n->t('a private message').'[/url]');
144
145                 $sitelink = $l10n->t('Please visit %s to view and/or reply to your private messages.');
146                 $tsitelink = sprintf($sitelink, $siteurl.'/message/'.$params['item']['id']);
147                 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'/message/'.$params['item']['id'].'">'.$sitename.'</a>');
148         }
149
150         if ($params['type'] == Notify\Type::COMMENT || $params['type'] == Notify\Type::TAG_SELF) {
151                 $thread = Item::selectFirstThreadForUser($params['uid'], ['ignored'], ['iid' => $parent_id, 'deleted' => false]);
152                 if (DBA::isResult($thread) && $thread['ignored']) {
153                         Logger::log('Thread ' . $parent_id . ' will be ignored', Logger::DEBUG);
154                         return false;
155                 }
156
157                 // Check to see if there was already a tag notify or comment notify for this post.
158                 // If so don't create a second notification
159                 /// @todo In the future we should store the notification with the highest "value" and replace notifications
160                 $condition = ['type' => [Notify\Type::TAG_SELF, Notify\Type::COMMENT, Notify\Type::SHARE],
161                         'link' => $params['link'], 'uid' => $params['uid']];
162                 if (DBA::exists('notify', $condition)) {
163                         return false;
164                 }
165
166                 // if it's a post figure out who's post it is.
167                 $item = null;
168                 if ($params['otype'] === Notify\ObjectType::ITEM && $parent_id) {
169                         $item = Item::selectFirstForUser($params['uid'], Item::ITEM_FIELDLIST, ['id' => $parent_id, 'deleted' => false]);
170                 }
171
172                 if (empty($item)) {
173                         return false;
174                 }
175
176                 $item_post_type = Item::postType($item);
177
178                 $content = ItemContent::getPlaintextPost($item, 70);
179                 if (!empty($content['text'])) {
180                         $title = '"' . trim(str_replace("\n", " ", $content['text'])) . '"';
181                 } else {
182                         $title = '';
183                 }
184
185                 // First go for the general message
186
187                 // "George Bull's post"
188                 if ($params['activity']['origin_comment']) {
189                         $message = $l10n->t('%1$s replied to you on %2$s\'s %3$s %4$s');
190                 } elseif ($params['activity']['explicit_tagged']) {
191                         $message = $l10n->t('%1$s tagged you on %2$s\'s %3$s %4$s');
192                 } else {
193                         $message = $l10n->t('%1$s commented on %2$s\'s %3$s %4$s');
194                 }
195
196                 $dest_str = sprintf($message, $params['source_name'], $item['author-name'], $item_post_type, $title);
197
198                 // Then look for the special cases
199
200                 // "your post"
201                 if ($params['activity']['origin_thread']) {
202                         if ($params['activity']['origin_comment']) {
203                                 $message = $l10n->t('%1$s replied to you on your %2$s %3$s');
204                         } elseif ($params['activity']['explicit_tagged']) {
205                                 $message = $l10n->t('%1$s tagged you on your %2$s %3$s');
206                         } else {
207                                 $message = $l10n->t('%1$s commented on your %2$s %3$s');
208                         }
209
210                         $dest_str = sprintf($message, $params['source_name'], $item_post_type, $title);
211                 // "their post"
212                 } elseif ($item['author-link'] == $params['source_link']) {
213                         if ($params['activity']['origin_comment']) {
214                                 $message = $l10n->t('%1$s replied to you on their %2$s %3$s');
215                         } elseif ($params['activity']['explicit_tagged']) {
216                                 $message = $l10n->t('%1$s tagged you on their %2$s %3$s');
217                         } else {
218                                 $message = $l10n->t('%1$s commented on their %2$s %3$s');
219                         }
220
221                         $dest_str = sprintf($message, $params['source_name'], $item_post_type, $title);
222                 }
223
224                 // Some mail software relies on subject field for threading.
225                 // So, we cannot have different subjects for notifications of the same thread.
226                 // Before this we have the name of the replier on the subject rendering
227                 // different subjects for messages on the same thread.
228                 if ($params['activity']['explicit_tagged']) {
229                         $subject = $l10n->t('%s %s tagged you', $subjectPrefix, $params['source_name']);
230
231                         $preamble = $l10n->t('%1$s tagged you at %2$s', $params['source_name'], $sitename);
232                 } else {
233                         $subject = $l10n->t('%1$s Comment to conversation #%2$d by %3$s', $subjectPrefix, $parent_id, $params['source_name']);
234
235                         $preamble = $l10n->t('%s commented on an item/conversation you have been following.', $params['source_name']);
236                 }
237
238                 $epreamble = $dest_str;
239
240                 $sitelink = $l10n->t('Please visit %s to view and/or reply to the conversation.');
241                 $tsitelink = sprintf($sitelink, $siteurl);
242                 $hsitelink = sprintf($sitelink, '<a href="' . $siteurl . '">' . $sitename . '</a>');
243                 $itemlink =  $params['link'];
244         }
245
246         if ($params['type'] == Notify\Type::WALL) {
247                 $subject = $l10n->t('%s %s posted to your profile wall', $subjectPrefix, $params['source_name']);
248
249                 $preamble = $l10n->t('%1$s posted to your profile wall at %2$s', $params['source_name'], $sitename);
250                 $epreamble = $l10n->t('%1$s posted to [url=%2$s]your wall[/url]',
251                         '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
252                         $params['link']
253                 );
254
255                 $sitelink = $l10n->t('Please visit %s to view and/or reply to the conversation.');
256                 $tsitelink = sprintf($sitelink, $siteurl);
257                 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
258                 $itemlink =  $params['link'];
259         }
260
261         if ($params['type'] == Notify\Type::SHARE) {
262                 if ($params['origin_link'] == $params['source_link']) {
263                         $subject = $l10n->t('%s %s shared a new post', $subjectPrefix, $params['source_name']);
264
265                         $preamble = $l10n->t('%1$s shared a new post at %2$s', $params['source_name'], $sitename);
266                         $epreamble = $l10n->t('%1$s [url=%2$s]shared a post[/url].',
267                                 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
268                                 $params['link']
269                         );
270                 } else {
271                         $subject = $l10n->t('%s %s shared a post from %s', $subjectPrefix, $params['source_name'], $params['origin_name']);
272
273                         $preamble = $l10n->t('%1$s shared a post from %2$s at %3$s', $params['source_name'], $params['origin_name'], $sitename);
274                         $epreamble = $l10n->t('%1$s [url=%2$s]shared a post[/url] from %3$s.',
275                                 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
276                                 $params['link'], '[url='.$params['origin_link'].']'.$params['origin_name'].'[/url]'
277                         );                      
278                 }
279
280                 $sitelink = $l10n->t('Please visit %s to view and/or reply to the conversation.');
281                 $tsitelink = sprintf($sitelink, $siteurl);
282                 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
283                 $itemlink =  $params['link'];
284         }
285
286         if ($params['type'] == Notify\Type::POKE) {
287                 $subject = $l10n->t('%1$s %2$s poked you', $subjectPrefix, $params['source_name']);
288
289                 $preamble = $l10n->t('%1$s poked you at %2$s', $params['source_name'], $sitename);
290                 $epreamble = $l10n->t('%1$s [url=%2$s]poked you[/url].',
291                         '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
292                         $params['link']
293                 );
294
295                 $subject = str_replace('poked', $l10n->t($params['activity']), $subject);
296                 $preamble = str_replace('poked', $l10n->t($params['activity']), $preamble);
297                 $epreamble = str_replace('poked', $l10n->t($params['activity']), $epreamble);
298
299                 $sitelink = $l10n->t('Please visit %s to view and/or reply to the conversation.');
300                 $tsitelink = sprintf($sitelink, $siteurl);
301                 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
302                 $itemlink =  $params['link'];
303         }
304
305         if ($params['type'] == Notify\Type::TAG_SHARE) {
306                 $itemlink =  $params['link'];
307                 $subject = $l10n->t('%s %s tagged your post', $subjectPrefix, $params['source_name']);
308
309                 $preamble = $l10n->t('%1$s tagged your post at %2$s', $params['source_name'], $sitename);
310                 $epreamble = $l10n->t('%1$s tagged [url=%2$s]your post[/url]',
311                         '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
312                         $itemlink
313                 );
314
315                 $sitelink = $l10n->t('Please visit %s to view and/or reply to the conversation.');
316                 $tsitelink = sprintf($sitelink, $siteurl);
317                 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
318         }
319
320         if ($params['type'] == Notify\Type::INTRO) {
321                 $itemlink = $params['link'];
322                 $subject = $l10n->t('%s Introduction received', $subjectPrefix);
323
324                 $preamble = $l10n->t('You\'ve received an introduction from \'%1$s\' at %2$s', $params['source_name'], $sitename);
325                 $epreamble = $l10n->t('You\'ve received [url=%1$s]an introduction[/url] from %2$s.',
326                         $itemlink,
327                         '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
328                 );
329
330                 $body = $l10n->t('You may visit their profile at %s', $params['source_link']);
331
332                 $sitelink = $l10n->t('Please visit %s to approve or reject the introduction.');
333                 $tsitelink = sprintf($sitelink, $siteurl);
334                 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
335
336                 switch ($params['verb']) {
337                         case Activity::FRIEND:
338                                 // someone started to share with user (mostly OStatus)
339                                 $subject = $l10n->t('%s A new person is sharing with you', $subjectPrefix);
340
341                                 $preamble = $l10n->t('%1$s is sharing with you at %2$s', $params['source_name'], $sitename);
342                                 $epreamble = $l10n->t('%1$s is sharing with you at %2$s',
343                                         '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
344                                         $sitename
345                                 );
346                                 break;
347                         case Activity::FOLLOW:
348                                 // someone started to follow the user (mostly OStatus)
349                                 $subject = $l10n->t('%s You have a new follower', $subjectPrefix);
350
351                                 $preamble = $l10n->t('You have a new follower at %2$s : %1$s', $params['source_name'], $sitename);
352                                 $epreamble = $l10n->t('You have a new follower at %2$s : %1$s',
353                                         '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
354                                         $sitename
355                                 );
356                                 break;
357                         default:
358                                 // ACTIVITY_REQ_FRIEND is default activity for notifications
359                                 break;
360                 }
361         }
362
363         if ($params['type'] == Notify\Type::SUGGEST) {
364                 $itemlink =  $params['link'];
365                 $subject = $l10n->t('%s Friend suggestion received', $subjectPrefix);
366
367                 $preamble = $l10n->t('You\'ve received a friend suggestion from \'%1$s\' at %2$s', $params['source_name'], $sitename);
368                 $epreamble = $l10n->t('You\'ve received [url=%1$s]a friend suggestion[/url] for %2$s from %3$s.',
369                         $itemlink,
370                         '[url='.$params['item']['url'].']'.$params['item']['name'].'[/url]',
371                         '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
372                 );
373
374                 $body = $l10n->t('Name:').' '.$params['item']['name']."\n";
375                 $body .= $l10n->t('Photo:').' '.$params['item']['photo']."\n";
376                 $body .= $l10n->t('You may visit their profile at %s', $params['item']['url']);
377
378                 $sitelink = $l10n->t('Please visit %s to approve or reject the suggestion.');
379                 $tsitelink = sprintf($sitelink, $siteurl);
380                 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
381         }
382
383         if ($params['type'] == Notify\Type::CONFIRM) {
384                 if ($params['verb'] == Activity::FRIEND) { // mutual connection
385                         $itemlink =  $params['link'];
386                         $subject = $l10n->t('%s Connection accepted', $subjectPrefix);
387
388                         $preamble = $l10n->t('\'%1$s\' has accepted your connection request at %2$s', $params['source_name'], $sitename);
389                         $epreamble = $l10n->t('%2$s has accepted your [url=%1$s]connection request[/url].',
390                                 $itemlink,
391                                 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
392                         );
393
394                         $body =  $l10n->t('You are now mutual friends and may exchange status updates, photos, and email without restriction.');
395
396                         $sitelink = $l10n->t('Please visit %s if you wish to make any changes to this relationship.');
397                         $tsitelink = sprintf($sitelink, $siteurl);
398                         $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
399                 } else { // ACTIVITY_FOLLOW
400                         $itemlink =  $params['link'];
401                         $subject = $l10n->t('%s Connection accepted', $subjectPrefix);
402
403                         $preamble = $l10n->t('\'%1$s\' has accepted your connection request at %2$s', $params['source_name'], $sitename);
404                         $epreamble = $l10n->t('%2$s has accepted your [url=%1$s]connection request[/url].',
405                                 $itemlink,
406                                 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
407                         );
408
409                         $body =  $l10n->t('\'%1$s\' has chosen to accept you a fan, which restricts some forms of communication - such as private messaging and some profile interactions. If this is a celebrity or community page, these settings were applied automatically.', $params['source_name']);
410                         $body .= "\n\n";
411                         $body .= $l10n->t('\'%1$s\' may choose to extend this into a two-way or more permissive relationship in the future.', $params['source_name']);
412
413                         $sitelink = $l10n->t('Please visit %s  if you wish to make any changes to this relationship.');
414                         $tsitelink = sprintf($sitelink, $siteurl);
415                         $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
416                 }
417         }
418
419         if ($params['type'] == Notify\Type::SYSTEM) {
420                 switch($params['event']) {
421                         case "SYSTEM_REGISTER_REQUEST":
422                                 $itemlink =  $params['link'];
423                                 $subject = $l10n->t('[Friendica System Notify]') . ' ' . $l10n->t('registration request');
424
425                                 $preamble = $l10n->t('You\'ve received a registration request from \'%1$s\' at %2$s', $params['source_name'], $sitename);
426                                 $epreamble = $l10n->t('You\'ve received a [url=%1$s]registration request[/url] from %2$s.',
427                                         $itemlink,
428                                         '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
429                                 );
430
431                                 $body = $l10n->t("Full Name:    %s\nSite Location:      %s\nLogin Name: %s (%s)",
432                                         $params['source_name'],
433                                         $siteurl, $params['source_mail'],
434                                         $params['source_nick']
435                                 );
436
437                                 $sitelink = $l10n->t('Please visit %s to approve or reject the request.');
438                                 $tsitelink = sprintf($sitelink, $params['link']);
439                                 $hsitelink = sprintf($sitelink, '<a href="'.$params['link'].'">'.$sitename.'</a><br><br>');
440                                 break;
441                         case "SYSTEM_DB_UPDATE_FAIL":
442                                 break;
443                 }
444         }
445
446         $subject .= " (".$nickname."@".$hostname.")";
447
448         $h = [
449                 'params'    => $params,
450                 'subject'   => $subject,
451                 'preamble'  => $preamble,
452                 'epreamble' => $epreamble,
453                 'body'      => $body,
454                 'sitelink'  => $sitelink,
455                 'tsitelink' => $tsitelink,
456                 'hsitelink' => $hsitelink,
457                 'itemlink'  => $itemlink
458         ];
459
460         Hook::callAll('enotify', $h);
461
462         $subject   = $h['subject'];
463
464         $preamble  = $h['preamble'];
465         $epreamble = $h['epreamble'];
466
467         $body      = $h['body'];
468
469         $tsitelink = $h['tsitelink'];
470         $hsitelink = $h['hsitelink'];
471         $itemlink  = $h['itemlink'];
472
473         $notify_id = 0;
474
475         if ($show_in_notification_page) {
476                 $notification = DI::notify()->insert([
477                         'name'          => $params['source_name'] ?? '',
478                         'name_cache'    => substr(strip_tags(BBCode::convert($params['source_name'])), 0, 255),
479                         'url'           => $params['source_link'] ?? '',
480                         'photo'         => $params['source_photo'] ?? '',
481                         'link'          => $itemlink ?? '',
482                         'uid'           => $params['uid'] ?? 0,
483                         'iid'           => $item_id,
484                         'uri-id'        => $uri_id,
485                         'parent'        => $parent_id,
486                         'parent-uri-id' => $parent_uri_id,
487                         'type'          => $params['type'] ?? '',
488                         'verb'          => $params['verb'] ?? '',
489                         'otype'         => $params['otype'] ?? '',
490                 ]);
491
492                 // Notification insertion can be intercepted by an addon registering the 'enotify_store' hook
493                 if (!$notification) {
494                         return false;
495                 }
496
497                 $notification->msg = Renderer::replaceMacros($epreamble, ['$itemlink' => $notification->link]);
498
499                 DI::notify()->update($notification);
500
501                 $itemlink  = DI::baseUrl() . '/notification/' . $notification->id;
502                 $notify_id = $notification->id;
503         }
504
505         // send email notification if notification preferences permit
506         if ((intval($params['notify_flags']) & intval($params['type']))
507                 || $params['type'] == Notify\Type::SYSTEM) {
508
509                 Logger::log('sending notification email');
510
511                 if (isset($params['parent']) && (intval($params['parent']) != 0)) {
512                         $id_for_parent = $params['parent'] . "@" . $hostname;
513
514                         // Is this the first email notification for this parent item and user?
515                         if (!DBA::exists('notify-threads', ['master-parent-item' => $params['parent'], 'receiver-uid' => $params['uid']])) {
516                                 Logger::log("notify_id:" . intval($notify_id) . ", parent: " . intval($params['parent']) . "uid: " . intval($params['uid']), Logger::DEBUG);
517
518                                 $fields = ['notify-id' => $notify_id, 'master-parent-item' => $params['parent'],
519                                         'master-parent-uri-id' => $parent_uri_id,
520                                         'receiver-uid' => $params['uid'], 'parent-item' => 0];
521                                 DBA::insert('notify-threads', $fields);
522
523                                 $additional_mail_header .= "Message-ID: <${id_for_parent}>\n";
524                                 $log_msg                = "include/enotify: No previous notification found for this parent:\n" .
525                                                           "  parent: ${params['parent']}\n" . "  uid   : ${params['uid']}\n";
526                                 Logger::log($log_msg, Logger::DEBUG);
527                         } else {
528                                 // If not, just "follow" the thread.
529                                 $additional_mail_header .= "References: <${id_for_parent}>\nIn-Reply-To: <${id_for_parent}>\n";
530                                 Logger::log("There's already a notification for this parent.", Logger::DEBUG);
531                         }
532                 }
533
534                 $datarray = [
535                         'preamble'     => $preamble,
536                         'type'         => $params['type'],
537                         'parent'       => $parent_id,
538                         'source_name'  => $params['source_name'] ?? null,
539                         'source_link'  => $params['source_link'] ?? null,
540                         'source_photo' => $params['source_photo'] ?? null,
541                         'uid'          => $params['uid'],
542                         'hsitelink'    => $hsitelink,
543                         'tsitelink'    => $tsitelink,
544                         'itemlink'     => $itemlink,
545                         'title'        => $title,
546                         'body'         => $body,
547                         'subject'      => $subject,
548                         'headers'      => $additional_mail_header,
549                 ];
550
551                 Hook::callAll('enotify_mail', $datarray);
552
553                 $builder = DI::emailer()
554                         ->newNotifyMail()
555                         ->addHeaders($datarray['headers'])
556                         ->withRecipient($params['to_email'])
557                         ->forUser([
558                                 'uid' => $datarray['uid'],
559                                 'language' => $params['language'],
560                         ])
561                         ->withNotification($datarray['subject'], $datarray['preamble'], $datarray['title'], $datarray['body'])
562                         ->withSiteLink($datarray['tsitelink'], $datarray['hsitelink'])
563                         ->withItemLink($datarray['itemlink']);
564
565                 // If a photo is present, add it to the email
566                 if (!empty($datarray['source_photo'])) {
567                         $builder->withPhoto(
568                                 $datarray['source_photo'],
569                                 $datarray['source_link'] ?? $sitelink,
570                                 $datarray['source_name'] ?? $sitename);
571                 }
572
573                 $email = $builder->build();
574
575                 // use the Emailer class to send the message
576                 return DI::emailer()->send($email);
577         }
578
579         return false;
580 }
581
582 /**
583  * Checks for users who should be notified
584  *
585  * @param int $itemid ID of the item for which the check should be done
586  * @throws \Friendica\Network\HTTPException\InternalServerErrorException
587  */
588 function check_user_notification($itemid) {
589         // fetch all users with notifications
590         $useritems = DBA::select('user-item', ['uid', 'notification-type'], ['iid' => $itemid]);
591         while ($useritem = DBA::fetch($useritems)) {
592                 check_item_notification($itemid, $useritem['uid'], $useritem['notification-type']);
593         }
594         DBA::close($useritems);
595 }
596
597 /**
598  * Checks for item related notifications and sends them
599  *
600  * @param int    $itemid            ID of the item for which the check should be done
601  * @param int    $uid               User ID
602  * @param int    $notification_type Notification bits
603  * @return bool
604  * @throws \Friendica\Network\HTTPException\InternalServerErrorException
605  */
606 function check_item_notification($itemid, $uid, $notification_type) {
607         $fields = ['id', 'uri-id', 'mention', 'parent', 'parent-uri-id', 'thr-parent-id',
608                 'title', 'body', 'author-link', 'author-name', 'author-avatar', 'author-id',
609                 'gravity', 'guid', 'parent-uri', 'uri', 'contact-id', 'network'];
610         $condition = ['id' => $itemid, 'deleted' => false];
611         $item = Item::selectFirstForUser($uid, $fields, $condition);
612         if (!DBA::isResult($item)) {
613                 return false;
614         }
615
616         // Generate the notification array
617         $params = [];
618         $params['uid'] = $uid;
619         $params['item'] = $item;
620         $params['parent'] = $item['parent'];
621         $params['link'] = DI::baseUrl() . '/display/' . urlencode($item['guid']);
622         $params['otype'] = 'item';
623         $params['origin_name'] = $params['source_name'] = $item['author-name'];
624         $params['origin_link'] = $params['source_link'] = $item['author-link'];
625         $params['origin_photo'] = $params['source_photo'] = $item['author-avatar'];
626
627         // Set the activity flags
628         $params['activity']['explicit_tagged'] = ($notification_type & UserItem::NOTIF_EXPLICIT_TAGGED);
629         $params['activity']['implicit_tagged'] = ($notification_type & UserItem::NOTIF_IMPLICIT_TAGGED);
630         $params['activity']['origin_comment'] = ($notification_type & UserItem::NOTIF_DIRECT_COMMENT);
631         $params['activity']['origin_thread'] = ($notification_type & UserItem::NOTIF_THREAD_COMMENT);
632         $params['activity']['thread_comment'] = ($notification_type & UserItem::NOTIF_COMMENT_PARTICIPATION);
633         $params['activity']['thread_activity'] = ($notification_type & UserItem::NOTIF_ACTIVITY_PARTICIPATION);
634
635         // Tagging a user in a direct post (first comment level) means a direct comment
636         if ($params['activity']['explicit_tagged'] && ($notification_type & UserItem::NOTIF_DIRECT_THREAD_COMMENT)) {
637                 $params['activity']['origin_comment'] = true;
638         }
639
640         if ($notification_type & UserItem::NOTIF_SHARED) {
641                 $params['type'] = Notify\Type::SHARE;
642                 $params['verb'] = Activity::POST;
643
644                 // Special treatment for posts that had been shared via "announce"
645                 if ($item['gravity'] == GRAVITY_ACTIVITY) {
646                         $parent_item = Item::selectFirst($fields, ['uri-id' => $item['thr-parent-id'], 'uid' => [$uid, 0]]);
647                         if (DBA::isResult($parent_item)) {
648                                 $params['origin_name'] = $parent_item['author-name'];
649                                 $params['origin_link'] = $parent_item['author-link'];
650                                 $params['origin_photo'] = $parent_item['author-avatar'];
651                                 $params['item'] = $parent_item;
652                         }
653                 }
654         } elseif ($notification_type & UserItem::NOTIF_EXPLICIT_TAGGED) {
655                 $params['type'] = Notify\Type::TAG_SELF;
656                 $params['verb'] = Activity::TAG;
657         } elseif ($notification_type & UserItem::NOTIF_IMPLICIT_TAGGED) {
658                 $params['type'] = Notify\Type::COMMENT;
659                 $params['verb'] = Activity::POST;
660         } elseif ($notification_type & UserItem::NOTIF_THREAD_COMMENT) {
661                 $params['type'] = Notify\Type::COMMENT;
662                 $params['verb'] = Activity::POST;
663         } elseif ($notification_type & UserItem::NOTIF_DIRECT_COMMENT) {
664                 $params['type'] = Notify\Type::COMMENT;
665                 $params['verb'] = Activity::POST;
666         } elseif ($notification_type & UserItem::NOTIF_COMMENT_PARTICIPATION) {
667                 $params['type'] = Notify\Type::COMMENT;
668                 $params['verb'] = Activity::POST;
669         } elseif ($notification_type & UserItem::NOTIF_ACTIVITY_PARTICIPATION) {
670                 $params['type'] = Notify\Type::COMMENT;
671                 $params['verb'] = Activity::POST;
672         } else {
673                 return false;
674         }
675
676         notification($params);
677 }