]> git.mxchange.org Git - friendica.git/blob - src/Module/Conversation/Community.php
Merge remote-tracking branch 'upstream/develop' into conversation-moved
[friendica.git] / src / Module / Conversation / Community.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  * See update_profile.php for documentation
21  */
22
23 namespace Friendica\Module\Conversation;
24
25 use Friendica\BaseModule;
26 use Friendica\Content\BoundariesPager;
27 use Friendica\Content\Feature;
28 use Friendica\Content\Nav;
29 use Friendica\Content\Text\HTML;
30 use Friendica\Content\Widget;
31 use Friendica\Content\Widget\TrendingTags;
32 use Friendica\Core\Renderer;
33 use Friendica\Core\Session;
34 use Friendica\Database\DBA;
35 use Friendica\DI;
36 use Friendica\Model\Item;
37 use Friendica\Model\Post;
38 use Friendica\Model\User;
39 use Friendica\Network\HTTPException;
40
41 class Community extends BaseModule
42 {
43         protected static $page_style;
44         protected static $content;
45         protected static $accountTypeString;
46         protected static $accountType;
47         protected static $itemsPerPage;
48         protected static $min_id;
49         protected static $max_id;
50         protected static $item_id;
51
52         public static function content(array $parameters = [])
53         {
54                 self::parseRequest($parameters);
55
56                 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
57                         $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
58                         $o = Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
59                 } else {
60                         $o = '';
61                 }
62
63                 if (empty($_GET['mode']) || ($_GET['mode'] != 'raw')) {
64                         $tabs = [];
65
66                         if ((Session::isAuthenticated() || in_array(self::$page_style, [CP_USERS_AND_GLOBAL, CP_USERS_ON_SERVER])) && empty(DI::config()->get('system', 'singleuser'))) {
67                                 $tabs[] = [
68                                         'label' => DI::l10n()->t('Local Community'),
69                                         'url' => 'community/local',
70                                         'sel' => self::$content == 'local' ? 'active' : '',
71                                         'title' => DI::l10n()->t('Posts from local users on this server'),
72                                         'id' => 'community-local-tab',
73                                         'accesskey' => 'l'
74                                 ];
75                         }
76         
77                         if (Session::isAuthenticated() || in_array(self::$page_style, [CP_USERS_AND_GLOBAL, CP_GLOBAL_COMMUNITY])) {
78                                 $tabs[] = [
79                                         'label' => DI::l10n()->t('Global Community'),
80                                         'url' => 'community/global',
81                                         'sel' => self::$content == 'global' ? 'active' : '',
82                                         'title' => DI::l10n()->t('Posts from users of the whole federated network'),
83                                         'id' => 'community-global-tab',
84                                         'accesskey' => 'g'
85                                 ];
86                         }
87
88                         $tab_tpl = Renderer::getMarkupTemplate('common_tabs.tpl');
89                         $o .= Renderer::replaceMacros($tab_tpl, ['$tabs' => $tabs]);
90
91                         Nav::setSelected('community');
92
93                         DI::page()['aside'] .= Widget::accounttypes('community/' . self::$content, self::$accountTypeString);
94         
95                         if (local_user() && DI::config()->get('system', 'community_no_sharer')) {
96                                 $path = self::$content;
97                                 if (!empty($parameters['accounttype'])) {
98                                         $path .= '/' . $parameters['accounttype'];
99                                 }
100                                 $query_parameters = [];
101                 
102                                 if (!empty($_GET['min_id'])) {
103                                         $query_parameters['min_id'] = $_GET['min_id'];
104                                 }
105                                 if (!empty($_GET['max_id'])) {
106                                         $query_parameters['max_id'] = $_GET['max_id'];
107                                 }
108                                 if (!empty($_GET['last_commented'])) {
109                                         $query_parameters['max_id'] = $_GET['last_commented'];
110                                 }
111                 
112                                 $path_all = $path . (!empty($query_parameters) ? '?' . http_build_query($query_parameters) : '');
113                                 $path_no_sharer = $path . '?' . http_build_query(array_merge($query_parameters, ['no_sharer' => true]));
114                                 DI::page()['aside'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate('widget/community_sharer.tpl'), [
115                                         '$title'           => DI::l10n()->t('Own Contacts'),
116                                         '$path_all'        => $path_all,
117                                         '$path_no_sharer'  => $path_no_sharer,
118                                         '$no_sharer'       => !empty($_REQUEST['no_sharer']),
119                                         '$all'             => DI::l10n()->t('Include'),
120                                         '$no_sharer_label' => DI::l10n()->t('Hide'),
121                                 ]);
122                         }
123         
124                         if (Feature::isEnabled(local_user(), 'trending_tags')) {
125                                 DI::page()['aside'] .= TrendingTags::getHTML(self::$content);
126                         }
127
128                         // We need the editor here to be able to reshare an item.
129                         if (Session::isAuthenticated()) {
130                                 $o .= DI::conversation()->statusEditor([], 0, true);
131                         }
132                 }
133
134                 $items = self::getItems();
135
136                 if (!DBA::isResult($items)) {
137                         notice(DI::l10n()->t('No results.'));
138                         return $o;
139                 }
140
141                 $o .= DI::conversation()->create($items, 'community', false, false, 'commented', local_user());
142
143                 $pager = new BoundariesPager(
144                         DI::l10n(),
145                         DI::args()->getQueryString(),
146                         $items[0]['commented'],
147                         $items[count($items) - 1]['commented'],
148                         self::$itemsPerPage
149                 );
150
151                 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
152                         $o .= HTML::scrollLoader();
153                 } else {
154                         $o .= $pager->renderMinimal(count($items));
155                 }
156
157                 $t = Renderer::getMarkupTemplate("community.tpl");
158                 return Renderer::replaceMacros($t, [
159                         '$content' => $o,
160                         '$header' => '',
161                         '$show_global_community_hint' => (self::$content == 'global') && DI::config()->get('system', 'show_global_community_hint'),
162                         '$global_community_hint' => DI::l10n()->t("This community stream shows all public posts received by this node. They may not reflect the opinions of this node’s users.")
163                 ]);
164         }
165
166         /**
167          * Computes module parameters from the request and local configuration
168          *
169          * @param array $parameters
170          * @throws HTTPException\BadRequestException
171          * @throws HTTPException\ForbiddenException
172          */
173         protected static function parseRequest(array $parameters)
174         {
175                 if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) {
176                         throw new HTTPException\ForbiddenException(DI::l10n()->t('Public access denied.'));
177                 }
178
179                 self::$page_style = DI::config()->get('system', 'community_page_style');
180
181                 if (self::$page_style == CP_NO_INTERNAL_COMMUNITY) {
182                         throw new HTTPException\ForbiddenException(DI::l10n()->t('Access denied.'));
183                 }
184
185                 self::$accountTypeString = $_GET['accounttype'] ?? $parameters['accounttype'] ?? '';
186                 self::$accountType = User::getAccountTypeByString(self::$accountTypeString);
187
188                 self::$content = $parameters['content'] ?? '';
189                 if (!self::$content) {
190                         if (!empty(DI::config()->get('system', 'singleuser'))) {
191                                 // On single user systems only the global page does make sense
192                                 self::$content = 'global';
193                         } else {
194                                 // When only the global community is allowed, we use this as default
195                                 self::$content = self::$page_style == CP_GLOBAL_COMMUNITY ? 'global' : 'local';
196                         }
197                 }
198
199                 if (!in_array(self::$content, ['local', 'global'])) {
200                         throw new HTTPException\BadRequestException(DI::l10n()->t('Community option not available.'));
201                 }
202
203                 // Check if we are allowed to display the content to visitors
204                 if (!Session::isAuthenticated()) {
205                         $available = self::$page_style == CP_USERS_AND_GLOBAL;
206
207                         if (!$available) {
208                                 $available = (self::$page_style == CP_USERS_ON_SERVER) && (self::$content == 'local');
209                         }
210
211                         if (!$available) {
212                                 $available = (self::$page_style == CP_GLOBAL_COMMUNITY) && (self::$content == 'global');
213                         }
214
215                         if (!$available) {
216                                 throw new HTTPException\ForbiddenException(DI::l10n()->t('Not available.'));
217                         }
218                 }
219
220                 if (DI::mode()->isMobile()) {
221                         self::$itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
222                                 DI::config()->get('system', 'itemspage_network_mobile'));
223                 } else {
224                         self::$itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
225                                 DI::config()->get('system', 'itemspage_network'));
226                 }
227
228                 if (!empty($_GET['item'])) {
229                         $item = Post::selectFirst(['parent'], ['id' => $_GET['item']]);
230                         self::$item_id = $item['parent'] ?? 0;
231                 } else {
232                         self::$item_id = 0;
233                 }
234
235                 self::$min_id = $_GET['min_id'] ?? null;
236                 self::$max_id   = $_GET['max_id']   ?? null;
237                 self::$max_id   = $_GET['last_commented'] ?? self::$max_id;
238         }
239
240         /**
241          * Computes the displayed items.
242          *
243          * Community pages have a restriction on how many successive posts by the same author can show on any given page,
244          * so we may have to retrieve more content beyond the first query
245          *
246          * @return array
247          * @throws \Exception
248          */
249         protected static function getItems()
250         {
251                 $items = self::selectItems(self::$min_id, self::$max_id, self::$item_id, self::$itemsPerPage);
252
253                 $maxpostperauthor = (int) DI::config()->get('system', 'max_author_posts_community_page');
254                 if ($maxpostperauthor != 0 && self::$content == 'local') {
255                         $count = 1;
256                         $previousauthor = '';
257                         $numposts = 0;
258                         $selected_items = [];
259
260                         while (count($selected_items) < self::$itemsPerPage && ++$count < 50 && count($items) > 0) {
261                                 foreach ($items as $item) {
262                                         if ($previousauthor == $item["author-link"]) {
263                                                 ++$numposts;
264                                         } else {
265                                                 $numposts = 0;
266                                         }
267                                         $previousauthor = $item["author-link"];
268
269                                         if (($numposts < $maxpostperauthor) && (count($selected_items) < self::$itemsPerPage)) {
270                                                 $selected_items[] = $item;
271                                         }
272                                 }
273
274                                 // If we're looking at a "previous page", the lookup continues forward in time because the list is
275                                 // sorted in chronologically decreasing order
276                                 if (isset(self::$min_id)) {
277                                         self::$min_id = $items[0]['commented'];
278                                 } else {
279                                         // In any other case, the lookup continues backwards in time
280                                         self::$max_id = $items[count($items) - 1]['commented'];
281                                 }
282
283                                 $items = self::selectItems(self::$min_id, self::$max_id, self::$item_id, self::$itemsPerPage);
284                         }
285                 } else {
286                         $selected_items = $items;
287                 }
288
289                 return $selected_items;
290         }
291
292         /**
293          * Database query for the comunity page
294          *
295          * @param $min_id
296          * @param $max_id
297          * @param $itemspage
298          * @return array
299          * @throws \Exception
300          * @TODO Move to repository/factory
301          */
302         private static function selectItems($min_id, $max_id, $item_id, $itemspage)
303         {
304                 if (self::$content == 'local') {
305                         if (!is_null(self::$accountType)) {
306                                 $condition = ["`wall` AND `origin` AND `private` = ? AND `owner-contact-type` = ?", Item::PUBLIC, self::$accountType];
307                         } else {
308                                 $condition = ["`wall` AND `origin` AND `private` = ?", Item::PUBLIC];
309                         }
310                 } elseif (self::$content == 'global') {
311                         if (!is_null(self::$accountType)) {
312                                 $condition = ["`uid` = ? AND `private` = ? AND `owner-contact-type` = ?", 0, Item::PUBLIC, self::$accountType];
313                         } else {
314                                 $condition = ["`uid` = ? AND `private` = ?", 0, Item::PUBLIC];
315                         }
316                 } else {
317                         return [];
318                 }
319
320                 $params = ['order' => ['commented' => true], 'limit' => $itemspage];
321
322                 if (!empty($item_id)) {
323                         $condition[0] .= " AND `id` = ?";
324                         $condition[] = $item_id;
325                 } else {
326                         if (local_user() && !empty($_REQUEST['no_sharer'])) {
327                                 $condition[0] .= " AND NOT EXISTS (SELECT `uri-id` FROM `post-user` WHERE `post-user`.`uri-id` = `post-thread-user-view`.`uri-id` AND `post-user`.`uid` = ?)";
328                                 $condition[] = local_user();
329                         }
330         
331                         if (isset($max_id)) {
332                                 $condition[0] .= " AND `commented` < ?";
333                                 $condition[] = $max_id;
334                         }
335
336                         if (isset($min_id)) {
337                                 $condition[0] .= " AND `commented` > ?";
338                                 $condition[] = $min_id;
339
340                                 // Previous page case: we want the items closest to min_id but for that we need to reverse the query order
341                                 if (!isset($max_id)) {
342                                         $params['order']['commented'] = false;
343                                 }
344                         }
345                 }
346
347                 $r = Post::selectThreadForUser(0, ['uri-id', 'commented', 'author-link'], $condition, $params);
348
349                 $items = Post::toArray($r);
350                 if (empty($items)) {
351                         return [];
352                 }
353
354                 // Previous page case: once we get the relevant items closest to min_id, we need to restore the expected display order
355                 if (empty($item_id) && isset($min_id) && !isset($max_id)) {
356                         $items = array_reverse($items);
357                 }
358
359                 return $items;
360         }
361 }