gnu-social/classes/Profile.php

1865 lines
59 KiB
PHP
Raw Normal View History

<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* @copyright 2008-2011 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
/**
* Table Definition for profile
*/
2011-08-23 06:52:02 +09:00
class Profile extends Managed_DataObject
{
public $__table = 'profile'; // table name
public $id; // int(4) primary_key not_null
public $nickname; // varchar(64) multiple_key not_null
public $fullname; // text()
public $profileurl; // text()
public $homepage; // text()
public $bio; // text() multiple_key
public $location; // text()
2009-09-16 07:28:44 +09:00
public $lat; // decimal(10,7)
public $lon; // decimal(10,7)
public $location_id; // int(4)
public $location_ns; // int(4)
public $created; // datetime() not_null default_0000-00-00%2000%3A00%3A00
public $modified; // datetime() not_null default_CURRENT_TIMESTAMP
2011-08-23 06:52:02 +09:00
public static function schemaDef()
{
$def = array(
2011-08-23 06:52:02 +09:00
'description' => 'local and remote users have profiles',
'fields' => array(
'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
'nickname' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'nickname or username', 'collate' => 'utf8mb4_general_ci'),
'fullname' => array('type' => 'text', 'description' => 'display name', 'collate' => 'utf8mb4_general_ci'),
'profileurl' => array('type' => 'text', 'description' => 'URL, cached so we dont regenerate'),
'homepage' => array('type' => 'text', 'description' => 'identifying URL', 'collate' => 'utf8mb4_general_ci'),
'bio' => array('type' => 'text', 'description' => 'descriptive biography', 'collate' => 'utf8mb4_general_ci'),
'location' => array('type' => 'text', 'description' => 'physical location', 'collate' => 'utf8mb4_general_ci'),
2011-08-23 06:52:02 +09:00
'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'),
'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'),
'location_id' => array('type' => 'int', 'description' => 'location id if possible'),
'location_ns' => array('type' => 'int', 'description' => 'namespace for location'),
'created' => array('type' => 'datetime', 'not null' => true, 'default' => '0000-00-00 00:00:00', 'description' => 'date this record was created'),
'modified' => array('type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'),
2011-08-23 06:52:02 +09:00
),
'primary key' => array('id'),
'indexes' => array(
'profile_nickname_idx' => array('nickname'),
)
2011-08-23 06:52:02 +09:00
);
// Add a fulltext index
if (common_config('search', 'type') == 'fulltext') {
$def['fulltext indexes'] = array('nickname' => array('nickname', 'fullname', 'location', 'bio', 'homepage'));
}
return $def;
2011-08-23 06:52:02 +09:00
}
public static function getByEmail($email)
{
// in the future, profiles should have emails stored...
$user = User::getKV('email', $email);
if (!($user instanceof User)) {
throw new NoSuchUserException(array('email'=>$email));
}
return $user->getProfile();
}
protected $_user = array();
public function getUser()
{
if (!isset($this->_user[$this->id])) {
$cur_user = common_current_user();
2016-07-03 06:43:47 +09:00
if (($cur_user instanceof User) && $cur_user->sameAs($this)) {
$user = $cur_user;
} else {
$user = User::getKV('id', $this->id);
if (!$user instanceof User) {
throw new NoSuchUserException(array('id'=>$this->id));
}
}
$this->_user[$this->id] = $user;
}
return $this->_user[$this->id];
}
protected $_group = array();
public function getGroup()
{
if (!isset($this->_group[$this->id])) {
$group = User_group::getKV('profile_id', $this->id);
if (!$group instanceof User_group) {
throw new NoSuchGroupException(array('profile_id'=>$this->id));
}
$this->_group[$this->id] = $group;
}
return $this->_group[$this->id];
}
public function isGroup()
{
try {
$this->getGroup();
return true;
} catch (NoSuchGroupException $e) {
return false;
}
}
public function isPerson()
{
// Maybe other things than PERSON and GROUP can have Profiles in the future?
return !$this->isGroup();
}
public function isLocal()
{
try {
$this->getUser();
} catch (NoSuchUserException $e) {
return false;
}
return true;
}
// Returns false if the user has no password (which will always
// be the case for remote users). This can be the case for OpenID
// logins or other mechanisms which don't store a password hash.
public function hasPassword()
{
try {
2015-10-05 05:31:07 +09:00
return $this->getUser()->hasPassword();
} catch (NoSuchUserException $e) {
return false;
}
}
public function getObjectType()
{
// FIXME: More types... like peopletags and whatever
if ($this->isGroup()) {
return ActivityObject::GROUP;
} else {
return ActivityObject::PERSON;
}
}
Avatar resizing improvements and better code reuse * getOriginal added to Avatar class This is a static function that retrieves the original avatar in a leaner way than Profile->getOriginalAvatar() did (see below). This will throw an Exception if there was none to be found. * getProfileAvatars added to Avatar class This gets all Avatars from a profile and returns them in an array. * newSize added to Avatar class This will scale an original avatar or throw an Exception (originally from Avatar::getOriginal) if one wasn't found. * deleteFromProfile added to Avatar class Deletes all avatars for a Profile. This makes the code much smarter when removing all avatars from a user. Previously only specific, hardcoded (through constants) sizes would be deleted. If you ever changed lib/framework.php then many oddsized avatars would remain with the old method. * Migrated Profile class to new Avatar::getOriginal support Profile class now uses Avatar::getOriginal through its own $this->getOriginalAvatar and thus remains backwards compatible. * Updating stock GNU Social to use Avatar::getOriginal All places where core StatusNet code used the $profile->getOriginalAvatar, it will now useAvatar::getOriginal with proper error handling. * Updated Profile class to use Avatar::newSize When doing setOriginal, the scaling will be done with the new method introduced in this merge. This also edits the _fillAvatar function to avoid adding NULL values to the array (which causes errors when attempting to access array entries as objects). See issue #3478 at http://status.net/open-source/issues/3478
2013-10-01 05:13:37 +09:00
public function getAvatar($width, $height=null)
{
return Avatar::byProfile($this, $width, $height);
2011-09-30 09:56:24 +09:00
}
public function setOriginal($filename)
{
if ($this->isGroup()) {
// Until Group avatars are handled just like profile avatars.
return $this->getGroup()->setOriginal($filename);
}
$imagefile = new ImageFile(null, Avatar::path($filename));
$avatar = new Avatar();
$avatar->profile_id = $this->id;
$avatar->width = $imagefile->width;
$avatar->height = $imagefile->height;
$avatar->mediatype = image_type_to_mime_type($imagefile->type);
$avatar->filename = $filename;
$avatar->original = true;
2013-10-08 18:40:23 +09:00
$avatar->created = common_sql_now();
// XXX: start a transaction here
if (!Avatar::deleteFromProfile($this, true) || !$avatar->insert()) {
// If we can't delete the old avatars, let's abort right here.
@unlink(Avatar::path($filename));
return null;
}
return $avatar;
}
/**
* Gets either the full name (if filled) or the nickname.
*
* @return string
*/
public function getBestName()
{
return ($this->fullname) ? $this->fullname : $this->nickname;
}
/**
* Takes the currently scoped profile into account to give a name
* to list in notice streams. Preferences may differ between profiles.
*/
public function getStreamName()
{
$user = common_current_user();
if ($user instanceof User && $user->streamNicknames()) {
return $this->nickname;
}
return $this->getBestName();
}
/**
* Gets the full name (if filled) with acct URI, URL, or URI as a
* parenthetical (in that order, for each not found). If no full
* name is found only the second part is returned, without ()s.
*
* @return string
*/
public function getFancyName()
{
$uri = null;
try {
2016-03-02 18:49:33 +09:00
$uri = $this->getAcctUri(false);
} catch (ProfileNoAcctUriException $e) {
try {
$uri = $this->getUrl();
} catch (InvalidUrlException $e) {
$uri = $this->getUri();
}
}
if (mb_strlen($this->getFullname()) > 0) {
// TRANS: The "fancy name": Full name of a profile or group (%1$s) followed by some URI (%2$s) in parentheses.
return sprintf(_m('FANCYNAME', '%1$s (%2$s)'), $this->getFullname(), $uri);
} else {
return $uri;
}
}
/**
* Get the most recent notice posted by this user, if any.
*
* @return mixed Notice or null
*/
public function getCurrentNotice(Profile $scoped = null)
{
try {
$notice = $this->getNotices(0, 1, 0, 0, $scoped);
if ($notice->fetch()) {
if ($notice instanceof ArrayWrapper) {
// hack for things trying to work with single notices
// ...but this shouldn't happen anymore I think. Keeping it for safety...
return $notice->_items[0];
}
return $notice;
}
} catch (PrivateStreamException $e) {
// Maybe we should let this through if it's handled well upstream
return null;
}
return null;
}
public function getReplies($offset = 0, $limit = NOTICES_PER_PAGE, $since_id = 0, $before_id = 0)
{
return Reply::stream($this->getID(), $offset, $limit, $since_id, $before_id);
}
public function getTaggedNotices($tag, $offset = 0, $limit = NOTICES_PER_PAGE, $since_id = 0, $max_id = 0)
{
//FIXME: Get Profile::current() some other way to avoid possible
// confusion between current session profile and background processing.
$stream = new TaggedProfileNoticeStream($this, $tag, Profile::current());
return $stream->getNotices($offset, $limit, $since_id, $max_id);
}
public function getNotices($offset = 0, $limit = NOTICES_PER_PAGE, $since_id = 0, $max_id = 0, Profile $scoped = null)
2009-05-02 03:27:57 +09:00
{
$stream = new ProfileNoticeStream($this, $scoped);
return $stream->getNotices($offset, $limit, $since_id, $max_id);
}
public function isMember(User_group $group)
{
$groups = $this->getGroups(0, null);
while ($groups instanceof User_group && $groups->fetch()) {
if ($groups->id == $group->id) {
return true;
}
}
return false;
}
public function isAdmin(User_group $group)
{
$gm = Group_member::pkeyGet(array('profile_id' => $this->id,
'group_id' => $group->id));
return (!empty($gm) && $gm->is_admin);
}
public function isPendingMember($group)
{
$request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
'group_id' => $group->id));
return !empty($request);
}
public function getGroups($offset = 0, $limit = PROFILES_PER_PAGE)
{
2011-04-06 06:20:17 +09:00
$ids = array();
2011-04-06 06:20:17 +09:00
$keypart = sprintf('profile:groups:%d', $this->id);
$idstring = self::cacheGet($keypart);
if ($idstring !== false) {
$ids = explode(',', $idstring);
} else {
$gm = new Group_member();
$gm->profile_id = $this->id;
if ($gm->find()) {
while ($gm->fetch()) {
$ids[] = $gm->group_id;
}
}
2011-04-06 06:20:17 +09:00
self::cacheSet($keypart, implode(',', $ids));
}
if (!is_null($offset) && !is_null($limit)) {
$ids = array_slice($ids, $offset, $limit);
}
try {
return User_group::multiGet('id', $ids);
} catch (NoResultException $e) {
return null; // throw exception when we handle it everywhere
}
}
public function getGroupCount()
{
$groups = $this->getGroups(0, null);
return $groups instanceof User_group
? $groups->N
: 0;
}
public function isTagged($peopletag)
2011-03-07 02:58:03 +09:00
{
$tag = Profile_tag::pkeyGet(array('tagger' => $peopletag->tagger,
'tagged' => $this->id,
'tag' => $peopletag->tag));
return !empty($tag);
}
public function canTag($tagged)
2011-03-07 02:58:03 +09:00
{
if (empty($tagged)) {
return false;
}
if ($tagged->id == $this->id) {
return true;
}
$all = common_config('peopletag', 'allow_tagging', 'all');
$local = common_config('peopletag', 'allow_tagging', 'local');
$remote = common_config('peopletag', 'allow_tagging', 'remote');
$subs = common_config('peopletag', 'allow_tagging', 'subs');
if ($all) {
return true;
}
$tagged_user = $tagged->getUser();
if (!empty($tagged_user)) {
if ($local) {
return true;
}
} elseif ($subs) {
2011-03-07 02:58:03 +09:00
return (Subscription::exists($this, $tagged) ||
Subscription::exists($tagged, $this));
} elseif ($remote) {
2011-03-07 02:58:03 +09:00
return true;
}
return false;
}
public function getLists(Profile $scoped = null, $offset = 0, $limit = null, $since_id = 0, $max_id = 0)
2011-03-07 02:58:03 +09:00
{
$ids = array();
2011-03-07 02:58:03 +09:00
$keypart = sprintf('profile:lists:%d', $this->id);
$idstr = self::cacheGet($keypart);
if ($idstr !== false) {
$ids = explode(',', $idstr);
2011-03-07 02:58:03 +09:00
} else {
$list = new Profile_list();
$list->selectAdd();
$list->selectAdd('id');
$list->tagger = $this->id;
$list->selectAdd('id as "cursor"');
2011-03-07 02:58:03 +09:00
if ($since_id > 0) {
$list->whereAdd('id > ' . $since_id);
}
2011-03-07 02:58:03 +09:00
if ($max_id > 0) {
$list->whereAdd('id <= ' . $max_id);
}
2011-03-07 02:58:03 +09:00
if ($offset >= 0 && !is_null($limit)) {
$list->limit($offset, $limit);
}
2011-03-07 02:58:03 +09:00
$list->orderBy('id DESC');
if ($list->find()) {
while ($list->fetch()) {
$ids[] = $list->id;
}
}
self::cacheSet($keypart, implode(',', $ids));
2011-03-07 02:58:03 +09:00
}
2016-01-06 08:18:10 +09:00
$showPrivate = $this->sameAs($scoped);
2011-03-07 02:58:03 +09:00
$lists = array();
foreach ($ids as $id) {
$list = Profile_list::getKV('id', $id);
if (!empty($list) &&
($showPrivate || !$list->private)) {
if (!isset($list->cursor)) {
$list->cursor = $list->id;
}
$lists[] = $list;
}
}
return new ArrayWrapper($lists);
2011-03-07 02:58:03 +09:00
}
/**
* Get tags that other people put on this profile, in reverse-chron order
*
* @param Profile $scoped User we are requesting as
* @param int $offset Offset from latest
* @param int $limit Max number to get
* @param datetime $since_id max date
* @param datetime $max_id min date
*
* @return Profile_list resulting lists
*/
public function getOtherTags(Profile $scoped = null, int $offset = 0, ?int $limit = null, int $since = 0, int $upto = 0)
2011-03-07 02:58:03 +09:00
{
$list = new Profile_list();
2011-03-07 02:58:03 +09:00
if (common_config('db', 'type') !== 'mysql') {
$cursor = sprintf(
'((EXTRACT(DAY %1$s) * 24 + EXTRACT(HOUR %1$s)) * 60 + ' .
'EXTRACT(MINUTE %1$s)) * 60 + FLOOR(EXTRACT(SECOND %1$s)) AS "cursor"',
"FROM (profile_tag.modified - TIMESTAMP '1970-01-01 00:00:00')"
);
} else {
// The SQL/Foundation conforming implementation above doesn't work on MariaDB/MySQL
$cursor = "timestampdiff(SECOND, '1970-01-01', profile_tag.modified) AS `cursor`";
}
$qry = sprintf(
'SELECT profile_list.*, ' . $cursor . ' ' .
'FROM profile_tag INNER JOIN profile_list ' .
'ON (profile_tag.tagger = profile_list.tagger ' .
' AND profile_tag.tag = profile_list.tag) ' .
'WHERE profile_tag.tagged = %d ',
$this->id
);
2011-03-07 02:58:03 +09:00
if (!is_null($scoped)) {
$qry .= sprintf(
'AND ( profile_list.private = false ' .
'OR ( profile_list.tagger = %d AND ' .
'profile_list.private = TRUE ) )',
$scoped->getID()
);
2011-03-07 02:58:03 +09:00
} else {
$qry .= 'AND profile_list.private = FALSE ';
2011-03-07 02:58:03 +09:00
}
if ($since > 0) {
$qry .= 'AND cursor > ' . $since . ' ';
2011-03-07 02:58:03 +09:00
}
if ($upto > 0) {
$qry .= 'AND cursor < ' . $upto . ' ';
2011-03-07 02:58:03 +09:00
}
$qry .= 'ORDER BY profile_tag.modified DESC ';
2011-03-07 02:58:03 +09:00
if ($offset >= 0 && !is_null($limit)) {
$qry .= sprintf('LIMIT %d OFFSET %d ', $limit, $offset);
}
2011-03-07 02:58:03 +09:00
$list->query($qry);
return $list;
2011-03-07 02:58:03 +09:00
}
public function getPrivateTags($offset = 0, $limit = null, $since_id = 0, $max_id = 0)
2011-03-07 02:58:03 +09:00
{
$tags = new Profile_list();
$tags->private = true;
$tags->tagger = $this->id;
if ($since_id > 0) {
$tags->whereAdd('id > ' . $since_id);
2011-03-07 02:58:03 +09:00
}
if ($max_id > 0) {
$tags->whereAdd('id <= ' . $max_id);
2011-03-07 02:58:03 +09:00
}
if ($offset >= 0 && !is_null($limit)) {
2011-03-07 02:58:03 +09:00
$tags->limit($offset, $limit);
}
$tags->orderBy('id DESC');
$tags->find();
return $tags;
}
public function hasLocalTags()
2011-03-07 02:58:03 +09:00
{
$tags = new Profile_tag();
$tags->joinAdd(array('tagger', 'user:id'));
$tags->whereAdd('tagged = ' . $this->id);
$tags->whereAdd('tagger <> ' . $this->id);
2011-03-07 02:58:03 +09:00
$tags->limit(0, 1);
$tags->fetch();
return ($tags->N == 0) ? false : true;
}
public function getTagSubscriptions(int $offset = 0, ?int $limit = null, int $since = 0, int $upto = 0)
2011-03-07 02:58:03 +09:00
{
$lists = new Profile_list();
$subs = new Profile_tag_subscription();
$lists->joinAdd(['id', 'profile_tag_subscription:profile_tag_id']);
if (common_config('db', 'type') !== 'mysql') {
$lists->selectAdd(sprintf(
'((EXTRACT(DAY %1$s) * 24 + EXTRACT(HOUR %1$s)) * 60 + ' .
'EXTRACT(MINUTE %1$s)) * 60 + FLOOR(EXTRACT(SECOND %1$s)) AS "cursor"',
"FROM (profile_tag_subscription.created - TIMESTAMP '1970-01-01 00:00:00')"
));
} else {
$lists->selectAdd("timestampdiff(SECOND, '1970-01-01', profile_tag_subscription.created) AS `cursor`");
}
2011-03-07 02:58:03 +09:00
$lists->whereAdd('profile_tag_subscription.profile_id = '.$this->id);
if ($since > 0) {
$lists->whereAdd('cursor > ' . $since);
2011-03-07 02:58:03 +09:00
}
if ($upto > 0) {
$lists->whereAdd('cursor <= ' . $upto);
2011-03-07 02:58:03 +09:00
}
if ($offset >= 0 && !is_null($limit)) {
2011-03-07 02:58:03 +09:00
$lists->limit($offset, $limit);
}
$lists->orderBy('profile_tag_subscription.created DESC');
2011-03-07 02:58:03 +09:00
$lists->find();
return $lists;
}
/**
* Request to join the given group.
* May throw exceptions on failure.
*
* @param User_group $group
* @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
*/
public function joinGroup(User_group $group)
{
$join = null;
if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
$join = Group_join_queue::saveNew($this, $group);
} else {
if (Event::handle('StartJoinGroup', array($group, $this))) {
$join = Group_member::join($group->id, $this->id);
2011-04-06 06:20:17 +09:00
self::blow('profile:groups:%d', $this->id);
2012-07-05 03:39:26 +09:00
self::blow('group:member_ids:%d', $group->id);
2012-07-05 03:11:42 +09:00
self::blow('group:member_count:%d', $group->id);
Event::handle('EndJoinGroup', array($group, $this));
}
}
if ($join) {
// Send any applicable notifications...
$join->notify();
}
return $join;
}
/**
* Leave a group that this profile is a member of.
*
* @param User_group $group
*/
public function leaveGroup(User_group $group)
{
if (Event::handle('StartLeaveGroup', array($group, $this))) {
Group_member::leave($group->id, $this->id);
2011-04-06 06:20:17 +09:00
self::blow('profile:groups:%d', $this->id);
2012-07-05 03:39:26 +09:00
self::blow('group:member_ids:%d', $group->id);
2012-07-05 03:11:42 +09:00
self::blow('group:member_count:%d', $group->id);
Event::handle('EndLeaveGroup', array($group, $this));
}
}
public function avatarUrl($size = AVATAR_PROFILE_SIZE)
{
return Avatar::urlByProfile($this, $size);
}
public function getSubscribed($offset = 0, $limit = null)
{
$subs = Subscription::getSubscribedIDs($this->id, $offset, $limit);
try {
$profiles = Profile::multiGet('id', $subs);
} catch (NoResultException $e) {
return $e->obj;
}
return $profiles;
}
public function getSubscribers($offset = 0, $limit = null)
{
$subs = Subscription::getSubscriberIDs($this->id, $offset, $limit);
try {
$profiles = Profile::multiGet('id', $subs);
} catch (NoResultException $e) {
return $e->obj;
}
return $profiles;
}
public function getTaggedSubscribers($tag, $offset = 0, $limit = null)
2011-03-07 02:58:03 +09:00
{
$qry =
'SELECT profile.* ' .
'FROM profile JOIN subscription ' .
2011-03-07 02:58:03 +09:00
'ON profile.id = subscription.subscriber ' .
'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
'AND profile_tag.tagger = subscription.subscribed) ' .
2011-03-07 02:58:03 +09:00
'WHERE subscription.subscribed = %d ' .
"AND profile_tag.tag = '%s' " .
'AND subscription.subscribed <> subscription.subscriber ' .
'ORDER BY subscription.created DESC ';
if ($offset) {
$qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
}
2011-03-07 02:58:03 +09:00
$profile = new Profile();
$cnt = $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
2011-03-07 02:58:03 +09:00
return $profile;
}
public function getTaggedSubscriptions($tag, $offset = 0, $limit = null)
{
$qry =
'SELECT profile.* ' .
'FROM profile JOIN subscription ' .
'ON profile.id = subscription.subscribed ' .
'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
'AND profile_tag.tagger = subscription.subscriber) ' .
'WHERE subscription.subscriber = %d ' .
"AND profile_tag.tag = '%s' " .
'AND subscription.subscribed <> subscription.subscriber ' .
'ORDER BY subscription.created DESC ';
$qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
$profile = new Profile();
$profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
return $profile;
2011-03-07 02:58:03 +09:00
}
2011-03-29 09:06:02 +09:00
/**
* Get pending subscribers, who have not yet been approved.
*
* @param int $offset
* @param int $limit
* @return Profile
*/
public function getRequests($offset = 0, $limit = null)
2011-03-29 09:06:02 +09:00
{
// FIXME: mysql only
$subqueue = new Profile();
$subqueue->joinAdd(array('id', 'subscription_queue:subscriber'));
$subqueue->whereAdd(sprintf('subscription_queue.subscribed = %d', $this->getID()));
$subqueue->limit($offset, $limit);
$subqueue->orderBy('subscription_queue.created', 'DESC');
if (!$subqueue->find()) {
throw new NoResultException($subqueue);
}
return $subqueue;
2011-03-29 09:06:02 +09:00
}
public function subscriptionCount()
{
2010-09-06 22:56:45 +09:00
$c = Cache::instance();
if (!empty($c)) {
2010-09-06 23:07:43 +09:00
$cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
if (is_integer($cnt)) {
return (int) $cnt;
}
}
$sub = new Subscription();
$sub->subscriber = $this->id;
$cnt = (int) $sub->count('distinct subscribed');
// Local users are subscribed to themselves
if ($this->isLocal()) {
$cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
}
if (!empty($c)) {
2010-09-06 23:07:43 +09:00
$c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
}
return $cnt;
}
public function subscriberCount()
{
2010-09-06 22:56:45 +09:00
$c = Cache::instance();
if (!empty($c)) {
2010-09-06 23:07:43 +09:00
$cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
if (is_integer($cnt)) {
return (int) $cnt;
}
}
$sub = new Subscription();
$sub->subscribed = $this->id;
$sub->whereAdd('subscriber <> subscribed');
$cnt = (int) $sub->count('DISTINCT subscriber');
if (!empty($c)) {
2010-09-06 23:07:43 +09:00
$c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
}
return $cnt;
}
/**
* Is this profile subscribed to another profile?
*
* @param Profile $other
* @return boolean
*/
public function isSubscribed(Profile $other)
{
return Subscription::exists($this, $other);
}
public function readableBy(Profile $other = null)
{
// If it's not a private stream, it's readable by anyone
if (!$this->isPrivateStream()) {
return true;
}
// If it's a private stream, $other must be a subscriber to $this
return is_null($other) ? false : $other->isSubscribed($this);
}
public function requiresSubscriptionApproval(Profile $other = null): bool
{
if (!$this->isLocal()) {
// We don't know for remote users, and we'll always be able to send
// the request. Whether it'll work immediately or require moderation
// can be determined in another function.
return false;
}
// Assume that profiles _we_ subscribe to are permitted. Could be made configurable.
if (!is_null($other) && $this->isSubscribed($other)) {
return false;
}
// If the local user either has a private stream (implies the following)
// or user has a moderation policy for new subscriptions, return true.
return $this->isPrivateStream() || $this->getUser()->subscribe_policy === User::SUBSCRIBE_POLICY_MODERATE;
}
/**
* Check if a pending subscription request is outstanding for this...
*
* @param Profile $other
* @return boolean
*/
public function hasPendingSubscription(Profile $other)
{
return Subscription_queue::exists($this, $other);
}
/**
* Are these two profiles subscribed to each other?
*
* @param Profile $other
* @return boolean
*/
public function mutuallySubscribed(Profile $other)
{
return $this->isSubscribed($other) &&
$other->isSubscribed($this);
}
public function noticeCount()
{
2010-09-06 22:56:45 +09:00
$c = Cache::instance();
if (!empty($c)) {
2016-03-09 03:56:25 +09:00
$cnt = $c->get(Cache::key('profile:notice_count:'.$this->getID()));
if (is_integer($cnt)) {
return (int) $cnt;
}
}
$notices = new Notice();
2016-03-09 03:56:25 +09:00
$notices->profile_id = $this->getID();
$notices->verb = ActivityVerb::POST;
$cnt = (int) $notices->count('id'); // Not sure if I imagine this, but 'id' was faster than the defaulting 'uri'?
if (!empty($c)) {
2016-03-09 03:56:25 +09:00
$c->set(Cache::key('profile:notice_count:'.$this->getID()), $cnt);
}
return $cnt;
}
public function blowSubscriberCount()
{
2010-09-06 22:56:45 +09:00
$c = Cache::instance();
if (!empty($c)) {
2010-09-06 23:07:43 +09:00
$c->delete(Cache::key('profile:subscriber_count:'.$this->id));
}
}
public function blowSubscriptionCount()
{
2010-09-06 22:56:45 +09:00
$c = Cache::instance();
if (!empty($c)) {
2010-09-06 23:07:43 +09:00
$c->delete(Cache::key('profile:subscription_count:'.$this->id));
}
}
public function blowNoticeCount()
{
2010-09-06 22:56:45 +09:00
$c = Cache::instance();
if (!empty($c)) {
2010-09-06 23:07:43 +09:00
$c->delete(Cache::key('profile:notice_count:'.$this->id));
}
}
public static function maxBio()
{
$biolimit = common_config('profile', 'biolimit');
// null => use global limit (distinct from 0!)
if (is_null($biolimit)) {
$biolimit = common_config('site', 'textlimit');
}
return $biolimit;
}
public static function bioTooLong($bio)
{
$biolimit = self::maxBio();
return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
}
public function update($dataObject = false)
{
if (is_object($dataObject) && $this->nickname != $dataObject->nickname) {
try {
$local = $this->getUser();
common_debug("Updating User ({$this->id}) nickname from {$dataObject->nickname} to {$this->nickname}");
$origuser = clone($local);
$local->nickname = $this->nickname;
// updateWithKeys throws exception on failure.
$local->updateWithKeys($origuser);
// Clear the site owner, in case nickname changed
if ($local->hasRole(Profile_role::OWNER)) {
User::blow('user:site_owner');
}
} catch (NoSuchUserException $e) {
// Nevermind...
}
}
return parent::update($dataObject);
}
2016-02-25 00:42:54 +09:00
public function getRelSelf()
{
return ['href' => $this->getUrl(),
'text' => common_config('site', 'name'),
'image' => Avatar::urlByProfile($this)];
}
// All the known rel="me", used for the IndieWeb audience
public function getRelMes()
{
$relMes = array();
try {
$relMes[] = $this->getRelSelf();
} catch (InvalidUrlException $e) {
// no valid profile URL available
}
if (common_valid_http_url($this->getHomepage())) {
$relMes[] = ['href' => $this->getHomepage(),
'text' => _('Homepage'),
'image' => null];
}
Event::handle('OtherAccountProfiles', array($this, &$relMes));
return $relMes;
}
public function delete($useWhere = false)
2009-07-27 04:06:38 +09:00
{
$this->_deleteNotices();
$this->_deleteSubscriptions();
$this->_deleteTags();
$this->_deleteBlocks();
$this->_deleteAttentions();
Avatar::deleteFromProfile($this, true);
2009-07-27 04:06:38 +09:00
// Warning: delete() will run on the batch objects,
// not on individual objects.
$related = [
'Reply',
'Group_member',
'Profile_role',
];
Event::handle('ProfileDeleteRelated', array($this, &$related));
2009-07-27 04:06:38 +09:00
foreach ($related as $cls) {
$inst = new $cls();
$inst->profile_id = $this->id;
$inst->delete();
}
$this->grantRole(Profile_role::DELETED);
2009-07-27 04:06:38 +09:00
$localuser = User::getKV('id', $this->id);
if ($localuser instanceof User) {
$localuser->delete();
}
return parent::delete($useWhere);
2009-07-27 04:06:38 +09:00
}
public function _deleteNotices()
2009-07-27 04:06:38 +09:00
{
$notice = new Notice();
$notice->profile_id = $this->id;
if ($notice->find()) {
while ($notice->fetch()) {
$other = clone($notice);
$other->delete();
}
}
}
public function _deleteSubscriptions()
2009-07-27 04:06:38 +09:00
{
$sub = new Subscription();
$sub->subscriber = $this->getID();
$sub->find();
while ($sub->fetch()) {
try {
$other = $sub->getSubscribed();
if (!$other->sameAs($this)) {
Subscription::cancel($this, $other);
}
} catch (NoResultException $e) {
// Profile not found
common_log(LOG_INFO, 'Subscribed profile id=='.$sub->subscribed.' not found when deleting profile id=='.$this->getID().', ignoring...');
} catch (ServerException $e) {
// Subscription cancel failed
2016-01-04 06:22:58 +09:00
common_log(LOG_INFO, 'Subscribed profile id=='.$other->getID().' could not be reached for unsubscription notice when deleting profile id=='.$this->getID().', ignoring...');
}
}
2009-07-27 04:06:38 +09:00
$sub = new Subscription();
$sub->subscribed = $this->getID();
$sub->find();
while ($sub->fetch()) {
try {
$other = $sub->getSubscriber();
common_log(LOG_INFO, 'Subscriber profile id=='.$sub->subscribed.' not found when deleting profile id=='.$this->getID().', ignoring...');
if (!$other->sameAs($this)) {
Subscription::cancel($other, $this);
}
} catch (NoResultException $e) {
// Profile not found
common_log(LOG_INFO, 'Subscribed profile id=='.$sub->subscribed.' not found when deleting profile id=='.$this->getID().', ignoring...');
} catch (ServerException $e) {
// Subscription cancel failed
2016-01-04 06:22:58 +09:00
common_log(LOG_INFO, 'Subscriber profile id=='.$other->getID().' could not be reached for unsubscription notice when deleting profile id=='.$this->getID().', ignoring...');
}
}
// Finally delete self-subscription
$self = new Subscription();
$self->subscriber = $this->getID();
$self->subscribed = $this->getID();
$self->delete();
2009-07-27 04:06:38 +09:00
}
public function _deleteTags()
2009-07-27 04:06:38 +09:00
{
$tag = new Profile_tag();
$tag->tagged = $this->id;
$tag->delete();
2009-07-27 04:06:38 +09:00
}
public function _deleteBlocks()
2009-07-27 04:06:38 +09:00
{
$block = new Profile_block();
$block->blocked = $this->id;
$block->delete();
$block = new Group_block();
$block->blocked = $this->id;
$block->delete();
}
2009-10-30 03:43:25 +09:00
public function _deleteAttentions()
{
$att = new Attention();
$att->profile_id = $this->getID();
if ($att->find()) {
while ($att->fetch()) {
// Can't do delete() on the object directly since it won't remove all of it
$other = clone($att);
$other->delete();
}
}
}
2009-10-30 03:43:25 +09:00
// XXX: identical to Notice::getLocation.
public function getLocation()
2009-10-30 03:43:25 +09:00
{
$location = null;
if (!empty($this->location_id) && !empty($this->location_ns)) {
$location = Location::fromId($this->location_id, $this->location_ns);
}
if (is_null($location)) { // no ID, or Location::fromId() failed
if (!empty($this->lat) && !empty($this->lon)) {
$location = Location::fromLatLon($this->lat, $this->lon);
}
}
if (is_null($location)) { // still haven't found it!
if (!empty($this->location)) {
$location = Location::fromName($this->location);
}
}
return $location;
}
2009-11-16 23:52:33 +09:00
public function shareLocation()
{
$cfg = common_config('location', 'share');
if ($cfg == 'always') {
return true;
} elseif ($cfg == 'never') {
return false;
} else { // user
$share = common_config('location', 'sharedefault');
// Check if user has a personal setting for this
$prefs = User_location_prefs::getKV('user_id', $this->id);
if (!empty($prefs)) {
$share = $prefs->share_location;
$prefs->free();
}
return $share;
}
}
public function hasRole($name)
2009-11-16 23:52:33 +09:00
{
$has_role = false;
if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
$role = Profile_role::pkeyGet(array('profile_id' => $this->id,
'role' => $name));
$has_role = !empty($role);
Event::handle('EndHasRole', array($this, $name, $has_role));
}
return $has_role;
2009-11-16 23:52:33 +09:00
}
public function grantRole($name)
2009-11-16 23:52:33 +09:00
{
if (Event::handle('StartGrantRole', array($this, $name))) {
$role = new Profile_role();
2009-11-16 23:52:33 +09:00
$role->profile_id = $this->id;
$role->role = $name;
$role->created = common_sql_now();
2009-11-16 23:52:33 +09:00
$result = $role->insert();
if (!$result) {
throw new Exception("Can't save role '$name' for profile '{$this->id}'");
}
if ($name == 'owner') {
User::blow('user:site_owner');
}
Event::handle('EndGrantRole', array($this, $name));
2009-11-16 23:52:33 +09:00
}
return $result;
2009-11-16 23:52:33 +09:00
}
public function revokeRole($name)
2009-11-16 23:52:33 +09:00
{
if (Event::handle('StartRevokeRole', array($this, $name))) {
$role = Profile_role::pkeyGet(array('profile_id' => $this->id,
'role' => $name));
2009-11-16 23:52:33 +09:00
if (empty($role)) {
// TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
// TRANS: %1$s is the role name, %2$s is the user ID (number).
throw new Exception(sprintf(
_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),
$name,
$this->id
));
}
2009-11-16 23:52:33 +09:00
$result = $role->delete();
2009-11-16 23:52:33 +09:00
if (!$result) {
common_log_db_error($role, 'DELETE', __FILE__);
// TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
// TRANS: %1$s is the role name, %2$s is the user ID (number).
throw new Exception(sprintf(
_('Cannot revoke role "%1$s" for user #%2$d; database error.'),
$name,
$this->id
));
}
if ($name == 'owner') {
User::blow('user:site_owner');
}
Event::handle('EndRevokeRole', array($this, $name));
return true;
}
2009-11-16 23:52:33 +09:00
}
public function isSandboxed()
2009-11-16 23:52:33 +09:00
{
return $this->hasRole(Profile_role::SANDBOXED);
2009-11-16 23:52:33 +09:00
}
public function isSilenced()
2009-11-16 23:52:33 +09:00
{
return $this->hasRole(Profile_role::SILENCED);
2009-11-16 23:52:33 +09:00
}
public function sandbox()
2009-11-16 23:52:33 +09:00
{
$this->grantRole(Profile_role::SANDBOXED);
2009-11-16 23:52:33 +09:00
}
public function unsandbox()
2009-11-16 23:52:33 +09:00
{
$this->revokeRole(Profile_role::SANDBOXED);
2009-11-16 23:52:33 +09:00
}
public function silence()
2009-11-16 23:52:33 +09:00
{
$this->grantRole(Profile_role::SILENCED);
if (common_config('notice', 'hidespam')) {
$this->flushVisibility();
}
2009-11-16 23:52:33 +09:00
}
public function silenceAs(Profile $actor)
{
if (!$actor->hasRight(Right::SILENCEUSER)) {
throw new AuthorizationException(_('You cannot silence users on this site.'));
}
// Only administrators can silence other privileged users (such as others who have the right to silence).
if ($this->isPrivileged() && !$actor->hasRole(Profile_role::ADMINISTRATOR)) {
throw new AuthorizationException(_('You cannot silence other privileged users.'));
}
if ($this->isSilenced()) {
// TRANS: Client error displayed trying to silence an already silenced user.
throw new AlreadyFulfilledException(_('User is already silenced.'));
}
return $this->silence();
}
public function unsilence()
2009-11-16 23:52:33 +09:00
{
$this->revokeRole(Profile_role::SILENCED);
if (common_config('notice', 'hidespam')) {
$this->flushVisibility();
}
}
public function unsilenceAs(Profile $actor)
{
if (!$actor->hasRight(Right::SILENCEUSER)) {
// TRANS: Client error displayed trying to unsilence a user when the user does not have the right.
throw new AuthorizationException(_('You cannot unsilence users on this site.'));
}
if (!$this->isSilenced()) {
// TRANS: Client error displayed trying to unsilence a user when the target user has not been silenced.
throw new AlreadyFulfilledException(_('User is not silenced.'));
}
return $this->unsilence();
}
public function flushVisibility()
{
// Get all notices
$stream = new ProfileNoticeStream($this, $this);
$ids = $stream->getNoticeIds(0, CachingNoticeStream::CACHE_WINDOW);
foreach ($ids as $id) {
self::blow('notice:in-scope-for:%d:null', $id);
}
2009-11-16 23:52:33 +09:00
}
public function isPrivileged()
{
// TODO: An Event::handle so plugins can report if users are privileged.
// The ModHelper is the only one I care about when coding this, and that
// can be tested with Right::SILENCEUSER which I do below:
switch (true) {
case $this->hasRight(Right::SILENCEUSER):
case $this->hasRole(Profile_role::MODERATOR):
case $this->hasRole(Profile_role::ADMINISTRATOR):
case $this->hasRole(Profile_role::OWNER):
return true;
}
return false;
}
/**
* Does this user have the right to do X?
*
* With our role-based authorization, this is merely a lookup for whether the user
* has a particular role. The implementation currently uses a switch statement
* to determine if the user has the pre-defined role to exercise the right. Future
* implementations may allow per-site roles, and different mappings of roles to rights.
*
* @param $right string Name of the right, usually a constant in class Right
* @return boolean whether the user has the right in question
*/
public function hasRight($right)
{
$result = false;
if ($this->hasRole(Profile_role::DELETED)) {
return false;
}
if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
switch ($right) {
case Right::DELETEOTHERSNOTICE:
case Right::MAKEGROUPADMIN:
case Right::SANDBOXUSER:
case Right::SILENCEUSER:
case Right::DELETEUSER:
case Right::DELETEGROUP:
case Right::TRAINSPAM:
case Right::REVIEWSPAM:
$result = $this->hasRole(Profile_role::MODERATOR);
break;
case Right::CONFIGURESITE:
$result = $this->hasRole(Profile_role::ADMINISTRATOR);
break;
case Right::GRANTROLE:
case Right::REVOKEROLE:
$result = $this->hasRole(Profile_role::OWNER);
break;
case Right::NEWNOTICE:
case Right::NEWMESSAGE:
case Right::SUBSCRIBE:
case Right::CREATEGROUP:
$result = !$this->isSilenced();
break;
case Right::PUBLICNOTICE:
case Right::EMAILONREPLY:
case Right::EMAILONSUBSCRIBE:
case Right::EMAILONFAVE:
$result = !$this->isSandboxed() && !$this->isSilenced();
break;
case Right::WEBLOGIN:
$result = !$this->isSilenced();
break;
case Right::API:
$result = !$this->isSilenced();
break;
case Right::BACKUPACCOUNT:
$result = common_config('profile', 'backup');
break;
case Right::RESTOREACCOUNT:
$result = common_config('profile', 'restore');
break;
case Right::DELETEACCOUNT:
$result = common_config('profile', 'delete');
break;
case Right::MOVEACCOUNT:
$result = common_config('profile', 'move');
break;
default:
$result = false;
break;
}
}
return $result;
}
2009-12-12 00:49:26 +09:00
// FIXME: Can't put Notice typing here due to ArrayWrapper
public function hasRepeated($notice)
2009-12-12 00:49:26 +09:00
{
// XXX: not really a pkey, but should work
$notice = Notice::pkeyGet(array('profile_id' => $this->getID(),
'repeat_of' => $notice->getID(),
'verb' => ActivityVerb::SHARE));
2009-12-12 00:49:26 +09:00
return !empty($notice);
}
/**
* Returns an XML string fragment with limited profile information
* as an Atom <author> element.
*
* Assumes that Atom has been previously set up as the base namespace.
*
* @param Profile $cur the current authenticated user
*
* @return string
*/
public function asAtomAuthor($cur = null)
{
$xs = new XMLStringer(true);
$xs->elementStart('author');
$xs->element('name', null, $this->nickname);
2010-02-17 13:13:39 +09:00
$xs->element('uri', null, $this->getUri());
if ($cur != null) {
$attrs = [];
$attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
$attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
$xs->element('statusnet:profile_info', $attrs, null);
}
$xs->elementEnd('author');
return $xs->getString();
}
/**
* Extra profile info for atom entries
*
* Clients use some extra profile info in the atom stream.
* This gives it to them.
*
2014-07-28 16:25:05 +09:00
* @param Profile $scoped The currently logged in/scoped profile
*
2011-02-18 12:02:57 +09:00
* @return array representation of <statusnet:profile_info> element or null
*/
public function profileInfo(Profile $scoped = null)
{
2011-02-18 12:02:57 +09:00
$profileInfoAttr = array('local_id' => $this->id);
2014-07-28 16:25:05 +09:00
if ($scoped instanceof Profile) {
// Whether the current user is a subscribed to this profile
2014-07-28 16:25:05 +09:00
$profileInfoAttr['following'] = $scoped->isSubscribed($this) ? 'true' : 'false';
// Whether the current user is has blocked this profile
2014-07-28 16:25:05 +09:00
$profileInfoAttr['blocking'] = $scoped->hasBlocked($this) ? 'true' : 'false';
}
return array('statusnet:profile_info', $profileInfoAttr, null);
}
/**
* Returns an XML string fragment with profile information as an
* Activity Streams <activity:actor> element.
*
* Assumes that 'activity' namespace has been previously defined.
*
* @return string
*/
public function asActivityActor()
{
return $this->asActivityNoun('actor');
}
/**
* Returns an XML string fragment with profile information as an
* Activity Streams noun object with the given element type.
*
* Assumes that 'activity', 'georss', and 'poco' namespace has been
* previously defined.
*
* @param string $element one of 'actor', 'subject', 'object', 'target'
*
* @return string
*/
public function asActivityNoun($element)
{
$noun = $this->asActivityObject();
return $noun->asString('activity:' . $element);
}
public function asActivityObject()
{
$object = new ActivityObject();
if (Event::handle('StartActivityObjectFromProfile', array($this, &$object))) {
$object->type = $this->getObjectType();
$object->id = $this->getUri();
$object->title = $this->getBestName();
$object->link = $this->getUrl();
$object->summary = $this->getDescription();
try {
$avatar = Avatar::getUploaded($this);
$object->avatarLinks[] = AvatarLink::fromAvatar($avatar);
} catch (NoAvatarException $e) {
// Could not find an original avatar to link
}
$sizes = array(
AVATAR_PROFILE_SIZE,
AVATAR_STREAM_SIZE,
AVATAR_MINI_SIZE
);
foreach ($sizes as $size) {
$alink = null;
try {
$avatar = Avatar::byProfile($this, $size);
$alink = AvatarLink::fromAvatar($avatar);
} catch (NoAvatarException $e) {
$alink = new AvatarLink();
$alink->type = 'image/png';
$alink->height = $size;
$alink->width = $size;
$alink->url = Avatar::defaultImage($size);
}
$object->avatarLinks[] = $alink;
}
if (isset($this->lat) && isset($this->lon)) {
$object->geopoint = (float)$this->lat
. ' ' . (float)$this->lon;
}
$object->poco = PoCo::fromProfile($this);
if ($this->isLocal()) {
$object->extra[] = array('followers', array('url' => common_local_url('subscribers', array('nickname' => $this->getNickname()))));
}
Event::handle('EndActivityObjectFromProfile', array($this, &$object));
}
return $object;
}
/**
* Returns the profile's canonical url, not necessarily a uri/unique id
*
* @return string $profileurl
*/
public function getUrl()
{
$url = null;
if ($this->isGroup()) {
// FIXME: Get rid of this event, it fills no real purpose, data should be in Profile->profileurl (replaces User_group->mainpage)
if (Event::handle('StartUserGroupHomeUrl', array($this->getGroup(), &$url))) {
2016-01-09 21:33:30 +09:00
$url = $this->getGroup()->isLocal()
? common_local_url('showgroup', array('nickname' => $this->getNickname()))
: $this->profileurl;
}
Event::handle('EndUserGroupHomeUrl', array($this->getGroup(), $url));
} elseif ($this->isLocal()) {
$url = common_local_url('showstream', array('nickname' => $this->getNickname()));
} else {
$url = $this->profileurl;
}
2016-01-09 21:33:30 +09:00
if (empty($url) ||
!filter_var($url, FILTER_VALIDATE_URL)) {
throw new InvalidUrlException($url);
}
2016-01-09 21:33:30 +09:00
return $url;
}
public function getHtmlTitle()
{
try {
return $this->getAcctUri(false);
} catch (ProfileNoAcctUriException $e) {
return $this->getNickname();
}
}
public function getNickname()
{
return $this->nickname;
}
public function getFullname()
{
return $this->fullname;
}
public function getHomepage()
{
return $this->homepage;
}
public function getDescription()
{
return $this->bio;
}
2010-02-17 13:13:39 +09:00
/**
* Returns the best URI for a profile. Plugins may override.
*
* @return string $uri
*/
public function getUri()
{
2010-02-17 13:13:39 +09:00
$uri = null;
// give plugins a chance to set the URI
if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
// check for a local user first
$user = User::getKV('id', $this->id);
if ($user instanceof User) {
$uri = $user->getUri();
} else {
$group = User_group::getKV('profile_id', $this->id);
if ($group instanceof User_group) {
$uri = $group->getUri();
}
}
Squashed commit of the following: Move OMB to a plugin commit 75d21f00246bcc56d7f854936be1e28395e079a2 Merge: cea0199 d594d07 Author: Zach Copley <zach@status.net> Date: Fri Jul 15 11:16:54 2011 -0700 Merge branch 'kill-omb2' of gitorious.org:~zcopley/statusnet/zcopleys-clone into kill-omb2 * 'kill-omb2' of gitorious.org:~zcopley/statusnet/zcopleys-clone: Fix paths Oops, I left out the ability to authorize a token in ApiStatusNetOAuthDataStore Some odds and ends Remove omb stuff from queuemanager defaults Add check to make sure we're not untagging an OMB profile to OMB plugin Move some more subscription stuff and peopletag checks to OMB plugin Move some OMB-specific unsubscribe stuff to OMB plugin Finish removing libomb from core extlibs Fix more conflicts Fix queuing/queuehandling Move some stuff around; fix references Fix conflicts Move OMB-specific files to OMB plugin Move some stuff around; fix references Add OMB plugin README and rm references to OMB in mail StatusNet README Update paths Fix define Basic plugin finished Move OMB-specific files to OMB plugin Remove OMB stuff from router commit cea019967f343042ebaea14b7bbb0d54289bcc1a Author: Zach Copley <zach@status.net> Date: Wed Jul 13 14:38:40 2011 -0700 Fix paths commit d412aa3c0ea0e21e65a72a16c7b9edd64ff373e1 Author: Zach Copley <zach@status.net> Date: Tue Jul 12 18:17:06 2011 -0700 Oops, I left out the ability to authorize a token in ApiStatusNetOAuthDataStore commit b459c9f10ac283d6e774ef13f3293fc8a6948143 Author: Zach Copley <zach@status.net> Date: Wed Jul 6 19:02:08 2011 -0700 Some odds and ends commit 895cfbfce58ffb3a05beebf48a90c549e00f1cce Author: Zach Copley <zach@status.net> Date: Wed Jul 6 19:01:23 2011 -0700 Remove omb stuff from queuemanager defaults commit b41b9e994f291ff83afb2460d9b37aee8ec1ec2b Author: Zach Copley <zach@status.net> Date: Wed Jul 6 18:46:44 2011 -0700 Add check to make sure we're not untagging an OMB profile to OMB plugin commit 94374d26ddd428dac8e4cd4541fd56db748c248b Author: Zach Copley <zach@status.net> Date: Wed Jul 6 18:34:20 2011 -0700 Move some more subscription stuff and peopletag checks to OMB plugin commit b91043b7820d5cd8b0ba4e9ee2a9d03c99248f11 Author: Zach Copley <zach@status.net> Date: Wed Jul 6 16:37:25 2011 -0700 Move some OMB-specific unsubscribe stuff to OMB plugin commit d9430fe52975d9497b4a0d3d54da35b222e207ad Author: Zach Copley <zach@status.net> Date: Wed Jul 6 15:26:30 2011 -0700 Finish removing libomb from core extlibs commit bb6257eb85cc7ba392e91468c01503f51faeb989 Author: Zach Copley <zach@status.net> Date: Wed Jul 13 12:47:32 2011 -0700 Fix more conflicts commit 3c760d0a4b4a083ae5fca2530d22aad5f4a9fdae Author: Zach Copley <zach@status.net> Date: Tue Jul 5 15:49:22 2011 -0700 Fix queuing/queuehandling commit ed635fa0c20e150673709c04ecc7f285d12e0ce2 Author: Zach Copley <zach@status.net> Date: Tue Jul 5 15:29:35 2011 -0700 Move some stuff around; fix references commit cbc553a147941cad16e205a6b66ab4b32a5e3d3d Author: Zach Copley <zach@status.net> Date: Wed Jul 13 12:46:05 2011 -0700 Fix conflicts commit 5d77c81f75b57f5d5357d6b46d503650a4b3225d Author: Zach Copley <zach@status.net> Date: Thu Jun 30 19:10:38 2011 -0700 Move OMB-specific files to OMB plugin commit 2ed051dbce0ce9b44723b14922026849c39ed603 Author: Zach Copley <zach@status.net> Date: Tue Jul 5 15:29:35 2011 -0700 Move some stuff around; fix references commit 8809b5e35b1aacb67d70ae3e55a43003b6f591b7 Author: Zach Copley <zach@status.net> Date: Tue Jul 5 15:28:59 2011 -0700 Add OMB plugin README and rm references to OMB in mail StatusNet README commit 35ced4067c1915baca0b3e184f9533a91a951d2d Author: Zach Copley <zach@status.net> Date: Thu Jun 30 23:50:09 2011 -0700 Update paths commit 0ee5bafbce95fc9b8db98c1e828d33d26d08bc73 Author: Zach Copley <zach@status.net> Date: Thu Jun 30 23:38:03 2011 -0700 Fix define commit e309dd22ffb9087d7fcf9180ede4f531dbd88c3c Author: Zach Copley <zach@status.net> Date: Thu Jun 30 23:30:43 2011 -0700 Basic plugin finished commit 00f1e930f27e080b04d1e82952f7886c84e01d97 Author: Zach Copley <zach@status.net> Date: Thu Jun 30 19:10:38 2011 -0700 Move OMB-specific files to OMB plugin commit 39dcd031a79b49da0b4fe25f1594d2e406b5eb65 Author: Zach Copley <zach@status.net> Date: Thu Jun 30 19:10:01 2011 -0700 Remove OMB stuff from router commit d594d071be1ec42518dd5465db61e01e7e8ec036 Author: Zach Copley <zach@status.net> Date: Wed Jul 13 14:38:40 2011 -0700 Fix paths commit 48c1064b4b50e89cf51d2cab388f708f60601247 Author: Zach Copley <zach@status.net> Date: Tue Jul 12 18:17:06 2011 -0700 Oops, I left out the ability to authorize a token in ApiStatusNetOAuthDataStore commit 1e1168978f38c31dbf0206b3493b2b6dcbe61589 Author: Zach Copley <zach@status.net> Date: Wed Jul 6 19:02:08 2011 -0700 Some odds and ends commit ac43af2b497d8b9286c49a9469a1dff950e41650 Author: Zach Copley <zach@status.net> Date: Wed Jul 6 19:01:23 2011 -0700 Remove omb stuff from queuemanager defaults commit 2471af2f8800515a3db544b3a186a18f3e8a43af Author: Zach Copley <zach@status.net> Date: Wed Jul 6 18:46:44 2011 -0700 Add check to make sure we're not untagging an OMB profile to OMB plugin commit df974646459ac6d5d97a40d008f1aab66f998226 Author: Zach Copley <zach@status.net> Date: Wed Jul 6 18:34:20 2011 -0700 Move some more subscription stuff and peopletag checks to OMB plugin commit 8a1427b759e791c14a7a7a22128ba05f0b4b6d12 Author: Zach Copley <zach@status.net> Date: Wed Jul 6 16:37:25 2011 -0700 Move some OMB-specific unsubscribe stuff to OMB plugin commit bd24220dbb5170af22ea0dea8a3062e6d1aeb6a2 Author: Zach Copley <zach@status.net> Date: Wed Jul 6 15:26:30 2011 -0700 Finish removing libomb from core extlibs commit 4c3c6f1fabb0f2c92635ccc5e8f38db2293f5456 Author: Zach Copley <zach@status.net> Date: Wed Jul 13 12:47:32 2011 -0700 Fix more conflicts commit db44deefd731a412685c5669c4c6fa69833de922 Author: Zach Copley <zach@status.net> Date: Tue Jul 5 15:49:22 2011 -0700 Fix queuing/queuehandling commit ea2d84d2f3d518950d3aa1956ddc8f3a25ca55f3 Author: Zach Copley <zach@status.net> Date: Tue Jul 5 15:29:35 2011 -0700 Move some stuff around; fix references commit 8ac3e010444b41bd9a78766f5e37e49dff023b45 Author: Zach Copley <zach@status.net> Date: Wed Jul 13 12:46:05 2011 -0700 Fix conflicts commit 0aad6e10e3637b3189a87b42c24c1d6de1b346bc Author: Zach Copley <zach@status.net> Date: Thu Jun 30 19:10:38 2011 -0700 Move OMB-specific files to OMB plugin commit d982d7076c5cb28c7b8e4b1dde8d07d7e58e278f Author: Zach Copley <zach@status.net> Date: Tue Jul 5 15:29:35 2011 -0700 Move some stuff around; fix references commit 4b9d39c93562ff4c45c37c940013e8b78197dec1 Author: Zach Copley <zach@status.net> Date: Tue Jul 5 15:28:59 2011 -0700 Add OMB plugin README and rm references to OMB in mail StatusNet README commit dab0fb6647a85e6835298496d7127a398b6b9293 Author: Zach Copley <zach@status.net> Date: Thu Jun 30 23:50:09 2011 -0700 Update paths commit 2cb73dac8ad971f1545dcf6ba57746c777e232ef Author: Zach Copley <zach@status.net> Date: Thu Jun 30 23:38:03 2011 -0700 Fix define commit 6f226b18a059f175b1bdd3abcb8cb95eedc22ee7 Author: Zach Copley <zach@status.net> Date: Thu Jun 30 23:30:43 2011 -0700 Basic plugin finished commit 7be304beaa0f39755c3978e0b852fde768950da4 Author: Zach Copley <zach@status.net> Date: Thu Jun 30 19:10:38 2011 -0700 Move OMB-specific files to OMB plugin commit 5b30da01cfa2802d6e7a4a4a4f39b8043c54f472 Author: Zach Copley <zach@status.net> Date: Thu Jun 30 19:10:01 2011 -0700 Remove OMB stuff from router
2011-07-16 04:13:57 +09:00
Event::handle('EndGetProfileUri', array($this, &$uri));
}
2010-02-17 13:13:39 +09:00
return $uri;
}
/**
* Returns an assumed acct: URI for a profile. Plugins are required.
*
* @return string $uri
*/
public function getAcctUri($scheme=true)
{
$acct = null;
if (Event::handle('StartGetProfileAcctUri', array($this, &$acct))) {
Event::handle('EndGetProfileAcctUri', array($this, &$acct));
}
if ($acct === null) {
throw new ProfileNoAcctUriException($this);
}
if (parse_url($acct, PHP_URL_SCHEME) !== 'acct') {
throw new ServerException('Acct URI does not have acct: scheme');
}
// if we don't return the scheme, just remove the 'acct:' in the beginning
return $scheme ? $acct : mb_substr($acct, 5);
}
public function hasBlocked(Profile $other)
{
$block = Profile_block::exists($this, $other);
return !empty($block);
}
2010-08-04 07:50:21 +09:00
public function getAtomFeed()
2010-08-04 07:50:21 +09:00
{
$feed = null;
if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
if ($this->isLocal()) {
$feed = common_local_url('ApiTimelineUser', array('id' => $this->getID(),
2010-08-04 07:50:21 +09:00
'format' => 'atom'));
}
Event::handle('EndProfileGetAtomFeed', array($this, $feed));
}
return $feed;
}
public function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
{
// TRANS: Exception thrown when trying view "repeated to me".
throw new Exception(_('Not implemented since inbox change.'));
}
/*
* Get a Profile object by URI. Will call external plugins for help
* using the event StartGetProfileFromURI.
*
* @param string $uri A unique identifier for a resource (profile/group/whatever)
*/
public static function fromUri($uri)
{
$profile = null;
if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
// Get a local user when plugin lookup (like OStatus) fails
$user = User::getKV('uri', $uri);
if ($user instanceof User) {
$profile = $user->getProfile();
2016-01-09 22:36:47 +09:00
} else {
$group = User_group::getKV('uri', $uri);
if ($group instanceof User_group) {
$profile = $group->getProfile();
}
}
Event::handle('EndGetProfileFromURI', array($uri, $profile));
}
if (!$profile instanceof Profile) {
throw new UnknownUriException($uri);
}
return $profile;
}
public function canRead(Notice $notice)
{
if ($notice->scope & Notice::SITE_SCOPE) {
$user = $this->getUser();
if (empty($user)) {
return false;
}
}
if ($notice->scope & Notice::ADDRESSEE_SCOPE) {
$replies = $notice->getReplies();
if (!in_array($this->id, $replies)) {
$groups = $notice->getGroups();
$foundOne = false;
foreach ($groups as $group) {
if ($this->isMember($group)) {
$foundOne = true;
break;
}
}
if (!$foundOne) {
return false;
}
}
}
if ($notice->scope & Notice::FOLLOWER_SCOPE) {
$author = $notice->getProfile();
if (!Subscription::exists($this, $author)) {
return false;
}
}
return true;
}
public static function current()
{
$user = common_current_user();
if (empty($user)) {
$profile = null;
} else {
$profile = $user->getProfile();
}
return $profile;
}
2011-04-19 07:23:06 +09:00
public static function ensureCurrent()
{
$profile = self::current();
if (!$profile instanceof Profile) {
throw new AuthorizationException('A currently scoped profile is required.');
}
return $profile;
}
2011-04-19 07:23:06 +09:00
/**
* Magic function called at serialize() time.
*
* We use this to drop a couple process-specific references
* from DB_DataObject which can cause trouble in future
* processes.
*
* @return array of variable names to include in serialization.
*/
public function __sleep()
2011-04-19 07:23:06 +09:00
{
$vars = parent::__sleep();
$skip = array('_user', '_group');
2011-04-19 07:23:06 +09:00
return array_diff($vars, $skip);
}
public function getProfile()
{
return $this;
}
2014-04-30 03:37:58 +09:00
/**
* Test whether the given profile is the same as the current class,
* for testing identities.
*
* @param Profile $other The other profile, usually from Action's $this->scoped
*
* @return boolean
*/
public function sameAs(Profile $other=null)
2015-07-10 19:19:08 +09:00
{
if (is_null($other)) {
// In case $this->scoped is null or something, i.e. not a current/legitimate profile.
return false;
}
2015-07-10 19:19:08 +09:00
return $this->getID() === $other->getID();
}
2014-04-30 03:37:58 +09:00
/**
* This will perform shortenLinks with the connected User object.
*
* Won't work on remote profiles or groups, so expect a
* NoSuchUserException if you don't know it's a local User.
*
* @param string $text String to shorten
* @param boolean $always Disrespect minimum length etc.
*
* @return string link-shortened $text
*/
public function shortenLinks($text, $always=false)
{
return $this->getUser()->shortenLinks($text, $always);
}
public function isPrivateStream(): bool
{
// We only know of public remote users as of yet...
if (!$this->isLocal()) {
return false;
}
$private_stream = $this->getUser()->private_stream;
return !is_null($private_stream) && $private_stream;
}
public function delPref($namespace, $topic)
{
return Profile_prefs::setData($this, $namespace, $topic, null);
}
public function getPref($namespace, $topic, $default = null)
{
// If you want an exception to be thrown, call Profile_prefs::getData directly
try {
return Profile_prefs::getData($this, $namespace, $topic, $default);
} catch (NoResultException $e) {
return null;
}
}
// The same as getPref but will fall back to common_config value for the same namespace/topic
public function getConfigPref($namespace, $topic)
{
return Profile_prefs::getConfigData($this, $namespace, $topic);
}
public function setPref($namespace, $topic, $data)
{
return Profile_prefs::setData($this, $namespace, $topic, $data);
}
public function getConnectedApps($offset=0, $limit=null)
{
return $this->getUser()->getConnectedApps($offset, $limit);
}
}