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 isLocal()
129 } catch (NoSuchUserException $e) {
135 // Returns false if the user has no password (which will always
136 // be the case for remote users). This can be the case for OpenID
137 // logins or other mechanisms which don't store a password hash.
138 public function hasPassword()
141 return $this->getUser()->hasPassword();
142 } catch (NoSuchUserException $e) {
147 public function getObjectType()
149 // FIXME: More types... like peopletags and whatever
150 if ($this->isGroup()) {
151 return ActivityObject::GROUP;
153 return ActivityObject::PERSON;
157 public function getAvatar($width, $height=null)
159 return Avatar::byProfile($this, $width, $height);
162 public function setOriginal($filename)
164 if ($this->isGroup()) {
165 // Until Group avatars are handled just like profile avatars.
166 return $this->getGroup()->setOriginal($filename);
169 $imagefile = new ImageFile(null, Avatar::path($filename));
171 $avatar = new Avatar();
172 $avatar->profile_id = $this->id;
173 $avatar->width = $imagefile->width;
174 $avatar->height = $imagefile->height;
175 $avatar->mediatype = image_type_to_mime_type($imagefile->type);
176 $avatar->filename = $filename;
177 $avatar->original = true;
178 $avatar->url = Avatar::url($filename);
179 $avatar->created = common_sql_now();
181 // XXX: start a transaction here
182 if (!Avatar::deleteFromProfile($this, true) || !$avatar->insert()) {
183 // If we can't delete the old avatars, let's abort right here.
184 @unlink(Avatar::path($filename));
192 * Gets either the full name (if filled) or the nickname.
196 function getBestName()
198 return ($this->fullname) ? $this->fullname : $this->nickname;
202 * Takes the currently scoped profile into account to give a name
203 * to list in notice streams. Preferences may differ between profiles.
205 function getStreamName()
207 $user = common_current_user();
208 if ($user instanceof User && $user->streamNicknames()) {
209 return $this->nickname;
212 return $this->getBestName();
216 * Gets the full name (if filled) with nickname as a parenthetical, or the nickname alone
217 * if no fullname is provided.
221 function getFancyName()
223 if ($this->fullname) {
224 // TRANS: Full name of a profile or group (%1$s) followed by nickname (%2$s) in parentheses.
225 return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->fullname, $this->nickname);
227 return $this->nickname;
232 * Get the most recent notice posted by this user, if any.
234 * @return mixed Notice or null
236 function getCurrentNotice(Profile $scoped=null)
239 $notice = $this->getNotices(0, 1, 0, 0, $scoped);
241 if ($notice->fetch()) {
242 if ($notice instanceof ArrayWrapper) {
243 // hack for things trying to work with single notices
244 // ...but this shouldn't happen anymore I think. Keeping it for safety...
245 return $notice->_items[0];
249 } catch (PrivateStreamException $e) {
250 // Maybe we should let this through if it's handled well upstream
257 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
259 return Reply::stream($this->getID(), $offset, $limit, $since_id, $before_id);
262 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
264 $stream = new TaggedProfileNoticeStream($this, $tag);
266 return $stream->getNotices($offset, $limit, $since_id, $max_id);
269 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0, Profile $scoped=null)
271 $stream = new ProfileNoticeStream($this, $scoped);
273 return $stream->getNotices($offset, $limit, $since_id, $max_id);
276 function isMember(User_group $group)
278 $groups = $this->getGroups(0, null);
279 while ($groups instanceof User_group && $groups->fetch()) {
280 if ($groups->id == $group->id) {
287 function isAdmin(User_group $group)
289 $gm = Group_member::pkeyGet(array('profile_id' => $this->id,
290 'group_id' => $group->id));
291 return (!empty($gm) && $gm->is_admin);
294 function isPendingMember($group)
296 $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
297 'group_id' => $group->id));
298 return !empty($request);
301 function getGroups($offset=0, $limit=PROFILES_PER_PAGE)
305 $keypart = sprintf('profile:groups:%d', $this->id);
307 $idstring = self::cacheGet($keypart);
309 if ($idstring !== false) {
310 $ids = explode(',', $idstring);
312 $gm = new Group_member();
314 $gm->profile_id = $this->id;
317 while ($gm->fetch()) {
318 $ids[] = $gm->group_id;
322 self::cacheSet($keypart, implode(',', $ids));
325 if (!is_null($offset) && !is_null($limit)) {
326 $ids = array_slice($ids, $offset, $limit);
330 return User_group::multiGet('id', $ids);
331 } catch (NoResultException $e) {
332 return null; // throw exception when we handle it everywhere
336 function getGroupCount() {
337 $groups = $this->getGroups(0, null);
338 return $groups instanceof User_group
343 function isTagged($peopletag)
345 $tag = Profile_tag::pkeyGet(array('tagger' => $peopletag->tagger,
346 'tagged' => $this->id,
347 'tag' => $peopletag->tag));
351 function canTag($tagged)
353 if (empty($tagged)) {
357 if ($tagged->id == $this->id) {
361 $all = common_config('peopletag', 'allow_tagging', 'all');
362 $local = common_config('peopletag', 'allow_tagging', 'local');
363 $remote = common_config('peopletag', 'allow_tagging', 'remote');
364 $subs = common_config('peopletag', 'allow_tagging', 'subs');
370 $tagged_user = $tagged->getUser();
371 if (!empty($tagged_user)) {
376 return (Subscription::exists($this, $tagged) ||
377 Subscription::exists($tagged, $this));
378 } else if ($remote) {
384 function getLists(Profile $scoped=null, $offset=0, $limit=null, $since_id=0, $max_id=0)
388 $keypart = sprintf('profile:lists:%d', $this->id);
390 $idstr = self::cacheGet($keypart);
392 if ($idstr !== false) {
393 $ids = explode(',', $idstr);
395 $list = new Profile_list();
397 $list->selectAdd('id');
398 $list->tagger = $this->id;
399 $list->selectAdd('id as "cursor"');
402 $list->whereAdd('id > '.$since_id);
406 $list->whereAdd('id <= '.$max_id);
409 if($offset>=0 && !is_null($limit)) {
410 $list->limit($offset, $limit);
413 $list->orderBy('id DESC');
416 while ($list->fetch()) {
421 self::cacheSet($keypart, implode(',', $ids));
424 $showPrivate = $this->sameAs($scoped);
428 foreach ($ids as $id) {
429 $list = Profile_list::getKV('id', $id);
431 ($showPrivate || !$list->private)) {
433 if (!isset($list->cursor)) {
434 $list->cursor = $list->id;
441 return new ArrayWrapper($lists);
445 * Get tags that other people put on this profile, in reverse-chron order
447 * @param Profile $scoped User we are requesting as
448 * @param int $offset Offset from latest
449 * @param int $limit Max number to get
450 * @param datetime $since_id max date
451 * @param datetime $max_id min date
453 * @return Profile_list resulting lists
456 function getOtherTags(Profile $scoped=null, $offset=0, $limit=null, $since_id=0, $max_id=0)
458 $list = new Profile_list();
460 $qry = sprintf('select profile_list.*, unix_timestamp(profile_tag.modified) as "cursor" ' .
461 'from profile_tag join profile_list '.
462 'on (profile_tag.tagger = profile_list.tagger ' .
463 ' and profile_tag.tag = profile_list.tag) ' .
464 'where profile_tag.tagged = %d ',
468 if (!is_null($scoped)) {
469 $qry .= sprintf('AND ( ( profile_list.private = false ) ' .
470 'OR ( profile_list.tagger = %d AND ' .
471 'profile_list.private = true ) )',
474 $qry .= 'AND profile_list.private = 0 ';
478 $qry .= sprintf('AND (cursor > %d) ', $since_id);
482 $qry .= sprintf('AND (cursor < %d) ', $max_id);
485 $qry .= 'ORDER BY profile_tag.modified DESC ';
487 if ($offset >= 0 && !is_null($limit)) {
488 $qry .= sprintf('LIMIT %d OFFSET %d ', $limit, $offset);
495 function getPrivateTags($offset=0, $limit=null, $since_id=0, $max_id=0)
497 $tags = new Profile_list();
498 $tags->private = true;
499 $tags->tagger = $this->id;
502 $tags->whereAdd('id > '.$since_id);
506 $tags->whereAdd('id <= '.$max_id);
509 if($offset>=0 && !is_null($limit)) {
510 $tags->limit($offset, $limit);
513 $tags->orderBy('id DESC');
519 function hasLocalTags()
521 $tags = new Profile_tag();
523 $tags->joinAdd(array('tagger', 'user:id'));
524 $tags->whereAdd('tagged = '.$this->id);
525 $tags->whereAdd('tagger != '.$this->id);
530 return ($tags->N == 0) ? false : true;
533 function getTagSubscriptions($offset=0, $limit=null, $since_id=0, $max_id=0)
535 $lists = new Profile_list();
536 $subs = new Profile_tag_subscription();
538 $lists->joinAdd(array('id', 'profile_tag_subscription:profile_tag_id'));
540 #@fixme: postgres (round(date_part('epoch', my_date)))
541 $lists->selectAdd('unix_timestamp(profile_tag_subscription.created) as "cursor"');
543 $lists->whereAdd('profile_tag_subscription.profile_id = '.$this->id);
546 $lists->whereAdd('cursor > '.$since_id);
550 $lists->whereAdd('cursor <= '.$max_id);
553 if($offset>=0 && !is_null($limit)) {
554 $lists->limit($offset, $limit);
557 $lists->orderBy('"cursor" DESC');
564 * Request to join the given group.
565 * May throw exceptions on failure.
567 * @param User_group $group
568 * @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
570 function joinGroup(User_group $group)
573 if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
574 $join = Group_join_queue::saveNew($this, $group);
576 if (Event::handle('StartJoinGroup', array($group, $this))) {
577 $join = Group_member::join($group->id, $this->id);
578 self::blow('profile:groups:%d', $this->id);
579 self::blow('group:member_ids:%d', $group->id);
580 self::blow('group:member_count:%d', $group->id);
581 Event::handle('EndJoinGroup', array($group, $this));
585 // Send any applicable notifications...
592 * Leave a group that this profile is a member of.
594 * @param User_group $group
596 function leaveGroup(User_group $group)
598 if (Event::handle('StartLeaveGroup', array($group, $this))) {
599 Group_member::leave($group->id, $this->id);
600 self::blow('profile:groups:%d', $this->id);
601 self::blow('group:member_ids:%d', $group->id);
602 self::blow('group:member_count:%d', $group->id);
603 Event::handle('EndLeaveGroup', array($group, $this));
607 function avatarUrl($size=AVATAR_PROFILE_SIZE)
609 return Avatar::urlByProfile($this, $size);
612 function getSubscribed($offset=0, $limit=null)
614 $subs = Subscription::getSubscribedIDs($this->id, $offset, $limit);
616 $profiles = Profile::multiGet('id', $subs);
617 } catch (NoResultException $e) {
623 function getSubscribers($offset=0, $limit=null)
625 $subs = Subscription::getSubscriberIDs($this->id, $offset, $limit);
627 $profiles = Profile::multiGet('id', $subs);
628 } catch (NoResultException $e) {
634 function getTaggedSubscribers($tag, $offset=0, $limit=null)
637 'SELECT profile.* ' .
638 'FROM profile JOIN subscription ' .
639 'ON profile.id = subscription.subscriber ' .
640 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
641 'AND profile_tag.tagger = subscription.subscribed) ' .
642 'WHERE subscription.subscribed = %d ' .
643 "AND profile_tag.tag = '%s' " .
644 'AND subscription.subscribed != subscription.subscriber ' .
645 'ORDER BY subscription.created DESC ';
648 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
651 $profile = new Profile();
653 $cnt = $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
658 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
661 'SELECT profile.* ' .
662 'FROM profile JOIN subscription ' .
663 'ON profile.id = subscription.subscribed ' .
664 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
665 'AND profile_tag.tagger = subscription.subscriber) ' .
666 'WHERE subscription.subscriber = %d ' .
667 "AND profile_tag.tag = '%s' " .
668 'AND subscription.subscribed != subscription.subscriber ' .
669 'ORDER BY subscription.created DESC ';
671 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
673 $profile = new Profile();
675 $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
681 * Get pending subscribers, who have not yet been approved.
687 function getRequests($offset=0, $limit=null)
690 $subqueue = new Profile();
691 $subqueue->joinAdd(array('id', 'subscription_queue:subscriber'));
692 $subqueue->whereAdd(sprintf('subscription_queue.subscribed = %d', $this->getID()));
693 $subqueue->limit($offset, $limit);
694 $subqueue->orderBy('subscription_queue.created', 'DESC');
695 if (!$subqueue->find()) {
696 throw new NoResultException($subqueue);
701 function subscriptionCount()
703 $c = Cache::instance();
706 $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
707 if (is_integer($cnt)) {
712 $sub = new Subscription();
713 $sub->subscriber = $this->id;
715 $cnt = (int) $sub->count('distinct subscribed');
717 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
720 $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
726 function subscriberCount()
728 $c = Cache::instance();
730 $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
731 if (is_integer($cnt)) {
736 $sub = new Subscription();
737 $sub->subscribed = $this->id;
738 $sub->whereAdd('subscriber != subscribed');
739 $cnt = (int) $sub->count('distinct subscriber');
742 $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
749 * Is this profile subscribed to another profile?
751 * @param Profile $other
754 function isSubscribed(Profile $other)
756 return Subscription::exists($this, $other);
759 function readableBy(Profile $other=null)
761 // If it's not a private stream, it's readable by anyone
762 if (!$this->isPrivateStream()) {
766 // If it's a private stream, $other must be a subscriber to $this
767 return is_null($other) ? false : $other->isSubscribed($this);
770 function requiresSubscriptionApproval(Profile $other=null)
772 if (!$this->isLocal()) {
773 // We don't know for remote users, and we'll always be able to send
774 // the request. Whether it'll work immediately or require moderation
775 // can be determined in another function.
779 // Assume that profiles _we_ subscribe to are permitted. Could be made configurable.
780 if (!is_null($other) && $this->isSubscribed($other)) {
784 // If the local user either has a private stream (implies the following)
785 // or user has a moderation policy for new subscriptions, return true.
786 return $this->getUser()->private_stream || $this->getUser()->subscribe_policy === User::SUBSCRIBE_POLICY_MODERATE;
790 * Check if a pending subscription request is outstanding for this...
792 * @param Profile $other
795 function hasPendingSubscription(Profile $other)
797 return Subscription_queue::exists($this, $other);
801 * Are these two profiles subscribed to each other?
803 * @param Profile $other
806 function mutuallySubscribed(Profile $other)
808 return $this->isSubscribed($other) &&
809 $other->isSubscribed($this);
812 function noticeCount()
814 $c = Cache::instance();
817 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
818 if (is_integer($cnt)) {
823 $notices = new Notice();
824 $notices->profile_id = $this->id;
825 $cnt = (int) $notices->count('distinct id');
828 $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
834 function blowSubscriberCount()
836 $c = Cache::instance();
838 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
842 function blowSubscriptionCount()
844 $c = Cache::instance();
846 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
850 function blowNoticeCount()
852 $c = Cache::instance();
854 $c->delete(Cache::key('profile:notice_count:'.$this->id));
858 static function maxBio()
860 $biolimit = common_config('profile', 'biolimit');
861 // null => use global limit (distinct from 0!)
862 if (is_null($biolimit)) {
863 $biolimit = common_config('site', 'textlimit');
868 static function bioTooLong($bio)
870 $biolimit = self::maxBio();
871 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
874 function update($dataObject=false)
876 if (is_object($dataObject) && $this->nickname != $dataObject->nickname) {
878 $local = $this->getUser();
879 common_debug("Updating User ({$this->id}) nickname from {$dataObject->nickname} to {$this->nickname}");
880 $origuser = clone($local);
881 $local->nickname = $this->nickname;
882 // updateWithKeys throws exception on failure.
883 $local->updateWithKeys($origuser);
885 // Clear the site owner, in case nickname changed
886 if ($local->hasRole(Profile_role::OWNER)) {
887 User::blow('user:site_owner');
889 } catch (NoSuchUserException $e) {
894 return parent::update($dataObject);
897 function delete($useWhere=false)
899 // just in case it hadn't been done before... (usually set before adding deluser to queue handling!)
900 if (!$this->hasRole(Profile_role::DELETED)) {
901 $this->grantRole(Profile_role::DELETED);
904 $this->_deleteNotices();
905 $this->_deleteSubscriptions();
906 $this->_deleteTags();
907 $this->_deleteBlocks();
908 $this->_deleteAttentions();
909 Avatar::deleteFromProfile($this, true);
911 // Warning: delete() will run on the batch objects,
912 // not on individual objects.
913 $related = array('Reply',
916 Event::handle('ProfileDeleteRelated', array($this, &$related));
918 foreach ($related as $cls) {
920 $inst->profile_id = $this->id;
924 $localuser = User::getKV('id', $this->id);
925 if ($localuser instanceof User) {
926 $localuser->delete();
929 return parent::delete($useWhere);
932 function _deleteNotices()
934 $notice = new Notice();
935 $notice->profile_id = $this->id;
937 if ($notice->find()) {
938 while ($notice->fetch()) {
939 $other = clone($notice);
945 function _deleteSubscriptions()
947 $sub = new Subscription();
948 $sub->subscriber = $this->getID();
951 while ($sub->fetch()) {
953 $other = $sub->getSubscribed();
954 if (!$other->sameAs($this)) {
955 Subscription::cancel($this, $other);
957 } catch (NoResultException $e) {
959 common_log(LOG_INFO, 'Subscribed profile id=='.$sub->subscribed.' not found when deleting profile id=='.$this->getID().', ignoring...');
960 } catch (ServerException $e) {
961 // Subscription cancel failed
962 common_log(LOG_INFO, 'Subscribed profile id=='.$other->getID().' could not be reached for unsubscription notice when deleting profile id=='.$this->getID().', ignoring...');
966 $sub = new Subscription();
967 $sub->subscribed = $this->getID();
970 while ($sub->fetch()) {
972 $other = $sub->getSubscriber();
973 common_log(LOG_INFO, 'Subscriber profile id=='.$sub->subscribed.' not found when deleting profile id=='.$this->getID().', ignoring...');
974 if (!$other->sameAs($this)) {
975 Subscription::cancel($other, $this);
977 } catch (NoResultException $e) {
979 common_log(LOG_INFO, 'Subscribed profile id=='.$sub->subscribed.' not found when deleting profile id=='.$this->getID().', ignoring...');
980 } catch (ServerException $e) {
981 // Subscription cancel failed
982 common_log(LOG_INFO, 'Subscriber profile id=='.$other->getID().' could not be reached for unsubscription notice when deleting profile id=='.$this->getID().', ignoring...');
986 // Finally delete self-subscription
987 $self = new Subscription();
988 $self->subscriber = $this->getID();
989 $self->subscribed = $this->getID();
993 function _deleteTags()
995 $tag = new Profile_tag();
996 $tag->tagged = $this->id;
1000 function _deleteBlocks()
1002 $block = new Profile_block();
1003 $block->blocked = $this->id;
1006 $block = new Group_block();
1007 $block->blocked = $this->id;
1011 function _deleteAttentions()
1013 $att = new Attention();
1014 $att->profile_id = $this->getID();
1017 while ($att->fetch()) {
1018 // Can't do delete() on the object directly since it won't remove all of it
1019 $other = clone($att);
1025 // XXX: identical to Notice::getLocation.
1027 public function getLocation()
1031 if (!empty($this->location_id) && !empty($this->location_ns)) {
1032 $location = Location::fromId($this->location_id, $this->location_ns);
1035 if (is_null($location)) { // no ID, or Location::fromId() failed
1036 if (!empty($this->lat) && !empty($this->lon)) {
1037 $location = Location::fromLatLon($this->lat, $this->lon);
1041 if (is_null($location)) { // still haven't found it!
1042 if (!empty($this->location)) {
1043 $location = Location::fromName($this->location);
1050 public function shareLocation()
1052 $cfg = common_config('location', 'share');
1054 if ($cfg == 'always') {
1056 } else if ($cfg == 'never') {
1059 $share = common_config('location', 'sharedefault');
1061 // Check if user has a personal setting for this
1062 $prefs = User_location_prefs::getKV('user_id', $this->id);
1064 if (!empty($prefs)) {
1065 $share = $prefs->share_location;
1073 function hasRole($name)
1076 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
1077 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1079 $has_role = !empty($role);
1080 Event::handle('EndHasRole', array($this, $name, $has_role));
1085 function grantRole($name)
1087 if (Event::handle('StartGrantRole', array($this, $name))) {
1089 $role = new Profile_role();
1091 $role->profile_id = $this->id;
1092 $role->role = $name;
1093 $role->created = common_sql_now();
1095 $result = $role->insert();
1098 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
1101 if ($name == 'owner') {
1102 User::blow('user:site_owner');
1105 Event::handle('EndGrantRole', array($this, $name));
1111 function revokeRole($name)
1113 if (Event::handle('StartRevokeRole', array($this, $name))) {
1115 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1119 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
1120 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1121 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
1124 $result = $role->delete();
1127 common_log_db_error($role, 'DELETE', __FILE__);
1128 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
1129 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1130 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
1133 if ($name == 'owner') {
1134 User::blow('user:site_owner');
1137 Event::handle('EndRevokeRole', array($this, $name));
1143 function isSandboxed()
1145 return $this->hasRole(Profile_role::SANDBOXED);
1148 function isSilenced()
1150 return $this->hasRole(Profile_role::SILENCED);
1155 $this->grantRole(Profile_role::SANDBOXED);
1158 function unsandbox()
1160 $this->revokeRole(Profile_role::SANDBOXED);
1165 $this->grantRole(Profile_role::SILENCED);
1166 if (common_config('notice', 'hidespam')) {
1167 $this->flushVisibility();
1171 function unsilence()
1173 $this->revokeRole(Profile_role::SILENCED);
1174 if (common_config('notice', 'hidespam')) {
1175 $this->flushVisibility();
1179 function flushVisibility()
1182 $stream = new ProfileNoticeStream($this, $this);
1183 $ids = $stream->getNoticeIds(0, CachingNoticeStream::CACHE_WINDOW);
1184 foreach ($ids as $id) {
1185 self::blow('notice:in-scope-for:%d:null', $id);
1190 * Does this user have the right to do X?
1192 * With our role-based authorization, this is merely a lookup for whether the user
1193 * has a particular role. The implementation currently uses a switch statement
1194 * to determine if the user has the pre-defined role to exercise the right. Future
1195 * implementations may allow per-site roles, and different mappings of roles to rights.
1197 * @param $right string Name of the right, usually a constant in class Right
1198 * @return boolean whether the user has the right in question
1200 public function hasRight($right)
1204 if ($this->hasRole(Profile_role::DELETED)) {
1208 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
1211 case Right::DELETEOTHERSNOTICE:
1212 case Right::MAKEGROUPADMIN:
1213 case Right::SANDBOXUSER:
1214 case Right::SILENCEUSER:
1215 case Right::DELETEUSER:
1216 case Right::DELETEGROUP:
1217 case Right::TRAINSPAM:
1218 case Right::REVIEWSPAM:
1219 $result = $this->hasRole(Profile_role::MODERATOR);
1221 case Right::CONFIGURESITE:
1222 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
1224 case Right::GRANTROLE:
1225 case Right::REVOKEROLE:
1226 $result = $this->hasRole(Profile_role::OWNER);
1228 case Right::NEWNOTICE:
1229 case Right::NEWMESSAGE:
1230 case Right::SUBSCRIBE:
1231 case Right::CREATEGROUP:
1232 $result = !$this->isSilenced();
1234 case Right::PUBLICNOTICE:
1235 case Right::EMAILONREPLY:
1236 case Right::EMAILONSUBSCRIBE:
1237 case Right::EMAILONFAVE:
1238 $result = !$this->isSandboxed();
1240 case Right::WEBLOGIN:
1241 $result = !$this->isSilenced();
1244 $result = !$this->isSilenced();
1246 case Right::BACKUPACCOUNT:
1247 $result = common_config('profile', 'backup');
1249 case Right::RESTOREACCOUNT:
1250 $result = common_config('profile', 'restore');
1252 case Right::DELETEACCOUNT:
1253 $result = common_config('profile', 'delete');
1255 case Right::MOVEACCOUNT:
1256 $result = common_config('profile', 'move');
1266 // FIXME: Can't put Notice typing here due to ArrayWrapper
1267 public function hasRepeated($notice)
1269 // XXX: not really a pkey, but should work
1271 $notice = Notice::pkeyGet(array('profile_id' => $this->getID(),
1272 'repeat_of' => $notice->getID(),
1273 'verb' => ActivityVerb::SHARE));
1275 return !empty($notice);
1279 * Returns an XML string fragment with limited profile information
1280 * as an Atom <author> element.
1282 * Assumes that Atom has been previously set up as the base namespace.
1284 * @param Profile $cur the current authenticated user
1288 function asAtomAuthor($cur = null)
1290 $xs = new XMLStringer(true);
1292 $xs->elementStart('author');
1293 $xs->element('name', null, $this->nickname);
1294 $xs->element('uri', null, $this->getUri());
1297 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1298 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
1299 $xs->element('statusnet:profile_info', $attrs, null);
1301 $xs->elementEnd('author');
1303 return $xs->getString();
1307 * Extra profile info for atom entries
1309 * Clients use some extra profile info in the atom stream.
1310 * This gives it to them.
1312 * @param Profile $scoped The currently logged in/scoped profile
1314 * @return array representation of <statusnet:profile_info> element or null
1317 function profileInfo(Profile $scoped=null)
1319 $profileInfoAttr = array('local_id' => $this->id);
1321 if ($scoped instanceof Profile) {
1322 // Whether the current user is a subscribed to this profile
1323 $profileInfoAttr['following'] = $scoped->isSubscribed($this) ? 'true' : 'false';
1324 // Whether the current user is has blocked this profile
1325 $profileInfoAttr['blocking'] = $scoped->hasBlocked($this) ? 'true' : 'false';
1328 return array('statusnet:profile_info', $profileInfoAttr, null);
1332 * Returns an XML string fragment with profile information as an
1333 * Activity Streams <activity:actor> element.
1335 * Assumes that 'activity' namespace has been previously defined.
1339 function asActivityActor()
1341 return $this->asActivityNoun('actor');
1345 * Returns an XML string fragment with profile information as an
1346 * Activity Streams noun object with the given element type.
1348 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1349 * previously defined.
1351 * @param string $element one of 'actor', 'subject', 'object', 'target'
1355 function asActivityNoun($element)
1357 $noun = $this->asActivityObject();
1358 return $noun->asString('activity:' . $element);
1361 public function asActivityObject()
1363 $object = new ActivityObject();
1365 if (Event::handle('StartActivityObjectFromProfile', array($this, &$object))) {
1366 $object->type = $this->getObjectType();
1367 $object->id = $this->getUri();
1368 $object->title = $this->getBestName();
1369 $object->link = $this->getUrl();
1370 $object->summary = $this->getDescription();
1373 $avatar = Avatar::getUploaded($this);
1374 $object->avatarLinks[] = AvatarLink::fromAvatar($avatar);
1375 } catch (NoAvatarException $e) {
1376 // Could not find an original avatar to link
1380 AVATAR_PROFILE_SIZE,
1385 foreach ($sizes as $size) {
1388 $avatar = Avatar::byProfile($this, $size);
1389 $alink = AvatarLink::fromAvatar($avatar);
1390 } catch (NoAvatarException $e) {
1391 $alink = new AvatarLink();
1392 $alink->type = 'image/png';
1393 $alink->height = $size;
1394 $alink->width = $size;
1395 $alink->url = Avatar::defaultImage($size);
1398 $object->avatarLinks[] = $alink;
1401 if (isset($this->lat) && isset($this->lon)) {
1402 $object->geopoint = (float)$this->lat
1403 . ' ' . (float)$this->lon;
1406 $object->poco = PoCo::fromProfile($this);
1408 if ($this->isLocal()) {
1409 $object->extra[] = array('followers', array('url' => common_local_url('subscribers', array('nickname' => $this->getNickname()))));
1412 Event::handle('EndActivityObjectFromProfile', array($this, &$object));
1419 * Returns the profile's canonical url, not necessarily a uri/unique id
1421 * @return string $profileurl
1423 public function getUrl()
1425 if (empty($this->profileurl) ||
1426 !filter_var($this->profileurl, FILTER_VALIDATE_URL)) {
1427 throw new InvalidUrlException($this->profileurl);
1429 return $this->profileurl;
1432 public function getNickname()
1434 return $this->nickname;
1437 public function getFullname()
1439 return $this->fullname;
1442 public function getHomepage()
1444 return $this->homepage;
1447 public function getDescription()
1453 * Returns the best URI for a profile. Plugins may override.
1455 * @return string $uri
1457 public function getUri()
1461 // give plugins a chance to set the URI
1462 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1464 // check for a local user first
1465 $user = User::getKV('id', $this->id);
1466 if ($user instanceof User) {
1467 $uri = $user->getUri();
1469 $group = User_group::getKV('profile_id', $this->id);
1470 if ($group instanceof User_group) {
1471 $uri = $group->getUri();
1475 Event::handle('EndGetProfileUri', array($this, &$uri));
1482 * Returns an assumed acct: URI for a profile. Plugins are required.
1484 * @return string $uri
1486 public function getAcctUri()
1490 if (Event::handle('StartGetProfileAcctUri', array($this, &$acct))) {
1491 Event::handle('EndGetProfileAcctUri', array($this, &$acct));
1494 if ($acct === null) {
1495 throw new ProfileNoAcctUriException($this);
1501 function hasBlocked($other)
1503 $block = Profile_block::exists($this, $other);
1504 return !empty($block);
1507 function getAtomFeed()
1511 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1512 $user = User::getKV('id', $this->id);
1513 if (!empty($user)) {
1514 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1515 'format' => 'atom'));
1517 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1523 public function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
1525 // TRANS: Exception thrown when trying view "repeated to me".
1526 throw new Exception(_('Not implemented since inbox change.'));
1530 * Get a Profile object by URI. Will call external plugins for help
1531 * using the event StartGetProfileFromURI.
1533 * @param string $uri A unique identifier for a resource (profile/group/whatever)
1535 static function fromUri($uri)
1539 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1540 // Get a local user when plugin lookup (like OStatus) fails
1541 $user = User::getKV('uri', $uri);
1542 if ($user instanceof User) {
1543 $profile = $user->getProfile();
1545 Event::handle('EndGetProfileFromURI', array($uri, $profile));
1548 if (!$profile instanceof Profile) {
1549 throw new UnknownUriException($uri);
1555 function canRead(Notice $notice)
1557 if ($notice->scope & Notice::SITE_SCOPE) {
1558 $user = $this->getUser();
1564 if ($notice->scope & Notice::ADDRESSEE_SCOPE) {
1565 $replies = $notice->getReplies();
1567 if (!in_array($this->id, $replies)) {
1568 $groups = $notice->getGroups();
1572 foreach ($groups as $group) {
1573 if ($this->isMember($group)) {
1585 if ($notice->scope & Notice::FOLLOWER_SCOPE) {
1586 $author = $notice->getProfile();
1587 if (!Subscription::exists($this, $author)) {
1595 static function current()
1597 $user = common_current_user();
1601 $profile = $user->getProfile();
1607 * Magic function called at serialize() time.
1609 * We use this to drop a couple process-specific references
1610 * from DB_DataObject which can cause trouble in future
1613 * @return array of variable names to include in serialization.
1618 $vars = parent::__sleep();
1619 $skip = array('_user', '_group');
1620 return array_diff($vars, $skip);
1623 public function getProfile()
1629 * Test whether the given profile is the same as the current class,
1630 * for testing identities.
1632 * @param Profile $other The other profile, usually from Action's $this->scoped
1636 public function sameAs(Profile $other=null)
1638 if (is_null($other)) {
1639 // In case $this->scoped is null or something, i.e. not a current/legitimate profile.
1642 return $this->getID() === $other->getID();
1646 * This will perform shortenLinks with the connected User object.
1648 * Won't work on remote profiles or groups, so expect a
1649 * NoSuchUserException if you don't know it's a local User.
1651 * @param string $text String to shorten
1652 * @param boolean $always Disrespect minimum length etc.
1654 * @return string link-shortened $text
1656 public function shortenLinks($text, $always=false)
1658 return $this->getUser()->shortenLinks($text, $always);
1661 public function isPrivateStream()
1663 // We only know of public remote users as of yet...
1664 if (!$this->isLocal()) {
1667 return $this->getUser()->private_stream ? true : false;
1670 public function delPref($namespace, $topic) {
1671 return Profile_prefs::setData($this, $namespace, $topic, null);
1674 public function getPref($namespace, $topic, $default=null) {
1675 // If you want an exception to be thrown, call Profile_prefs::getData directly
1677 return Profile_prefs::getData($this, $namespace, $topic, $default);
1678 } catch (NoResultException $e) {
1683 // The same as getPref but will fall back to common_config value for the same namespace/topic
1684 public function getConfigPref($namespace, $topic)
1686 return Profile_prefs::getConfigData($this, $namespace, $topic);
1689 public function setPref($namespace, $topic, $data) {
1690 return Profile_prefs::setData($this, $namespace, $topic, $data);
1693 public function getConnectedApps($offset=0, $limit=null)
1695 return $this->getUser()->getConnectedApps($offset, $limit);