<?php
-
/**
- * @file src/Model/Group.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @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\BaseObject;
-use Friendica\Database\DBM;
-use dba;
-
-require_once 'boot.php';
-require_once 'include/text.php';
+use Friendica\BaseModule;
+use Friendica\Core\Logger;
+use Friendica\Core\Protocol;
+use Friendica\Core\Renderer;
+use Friendica\Database\DBA;
+use Friendica\DI;
/**
- * @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)
+ {
+ $conditions = ['uid' => $uid];
+
+ if (!$includesDeleted) {
+ $conditions['deleted'] = false;
+ }
+
+ return DBA::selectToArray('group', [], $conditions);
+ }
+
+ /**
+ * @param int $group_id
+ * @return bool
+ * @throws \Exception
+ */
+ public static function exists($group_id, $uid = null)
+ {
+ $condition = ['id' => $group_id, 'deleted' => false];
+
+ if (isset($uid)) {
+ $condition = [
+ 'uid' => $uid
+ ];
+ }
+
+ return DBA::exists('group', $condition);
+ }
+
/**
- * @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 int $uid
* @param string $name
* @return boolean
+ * @throws \Exception
*/
public static function create($uid, $name)
{
$return = false;
- if (x($uid) && x($name)) {
+ if (!empty($uid) && !empty($name)) {
$gid = self::getIdByName($uid, $name); // check for dupes
if ($gid !== false) {
// This could be a problem.
// all the old members are gone, but the group remains so we don't break any security
// access lists. What we're doing here is reviving the dead group, but old content which
// was restricted to this group may now be seen by the new group members.
- $group = dba::select('group', ['deleted'], ['id' => $gid], ['limit' => 1]);
- if (DBM::is_result($group) && $group['deleted']) {
- dba::update('group', ['deleted' => 0], ['gid' => $gid]);
- notice(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);
+ $group = DBA::selectFirst('group', ['deleted'], ['id' => $gid]);
+ if (DBA::isResult($group) && $group['deleted']) {
+ DBA::update('group', ['deleted' => 0], ['id' => $gid]);
+ 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;
}
- $return = dba::insert('group', ['uid' => $uid, 'name' => $name]);
+ $return = DBA::insert('group', ['uid' => $uid, 'name' => $name]);
+ if ($return) {
+ $return = DBA::lastInsertId();
+ }
}
return $return;
}
/**
- * @brief Get a list of group ids a contact belongs to
+ * Update group information.
+ *
+ * @param int $id Group ID
+ * @param string $name Group name
*
- * @todo Get rid of $uid, the contact id already bears the information
+ * @return bool Was the update successful?
+ * @throws \Exception
+ */
+ public static function update($id, $name)
+ {
+ return DBA::update('group', ['name' => $name], ['id' => $id]);
+ }
+
+ /**
+ * Get a list of group ids a contact belongs to
*
- * @param int $uid
* @param int $cid
* @return array
+ * @throws \Exception
*/
- private static function getByContactIdForUserId($uid, $cid)
+ public static function getIdsByContactId($cid)
{
- $stmt = dba::p('SELECT `id`
- FROM `group`
- INNER JOIN `group_member`
- ON `group_member`.`gid` = `group`.`id`
- WHERE `group`.`uid` = ?
- AND `group_member`.`contact-id` = ?',
- $uid,
- $cid
- );
-
$return = [];
- if (DBM::is_result($stmt)) {
- while($group = dba::fetch($stmt)) {
- $return[] = $group['id'];
- }
+
+ $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
*
* @return array
- * 'id' => group id
- * 'name' => group name
- * 'count' => counted unseen group items
+ * 'id' => group id
+ * 'name' => group name
+ * 'count' => counted unseen group items
+ * @throws \Exception
*/
public static function countUnseen()
{
- $stmt = dba::p("SELECT `group`.`id`, `group`.`name`,
+ $stmt = DBA::p("SELECT `group`.`id`, `group`.`name`,
(SELECT COUNT(*) FROM `item` FORCE INDEX (`uid_unseen_contactid`)
WHERE `uid` = ?
AND `unseen`
AND `contact-id` IN
(SELECT `contact-id`
FROM `group_member`
- WHERE `group_member`.`gid` = `group`.`id`
- AND `group_member`.`uid` = ?)
+ WHERE `group_member`.`gid` = `group`.`id`)
) AS `count`
FROM `group`
WHERE `group`.`uid` = ?;",
local_user(),
- local_user(),
local_user()
);
- return dba::inArray($stmt);
+ return DBA::toArray($stmt);
}
/**
- * @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 int $uid
* @param string $name
* @return int|boolean
+ * @throws \Exception
*/
public static function getIdByName($uid, $name)
{
- if ((! $uid) || (! strlen($name))) {
+ if (!$uid || !strlen($name)) {
return false;
}
- $group = dba::select('group', ['id'], ['uid' => $uid, 'name' => $name], ['limit' => 1]);
- if (DBM::is_result($group)) {
+ $group = DBA::selectFirst('group', ['id'], ['uid' => $uid, 'name' => $name]);
+ if (DBA::isResult($group)) {
return $group['id'];
}
}
/**
- * @brief Mark a group as deleted
+ * Mark a group as deleted
*
- * @param type $gid
+ * @param int $gid
* @return boolean
+ * @throws \Exception
*/
- public static function remove($gid) {
- if (! $gid) {
+ public static function remove($gid)
+ {
+ if (!$gid) {
+ return false;
+ }
+
+ $group = DBA::selectFirst('group', ['uid'], ['id' => $gid]);
+ if (!DBA::isResult($group)) {
return false;
}
// remove group from default posting lists
- $user = dba::select('user', ['def_gid', 'allow_gid', 'deny_gid'], ['uid' => $uid], ['limit' => 1]);
- if (DBM::is_result($user)) {
+ $user = DBA::selectFirst('user', ['def_gid', 'allow_gid', 'deny_gid'], ['uid' => $group['uid']]);
+ if (DBA::isResult($user)) {
$change = false;
if ($user['def_gid'] == $gid) {
}
if ($change) {
- dba::update('user', $user, ['uid' => $uid]);
+ DBA::update('user', $user, ['uid' => $group['uid']]);
}
}
// remove all members
- dba::delete('group_member', ['gid' => $gid]);
+ DBA::delete('group_member', ['gid' => $gid]);
// remove group
- $return = dba::update('group', ['deleted' => 1], ['id' => $gid]);
+ $return = DBA::update('group', ['deleted' => 1], ['id' => $gid]);
return $return;
}
/**
- * @brief Mark a group as deleted based on its name
+ * Mark a group as deleted based on its name
*
+ * @param int $uid
+ * @param string $name
+ * @return bool
+ * @throws \Exception
* @deprecated Use Group::remove instead
*
- * @param type $uid
- * @param type $name
- * @return type
*/
- public static function removeByName($uid, $name) {
+ public static function removeByName($uid, $name)
+ {
$return = false;
- if (x($uid) && x($name)) {
+ if (!empty($uid) && !empty($name)) {
$gid = self::getIdByName($uid, $name);
$return = self::remove($gid);
}
/**
- * @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)
{
return false;
}
- $row_exists = dba::exists('group_member', ['gid' => $gid, 'contact-id' => $cid]);
+ $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]);
+ $return = DBA::insert('group_member', ['gid' => $gid, 'contact-id' => $cid]);
}
return $return;
}
/**
- * @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)
{
return false;
}
- $return = dba::delete('group_member', ['gid' => $gid, 'contact-id' => $cid]);
+ $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
+ * Removes a contact from a group based on its name
*
- * @param int $uid
+ * @param int $uid
* @param string $name
- * @param int $cid
+ * @param int $cid
* @return boolean
+ * @throws \Exception
+ * @deprecated Use Group::removeMember instead
+ *
*/
public static function removeMemberByName($uid, $name, $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 array $group_ids
+ * @param int $uid
+ * @param array $group_ids
* @param boolean $check_dead
- * @param boolean $use_gcontact
* @return array
+ * @throws \Exception
*/
- public static function expand($group_ids, $check_dead = false, $use_gcontact = false)
+ public static function expand($uid, array $group_ids, $check_dead = false)
{
if (!is_array($group_ids) || !count($group_ids)) {
return [];
}
- $condition = '`gid` IN (' . substr(str_repeat("?, ", count($group_ids)), 0, -2) . ')';
- if ($use_gcontact) {
- $sql = 'SELECT `gcontact`.`id` AS `contact-id` FROM `group_member`
- INNER JOIN `contact` ON `contact`.`id` = `group_member`.`contact-id`
- INNER JOIN `gcontact` ON `gcontact`.`nurl` = `contact`.`nurl`
- WHERE ' . $condition;
- $param_arr = array_merge([$sql], $group_ids);
- $stmt = call_user_func_array('dba::p', $param_arr);
- } else {
- $condition_array = array_merge([$condition], $group_ids);
- $stmt = dba::select('group_member', ['contact-id'], $condition_array);
+ $return = [];
+ $pubmail = false;
+ $networks = Protocol::SUPPORT_PRIVATE;
+
+ $mailacct = DBA::selectFirst('mailacct', ['pubmail'], ['`uid` = ? AND `server` != ""', $uid]);
+ if (DBA::isResult($mailacct)) {
+ $pubmail = $mailacct['pubmail'];
}
- $return = [];
- while($group_member = dba::fetch($stmt)) {
+ if (!$pubmail) {
+ $networks = array_diff($networks, [Protocol::MAIL]);
+ }
+
+ $key = array_search(self::FOLLOWERS, $group_ids);
+ if ($key !== false) {
+ $followers = Contact::selectToArray(['id'], [
+ 'uid' => $uid,
+ 'rel' => [Contact::FOLLOWER, Contact::FRIEND],
+ 'network' => $networks,
+ 'contact-type' => [Contact::TYPE_UNKNOWN, Contact::TYPE_PERSON],
+ 'archive' => false,
+ 'pending' => false,
+ 'blocked' => false,
+ ]);
+
+ foreach ($followers as $follower) {
+ $return[] = $follower['id'];
+ }
+
+ unset($group_ids[$key]);
+ }
+
+ $key = array_search(self::MUTUALS, $group_ids);
+ if ($key !== false) {
+ $mutuals = Contact::selectToArray(['id'], [
+ 'uid' => $uid,
+ 'rel' => [Contact::FRIEND],
+ 'network' => $networks,
+ 'contact-type' => [Contact::TYPE_UNKNOWN, Contact::TYPE_PERSON],
+ 'archive' => false,
+ 'pending' => false,
+ 'blocked' => false,
+ ]);
+
+ foreach ($mutuals as $mutual) {
+ $return[] = $mutual['id'];
+ }
+
+ unset($group_ids[$key]);
+ }
+
+ $stmt = DBA::select('group_member', ['contact-id'], ['gid' => $group_ids]);
+ while ($group_member = DBA::fetch($stmt)) {
$return[] = $group_member['contact-id'];
}
+ DBA::close($stmt);
- if ($check_dead && !$use_gcontact) {
- require_once 'include/acl_selectors.php';
- $return = prune_deadguys($return);
+ if ($check_dead) {
+ $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
+ * @param int $uid
+ * @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 = '')
{
- $o = '';
-
- $stmt = dba::select('group', [], ['deleted' => 0, 'uid' => $uid], ['order' => ['name' => 'ASC']]);
-
$display_groups = [
[
'name' => '',
'selected' => ''
]
];
- while ($group = dba::fetch($stmt)) {
+
+ $stmt = DBA::select('group', [], ['deleted' => 0, 'uid' => $uid], ['order' => ['name']]);
+ while ($group = DBA::fetch($stmt)) {
$display_groups[] = [
'name' => $group['name'],
'id' => $group['id'],
'selected' => $gid == $group['id'] ? 'true' : ''
];
}
- logger('groups: ' . print_r($display_groups, true));
+ DBA::close($stmt);
+
+ Logger::info('Got groups', $display_groups);
if ($label == '') {
- $label = t('Default privacy group for new contacts');
+ $label = DI::l10n()->t('Default privacy group for new contacts');
}
- $o = replace_macros(get_markup_template('group_selection.tpl'), array(
+ $o = Renderer::replaceMacros(Renderer::getMarkupTemplate('group_selection.tpl'), [
'$label' => $label,
'$groups' => $display_groups
- ));
+ ]);
return $o;
}
/**
- * @brief Create group sidebar widget
+ * Create group sidebar widget
*
* @param string $every
* @param string $each
* @param string $editmode
- * '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 int $group_id
- * @param int $cid
+ * '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
+ * @throws \Exception
*/
- public static function sidebarWidget($every = 'contacts', $each = 'group', $editmode = 'standard', $group_id = 0, $cid = 0)
+ public static function sidebarWidget($every = 'contact', $each = 'group', $editmode = 'standard', $group_id = '', $cid = 0)
{
- $o = '';
-
if (!local_user()) {
return '';
}
$display_groups = [
[
- 'text' => t('Everybody'),
+ 'text' => DI::l10n()->t('Everybody'),
'id' => 0,
- 'selected' => (($group_id == 0) ? 'group-selected' : ''),
+ 'selected' => (($group_id === 'everyone') ? 'group-selected' : ''),
'href' => $every,
]
];
- $stmt = dba::select('group', [], ['deleted' => 0, 'uid' => local_user()], ['order' => ['name' => 'ASC']]);
-
- $member_of = array();
+ $member_of = [];
if ($cid) {
- $member_of = self::getByContactIdForUserId(local_user(), $cid);
+ $member_of = self::getIdsByContactId($cid);
}
- while ($group = dba::fetch($stmt)) {
+ $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' => t('edit'),
+ 'title' => DI::l10n()->t('edit'),
];
} else {
$groupedit = null;
'ismember' => in_array($group['id'], $member_of),
];
}
+ DBA::close($stmt);
- $tpl = get_markup_template('group_side.tpl');
- $o = replace_macros($tpl, [
- '$add' => t('add'),
- '$title' => t('Groups'),
+ // Don't show the groups on the network page when there is only one
+ if ((count($display_groups) <= 2) && ($each == 'network')) {
+ return '';
+ }
+
+ $tpl = Renderer::getMarkupTemplate('group_side.tpl');
+ $o = Renderer::replaceMacros($tpl, [
+ '$add' => DI::l10n()->t('add'),
+ '$title' => DI::l10n()->t('Groups'),
'$groups' => $display_groups,
'newgroup' => $editmode == 'extended' || $editmode == 'full' ? 1 : '',
'grouppage' => 'group/',
- '$edittext' => t('Edit group'),
- '$ungrouped' => $every === 'contacts' ? t('Contacts not in any group') : '',
- '$createtext' => t('Create a new group'),
- '$creategroup' => t('Group Name: '),
- '$editgroupstext' => t('Edit groups'),
- '$form_security_token' => get_form_security_token('group_edit'),
+ '$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' => 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;
}
}