X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FModel%2FGroup.php;h=268680a165b79cd7e90e5ae96c190764c7a9af11;hb=073695b33c5f9c5d89d91958b09259c59e12dd98;hp=b87458756a94e14d487a593704a78a4034abcb6b;hpb=e56c8dcc3cc6813a56aac2a0eed0157b0f534ab6;p=friendica.git
diff --git a/src/Model/Group.php b/src/Model/Group.php
index b87458756a..268680a165 100644
--- a/src/Model/Group.php
+++ b/src/Model/Group.php
@@ -1,28 +1,54 @@
.
+ *
*/
namespace Friendica\Model;
use Friendica\BaseModule;
-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;
+use Friendica\Protocol\ActivityPub;
/**
- * @brief functions for interacting with the group database table
+ * functions for interacting with the group database table
*/
class Group
{
const FOLLOWERS = '~';
const MUTUALS = '&';
- public static function getByUserId($uid, $includesDeleted = false)
+ /**
+ * Fetches group record by user id and maybe includes deleted groups as well
+ *
+ * @param int $uid User id to fetch group(s) for
+ * @param bool $includesDeleted Whether deleted groups should be included
+ * @return array|bool Array on success, bool on error
+ */
+ public static function getByUserId(int $uid, bool $includesDeleted = false)
{
- $conditions = ['uid' => $uid];
+ $conditions = ['uid' => $uid, 'cid' => null];
if (!$includesDeleted) {
$conditions['deleted'] = false;
@@ -32,15 +58,18 @@ class Group
}
/**
- * @param int $group_id
+ * Checks whether given group id is found in database
+ *
+ * @param int $group_id Groupd it
+ * @param int $uid Optional user id
* @return bool
* @throws \Exception
*/
- public static function exists($group_id, $uid = null)
+ public static function exists(int $group_id, int $uid = null): bool
{
$condition = ['id' => $group_id, 'deleted' => false];
- if (isset($uid)) {
+ if (!is_null($uid)) {
$condition = [
'uid' => $uid
];
@@ -50,16 +79,16 @@ class Group
}
/**
- * @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
*
- * @param int $uid
- * @param string $name
- * @return boolean
+ * @param int $uid User id to create group for
+ * @param string $name Name of group
+ * @return int|boolean Id of newly created group or false on error
* @throws \Exception
*/
- public static function create($uid, $name)
+ public static function create(int $uid, string $name)
{
$return = false;
if (!empty($uid) && !empty($name)) {
@@ -73,7 +102,7 @@ class Group
$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 may 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 may 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;
}
@@ -95,19 +124,19 @@ class Group
* @return bool Was the update successful?
* @throws \Exception
*/
- public static function update($id, $name)
+ public static function update(int $id, string $name): bool
{
return DBA::update('group', ['name' => $name], ['id' => $id]);
}
/**
- * @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
+ * @param int $cid Contact id
+ * @return array Group ids
* @throws \Exception
*/
- public static function getIdsByContactId($cid)
+ public static function getIdsByContactId(int $cid): array
{
$return = [];
@@ -117,11 +146,21 @@ class Group
}
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
*
@@ -134,7 +173,7 @@ class Group
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
@@ -152,16 +191,16 @@ class Group
}
/**
- * @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.
*
- * @param int $uid
- * @param string $name
- * @return int|boolean
+ * @param int $uid User id
+ * @param string $name Group name
+ * @return int|boolean Groups' id number or false on error
* @throws \Exception
*/
- public static function getIdByName($uid, $name)
+ public static function getIdByName(int $uid, string $name)
{
if (!$uid || !strlen($name)) {
return false;
@@ -176,13 +215,13 @@ class Group
}
/**
- * @brief Mark a group as deleted
+ * Mark a group as deleted
*
* @param int $gid
* @return boolean
* @throws \Exception
*/
- public static function remove($gid)
+ public static function remove(int $gid): bool
{
if (!$gid) {
return false;
@@ -226,101 +265,136 @@ class Group
}
/**
- * @brief Mark a group as deleted based on its name
+ * Adds a contact to a group
*
- * @param int $uid
- * @param string $name
- * @return bool
+ * @param int $gid
+ * @param int $cid
+ * @return boolean
* @throws \Exception
- * @deprecated Use Group::remove instead
- *
*/
- public static function removeByName($uid, $name)
+ public static function addMember(int $gid, int $cid): bool
{
- $return = false;
- if (!empty($uid) && !empty($name)) {
- $gid = self::getIdByName($uid, $name);
+ if (!$gid || !$cid) {
+ return false;
+ }
- $return = self::remove($gid);
+ // @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 Adds a contact to a group
+ * Removes a contact from a group
*
* @param int $gid
* @param int $cid
* @return boolean
* @throws \Exception
*/
- public static function addMember($gid, $cid)
+ public static function removeMember(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::delete('group_member', ['gid' => $gid, 'contact-id' => $cid]);
}
/**
- * @brief Removes a contact from a group
+ * Adds contacts to a group
*
* @param int $gid
- * @param int $cid
- * @return boolean
+ * @param array $contacts Array with contact ids
+ * @return void
* @throws \Exception
*/
- public static function removeMember($gid, $cid)
+ public static function addMembers(int $gid, array $contacts)
{
- if (!$gid || !$cid) {
- return false;
+ if (!$gid || !$contacts) {
+ return;
+ }
+
+ // @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 = DBA::delete('group_member', ['gid' => $gid, 'contact-id' => $cid]);
+ foreach ($contacts as $cid) {
+ $cdata = Contact::getPublicAndUserContactID($cid, $group['uid']);
+ if (empty($cdata['user'])) {
+ throw new HTTPException\NotFoundException('Invalid contact.');
+ }
- return $return;
+ DBA::insert('group_member', ['gid' => $gid, 'contact-id' => $cdata['user']], Database::INSERT_IGNORE);
+ }
}
/**
- * @brief Removes a contact from a group based on its name
+ * Removes contacts from a group
*
- * @param int $uid
- * @param string $name
- * @param int $cid
- * @return boolean
+ * @param int $gid Group id
+ * @param array $contacts Contact ids
+ * @return bool
* @throws \Exception
- * @deprecated Use Group::removeMember instead
- *
*/
- public static function removeMemberByName($uid, $name, $cid)
+ public static function removeMembers(int $gid, array $contacts)
{
- $gid = self::getIdByName($uid, $name);
+ if (!$gid || !$contacts) {
+ return false;
+ }
+
+ // @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);
+ $contactIds = [];
- return $return;
+ foreach ($contacts as $cid) {
+ $cdata = Contact::getPublicAndUserContactID($cid, $group['uid']);
+ if (empty($cdata['user'])) {
+ throw new HTTPException\NotFoundException('Invalid contact.');
+ }
+
+ $contactIds[] = $cdata['user'];
+ }
+
+ // Return status of deletion
+ return DBA::delete('group_member', ['gid' => $gid, 'contact-id' => $contactIds]);
}
/**
- * @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
- * @param boolean $check_dead
+ * @param int $uid User id
+ * @param array $group_ids Groups ids
+ * @param boolean $check_dead Whether check "dead" records (?)
* @return array
* @throws \Exception
*/
- public static function expand($uid, array $group_ids, $check_dead = false)
+ public static function expand(int $uid, array $group_ids, bool $check_dead = false): array
{
if (!is_array($group_ids) || !count($group_ids)) {
return [];
@@ -391,15 +465,15 @@ class Group
}
/**
- * @brief Returns a templated group selection list
+ * Returns a templated group selection list
*
- * @param int $uid
+ * @param int $uid User id
* @param int $gid An optional pre-selected group
* @param string $label An optional label of the list
* @return string
* @throws \Exception
*/
- public static function displayGroupSelection($uid, $gid = 0, $label = '')
+ public static function displayGroupSelection(int $uid, int $gid = 0, string $label = ''): string
{
$display_groups = [
[
@@ -409,7 +483,7 @@ class Group
]
];
- $stmt = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid], ['order' => ['name']]);
+ $stmt = DBA::select('group', [], ['deleted' => false, 'uid' => $uid, 'cid' => null], ['order' => ['name']]);
while ($group = DBA::fetch($stmt)) {
$display_groups[] = [
'name' => $group['name'],
@@ -422,7 +496,7 @@ class Group
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'), [
@@ -433,7 +507,7 @@ class Group
}
/**
- * @brief Create group sidebar widget
+ * Create group sidebar widget
*
* @param string $every
* @param string $each
@@ -441,12 +515,12 @@ class Group
* 'standard' => include link 'Edit groups'
* 'extended' => include link 'Create new group'
* 'full' => include link 'Create new group' and provide for each group a link to edit this group
- * @param string $group_id
- * @param int $cid
- * @return string
+ * @param string|int $group_id Distinct group id or 'everyone'
+ * @param int $cid Contact id
+ * @return string Sidebar widget HTML code
* @throws \Exception
*/
- public static function sidebarWidget($every = 'contact', $each = 'group', $editmode = 'standard', $group_id = '', $cid = 0)
+ public static function sidebarWidget(string $every = 'contact', string $each = 'group', string $editmode = 'standard', $group_id = '', int $cid = 0)
{
if (!local_user()) {
return '';
@@ -454,7 +528,7 @@ class Group
$display_groups = [
[
- 'text' => L10n::t('Everybody'),
+ 'text' => DI::l10n()->t('Everybody'),
'id' => 0,
'selected' => (($group_id === 'everyone') ? 'group-selected' : ''),
'href' => $every,
@@ -466,23 +540,30 @@ class Group
$member_of = self::getIdsByContactId($cid);
}
- $stmt = DBA::select('group', [], ['deleted' => 0, 'uid' => local_user()], ['order' => ['name']]);
+ $stmt = DBA::select('group', [], ['deleted' => false, 'uid' => local_user(), 'cid' => null], ['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,
@@ -498,20 +579,96 @@ class Group
$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;
}
+
+ /**
+ * Fetch the group id for the given contact id
+ *
+ * @param integer $id Contact ID
+ * @return integer Group IO
+ */
+ public static function getIdForForum(int $id): int
+ {
+ Logger::info('Get id for forum id', ['id' => $id]);
+ $contact = Contact::getById($id, ['uid', 'name', 'contact-type', 'manually-approve']);
+ if (empty($contact) || ($contact['contact-type'] != Contact::TYPE_COMMUNITY) || !$contact['manually-approve']) {
+ return 0;
+ }
+
+ $group = DBA::selectFirst('group', ['id'], ['uid' => $contact['uid'], 'cid' => $id]);
+ if (empty($group)) {
+ $fields = [
+ 'uid' => $contact['uid'],
+ 'name' => $contact['name'],
+ 'cid' => $id,
+ ];
+ DBA::insert('group', $fields);
+ $gid = DBA::lastInsertId();
+ } else {
+ $gid = $group['id'];
+ }
+
+ return $gid;
+ }
+
+ /**
+ * Fetch the followers of a given contact id and store them as group members
+ *
+ * @param integer $id Contact ID
+ * @return void
+ */
+ public static function updateMembersForForum(int $id)
+ {
+ Logger::info('Update forum members', ['id' => $id]);
+
+ $contact = Contact::getById($id, ['uid', 'url']);
+ if (empty($contact)) {
+ return;
+ }
+
+ $apcontact = APContact::getByURL($contact['url']);
+ if (empty($apcontact['followers'])) {
+ return;
+ }
+
+ $gid = self::getIdForForum($id);
+ if (empty($gid)) {
+ return;
+ }
+
+ $group_members = DBA::selectToArray('group_member', ['contact-id'], ['gid' => $gid]);
+ if (!empty($group_members)) {
+ $current = array_unique(array_column($group_members, 'contact-id'));
+ } else {
+ $current = [];
+ }
+
+ foreach (ActivityPub::fetchItems($apcontact['followers'], $contact['uid']) as $follower) {
+ $id = Contact::getIdForURL($follower);
+ if (!in_array($id, $current)) {
+ DBA::insert('group_member', ['gid' => $gid, 'contact-id' => $id]);
+ } else {
+ $key = array_search($id, $current);
+ unset($current[$key]);
+ }
+ }
+
+ DBA::delete('group_member', ['gid' => $gid, 'contact-id' => $current]);
+ Logger::info('Updated forum members', ['id' => $id, 'count' => DBA::count('group_member', ['gid' => $gid])]);
+ }
}