Add common relationship methods to Model\ContactRelation

- Introduce DBA::mergeConditions method
- Replace GContact relationship method contents with Model\ContactRelation method calls
This commit is contained in:
Hypolite Petovan 2020-07-29 11:30:54 -04:00
parent a6a23802b7
commit 24a82110fd
5 changed files with 425 additions and 117 deletions

View file

@ -109,26 +109,22 @@ abstract class BaseRepository extends BaseFactory
*/ */
public function selectByBoundaries(array $condition = [], array $params = [], int $max_id = null, int $since_id = null, int $limit = self::LIMIT) public function selectByBoundaries(array $condition = [], array $params = [], int $max_id = null, int $since_id = null, int $limit = self::LIMIT)
{ {
$condition = DBA::collapseCondition($condition); $totalCount = DBA::count(static::$table_name, $condition);
$boundCondition = $condition; $boundCondition = $condition;
if (isset($max_id)) { if (isset($max_id)) {
$boundCondition[0] .= " AND `id` < ?"; $boundCondition = DBA::mergeConditions($boundCondition, ['`id` < ?', $max_id]);
$boundCondition[] = $max_id;
} }
if (isset($since_id)) { if (isset($since_id)) {
$boundCondition[0] .= " AND `id` > ?"; $boundCondition = DBA::mergeConditions($boundCondition, ['`id` > ?', $since_id]);
$boundCondition[] = $since_id;
} }
$params['limit'] = $limit; $params['limit'] = $limit;
$models = $this->selectModels($boundCondition, $params); $models = $this->selectModels($boundCondition, $params);
$totalCount = DBA::count(static::$table_name, $condition);
return new static::$collection_class($models, $totalCount); return new static::$collection_class($models, $totalCount);
} }

View file

