3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008-2011, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('GNUSOCIAL')) { exit(1); }
23 * Table Definition for profile
25 class Profile extends Managed_DataObject
27 public $__table = 'profile'; // table name
28 public $id; // int(4) primary_key not_null
29 public $nickname; // varchar(64) multiple_key not_null
30 public $fullname; // text()
31 public $profileurl; // text()
32 public $homepage; // text()
33 public $bio; // text() multiple_key
34 public $location; // text()
35 public $lat; // decimal(10,7)
36 public $lon; // decimal(10,7)
37 public $location_id; // int(4)
38 public $location_ns; // int(4)
39 public $created; // datetime() not_null
40 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
42 public static function schemaDef()
45 'description' => 'local and remote users have profiles',
47 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
48 'nickname' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'nickname or username', 'collate' => 'utf8mb4_general_ci'),
49 'fullname' => array('type' => 'text', 'description' => 'display name', 'collate' => 'utf8mb4_general_ci'),
50 'profileurl' => array('type' => 'text', 'description' => 'URL, cached so we dont regenerate'),
51 'homepage' => array('type' => 'text', 'description' => 'identifying URL', 'collate' => 'utf8mb4_general_ci'),
52 'bio' => array('type' => 'text', 'description' => 'descriptive biography', 'collate' => 'utf8mb4_general_ci'),
53 'location' => array('type' => 'text', 'description' => 'physical location', 'collate' => 'utf8mb4_general_ci'),
54 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'),
55 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'),
56 'location_id' => array('type' => 'int', 'description' => 'location id if possible'),
57 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'),
59 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
60 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
62 'primary key' => array('id'),
64 'profile_nickname_idx' => array('nickname'),
68 // Add a fulltext index
70 if (common_config('search', 'type') == 'fulltext') {
71 $def['fulltext indexes'] = array('nickname' => array('nickname', 'fullname', 'location', 'bio', 'homepage'));
77 public static function getByEmail($email)
79 // in the future, profiles should have emails stored...
80 $user = User::getKV('email', $email);
81 if (!($user instanceof User)) {
82 throw new NoSuchUserException(array('email'=>$email));
84 return $user->getProfile();
87 protected $_user = array();
89 public function getUser()
91 if (!isset($this->_user[$this->id])) {
92 $user = User::getKV('id', $this->id);
93 if (!$user instanceof User) {
94 throw new NoSuchUserException(array('id'=>$this->id));
96 $this->_user[$this->id] = $user;
98 return $this->_user[$this->id];
101 protected $_group = array();
103 public function getGroup()
105 if (!isset($this->_group[$this->id])) {
106 $group = User_group::getKV('profile_id', $this->id);
107 if (!$group instanceof User_group) {
108 throw new NoSuchGroupException(array('profile_id'=>$this->id));
110 $this->_group[$this->id] = $group;
112 return $this->_group[$this->id];
115 public function isGroup()
120 } catch (NoSuchGroupException $e) {
125 public function isPerson()
127 // Maybe other things than PERSON and GROUP can have Profiles in the future?
128 return !$this->isGroup();
131 public function isLocal()
135 } catch (NoSuchUserException $e) {
141 // Returns false if the user has no password (which will always
142 // be the case for remote users). This can be the case for OpenID
143 // logins or other mechanisms which don't store a password hash.
144 public function hasPassword()
147 return $this->getUser()->hasPassword();
148 } catch (NoSuchUserException $e) {
153 public function getObjectType()
155 // FIXME: More types... like peopletags and whatever
156 if ($this->isGroup()) {
157 return ActivityObject::GROUP;
159 return ActivityObject::PERSON;
163 public function getAvatar($width, $height=null)
165 return Avatar::byProfile($this, $width, $height);
168 public function setOriginal($filename)
170 if ($this->isGroup()) {
171 // Until Group avatars are handled just like profile avatars.
172 return $this->getGroup()->setOriginal($filename);
175 $imagefile = new ImageFile(null, Avatar::path($filename));
177 $avatar = new Avatar();
178 $avatar->profile_id = $this->id;
179 $avatar->width = $imagefile->width;
180 $avatar->height = $imagefile->height;
181 $avatar->mediatype = image_type_to_mime_type($imagefile->type);
182 $avatar->filename = $filename;
183 $avatar->original = true;
184 $avatar->created = common_sql_now();
186 // XXX: start a transaction here
187 if (!Avatar::deleteFromProfile($this, true) || !$avatar->insert()) {
188 // If we can't delete the old avatars, let's abort right here.
189 @unlink(Avatar::path($filename));
197 * Gets either the full name (if filled) or the nickname.
201 function getBestName()
203 return ($this->fullname) ? $this->fullname : $this->nickname;
207 * Takes the currently scoped profile into account to give a name
208 * to list in notice streams. Preferences may differ between profiles.
210 function getStreamName()
212 $user = common_current_user();
213 if ($user instanceof User && $user->streamNicknames()) {
214 return $this->nickname;
217 return $this->getBestName();
221 * Gets the full name (if filled) with acct URI, URL, or URI as a
222 * parenthetical (in that order, for each not found). If no full
223 * name is found only the second part is returned, without ()s.
227 function getFancyName()
231 $uri = $this->getAcctUri(false);
232 } catch (ProfileNoAcctUriException $e) {
234 $uri = $this->getUrl();
235 } catch (InvalidUrlException $e) {
236 $uri = $this->getUri();
240 if (mb_strlen($this->getFullname()) > 0) {
241 // TRANS: The "fancy name": Full name of a profile or group (%1$s) followed by some URI (%2$s) in parentheses.
242 return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->getFullname(), $uri);
249 * Get the most recent notice posted by this user, if any.
251 * @return mixed Notice or null
253 function getCurrentNotice(Profile $scoped=null)
256 $notice = $this->getNotices(0, 1, 0, 0, $scoped);
258 if ($notice->fetch()) {
259 if ($notice instanceof ArrayWrapper) {
260 // hack for things trying to work with single notices
261 // ...but this shouldn't happen anymore I think. Keeping it for safety...
262 return $notice->_items[0];
266 } catch (PrivateStreamException $e) {
267 // Maybe we should let this through if it's handled well upstream
274 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
276 return Reply::stream($this->getID(), $offset, $limit, $since_id, $before_id);
279 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
281 //FIXME: Get Profile::current() some other way to avoid possible
282 // confusion between current session profile and background processing.
283 $stream = new TaggedProfileNoticeStream($this, $tag, Profile::current());
285 return $stream->getNotices($offset, $limit, $since_id, $max_id);
288 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0, Profile $scoped=null)
290 $stream = new ProfileNoticeStream($this, $scoped);
292 return $stream->getNotices($offset, $limit, $since_id, $max_id);
295 function isMember(User_group $group)
297 $groups = $this->getGroups(0, null);
298 while ($groups instanceof User_group && $groups->fetch()) {
299 if ($groups->id == $group->id) {
306 function isAdmin(User_group $group)
308 $gm = Group_member::pkeyGet(array('profile_id' => $this->id,
309 'group_id' => $group->id));
310 return (!empty($gm) && $gm->is_admin);
313 function isPendingMember($group)
315 $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
316 'group_id' => $group->id));
317 return !empty($request);
320 function getGroups($offset=0, $limit=PROFILES_PER_PAGE)
324 $keypart = sprintf('profile:groups:%d', $this->id);
326 $idstring = self::cacheGet($keypart);
328 if ($idstring !== false) {
329 $ids = explode(',', $idstring);
331 $gm = new Group_member();
333 $gm->profile_id = $this->id;
336 while ($gm->fetch()) {
337 $ids[] = $gm->group_id;
341 self::cacheSet($keypart, implode(',', $ids));
344 if (!is_null($offset) && !is_null($limit)) {
345 $ids = array_slice($ids, $offset, $limit);
349 return User_group::multiGet('id', $ids);
350 } catch (NoResultException $e) {
351 return null; // throw exception when we handle it everywhere
355 function getGroupCount() {
356 $groups = $this->getGroups(0, null);
357 return $groups instanceof User_group
362 function isTagged($peopletag)
364 $tag = Profile_tag::pkeyGet(array('tagger' => $peopletag->tagger,
365 'tagged' => $this->id,
366 'tag' => $peopletag->tag));
370 function canTag($tagged)
372 if (empty($tagged)) {
376 if ($tagged->id == $this->id) {
380 $all = common_config('peopletag', 'allow_tagging', 'all');
381 $local = common_config('peopletag', 'allow_tagging', 'local');
382 $remote = common_config('peopletag', 'allow_tagging', 'remote');
383 $subs = common_config('peopletag', 'allow_tagging', 'subs');
389 $tagged_user = $tagged->getUser();
390 if (!empty($tagged_user)) {
395 return (Subscription::exists($this, $tagged) ||
396 Subscription::exists($tagged, $this));
397 } else if ($remote) {
403 function getLists(Profile $scoped=null, $offset=0, $limit=null, $since_id=0, $max_id=0)
407 $keypart = sprintf('profile:lists:%d', $this->id);
409 $idstr = self::cacheGet($keypart);
411 if ($idstr !== false) {
412 $ids = explode(',', $idstr);
414 $list = new Profile_list();
416 $list->selectAdd('id');
417 $list->tagger = $this->id;
418 $list->selectAdd('id as "cursor"');
421 $list->whereAdd('id > '.$since_id);
425 $list->whereAdd('id <= '.$max_id);
428 if($offset>=0 && !is_null($limit)) {
429 $list->limit($offset, $limit);
432 $list->orderBy('id DESC');
435 while ($list->fetch()) {
440 self::cacheSet($keypart, implode(',', $ids));
443 $showPrivate = $this->sameAs($scoped);
447 foreach ($ids as $id) {
448 $list = Profile_list::getKV('id', $id);
450 ($showPrivate || !$list->private)) {
452 if (!isset($list->cursor)) {
453 $list->cursor = $list->id;
460 return new ArrayWrapper($lists);
464 * Get tags that other people put on this profile, in reverse-chron order
466 * @param Profile $scoped User we are requesting as
467 * @param int $offset Offset from latest
468 * @param int $limit Max number to get
469 * @param datetime $since_id max date
470 * @param datetime $max_id min date
472 * @return Profile_list resulting lists
475 function getOtherTags(Profile $scoped=null, $offset=0, $limit=null, $since_id=0, $max_id=0)
477 $list = new Profile_list();
479 $qry = sprintf('select profile_list.*, unix_timestamp(profile_tag.modified) as "cursor" ' .
480 'from profile_tag join profile_list '.
481 'on (profile_tag.tagger = profile_list.tagger ' .
482 ' and profile_tag.tag = profile_list.tag) ' .
483 'where profile_tag.tagged = %d ',
487 if (!is_null($scoped)) {
488 $qry .= sprintf('AND ( ( profile_list.private = false ) ' .
489 'OR ( profile_list.tagger = %d AND ' .
490 'profile_list.private = true ) )',
493 $qry .= 'AND profile_list.private = 0 ';
497 $qry .= sprintf('AND (cursor > %d) ', $since_id);
501 $qry .= sprintf('AND (cursor < %d) ', $max_id);
504 $qry .= 'ORDER BY profile_tag.modified DESC ';
506 if ($offset >= 0 && !is_null($limit)) {
507 $qry .= sprintf('LIMIT %d OFFSET %d ', $limit, $offset);
514 function getPrivateTags($offset=0, $limit=null, $since_id=0, $max_id=0)
516 $tags = new Profile_list();
517 $tags->private = true;
518 $tags->tagger = $this->id;
521 $tags->whereAdd('id > '.$since_id);
525 $tags->whereAdd('id <= '.$max_id);
528 if($offset>=0 && !is_null($limit)) {
529 $tags->limit($offset, $limit);
532 $tags->orderBy('id DESC');
538 function hasLocalTags()
540 $tags = new Profile_tag();
542 $tags->joinAdd(array('tagger', 'user:id'));
543 $tags->whereAdd('tagged = '.$this->id);
544 $tags->whereAdd('tagger != '.$this->id);
549 return ($tags->N == 0) ? false : true;
552 function getTagSubscriptions($offset=0, $limit=null, $since_id=0, $max_id=0)
554 $lists = new Profile_list();
555 $subs = new Profile_tag_subscription();
557 $lists->joinAdd(array('id', 'profile_tag_subscription:profile_tag_id'));
559 #@fixme: postgres (round(date_part('epoch', my_date)))
560 $lists->selectAdd('unix_timestamp(profile_tag_subscription.created) as "cursor"');
562 $lists->whereAdd('profile_tag_subscription.profile_id = '.$this->id);
565 $lists->whereAdd('cursor > '.$since_id);
569 $lists->whereAdd('cursor <= '.$max_id);
572 if($offset>=0 && !is_null($limit)) {
573 $lists->limit($offset, $limit);
576 $lists->orderBy('"cursor" DESC');
583 * Request to join the given group.
584 * May throw exceptions on failure.
586 * @param User_group $group
587 * @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
589 function joinGroup(User_group $group)
592 if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
593 $join = Group_join_queue::saveNew($this, $group);
595 if (Event::handle('StartJoinGroup', array($group, $this))) {
596 $join = Group_member::join($group->id, $this->id);
597 self::blow('profile:groups:%d', $this->id);
598 self::blow('group:member_ids:%d', $group->id);
599 self::blow('group:member_count:%d', $group->id);
600 Event::handle('EndJoinGroup', array($group, $this));
604 // Send any applicable notifications...
611 * Leave a group that this profile is a member of.
613 * @param User_group $group
615 function leaveGroup(User_group $group)
617 if (Event::handle('StartLeaveGroup', array($group, $this))) {
618 Group_member::leave($group->id, $this->id);
619 self::blow('profile:groups:%d', $this->id);
620 self::blow('group:member_ids:%d', $group->id);
621 self::blow('group:member_count:%d', $group->id);
622 Event::handle('EndLeaveGroup', array($group, $this));
626 function avatarUrl($size=AVATAR_PROFILE_SIZE)
628 return Avatar::urlByProfile($this, $size);
631 function getSubscribed($offset=0, $limit=null)
633 $subs = Subscription::getSubscribedIDs($this->id, $offset, $limit);
635 $profiles = Profile::multiGet('id', $subs);
636 } catch (NoResultException $e) {
642 function getSubscribers($offset=0, $limit=null)
644 $subs = Subscription::getSubscriberIDs($this->id, $offset, $limit);
646 $profiles = Profile::multiGet('id', $subs);
647 } catch (NoResultException $e) {
653 function getTaggedSubscribers($tag, $offset=0, $limit=null)
656 'SELECT profile.* ' .
657 'FROM profile JOIN subscription ' .
658 'ON profile.id = subscription.subscriber ' .
659 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
660 'AND profile_tag.tagger = subscription.subscribed) ' .
661 'WHERE subscription.subscribed = %d ' .
662 "AND profile_tag.tag = '%s' " .
663 'AND subscription.subscribed != subscription.subscriber ' .
664 'ORDER BY subscription.created DESC ';
667 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
670 $profile = new Profile();
672 $cnt = $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
677 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
680 'SELECT profile.* ' .
681 'FROM profile JOIN subscription ' .
682 'ON profile.id = subscription.subscribed ' .
683 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
684 'AND profile_tag.tagger = subscription.subscriber) ' .
685 'WHERE subscription.subscriber = %d ' .
686 "AND profile_tag.tag = '%s' " .
687 'AND subscription.subscribed != subscription.subscriber ' .
688 'ORDER BY subscription.created DESC ';
690 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
692 $profile = new Profile();
694 $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
700 * Get pending subscribers, who have not yet been approved.
706 function getRequests($offset=0, $limit=null)
709 $subqueue = new Profile();
710 $subqueue->joinAdd(array('id', 'subscription_queue:subscriber'));
711 $subqueue->whereAdd(sprintf('subscription_queue.subscribed = %d', $this->getID()));
712 $subqueue->limit($offset, $limit);
713 $subqueue->orderBy('subscription_queue.created', 'DESC');
714 if (!$subqueue->find()) {
715 throw new NoResultException($subqueue);
720 function subscriptionCount()
722 $c = Cache::instance();
725 $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
726 if (is_integer($cnt)) {
731 $sub = new Subscription();
732 $sub->subscriber = $this->id;
734 $cnt = (int) $sub->count('distinct subscribed');
736 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
739 $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
745 function subscriberCount()
747 $c = Cache::instance();
749 $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
750 if (is_integer($cnt)) {
755 $sub = new Subscription();
756 $sub->subscribed = $this->id;
757 $sub->whereAdd('subscriber != subscribed');
758 $cnt = (int) $sub->count('distinct subscriber');
761 $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
768 * Is this profile subscribed to another profile?
770 * @param Profile $other
773 function isSubscribed(Profile $other)
775 return Subscription::exists($this, $other);
778 function readableBy(Profile $other=null)
780 // If it's not a private stream, it's readable by anyone
781 if (!$this->isPrivateStream()) {
785 // If it's a private stream, $other must be a subscriber to $this
786 return is_null($other) ? false : $other->isSubscribed($this);
789 function requiresSubscriptionApproval(Profile $other=null)
791 if (!$this->isLocal()) {
792 // We don't know for remote users, and we'll always be able to send
793 // the request. Whether it'll work immediately or require moderation
794 // can be determined in another function.
798 // Assume that profiles _we_ subscribe to are permitted. Could be made configurable.
799 if (!is_null($other) && $this->isSubscribed($other)) {
803 // If the local user either has a private stream (implies the following)
804 // or user has a moderation policy for new subscriptions, return true.
805 return $this->getUser()->private_stream || $this->getUser()->subscribe_policy === User::SUBSCRIBE_POLICY_MODERATE;
809 * Check if a pending subscription request is outstanding for this...
811 * @param Profile $other
814 function hasPendingSubscription(Profile $other)
816 return Subscription_queue::exists($this, $other);
820 * Are these two profiles subscribed to each other?
822 * @param Profile $other
825 function mutuallySubscribed(Profile $other)
827 return $this->isSubscribed($other) &&
828 $other->isSubscribed($this);
831 function noticeCount()
833 $c = Cache::instance();
836 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->getID()));
837 if (is_integer($cnt)) {
842 $notices = new Notice();
843 $notices->profile_id = $this->getID();
844 $notices->verb = ActivityVerb::POST;
845 $cnt = (int) $notices->count('id'); // Not sure if I imagine this, but 'id' was faster than the defaulting 'uri'?
848 $c->set(Cache::key('profile:notice_count:'.$this->getID()), $cnt);
854 function blowSubscriberCount()
856 $c = Cache::instance();
858 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
862 function blowSubscriptionCount()
864 $c = Cache::instance();
866 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
870 function blowNoticeCount()
872 $c = Cache::instance();
874 $c->delete(Cache::key('profile:notice_count:'.$this->id));
878 static function maxBio()
880 $biolimit = common_config('profile', 'biolimit');
881 // null => use global limit (distinct from 0!)
882 if (is_null($biolimit)) {
883 $biolimit = common_config('site', 'textlimit');
888 static function bioTooLong($bio)
890 $biolimit = self::maxBio();
891 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
894 function update($dataObject=false)
896 if (is_object($dataObject) && $this->nickname != $dataObject->nickname) {
898 $local = $this->getUser();
899 common_debug("Updating User ({$this->id}) nickname from {$dataObject->nickname} to {$this->nickname}");
900 $origuser = clone($local);
901 $local->nickname = $this->nickname;
902 // updateWithKeys throws exception on failure.
903 $local->updateWithKeys($origuser);
905 // Clear the site owner, in case nickname changed
906 if ($local->hasRole(Profile_role::OWNER)) {
907 User::blow('user:site_owner');
909 } catch (NoSuchUserException $e) {
914 return parent::update($dataObject);
917 public function getRelSelf()
919 return ['href' => $this->getUrl(),
920 'text' => common_config('site', 'name'),
921 'image' => Avatar::urlByProfile($this)];
924 // All the known rel="me", used for the IndieWeb audience
925 public function getRelMes()
929 $relMes[] = $this->getRelSelf();
930 } catch (InvalidUrlException $e) {
931 // no valid profile URL available
933 if (common_valid_http_url($this->getHomepage())) {
934 $relMes[] = ['href' => $this->getHomepage(),
935 'text' => _('Homepage'),
938 Event::handle('OtherAccountProfiles', array($this, &$relMes));
942 function delete($useWhere=false)
944 // just in case it hadn't been done before... (usually set before adding deluser to queue handling!)
945 if (!$this->hasRole(Profile_role::DELETED)) {
946 $this->grantRole(Profile_role::DELETED);
949 $this->_deleteNotices();
950 $this->_deleteSubscriptions();
951 $this->_deleteTags();
952 $this->_deleteBlocks();
953 $this->_deleteAttentions();
954 Avatar::deleteFromProfile($this, true);
956 // Warning: delete() will run on the batch objects,
957 // not on individual objects.
958 $related = array('Reply',
961 Event::handle('ProfileDeleteRelated', array($this, &$related));
963 foreach ($related as $cls) {
965 $inst->profile_id = $this->id;
969 $localuser = User::getKV('id', $this->id);
970 if ($localuser instanceof User) {
971 $localuser->delete();
974 return parent::delete($useWhere);
977 function _deleteNotices()
979 $notice = new Notice();
980 $notice->profile_id = $this->id;
982 if ($notice->find()) {
983 while ($notice->fetch()) {
984 $other = clone($notice);
990 function _deleteSubscriptions()
992 $sub = new Subscription();
993 $sub->subscriber = $this->getID();
996 while ($sub->fetch()) {
998 $other = $sub->getSubscribed();
999 if (!$other->sameAs($this)) {
1000 Subscription::cancel($this, $other);
1002 } catch (NoResultException $e) {
1003 // Profile not found
1004 common_log(LOG_INFO, 'Subscribed profile id=='.$sub->subscribed.' not found when deleting profile id=='.$this->getID().', ignoring...');
1005 } catch (ServerException $e) {
1006 // Subscription cancel failed
1007 common_log(LOG_INFO, 'Subscribed profile id=='.$other->getID().' could not be reached for unsubscription notice when deleting profile id=='.$this->getID().', ignoring...');
1011 $sub = new Subscription();
1012 $sub->subscribed = $this->getID();
1015 while ($sub->fetch()) {
1017 $other = $sub->getSubscriber();
1018 common_log(LOG_INFO, 'Subscriber profile id=='.$sub->subscribed.' not found when deleting profile id=='.$this->getID().', ignoring...');
1019 if (!$other->sameAs($this)) {
1020 Subscription::cancel($other, $this);
1022 } catch (NoResultException $e) {
1023 // Profile not found
1024 common_log(LOG_INFO, 'Subscribed profile id=='.$sub->subscribed.' not found when deleting profile id=='.$this->getID().', ignoring...');
1025 } catch (ServerException $e) {
1026 // Subscription cancel failed
1027 common_log(LOG_INFO, 'Subscriber profile id=='.$other->getID().' could not be reached for unsubscription notice when deleting profile id=='.$this->getID().', ignoring...');
1031 // Finally delete self-subscription
1032 $self = new Subscription();
1033 $self->subscriber = $this->getID();
1034 $self->subscribed = $this->getID();
1038 function _deleteTags()
1040 $tag = new Profile_tag();
1041 $tag->tagged = $this->id;
1045 function _deleteBlocks()
1047 $block = new Profile_block();
1048 $block->blocked = $this->id;
1051 $block = new Group_block();
1052 $block->blocked = $this->id;
1056 function _deleteAttentions()
1058 $att = new Attention();
1059 $att->profile_id = $this->getID();
1062 while ($att->fetch()) {
1063 // Can't do delete() on the object directly since it won't remove all of it
1064 $other = clone($att);
1070 // XXX: identical to Notice::getLocation.
1072 public function getLocation()
1076 if (!empty($this->location_id) && !empty($this->location_ns)) {
1077 $location = Location::fromId($this->location_id, $this->location_ns);
1080 if (is_null($location)) { // no ID, or Location::fromId() failed
1081 if (!empty($this->lat) && !empty($this->lon)) {
1082 $location = Location::fromLatLon($this->lat, $this->lon);
1086 if (is_null($location)) { // still haven't found it!
1087 if (!empty($this->location)) {
1088 $location = Location::fromName($this->location);
1095 public function shareLocation()
1097 $cfg = common_config('location', 'share');
1099 if ($cfg == 'always') {
1101 } else if ($cfg == 'never') {
1104 $share = common_config('location', 'sharedefault');
1106 // Check if user has a personal setting for this
1107 $prefs = User_location_prefs::getKV('user_id', $this->id);
1109 if (!empty($prefs)) {
1110 $share = $prefs->share_location;
1118 function hasRole($name)
1121 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
1122 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1124 $has_role = !empty($role);
1125 Event::handle('EndHasRole', array($this, $name, $has_role));
1130 function grantRole($name)
1132 if (Event::handle('StartGrantRole', array($this, $name))) {
1134 $role = new Profile_role();
1136 $role->profile_id = $this->id;
1137 $role->role = $name;
1138 $role->created = common_sql_now();
1140 $result = $role->insert();
1143 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
1146 if ($name == 'owner') {
1147 User::blow('user:site_owner');
1150 Event::handle('EndGrantRole', array($this, $name));
1156 function revokeRole($name)
1158 if (Event::handle('StartRevokeRole', array($this, $name))) {
1160 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1164 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
1165 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1166 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
1169 $result = $role->delete();
1172 common_log_db_error($role, 'DELETE', __FILE__);
1173 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
1174 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1175 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
1178 if ($name == 'owner') {
1179 User::blow('user:site_owner');
1182 Event::handle('EndRevokeRole', array($this, $name));
1188 function isSandboxed()
1190 return $this->hasRole(Profile_role::SANDBOXED);
1193 function isSilenced()
1195 return $this->hasRole(Profile_role::SILENCED);
1200 $this->grantRole(Profile_role::SANDBOXED);
1203 function unsandbox()
1205 $this->revokeRole(Profile_role::SANDBOXED);
1210 $this->grantRole(Profile_role::SILENCED);
1211 if (common_config('notice', 'hidespam')) {
1212 $this->flushVisibility();
1216 function silenceAs(Profile $actor)
1218 if (!$actor->hasRight(Right::SILENCEUSER)) {
1219 throw new AuthorizationException(_('You cannot silence users on this site.'));
1221 // Only administrators can silence other privileged users (such as others who have the right to silence).
1222 if ($this->isPrivileged() && !$actor->hasRole(Profile_role::ADMINISTRATOR)) {
1223 throw new AuthorizationException(_('You cannot silence other privileged users.'));
1225 if ($this->isSilenced()) {
1226 // TRANS: Client error displayed trying to silence an already silenced user.
1227 throw new AlreadyFulfilledException(_('User is already silenced.'));
1229 return $this->silence();
1232 function unsilence()
1234 $this->revokeRole(Profile_role::SILENCED);
1235 if (common_config('notice', 'hidespam')) {
1236 $this->flushVisibility();
1240 function unsilenceAs(Profile $actor)
1242 if (!$actor->hasRight(Right::SILENCEUSER)) {
1243 // TRANS: Client error displayed trying to unsilence a user when the user does not have the right.
1244 throw new AuthorizationException(_('You cannot unsilence users on this site.'));
1246 if (!$this->isSilenced()) {
1247 // TRANS: Client error displayed trying to unsilence a user when the target user has not been silenced.
1248 throw new AlreadyFulfilledException(_('User is not silenced.'));
1250 return $this->unsilence();
1253 function flushVisibility()
1256 $stream = new ProfileNoticeStream($this, $this);
1257 $ids = $stream->getNoticeIds(0, CachingNoticeStream::CACHE_WINDOW);
1258 foreach ($ids as $id) {
1259 self::blow('notice:in-scope-for:%d:null', $id);
1263 public function isPrivileged()
1265 // TODO: An Event::handle so plugins can report if users are privileged.
1266 // The ModHelper is the only one I care about when coding this, and that
1267 // can be tested with Right::SILENCEUSER which I do below:
1269 case $this->hasRight(Right::SILENCEUSER):
1270 case $this->hasRole(Profile_role::MODERATOR):
1271 case $this->hasRole(Profile_role::ADMINISTRATOR):
1272 case $this->hasRole(Profile_role::OWNER):
1280 * Does this user have the right to do X?
1282 * With our role-based authorization, this is merely a lookup for whether the user
1283 * has a particular role. The implementation currently uses a switch statement
1284 * to determine if the user has the pre-defined role to exercise the right. Future
1285 * implementations may allow per-site roles, and different mappings of roles to rights.
1287 * @param $right string Name of the right, usually a constant in class Right
1288 * @return boolean whether the user has the right in question
1290 public function hasRight($right)
1294 if ($this->hasRole(Profile_role::DELETED)) {
1298 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
1301 case Right::DELETEOTHERSNOTICE:
1302 case Right::MAKEGROUPADMIN:
1303 case Right::SANDBOXUSER:
1304 case Right::SILENCEUSER:
1305 case Right::DELETEUSER:
1306 case Right::DELETEGROUP:
1307 case Right::TRAINSPAM:
1308 case Right::REVIEWSPAM:
1309 $result = $this->hasRole(Profile_role::MODERATOR);
1311 case Right::CONFIGURESITE:
1312 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
1314 case Right::GRANTROLE:
1315 case Right::REVOKEROLE:
1316 $result = $this->hasRole(Profile_role::OWNER);
1318 case Right::NEWNOTICE:
1319 case Right::NEWMESSAGE:
1320 case Right::SUBSCRIBE:
1321 case Right::CREATEGROUP:
1322 $result = !$this->isSilenced();
1324 case Right::PUBLICNOTICE:
1325 case Right::EMAILONREPLY:
1326 case Right::EMAILONSUBSCRIBE:
1327 case Right::EMAILONFAVE:
1328 $result = !$this->isSandboxed() && !$this->isSilenced();
1330 case Right::WEBLOGIN:
1331 $result = !$this->isSilenced();
1334 $result = !$this->isSilenced();
1336 case Right::BACKUPACCOUNT:
1337 $result = common_config('profile', 'backup');
1339 case Right::RESTOREACCOUNT:
1340 $result = common_config('profile', 'restore');
1342 case Right::DELETEACCOUNT:
1343 $result = common_config('profile', 'delete');
1345 case Right::MOVEACCOUNT:
1346 $result = common_config('profile', 'move');
1356 // FIXME: Can't put Notice typing here due to ArrayWrapper
1357 public function hasRepeated($notice)
1359 // XXX: not really a pkey, but should work
1361 $notice = Notice::pkeyGet(array('profile_id' => $this->getID(),
1362 'repeat_of' => $notice->getID(),
1363 'verb' => ActivityVerb::SHARE));
1365 return !empty($notice);
1369 * Returns an XML string fragment with limited profile information
1370 * as an Atom <author> element.
1372 * Assumes that Atom has been previously set up as the base namespace.
1374 * @param Profile $cur the current authenticated user
1378 function asAtomAuthor($cur = null)
1380 $xs = new XMLStringer(true);
1382 $xs->elementStart('author');
1383 $xs->element('name', null, $this->nickname);
1384 $xs->element('uri', null, $this->getUri());
1387 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1388 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
1389 $xs->element('statusnet:profile_info', $attrs, null);
1391 $xs->elementEnd('author');
1393 return $xs->getString();
1397 * Extra profile info for atom entries
1399 * Clients use some extra profile info in the atom stream.
1400 * This gives it to them.
1402 * @param Profile $scoped The currently logged in/scoped profile
1404 * @return array representation of <statusnet:profile_info> element or null
1407 function profileInfo(Profile $scoped=null)
1409 $profileInfoAttr = array('local_id' => $this->id);
1411 if ($scoped instanceof Profile) {
1412 // Whether the current user is a subscribed to this profile
1413 $profileInfoAttr['following'] = $scoped->isSubscribed($this) ? 'true' : 'false';
1414 // Whether the current user is has blocked this profile
1415 $profileInfoAttr['blocking'] = $scoped->hasBlocked($this) ? 'true' : 'false';
1418 return array('statusnet:profile_info', $profileInfoAttr, null);
1422 * Returns an XML string fragment with profile information as an
1423 * Activity Streams <activity:actor> element.
1425 * Assumes that 'activity' namespace has been previously defined.
1429 function asActivityActor()
1431 return $this->asActivityNoun('actor');
1435 * Returns an XML string fragment with profile information as an
1436 * Activity Streams noun object with the given element type.
1438 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1439 * previously defined.
1441 * @param string $element one of 'actor', 'subject', 'object', 'target'
1445 function asActivityNoun($element)
1447 $noun = $this->asActivityObject();
1448 return $noun->asString('activity:' . $element);
1451 public function asActivityObject()
1453 $object = new ActivityObject();
1455 if (Event::handle('StartActivityObjectFromProfile', array($this, &$object))) {
1456 $object->type = $this->getObjectType();
1457 $object->id = $this->getUri();
1458 $object->title = $this->getBestName();
1459 $object->link = $this->getUrl();
1460 $object->summary = $this->getDescription();
1463 $avatar = Avatar::getUploaded($this);
1464 $object->avatarLinks[] = AvatarLink::fromAvatar($avatar);
1465 } catch (NoAvatarException $e) {
1466 // Could not find an original avatar to link
1470 AVATAR_PROFILE_SIZE,
1475 foreach ($sizes as $size) {
1478 $avatar = Avatar::byProfile($this, $size);
1479 $alink = AvatarLink::fromAvatar($avatar);
1480 } catch (NoAvatarException $e) {
1481 $alink = new AvatarLink();
1482 $alink->type = 'image/png';
1483 $alink->height = $size;
1484 $alink->width = $size;
1485 $alink->url = Avatar::defaultImage($size);
1488 $object->avatarLinks[] = $alink;
1491 if (isset($this->lat) && isset($this->lon)) {
1492 $object->geopoint = (float)$this->lat
1493 . ' ' . (float)$this->lon;
1496 $object->poco = PoCo::fromProfile($this);
1498 if ($this->isLocal()) {
1499 $object->extra[] = array('followers', array('url' => common_local_url('subscribers', array('nickname' => $this->getNickname()))));
1502 Event::handle('EndActivityObjectFromProfile', array($this, &$object));
1509 * Returns the profile's canonical url, not necessarily a uri/unique id
1511 * @return string $profileurl
1513 public function getUrl()
1516 if ($this->isGroup()) {
1517 // FIXME: Get rid of this event, it fills no real purpose, data should be in Profile->profileurl (replaces User_group->mainpage)
1518 if (Event::handle('StartUserGroupHomeUrl', array($this->getGroup(), &$url))) {
1519 $url = $this->getGroup()->isLocal()
1520 ? common_local_url('showgroup', array('nickname' => $this->getNickname()))
1521 : $this->profileurl;
1523 Event::handle('EndUserGroupHomeUrl', array($this->getGroup(), $url));
1524 } elseif ($this->isLocal()) {
1525 $url = common_local_url('showstream', array('nickname' => $this->getNickname()));
1527 $url = $this->profileurl;
1530 !filter_var($url, FILTER_VALIDATE_URL)) {
1531 throw new InvalidUrlException($url);
1536 public function getNickname()
1538 return $this->nickname;
1541 public function getFullname()
1543 return $this->fullname;
1546 public function getHomepage()
1548 return $this->homepage;
1551 public function getDescription()
1557 * Returns the best URI for a profile. Plugins may override.
1559 * @return string $uri
1561 public function getUri()
1565 // give plugins a chance to set the URI
1566 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1568 // check for a local user first
1569 $user = User::getKV('id', $this->id);
1570 if ($user instanceof User) {
1571 $uri = $user->getUri();
1573 $group = User_group::getKV('profile_id', $this->id);
1574 if ($group instanceof User_group) {
1575 $uri = $group->getUri();
1579 Event::handle('EndGetProfileUri', array($this, &$uri));
1586 * Returns an assumed acct: URI for a profile. Plugins are required.
1588 * @return string $uri
1590 public function getAcctUri($scheme=true)
1594 if (Event::handle('StartGetProfileAcctUri', array($this, &$acct))) {
1595 Event::handle('EndGetProfileAcctUri', array($this, &$acct));
1598 if ($acct === null) {
1599 throw new ProfileNoAcctUriException($this);
1601 if (parse_url($acct, PHP_URL_SCHEME) !== 'acct') {
1602 throw new ServerException('Acct URI does not have acct: scheme');
1605 // if we don't return the scheme, just remove the 'acct:' in the beginning
1606 return $scheme ? $acct : mb_substr($acct, 5);
1609 function hasBlocked(Profile $other)
1611 $block = Profile_block::exists($this, $other);
1612 return !empty($block);
1615 function getAtomFeed()
1619 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1620 $user = User::getKV('id', $this->id);
1621 if (!empty($user)) {
1622 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1623 'format' => 'atom'));
1625 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1631 public function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
1633 // TRANS: Exception thrown when trying view "repeated to me".
1634 throw new Exception(_('Not implemented since inbox change.'));
1638 * Get a Profile object by URI. Will call external plugins for help
1639 * using the event StartGetProfileFromURI.
1641 * @param string $uri A unique identifier for a resource (profile/group/whatever)
1643 static function fromUri($uri)
1647 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1648 // Get a local user when plugin lookup (like OStatus) fails
1649 $user = User::getKV('uri', $uri);
1650 if ($user instanceof User) {
1651 $profile = $user->getProfile();
1653 $group = User_group::getKV('uri', $uri);
1654 if ($group instanceof User_group) {
1655 $profile = $group->getProfile();
1658 Event::handle('EndGetProfileFromURI', array($uri, $profile));
1661 if (!$profile instanceof Profile) {
1662 throw new UnknownUriException($uri);
1668 function canRead(Notice $notice)
1670 if ($notice->scope & Notice::SITE_SCOPE) {
1671 $user = $this->getUser();
1677 if ($notice->scope & Notice::ADDRESSEE_SCOPE) {
1678 $replies = $notice->getReplies();
1680 if (!in_array($this->id, $replies)) {
1681 $groups = $notice->getGroups();
1685 foreach ($groups as $group) {
1686 if ($this->isMember($group)) {
1698 if ($notice->scope & Notice::FOLLOWER_SCOPE) {
1699 $author = $notice->getProfile();
1700 if (!Subscription::exists($this, $author)) {
1708 static function current()
1710 $user = common_current_user();
1714 $profile = $user->getProfile();
1719 static function ensureCurrent()
1721 $profile = self::current();
1722 if (!$profile instanceof Profile) {
1723 throw new AuthorizationException('A currently scoped profile is required.');
1729 * Magic function called at serialize() time.
1731 * We use this to drop a couple process-specific references
1732 * from DB_DataObject which can cause trouble in future
1735 * @return array of variable names to include in serialization.
1740 $vars = parent::__sleep();
1741 $skip = array('_user', '_group');
1742 return array_diff($vars, $skip);
1745 public function getProfile()
1751 * Test whether the given profile is the same as the current class,
1752 * for testing identities.
1754 * @param Profile $other The other profile, usually from Action's $this->scoped
1758 public function sameAs(Profile $other=null)
1760 if (is_null($other)) {
1761 // In case $this->scoped is null or something, i.e. not a current/legitimate profile.
1764 return $this->getID() === $other->getID();
1768 * This will perform shortenLinks with the connected User object.
1770 * Won't work on remote profiles or groups, so expect a
1771 * NoSuchUserException if you don't know it's a local User.
1773 * @param string $text String to shorten
1774 * @param boolean $always Disrespect minimum length etc.
1776 * @return string link-shortened $text
1778 public function shortenLinks($text, $always=false)
1780 return $this->getUser()->shortenLinks($text, $always);
1783 public function isPrivateStream()
1785 // We only know of public remote users as of yet...
1786 if (!$this->isLocal()) {
1789 return $this->getUser()->private_stream ? true : false;
1792 public function delPref($namespace, $topic) {
1793 return Profile_prefs::setData($this, $namespace, $topic, null);
1796 public function getPref($namespace, $topic, $default=null) {
1797 // If you want an exception to be thrown, call Profile_prefs::getData directly
1799 return Profile_prefs::getData($this, $namespace, $topic, $default);
1800 } catch (NoResultException $e) {
1805 // The same as getPref but will fall back to common_config value for the same namespace/topic
1806 public function getConfigPref($namespace, $topic)
1808 return Profile_prefs::getConfigData($this, $namespace, $topic);
1811 public function setPref($namespace, $topic, $data) {
1812 return Profile_prefs::setData($this, $namespace, $topic, $data);
1815 public function getConnectedApps($offset=0, $limit=null)
1817 return $this->getUser()->getConnectedApps($offset, $limit);