class Contact extends BaseObject
{
/**
- * @name page/profile types
- *
- * PAGE_NORMAL is a typical personal profile account
- * PAGE_SOAPBOX automatically approves all friend requests as Contact::SHARING, (readonly)
- * PAGE_COMMUNITY automatically approves all friend requests as Contact::SHARING, but with
- * write access to wall and comments (no email and not included in page owner's ACL lists)
- * PAGE_FREELOVE automatically approves all friend requests as full friends (Contact::FRIEND).
- *
- * @{
+ * @deprecated since version 2019.03
+ * @see User::PAGE_FLAGS_NORMAL
+ */
+ const PAGE_NORMAL = User::PAGE_FLAGS_NORMAL;
+ /**
+ * @deprecated since version 2019.03
+ * @see User::PAGE_FLAGS_SOAPBOX
+ */
+ const PAGE_SOAPBOX = User::PAGE_FLAGS_SOAPBOX;
+ /**
+ * @deprecated since version 2019.03
+ * @see User::PAGE_FLAGS_COMMUNITY
+ */
+ const PAGE_COMMUNITY = User::PAGE_FLAGS_COMMUNITY;
+ /**
+ * @deprecated since version 2019.03
+ * @see User::PAGE_FLAGS_FREELOVE
+ */
+ const PAGE_FREELOVE = User::PAGE_FLAGS_FREELOVE;
+ /**
+ * @deprecated since version 2019.03
+ * @see User::PAGE_FLAGS_BLOG
+ */
+ const PAGE_BLOG = User::PAGE_FLAGS_BLOG;
+ /**
+ * @deprecated since version 2019.03
+ * @see User::PAGE_FLAGS_PRVGROUP
*/
- const PAGE_NORMAL = 0;
- const PAGE_SOAPBOX = 1;
- const PAGE_COMMUNITY = 2;
- const PAGE_FREELOVE = 3;
- const PAGE_BLOG = 4;
- const PAGE_PRVGROUP = 5;
+ const PAGE_PRVGROUP = User::PAGE_FLAGS_PRVGROUP;
/**
* @}
*/
/**
- * @name account types
+ * Account types
+ *
+ * TYPE_UNKNOWN - the account has been imported from gcontact where this is the default type value
*
- * ACCOUNT_TYPE_PERSON - the account belongs to a person
+ * TYPE_PERSON - the account belongs to a person
* Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
*
- * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
+ * TYPE_ORGANISATION - the account belongs to an organisation
* Associated page type: PAGE_SOAPBOX
*
- * ACCOUNT_TYPE_NEWS - the account is a news reflector
+ * TYPE_NEWS - the account is a news reflector
* Associated page type: PAGE_SOAPBOX
*
- * ACCOUNT_TYPE_COMMUNITY - the account is community forum
+ * TYPE_COMMUNITY - the account is community forum
* Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
*
- * ACCOUNT_TYPE_RELAY - the account is a relay
+ * TYPE_RELAY - the account is a relay
* This will only be assigned to contacts, not to user accounts
* @{
*/
- const ACCOUNT_TYPE_PERSON = 0;
- const ACCOUNT_TYPE_ORGANISATION = 1;
- const ACCOUNT_TYPE_NEWS = 2;
- const ACCOUNT_TYPE_COMMUNITY = 3;
- const ACCOUNT_TYPE_RELAY = 4;
+ const TYPE_UNKNOWN = -1;
+ const TYPE_PERSON = User::ACCOUNT_TYPE_PERSON;
+ const TYPE_ORGANISATION = User::ACCOUNT_TYPE_ORGANISATION;
+ const TYPE_NEWS = User::ACCOUNT_TYPE_NEWS;
+ const TYPE_COMMUNITY = User::ACCOUNT_TYPE_COMMUNITY;
+ const TYPE_RELAY = User::ACCOUNT_TYPE_RELAY;
/**
* @}
*/
/**
- * @name Contact_is
+ * Contact_is
*
* Relationship types
* @{
* @param int $uid User ID
*
* @return boolean is the contact id a follower?
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function isFollower($cid, $uid)
{
/**
* @brief Get the basepath for a given contact link
- * @todo Add functionality to store this value in the contact table
+ * @todo Add functionality to store this value in the contact table
*
* @param string $url The contact link
*
* @return string basepath
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function getBasepath($url)
{
* @param int $uid User ID
*
* @return array with public and user's contact id
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function getPublicAndUserContacID($cid, $uid)
{
* @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?
+ * @throws \Exception
*/
public static function setBlockedForUser($cid, $uid, $blocked)
{
* @param int $uid User ID
*
* @return boolean is the contact id blocked for the given user?
+ * @throws \Exception
*/
public static function isBlockedByUser($cid, $uid)
{
* @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?
+ * @throws \Exception
*/
public static function setIgnoredForUser($cid, $uid, $ignored)
{
* @param int $uid User ID
*
* @return boolean is the contact id ignored for the given user?
+ * @throws \Exception
*/
public static function isIgnoredByUser($cid, $uid)
{
* @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?
+ * @throws \Exception
*/
public static function setCollapsedForUser($cid, $uid, $collapsed)
{
* @param int $uid User ID
*
* @return boolean is the contact id blocked for the given user?
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function isCollapsedByUser($cid, $uid)
{
*
* @param int $gid
* @return array
+ * @throws \Exception
*/
public static function getByGroupId($gid)
{
*
* @param int $gid
* @return int
+ * @throws \Exception
*/
public static function getOStatusCountByGroupId($gid)
{
*
* @param int $uid
* @return bool Operation success
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function createSelfFromUserId($uid)
{
/**
* Updates the self-contact for the provided user id
*
- * @param int $uid
+ * @param int $uid
* @param boolean $update_avatar Force the avatar update
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function updateSelfFromUserID($uid, $update_avatar = false)
{
$fields['micro'] = System::baseUrl() . '/images/person-48.jpg';
}
- $fields['forum'] = $user['page-flags'] == self::PAGE_COMMUNITY;
- $fields['prv'] = $user['page-flags'] == self::PAGE_PRVGROUP;
+ $fields['forum'] = $user['page-flags'] == User::PAGE_FLAGS_COMMUNITY;
+ $fields['prv'] = $user['page-flags'] == User::PAGE_FLAGS_PRVGROUP;
// it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
$fields['url'] = System::baseUrl() . '/profile/' . $user['nickname'];
*
* @param int $id contact id
* @return null
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function remove($id)
{
* @param array $contact Contact unfriended
* @param boolean $dissolve Remove the contact on the remote side
* @return void
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function terminateFriendship(array $user, array $contact, $dissolve = false)
{
*
* @param array $contact contact to mark for archival
* @return null
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function markForArchival(array $contact)
{
if (!isset($contact['url']) && !empty($contact['id'])) {
$fields = ['id', 'url', 'archive', 'self', 'term-date'];
- $contact = DBA::selectFirst('contact', [], ['id' => $contact['id']]);
+ $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
if (!DBA::isResult($contact)) {
return;
}
/**
* @brief Cancels the archival countdown
*
- * @see Contact::markForArchival()
+ * @see Contact::markForArchival()
*
* @param array $contact contact to be unmarked for archival
* @return null
+ * @throws \Exception
*/
public static function unmarkForArchival(array $contact)
{
if (!isset($contact['url']) && !empty($contact['id'])) {
$fields = ['id', 'url', 'batch'];
- $contact = DBA::selectFirst('contact', [], ['id' => $contact['id']]);
+ $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
if (!DBA::isResult($contact)) {
return;
}
DBA::update('contact', $fields, ['nurl' => Strings::normaliseLink($contact['url'])]);
if (!empty($contact['batch'])) {
- $condition = ['batch' => $contact['batch'], 'contact-type' => self::ACCOUNT_TYPE_RELAY];
+ $condition = ['batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
DBA::update('contact', $fields, $condition);
}
}
* @param array $default If not data was found take this data as default value
*
* @return array Contact data
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function getDetailsByURL($url, $uid = -1, array $default = [])
{
* @param int $uid User id
*
* @return array Contact data
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function getDetailsByAddr($addr, $uid = -1)
{
- static $cache = [];
-
if ($addr == '') {
return [];
}
* @param array $contact contact
* @param int $uid optional, default 0
* @return array
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function photoMenu(array $contact, $uid = 0)
{
- // @todo Unused, to be removed
- $a = \get_app();
-
- $contact_url = '';
$pm_url = '';
$status_link = '';
$photos_link = '';
- $posts_link = '';
$contact_drop_link = '';
$poke_link = '';
* Returns either the total number of ungrouped contacts for the given user
* id or a paginated list of ungrouped contacts.
*
- * @param int $uid uid
- * @param int $start optional, default 0
- * @param int $count optional, default 0
- *
+ * @param int $uid uid
* @return array
+ * @throws \Exception
*/
public static function getUngroupedList($uid)
{
* @param boolean $in_loop Internally used variable to prevent an endless loop
*
* @return integer Contact ID
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function getIdForURL($url, $uid = 0, $no_update = false, $default = [], $in_loop = false)
{
$contact = DBA::selectFirst('contact', $fields, ['addr' => $url]);
}
+ // The link could be provided as http although we stored it as https
+ $ssl_url = str_replace('http://', 'https://', $url);
+
if (!DBA::isResult($contact)) {
- // The link could be provided as http although we stored it as https
- $ssl_url = str_replace('http://', 'https://', $url);
$condition = ['alias' => [$url, Strings::normaliseLink($url), $ssl_url]];
$contact = DBA::selectFirst('contact', $fields, $condition);
}
$contact_id = self::getIdForURL($data["alias"], $uid, true, $default, true);
}
- $url = $data["url"];
if (!$contact_id) {
$fields = [
'uid' => $uid,
* @param int $cid contact id
*
* @return boolean Is the contact blocked?
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function isBlocked($cid)
{
* @param int $cid contact id
*
* @return boolean Is the contact hidden?
+ * @throws \Exception
*/
public static function isHidden($cid)
{
*
* @param string $contact_url Contact URL
*
+ * @param bool $thread_mode
+ * @param int $update
* @return string posts in HTML
+ * @throws \Exception
*/
public static function getPostsFromUrl($contact_url, $thread_mode = false, $update = 0)
{
$a = self::getApp();
- $cid = Self::getIdForURL($contact_url);
+ $cid = self::getIdForURL($contact_url);
$contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
if (!DBA::isResult($contact)) {
$sql = "`item`.`uid` = ?";
}
- $contact_field = ($contact["contact-type"] == self::ACCOUNT_TYPE_COMMUNITY ? 'owner-id' : 'author-id');
+ $contact_field = ($contact["contact-type"] == self::TYPE_COMMUNITY ? 'owner-id' : 'author-id');
if ($thread_mode) {
$condition = ["`$contact_field` = ? AND `gravity` = ? AND " . $sql,
{
// There are several fields that indicate that the contact or user is a forum
// "page-flags" is a field in the user table,
- // "forum" and "prv" are used in the contact table. They stand for self::PAGE_COMMUNITY and self::PAGE_PRVGROUP.
- // "community" is used in the gcontact table and is true if the contact is self::PAGE_COMMUNITY or self::PAGE_PRVGROUP.
- if ((isset($contact['page-flags']) && (intval($contact['page-flags']) == self::PAGE_COMMUNITY))
- || (isset($contact['page-flags']) && (intval($contact['page-flags']) == self::PAGE_PRVGROUP))
+ // "forum" and "prv" are used in the contact table. They stand for User::PAGE_FLAGS_COMMUNITY and User::PAGE_FLAGS_PRVGROUP.
+ // "community" is used in the gcontact table and is true if the contact is User::PAGE_FLAGS_COMMUNITY or User::PAGE_FLAGS_PRVGROUP.
+ if ((isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_COMMUNITY))
+ || (isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_PRVGROUP))
|| (isset($contact['forum']) && intval($contact['forum']))
|| (isset($contact['prv']) && intval($contact['prv']))
|| (isset($contact['community']) && intval($contact['community']))
) {
- $type = self::ACCOUNT_TYPE_COMMUNITY;
+ $type = self::TYPE_COMMUNITY;
} else {
- $type = self::ACCOUNT_TYPE_PERSON;
+ $type = self::TYPE_PERSON;
}
// The "contact-type" (contact table) and "account-type" (user table) are more general then the chaos from above.
}
switch ($type) {
- case self::ACCOUNT_TYPE_ORGANISATION:
+ case self::TYPE_ORGANISATION:
$account_type = L10n::t("Organisation");
break;
- case self::ACCOUNT_TYPE_NEWS:
+ case self::TYPE_NEWS:
$account_type = L10n::t('News');
break;
- case self::ACCOUNT_TYPE_COMMUNITY:
+ case self::TYPE_COMMUNITY:
$account_type = L10n::t("Forum");
break;
*
* @param int $uid
* @return bool
+ * @throws \Exception
*/
public static function block($uid)
{
*
* @param int $uid
* @return bool
+ * @throws \Exception
*/
public static function unblock($uid)
{
* @param bool $force force picture update
*
* @return array Returns array of the different avatar sizes
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function updateAvatar($avatar, $uid, $cid, $force = false)
{
* @param integer $id contact id
* @param string $network Optional network we are probing for
* @return boolean
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function updateFromProbe($id, $network = '')
{
* @param string $url
* @param bool $interactive
* @param string $network
- * @return boolean|string
+ * @return array
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function createFromProbe($uid, $url, $interactive = false, $network = '')
{
}
} elseif (Config::get('system', 'dfrn_only') && ($ret['network'] != Protocol::DFRN)) {
$result['message'] = L10n::t('This site is not configured to allow communications with other networks.') . EOL;
- $result['message'] != L10n::t('No compatible communication protocols or feeds were discovered.') . EOL;
+ $result['message'] .= L10n::t('No compatible communication protocols or feeds were discovered.') . EOL;
return $result;
}
/**
* @brief Updated contact's SSL policy
*
- * @param array $contact Contact array
+ * @param array $contact Contact array
* @param string $new_policy New policy, valid: self,full
*
* @return array Contact array with updated values
+ * @throws \Exception
*/
public static function updateSslPolicy(array $contact, $new_policy)
{
/// @TODO Encapsulate this into a function/method
$fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
$user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
- if (DBA::isResult($user) && !in_array($user['page-flags'], [self::PAGE_SOAPBOX, self::PAGE_FREELOVE, self::PAGE_COMMUNITY])) {
+ if (DBA::isResult($user) && !in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
// create notification
$hash = Strings::getRandomHex();
Group::addMember(User::getDefaultGroup($importer['uid'], $contact_record["network"]), $contact_record['id']);
if (($user['notify-flags'] & NOTIFY_INTRO) &&
- in_array($user['page-flags'], [self::PAGE_NORMAL])) {
+ in_array($user['page-flags'], [User::PAGE_FLAGS_NORMAL])) {
notification([
'type' => NOTIFY_INTRO,
]);
}
- } elseif (DBA::isResult($user) && in_array($user['page-flags'], [self::PAGE_SOAPBOX, self::PAGE_FREELOVE, self::PAGE_COMMUNITY])) {
+ } elseif (DBA::isResult($user) && in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
$condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
DBA::update('contact', ['pending' => false], $condition);
* Remove the unavailable contact ids from the provided list
*
* @param array $contact_ids Contact id list
+ * @throws \Exception
*/
public static function pruneUnavailable(array &$contact_ids)
{
/**
* @brief Returns a magic link to authenticate remote visitors
*
- * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
+ * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
*
* @param string $contact_url The address of the target contact profile
- * @param string $url An url that we will be redirected to after the authentication
+ * @param string $url An url that we will be redirected to after the authentication
*
* @return string with "redir" link
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function magicLink($contact_url, $url = '')
{
* @brief Returns a magic link to authenticate remote visitors
*
* @param integer $cid The contact id of the target contact profile
- * @param integer $url An url that we will be redirected to after the authentication
+ * @param string $url An url that we will be redirected to after the authentication
*
* @return string with "redir" link
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function magicLinkbyId($cid, $url = '')
{
/**
* @brief Returns a magic link to authenticate remote visitors
*
- * @param array $contact The contact array with "uid", "network" and "url"
- * @param string $url An url that we will be redirected to after the authentication
+ * @param array $contact The contact array with "uid", "network" and "url"
+ * @param string $url An url that we will be redirected to after the authentication
*
* @return string with "redir" link
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
*/
public static function magicLinkbyContact($contact, $url = '')
{
projects / friendica.git / blobdiff