@ -539,7 +539,7 @@ class DBA
* Returns the SQL condition string built from the provided condition array * Returns the SQL condition string built from the provided condition array
* *
* This function operates with two modes. * This function operates with two modes.
* - Supplied with a filed/value associative array, it builds simple strict * - Supplied with a field/value associative array, it builds simple strict
* equality conditions linked by AND. * equality conditions linked by AND.
* - Supplied with a flat list, the first element is the condition string and * - Supplied with a flat list, the first element is the condition string and
* the following arguments are the values to be interpolated * the following arguments are the values to be interpolated
@ -645,6 +645,34 @@ class DBA
return $condition; return $condition;
} }
/**
* Merges the provided conditions into a single collapsed one
*
* @param array ...$conditions One or more condition arrays
* @return array A collapsed condition
* @see DBA::collapseCondition() for the condition array formats
*/
public static function mergeConditions(array ...$conditions)
{
$conditionStrings = [];
$result = [];
foreach ($conditions as $key => $condition) {
$condition = self::collapseCondition($condition);
$conditionStrings[] = array_shift($condition);
// The result array holds the eventual parameter values
$result = array_merge($result, $condition);
}
if (count($conditionStrings)) {
// We prepend the condition string at the end to form a collapsed condition array again
array_unshift($result, implode(' AND ', $conditionStrings));
}
return $result;
}
/** /**
* Returns the SQL parameter string built from the provided parameter array * Returns the SQL parameter string built from the provided parameter array
* *

View file

@ -21,6 +21,7 @@
namespace Friendica\Model; namespace Friendica\Model;
use Exception;
use Friendica\Core\Logger; use Friendica\Core\Logger;
use Friendica\Core\Protocol; use Friendica\Core\Protocol;
use Friendica\Database\DBA; use Friendica\Database\DBA;
@ -29,6 +30,11 @@ use Friendica\Protocol\ActivityPub;
use Friendica\Util\DateTimeFormat; use Friendica\Util\DateTimeFormat;
use Friendica\Util\Strings; use Friendica\Util\Strings;
/**
* This class provides relationship information based on the `contact-relation` table.
* This table is directional (cid = source, relation-cid = target), references public contacts (with uid=0) and records both
* follows and the last interaction (likes/comments) on public posts.
*/
class ContactRelation class ContactRelation
{ {
/** /**
@ -200,4 +206,333 @@ class ContactRelation
return true; return true;
} }
/**
* Counts all the known follows of the provided public contact
*
* @param int $cid Public contact id
* @param array $condition Additional condition on the contact table
* @return int
* @throws Exception
*/
public static function countFollows(int $cid, array $condition = [])
{
$condition = DBA::mergeConditions($condition,
['`id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
AND `follows`
)', $cid]
);
return DI::dba()->count('contact', $condition);
}
/**
* Returns a paginated list of contacts that are followed the provided public contact.
*
* @param int $cid Public contact id
* @param array $condition Additional condition on the contact table
* @param int $count
* @param int $offset
* @param bool $shuffle
* @return array
* @throws Exception
*/
public static function listFollows(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
{
$condition = DBA::mergeConditions($condition,
['`id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
AND `follows`
)', $cid]
);
$follows = DI::dba()->selectToArray(
'contact',
$condition,
[
'limit' => [$offset, $count],
'order' => [$shuffle ? 'RAND()' : 'name']
]
);
return $follows;
}
/**
* Counts all the known followers of the provided public contact
*
* @param int $cid Public contact id
* @param array $condition Additional condition on the contact table
* @return int
* @throws Exception
*/
public static function countFollowers(int $cid, array $condition = [])
{
$condition = DBA::mergeConditions($condition,
['`id` IN (
SELECT `cid`
FROM `contact-relation`
WHERE `relation-cid` = ?
AND `follows`
)', $cid]
);
return DI::dba()->count('contact', $condition);
}
/**
* Returns a paginated list of contacts that follow the provided public contact.
*
* @param int $cid Public contact id
* @param array $condition Additional condition on the contact table
* @param int $count
* @param int $offset
* @param bool $shuffle
* @return array
* @throws Exception
*/
public static function listFollowers(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
{
$condition = DBA::mergeConditions($condition,
['`id` IN (
SELECT `cid`
FROM `contact-relation`
WHERE `relation-cid` = ?
AND `follows`
)', $cid]
);
$followers = DI::dba()->selectToArray(
'contact',
$condition,
[
'limit' => [$offset, $count],
'order' => [$shuffle ? 'RAND()' : 'name']
]
);
return $followers;
}
/**
* Counts the number of contacts that both provided public contacts have interacted with at least once.
* Interactions include follows and likes and comments on public posts.
*
* @param int $sourceId Public contact id
* @param int $targetId Public contact id
* @param array $condition Additional condition array on the contact table
* @return int
* @throws Exception
*/
public static function countCommon(int $sourceId, int $targetId, array $condition = [])
{
$condition = DBA::mergeConditions($condition,
['`id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
)
AND `id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
)', $sourceId, $targetId]
);
$total = DI::dba()->count('contact', $condition);
return $total;
}
/**
* Returns a paginated list of contacts that both provided public contacts have interacted with at least once.
* Interactions include follows and likes and comments on public posts.
*
* @param int $sourceId Public contact id
* @param int $targetId Public contact id
* @param array $condition Additional condition on the contact table
* @param int $count
* @param int $offset
* @param bool $shuffle
* @return array
* @throws Exception
*/
public static function listCommon(int $sourceId, int $targetId, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
{
$condition = DBA::mergeConditions($condition,
["`id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
AND `follows`
)
AND `id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
AND `follows`
)", $sourceId, $targetId]
);
$contacts = DI::dba()->selectToArray(
'contact',
$condition,
[
'limit' => [$offset, $count],
'order' => [$shuffle ? 'name' : 'RAND()'],
]
);
return $contacts;
}
/**
* Counts the number of contacts that are followed by both provided public contacts.
*
* @param int $sourceId Public contact id
* @param int $targetId Public contact id
* @param array $condition Additional condition array on the contact table
* @return int
* @throws Exception
*/
public static function countCommonFollows(int $sourceId, int $targetId, array $condition = [])
{
$condition = DBA::mergeConditions($condition,
['`id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
AND `follows`
)
AND `id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
AND `follows`
)', $sourceId, $targetId]
);
$total = DI::dba()->count('contact', $condition);
return $total;
}
/**
* Returns a paginated list of contacts that are followed by both provided public contacts.
*
* @param int $sourceId Public contact id
* @param int $targetId Public contact id
* @param array $condition Additional condition array on the contact table
* @param int $count
* @param int $offset
* @param bool $shuffle
* @return array
* @throws Exception
*/
public static function listCommonFollows(int $sourceId, int $targetId, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
{
$condition = DBA::mergeConditions($condition,
["`id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
AND `follows`
)
AND `id` IN (
SELECT `relation-cid`
FROM `contact-relation`
WHERE `cid` = ?
AND `follows`
)", $sourceId, $targetId]
);
$contacts = DI::dba()->selectToArray(
'contact',
$condition,
[
'limit' => [$offset, $count],
'order' => [$shuffle ? 'name' : 'RAND()'],
]
);
return $contacts;
}
/**
* Counts the number of contacts that follow both provided public contacts.
*
* @param int $sourceId Public contact id
* @param int $targetId Public contact id
* @param array $condition Additional condition on the contact table
* @return int
* @throws Exception
*/
public static function countCommonFollowers(int $sourceId, int $targetId, array $condition = [])
{
$condition = DBA::mergeConditions($condition,
['`id` IN (
SELECT `cid`
FROM `contact-relation`
WHERE `relation-cid` = ?
AND `follows`
)
AND `id` IN (
SELECT `cid`
FROM `contact-relation`
WHERE `relation-cid` = ?
AND `follows`
)', $sourceId, $targetId]
);
$total = DI::dba()->count('contact', $condition);
return $total;
}
/**
* Returns a paginated list of contacts that follow both provided public contacts.
*
* @param int $sourceId Public contact id
* @param int $targetId Public contact id
* @param array $condition Additional condition on the contact table
* @param int $count
* @param int $offset
* @param bool $shuffle
* @return array
* @throws Exception
*/
public static function listCommonFollowers(int $sourceId, int $targetId, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
{
$condition = DBA::mergeConditions($condition,
["`id` IN (
SELECT `cid`
FROM `contact-relation`
WHERE `relation-cid` = ?
AND `follows`
)
AND `id` IN (
SELECT `cid`
FROM `contact-relation`
WHERE `relation-cid` = ?
AND `follows`
)", $sourceId, $targetId]
);
$contacts = DI::dba()->selectToArray(
'contact',
$condition,
[
'limit' => [$offset, $count],
'order' => [$shuffle ? 'name' : 'RAND()'],
]
);
return $contacts;
}
} }

