]> git.mxchange.org Git - friendica.git/blob - src/Module/Conversation/Timeline.php
Channel visibility rules can now be set for each contact
[friendica.git] / 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                 $items = $this->getRawChannelItems();
193
194                 $contacts = $this->database->selectToArray('user-contact', ['cid'], ['channel-visibility' => Contact\User::VISIBILITY_REDUCED, 'cid' => array_column($items, 'owner-id')]);
195                 $reduced  = array_column($contacts, 'cid');
196
197                 $maxpostperauthor = $this->config->get('channel', 'max_posts_per_author');
198
199                 if ($maxpostperauthor != 0) {
200                         $count          = 1;
201                         $numposts       = [];
202                         $selected_items = [];
203
204                         while (count($selected_items) < $this->itemsPerPage && ++$count < 50 && count($items) > 0) {
205                                 foreach ($items as $item) {
206                                         if (!in_array($item['owner-id'], $reduced) || (($numposts[$item['owner-id']]++ < $maxpostperauthor)) && (count($selected_items) < $this->itemsPerPage)) {
207                                                 $selected_items[] = $item;
208                                         }
209                                 }
210
211                                 // If we're looking at a "previous page", the lookup continues forward in time because the list is
212                                 // sorted in chronologically decreasing order
213                                 if (isset($this->minId)) {
214                                         $this->minId = $items[0]['created'];
215                                 } else {
216                                         // In any other case, the lookup continues backwards in time
217                                         $this->maxId = $items[count($items) - 1]['created'];
218                                 }
219
220                                 if (count($selected_items) < $this->itemsPerPage) {
221                                         $items = $this->getRawChannelItems();
222                                 }
223                         }
224                 } else {
225                         $selected_items = $items;
226                 }
227
228                 $condition = ['unseen' => true, 'uid' => $this->session->getLocalUserId(), 'parent-uri-id' => array_column($selected_items, 'uri-id')];
229                 $this->setItemsSeenByCondition($condition);
230
231                 return $selected_items;
232         }
233
234         /**
235          * Database query for the channel page
236          *
237          * @return array
238          * @throws \Exception
239          */
240         private function getRawChannelItems()
241         {
242                 $uid = $this->session->getLocalUserId();
243
244                 if ($this->selectedTab == TimelineEntity::WHATSHOT) {
245                         if (!is_null($this->accountType)) {
246                                 $condition = ["(`comments` > ? OR `activities` > ?) AND `contact-type` = ?", $this->getMedianComments($uid, 4), $this->getMedianActivities($uid, 4), $this->accountType];
247                         } else {
248                                 $condition = ["(`comments` > ? OR `activities` > ?) AND `contact-type` != ?", $this->getMedianComments($uid, 4), $this->getMedianActivities($uid, 4), Contact::TYPE_COMMUNITY];
249                         }
250                 } elseif ($this->selectedTab == TimelineEntity::FORYOU) {
251                         $cid = Contact::getPublicIdByUserId($uid);
252
253                         $condition = [
254                                 "(`owner-id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `relation-thread-score` > ?) OR
255                                 ((`comments` >= ? OR `activities` >= ?) AND `owner-id` IN (SELECT `cid` FROM `contact-relation` WHERE `follows` AND `relation-cid` = ?)) OR
256                                 (`owner-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND (`notify_new_posts` OR `channel-visibility` = ?))))",
257                                 $cid, $this->getMedianRelationThreadScore($cid, 4), $this->getMedianComments($uid, 4), $this->getMedianActivities($uid, 4), $cid,
258                                 $uid, Contact\User::VISIBILITY_ALWAYS
259                         ];
260                 } elseif ($this->selectedTab == TimelineEntity::FOLLOWERS) {
261                         $condition = ["`owner-id` IN (SELECT `pid` FROM `account-user-view` WHERE `uid` = ? AND `rel` = ?)", $uid, Contact::FOLLOWER];
262                 } elseif ($this->selectedTab == TimelineEntity::SHARERSOFSHARERS) {
263                         $cid = Contact::getPublicIdByUserId($uid);
264
265                         // @todo Suggest posts from contacts that are followed most by our followers
266                         $condition = [
267                                 "`owner-id` IN (SELECT `cid` FROM `contact-relation` WHERE `follows` AND `last-interaction` > ?
268                                 AND `relation-cid` IN (SELECT `cid` FROM `contact-relation` WHERE `follows` AND `relation-cid` = ? AND `relation-thread-score` >= ?)
269                                 AND NOT `cid` IN (SELECT `cid` FROM `contact-relation` WHERE `follows` AND `relation-cid` = ?))",
270                                 DateTimeFormat::utc('now - ' . $this->config->get('channel', 'sharer_interaction_days') . ' day'), $cid, $this->getMedianRelationThreadScore($cid, 4), $cid
271                         ];
272                 } elseif ($this->selectedTab == TimelineEntity::IMAGE) {
273                         $condition = ["`media-type` & ?", 1];
274                 } elseif ($this->selectedTab == TimelineEntity::VIDEO) {
275                         $condition = ["`media-type` & ?", 2];
276                 } elseif ($this->selectedTab == TimelineEntity::AUDIO) {
277                         $condition = ["`media-type` & ?", 4];
278                 } elseif ($this->selectedTab == TimelineEntity::LANGUAGE) {
279                         $condition = ["JSON_EXTRACT(JSON_KEYS(language), '$[0]') = ?", $this->l10n->convertCodeForLanguageDetection(User::getLanguageCode($uid))];
280                 }
281
282                 if ($this->selectedTab != TimelineEntity::LANGUAGE) {
283                         $condition = $this->addLanguageCondition($uid, $condition);
284                 }
285
286                 $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` OR `is-blocked` OR `channel-visibility` = ?))", $uid, Contact\User::VISIBILITY_NEVER]);
287
288                 if (($this->selectedTab != TimelineEntity::WHATSHOT) && !is_null($this->accountType)) {
289                         $condition = DBA::mergeConditions($condition, ['contact-type' => $this->accountType]);
290                 }
291
292                 $params = ['order' => ['created' => true], 'limit' => $this->itemsPerPage];
293
294                 if (!empty($this->itemUriId)) {
295                         $condition = DBA::mergeConditions($condition, ['uri-id' => $this->itemUriId]);
296                 } else {
297                         if ($this->noSharer) {
298                                 $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()]);
299                         }
300
301                         if (isset($this->maxId)) {
302                                 $condition = DBA::mergeConditions($condition, ["`created` < ?", $this->maxId]);
303                         }
304
305                         if (isset($this->minId)) {
306                                 $condition = DBA::mergeConditions($condition, ["`created` > ?", $this->minId]);
307
308                                 // Previous page case: we want the items closest to min_id but for that we need to reverse the query order
309                                 if (!isset($this->maxId)) {
310                                         $params['order']['created'] = false;
311                                 }
312                         }
313                 }
314
315                 $items = $this->database->selectToArray('post-engagement', ['uri-id', 'created', 'owner-id'], $condition, $params);
316                 if (empty($items)) {
317                         return [];
318                 }
319
320                 // Previous page case: once we get the relevant items closest to min_id, we need to restore the expected display order
321                 if (empty($this->itemUriId) && isset($this->minId) && !isset($this->maxId)) {
322                         $items = array_reverse($items);
323                 }
324
325                 $condition = ['unseen' => true, 'uid' => $uid, 'parent-uri-id' => array_column($items, 'uri-id')];
326                 $this->setItemsSeenByCondition($condition);
327
328                 return $items;
329         }
330
331         private function addLanguageCondition(int $uid, array $condition): array
332         {
333                 $conditions = [];
334                 $languages  = $this->pConfig->get($uid, 'channel', 'languages', [User::getLanguageCode($uid)]);
335                 $languages  = $this->l10n->convertForLanguageDetection($languages);
336                 foreach ($languages as $language) {
337                         $conditions[] = "JSON_EXTRACT(JSON_KEYS(language), '$[0]') = ?";
338                         $condition[]  = $language;
339                 }
340                 if (!empty($conditions)) {
341                         $condition[0] .= " AND (`language` IS NULL OR " . implode(' OR ', $conditions) . ")";
342                 }
343                 return $condition;
344         }
345
346         private function getMedianComments(int $uid, int $divider): int
347         {
348                 $languages = $this->pConfig->get($uid, 'channel', 'languages', [User::getLanguageCode($uid)]);
349                 $cache_key = 'Channel:getMedianComments:' . $divider . ':' . implode(':', $languages);
350                 $comments  = $this->cache->get($cache_key);
351                 if (!empty($comments)) {
352                         return $comments;
353                 }
354
355                 $condition = ["`contact-type` != ? AND `comments` > ?", Contact::TYPE_COMMUNITY, 0];
356                 $condition = $this->addLanguageCondition($uid, $condition);
357
358                 $limit    = $this->database->count('post-engagement', $condition) / $divider;
359                 $post     = $this->database->selectToArray('post-engagement', ['comments'], $condition, ['order' => ['comments' => true], 'limit' => [$limit, 1]]);
360                 $comments = $post[0]['comments'] ?? 0;
361                 if (empty($comments)) {
362                         return 0;
363                 }
364
365                 $this->cache->set($cache_key, $comments, Duration::HALF_HOUR);
366                 $this->logger->debug('Calculated median comments', ['divider' => $divider, 'languages' => $languages, 'median' => $comments]);
367                 return $comments;
368         }
369
370         private function getMedianActivities(int $uid, int $divider): int
371         {
372                 $languages  = $this->pConfig->get($uid, 'channel', 'languages', [User::getLanguageCode($uid)]);
373                 $cache_key  = 'Channel:getMedianActivities:' . $divider . ':' . implode(':', $languages);
374                 $activities = $this->cache->get($cache_key);
375                 if (!empty($activities)) {
376                         return $activities;
377                 }
378
379                 $condition = ["`contact-type` != ? AND `activities` > ?", Contact::TYPE_COMMUNITY, 0];
380                 $condition = $this->addLanguageCondition($uid, $condition);
381
382                 $limit      = $this->database->count('post-engagement', $condition) / $divider;
383                 $post       = $this->database->selectToArray('post-engagement', ['activities'], $condition, ['order' => ['activities' => true], 'limit' => [$limit, 1]]);
384                 $activities = $post[0]['activities'] ?? 0;
385                 if (empty($activities)) {
386                         return 0;
387                 }
388
389                 $this->cache->set($cache_key, $activities, Duration::HALF_HOUR);
390                 $this->logger->debug('Calculated median activities', ['divider' => $divider, 'languages' => $languages, 'median' => $activities]);
391                 return $activities;
392         }
393
394         private function getMedianRelationThreadScore(int $cid, int $divider): int
395         {
396                 $cache_key = 'Channel:getThreadScore:' . $cid . ':' . $divider;
397                 $score     = $this->cache->get($cache_key);
398                 if (!empty($score)) {
399                         return $score;
400                 }
401
402                 $condition = ["`relation-cid` = ? AND `relation-thread-score` > ?", $cid, 0];
403
404                 $limit    = $this->database->count('contact-relation', $condition) / $divider;
405                 $relation = $this->database->selectToArray('contact-relation', ['relation-thread-score'], $condition, ['order' => ['relation-thread-score' => true], 'limit' => [$limit, 1]]);
406                 $score    = $relation[0]['relation-thread-score'] ?? 0;
407                 if (empty($score)) {
408                         return 0;
409                 }
410
411                 $this->cache->set($cache_key, $score, Duration::HALF_HOUR);
412                 $this->logger->debug('Calculated median score', ['cid' => $cid, 'divider' => $divider, 'median' => $score]);
413                 return $score;
414         }
415
416         /**
417          * Computes the displayed items.
418          *
419          * Community pages have a restriction on how many successive posts by the same author can show on any given page,
420          * so we may have to retrieve more content beyond the first query
421          *
422          * @return array
423          * @throws \Exception
424          */
425         protected function getCommunityItems()
426         {
427                 $items = $this->selectItems();
428
429                 $maxpostperauthor = (int) $this->config->get('system', 'max_author_posts_community_page');
430                 if ($maxpostperauthor != 0 && $this->selectedTab == 'local') {
431                         $count          = 1;
432                         $previousauthor = '';
433                         $numposts       = 0;
434                         $selected_items = [];
435
436                         while (count($selected_items) < $this->itemsPerPage && ++$count < 50 && count($items) > 0) {
437                                 foreach ($items as $item) {
438                                         if ($previousauthor == $item["author-link"]) {
439                                                 ++$numposts;
440                                         } else {
441                                                 $numposts = 0;
442                                         }
443                                         $previousauthor = $item["author-link"];
444
445                                         if (($numposts < $maxpostperauthor) && (count($selected_items) < $this->itemsPerPage)) {
446                                                 $selected_items[] = $item;
447                                         }
448                                 }
449
450                                 // If we're looking at a "previous page", the lookup continues forward in time because the list is
451                                 // sorted in chronologically decreasing order
452                                 if (isset($this->minId)) {
453                                         $this->minId = $items[0]['commented'];
454                                 } else {
455                                         // In any other case, the lookup continues backwards in time
456                                         $this->maxId = $items[count($items) - 1]['commented'];
457                                 }
458
459                                 $items = $this->selectItems();
460                         }
461                 } else {
462                         $selected_items = $items;
463                 }
464
465                 $condition = ['unseen' => true, 'uid' => $this->session->getLocalUserId(), 'parent-uri-id' => array_column($selected_items, 'uri-id')];
466                 $this->setItemsSeenByCondition($condition);
467
468                 return $selected_items;
469         }
470
471         /**
472          * Database query for the community page
473          *
474          * @return array
475          * @throws \Exception
476          * @TODO Move to repository/factory
477          */
478         private function selectItems()
479         {
480                 if ($this->selectedTab == 'local') {
481                         if (!is_null($this->accountType)) {
482                                 $condition = ["`wall` AND `origin` AND `private` = ? AND `owner-contact-type` = ?", Item::PUBLIC, $this->accountType];
483                         } else {
484                                 $condition = ["`wall` AND `origin` AND `private` = ?", Item::PUBLIC];
485                         }
486                 } elseif ($this->selectedTab == 'global') {
487                         if (!is_null($this->accountType)) {
488                                 $condition = ["`uid` = ? AND `private` = ? AND `owner-contact-type` = ?", 0, Item::PUBLIC, $this->accountType];
489                         } else {
490                                 $condition = ["`uid` = ? AND `private` = ?", 0, Item::PUBLIC];
491                         }
492                 } else {
493                         return [];
494                 }
495
496                 $params = ['order' => ['commented' => true], 'limit' => $this->itemsPerPage];
497
498                 if (!empty($this->itemUriId)) {
499                         $condition = DBA::mergeConditions($condition, ['uri-id' => $this->itemUriId]);
500                 } else {
501                         if ($this->session->getLocalUserId() && $this->noSharer) {
502                                 $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()]);
503                         }
504
505                         if (isset($this->maxId)) {
506                                 $condition = DBA::mergeConditions($condition, ["`commented` < ?", $this->maxId]);
507                         }
508
509                         if (isset($this->minId)) {
510                                 $condition = DBA::mergeConditions($condition, ["`commented` > ?", $this->minId]);
511
512                                 // Previous page case: we want the items closest to min_id but for that we need to reverse the query order
513                                 if (!isset($this->maxId)) {
514                                         $params['order']['commented'] = false;
515                                 }
516                         }
517                 }
518
519                 $r = Post::selectThreadForUser($this->session->getLocalUserId() ?: 0, ['uri-id', 'commented', 'author-link'], $condition, $params);
520
521                 $items = Post::toArray($r);
522                 if (empty($items)) {
523                         return [];
524                 }
525
526                 // Previous page case: once we get the relevant items closest to min_id, we need to restore the expected display order
527                 if (empty($this->itemUriId) && isset($this->minId) && !isset($this->maxId)) {
528                         $items = array_reverse($items);
529                 }
530
531                 return $items;
532         }
533
534         /**
535          * Sets items as seen
536          *
537          * @param array $condition The array with the SQL condition
538          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
539          */
540         protected function setItemsSeenByCondition(array $condition)
541         {
542                 if (empty($condition)) {
543                         return;
544                 }
545
546                 $unseen = Post::exists($condition);
547
548                 if ($unseen) {
549                         /// @todo handle huge "unseen" updates in the background to avoid timeout errors
550                         Item::update(['unseen' => false], $condition);
551                 }
552         }
553 }