src/Model/Notification.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   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 namespace Friendica\Model;
  23
  24 use Friendica\BaseModel;
  25 use Friendica\Content\Text\BBCode;
  26 use Friendica\Content\Text\Plaintext;
  27 use Friendica\Core\Logger;
  28 use Friendica\Database\Database;
  29 use Friendica\DI;
  30 use Friendica\Network\HTTPException\InternalServerErrorException;
  31 use Friendica\Protocol\Activity;
  32 use Psr\Log\LoggerInterface;
  33
  34 /**
  35  * Model for an entry in the notify table
  36  *
  37  * @property string  hash
  38  * @property integer type
  39  * @property string  name   Full name of the contact subject
  40  * @property string  url    Profile page URL of the contact subject
  41  * @property string  photo  Profile photo URL of the contact subject
  42  * @property string  date   YYYY-MM-DD hh:mm:ss local server time
  43  * @property string  msg
  44  * @property integer uid        Owner User Id
  45  * @property string  link   Notification URL
  46  * @property integer iid        Item Id
  47  * @property integer parent Parent Item Id
  48  * @property boolean seen   Whether the notification was read or not.
  49  * @property string  verb   Verb URL (@see http://activitystrea.ms)
  50  * @property string  otype  Subject type ('item', 'intro' or 'mail')
  51  *
  52  * @property-read string name_cache Full name of the contact subject
  53  * @property-read string msg_cache  Plaintext version of the notification text with a placeholder (`{0}`) for the subject contact's name.
  54  */
  55 class Notification extends BaseModel
  56 {
  57         /** @var \Friendica\Repository\Notification */
  58         private $repo;
  59
  60         public function __construct(Database $dba, LoggerInterface $logger, \Friendica\Repository\Notification $repo, array $data = [])
  61         {
  62                 parent::__construct($dba, $logger, $data);
  63
  64                 $this->repo = $repo;
  65
  66                 $this->setNameCache();
  67                 $this->setMsgCache();
  68         }
  69
  70         /**
  71          * Sets the pre-formatted name (caching)
  72          */
  73         private function setNameCache()
  74         {
  75                 try {
  76                         $this->name_cache = strip_tags(BBCode::convert($this->source_name));
  77                 } catch (InternalServerErrorException $e) {
  78                 }
  79         }
  80
  81         /**
  82          * Sets the pre-formatted msg (caching)
  83          */
  84         private function setMsgCache()
  85         {
  86                 try {
  87                         $this->msg_cache = self::formatMessage($this->name_cache, strip_tags(BBCode::convert($this->msg)));
  88                 } catch (InternalServerErrorException $e) {
  89                 }
  90         }
  91
  92         public function __set($name, $value)
  93         {
  94                 parent::__set($name, $value);
  95
  96                 if ($name == 'msg') {
  97                         $this->setMsgCache();
  98                 }
  99
 100                 if ($name == 'source_name') {
 101                         $this->setNameCache();
 102                 }
 103         }
 104
 105         /**
 106          * Formats a notification message with the notification author
 107          *
 108          * Replace the name with {0} but ensure to make that only once. The {0} is used
 109          * later and prints the name in bold.
 110          *
 111          * @param string $name
 112          * @param string $message
 113          *
 114          * @return string Formatted message
 115          */
 116         public static function formatMessage($name, $message)
 117         {
 118                 if ($name != '') {
 119                         $pos = strpos($message, $name);
 120                 } else {
 121                         $pos = false;
 122                 }
 123
 124                 if ($pos !== false) {
 125                         $message = substr_replace($message, '{0}', $pos, strlen($name));
 126                 }
 127
 128                 return $message;
 129         }
 130
 131         /**
 132          * Fetch the notification type for the given notification
 133          *
 134          * @param array $notification
 135          * @return string
 136          */
 137         public static function getType(array $notification): string
 138         {
 139                 if (($notification['vid'] == Verb::getID(Activity::FOLLOW)) && ($notification['type'] == Post\UserNotification::NOTIF_NONE)) {
 140                         $contact = Contact::getById($notification['actor-id'], ['pending']);
 141                         $type = $contact['pending'] ? 'follow_request' : 'follow';
 142                 } elseif (($notification['vid'] == Verb::getID(Activity::ANNOUNCE)) &&
 143                         in_array($notification['type'], [Post\UserNotification::NOTIF_DIRECT_COMMENT, Post\UserNotification::NOTIF_DIRECT_THREAD_COMMENT])) {
 144                         $type = 'reblog';
 145                 } elseif (in_array($notification['vid'], [Verb::getID(Activity::LIKE), Verb::getID(Activity::DISLIKE)]) &&
 146                         in_array($notification['type'], [Post\UserNotification::NOTIF_DIRECT_COMMENT, Post\UserNotification::NOTIF_DIRECT_THREAD_COMMENT])) {
 147                         $type = 'favourite';
 148                 } elseif ($notification['type'] == Post\UserNotification::NOTIF_SHARED) {
 149                         $type = 'status';
 150                 } elseif (in_array($notification['type'], [Post\UserNotification::NOTIF_EXPLICIT_TAGGED,
 151                         Post\UserNotification::NOTIF_IMPLICIT_TAGGED, Post\UserNotification::NOTIF_DIRECT_COMMENT,
 152                         Post\UserNotification::NOTIF_DIRECT_THREAD_COMMENT, Post\UserNotification::NOTIF_THREAD_COMMENT])) {
 153                         $type = 'mention';
 154                 } else {
 155                         return '';
 156                 }
 157
 158                 return $type;
 159         }
 160
 161         /**
 162          * Create a notification message for the given notification
 163          *
 164          * @param array $notification
 165          * @return array with the elements "causer", "notification", "plain" and "rich"
 166          */
 167         public static function getMessage(array $notification)
 168         {
 169                 $message = [];
 170
 171                 if ($notification['type'] == Post\UserNotification::NOTIF_NONE) {
 172                         return $message;
 173                 }
 174
 175                 if (empty($notification['target-uri-id'])) {
 176                         return $message;
 177                 }
 178
 179                 $user = User::getById($notification['uid']);
 180                 if (empty($user)) {
 181                         Logger::info('User not found', ['application' => $notification['uid']]);
 182                         return $message;
 183                 }
 184
 185                 $causer = $contact = Contact::getById($notification['actor-id'], ['id', 'name', 'url']);
 186                 if (empty($contact)) {
 187                         Logger::info('Contact not found', ['contact' => $notification['actor-id']]);
 188                         return $message;
 189                 }
 190
 191                 $like     = Verb::getID(Activity::LIKE);
 192                 $dislike  = Verb::getID(Activity::DISLIKE);
 193                 $announce = Verb::getID(Activity::ANNOUNCE);
 194                 $post     = Verb::getID(Activity::POST);
 195
 196                 if (in_array($notification['type'], [Post\UserNotification::NOTIF_THREAD_COMMENT, Post\UserNotification::NOTIF_COMMENT_PARTICIPATION, Post\UserNotification::NOTIF_ACTIVITY_PARTICIPATION, Post\UserNotification::NOTIF_EXPLICIT_TAGGED])) {
 197                         $item = Post::selectFirst([], ['uri-id' => $notification['parent-uri-id'], 'uid' => [0, $notification['uid']]], ['order' => ['uid' => true]]);
 198                         if (empty($item)) {
 199                                 Logger::info('Parent post not found', ['uri-id' => $notification['parent-uri-id']]);
 200                                 return $message;
 201                         }
 202                 } else {
 203                         $item = Post::selectFirst([], ['uri-id' => $notification['target-uri-id'], 'uid' => [0, $notification['uid']]], ['order' => ['uid' => true]]);
 204                         if (empty($item)) {
 205                                 Logger::info('Post not found', ['uri-id' => $notification['target-uri-id']]);
 206                                 return $message;
 207                         }
 208
 209                         if ($notification['vid'] == $post) {
 210                                 $item = Post::selectFirst([], ['uri-id' => $item['thr-parent-id'], 'uid' => [0, $notification['uid']]], ['order' => ['uid' => true]]);
 211                                 if (empty($item)) {
 212                                         Logger::info('Thread parent post not found', ['uri-id' => $item['thr-parent-id']]);
 213                                         return $message;
 214                                 }
 215                         }
 216                 }
 217
 218                 if (($notification['type'] == Post\UserNotification::NOTIF_SHARED) && !empty($item['causer-id'])) {
 219                         $causer = Contact::getById($item['causer-id'], ['id', 'name', 'url']);
 220                         if (empty($contact)) {
 221                                 Logger::info('Causer not found', ['causer' => $item['causer-id']]);
 222                                 return $message;
 223                         }
 224                 } elseif (in_array($notification['type'], [Post\UserNotification::NOTIF_COMMENT_PARTICIPATION, Post\UserNotification::NOTIF_ACTIVITY_PARTICIPATION])) {
 225                         $contact = Contact::getById($item['author-id'], ['id', 'name', 'url']);
 226                         if (empty($contact)) {
 227                                 Logger::info('Author not found', ['author' => $item['author-id']]);
 228                                 return $message;
 229                         }
 230                 }
 231
 232                 $link = DI::baseUrl() . '/display/' . urlencode($item['guid']);
 233
 234                 $content = Plaintext::getPost($item, 70);
 235                 if (!empty($content['text'])) {
 236                         $title = '"' . trim(str_replace("\n", " ", $content['text'])) . '"';
 237                 } else {
 238                         $title = '';
 239                 }
 240
 241                 $l10n = DI::l10n()->withLang($user['language']);
 242
 243                 switch ($notification['vid']) {
 244                         case $like:
 245                                 switch ($notification['type']) {
 246                                         case Post\UserNotification::NOTIF_DIRECT_COMMENT:
 247                                                 $msg = $l10n->t('%1$s liked your comment %2$s');
 248                                                 break;
 249                                         case Post\UserNotification::NOTIF_DIRECT_THREAD_COMMENT:
 250                                                 $msg = $l10n->t('%1$s liked your post %2$s');
 251                                                 break;
 252                                         }
 253                                 break;
 254                         case $dislike:
 255                                 switch ($notification['type']) {
 256                                         case Post\UserNotification::NOTIF_DIRECT_COMMENT:
 257                                                 $msg = $l10n->t('%1$s disliked your comment %2$s');
 258                                                 break;
 259                                         case Post\UserNotification::NOTIF_DIRECT_THREAD_COMMENT:
 260                                                 $msg = $l10n->t('%1$s disliked your post %2$s');
 261                                                 break;
 262                                 }
 263                                 break;
 264                         case $announce:
 265                                 switch ($notification['type']) {
 266                                         case Post\UserNotification::NOTIF_DIRECT_COMMENT:
 267                                                 $msg = $l10n->t('%1$s shared your comment %2$s');
 268                                                 break;
 269                                         case Post\UserNotification::NOTIF_DIRECT_THREAD_COMMENT:
 270                                                 $msg = $l10n->t('%1$s shared your post %2$s');
 271                                                 break;
 272                                         }
 273                                 break;
 274                         case $post:
 275                                 switch ($notification['type']) {
 276                                         case Post\UserNotification::NOTIF_EXPLICIT_TAGGED:
 277                                                 $msg = $l10n->t('%1$s tagged you on %2$s');
 278                                                 break;
 279
 280                                         case Post\UserNotification::NOTIF_IMPLICIT_TAGGED:
 281                                                 $msg = $l10n->t('%1$s replied to you on %2$s');
 282                                                 break;
 283
 284                                         case Post\UserNotification::NOTIF_THREAD_COMMENT:
 285                                                 $msg = $l10n->t('%1$s commented in your thread %2$s');
 286                                                 break;
 287
 288                                         case Post\UserNotification::NOTIF_DIRECT_COMMENT:
 289                                                 $msg = $l10n->t('%1$s commented on your comment %2$s');
 290                                                 break;
 291
 292                                         case Post\UserNotification::NOTIF_COMMENT_PARTICIPATION:
 293                                         case Post\UserNotification::NOTIF_ACTIVITY_PARTICIPATION:
 294                                                 if (($causer['id'] == $contact['id']) && ($title != '')) {
 295                                                         $msg = $l10n->t('%1$s commented in their thread %2$s');
 296                                                 } elseif ($causer['id'] == $contact['id']) {
 297                                                         $msg = $l10n->t('%1$s commented in their thread');
 298                                                 } elseif ($title != '') {
 299                                                         $msg = $l10n->t('%1$s commented in the thread %2$s from %3$s');
 300                                                 } else {
 301                                                         $msg = $l10n->t('%1$s commented in the thread from %3$s');
 302                                                 }
 303                                                 break;
 304
 305                                         case Post\UserNotification::NOTIF_DIRECT_THREAD_COMMENT:
 306                                                 $msg = $l10n->t('%1$s commented on your thread %2$s');
 307                                                 break;
 308
 309                                         case Post\UserNotification::NOTIF_SHARED:
 310                                                 if (($causer['id'] != $contact['id']) && ($title != '')) {
 311                                                         $msg = $l10n->t('%1$s shared the post %2$s from %3$s');
 312                                                 } elseif ($causer['id'] != $contact['id']) {
 313                                                         $msg = $l10n->t('%1$s shared a post from %3$s');
 314                                                 } elseif ($title != '') {
 315                                                         $msg = $l10n->t('%1$s shared the post %2$s');
 316                                                 } else {
 317                                                         $msg = $l10n->t('%1$s shared a post');
 318                                                 }
 319                                                 break;
 320                                 }
 321                                 break;
 322                 }
 323
 324                 if (!empty($msg)) {
 325                         // Name of the notification's causer
 326                         $message['causer'] = $causer['name'];
 327                         // Format for the "ping" mechanism
 328                         $message['notification'] = sprintf($msg, '{0}', $title, $contact['name']);
 329                         // Plain text for the web push api
 330                         $message['plain']        = sprintf($msg, $causer['name'], $title, $contact['name']);
 331                         // Rich text for other purposes
 332                         $message['rich']         = sprintf($msg,
 333                                 '[url=' . $causer['url'] . ']' . $causer['name'] . '[/url]',
 334                                 '[url=' . $link . ']' . $title . '[/url]',
 335                                 '[url=' . $contact['url'] . ']' . $contact['name'] . '[/url]');
 336                 }
 337
 338                 return $message;
 339         }
 340 }