]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Group.php
Use rawContent for Special Options to avoid a protected options() method
[friendica.git] / src / Model / Group.php
index 965dfe8d7f366353f354bed98f3959f179f6775d..17e0a18e2e49dd0c8019f2779dcb2b541898e5c8 100644 (file)
@@ -1,38 +1,52 @@
 <?php
 /**
- * @file src/Model/Group.php
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
+
 namespace Friendica\Model;
 
 use Friendica\BaseModule;
-use Friendica\BaseObject;
-use Friendica\Core\L10n;
 use Friendica\Core\Logger;
 use Friendica\Core\Protocol;
 use Friendica\Core\Renderer;
+use Friendica\Database\Database;
 use Friendica\Database\DBA;
+use Friendica\DI;
+use Friendica\Network\HTTPException;
 
 /**
- * @brief functions for interacting with the group database table
+ * functions for interacting with the group database table
  */
-class Group extends BaseObject
+class Group
 {
        const FOLLOWERS = '~';
        const MUTUALS = '&';
 
        public static function getByUserId($uid, $includesDeleted = false)
        {
-               $DB = self::getApp()->getDatabase();
-
                $conditions = ['uid' => $uid];
 
                if (!$includesDeleted) {
                        $conditions['deleted'] = false;
                }
 
-               $groupsStmt = $DB->select('group', [], $conditions);
-
-               return $DB->toArray($groupsStmt);
+               return DBA::selectToArray('group', [], $conditions);
        }
 
        /**
@@ -54,7 +68,7 @@ class Group extends BaseObject
        }
 
        /**
-        * @brief Create a new contact group
+        * Create a new contact group
         *
         * Note: If we found a deleted group with the same name, we restore it
         *
@@ -77,7 +91,7 @@ class Group extends BaseObject
                                $group = DBA::selectFirst('group', ['deleted'], ['id' => $gid]);
                                if (DBA::isResult($group) && $group['deleted']) {
                                        DBA::update('group', ['deleted' => 0], ['id' => $gid]);
-                                       notice(L10n::t('A deleted group with this name was revived. Existing item permissions <strong>may</strong> apply to this group and any future members. If this is not what you intended, please create another group with a different name.') . EOL);
+                                       notice(DI::l10n()->t('A deleted group with this name was revived. Existing item permissions <strong>may</strong> apply to this group and any future members. If this is not what you intended, please create another group with a different name.'));
                                }
                                return true;
                        }
@@ -93,8 +107,8 @@ class Group extends BaseObject
        /**
         * Update group information.
         *
-        * @param  int    $id   Group ID
-        * @param  string $name Group name
+        * @param int    $id   Group ID
+        * @param string $name Group name
         *
         * @return bool Was the update successful?
         * @throws \Exception
@@ -105,7 +119,7 @@ class Group extends BaseObject
        }
 
        /**
-        * @brief Get a list of group ids a contact belongs to
+        * Get a list of group ids a contact belongs to
         *
         * @param int $cid
         * @return array
@@ -113,20 +127,29 @@ class Group extends BaseObject
         */
        public static function getIdsByContactId($cid)
        {
-               $condition = ['contact-id' => $cid];
-               $stmt = DBA::select('group_member', ['gid'], $condition);
-
                $return = [];
 
+               $stmt = DBA::select('group_member', ['gid'], ['contact-id' => $cid]);
                while ($group = DBA::fetch($stmt)) {
                        $return[] = $group['gid'];
                }
+               DBA::close($stmt);
+
+               // Meta-groups
+               $contact = Contact::getById($cid, ['rel']);
+               if ($contact['rel'] == Contact::FOLLOWER || $contact['rel'] == Contact::FRIEND) {
+                       $return[] = self::FOLLOWERS;
+               }
+
+               if ($contact['rel'] == Contact::FRIEND) {
+                       $return[] = self::MUTUALS;
+               }
 
                return $return;
        }
 
        /**
-        * @brief count unread group items
+        * count unread group items
         *
         * Count unread items of each groups of the local user
         *
@@ -139,7 +162,7 @@ class Group extends BaseObject
        public static function countUnseen()
        {
                $stmt = DBA::p("SELECT `group`.`id`, `group`.`name`,
-                               (SELECT COUNT(*) FROM `item` FORCE INDEX (`uid_unseen_contactid`)
+                               (SELECT COUNT(*) FROM `post-user`
                                        WHERE `uid` = ?
                                        AND `unseen`
                                        AND `contact-id` IN
@@ -157,7 +180,7 @@ class Group extends BaseObject
        }
 
        /**
-        * @brief Get the group id for a user/name couple
+        * Get the group id for a user/name couple
         *
         * Returns false if no group has been found.
         *
@@ -181,14 +204,15 @@ class Group extends BaseObject
        }
 
        /**
-        * @brief Mark a group as deleted
+        * Mark a group as deleted
         *
         * @param int $gid
         * @return boolean
         * @throws \Exception
         */
-       public static function remove($gid) {
-               if (! $gid) {
+       public static function remove($gid)
+       {
+               if (!$gid) {
                        return false;
                }
 
@@ -230,92 +254,63 @@ class Group extends BaseObject
        }
 
        /**
-        * @brief      Mark a group as deleted based on its name
-        *
-        * @deprecated Use Group::remove instead
-        *
-        * @param int    $uid
-        * @param string $name
-        * @return bool
-        * @throws \Exception
-        */
-       public static function removeByName($uid, $name) {
-               $return = false;
-               if (!empty($uid) && !empty($name)) {
-                       $gid = self::getIdByName($uid, $name);
-
-                       $return = self::remove($gid);
-               }
-
-               return $return;
-       }
-
-       /**
-        * @brief Adds a contact to a group
+        * Adds a contact to a group
         *
         * @param int $gid
         * @param int $cid
         * @return boolean
         * @throws \Exception
         */
-       public static function addMember($gid, $cid)
+       public static function addMember(int $gid, int $cid): bool
        {
                if (!$gid || !$cid) {
                        return false;
                }
 
-               $row_exists = DBA::exists('group_member', ['gid' => $gid, 'contact-id' => $cid]);
-               if ($row_exists) {
-                       // Row already existing, nothing to do
-                       $return = true;
-               } else {
-                       $return = DBA::insert('group_member', ['gid' => $gid, 'contact-id' => $cid]);
+               // @TODO Backward compatibility with user contacts, remove by version 2022.03
+               $group = DBA::selectFirst('group', ['uid'], ['id' => $gid]);
+               if (empty($group)) {
+                       throw new HTTPException\NotFoundException('Group not found.');
                }
 
-               return $return;
+               $cdata = Contact::getPublicAndUserContactID($cid, $group['uid']);
+               if (empty($cdata['user'])) {
+                       throw new HTTPException\NotFoundException('Invalid contact.');
+               }
+
+               return DBA::insert('group_member', ['gid' => $gid, 'contact-id' => $cdata['user']], Database::INSERT_IGNORE);
        }
 
        /**
-        * @brief Removes a contact from a group
+        * Removes a contact from a group
         *
         * @param int $gid
         * @param int $cid
         * @return boolean
         * @throws \Exception
         */
-       public static function removeMember($gid, $cid)
+       public static function removeMember(int $gid, int $cid): bool
        {
                if (!$gid || !$cid) {
                        return false;
                }
 
-               $return = DBA::delete('group_member', ['gid' => $gid, 'contact-id' => $cid]);
-
-               return $return;
-       }
-
-       /**
-        * @brief      Removes a contact from a group based on its name
-        *
-        * @deprecated Use Group::removeMember instead
-        *
-        * @param int    $uid
-        * @param string $name
-        * @param int    $cid
-        * @return boolean
-        * @throws \Exception
-        */
-       public static function removeMemberByName($uid, $name, $cid)
-       {
-               $gid = self::getIdByName($uid, $name);
+               // @TODO Backward compatibility with user contacts, remove by version 2022.03
+               $group = DBA::selectFirst('group', ['uid'], ['id' => $gid]);
+               if (empty($group)) {
+                       throw new HTTPException\NotFoundException('Group not found.');
+               }
 
-               $return = self::removeMember($gid, $cid);
+               $cdata = Contact::getPublicAndUserContactID($cid, $group['uid']);
+               if (empty($cdata['user'])) {
+                       throw new HTTPException\NotFoundException('Invalid contact.');
+               }
 
-               return $return;
+               return DBA::delete('group_member', ['gid' => $gid, 'contact-id' => $cid]);
        }
 
        /**
-        * @brief Returns the combined list of contact ids from a group id list
+        * Returns the combined list of contact ids from a group id list
         *
         * @param int     $uid
         * @param array   $group_ids
@@ -330,16 +325,31 @@ class Group extends BaseObject
                }
 
                $return = [];
+               $pubmail = false;
+               $networks = Protocol::SUPPORT_PRIVATE;
+
+               $mailacct = DBA::selectFirst('mailacct', ['pubmail'], ['`uid` = ? AND `server` != ""', $uid]);
+               if (DBA::isResult($mailacct)) {
+                       $pubmail = $mailacct['pubmail'];
+               }
+
+               if (!$pubmail) {
+                       $networks = array_diff($networks, [Protocol::MAIL]);
+               }
 
                $key = array_search(self::FOLLOWERS, $group_ids);
                if ($key !== false) {
-                       $followersStmt = Contact::select(['id'], [
+                       $followers = Contact::selectToArray(['id'], [
                                'uid' => $uid,
                                'rel' => [Contact::FOLLOWER, Contact::FRIEND],
-                               'protocol' => Protocol::SUPPORT_PRIVATE,
+                               'network' => $networks,
+                               'contact-type' => [Contact::TYPE_UNKNOWN, Contact::TYPE_PERSON],
+                               'archive' => false,
+                               'pending' => false,
+                               'blocked' => false,
                        ]);
 
-                       while($follower = DBA::fetch($followersStmt)) {
+                       foreach ($followers as $follower) {
                                $return[] = $follower['id'];
                        }
 
@@ -348,13 +358,17 @@ class Group extends BaseObject
 
                $key = array_search(self::MUTUALS, $group_ids);
                if ($key !== false) {
-                       $mutualsStmt = Contact::select(['id'], [
+                       $mutuals = Contact::selectToArray(['id'], [
                                'uid' => $uid,
                                'rel' => [Contact::FRIEND],
-                               'protocol' => Protocol::SUPPORT_PRIVATE,
+                               'network' => $networks,
+                               'contact-type' => [Contact::TYPE_UNKNOWN, Contact::TYPE_PERSON],
+                               'archive' => false,
+                               'pending' => false,
+                               'blocked' => false,
                        ]);
 
-                       while($mutual = DBA::fetch($mutualsStmt)) {
+                       foreach ($mutuals as $mutual) {
                                $return[] = $mutual['id'];
                        }
 
@@ -362,19 +376,20 @@ class Group extends BaseObject
                }
 
                $stmt = DBA::select('group_member', ['contact-id'], ['gid' => $group_ids]);
-               while($group_member = DBA::fetch($stmt)) {
+               while ($group_member = DBA::fetch($stmt)) {
                        $return[] = $group_member['contact-id'];
                }
+               DBA::close($stmt);
 
                if ($check_dead) {
-                       Contact::pruneUnavailable($return);
+                       $return = Contact::pruneUnavailable($return);
                }
 
                return $return;
        }
 
        /**
-        * @brief Returns a templated group selection list
+        * Returns a templated group selection list
         *
         * @param int    $uid
         * @param int    $gid   An optional pre-selected group
@@ -384,8 +399,6 @@ class Group extends BaseObject
         */
        public static function displayGroupSelection($uid, $gid = 0, $label = '')
        {
-               $stmt = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid], ['order' => ['name']]);
-
                $display_groups = [
                        [
                                'name' => '',
@@ -393,6 +406,8 @@ class Group extends BaseObject
                                'selected' => ''
                        ]
                ];
+
+               $stmt = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid], ['order' => ['name']]);
                while ($group = DBA::fetch($stmt)) {
                        $display_groups[] = [
                                'name' => $group['name'],
@@ -400,10 +415,12 @@ class Group extends BaseObject
                                'selected' => $gid == $group['id'] ? 'true' : ''
                        ];
                }
-               Logger::log('groups: ' . print_r($display_groups, true));
+               DBA::close($stmt);
+
+               Logger::info('Got groups', $display_groups);
 
                if ($label == '') {
-                       $label = L10n::t('Default privacy group for new contacts');
+                       $label = DI::l10n()->t('Default privacy group for new contacts');
                }
 
                $o = Renderer::replaceMacros(Renderer::getMarkupTemplate('group_selection.tpl'), [
@@ -414,7 +431,7 @@ class Group extends BaseObject
        }
 
        /**
-        * @brief Create group sidebar widget
+        * Create group sidebar widget
         *
         * @param string $every
         * @param string $each
@@ -435,42 +452,49 @@ class Group extends BaseObject
 
                $display_groups = [
                        [
-                               'text' => L10n::t('Everybody'),
+                               'text' => DI::l10n()->t('Everybody'),
                                'id' => 0,
                                'selected' => (($group_id === 'everyone') ? 'group-selected' : ''),
                                'href' => $every,
                        ]
                ];
 
-               $stmt = DBA::select('group', [], ['deleted' => 0, 'uid' => local_user()], ['order' => ['name']]);
-
                $member_of = [];
                if ($cid) {
                        $member_of = self::getIdsByContactId($cid);
                }
 
+               $stmt = DBA::select('group', [], ['deleted' => 0, 'uid' => local_user()], ['order' => ['name']]);
                while ($group = DBA::fetch($stmt)) {
                        $selected = (($group_id == $group['id']) ? ' group-selected' : '');
 
                        if ($editmode == 'full') {
                                $groupedit = [
                                        'href' => 'group/' . $group['id'],
-                                       'title' => L10n::t('edit'),
+                                       'title' => DI::l10n()->t('edit'),
                                ];
                        } else {
                                $groupedit = null;
                        }
 
+                       if ($each == 'group') {
+                               $count = DBA::count('group_member', ['gid' => $group['id']]);
+                               $group_name = sprintf('%s (%d)', $group['name'], $count);
+                       } else {
+                               $group_name = $group['name'];
+                       }
+
                        $display_groups[] = [
                                'id'   => $group['id'],
                                'cid'  => $cid,
-                               'text' => $group['name'],
+                               'text' => $group_name,
                                'href' => $each . '/' . $group['id'],
                                'edit' => $groupedit,
                                'selected' => $selected,
                                'ismember' => in_array($group['id'], $member_of),
                        ];
                }
+               DBA::close($stmt);
 
                // Don't show the groups on the network page when there is only one
                if ((count($display_groups) <= 2) && ($each == 'network')) {
@@ -479,21 +503,20 @@ class Group extends BaseObject
 
                $tpl = Renderer::getMarkupTemplate('group_side.tpl');
                $o = Renderer::replaceMacros($tpl, [
-                       '$add' => L10n::t('add'),
-                       '$title' => L10n::t('Groups'),
+                       '$add' => DI::l10n()->t('add'),
+                       '$title' => DI::l10n()->t('Groups'),
                        '$groups' => $display_groups,
                        'newgroup' => $editmode == 'extended' || $editmode == 'full' ? 1 : '',
                        'grouppage' => 'group/',
-                       '$edittext' => L10n::t('Edit group'),
-                       '$ungrouped' => $every === 'contact' ? L10n::t('Contacts not in any group') : '',
+                       '$edittext' => DI::l10n()->t('Edit group'),
+                       '$ungrouped' => $every === 'contact' ? DI::l10n()->t('Contacts not in any group') : '',
                        '$ungrouped_selected' => (($group_id === 'none') ? 'group-selected' : ''),
-                       '$createtext' => L10n::t('Create a new group'),
-                       '$creategroup' => L10n::t('Group Name: '),
-                       '$editgroupstext' => L10n::t('Edit groups'),
+                       '$createtext' => DI::l10n()->t('Create a new group'),
+                       '$creategroup' => DI::l10n()->t('Group Name: '),
+                       '$editgroupstext' => DI::l10n()->t('Edit groups'),
                        '$form_security_token' => BaseModule::getFormSecurityToken('group_edit'),
                ]);
 
-
                return $o;
        }
 }