3 * @file include/enotify.php
6 use Friendica\Content\Text\BBCode;
7 use Friendica\Core\Config;
8 use Friendica\Core\Hook;
9 use Friendica\Core\L10n;
10 use Friendica\Core\Logger;
11 use Friendica\Core\Renderer;
12 use Friendica\Core\System;
13 use Friendica\Database\DBA;
14 use Friendica\Model\Item;
15 use Friendica\Model\User;
16 use Friendica\Protocol\Activity;
17 use Friendica\Util\DateTimeFormat;
18 use Friendica\Util\Emailer;
19 use Friendica\Util\Strings;
22 * @brief Creates a notification entry and possibly sends a mail
24 * @param array $params Array with the elements:
25 * uid, item, parent, type, otype, verb, event,
26 * link, subject, body, to_name, to_email, source_name,
27 * source_link, activity, preamble, notify_flags,
28 * language, show_in_notification_page
30 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
32 function notification($params)
36 // Temporary logging for finding the origin
37 if (!isset($params['uid'])) {
38 Logger::notice('Missing parameters "uid".', ['params' => $params, 'callstack' => System::callstack()]);
41 // Ensure that the important fields are set at any time
42 $fields = ['notify-flags', 'language', 'username', 'email'];
43 $user = DBA::selectFirst('user', $fields, ['uid' => $params['uid']]);
45 if (!DBA::isResult($user)) {
46 Logger::error('Unknown user', ['uid' => $params['uid']]);
50 $params['notify_flags'] = ($params['notify_flags'] ?? '') ?: $user['notify-flags'];
51 $params['language'] = ($params['language'] ?? '') ?: $user['language'];
52 $params['to_name'] = ($params['to_name'] ?? '') ?: $user['username'];
53 $params['to_email'] = ($params['to_email'] ?? '') ?: $user['email'];
55 // from here on everything is in the recipients language
56 L10n::pushLang($params['language']);
58 $banner = L10n::t('Friendica Notification');
59 $product = FRIENDICA_PLATFORM;
60 $siteurl = System::baseUrl(true);
61 $thanks = L10n::t('Thank You,');
62 $sitename = Config::get('config', 'sitename');
63 if (Config::get('config', 'admin_name')) {
64 $site_admin = L10n::t('%1$s, %2$s Administrator', Config::get('config', 'admin_name'), $sitename);
66 $site_admin = L10n::t('%s Administrator', $sitename);
69 $sender_name = $sitename;
70 $hostname = $a->getHostName();
71 if (strpos($hostname, ':')) {
72 $hostname = substr($hostname, 0, strpos($hostname, ':'));
75 $sender_email = $a->getSenderEmailAddress();
77 if ($params['type'] != SYSTEM_EMAIL) {
78 $user = DBA::selectFirst('user', ['nickname', 'page-flags'],
79 ['uid' => $params['uid']]);
81 // There is no need to create notifications for forum accounts
82 if (!DBA::isResult($user) || in_array($user["page-flags"], [User::PAGE_FLAGS_COMMUNITY, User::PAGE_FLAGS_PRVGROUP])) {
85 $nickname = $user["nickname"];
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;
95 $additional_mail_header = "";
96 $additional_mail_header .= "Precedence: list\n";
97 $additional_mail_header .= "X-Friendica-Host: ".$hostname."\n";
98 $additional_mail_header .= "X-Friendica-Account: <".$nickname."@".$hostname.">\n";
99 $additional_mail_header .= "X-Friendica-Platform: ".FRIENDICA_PLATFORM."\n";
100 $additional_mail_header .= "X-Friendica-Version: ".FRIENDICA_VERSION."\n";
101 $additional_mail_header .= "List-ID: <notification.".$hostname.">\n";
102 $additional_mail_header .= "List-Archive: <".System::baseUrl()."/notifications/system>\n";
104 if (array_key_exists('item', $params)) {
105 $title = $params['item']['title'];
106 $body = $params['item']['body'];
111 if (isset($params['item']['id'])) {
112 $item_id = $params['item']['id'];
117 if (isset($params['parent'])) {
118 $parent_id = $params['parent'];
131 if ($params['type'] == NOTIFY_MAIL) {
132 $itemlink = $siteurl.'/message/'.$params['item']['id'];
133 $params["link"] = $itemlink;
135 $subject = L10n::t('[Friendica:Notify] New mail received at %s', $sitename);
137 $preamble = L10n::t('%1$s sent you a new private message at %2$s.', $params['source_name'], $sitename);
138 $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]');
140 $sitelink = L10n::t('Please visit %s to view and/or reply to your private messages.');
141 $tsitelink = sprintf($sitelink, $siteurl.'/message/'.$params['item']['id']);
142 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'/message/'.$params['item']['id'].'">'.$sitename.'</a>');
145 if ($params['type'] == NOTIFY_COMMENT || $params['type'] == NOTIFY_TAGSELF) {
146 $thread = Item::selectFirstThreadForUser($params['uid'], ['ignored'], ['iid' => $parent_id, 'deleted' => false]);
147 if (DBA::isResult($thread) && $thread['ignored']) {
148 Logger::log('Thread ' . $parent_id . ' will be ignored', Logger::DEBUG);
153 // Check to see if there was already a tag notify or comment notify for this post.
154 // If so don't create a second notification
155 $condition = ['type' => [NOTIFY_TAGSELF, NOTIFY_COMMENT, NOTIFY_SHARE],
156 'link' => $params['link'], 'uid' => $params['uid']];
157 if (DBA::exists('notify', $condition)) {
162 // if it's a post figure out who's post it is.
164 if ($params['otype'] === 'item' && $parent_id) {
165 $item = Item::selectFirstForUser($params['uid'], Item::ITEM_FIELDLIST, ['id' => $parent_id, 'deleted' => false]);
168 $item_post_type = Item::postType($item);
169 $itemlink = $item['plink'];
172 if ($params['type'] == NOTIFY_TAGSELF) {
173 $dest_str = L10n::t('%1$s tagged you on [url=%2$s]a %3$s[/url]',
174 '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
179 $dest_str = L10n::t('%1$s commented on [url=%2$s]a %3$s[/url]',
180 '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
186 // "George Bull's post"
187 if (DBA::isResult($item)) {
188 if ($params['type'] == NOTIFY_TAGSELF) {
189 $dest_str = L10n::t('%1$s tagged you on [url=%2$s]%3$s\'s %4$s[/url]',
190 '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
192 $item['author-name'],
196 $dest_str = L10n::t('%1$s commented on [url=%2$s]%3$s\'s %4$s[/url]',
197 '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
199 $item['author-name'],
206 if (DBA::isResult($item) && $item['owner-id'] == $item['author-id'] && $item['wall']) {
207 if ($params['type'] == NOTIFY_TAGSELF) {
208 $dest_str = L10n::t('%1$s tagged you on [url=%2$s]your %3$s[/url]',
209 '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
214 $dest_str = L10n::t('%1$s commented on [url=%2$s]your %3$s[/url]',
215 '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
223 if (DBA::isResult($item) && $item['author-link'] == $params['source_link']) {
224 if ($params['type'] == NOTIFY_TAGSELF) {
225 $dest_str = L10n::t('%1$s tagged you on [url=%2$s]their %3$s[/url]',
226 '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
231 $dest_str = L10n::t('%1$s commented on [url=%2$s]their %3$s[/url]',
232 '[url=' . $params['source_link'] . ']' . $params['source_name'] . '[/url]',
239 // Some mail software relies on subject field for threading.
240 // So, we cannot have different subjects for notifications of the same thread.
241 // Before this we have the name of the replier on the subject rendering
242 // different subjects for messages on the same thread.
243 if ($params['type'] == NOTIFY_TAGSELF) {
244 $subject = L10n::t('[Friendica:Notify] %s tagged you', $params['source_name']);
246 $preamble = L10n::t('%1$s tagged you at %2$s', $params['source_name'], $sitename);
248 $subject = L10n::t('[Friendica:Notify] Comment to conversation #%1$d by %2$s', $parent_id, $params['source_name']);
250 $preamble = L10n::t('%s commented on an item/conversation you have been following.', $params['source_name']);
253 $epreamble = $dest_str;
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'];
261 if ($params['type'] == NOTIFY_WALL) {
262 $subject = L10n::t('[Friendica:Notify] %s posted to your profile wall', $params['source_name']);
264 $preamble = L10n::t('%1$s posted to your profile wall at %2$s', $params['source_name'], $sitename);
265 $epreamble = L10n::t('%1$s posted to [url=%2$s]your wall[/url]',
266 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
270 $sitelink = L10n::t('Please visit %s to view and/or reply to the conversation.');
271 $tsitelink = sprintf($sitelink, $siteurl);
272 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
273 $itemlink = $params['link'];
276 if ($params['type'] == NOTIFY_SHARE) {
277 $subject = L10n::t('[Friendica:Notify] %s shared a new post', $params['source_name']);
279 $preamble = L10n::t('%1$s shared a new post at %2$s', $params['source_name'], $sitename);
280 $epreamble = L10n::t('%1$s [url=%2$s]shared a post[/url].',
281 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
285 $sitelink = L10n::t('Please visit %s to view and/or reply to the conversation.');
286 $tsitelink = sprintf($sitelink, $siteurl);
287 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
288 $itemlink = $params['link'];
291 if ($params['type'] == NOTIFY_POKE) {
292 $subject = L10n::t('[Friendica:Notify] %1$s poked you', $params['source_name']);
294 $preamble = L10n::t('%1$s poked you at %2$s', $params['source_name'], $sitename);
295 $epreamble = L10n::t('%1$s [url=%2$s]poked you[/url].',
296 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
300 $subject = str_replace('poked', L10n::t($params['activity']), $subject);
301 $preamble = str_replace('poked', L10n::t($params['activity']), $preamble);
302 $epreamble = str_replace('poked', L10n::t($params['activity']), $epreamble);
304 $sitelink = L10n::t('Please visit %s to view and/or reply to the conversation.');
305 $tsitelink = sprintf($sitelink, $siteurl);
306 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
307 $itemlink = $params['link'];
310 if ($params['type'] == NOTIFY_TAGSHARE) {
311 $itemlink = $params['link'];
312 $subject = L10n::t('[Friendica:Notify] %s tagged your post', $params['source_name']);
314 $preamble = L10n::t('%1$s tagged your post at %2$s', $params['source_name'], $sitename);
315 $epreamble = L10n::t('%1$s tagged [url=%2$s]your post[/url]',
316 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
320 $sitelink = L10n::t('Please visit %s to view and/or reply to the conversation.');
321 $tsitelink = sprintf($sitelink, $siteurl);
322 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
325 if ($params['type'] == NOTIFY_INTRO) {
326 $itemlink = $params['link'];
327 $subject = L10n::t('[Friendica:Notify] Introduction received');
329 $preamble = L10n::t('You\'ve received an introduction from \'%1$s\' at %2$s', $params['source_name'], $sitename);
330 $epreamble = L10n::t('You\'ve received [url=%1$s]an introduction[/url] from %2$s.',
332 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
335 $body = L10n::t('You may visit their profile at %s', $params['source_link']);
337 $sitelink = L10n::t('Please visit %s to approve or reject the introduction.');
338 $tsitelink = sprintf($sitelink, $siteurl);
339 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
341 switch ($params['verb']) {
342 case Activity::FRIEND:
343 // someone started to share with user (mostly OStatus)
344 $subject = L10n::t('[Friendica:Notify] A new person is sharing with you');
346 $preamble = L10n::t('%1$s is sharing with you at %2$s', $params['source_name'], $sitename);
347 $epreamble = L10n::t('%1$s is sharing with you at %2$s',
348 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
352 case Activity::FOLLOW:
353 // someone started to follow the user (mostly OStatus)
354 $subject = L10n::t('[Friendica:Notify] You have a new follower');
356 $preamble = L10n::t('You have a new follower at %2$s : %1$s', $params['source_name'], $sitename);
357 $epreamble = L10n::t('You have a new follower at %2$s : %1$s',
358 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]',
363 // ACTIVITY_REQ_FRIEND is default activity for notifications
368 if ($params['type'] == NOTIFY_SUGGEST) {
369 $itemlink = $params['link'];
370 $subject = L10n::t('[Friendica:Notify] Friend suggestion received');
372 $preamble = L10n::t('You\'ve received a friend suggestion from \'%1$s\' at %2$s', $params['source_name'], $sitename);
373 $epreamble = L10n::t('You\'ve received [url=%1$s]a friend suggestion[/url] for %2$s from %3$s.',
375 '[url='.$params['item']['url'].']'.$params['item']['name'].'[/url]',
376 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
379 $body = L10n::t('Name:').' '.$params['item']['name']."\n";
380 $body .= L10n::t('Photo:').' '.$params['item']['photo']."\n";
381 $body .= L10n::t('You may visit their profile at %s', $params['item']['url']);
383 $sitelink = L10n::t('Please visit %s to approve or reject the suggestion.');
384 $tsitelink = sprintf($sitelink, $siteurl);
385 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
388 if ($params['type'] == NOTIFY_CONFIRM) {
389 if ($params['verb'] == Activity::FRIEND) { // mutual connection
390 $itemlink = $params['link'];
391 $subject = L10n::t('[Friendica:Notify] Connection accepted');
393 $preamble = L10n::t('\'%1$s\' has accepted your connection request at %2$s', $params['source_name'], $sitename);
394 $epreamble = L10n::t('%2$s has accepted your [url=%1$s]connection request[/url].',
396 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
399 $body = L10n::t('You are now mutual friends and may exchange status updates, photos, and email without restriction.');
401 $sitelink = L10n::t('Please visit %s if you wish to make any changes to this relationship.');
402 $tsitelink = sprintf($sitelink, $siteurl);
403 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
404 } else { // ACTIVITY_FOLLOW
405 $itemlink = $params['link'];
406 $subject = L10n::t('[Friendica:Notify] Connection accepted');
408 $preamble = L10n::t('\'%1$s\' has accepted your connection request at %2$s', $params['source_name'], $sitename);
409 $epreamble = L10n::t('%2$s has accepted your [url=%1$s]connection request[/url].',
411 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
414 $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']);
416 $body .= L10n::t('\'%1$s\' may choose to extend this into a two-way or more permissive relationship in the future.', $params['source_name']);
418 $sitelink = L10n::t('Please visit %s if you wish to make any changes to this relationship.');
419 $tsitelink = sprintf($sitelink, $siteurl);
420 $hsitelink = sprintf($sitelink, '<a href="'.$siteurl.'">'.$sitename.'</a>');
424 if ($params['type'] == NOTIFY_SYSTEM) {
425 switch($params['event']) {
426 case "SYSTEM_REGISTER_REQUEST":
427 $itemlink = $params['link'];
428 $subject = L10n::t('[Friendica System Notify]') . ' ' . L10n::t('registration request');
430 $preamble = L10n::t('You\'ve received a registration request from \'%1$s\' at %2$s', $params['source_name'], $sitename);
431 $epreamble = L10n::t('You\'ve received a [url=%1$s]registration request[/url] from %2$s.',
433 '[url='.$params['source_link'].']'.$params['source_name'].'[/url]'
436 $body = L10n::t("Full Name: %s\nSite Location: %s\nLogin Name: %s (%s)",
437 $params['source_name'],
438 $siteurl, $params['source_mail'],
439 $params['source_nick']
442 $sitelink = L10n::t('Please visit %s to approve or reject the request.');
443 $tsitelink = sprintf($sitelink, $params['link']);
444 $hsitelink = sprintf($sitelink, '<a href="'.$params['link'].'">'.$sitename.'</a><br><br>');
446 case "SYSTEM_DB_UPDATE_FAIL":
451 if ($params['type'] == SYSTEM_EMAIL) {
452 // not part of the notifications.
453 // it just send a mail to the user.
454 // It will be used by the system to send emails to users (like
455 // password reset, invitations and so) using one look (but without
456 // add a notification to the user, with could be inexistent)
457 if (!isset($params['subject'])) {
458 Logger::warning('subject isn\'t set.', ['type' => $params['type']]);
460 $subject = $params['subject'] ?? '';
462 if (!isset($params['preamble'])) {
463 Logger::warning('preamble isn\'t set.', ['type' => $params['type'], 'subject' => $subject]);
465 $preamble = $params['preamble'] ?? '';
467 if (!isset($params['body'])) {
468 Logger::warning('body isn\'t set.', ['type' => $params['type'], 'subject' => $subject, 'preamble' => $preamble]);
470 $body = $params['body'] ?? '';
472 $show_in_notification_page = false;
475 $subject .= " (".$nickname."@".$hostname.")";
479 'subject' => $subject,
480 'preamble' => $preamble,
481 'epreamble' => $epreamble,
483 'sitelink' => $sitelink,
484 'tsitelink' => $tsitelink,
485 'hsitelink' => $hsitelink,
486 'itemlink' => $itemlink
489 Hook::callAll('enotify', $h);
491 $subject = $h['subject'];
493 $preamble = $h['preamble'];
494 $epreamble = $h['epreamble'];
498 $tsitelink = $h['tsitelink'];
499 $hsitelink = $h['hsitelink'];
500 $itemlink = $h['itemlink'];
504 if ($show_in_notification_page) {
505 Logger::log("adding notification entry", Logger::DEBUG);
507 /// @TODO One statement is enough
509 $datarray['name'] = $params['source_name'];
510 $datarray['name_cache'] = strip_tags(BBCode::convert($params['source_name']));
511 $datarray['url'] = $params['source_link'];
512 $datarray['photo'] = $params['source_photo'];
513 $datarray['date'] = DateTimeFormat::utcNow();
514 $datarray['uid'] = $params['uid'];
515 $datarray['link'] = $itemlink;
516 $datarray['iid'] = $item_id;
517 $datarray['parent'] = $parent_id;
518 $datarray['type'] = $params['type'];
519 $datarray['verb'] = $params['verb'];
520 $datarray['otype'] = $params['otype'];
521 $datarray['abort'] = false;
523 Hook::callAll('enotify_store', $datarray);
525 if ($datarray['abort']) {
530 // create notification entry in DB
531 $fields = ['name' => $datarray['name'], 'url' => $datarray['url'],
532 'photo' => $datarray['photo'], 'date' => $datarray['date'], 'uid' => $datarray['uid'],
533 'link' => $datarray['link'], 'iid' => $datarray['iid'], 'parent' => $datarray['parent'],
534 'type' => $datarray['type'], 'verb' => $datarray['verb'], 'otype' => $datarray['otype'],
535 'name_cache' => $datarray["name_cache"]];
536 DBA::insert('notify', $fields);
538 $notify_id = DBA::lastInsertId();
540 // we seem to have a lot of duplicate comment notifications due to race conditions, mostly from forums
541 // After we've stored everything, look again to see if there are any duplicates and if so remove them
542 $p = q("SELECT `id` FROM `notify` WHERE `type` IN (%d, %d) AND `link` = '%s' AND `uid` = %d ORDER BY `id`",
543 intval(NOTIFY_TAGSELF),
544 intval(NOTIFY_COMMENT),
545 DBA::escape($params['link']),
546 intval($params['uid'])
548 if ($p && (count($p) > 1)) {
549 for ($d = 1; $d < count($p); $d ++) {
550 DBA::delete('notify', ['id' => $p[$d]['id']]);
553 // only continue on if we stored the first one
554 if ($notify_id != $p[0]['id']) {
560 $itemlink = System::baseUrl().'/notify/view/'.$notify_id;
561 $msg = Renderer::replaceMacros($epreamble, ['$itemlink' => $itemlink]);
562 $msg_cache = format_notification_message($datarray['name_cache'], strip_tags(BBCode::convert($msg)));
564 $fields = ['msg' => $msg, 'msg_cache' => $msg_cache];
565 $condition = ['id' => $notify_id, 'uid' => $params['uid']];
566 DBA::update('notify', $fields, $condition);
569 // send email notification if notification preferences permit
570 if ((intval($params['notify_flags']) & intval($params['type']))
571 || $params['type'] == NOTIFY_SYSTEM
572 || $params['type'] == SYSTEM_EMAIL) {
574 Logger::log('sending notification email');
576 if (isset($params['parent']) && (intval($params['parent']) != 0)) {
577 $id_for_parent = $params['parent']."@".$hostname;
579 // Is this the first email notification for this parent item and user?
580 if (!DBA::exists('notify-threads', ['master-parent-item' => $params['parent'], 'receiver-uid' => $params['uid']])) {
581 Logger::log("notify_id:".intval($notify_id).", parent: ".intval($params['parent'])."uid: ".intval($params['uid']), Logger::DEBUG);
583 $fields = ['notify-id' => $notify_id, 'master-parent-item' => $params['parent'],
584 'receiver-uid' => $params['uid'], 'parent-item' => 0];
585 DBA::insert('notify-threads', $fields);
587 $additional_mail_header .= "Message-ID: <${id_for_parent}>\n";
588 $log_msg = "include/enotify: No previous notification found for this parent:\n".
589 " parent: ${params['parent']}\n"." uid : ${params['uid']}\n";
590 Logger::log($log_msg, Logger::DEBUG);
592 // If not, just "follow" the thread.
593 $additional_mail_header .= "References: <${id_for_parent}>\nIn-Reply-To: <${id_for_parent}>\n";
594 Logger::log("There's already a notification for this parent.", Logger::DEBUG);
598 $textversion = BBCode::toPlaintext($body);
599 $htmlversion = BBCode::convert($body);
602 $datarray['banner'] = $banner;
603 $datarray['product'] = $product;
604 $datarray['preamble'] = $preamble;
605 $datarray['sitename'] = $sitename;
606 $datarray['siteurl'] = $siteurl;
607 $datarray['type'] = $params['type'];
608 $datarray['parent'] = $parent_id;
609 $datarray['source_name'] = $params['source_name'] ?? '';
610 $datarray['source_link'] = $params['source_link'] ?? '';
611 $datarray['source_photo'] = $params['source_photo'] ?? '';
612 $datarray['uid'] = $params['uid'];
613 $datarray['username'] = $params['to_name'] ?? '';
614 $datarray['hsitelink'] = $hsitelink;
615 $datarray['tsitelink'] = $tsitelink;
616 $datarray['hitemlink'] = '<a href="'.$itemlink.'">'.$itemlink.'</a>';
617 $datarray['titemlink'] = $itemlink;
618 $datarray['thanks'] = $thanks;
619 $datarray['site_admin'] = $site_admin;
620 $datarray['title'] = stripslashes($title);
621 $datarray['htmlversion'] = $htmlversion;
622 $datarray['textversion'] = $textversion;
623 $datarray['subject'] = $subject;
624 $datarray['headers'] = $additional_mail_header;
626 Hook::callAll('enotify_mail', $datarray);
628 // check whether sending post content in email notifications is allowed
629 // always true for SYSTEM_EMAIL
630 $content_allowed = ((!Config::get('system', 'enotify_no_content')) || ($params['type'] == SYSTEM_EMAIL));
632 // load the template for private message notifications
633 $tpl = Renderer::getMarkupTemplate('email_notify_html.tpl');
634 $email_html_body = Renderer::replaceMacros($tpl, [
635 '$banner' => $datarray['banner'],
636 '$product' => $datarray['product'],
637 '$preamble' => str_replace("\n", "<br>\n", $datarray['preamble']),
638 '$sitename' => $datarray['sitename'],
639 '$siteurl' => $datarray['siteurl'],
640 '$source_name' => $datarray['source_name'],
641 '$source_link' => $datarray['source_link'],
642 '$source_photo' => $datarray['source_photo'],
643 '$username' => $datarray['username'],
644 '$hsitelink' => $datarray['hsitelink'],
645 '$hitemlink' => $datarray['hitemlink'],
646 '$thanks' => $datarray['thanks'],
647 '$site_admin' => $datarray['site_admin'],
648 '$title' => $datarray['title'],
649 '$htmlversion' => $datarray['htmlversion'],
650 '$content_allowed' => $content_allowed,
653 // load the template for private message notifications
654 $tpl = Renderer::getMarkupTemplate('email_notify_text.tpl');
655 $email_text_body = Renderer::replaceMacros($tpl, [
656 '$banner' => $datarray['banner'],
657 '$product' => $datarray['product'],
658 '$preamble' => $datarray['preamble'],
659 '$sitename' => $datarray['sitename'],
660 '$siteurl' => $datarray['siteurl'],
661 '$source_name' => $datarray['source_name'],
662 '$source_link' => $datarray['source_link'],
663 '$source_photo' => $datarray['source_photo'],
664 '$username' => $datarray['username'],
665 '$tsitelink' => $datarray['tsitelink'],
666 '$titemlink' => $datarray['titemlink'],
667 '$thanks' => $datarray['thanks'],
668 '$site_admin' => $datarray['site_admin'],
669 '$title' => $datarray['title'],
670 '$textversion' => $datarray['textversion'],
671 '$content_allowed' => $content_allowed,
675 // use the Emailer class to send the message
676 return Emailer::send([
677 'uid' => $params['uid'],
678 'fromName' => $sender_name,
679 'fromEmail' => $sender_email,
680 'replyTo' => $sender_email,
681 'toEmail' => $params['to_email'],
682 'messageSubject' => $datarray['subject'],
683 'htmlVersion' => $email_html_body,
684 'textVersion' => $email_text_body,
685 'additionalMailHeader' => $datarray['headers']
694 * @brief Checks for users who should be notified
696 * @param int $itemid ID of the item for which the check should be done
697 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
699 function check_user_notification($itemid) {
700 // fetch all users in the thread
701 $users = DBA::p("SELECT DISTINCT(`contact`.`uid`) FROM `item`
702 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` != 0
703 WHERE `parent` IN (SELECT `parent` FROM `item` WHERE `id`=?)", $itemid);
704 while ($user = DBA::fetch($users)) {
705 check_item_notification($itemid, $user['uid']);
711 * @brief Checks for item related notifications and sends them
713 * @param int $itemid ID of the item for which the check should be done
714 * @param int $uid User ID
715 * @param string $defaulttype (Optional) Forces a notification with this type.
717 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
719 function check_item_notification($itemid, $uid, $defaulttype = "") {
720 $notification_data = ["uid" => $uid, "profiles" => []];
721 Hook::callAll('check_item_notification', $notification_data);
723 $profiles = $notification_data["profiles"];
725 $fields = ['nickname'];
726 $user = DBA::selectFirst('user', $fields, ['uid' => $uid]);
727 if (!DBA::isResult($user)) {
731 $owner = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
732 if (!DBA::isResult($owner)) {
736 // This is our regular URL format
737 $profiles[] = $owner["url"];
739 // Notifications from Diaspora are often with an URL in the Diaspora format
740 $profiles[] = System::baseUrl()."/u/".$user["nickname"];
744 foreach ($profiles AS $profile) {
745 // Check for invalid profile urls. 13 should be the shortest possible profile length:
747 // Additionally check for invalid urls that would return the normalised value "http:"
748 if ((strlen($profile) >= 13) && (Strings::normaliseLink($profile) != "http:")) {
749 if (!in_array($profile, $profiles2))
750 $profiles2[] = $profile;
752 $profile = Strings::normaliseLink($profile);
753 if (!in_array($profile, $profiles2))
754 $profiles2[] = $profile;
756 $profile = str_replace("http://", "https://", $profile);
757 if (!in_array($profile, $profiles2))
758 $profiles2[] = $profile;
762 $profiles = $profiles2;
764 $ret = DBA::select('contact', ['id'], ['uid' => 0, 'nurl' => $profiles]);
768 while ($contact = DBA::fetch($ret)) {
769 $contacts[] = $contact['id'];
774 // Only act if it is a "real" post
775 // We need the additional check for the "local_profile" because of mixed situations on connector networks
776 $fields = ['id', 'mention', 'tag', 'parent', 'title', 'body',
777 'author-link', 'author-name', 'author-avatar', 'author-id',
778 'guid', 'parent-uri', 'uri', 'contact-id', 'network'];
779 $condition = ['id' => $itemid, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT], 'deleted' => false];
780 $item = Item::selectFirstForUser($uid, $fields, $condition);
781 if (!DBA::isResult($item) || in_array($item['author-id'], $contacts)) {
785 // Generate the notification array
787 $params["uid"] = $uid;
788 $params["item"] = $item;
789 $params["parent"] = $item["parent"];
790 $params["link"] = System::baseUrl().'/display/'.urlencode($item["guid"]);
791 $params["otype"] = 'item';
792 $params["source_name"] = $item["author-name"];
793 $params["source_link"] = $item["author-link"];
794 $params["source_photo"] = $item["author-avatar"];
796 if ($item["parent-uri"] === $item["uri"]) {
797 // Send a notification for every new post?
798 $send_notification = DBA::exists('contact', ['id' => $item['contact-id'], 'notify_new_posts' => true]);
800 if (!$send_notification) {
801 $tags = q("SELECT `url` FROM `term` WHERE `otype` = %d AND `oid` = %d AND `type` = %d AND `uid` = %d",
802 intval(TERM_OBJ_POST), intval($itemid), intval(TERM_MENTION), intval($uid));
804 if (DBA::isResult($tags)) {
805 foreach ($tags AS $tag) {
806 $condition = ['nurl' => Strings::normaliseLink($tag["url"]), 'uid' => $uid, 'notify_new_posts' => true];
807 $r = DBA::exists('contact', $condition);
809 $send_notification = true;
815 if ($send_notification) {
816 $params["type"] = NOTIFY_SHARE;
817 $params["verb"] = Activity::TAG;
821 // Is the user mentioned in this post?
824 foreach ($profiles AS $profile) {
825 if (strpos($item["tag"], "=".$profile."]") || strpos($item["body"], "=".$profile."]"))
829 if ($item["mention"] || $tagged || ($defaulttype == NOTIFY_TAGSELF)) {
830 $params["type"] = NOTIFY_TAGSELF;
831 $params["verb"] = Activity::TAG;
834 // Is it a post that the user had started?
835 $fields = ['ignored', 'mention'];
836 $thread = Item::selectFirstThreadForUser($params['uid'], $fields, ['iid' => $item["parent"], 'deleted' => false]);
838 if ($thread['mention'] && !$thread['ignored'] && !isset($params["type"])) {
839 $params["type"] = NOTIFY_COMMENT;
840 $params["verb"] = Activity::POST;
843 // And now we check for participation of one of our contacts in the thread
844 $condition = ['parent' => $item["parent"], 'author-id' => $contacts, 'deleted' => false];
846 if (!$thread['ignored'] && !isset($params["type"]) && Item::exists($condition)) {
847 $params["type"] = NOTIFY_COMMENT;
848 $params["verb"] = Activity::POST;
851 if (isset($params["type"])) {
852 notification($params);
857 * @brief Formats a notification message with the notification author
859 * Replace the name with {0} but ensure to make that only once. The {0} is used
860 * later and prints the name in bold.
862 * @param string $name
863 * @param string $message
864 * @return string Formatted message
866 function format_notification_message($name, $message) {
868 $pos = strpos($message, $name);
873 if ($pos !== false) {
874 $message = substr_replace($message, '{0}', $pos, strlen($name));