src/Content/ForumManager.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   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\Content;
  23
  24 use Friendica\Content\Text\HTML;
  25 use Friendica\Core\Protocol;
  26 use Friendica\Core\Renderer;
  27 use Friendica\Database\DBA;
  28 use Friendica\DI;
  29 use Friendica\Model\Contact;
  30
  31 /**
  32  * This class handles methods related to the forum functionality
  33  */
  34 class ForumManager
  35 {
  36         /**
  37          * Function to list all forums a user is connected with
  38          *
  39          * @param int     $uid         of the profile owner
  40          * @param boolean $lastitem    Sort by lastitem
  41          * @param boolean $showhidden  Show frorums which are not hidden
  42          * @param boolean $showprivate Show private groups
  43          *
  44          * @return array
  45          *    'url'    => forum url
  46          *    'name'    => forum name
  47          *    'id'    => number of the key from the array
  48          *    'micro' => contact photo in format micro
  49          *    'thumb' => contact photo in format thumb
  50          * @throws \Exception
  51          */
  52         public static function getList($uid, $lastitem, $showhidden = true, $showprivate = false)
  53         {
  54                 if ($lastitem) {
  55                         $params = ['order' => ['last-item' => true]];
  56                 } else {
  57                         $params = ['order' => ['name']];
  58                 }
  59
  60                 $condition_str = "`network` IN (?, ?) AND `uid` = ? AND NOT `blocked` AND NOT `pending` AND NOT `archive` AND ";
  61
  62                 if ($showprivate) {
  63                         $condition_str .= '(`forum` OR `prv`)';
  64                 } else {
  65                         $condition_str .= '`forum`';
  66                 }
  67
  68                 if (!$showhidden) {
  69                         $condition_str .=  ' AND NOT `hidden`';
  70                 }
  71
  72                 $forumlist = [];
  73
  74                 $fields = ['id', 'url', 'name', 'micro', 'thumb', 'avatar'];
  75                 $condition = [$condition_str, Protocol::DFRN, Protocol::ACTIVITYPUB, $uid];
  76                 $contacts = DBA::select('contact', $fields, $condition, $params);
  77                 if (!$contacts) {
  78                         return($forumlist);
  79                 }
  80
  81                 while ($contact = DBA::fetch($contacts)) {
  82                         $forumlist[] = [
  83                                 'url'   => $contact['url'],
  84                                 'name'  => $contact['name'],
  85                                 'id'    => $contact['id'],
  86                                 'micro' => $contact['micro'],
  87                                 'thumb' => $contact['thumb'],
  88                         ];
  89                 }
  90                 DBA::close($contacts);
  91
  92                 return($forumlist);
  93         }
  94
  95
  96         /**
  97          * Forumlist widget
  98          *
  99          * Sidebar widget to show subcribed friendica forums. If activated
 100          * in the settings, it appears at the notwork page sidebar
 101          *
 102          * @param string $baseurl Base module path
 103          * @param int    $uid     The ID of the User
 104          * @param int    $cid     The contact id which is used to mark a forum as "selected"
 105          * @return string
 106          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 107          * @throws \ImagickException
 108          */
 109         public static function widget(string $baseurl, int $uid, int $cid = 0)
 110         {
 111                 $o = '';
 112
 113                 //sort by last updated item
 114                 $lastitem = true;
 115
 116                 $contacts = self::getList($uid, $lastitem, true, true);
 117                 $total = count($contacts);
 118                 $visible_forums = 10;
 119
 120                 if (DBA::isResult($contacts)) {
 121                         $id = 0;
 122
 123                         $entries = [];
 124
 125                         foreach ($contacts as $contact) {
 126                                 $selected = (($cid == $contact['id']) ? ' forum-selected' : '');
 127
 128                                 $entry = [
 129                                         'url' => $baseurl . '/' . $contact['id'],
 130                                         'external_url' => Contact::magicLink($contact['url']),
 131                                         'name' => $contact['name'],
 132                                         'cid' => $contact['id'],
 133                                         'selected'      => $selected,
 134                                         'micro' => DI::baseUrl()->remove(Contact::getMicro($contact)),
 135                                         'id' => ++$id,
 136                                 ];
 137                                 $entries[] = $entry;
 138                         }
 139
 140                         $tpl = Renderer::getMarkupTemplate('widget_forumlist.tpl');
 141
 142                         $o .= Renderer::replaceMacros(
 143                                 $tpl,
 144                                 [
 145                                         '$title'        => DI::l10n()->t('Forums'),
 146                                         '$forums'       => $entries,
 147                                         '$link_desc'    => DI::l10n()->t('External link to forum'),
 148                                         '$total'        => $total,
 149                                         '$visible_forums' => $visible_forums,
 150                                         '$showless'     => DI::l10n()->t('show less'),
 151                                         '$showmore'     => DI::l10n()->t('show more')]
 152                         );
 153                 }
 154
 155                 return $o;
 156         }
 157
 158         /**
 159          * Format forumlist as contact block
 160          *
 161          * This function is used to show the forumlist in
 162          * the advanced profile.
 163          *
 164          * @param int $uid The ID of the User
 165          * @return string
 166          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 167          * @throws \ImagickException
 168          */
 169         public static function profileAdvanced($uid)
 170         {
 171                 $profile = intval(Feature::isEnabled($uid, 'forumlist_profile'));
 172                 if (!$profile) {
 173                         return '';
 174                 }
 175
 176                 $o = '';
 177
 178                 // place holder in case somebody wants configurability
 179                 $show_total = 9999;
 180
 181                 //don't sort by last updated item
 182                 $lastitem = false;
 183
 184                 $contacts = self::getList($uid, $lastitem, false, false);
 185
 186                 $total_shown = 0;
 187                 foreach ($contacts as $contact) {
 188                         $o .= HTML::micropro($contact, true, 'forumlist-profile-advanced');
 189                         $total_shown++;
 190                         if ($total_shown == $show_total) {
 191                                 break;
 192                         }
 193                 }
 194
 195                 return $o;
 196         }
 197
 198         /**
 199          * count unread forum items
 200          *
 201          * Count unread items of connected forums and private groups
 202          *
 203          * @return array
 204          *    'id' => contact id
 205          *    'name' => contact/forum name
 206          *    'count' => counted unseen forum items
 207          * @throws \Exception
 208          */
 209         public static function countUnseenItems()
 210         {
 211                 $stmtContacts = DBA::p(
 212                         "SELECT `contact`.`id`, `contact`.`name`, COUNT(*) AS `count` FROM `post-view`
 213                                 INNER JOIN `contact` ON `post-view`.`contact-id` = `contact`.`id`
 214                                 WHERE `post-view`.`uid` = ? AND `post-view`.`visible` AND NOT `post-view`.`deleted` AND `post-view`.`unseen`
 215                                 AND `contact`.`network` IN (?, ?) AND `contact`.`contact-type` = ?
 216                                 AND NOT `contact`.`blocked` AND NOT `contact`.`hidden`
 217                                 AND NOT `contact`.`pending` AND NOT `contact`.`archive`
 218                                 GROUP BY `contact`.`id`",
 219                         local_user(), Protocol::DFRN, Protocol::ACTIVITYPUB, Contact::TYPE_COMMUNITY
 220                 );
 221
 222                 return DBA::toArray($stmtContacts);
 223         }
 224 }