View file

@ -39,22 +39,16 @@ class GContact
*/ */
public static function countCommonFriends($uid, $cid) public static function countCommonFriends($uid, $cid)
{ {
$r = q( $sourceId = Contact::getPublicIdByUserId($uid);
"SELECT count(*) as `total`
FROM `glink` INNER JOIN `gcontact` on `glink`.`gcid` = `gcontact`.`id`
WHERE `glink`.`cid` = %d AND `glink`.`uid` = %d AND
NOT `gcontact`.`failed`
AND `gcontact`.`nurl` IN (select nurl from contact where uid = %d and self = 0 and blocked = 0 and hidden = 0 and id != %d) ",
intval($cid),
intval($uid),
intval($uid),
intval($cid)
);
if (DBA::isResult($r)) { $targetIds = Contact::getPublicAndUserContacID($cid, $uid);
return $r[0]['total'];
} $condition = [
return 0; 'NOT `self` AND NOT `blocked` AND NOT `hidden` AND `id` != ?',
$sourceId,
];
return ContactRelation::countCommonFollows($sourceId, $targetIds['public'] ?? 0, $condition);
} }
/** /**
@ -65,92 +59,74 @@ class GContact
*/ */
public static function countCommonFriendsZcid($uid, $zcid) public static function countCommonFriendsZcid($uid, $zcid)
{ {
$r = q( $sourceId = Contact::getPublicIdByUserId($uid);
"SELECT count(*) as `total`
FROM `glink` INNER JOIN `gcontact` on `glink`.`gcid` = `gcontact`.`id` $targetPublicContact = DI::dba()->fetchFirst("
where `glink`.`zcid` = %d SELECT `id`
and `gcontact`.`nurl` in (select nurl from contact where uid = %d and self = 0 and blocked = 0 and hidden = 0) ", FROM `contact` c
intval($zcid), JOIN `gcontact` z ON z.`nurl` = c.`nurl`
intval($uid) AND z.`id` = ?
AND c.`uid` = 0
LIMIT 1",
$zcid
); );
if (DBA::isResult($r)) { return ContactRelation::countCommonFollowers($sourceId, $targetPublicContact['id'] ?? 0);
return $r[0]['total'];
}
return 0;
} }
/** /**
* @param integer $uid user * Returns the cross-section between the local user contacts and one of their contact's own relationships
* @param integer $cid cid * as known by the local node.
*
* @param integer $uid local user id
* @param integer $cid user contact id to compare friends with
* @param integer $start optional, default 0 * @param integer $start optional, default 0
* @param integer $limit optional, default 9999 * @param integer $limit optional, default 9999
* @param boolean $shuffle optional, default false * @param boolean $shuffle optional, default false
* @return object * @return array
* @throws Exception * @throws Exception
*/ */
public static function commonFriends($uid, $cid, $start = 0, $limit = 9999, $shuffle = false) public static function commonFriends($uid, $cid, $start = 0, $limit = 9999, $shuffle = false)
{ {
if ($shuffle) { $sourceId = Contact::getPublicIdByUserId($uid);
$sql_extra = " order by rand() ";
} else {
$sql_extra = " order by `gcontact`.`name` asc ";
}
$r = q( $targetIds = Contact::getPublicAndUserContacID($cid, $uid);
"SELECT `gcontact`.*, `contact`.`id` AS `cid`
FROM `glink`
INNER JOIN `gcontact` ON `glink`.`gcid` = `gcontact`.`id`
INNER JOIN `contact` ON `gcontact`.`nurl` = `contact`.`nurl`
WHERE `glink`.`cid` = %d and `glink`.`uid` = %d
AND `contact`.`uid` = %d AND `contact`.`self` = 0 AND `contact`.`blocked` = 0
AND `contact`.`hidden` = 0 AND `contact`.`id` != %d
AND NOT `gcontact`.`failed`
$sql_extra LIMIT %d, %d",
intval($cid),
intval($uid),
intval($uid),
intval($cid),
intval($start),
intval($limit)
);
/// @TODO Check all calling-findings of this function if they properly use DBA::isResult() $condition = [
return $r; 'NOT `self` AND NOT `blocked` AND NOT `hidden` AND `id` != ?',
$sourceId,
];
return ContactRelation::listCommonFollows($sourceId, $targetIds['public'] ?? 0, $condition, $limit, $start, $shuffle);
} }
/** /**
* @param integer $uid user * Returns the cross-section between a local user and a remote visitor contact's own relationships
* @param integer $zcid zcid * as known by the local node.
*
* @param integer $uid local user id
* @param integer $zcid remote visitor contact zcid
* @param integer $start optional, default 0 * @param integer $start optional, default 0
* @param integer $limit optional, default 9999 * @param integer $limit optional, default 9999
* @param boolean $shuffle optional, default false * @param boolean $shuffle optional, default false
* @return object * @return array
* @throws Exception * @throws Exception
*/ */
public static function commonFriendsZcid($uid, $zcid, $start = 0, $limit = 9999, $shuffle = false) public static function commonFriendsZcid($uid, $zcid, $start = 0, $limit = 9999, $shuffle = false)
{ {
if ($shuffle) { $sourceId = Contact::getPublicIdByUserId($uid);
$sql_extra = " order by rand() ";
} else {
$sql_extra = " order by `gcontact`.`name` asc ";
}
$r = q( $targetPublicContact = DI::dba()->fetchFirst("
"SELECT `gcontact`.* SELECT c.`id`
FROM `glink` INNER JOIN `gcontact` on `glink`.`gcid` = `gcontact`.`id` FROM `contact` c
where `glink`.`zcid` = %d JOIN `gcontact` z ON z.`nurl` = c.`nurl`
and `gcontact`.`nurl` in (select nurl from contact where uid = %d and self = 0 and blocked = 0 and hidden = 0) AND z.`id` = ?
$sql_extra limit %d, %d", AND c.`uid` = 0
intval($zcid), LIMIT 1",
intval($uid), $zcid
intval($start),
intval($limit)
); );
/// @TODO Check all calling-findings of this function if they properly use DBA::isResult() return ContactRelation::listCommonFollows($sourceId, $targetPublicContact['id'] ?? 0, [], $limit, $start, $shuffle);
return $r;
} }
/** /**
@ -161,20 +137,9 @@ class GContact
*/ */
public static function countAllFriends($uid, $cid) public static function countAllFriends($uid, $cid)
{ {
$r = q( $cids = Contact::getPublicAndUserContacID($cid, $uid);
"SELECT count(*) as `total`
FROM `glink` INNER JOIN `gcontact` on `glink`.`gcid` = `gcontact`.`id`
where `glink`.`cid` = %d and `glink`.`uid` = %d AND
NOT `gcontact`.`failed`",
intval($cid),
intval($uid)
);
if (DBA::isResult($r)) { return ContactRelation::countFollows($cids['public'] ?? 0);
return $r[0]['total'];
}
return 0;
} }
/** /**
@ -187,22 +152,8 @@ class GContact
*/ */
public static function allFriends($uid, $cid, $start = 0, $limit = 80) public static function allFriends($uid, $cid, $start = 0, $limit = 80)
{ {
$r = q( $cids = Contact::getPublicAndUserContacID($cid, $uid);
"SELECT `gcontact`.*, `contact`.`id` AS `cid`
FROM `glink`
INNER JOIN `gcontact` on `glink`.`gcid` = `gcontact`.`id`
LEFT JOIN `contact` ON `contact`.`nurl` = `gcontact`.`nurl` AND `contact`.`uid` = %d
WHERE `glink`.`cid` = %d AND `glink`.`uid` = %d AND
NOT `gcontact`.`failed`
ORDER BY `gcontact`.`name` ASC LIMIT %d, %d ",
intval($uid),
intval($cid),
intval($uid),
intval($start),
intval($limit)
);
/// @TODO Check all calling-findings of this function if they properly use DBA::isResult() return ContactRelation::listFollows($cids['public'] ?? 0, [], $limit, $start);
return $r;
} }
} }

View file

@ -143,7 +143,7 @@ abstract class ContactEndpoint extends BaseApi
$previous_cursor = 0; $previous_cursor = 0;
$total_count = 0; $total_count = 0;
if (!$hide_friends) { if (!$hide_friends) {
$condition = DBA::collapseCondition([ $condition = [
'rel' => $rel, 'rel' => $rel,
'uid' => $uid, 'uid' => $uid,
'self' => false, 'self' => false,
@ -151,17 +151,15 @@ abstract class ContactEndpoint extends BaseApi
'hidden' => false, 'hidden' => false,
'archive' => false, 'archive' => false,
'pending' => false 'pending' => false
]); ];
$total_count = DBA::count('contact', $condition); $total_count = DBA::count('contact', $condition);
if ($cursor !== -1) { if ($cursor !== -1) {
if ($cursor > 0) { if ($cursor > 0) {
$condition[0] .= " AND `id` > ?"; $condition = DBA::mergeConditions($condition, ['`id` > ?', $cursor]);
$condition[] = $cursor;
} else { } else {
$condition[0] .= " AND `id` < ?"; $condition = DBA::mergeConditions($condition, ['`id` < ?', -$cursor]);
$condition[] = -$cursor;
} }
} }