friendica/src/Model/Contact/User.php

360 lines
10 KiB
PHP
Raw Normal View History

2020-08-04 04:47:02 +00:00
<?php
/**
2022-01-02 07:27:47 +00:00
* @copyright Copyright (C) 2010-2022, the Friendica project
2020-08-04 04:47:02 +00:00
*
* @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\Contact;
2021-09-10 20:22:24 +00:00
use Exception;
use Friendica\Core\Logger;
2021-10-02 20:00:06 +00:00
use Friendica\Core\Protocol;
use Friendica\Core\System;
use Friendica\Database\Database;
2020-08-04 04:47:02 +00:00
use Friendica\Database\DBA;
2021-09-10 20:22:24 +00:00
use Friendica\Database\DBStructure;
2020-08-04 04:47:02 +00:00
use Friendica\Model\Contact;
use Friendica\Model\ItemURI;
2021-09-10 20:22:24 +00:00
use PDOException;
2020-08-04 04:47:02 +00:00
/**
* This class provides information about user related contacts based on the "user-contact" table.
*/
class User
{
/**
* Insert a user-contact for a given contact array
*
* @param array $contact
* @return void
*/
public static function insertForContactArray(array $contact)
{
if (empty($contact['uid'])) {
// We don't create entries for the public user - by now
return false;
}
if (empty($contact['uri-id']) && empty($contact['url'])) {
Logger::info('Missing contact details', ['contact' => $contact, 'callstack' => System::callstack(20)]);
return false;
}
if (empty($contact['uri-id'])) {
$contact['uri-id'] = ItemURI::getIdByURI($contact['url']);
}
$pcontact = Contact::selectFirst(['id'], ['uri-id' => $contact['uri-id'], 'uid' => 0]);
if (!empty($contact['uri-id']) && DBA::isResult($pcontact)) {
$pcid = $pcontact['id'];
2021-09-11 13:00:12 +00:00
} elseif (empty($contact['url']) || !($pcid = Contact::getIdForURL($contact['url'], 0, false))) {
Logger::info('Public contact for user not found', ['uri-id' => $contact['uri-id'], 'uid' => $contact['uid']]);
return false;
}
2021-09-13 14:20:20 +00:00
$fields = self::preparedFields($contact);
$fields['cid'] = $pcid;
2021-09-10 20:53:10 +00:00
$fields['uid'] = $contact['uid'];
$fields['uri-id'] = $contact['uri-id'];
$ret = DBA::insert('user-contact', $fields, Database::INSERT_UPDATE);
Logger::info('Inserted user contact', ['uid' => $contact['uid'], 'cid' => $pcid, 'uri-id' => $contact['uri-id'], 'ret' => $ret]);
return $ret;
}
2021-09-10 20:22:24 +00:00
/**
* Apply changes from contact update data to user-contact table
*
2022-06-23 14:03:55 +00:00
* @param array $fields
* @param array $condition
* @return void
* @throws PDOException
* @throws Exception
2021-09-10 20:22:24 +00:00
*/
2021-09-10 23:59:33 +00:00
public static function updateByContactUpdate(array $fields, array $condition)
2021-09-10 20:22:24 +00:00
{
DBA::transaction();
2021-09-13 14:20:20 +00:00
$update_fields = self::preparedFields($fields);
2021-09-10 20:22:24 +00:00
if (!empty($update_fields)) {
$contacts = DBA::select('contact', ['uri-id', 'uid'], $condition);
while ($contact = DBA::fetch($contacts)) {
if (empty($contact['uri-id']) || empty($contact['uid'])) {
2021-09-10 20:22:24 +00:00
continue;
}
$ret = DBA::update('user-contact', $update_fields, ['uri-id' => $contact['uri-id'], 'uid' => $contact['uid']]);
Logger::info('Updated user contact', ['uid' => $contact['uid'], 'uri-id' => $contact['uri-id'], 'ret' => $ret]);
2021-09-10 20:22:24 +00:00
}
DBA::close($contacts);
}
2022-06-23 14:03:55 +00:00
DBA::commit();
2021-09-10 20:22:24 +00:00
}
2021-09-13 14:20:20 +00:00
/**
* Prepare field data for update/insert
*
* @param array $fields
* @return array prepared fields
*/
private static function preparedFields(array $fields): array
{
unset($fields['uid']);
unset($fields['cid']);
unset($fields['uri-id']);
if (isset($fields['readonly'])) {
$fields['ignored'] = $fields['readonly'];
}
if (!empty($fields['self'])) {
$fields['rel'] = Contact::SELF;
}
return DBStructure::getFieldsForTable('user-contact', $fields);
}
2020-08-04 04:47:02 +00:00
/**
* Block contact id for user id
*
* @param int $cid Either public contact id or user's contact id
* @param int $uid User ID
* @param boolean $blocked Is the contact blocked or unblocked?
* @return void
2020-08-04 04:47:02 +00:00
* @throws \Exception
*/
public static function setBlocked(int $cid, int $uid, bool $blocked)
2020-08-04 04:47:02 +00:00
{
$cdata = Contact::getPublicAndUserContactID($cid, $uid);
2020-08-04 04:47:02 +00:00
if (empty($cdata)) {
return;
}
2021-10-02 20:00:06 +00:00
$contact = Contact::getById($cdata['public']);
if ($blocked) {
Protocol::block($contact, $uid);
2021-10-02 20:00:06 +00:00
} else {
Protocol::unblock($contact, $uid);
2021-10-02 20:00:06 +00:00
}
2020-08-04 04:47:02 +00:00
if ($cdata['user'] != 0) {
DBA::update('contact', ['blocked' => $blocked], ['id' => $cdata['user'], 'pending' => false]);
}
DBA::update('user-contact', ['blocked' => $blocked], ['cid' => $cdata['public'], 'uid' => $uid], true);
}
/**
* Returns "block" state for contact id and user id
*
* @param int $cid Either public contact id or user's contact id
* @param int $uid User ID
*
* @return boolean is the contact id blocked for the given user?
* @throws \Exception
*/
public static function isBlocked(int $cid, int $uid): bool
2020-08-04 04:47:02 +00:00
{
$cdata = Contact::getPublicAndUserContactID($cid, $uid);
2020-08-04 04:47:02 +00:00
if (empty($cdata)) {
return false;
2020-08-04 04:47:02 +00:00
}
$public_blocked = false;
if (!empty($cdata['public'])) {
$public_contact = DBA::selectFirst('user-contact', ['blocked'], ['cid' => $cdata['public'], 'uid' => $uid]);
if (DBA::isResult($public_contact)) {
$public_blocked = $public_contact['blocked'];
}
}
$user_blocked = $public_blocked;
if (!empty($cdata['user'])) {
$user_contact = DBA::selectFirst('contact', ['blocked'], ['id' => $cdata['user'], 'pending' => false]);
if (DBA::isResult($user_contact)) {
$user_blocked = $user_contact['blocked'];
}
}
if ($user_blocked != $public_blocked) {
DBA::update('user-contact', ['blocked' => $user_blocked], ['cid' => $cdata['public'], 'uid' => $uid], true);
}
return $user_blocked;
}
/**
* Ignore contact id for user id
*
* @param int $cid Either public contact id or user's contact id
* @param int $uid User ID
* @param boolean $ignored Is the contact ignored or unignored?
* @return void
2020-08-04 04:47:02 +00:00
* @throws \Exception
*/
public static function setIgnored(int $cid, int $uid, bool $ignored)
2020-08-04 04:47:02 +00:00
{
$cdata = Contact::getPublicAndUserContactID($cid, $uid);
2020-08-04 04:47:02 +00:00
if (empty($cdata)) {
return;
}
if ($cdata['user'] != 0) {
DBA::update('contact', ['readonly' => $ignored], ['id' => $cdata['user'], 'pending' => false]);
}
DBA::update('user-contact', ['ignored' => $ignored], ['cid' => $cdata['public'], 'uid' => $uid], true);
}
/**
* Returns "ignore" state for contact id and user id
*
* @param int $cid Either public contact id or user's contact id
* @param int $uid User ID
* @return boolean is the contact id ignored for the given user?
* @throws \Exception
*/
public static function isIgnored(int $cid, int $uid): bool
2020-08-04 04:47:02 +00:00
{
$cdata = Contact::getPublicAndUserContactID($cid, $uid);
2020-08-04 04:47:02 +00:00
if (empty($cdata)) {
return false;
2020-08-04 04:47:02 +00:00
}
$public_ignored = false;
if (!empty($cdata['public'])) {
$public_contact = DBA::selectFirst('user-contact', ['ignored'], ['cid' => $cdata['public'], 'uid' => $uid]);
if (DBA::isResult($public_contact)) {
$public_ignored = $public_contact['ignored'];
}
}
$user_ignored = $public_ignored;
if (!empty($cdata['user'])) {
$user_contact = DBA::selectFirst('contact', ['readonly'], ['id' => $cdata['user'], 'pending' => false]);
if (DBA::isResult($user_contact)) {
$user_ignored = $user_contact['readonly'];
}
}
if ($user_ignored != $public_ignored) {
DBA::update('user-contact', ['ignored' => $user_ignored], ['cid' => $cdata['public'], 'uid' => $uid], true);
}
return $user_ignored;
}
/**
* Set "collapsed" for contact id and user id
*
* @param int $cid Either public contact id or user's contact id
* @param int $uid User ID
* @param boolean $collapsed are the contact's posts collapsed or uncollapsed?
* @return void
2020-08-04 04:47:02 +00:00
* @throws \Exception
*/
public static function setCollapsed(int $cid, int $uid, bool $collapsed)
2020-08-04 04:47:02 +00:00
{
$cdata = Contact::getPublicAndUserContactID($cid, $uid);
2020-08-04 04:47:02 +00:00
if (empty($cdata)) {
return;
}
DBA::update('user-contact', ['collapsed' => $collapsed], ['cid' => $cdata['public'], 'uid' => $uid], true);
}
/**
* Returns "collapsed" state for contact id and user id
*
* @param int $cid Either public contact id or user's contact id
* @param int $uid User ID
* @return boolean is the contact id blocked for the given user?
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function isCollapsed(int $cid, int $uid): bool
2020-08-04 04:47:02 +00:00
{
$cdata = Contact::getPublicAndUserContactID($cid, $uid);
2020-08-04 04:47:02 +00:00
if (empty($cdata)) {
return false;
2020-08-04 04:47:02 +00:00
}
$collapsed = false;
if (!empty($cdata['public'])) {
$public_contact = DBA::selectFirst('user-contact', ['collapsed'], ['cid' => $cdata['public'], 'uid' => $uid]);
if (DBA::isResult($public_contact)) {
$collapsed = $public_contact['collapsed'];
}
}
return $collapsed;
}
/**
* Set/Release that the user is blocked by the contact
*
* @param int $cid Either public contact id or user's contact id
* @param int $uid User ID
* @param boolean $blocked Is the user blocked or unblocked by the contact?
* @return void
* @throws \Exception
*/
public static function setIsBlocked(int $cid, int $uid, bool $blocked)
{
$cdata = Contact::getPublicAndUserContactID($cid, $uid);
if (empty($cdata)) {
return;
}
DBA::update('user-contact', ['is-blocked' => $blocked], ['cid' => $cdata['public'], 'uid' => $uid], true);
}
/**
* Returns if the user is blocked by the contact
*
* @param int $cid Either public contact id or user's contact id
* @param int $uid User ID
* @return boolean Is the user blocked or unblocked by the contact?
* @throws \Exception
*/
public static function isIsBlocked(int $cid, int $uid): bool
{
$cdata = Contact::getPublicAndUserContactID($cid, $uid);
if (empty($cdata)) {
return false;
}
if (!empty($cdata['public'])) {
$public_contact = DBA::selectFirst('user-contact', ['is-blocked'], ['cid' => $cdata['public'], 'uid' => $uid]);
if (DBA::isResult($public_contact)) {
return $public_contact['is-blocked'];
}
}
return false;
}
2020-08-04 04:47:02 +00:00
}