src/Module/Conversation/Timeline.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, 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\Module\Conversation;
  23
  24 use Friendica\App;
  25 use Friendica\App\Mode;
  26 use Friendica\BaseModule;
  27 use Friendica\Content\Conversation\Collection\Timelines;
  28 use Friendica\Content\Conversation\Entity\Timeline as TimelineEntity;
  29 use Friendica\Core\Cache\Capability\ICanCache;
  30 use Friendica\Core\Cache\Enum\Duration;
  31 use Friendica\Core\Config\Capability\IManageConfigValues;
  32 use Friendica\Core\L10n;
  33 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
  34 use Friendica\Core\Renderer;
  35 use Friendica\Core\Session\Capability\IHandleUserSessions;
  36 use Friendica\Model\Contact;
  37 use Friendica\Model\User;
  38 use Friendica\Database\Database;
  39 use Friendica\Database\DBA;
  40 use Friendica\Model\Item;
  41 use Friendica\Model\Post;
  42 use Friendica\Module\Response;
  43 use Friendica\Util\DateTimeFormat;
  44 use Friendica\Util\Profiler;
  45 use Psr\Log\LoggerInterface;
  46
  47 class Timeline extends BaseModule
  48 {
  49         /** @var string */
  50         protected $selectedTab;
  51         /** @var mixed */
  52         protected $minId;
  53         /** @var mixed */
  54         protected $maxId;
  55         /** @var string */
  56         protected $accountTypeString;
  57         /** @var int */
  58         protected $accountType;
  59         /** @var int */
  60         protected $itemUriId;
  61         /** @var int */
  62         protected $itemsPerPage;
  63         /** @var bool */
  64         protected $noSharer;
  65
  66         /** @var App\Mode $mode */
  67         protected $mode;
  68         /** @var IHandleUserSessions */
  69         protected $session;
  70         /** @var Database */
  71         protected $database;
  72         /** @var IManagePersonalConfigValues */
  73         protected $pConfig;
  74         /** @var IManageConfigValues The config */
  75         protected $config;
  76         /** @var ICanCache */
  77         protected $cache;
  78
  79         public function __construct(Mode $mode, IHandleUserSessions $session, Database $database, IManagePersonalConfigValues $pConfig, IManageConfigValues $config, ICanCache $cache, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
  80         {
  81                 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
  82
  83                 $this->mode     = $mode;
  84                 $this->session  = $session;
  85                 $this->database = $database;
  86                 $this->pConfig  = $pConfig;
  87                 $this->config   = $config;
  88                 $this->cache    = $cache;
  89         }
  90
  91         /**
  92          * Computes module parameters from the request and local configuration
  93          *
  94          * @throws HTTPException\BadRequestException
  95          * @throws HTTPException\ForbiddenException
  96          */
  97         protected function parseRequest(array $request)
  98         {
  99                 $this->logger->debug('Got request', $request);
 100                 $this->selectedTab = $this->parameters['content'] ?? $request['channel'] ?? '';
 101
 102                 $this->accountTypeString = $request['accounttype'] ?? $this->parameters['accounttype'] ?? '';
 103                 $this->accountType       = User::getAccountTypeByString($this->accountTypeString);
 104
 105                 if ($this->mode->isMobile()) {
 106                         $this->itemsPerPage = $this->pConfig->get(
 107                                 $this->session->getLocalUserId(),
 108                                 'system',
 109                                 'itemspage_mobile_network',
 110                                 $this->config->get('system', 'itemspage_network_mobile')
 111                         );
 112                 } else {
 113                         $this->itemsPerPage = $this->pConfig->get(
 114                                 $this->session->getLocalUserId(),
 115                                 'system',
 116                                 'itemspage_network',
 117                                 $this->config->get('system', 'itemspage_network')
 118                         );
 119                 }
 120
 121                 if (!empty($request['item'])) {
 122                         $item            = Post::selectFirst(['parent', 'parent-uri-id'], ['id' => $request['item']]);
 123                         $this->itemUriId = $item['parent-uri-id'] ?? 0;
 124                 } else {
 125                         $this->itemUriId = 0;
 126                 }
 127
 128                 $this->minId = $request['min_id'] ?? null;
 129                 $this->maxId = $request['max_id'] ?? null;
 130
 131                 $this->noSharer = !empty($request['no_sharer']);
 132         }
 133
 134         protected function getNoSharerWidget(string $base): string
 135         {
 136                 $path = $this->selectedTab;
 137                 if (!empty($this->accountTypeString)) {
 138                         $path .= '/' . $this->accountTypeString;
 139                 }
 140                 $query_parameters = [];
 141
 142                 if (!empty($this->minId)) {
 143                         $query_parameters['min_id'] = $this->minId;
 144                 }
 145                 if (!empty($this->maxId)) {
 146                         $query_parameters['max_id'] = $this->maxId;
 147                 }
 148
 149                 $path_all       = $path . (!empty($query_parameters) ? '?' . http_build_query($query_parameters) : '');
 150                 $path_no_sharer = $path . '?' . http_build_query(array_merge($query_parameters, ['no_sharer' => true]));
 151                 return Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/community_sharer.tpl'), [
 152                         '$title'           => $this->l10n->t('Own Contacts'),
 153                         '$path_all'        => $path_all,
 154                         '$path_no_sharer'  => $path_no_sharer,
 155                         '$no_sharer'       => $this->noSharer,
 156                         '$all'             => $this->l10n->t('Include'),
 157                         '$no_sharer_label' => $this->l10n->t('Hide'),
 158                         '$base'            => $base,
 159                 ]);
 160         }
 161
 162         protected function getTabArray(Timelines $timelines, string $prefix, string $parameter = ''): array
 163         {
 164                 $tabs = [];
 165
 166                 foreach ($timelines as $tab) {
 167                         if (is_null($tab->path) && !empty($parameter)) {
 168                                 $path = $prefix . '?' . http_build_query([$parameter => $tab->code]);
 169                         } else {
 170                                 $path = $tab->path ?? $prefix . '/' . $tab->code;
 171                         }
 172                         $tabs[$tab->code] = [
 173                                 'label'     => $tab->label,
 174                                 'url'       => $path,
 175                                 'sel'       => $this->selectedTab == $tab->code ? 'active' : '',
 176                                 'title'     => $tab->description,
 177                                 'id'        => $prefix . '-' . $tab->code . '-tab',
 178                                 'accesskey' => $tab->accessKey,
 179                         ];
 180                 }
 181                 return $tabs;
 182         }
 183
 184         /**
 185          * Database query for the channel page
 186          *
 187          * @return array
 188          * @throws \Exception
 189          */
 190         protected function getChannelItems()
 191         {
 192                 $uid = $this->session->getLocalUserId();
 193
 194                 if ($this->selectedTab == TimelineEntity::WHATSHOT) {
 195                         if (!is_null($this->accountType)) {
 196                                 $condition = ["(`comments` >= ? OR `activities` >= ?) AND `contact-type` = ?", $this->getMedianComments($uid, 4), $this->getMedianActivities($uid, 4), $this->accountType];
 197                         } else {
 198                                 $condition = ["(`comments` >= ? OR `activities` >= ?) AND `contact-type` != ?", $this->getMedianComments($uid, 4), $this->getMedianActivities($uid, 4), Contact::TYPE_COMMUNITY];
 199                         }
 200                 } elseif ($this->selectedTab == TimelineEntity::FORYOU) {
 201                         $cid = Contact::getPublicIdByUserId($uid);
 202
 203                         $condition = [
 204                                 "(`owner-id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `relation-thread-score` > ?) OR
 205                                 ((`comments` >= ? OR `activities` >= ?) AND `owner-id` IN (SELECT `cid` FROM `contact-relation` WHERE `follows` AND `relation-cid` = ?)) OR
 206                                 (`owner-id` IN (SELECT `pid` FROM `account-user-view` WHERE `uid` = ? AND `rel` IN (?, ?) AND `notify_new_posts`)))",
 207                                 $cid, $this->getMedianRelationThreadScore($cid, 4), $this->getMedianComments($uid, 4), $this->getMedianActivities($uid, 4), $cid,
 208                                 $uid, Contact::FRIEND, Contact::SHARING
 209                         ];
 210                 } elseif ($this->selectedTab == TimelineEntity::FOLLOWERS) {
 211                         $condition = ["`owner-id` IN (SELECT `pid` FROM `account-user-view` WHERE `uid` = ? AND `rel` = ?)", $uid, Contact::FOLLOWER];
 212                 } elseif ($this->selectedTab == TimelineEntity::SHARERSOFSHARERS) {
 213                         $cid = Contact::getPublicIdByUserId($uid);
 214
 215                         // @todo Suggest posts from contacts that are followed most by our followers
 216                         $condition = [
 217                                 "`owner-id` IN (SELECT `cid` FROM `contact-relation` WHERE `follows` AND `last-interaction` > ?
 218                                 AND `relation-cid` IN (SELECT `cid` FROM `contact-relation` WHERE `follows` AND `relation-cid` = ? AND `relation-thread-score` >= ?)
 219                                 AND NOT `cid` IN (SELECT `cid` FROM `contact-relation` WHERE `follows` AND `relation-cid` = ?))",
 220                                 DateTimeFormat::utc('now - ' . $this->config->get('channel', 'sharer_interaction_days') . ' day'), $cid, $this->getMedianRelationThreadScore($cid, 4), $cid
 221                         ];
 222                 } elseif ($this->selectedTab == TimelineEntity::IMAGE) {
 223                         $condition = ["`media-type` & ?", 1];
 224                 } elseif ($this->selectedTab == TimelineEntity::VIDEO) {
 225                         $condition = ["`media-type` & ?", 2];
 226                 } elseif ($this->selectedTab == TimelineEntity::AUDIO) {
 227                         $condition = ["`media-type` & ?", 4];
 228                 } elseif ($this->selectedTab == TimelineEntity::LANGUAGE) {
 229                         $condition = ["JSON_EXTRACT(JSON_KEYS(language), '$[0]') = ?", $this->l10n->convertCodeForLanguageDetection(User::getLanguageCode($uid))];
 230                 }
 231
 232                 if ($this->selectedTab != TimelineEntity::LANGUAGE) {
 233                         $condition = $this->addLanguageCondition($uid, $condition);
 234                 }
 235
 236                 $condition = DBA::mergeConditions($condition, ["NOT EXISTS(SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `post-engagement`.`owner-id` AND (`ignored` OR `blocked` OR `collapsed`))", $uid]);
 237
 238                 if (($this->selectedTab != TimelineEntity::WHATSHOT) && !is_null($this->accountType)) {
 239                         $condition = DBA::mergeConditions($condition, ['contact-type' => $this->accountType]);
 240                 }
 241
 242                 $params = ['order' => ['created' => true], 'limit' => $this->itemsPerPage];
 243
 244                 if (!empty($this->itemUriId)) {
 245                         $condition = DBA::mergeConditions($condition, ['uri-id' => $this->itemUriId]);
 246                 } else {
 247                         if ($this->noSharer) {
 248                                 $condition = DBA::mergeConditions($condition, ["NOT `uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `post-user`.`uid` = ? AND `post-user`.`uri-id` = `post-engagement`.`uri-id`)", $this->session->getLocalUserId()]);
 249                         }
 250
 251                         if (isset($this->maxId)) {
 252                                 $condition = DBA::mergeConditions($condition, ["`created` < ?", $this->maxId]);
 253                         }
 254
 255                         if (isset($this->minId)) {
 256                                 $condition = DBA::mergeConditions($condition, ["`created` > ?", $this->minId]);
 257
 258                                 // Previous page case: we want the items closest to min_id but for that we need to reverse the query order
 259                                 if (!isset($this->maxId)) {
 260                                         $params['order']['created'] = false;
 261                                 }
 262                         }
 263                 }
 264
 265                 $items = $this->database->selectToArray('post-engagement', ['uri-id', 'created'], $condition, $params);
 266                 if (empty($items)) {
 267                         return [];
 268                 }
 269
 270                 // Previous page case: once we get the relevant items closest to min_id, we need to restore the expected display order
 271                 if (empty($this->itemUriId) && isset($this->minId) && !isset($this->maxId)) {
 272                         $items = array_reverse($items);
 273                 }
 274
 275                 $condition = ['unseen' => true, 'uid' => $uid, 'parent-uri-id' => array_column($items, 'uri-id')];
 276                 $this->setItemsSeenByCondition($condition);
 277
 278                 return $items;
 279         }
 280
 281         private function addLanguageCondition(int $uid, array $condition): array
 282         {
 283                 $conditions = [];
 284                 $languages  = $this->pConfig->get($uid, 'channel', 'languages', [User::getLanguageCode($uid)]);
 285                 $languages  = $this->l10n->convertForLanguageDetection($languages);
 286                 foreach ($languages as $language) {
 287                         $conditions[] = "JSON_EXTRACT(JSON_KEYS(language), '$[0]') = ?";
 288                         $condition[]  = $language;
 289                 }
 290                 if (!empty($conditions)) {
 291                         $condition[0] .= " AND (`language` IS NULL OR " . implode(' OR ', $conditions) . ")";
 292                 }
 293                 return $condition;
 294         }
 295
 296         private function getMedianComments(int $uid, int $divider): int
 297         {
 298                 $languages = $this->pConfig->get($uid, 'channel', 'languages', [User::getLanguageCode($uid)]);
 299                 $cache_key = 'Channel:getMedianComments:' . $divider . ':' . implode(':', $languages);
 300                 $comments  = $this->cache->get($cache_key);
 301                 if (!empty($comments)) {
 302                         return $comments;
 303                 }
 304
 305                 $condition = ["`contact-type` != ? AND `comments` > ?", Contact::TYPE_COMMUNITY, 0];
 306                 $condition = $this->addLanguageCondition($uid, $condition);
 307
 308                 $limit    = $this->database->count('post-engagement', $condition) / $divider;
 309                 $post     = $this->database->selectToArray('post-engagement', ['comments'], $condition, ['order' => ['comments' => true], 'limit' => [$limit, 1]]);
 310                 $comments = $post[0]['comments'] ?? 0;
 311                 if (empty($comments)) {
 312                         return 0;
 313                 }
 314
 315                 $this->cache->set($cache_key, $comments, Duration::HALF_HOUR);
 316                 $this->logger->debug('Calculated median comments', ['divider' => $divider, 'languages' => $languages, 'median' => $comments]);
 317                 return $comments;
 318         }
 319
 320         private function getMedianActivities(int $uid, int $divider): int
 321         {
 322                 $languages  = $this->pConfig->get($uid, 'channel', 'languages', [User::getLanguageCode($uid)]);
 323                 $cache_key  = 'Channel:getMedianActivities:' . $divider . ':' . implode(':', $languages);
 324                 $activities = $this->cache->get($cache_key);
 325                 if (!empty($activities)) {
 326                         return $activities;
 327                 }
 328
 329                 $condition = ["`contact-type` != ? AND `activities` > ?", Contact::TYPE_COMMUNITY, 0];
 330                 $condition = $this->addLanguageCondition($uid, $condition);
 331
 332                 $limit      = $this->database->count('post-engagement', $condition) / $divider;
 333                 $post       = $this->database->selectToArray('post-engagement', ['activities'], $condition, ['order' => ['activities' => true], 'limit' => [$limit, 1]]);
 334                 $activities = $post[0]['activities'] ?? 0;
 335                 if (empty($activities)) {
 336                         return 0;
 337                 }
 338
 339                 $this->cache->set($cache_key, $activities, Duration::HALF_HOUR);
 340                 $this->logger->debug('Calculated median activities', ['divider' => $divider, 'languages' => $languages, 'median' => $activities]);
 341                 return $activities;
 342         }
 343
 344         private function getMedianRelationThreadScore(int $cid, int $divider): int
 345         {
 346                 $cache_key = 'Channel:getThreadScore:' . $cid . ':' . $divider;
 347                 $score     = $this->cache->get($cache_key);
 348                 if (!empty($score)) {
 349                         return $score;
 350                 }
 351
 352                 $condition = ["`relation-cid` = ? AND `relation-thread-score` > ?", $cid, 0];
 353
 354                 $limit    = $this->database->count('contact-relation', $condition) / $divider;
 355                 $relation = $this->database->selectToArray('contact-relation', ['relation-thread-score'], $condition, ['order' => ['relation-thread-score' => true], 'limit' => [$limit, 1]]);
 356                 $score    = $relation[0]['relation-thread-score'] ?? 0;
 357                 if (empty($score)) {
 358                         return 0;
 359                 }
 360
 361                 $this->cache->set($cache_key, $score, Duration::HALF_HOUR);
 362                 $this->logger->debug('Calculated median score', ['cid' => $cid, 'divider' => $divider, 'median' => $score]);
 363                 return $score;
 364         }
 365
 366         /**
 367          * Computes the displayed items.
 368          *
 369          * Community pages have a restriction on how many successive posts by the same author can show on any given page,
 370          * so we may have to retrieve more content beyond the first query
 371          *
 372          * @return array
 373          * @throws \Exception
 374          */
 375         protected function getCommunityItems()
 376         {
 377                 $items = $this->selectItems();
 378
 379                 $maxpostperauthor = (int) $this->config->get('system', 'max_author_posts_community_page');
 380                 if ($maxpostperauthor != 0 && $this->selectedTab == 'local') {
 381                         $count          = 1;
 382                         $previousauthor = '';
 383                         $numposts       = 0;
 384                         $selected_items = [];
 385
 386                         while (count($selected_items) < $this->itemsPerPage && ++$count < 50 && count($items) > 0) {
 387                                 foreach ($items as $item) {
 388                                         if ($previousauthor == $item["author-link"]) {
 389                                                 ++$numposts;
 390                                         } else {
 391                                                 $numposts = 0;
 392                                         }
 393                                         $previousauthor = $item["author-link"];
 394
 395                                         if (($numposts < $maxpostperauthor) && (count($selected_items) < $this->itemsPerPage)) {
 396                                                 $selected_items[] = $item;
 397                                         }
 398                                 }
 399
 400                                 // If we're looking at a "previous page", the lookup continues forward in time because the list is
 401                                 // sorted in chronologically decreasing order
 402                                 if (isset($this->minId)) {
 403                                         $this->minId = $items[0]['commented'];
 404                                 } else {
 405                                         // In any other case, the lookup continues backwards in time
 406                                         $this->maxId = $items[count($items) - 1]['commented'];
 407                                 }
 408
 409                                 $items = $this->selectItems();
 410                         }
 411                 } else {
 412                         $selected_items = $items;
 413                 }
 414
 415                 $condition = ['unseen' => true, 'uid' => $this->session->getLocalUserId(), 'parent-uri-id' => array_column($selected_items, 'uri-id')];
 416                 $this->setItemsSeenByCondition($condition);
 417
 418                 return $selected_items;
 419         }
 420
 421         /**
 422          * Database query for the community page
 423          *
 424          * @return array
 425          * @throws \Exception
 426          * @TODO Move to repository/factory
 427          */
 428         private function selectItems()
 429         {
 430                 if ($this->selectedTab == 'local') {
 431                         if (!is_null($this->accountType)) {
 432                                 $condition = ["`wall` AND `origin` AND `private` = ? AND `owner-contact-type` = ?", Item::PUBLIC, $this->accountType];
 433                         } else {
 434                                 $condition = ["`wall` AND `origin` AND `private` = ?", Item::PUBLIC];
 435                         }
 436                 } elseif ($this->selectedTab == 'global') {
 437                         if (!is_null($this->accountType)) {
 438                                 $condition = ["`uid` = ? AND `private` = ? AND `owner-contact-type` = ?", 0, Item::PUBLIC, $this->accountType];
 439                         } else {
 440                                 $condition = ["`uid` = ? AND `private` = ?", 0, Item::PUBLIC];
 441                         }
 442                 } else {
 443                         return [];
 444                 }
 445
 446                 $params = ['order' => ['commented' => true], 'limit' => $this->itemsPerPage];
 447
 448                 if (!empty($this->itemUriId)) {
 449                         $condition = DBA::mergeConditions($condition, ['uri-id' => $this->itemUriId]);
 450                 } else {
 451                         if ($this->session->getLocalUserId() && $this->noSharer) {
 452                                 $condition = DBA::mergeConditions($condition, ["NOT `uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `post-user`.`uid` = ? AND `post-user`.`uri-id` = `post-thread-user-view`.`uri-id`)", $this->session->getLocalUserId()]);
 453                         }
 454
 455                         if (isset($this->maxId)) {
 456                                 $condition = DBA::mergeConditions($condition, ["`commented` < ?", $this->maxId]);
 457                         }
 458
 459                         if (isset($this->minId)) {
 460                                 $condition = DBA::mergeConditions($condition, ["`commented` > ?", $this->minId]);
 461
 462                                 // Previous page case: we want the items closest to min_id but for that we need to reverse the query order
 463                                 if (!isset($this->maxId)) {
 464                                         $params['order']['commented'] = false;
 465                                 }
 466                         }
 467                 }
 468
 469                 $r = Post::selectThreadForUser($this->session->getLocalUserId() ?: 0, ['uri-id', 'commented', 'author-link'], $condition, $params);
 470
 471                 $items = Post::toArray($r);
 472                 if (empty($items)) {
 473                         return [];
 474                 }
 475
 476                 // Previous page case: once we get the relevant items closest to min_id, we need to restore the expected display order
 477                 if (empty($this->itemUriId) && isset($this->minId) && !isset($this->maxId)) {
 478                         $items = array_reverse($items);
 479                 }
 480
 481                 return $items;
 482         }
 483
 484         /**
 485          * Sets items as seen
 486          *
 487          * @param array $condition The array with the SQL condition
 488          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 489          */
 490         protected function setItemsSeenByCondition(array $condition)
 491         {
 492                 if (empty($condition)) {
 493                         return;
 494                 }
 495
 496                 $unseen = Post::exists($condition);
 497
 498                 if ($unseen) {
 499                         /// @todo handle huge "unseen" updates in the background to avoid timeout errors
 500                         Item::update(['unseen' => false], $condition);
 501                 }
 502         }
 503 }