From 682fb7e4e21d861e48c526c71e64a4bfc2cc2964 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sun, 16 Feb 2020 04:38:56 -0500 Subject: [PATCH] Move community module to src/ - Use boundaries pagination instead of number pages - Trim down community update module output - Part of https://github.com/friendica/friendica/issues/4090 --- mod/community.php | 259 -------------- src/Module/Conversation/Community.php | 334 ++++++++++++++++++ .../Module/Update/Community.php | 25 +- static/routes.config.php | 4 + view/js/main.js | 8 + 5 files changed, 361 insertions(+), 269 deletions(-) delete mode 100644 mod/community.php create mode 100644 src/Module/Conversation/Community.php rename mod/update_community.php => src/Module/Update/Community.php (67%) diff --git a/mod/community.php b/mod/community.php deleted file mode 100644 index b95d13654c..0000000000 --- a/mod/community.php +++ /dev/null @@ -1,259 +0,0 @@ -. - * - */ - -use Friendica\App; -use Friendica\Content\Feature; -use Friendica\Content\Nav; -use Friendica\Content\Pager; -use Friendica\Content\Widget\TrendingTags; -use Friendica\Core\ACL; -use Friendica\Core\Renderer; -use Friendica\Core\Session; -use Friendica\Database\DBA; -use Friendica\DI; -use Friendica\Model\Item; -use Friendica\Model\User; - -function community_content(App $a, $update = 0) -{ - $o = ''; - - if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) { - notice(DI::l10n()->t('Public access denied.') . EOL); - return; - } - - $page_style = DI::config()->get('system', 'community_page_style'); - - if ($page_style == CP_NO_INTERNAL_COMMUNITY) { - notice(DI::l10n()->t('Access denied.') . EOL); - return; - } - - $accounttype = null; - - if ($a->argc > 2) { - switch ($a->argv[2]) { - case 'person': - $accounttype = User::ACCOUNT_TYPE_PERSON; - break; - case 'organisation': - $accounttype = User::ACCOUNT_TYPE_ORGANISATION; - break; - case 'news': - $accounttype = User::ACCOUNT_TYPE_NEWS; - break; - case 'community': - $accounttype = User::ACCOUNT_TYPE_COMMUNITY; - break; - } - } - - if ($a->argc > 1) { - $content = $a->argv[1]; - } else { - if (!empty(DI::config()->get('system', 'singleuser'))) { - // On single user systems only the global page does make sense - $content = 'global'; - } else { - // When only the global community is allowed, we use this as default - $content = $page_style == CP_GLOBAL_COMMUNITY ? 'global' : 'local'; - } - } - - if (!in_array($content, ['local', 'global'])) { - notice(DI::l10n()->t('Community option not available.') . EOL); - return; - } - - // Check if we are allowed to display the content to visitors - if (!local_user()) { - $available = $page_style == CP_USERS_AND_GLOBAL; - - if (!$available) { - $available = ($page_style == CP_USERS_ON_SERVER) && ($content == 'local'); - } - - if (!$available) { - $available = ($page_style == CP_GLOBAL_COMMUNITY) && ($content == 'global'); - } - - if (!$available) { - notice(DI::l10n()->t('Not available.') . EOL); - return; - } - } - - if (!$update) { - $tabs = []; - - if ((local_user() || in_array($page_style, [CP_USERS_AND_GLOBAL, CP_USERS_ON_SERVER])) && empty(DI::config()->get('system', 'singleuser'))) { - $tabs[] = [ - 'label' => DI::l10n()->t('Local Community'), - 'url' => 'community/local', - 'sel' => $content == 'local' ? 'active' : '', - 'title' => DI::l10n()->t('Posts from local users on this server'), - 'id' => 'community-local-tab', - 'accesskey' => 'l' - ]; - } - - if (local_user() || in_array($page_style, [CP_USERS_AND_GLOBAL, CP_GLOBAL_COMMUNITY])) { - $tabs[] = [ - 'label' => DI::l10n()->t('Global Community'), - 'url' => 'community/global', - 'sel' => $content == 'global' ? 'active' : '', - 'title' => DI::l10n()->t('Posts from users of the whole federated network'), - 'id' => 'community-global-tab', - 'accesskey' => 'g' - ]; - } - - $tab_tpl = Renderer::getMarkupTemplate('common_tabs.tpl'); - $o .= Renderer::replaceMacros($tab_tpl, ['$tabs' => $tabs]); - - Nav::setSelected('community'); - - // We need the editor here to be able to reshare an item. - if (local_user()) { - $x = [ - 'is_owner' => true, - 'allow_location' => $a->user['allow_location'], - 'default_location' => $a->user['default-location'], - 'nickname' => $a->user['nickname'], - 'lockstate' => (is_array($a->user) && (strlen($a->user['allow_cid']) || strlen($a->user['allow_gid']) || strlen($a->user['deny_cid']) || strlen($a->user['deny_gid'])) ? 'lock' : 'unlock'), - 'acl' => ACL::getFullSelectorHTML(DI::page(), $a->user, true), - 'bang' => '', - 'visitor' => 'block', - 'profile_uid' => local_user(), - ]; - $o .= status_editor($a, $x, 0, true); - } - } - - // check if we serve a mobile device and get the user settings accordingly - if (DI::mode()->isMobile()) { - $itemspage_network = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network', 20); - } else { - $itemspage_network = DI::pConfig()->get(local_user(), 'system', 'itemspage_network', 40); - } - - // now that we have the user settings, see if the theme forces - // a maximum item number which is lower then the user choice - if (($a->force_max_items > 0) && ($a->force_max_items < $itemspage_network)) { - $itemspage_network = $a->force_max_items; - } - - $pager = new Pager(DI::args()->getQueryString(), $itemspage_network); - - $r = community_getitems($pager->getStart(), $pager->getItemsPerPage(), $content, $accounttype); - - if (!DBA::isResult($r)) { - info(DI::l10n()->t('No results.') . EOL); - return $o; - } - - $maxpostperauthor = (int) DI::config()->get('system', 'max_author_posts_community_page'); - - if (($maxpostperauthor != 0) && ($content == 'local')) { - $count = 1; - $previousauthor = ""; - $numposts = 0; - $s = []; - - do { - foreach ($r as $item) { - if ($previousauthor == $item["author-link"]) { - ++$numposts; - } else { - $numposts = 0; - } - $previousauthor = $item["author-link"]; - - if (($numposts < $maxpostperauthor) && (count($s) < $pager->getItemsPerPage())) { - $s[] = $item; - } - } - if (count($s) < $pager->getItemsPerPage()) { - $r = community_getitems($pager->getStart() + ($count * $pager->getItemsPerPage()), $pager->getItemsPerPage(), $content, $accounttype); - } - } while ((count($s) < $pager->getItemsPerPage()) && ( ++$count < 50) && (count($r) > 0)); - } else { - $s = $r; - } - - $o .= conversation($a, $s, 'community', $update, false, 'commented', local_user()); - - if (!$update) { - $o .= $pager->renderMinimal(count($r)); - } - - if (empty(DI::page()['aside'])) { - DI::page()['aside'] = ''; - } - - if (Feature::isEnabled(local_user(), 'trending_tags')) { - DI::page()['aside'] .= TrendingTags::getHTML($content); - } - - $t = Renderer::getMarkupTemplate("community.tpl"); - return Renderer::replaceMacros($t, [ - '$content' => $o, - '$header' => '', - '$show_global_community_hint' => ($content == 'global') && DI::config()->get('system', 'show_global_community_hint'), - '$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.") - ]); -} - -function community_getitems($start, $itemspage, $content, $accounttype) -{ - if ($content == 'local') { - if (!is_null($accounttype)) { - $sql_accounttype = " AND `user`.`account-type` = ?"; - $values = [$accounttype, $start, $itemspage]; - } else { - $sql_accounttype = ""; - $values = [$start, $itemspage]; - } - - /// @todo Use "unsearchable" here as well (instead of "hidewall") - $r = DBA::p("SELECT `item`.`uri`, `author`.`url` AS `author-link` FROM `thread` - STRAIGHT_JOIN `user` ON `user`.`uid` = `thread`.`uid` AND NOT `user`.`hidewall` - STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid` - STRAIGHT_JOIN `contact` AS `author` ON `author`.`id`=`item`.`author-id` - WHERE `thread`.`visible` AND NOT `thread`.`deleted` AND NOT `thread`.`moderated` - AND NOT `thread`.`private` AND `thread`.`wall` AND `thread`.`origin` $sql_accounttype - ORDER BY `thread`.`commented` DESC LIMIT ?, ?", $values); - return DBA::toArray($r); - } elseif ($content == 'global') { - if (!is_null($accounttype)) { - $condition = ["`uid` = ? AND NOT `author`.`unsearchable` AND NOT `owner`.`unsearchable` AND `owner`.`contact-type` = ?", 0, $accounttype]; - } else { - $condition = ["`uid` = ? AND NOT `author`.`unsearchable` AND NOT `owner`.`unsearchable`", 0]; - } - - $r = Item::selectThreadForUser(0, ['uri'], $condition, ['order' => ['commented' => true], 'limit' => [$start, $itemspage]]); - return DBA::toArray($r); - } - - // Should never happen - return []; -} diff --git a/src/Module/Conversation/Community.php b/src/Module/Conversation/Community.php new file mode 100644 index 0000000000..d149672838 --- /dev/null +++ b/src/Module/Conversation/Community.php @@ -0,0 +1,334 @@ +. + * + * See update_profile.php for documentation + */ + +namespace Friendica\Module\Conversation; + +use Friendica\BaseModule; +use Friendica\Content\BoundariesPager; +use Friendica\Content\Feature; +use Friendica\Content\Nav; +use Friendica\Content\Widget\TrendingTags; +use Friendica\Core\ACL; +use Friendica\Core\Renderer; +use Friendica\Core\Session; +use Friendica\Database\DBA; +use Friendica\DI; +use Friendica\Model\Item; +use Friendica\Model\User; +use Friendica\Network\HTTPException; + +class Community extends BaseModule +{ + protected static $page_style; + protected static $content; + protected static $accounttype; + protected static $itemsPerPage; + protected static $since_id; + protected static $max_id; + + public static function content(array $parameters = []) + { + self::parseRequest($parameters); + + $tabs = []; + + if ((local_user() || in_array(self::$page_style, [CP_USERS_AND_GLOBAL, CP_USERS_ON_SERVER])) && empty(DI::config()->get('system', 'singleuser'))) { + $tabs[] = [ + 'label' => DI::l10n()->t('Local Community'), + 'url' => 'community/local', + 'sel' => self::$content == 'local' ? 'active' : '', + 'title' => DI::l10n()->t('Posts from local users on this server'), + 'id' => 'community-local-tab', + 'accesskey' => 'l' + ]; + } + + if (local_user() || in_array(self::$page_style, [CP_USERS_AND_GLOBAL, CP_GLOBAL_COMMUNITY])) { + $tabs[] = [ + 'label' => DI::l10n()->t('Global Community'), + 'url' => 'community/global', + 'sel' => self::$content == 'global' ? 'active' : '', + 'title' => DI::l10n()->t('Posts from users of the whole federated network'), + 'id' => 'community-global-tab', + 'accesskey' => 'g' + ]; + } + + $tab_tpl = Renderer::getMarkupTemplate('common_tabs.tpl'); + $o = Renderer::replaceMacros($tab_tpl, ['$tabs' => $tabs]); + + Nav::setSelected('community'); + + $items = self::getItems(); + + if (!DBA::isResult($items)) { + info(DI::l10n()->t('No results.')); + return $o; + } + + // We need the editor here to be able to reshare an item. + if (local_user()) { + $x = [ + 'is_owner' => true, + 'allow_location' => DI::app()->user['allow_location'], + 'default_location' => DI::app()->user['default-location'], + 'nickname' => DI::app()->user['nickname'], + 'lockstate' => (is_array(DI::app()->user) && (strlen(DI::app()->user['allow_cid']) || strlen(DI::app()->user['allow_gid']) || strlen(DI::app()->user['deny_cid']) || strlen(DI::app()->user['deny_gid'])) ? 'lock' : 'unlock'), + 'acl' => ACL::getFullSelectorHTML(DI::page(), DI::app()->user, true), + 'bang' => '', + 'visitor' => 'block', + 'profile_uid' => local_user(), + ]; + $o .= status_editor(DI::app(), $x, 0, true); + } + + $o .= conversation(DI::app(), $items, 'community', false, false, 'commented', local_user()); + + $pager = new BoundariesPager( + DI::args()->getQueryString(), + $items[0]['commented'], + $items[count($items) - 1]['commented'], + self::$itemsPerPage + ); + + $o .= $pager->renderMinimal(count($items)); + + if (Feature::isEnabled(local_user(), 'trending_tags')) { + DI::page()['aside'] .= TrendingTags::getHTML(self::$content); + } + + $t = Renderer::getMarkupTemplate("community.tpl"); + return Renderer::replaceMacros($t, [ + '$content' => $o, + '$header' => '', + '$show_global_community_hint' => (self::$content == 'global') && DI::config()->get('system', 'show_global_community_hint'), + '$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.") + ]); + } + + /** + * Computes module parameters from the request and local configuration + * + * @param array $parameters + * @throws HTTPException\BadRequestException + * @throws HTTPException\ForbiddenException + */ + protected static function parseRequest(array $parameters) + { + if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) { + throw new HTTPException\ForbiddenException(DI::l10n()->t('Public access denied.')); + } + + self::$page_style = DI::config()->get('system', 'community_page_style'); + + if (self::$page_style == CP_NO_INTERNAL_COMMUNITY) { + throw new HTTPException\ForbiddenException(DI::l10n()->t('Access denied.')); + } + + switch ($parameters['accounttype'] ?? '') { + case 'person': + self::$accounttype = User::ACCOUNT_TYPE_PERSON; + break; + case 'organisation': + self::$accounttype = User::ACCOUNT_TYPE_ORGANISATION; + break; + case 'news': + self::$accounttype = User::ACCOUNT_TYPE_NEWS; + break; + case 'community': + self::$accounttype = User::ACCOUNT_TYPE_COMMUNITY; + break; + default: + self::$accounttype = null; + break; + } + + self::$content = $parameters['content'] ?? ''; + if (!self::$content) { + if (!empty(DI::config()->get('system', 'singleuser'))) { + // On single user systems only the global page does make sense + self::$content = 'global'; + } else { + // When only the global community is allowed, we use this as default + self::$content = self::$page_style == CP_GLOBAL_COMMUNITY ? 'global' : 'local'; + } + } + + if (!in_array(self::$content, ['local', 'global'])) { + throw new HTTPException\BadRequestException(DI::l10n()->t('Community option not available.')); + } + + // Check if we are allowed to display the content to visitors + if (!local_user()) { + $available = self::$page_style == CP_USERS_AND_GLOBAL; + + if (!$available) { + $available = (self::$page_style == CP_USERS_ON_SERVER) && (self::$content == 'local'); + } + + if (!$available) { + $available = (self::$page_style == CP_GLOBAL_COMMUNITY) && (self::$content == 'global'); + } + + if (!$available) { + throw new HTTPException\ForbiddenException(DI::l10n()->t('Not available.')); + } + } + + // check if we serve a mobile device and get the user settings accordingly + if (DI::mode()->isMobile()) { + self::$itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network', 20); + } else { + self::$itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network', 40); + } + + // now that we have the user settings, see if the theme forces + // a maximum item number which is lower then the user choice + if ((DI::app()->force_max_items > 0) && (DI::app()->force_max_items < self::$itemsPerPage)) { + self::$itemsPerPage = DI::app()->force_max_items; + } + + self::$since_id = $_GET['since_id'] ?? null; + self::$max_id = $_GET['max_id'] ?? null; + } + + /** + * Computes the displayed items. + * + * Community pages have a restriction on how many successive posts by the same author can show on any given page, + * so we may have to retrieve more content beyond the first query + * + * @return array + * @throws \Exception + */ + protected static function getItems() + { + $items = self::selectItems(self::$since_id, self::$max_id, self::$itemsPerPage); + + $maxpostperauthor = (int) DI::config()->get('system', 'max_author_posts_community_page'); + if ($maxpostperauthor != 0 && self::$content == 'local') { + $count = 1; + $previousauthor = ''; + $numposts = 0; + $selected_items = []; + + while (count($selected_items) < self::$itemsPerPage && ++$count < 50 && count($items) > 0) { + foreach ($items as $item) { + if ($previousauthor == $item["author-link"]) { + ++$numposts; + } else { + $numposts = 0; + } + $previousauthor = $item["author-link"]; + + if (($numposts < $maxpostperauthor) && (count($selected_items) < self::$itemsPerPage)) { + $selected_items[] = $item; + } + } + + // If we're looking at a "previous page", the lookup continues forward in time because the list is + // sorted in chronologically decreasing order + if (isset(self::$since_id)) { + self::$since_id = $items[0]['commented']; + } else { + // In any other case, the lookup continues backwards in time + self::$max_id = $items[count($items) - 1]['commented']; + } + + $items = self::selectItems(self::$since_id, self::$max_id, self::$itemsPerPage); + } + } else { + $selected_items = $items; + } + + return $selected_items; + } + + /** + * Database query for the comunity page + * + * @param $since_id + * @param $max_id + * @param $itemspage + * @return array + * @throws \Exception + */ + private static function selectItems($since_id, $max_id, $itemspage) + { + $r = false; + + if (self::$content == 'local') { + $values = []; + + $sql_accounttype = ''; + $sql_boundaries = ''; + if (!is_null(self::$accounttype)) { + $sql_accounttype = " AND `user`.`account-type` = ?"; + $values[] = [self::$accounttype]; + } + + if (isset($since_id)) { + $sql_boundaries .= " AND `thread`.`commented` > ?"; + $values[] = $since_id; + } + + if (isset($max_id)) { + $sql_boundaries .= " AND `thread`.`commented` < ?"; + $values[] = $max_id; + } + + $values[] = $itemspage; + + /// @todo Use "unsearchable" here as well (instead of "hidewall") + $r = DBA::p("SELECT `item`.`uri`, `author`.`url` AS `author-link`, `thread`.`commented` FROM `thread` + STRAIGHT_JOIN `user` ON `user`.`uid` = `thread`.`uid` AND NOT `user`.`hidewall` + STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid` + STRAIGHT_JOIN `contact` AS `author` ON `author`.`id`=`item`.`author-id` + WHERE `thread`.`visible` AND NOT `thread`.`deleted` AND NOT `thread`.`moderated` + AND NOT `thread`.`private` AND `thread`.`wall` AND `thread`.`origin` + $sql_accounttype + $sql_boundaries + ORDER BY `thread`.`commented` DESC + LIMIT ?", $values); + } elseif (self::$content == 'global') { + if (!is_null(self::$accounttype)) { + $condition = ["`uid` = ? AND NOT `author`.`unsearchable` AND NOT `owner`.`unsearchable` AND `owner`.`contact-type` = ?", 0, self::$accounttype]; + } else { + $condition = ["`uid` = ? AND NOT `author`.`unsearchable` AND NOT `owner`.`unsearchable`", 0]; + } + + if (isset($max_id)) { + $condition[0] .= " AND `commented` < ?"; + $condition[] = $max_id; + } + + if (isset($since_id)) { + $condition[0] .= " AND `commented` > ?"; + $condition[] = $since_id; + } + + $r = Item::selectThreadForUser(0, ['uri', 'commented'], $condition, ['order' => ['commented' => true], 'limit' => $itemspage]); + } + + return DBA::toArray($r); + } +} diff --git a/mod/update_community.php b/src/Module/Update/Community.php similarity index 67% rename from mod/update_community.php rename to src/Module/Update/Community.php index 4ad07d606c..9d85cb3e8d 100644 --- a/mod/update_community.php +++ b/src/Module/Update/Community.php @@ -20,19 +20,24 @@ * See update_profile.php for documentation */ -use Friendica\App; +namespace Friendica\Module\Update; + use Friendica\Core\System; use Friendica\DI; -require_once 'mod/community.php'; - -function update_community_content(App $a) +/** + * Asynchronous update module for the community page + * + * @package Friendica\Module\Update + */ +class Community extends \Friendica\Module\Conversation\Community { - if ($_GET["force"] == 1) { - $text = community_content($a, true); - } else { - $text = ''; - } + public static function rawContent(array $parameters = []) + { + self::parseRequest($parameters); - System::htmlUpdateExit($text); + $o = conversation(DI::app(), self::getItems(), 'community', true, false, 'commented', local_user()); + + System::htmlUpdateExit($o); + } } diff --git a/static/routes.config.php b/static/routes.config.php index 489e99f48d..d0a1bde76b 100644 --- a/static/routes.config.php +++ b/static/routes.config.php @@ -102,6 +102,9 @@ return [ '/attach/{item:\d+}' => [Module\Attach::class, [R::GET]], '/babel' => [Module\Debug\Babel::class, [R::GET, R::POST]], '/bookmarklet' => [Module\Bookmarklet::class, [R::GET]], + + '/community[/{content}[/{accounttype}]]' => [Module\Conversation\Community::class, [R::GET]], + '/compose[/{type}]' => [Module\Item\Compose::class, [R::GET, R::POST]], '/contact' => [ @@ -288,6 +291,7 @@ return [ '/toggle_mobile' => [Module\ToggleMobile::class, [R::GET]], '/tos' => [Module\Tos::class, [R::GET]], + '/update_community[/{content}[/{accounttype}]]' => [Module\Update\Community::class, [R::GET]], '/update_profile' => [Module\Update\Profile::class, [R::GET]], '/view/theme/{theme}/style.pcss' => [Module\Theme::class, [R::GET]], diff --git a/view/js/main.js b/view/js/main.js index 560d9c4286..0718ea3ca7 100644 --- a/view/js/main.js +++ b/view/js/main.js @@ -527,6 +527,8 @@ function updateConvItems(data) { // Add new top-level item. if ($('#' + ident).length === 0 && (!getUrlParameter('page') + && !getUrlParameter('max_id') + && !getUrlParameter('since_id') || getUrlParameter('page') === '1' ) ) { @@ -597,6 +599,12 @@ function liveUpdate(src) { if (getUrlParameter('page')) { update_url += '&page=' + getUrlParameter('page'); } + if (getUrlParameter('since_id')) { + update_url += '&since_id=' + getUrlParameter('since_id'); + } + if (getUrlParameter('max_id')) { + update_url += '&max_id=' + getUrlParameter('max_id'); + } $.get(update_url,function(data) { in_progress = false;