src/Module/Conversation/Channel.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\BoundariesPager;
  28 use Friendica\Content\Conversation;
  29 use Friendica\Content\Feature;
  30 use Friendica\Content\Nav;
  31 use Friendica\Content\Text\HTML;
  32 use Friendica\Content\Widget;
  33 use Friendica\Content\Widget\TrendingTags;
  34 use Friendica\Core\Cache\Capability\ICanCache;
  35 use Friendica\Core\Cache\Enum\Duration;
  36 use Friendica\Core\Config\Capability\IManageConfigValues;
  37 use Friendica\Core\L10n;
  38 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
  39 use Friendica\Core\Renderer;
  40 use Friendica\Core\Session\Capability\IHandleUserSessions;
  41 use Friendica\Model\Contact;
  42 use Friendica\Model\Post;
  43 use Friendica\Model\User;
  44 use Friendica\Module\Security\Login;
  45 use Friendica\Network\HTTPException;
  46 use Friendica\Core\Session\Model\UserSession;
  47 use Friendica\Database\Database;
  48 use Friendica\Model\Item;
  49 use Friendica\Module\Response;
  50 use Friendica\Navigation\SystemMessages;
  51 use Friendica\Util\Profiler;
  52 use Psr\Log\LoggerInterface;
  53
  54 class Channel extends BaseModule
  55 {
  56         const WHATSHOT  = 'whatshot';
  57         const FORYOU    = 'foryou';
  58         const FOLLOWERS = 'followers';
  59         const IMAGE     = 'image';
  60         const VIDEO     = 'video';
  61         const AUDIO     = 'audio';
  62         const LANGUAGE  = 'language';
  63
  64         protected static $content;
  65         protected static $accountTypeString;
  66         protected static $accountType;
  67         protected static $itemsPerPage;
  68         protected static $min_id;
  69         protected static $max_id;
  70         protected static $item_id;
  71
  72         /** @var UserSession */
  73         protected $session;
  74         /** @var ICanCache */
  75         protected $cache;
  76         /** @var IManageConfigValues The config */
  77         protected $config;
  78         /** @var SystemMessages */
  79         protected $systemMessages;
  80         /** @var App\Page */
  81         protected $page;
  82         /** @var Conversation */
  83         protected $conversation;
  84         /** @var App\Mode $mode */
  85         protected $mode;
  86         /** @var IManagePersonalConfigValues */
  87         protected $pConfig;
  88         /** @var Database */
  89         protected $database;
  90
  91
  92         public function __construct(SystemMessages $systemMessages, Database $database, IManagePersonalConfigValues $pConfig, Mode $mode, Conversation $conversation, App\Page $page, IManageConfigValues $config, ICanCache $cache, IHandleUserSessions $session, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
  93         {
  94                 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
  95
  96                 $this->systemMessages = $systemMessages;
  97                 $this->database       = $database;
  98                 $this->pConfig        = $pConfig;
  99                 $this->mode           = $mode;
 100                 $this->conversation   = $conversation;
 101                 $this->page           = $page;
 102                 $this->config         = $config;
 103                 $this->cache          = $cache;
 104                 $this->session        = $session;
 105         }
 106
 107         protected function content(array $request = []): string
 108         {
 109                 if (!$this->session->getLocalUserId()) {
 110                         return Login::form();
 111                 }
 112
 113                 $this->parseRequest($request);
 114
 115                 $t = Renderer::getMarkupTemplate("community.tpl");
 116                 $o = Renderer::replaceMacros($t, [
 117                         '$content' => '',
 118                         '$header'  => '',
 119                 ]);
 120
 121                 if ($this->pConfig->get($this->session->getLocalUserId(), 'system', 'infinite_scroll')) {
 122                         $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
 123                         $o .= Renderer::replaceMacros($tpl, ['$reload_uri' => $this->args->getQueryString()]);
 124                 }
 125
 126                 if (empty($request['mode']) || ($request['mode'] != 'raw')) {
 127                         $tabs = [];
 128
 129                         $tabs[] = [
 130                                 'label'     => $this->l10n->t('For you'),
 131                                 'url'       => 'channel/' . self::FORYOU,
 132                                 'sel'       => self::$content == self::FORYOU ? 'active' : '',
 133                                 'title'     => $this->l10n->t('Posts from contacts you interact with and who interact with you'),
 134                                 'id'        => 'channel-foryou-tab',
 135                                 'accesskey' => 'y'
 136                         ];
 137
 138                         $tabs[] = [
 139                                 'label'     => $this->l10n->t('Followers'),
 140                                 'url'       => 'channel/' . self::FOLLOWERS,
 141                                 'sel'       => self::$content == self::FOLLOWERS ? 'active' : '',
 142                                 'title'     => $this->l10n->t('Posts from your followers that you don\'t follow'),
 143                                 'id'        => 'channel-followers-tab',
 144                                 'accesskey' => 'f'
 145                         ];
 146
 147                         $tabs[] = [
 148                                 'label'     => $this->l10n->t('What\'s Hot'),
 149                                 'url'       => 'channel/' . self::WHATSHOT,
 150                                 'sel'       => self::$content == self::WHATSHOT ? 'active' : '',
 151                                 'title'     => $this->l10n->t('Posts with a lot of interactions'),
 152                                 'id'        => 'channel-whatshot-tab',
 153                                 'accesskey' => 'h'
 154                         ];
 155
 156                         $tabs[] = [
 157                                 'label'     => $this->l10n->t('Images'),
 158                                 'url'       => 'channel/' . self::IMAGE,
 159                                 'sel'       => self::$content == self::IMAGE ? 'active' : '',
 160                                 'title'     => $this->l10n->t('Posts with images'),
 161                                 'id'        => 'channel-image-tab',
 162                                 'accesskey' => 'i'
 163                         ];
 164
 165                         $tabs[] = [
 166                                 'label'     => $this->l10n->t('Videos'),
 167                                 'url'       => 'channel/' . self::VIDEO,
 168                                 'sel'       => self::$content == self::VIDEO ? 'active' : '',
 169                                 'title'     => $this->l10n->t('Posts with videos'),
 170                                 'id'        => 'channel-video-tab',
 171                                 'accesskey' => 'v'
 172                         ];
 173
 174                         $tabs[] = [
 175                                 'label'     => $this->l10n->t('Audio'),
 176                                 'url'       => 'channel/' . self::AUDIO,
 177                                 'sel'       => self::$content == self::AUDIO ? 'active' : '',
 178                                 'title'     => $this->l10n->t('Posts with audio'),
 179                                 'id'        => 'channel-audio-tab',
 180                                 'accesskey' => 'd'
 181                         ];
 182
 183                         $language  = User::getLanguageCode($this->session->getLocalUserId(), false);
 184                         $languages = $this->l10n->getAvailableLanguages();
 185
 186                         $tabs[] = [
 187                                 'label'     => $languages[$language],
 188                                 'url'       => 'channel/' . self::LANGUAGE,
 189                                 'sel'       => self::$content == self::LANGUAGE ? 'active' : '',
 190                                 'title'     => $this->l10n->t('Posts in %s', $languages[$language]),
 191                                 'id'        => 'channel-language-tab',
 192                                 'accesskey' => 'g'
 193                         ];
 194
 195                         $tab_tpl = Renderer::getMarkupTemplate('common_tabs.tpl');
 196                         $o .= Renderer::replaceMacros($tab_tpl, ['$tabs' => $tabs]);
 197
 198                         Nav::setSelected('channel');
 199
 200                         $this->page['aside'] .= Widget::accountTypes('channel/' . self::$content, self::$accountTypeString);
 201
 202                         if (!in_array(self::$content, [self::FOLLOWERS, self::FORYOU]) && $this->config->get('system', 'community_no_sharer')) {
 203                                 $path = self::$content;
 204                                 if (!empty($this->parameters['accounttype'])) {
 205                                         $path .= '/' . $this->parameters['accounttype'];
 206                                 }
 207                                 $query_parameters = [];
 208
 209                                 if (!empty($request['min_id'])) {
 210                                         $query_parameters['min_id'] = $request['min_id'];
 211                                 }
 212                                 if (!empty($request['max_id'])) {
 213                                         $query_parameters['max_id'] = $request['max_id'];
 214                                 }
 215                                 if (!empty($request['last_created'])) {
 216                                         $query_parameters['max_id'] = $request['last_created'];
 217                                 }
 218
 219                                 $path_all       = $path . (!empty($query_parameters) ? '?' . http_build_query($query_parameters) : '');
 220                                 $path_no_sharer = $path . '?' . http_build_query(array_merge($query_parameters, ['no_sharer' => true]));
 221                                 $this->page['aside'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/community_sharer.tpl'), [
 222                                         '$title'           => $this->l10n->t('Own Contacts'),
 223                                         '$path_all'        => $path_all,
 224                                         '$path_no_sharer'  => $path_no_sharer,
 225                                         '$no_sharer'       => !empty($request['no_sharer']),
 226                                         '$all'             => $this->l10n->t('Include'),
 227                                         '$no_sharer_label' => $this->l10n->t('Hide'),
 228                                         '$base'            => 'channel',
 229                                 ]);
 230                         }
 231
 232                         if (Feature::isEnabled($this->session->getLocalUserId(), 'trending_tags')) {
 233                                 $this->page['aside'] .= TrendingTags::getHTML(self::$content);
 234                         }
 235
 236                         // We need the editor here to be able to reshare an item.
 237                         $o .= $this->conversation->statusEditor([], 0, true);
 238                 }
 239
 240                 $items = $this->getItems($request);
 241
 242                 if (!$this->database->isResult($items)) {
 243                         $this->systemMessages->addNotice($this->l10n->t('No results.'));
 244                         return $o;
 245                 }
 246
 247                 $o .= $this->conversation->render($items, Conversation::MODE_CHANNEL, false, false, 'created', $this->session->getLocalUserId());
 248
 249                 $pager = new BoundariesPager(
 250                         $this->l10n,
 251                         $this->args->getQueryString(),
 252                         $items[0]['created'],
 253                         $items[count($items) - 1]['created'],
 254                         self::$itemsPerPage
 255                 );
 256
 257                 if ($this->pConfig->get($this->session->getLocalUserId(), 'system', 'infinite_scroll')) {
 258                         $o .= HTML::scrollLoader();
 259                 } else {
 260                         $o .= $pager->renderMinimal(count($items));
 261                 }
 262
 263                 return $o;
 264         }
 265
 266         /**
 267          * Computes module parameters from the request and local configuration
 268          *
 269          * @throws HTTPException\BadRequestException
 270          * @throws HTTPException\ForbiddenException
 271          */
 272         protected function parseRequest(array $request)
 273         {
 274                 self::$accountTypeString = $request['accounttype'] ?? $this->parameters['accounttype'] ?? '';
 275                 self::$accountType       = User::getAccountTypeByString(self::$accountTypeString);
 276
 277                 self::$content = $this->parameters['content'] ?? '';
 278                 if (!self::$content) {
 279                         self::$content = self::FORYOU;
 280                 }
 281
 282                 if (!in_array(self::$content, [self::WHATSHOT, self::FORYOU, self::FOLLOWERS, self::IMAGE, self::VIDEO, self::AUDIO, self::LANGUAGE])) {
 283                         throw new HTTPException\BadRequestException($this->l10n->t('Channel not available.'));
 284                 }
 285
 286                 if ($this->mode->isMobile()) {
 287                         self::$itemsPerPage = $this->pConfig->get(
 288                                 $this->session->getLocalUserId(),
 289                                 'system',
 290                                 'itemspage_mobile_network',
 291                                 $this->config->get('system', 'itemspage_network_mobile')
 292                         );
 293                 } else {
 294                         self::$itemsPerPage = $this->pConfig->get(
 295                                 $this->session->getLocalUserId(),
 296                                 'system',
 297                                 'itemspage_network',
 298                                 $this->config->get('system', 'itemspage_network')
 299                         );
 300                 }
 301
 302                 if (!empty($request['item'])) {
 303                         $item          = Post::selectFirst(['parent-uri-id'], ['id' => $request['item']]);
 304                         self::$item_id = $item['parent-uri-id'] ?? 0;
 305                 } else {
 306                         self::$item_id = 0;
 307                 }
 308
 309                 self::$min_id = $request['min_id']       ?? null;
 310                 self::$max_id = $request['last_created'] ?? $request['max_id'] ?? null;
 311         }
 312
 313         /**
 314          * Computes the displayed items.
 315          *
 316          * Community pages have a restriction on how many successive posts by the same author can show on any given page,
 317          * so we may have to retrieve more content beyond the first query
 318          *
 319          * @return array
 320          * @throws \Exception
 321          */
 322         protected function getItems(array $request)
 323         {
 324                 if (self::$content == self::WHATSHOT) {
 325                         if (!is_null(self::$accountType)) {
 326                                 $condition = ["(`comments` >= ? OR `activities` >= ?) AND `contact-type` = ?", $this->getMedianComments(4), $this->getMedianActivities(4), self::$accountType];
 327                         } else {
 328                                 $condition = ["(`comments` >= ? OR `activities` >= ?) AND `contact-type` != ?", $this->getMedianComments(4), $this->getMedianActivities(4), Contact::TYPE_COMMUNITY];
 329                         }
 330
 331                         $condition = $this->addLanguageCondition($condition);
 332                 } elseif (self::$content == self::FORYOU) {
 333                         $cid = Contact::getPublicIdByUserId($this->session->getLocalUserId());
 334
 335                         $condition = ["(`owner-id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `thread-score` > ?) OR
 336                                 ((`comments` >= ? OR `activities` >= ?) AND `owner-id` IN (SELECT `pid` FROM `account-user-view` WHERE `uid` = ? AND `rel` IN (?, ?))) OR
 337                                 ( `owner-id` IN (SELECT `pid` FROM `account-user-view` WHERE `uid` = ? AND `rel` IN (?, ?) AND `notify_new_posts`)))",
 338                                 $cid, $this->getMedianThreadScore($cid, 4), $this->getMedianComments(4), $this->getMedianActivities(4), $this->session->getLocalUserId(), Contact::FRIEND, Contact::SHARING,
 339                                 $this->session->getLocalUserId(), Contact::FRIEND, Contact::SHARING];
 340                 } elseif (self::$content == self::FOLLOWERS) {
 341                         $condition = ["`owner-id` IN (SELECT `pid` FROM `account-user-view` WHERE `uid` = ? AND `rel` = ?)", $this->session->getLocalUserId(), Contact::FOLLOWER];
 342                 } elseif (self::$content == self::IMAGE) {
 343                         $condition = ["`media-type` & ?", 1];
 344                 } elseif (self::$content == self::VIDEO) {
 345                         $condition = ["`media-type` & ?", 2];
 346                 } elseif (self::$content == self::AUDIO) {
 347                         $condition = ["`media-type` & ?", 4];
 348                 } elseif (self::$content == self::LANGUAGE) {
 349                         $condition = ["JSON_EXTRACT(JSON_KEYS(language), '$[0]') = ?", User::getLanguageCode($this->session->getLocalUserId(), true)];
 350                 }
 351
 352                 $condition[0] .= " AND NOT EXISTS(SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND `cid` = `post-engagement`.`owner-id` AND (`ignored` OR `blocked` OR `collapsed`))";
 353                 $condition[] = $this->session->getLocalUserId();
 354
 355                 if ((self::$content != self::WHATSHOT) && !is_null(self::$accountType)) {
 356                         $condition[0] .= " AND `contact-type` = ?";
 357                         $condition[] = self::$accountType;
 358                 }
 359
 360                 $params = ['order' => ['created' => true], 'limit' => self::$itemsPerPage];
 361
 362                 if (!empty(self::$item_id)) {
 363                         $condition[0] .= " AND `uri-id` = ?";
 364                         $condition[] = self::$item_id;
 365                 } else {
 366                         if (!empty($request['no_sharer'])) {
 367                                 $condition[0] .= " AND NOT `uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `post-user`.`uid` = ? AND `post-user`.`uri-id` = `post-engagement`.`uri-id`)";
 368                                 $condition[] = $this->session->getLocalUserId();
 369                         }
 370
 371                         if (isset(self::$max_id)) {
 372                                 $condition[0] .= " AND `created` < ?";
 373                                 $condition[] = self::$max_id;
 374                         }
 375
 376                         if (isset(self::$min_id)) {
 377                                 $condition[0] .= " AND `created` > ?";
 378                                 $condition[] = self::$min_id;
 379
 380                                 // Previous page case: we want the items closest to min_id but for that we need to reverse the query order
 381                                 if (!isset(self::$max_id)) {
 382                                         $params['order']['created'] = false;
 383                                 }
 384                         }
 385                 }
 386
 387                 $items = $this->database->selectToArray('post-engagement', ['uri-id', 'created'], $condition, $params);
 388                 if (empty($items)) {
 389                         return [];
 390                 }
 391
 392                 // Previous page case: once we get the relevant items closest to min_id, we need to restore the expected display order
 393                 if (empty(self::$item_id) && isset(self::$min_id) && !isset(self::$max_id)) {
 394                         $items = array_reverse($items);
 395                 }
 396
 397                 Item::update(['unseen' => false], ['unseen' => true, 'uid' => $this->session->getLocalUserId(), 'uri-id' => array_column($items, 'uri-id')]);
 398
 399                 return $items;
 400         }
 401
 402         private function addLanguageCondition(array $condition): array
 403         {
 404                 $conditions = [];
 405                 $languages = $this->pConfig->get($this->session->getLocalUserId(), 'channel', 'languages', [User::getLanguageCode($this->session->getLocalUserId(), false)]);
 406                 foreach ($languages as $language) {
 407                         $conditions[] = "JSON_EXTRACT(JSON_KEYS(language), '$[0]') = ?";
 408                         $condition[]  = substr($language, 0, 2);
 409                 }
 410                 if (!empty($conditions)) {
 411                         $condition[0] .= " AND (`language` IS NULL OR " . implode(' OR ', $conditions) . ")";
 412                 }
 413                 return $condition;
 414         }
 415
 416         private function getMedianComments(int $divider): int
 417         {
 418                 $cache_key = 'Channel:getMedianComments:' . $divider;
 419                 $comments  = $this->cache->get($cache_key);
 420                 if (!empty($comments)) {
 421                         return $comments;
 422                 }
 423
 424                 $limit    = $this->database->count('post-engagement', ["`contact-type` != ? AND `comments` > ?", Contact::TYPE_COMMUNITY, 0]) / $divider;
 425                 $post     = $this->database->selectToArray('post-engagement', ['comments'], ["`contact-type` != ?", Contact::TYPE_COMMUNITY], ['order' => ['comments' => true], 'limit' => [$limit, 1]]);
 426                 $comments = $post[0]['comments'] ?? 0;
 427                 if (empty($comments)) {
 428                         return 0;
 429                 }
 430
 431                 $this->cache->set($cache_key, $comments, Duration::HOUR);
 432                 return $comments;
 433         }
 434
 435         private function getMedianActivities(int $divider): int
 436         {
 437                 $cache_key  = 'Channel:getMedianActivities:' . $divider;
 438                 $activities = $this->cache->get($cache_key);
 439                 if (!empty($activities)) {
 440                         return $activities;
 441                 }
 442
 443                 $limit      = $this->database->count('post-engagement', ["`contact-type` != ? AND `activities` > ?", Contact::TYPE_COMMUNITY, 0]) / $divider;
 444                 $post       = $this->database->selectToArray('post-engagement', ['activities'], ["`contact-type` != ?", Contact::TYPE_COMMUNITY], ['order' => ['activities' => true], 'limit' => [$limit, 1]]);
 445                 $activities = $post[0]['activities'] ?? 0;
 446                 if (empty($activities)) {
 447                         return 0;
 448                 }
 449
 450                 $this->cache->set($cache_key, $activities, Duration::HOUR);
 451                 return $activities;
 452         }
 453
 454         private function getMedianThreadScore(int $cid, int $divider): int
 455         {
 456                 $cache_key = 'Channel:getThreadScore:' . $cid . ':' . $divider;
 457                 $score     = $this->cache->get($cache_key);
 458                 if (!empty($score)) {
 459                         return $score;
 460                 }
 461
 462                 $limit    = $this->database->count('contact-relation', ["`cid` = ? AND `thread-score` > ?", $cid, 0]) / $divider;
 463                 $relation = $this->database->selectToArray('contact-relation', ['thread-score'], ['cid' => $cid], ['order' => ['thread-score' => true], 'limit' => [$limit, 1]]);
 464                 $score    = $relation[0]['thread-score'] ?? 0;
 465                 if (empty($score)) {
 466                         return 0;
 467                 }
 468
 469                 $this->cache->set($cache_key, $score, Duration::HOUR);
 470                 return $score;
 471         }
 472 }