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('STATUSNET') && !defined('LACONICA')) { exit(1); }
23 * Table Definition for profile
25 class Profile extends Managed_DataObject
28 /* the code below is auto generated do not remove the above tag */
30 public $__table = 'profile'; // table name
31 public $id; // int(4) primary_key not_null
32 public $nickname; // varchar(64) multiple_key not_null
33 public $fullname; // varchar(255) multiple_key
34 public $profileurl; // varchar(255)
35 public $homepage; // varchar(255) multiple_key
36 public $bio; // text() multiple_key
37 public $location; // varchar(255) multiple_key
38 public $lat; // decimal(10,7)
39 public $lon; // decimal(10,7)
40 public $location_id; // int(4)
41 public $location_ns; // int(4)
42 public $created; // datetime() not_null
43 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
45 public static function schemaDef()
48 'description' => 'local and remote users have profiles',
50 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
51 'nickname' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'nickname or username', 'collate' => 'utf8_general_ci'),
52 'fullname' => array('type' => 'varchar', 'length' => 255, 'description' => 'display name', 'collate' => 'utf8_general_ci'),
53 'profileurl' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL, cached so we dont regenerate'),
54 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'identifying URL', 'collate' => 'utf8_general_ci'),
55 'bio' => array('type' => 'text', 'description' => 'descriptive biography', 'collate' => 'utf8_general_ci'),
56 'location' => array('type' => 'varchar', 'length' => 255, 'description' => 'physical location', 'collate' => 'utf8_general_ci'),
57 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'),
58 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'),
59 'location_id' => array('type' => 'int', 'description' => 'location id if possible'),
60 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'),
62 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
63 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
65 'primary key' => array('id'),
67 'profile_nickname_idx' => array('nickname'),
71 // Add a fulltext index
73 if (common_config('search', 'type') == 'fulltext') {
74 $def['fulltext indexes'] = array('nickname' => array('nickname', 'fullname', 'location', 'bio', 'homepage'));
80 /* the code above is auto generated do not remove the tag below */
83 public static function getByEmail($email)
85 // in the future, profiles should have emails stored...
86 $user = User::getKV('email', $email);
87 if (!($user instanceof User)) {
88 throw new NoSuchUserException(array('email'=>$email));
90 return $user->getProfile();
93 protected $_user = array();
95 public function getUser()
97 if (!isset($this->_user[$this->id])) {
98 $user = User::getKV('id', $this->id);
99 if (!$user instanceof User) {
100 throw new NoSuchUserException(array('id'=>$this->id));
102 $this->_user[$this->id] = $user;
104 return $this->_user[$this->id];
107 protected $_group = array();
109 public function getGroup()
111 if (!isset($this->_group[$this->id])) {
112 $group = User_group::getKV('profile_id', $this->id);
113 if (!$group instanceof User_group) {
114 throw new NoSuchGroupException(array('profile_id'=>$this->id));
116 $this->_group[$this->id] = $group;
118 return $this->_group[$this->id];
121 public function isGroup()
126 } catch (NoSuchGroupException $e) {
131 public function isLocal()
135 } catch (NoSuchUserException $e) {
141 public function getObjectType()
143 // FIXME: More types... like peopletags and whatever
144 if ($this->isGroup()) {
145 return ActivityObject::GROUP;
147 return ActivityObject::PERSON;
151 public function getAvatar($width, $height=null)
153 return Avatar::byProfile($this, $width, $height);
156 public function setOriginal($filename)
158 if ($this->isGroup()) {
159 // Until Group avatars are handled just like profile avatars.
160 return $this->getGroup()->setOriginal($filename);
163 $imagefile = new ImageFile($this->id, Avatar::path($filename));
165 $avatar = new Avatar();
166 $avatar->profile_id = $this->id;
167 $avatar->width = $imagefile->width;
168 $avatar->height = $imagefile->height;
169 $avatar->mediatype = image_type_to_mime_type($imagefile->type);
170 $avatar->filename = $filename;
171 $avatar->original = true;
172 $avatar->url = Avatar::url($filename);
173 $avatar->created = common_sql_now();
175 // XXX: start a transaction here
176 if (!Avatar::deleteFromProfile($this, true) || !$avatar->insert()) {
177 // If we can't delete the old avatars, let's abort right here.
178 @unlink(Avatar::path($filename));
186 * Gets either the full name (if filled) or the nickname.
190 function getBestName()
192 return ($this->fullname) ? $this->fullname : $this->nickname;
196 * Takes the currently scoped profile into account to give a name
197 * to list in notice streams. Preferences may differ between profiles.
199 function getStreamName()
201 $user = common_current_user();
202 if ($user instanceof User && $user->streamNicknames()) {
203 return $this->nickname;
206 return $this->getBestName();
210 * Gets the full name (if filled) with nickname as a parenthetical, or the nickname alone
211 * if no fullname is provided.
215 function getFancyName()
217 if ($this->fullname) {
218 // TRANS: Full name of a profile or group (%1$s) followed by nickname (%2$s) in parentheses.
219 return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->fullname, $this->nickname);
221 return $this->nickname;
226 * Get the most recent notice posted by this user, if any.
228 * @return mixed Notice or null
230 function getCurrentNotice()
232 $notice = $this->getNotices(0, 1);
234 if ($notice->fetch()) {
235 if ($notice instanceof ArrayWrapper) {
236 // hack for things trying to work with single notices
237 return $notice->_items[0];
245 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
247 $stream = new TaggedProfileNoticeStream($this, $tag);
249 return $stream->getNotices($offset, $limit, $since_id, $max_id);
252 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0, Profile $scoped=null)
254 $stream = new ProfileNoticeStream($this, $scoped);
256 return $stream->getNotices($offset, $limit, $since_id, $max_id);
259 function isMember(User_group $group)
261 $groups = $this->getGroups(0, null);
262 while ($groups instanceof User_group && $groups->fetch()) {
263 if ($groups->id == $group->id) {
270 function isAdmin(User_group $group)
272 $gm = Group_member::pkeyGet(array('profile_id' => $this->id,
273 'group_id' => $group->id));
274 return (!empty($gm) && $gm->is_admin);
277 function isPendingMember($group)
279 $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
280 'group_id' => $group->id));
281 return !empty($request);
284 function getGroups($offset=0, $limit=PROFILES_PER_PAGE)
288 $keypart = sprintf('profile:groups:%d', $this->id);
290 $idstring = self::cacheGet($keypart);
292 if ($idstring !== false) {
293 $ids = explode(',', $idstring);
295 $gm = new Group_member();
297 $gm->profile_id = $this->id;
300 while ($gm->fetch()) {
301 $ids[] = $gm->group_id;
305 self::cacheSet($keypart, implode(',', $ids));
308 if (!is_null($offset) && !is_null($limit)) {
309 $ids = array_slice($ids, $offset, $limit);
313 return User_group::multiGet('id', $ids);
314 } catch (NoResultException $e) {
315 return null; // throw exception when we handle it everywhere
319 function getGroupCount() {
320 $groups = $this->getGroups(0, null);
321 return $groups instanceof User_group
326 function isTagged($peopletag)
328 $tag = Profile_tag::pkeyGet(array('tagger' => $peopletag->tagger,
329 'tagged' => $this->id,
330 'tag' => $peopletag->tag));
334 function canTag($tagged)
336 if (empty($tagged)) {
340 if ($tagged->id == $this->id) {
344 $all = common_config('peopletag', 'allow_tagging', 'all');
345 $local = common_config('peopletag', 'allow_tagging', 'local');
346 $remote = common_config('peopletag', 'allow_tagging', 'remote');
347 $subs = common_config('peopletag', 'allow_tagging', 'subs');
353 $tagged_user = $tagged->getUser();
354 if (!empty($tagged_user)) {
359 return (Subscription::exists($this, $tagged) ||
360 Subscription::exists($tagged, $this));
361 } else if ($remote) {
367 function getLists($auth_user, $offset=0, $limit=null, $since_id=0, $max_id=0)
371 $keypart = sprintf('profile:lists:%d', $this->id);
373 $idstr = self::cacheGet($keypart);
375 if ($idstr !== false) {
376 $ids = explode(',', $idstr);
378 $list = new Profile_list();
380 $list->selectAdd('id');
381 $list->tagger = $this->id;
382 $list->selectAdd('id as "cursor"');
385 $list->whereAdd('id > '.$since_id);
389 $list->whereAdd('id <= '.$max_id);
392 if($offset>=0 && !is_null($limit)) {
393 $list->limit($offset, $limit);
396 $list->orderBy('id DESC');
399 while ($list->fetch()) {
404 self::cacheSet($keypart, implode(',', $ids));
407 $showPrivate = (($auth_user instanceof User ||
408 $auth_user instanceof Profile) &&
409 $auth_user->id === $this->id);
413 foreach ($ids as $id) {
414 $list = Profile_list::getKV('id', $id);
416 ($showPrivate || !$list->private)) {
418 if (!isset($list->cursor)) {
419 $list->cursor = $list->id;
426 return new ArrayWrapper($lists);
430 * Get tags that other people put on this profile, in reverse-chron order
432 * @param (Profile|User) $auth_user Authorized user (used for privacy)
433 * @param int $offset Offset from latest
434 * @param int $limit Max number to get
435 * @param datetime $since_id max date
436 * @param datetime $max_id min date
438 * @return Profile_list resulting lists
441 function getOtherTags($auth_user=null, $offset=0, $limit=null, $since_id=0, $max_id=0)
443 $list = new Profile_list();
445 $qry = sprintf('select profile_list.*, unix_timestamp(profile_tag.modified) as "cursor" ' .
446 'from profile_tag join profile_list '.
447 'on (profile_tag.tagger = profile_list.tagger ' .
448 ' and profile_tag.tag = profile_list.tag) ' .
449 'where profile_tag.tagged = %d ',
453 if ($auth_user instanceof User || $auth_user instanceof Profile) {
454 $qry .= sprintf('AND ( ( profile_list.private = false ) ' .
455 'OR ( profile_list.tagger = %d AND ' .
456 'profile_list.private = true ) )',
459 $qry .= 'AND profile_list.private = 0 ';
463 $qry .= sprintf('AND (cursor > %d) ', $since_id);
467 $qry .= sprintf('AND (cursor < %d) ', $max_id);
470 $qry .= 'ORDER BY profile_tag.modified DESC ';
472 if ($offset >= 0 && !is_null($limit)) {
473 $qry .= sprintf('LIMIT %d OFFSET %d ', $limit, $offset);
480 function getPrivateTags($offset=0, $limit=null, $since_id=0, $max_id=0)
482 $tags = new Profile_list();
483 $tags->private = true;
484 $tags->tagger = $this->id;
487 $tags->whereAdd('id > '.$since_id);
491 $tags->whereAdd('id <= '.$max_id);
494 if($offset>=0 && !is_null($limit)) {
495 $tags->limit($offset, $limit);
498 $tags->orderBy('id DESC');
504 function hasLocalTags()
506 $tags = new Profile_tag();
508 $tags->joinAdd(array('tagger', 'user:id'));
509 $tags->whereAdd('tagged = '.$this->id);
510 $tags->whereAdd('tagger != '.$this->id);
515 return ($tags->N == 0) ? false : true;
518 function getTagSubscriptions($offset=0, $limit=null, $since_id=0, $max_id=0)
520 $lists = new Profile_list();
521 $subs = new Profile_tag_subscription();
523 $lists->joinAdd(array('id', 'profile_tag_subscription:profile_tag_id'));
525 #@fixme: postgres (round(date_part('epoch', my_date)))
526 $lists->selectAdd('unix_timestamp(profile_tag_subscription.created) as "cursor"');
528 $lists->whereAdd('profile_tag_subscription.profile_id = '.$this->id);
531 $lists->whereAdd('cursor > '.$since_id);
535 $lists->whereAdd('cursor <= '.$max_id);
538 if($offset>=0 && !is_null($limit)) {
539 $lists->limit($offset, $limit);
542 $lists->orderBy('"cursor" DESC');
549 * Request to join the given group.
550 * May throw exceptions on failure.
552 * @param User_group $group
553 * @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
555 function joinGroup(User_group $group)
558 if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
559 $join = Group_join_queue::saveNew($this, $group);
561 if (Event::handle('StartJoinGroup', array($group, $this))) {
562 $join = Group_member::join($group->id, $this->id);
563 self::blow('profile:groups:%d', $this->id);
564 self::blow('group:member_ids:%d', $group->id);
565 self::blow('group:member_count:%d', $group->id);
566 Event::handle('EndJoinGroup', array($group, $this));
570 // Send any applicable notifications...
577 * Leave a group that this profile is a member of.
579 * @param User_group $group
581 function leaveGroup(User_group $group)
583 if (Event::handle('StartLeaveGroup', array($group, $this))) {
584 Group_member::leave($group->id, $this->id);
585 self::blow('profile:groups:%d', $this->id);
586 self::blow('group:member_ids:%d', $group->id);
587 self::blow('group:member_count:%d', $group->id);
588 Event::handle('EndLeaveGroup', array($group, $this));
592 function avatarUrl($size=AVATAR_PROFILE_SIZE)
594 return Avatar::urlByProfile($this, $size);
597 function getSubscribed($offset=0, $limit=null)
599 $subs = Subscription::getSubscribedIDs($this->id, $offset, $limit);
601 $profiles = Profile::multiGet('id', $subs);
602 } catch (NoResultException $e) {
608 function getSubscribers($offset=0, $limit=null)
610 $subs = Subscription::getSubscriberIDs($this->id, $offset, $limit);
612 $profiles = Profile::multiGet('id', $subs);
613 } catch (NoResultException $e) {
619 function getTaggedSubscribers($tag, $offset=0, $limit=null)
622 'SELECT profile.* ' .
623 'FROM profile JOIN subscription ' .
624 'ON profile.id = subscription.subscriber ' .
625 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
626 'AND profile_tag.tagger = subscription.subscribed) ' .
627 'WHERE subscription.subscribed = %d ' .
628 "AND profile_tag.tag = '%s' " .
629 'AND subscription.subscribed != subscription.subscriber ' .
630 'ORDER BY subscription.created DESC ';
633 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
636 $profile = new Profile();
638 $cnt = $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
643 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
646 'SELECT profile.* ' .
647 'FROM profile JOIN subscription ' .
648 'ON profile.id = subscription.subscribed ' .
649 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
650 'AND profile_tag.tagger = subscription.subscriber) ' .
651 'WHERE subscription.subscriber = %d ' .
652 "AND profile_tag.tag = '%s' " .
653 'AND subscription.subscribed != subscription.subscriber ' .
654 'ORDER BY subscription.created DESC ';
656 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
658 $profile = new Profile();
660 $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
666 * Get pending subscribers, who have not yet been approved.
672 function getRequests($offset=0, $limit=null)
675 'SELECT profile.* ' .
676 'FROM profile JOIN subscription_queue '.
677 'ON profile.id = subscription_queue.subscriber ' .
678 'WHERE subscription_queue.subscribed = %d ' .
679 'ORDER BY subscription_queue.created DESC ';
681 if ($limit != null) {
682 if (common_config('db','type') == 'pgsql') {
683 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
685 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
689 $members = new Profile();
691 $members->query(sprintf($qry, $this->id));
695 function subscriptionCount()
697 $c = Cache::instance();
700 $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
701 if (is_integer($cnt)) {
706 $sub = new Subscription();
707 $sub->subscriber = $this->id;
709 $cnt = (int) $sub->count('distinct subscribed');
711 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
714 $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
720 function subscriberCount()
722 $c = Cache::instance();
724 $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
725 if (is_integer($cnt)) {
730 $sub = new Subscription();
731 $sub->subscribed = $this->id;
732 $sub->whereAdd('subscriber != subscribed');
733 $cnt = (int) $sub->count('distinct subscriber');
736 $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
743 * Is this profile subscribed to another profile?
745 * @param Profile $other
748 function isSubscribed(Profile $other)
750 return Subscription::exists($this, $other);
754 * Check if a pending subscription request is outstanding for this...
756 * @param Profile $other
759 function hasPendingSubscription(Profile $other)
761 return Subscription_queue::exists($this, $other);
765 * Are these two profiles subscribed to each other?
767 * @param Profile $other
770 function mutuallySubscribed(Profile $other)
772 return $this->isSubscribed($other) &&
773 $other->isSubscribed($this);
776 function noticeCount()
778 $c = Cache::instance();
781 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
782 if (is_integer($cnt)) {
787 $notices = new Notice();
788 $notices->profile_id = $this->id;
789 $cnt = (int) $notices->count('distinct id');
792 $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
798 function blowSubscriberCount()
800 $c = Cache::instance();
802 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
806 function blowSubscriptionCount()
808 $c = Cache::instance();
810 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
814 function blowNoticeCount()
816 $c = Cache::instance();
818 $c->delete(Cache::key('profile:notice_count:'.$this->id));
822 static function maxBio()
824 $biolimit = common_config('profile', 'biolimit');
825 // null => use global limit (distinct from 0!)
826 if (is_null($biolimit)) {
827 $biolimit = common_config('site', 'textlimit');
832 static function bioTooLong($bio)
834 $biolimit = self::maxBio();
835 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
838 function update($dataObject=false)
840 if (is_object($dataObject) && $this->nickname != $dataObject->nickname) {
842 $local = $this->getUser();
843 common_debug("Updating User ({$this->id}) nickname from {$dataObject->nickname} to {$this->nickname}");
844 $origuser = clone($local);
845 $local->nickname = $this->nickname;
846 // updateWithKeys throws exception on failure.
847 $local->updateWithKeys($origuser);
849 // Clear the site owner, in case nickname changed
850 if ($local->hasRole(Profile_role::OWNER)) {
851 User::blow('user:site_owner');
853 } catch (NoSuchUserException $e) {
858 return parent::update($dataObject);
861 function delete($useWhere=false)
863 $this->_deleteNotices();
864 $this->_deleteSubscriptions();
865 $this->_deleteTags();
866 $this->_deleteBlocks();
867 $this->_deleteAttentions();
868 Avatar::deleteFromProfile($this, true);
870 // Warning: delete() will run on the batch objects,
871 // not on individual objects.
872 $related = array('Reply',
875 Event::handle('ProfileDeleteRelated', array($this, &$related));
877 foreach ($related as $cls) {
879 $inst->profile_id = $this->id;
883 return parent::delete($useWhere);
886 function _deleteNotices()
888 $notice = new Notice();
889 $notice->profile_id = $this->id;
891 if ($notice->find()) {
892 while ($notice->fetch()) {
893 $other = clone($notice);
899 function _deleteSubscriptions()
901 $sub = new Subscription();
902 $sub->subscriber = $this->id;
906 while ($sub->fetch()) {
907 $other = Profile::getKV('id', $sub->subscribed);
911 if ($other->id == $this->id) {
914 Subscription::cancel($this, $other);
917 $subd = new Subscription();
918 $subd->subscribed = $this->id;
921 while ($subd->fetch()) {
922 $other = Profile::getKV('id', $subd->subscriber);
926 if ($other->id == $this->id) {
929 Subscription::cancel($other, $this);
932 $self = new Subscription();
934 $self->subscriber = $this->id;
935 $self->subscribed = $this->id;
940 function _deleteTags()
942 $tag = new Profile_tag();
943 $tag->tagged = $this->id;
947 function _deleteBlocks()
949 $block = new Profile_block();
950 $block->blocked = $this->id;
953 $block = new Group_block();
954 $block->blocked = $this->id;
958 function _deleteAttentions()
960 $att = new Attention();
961 $att->profile_id = $this->getID();
964 while ($att->fetch()) {
965 // Can't do delete() on the object directly since it won't remove all of it
966 $other = clone($att);
972 // XXX: identical to Notice::getLocation.
974 public function getLocation()
978 if (!empty($this->location_id) && !empty($this->location_ns)) {
979 $location = Location::fromId($this->location_id, $this->location_ns);
982 if (is_null($location)) { // no ID, or Location::fromId() failed
983 if (!empty($this->lat) && !empty($this->lon)) {
984 $location = Location::fromLatLon($this->lat, $this->lon);
988 if (is_null($location)) { // still haven't found it!
989 if (!empty($this->location)) {
990 $location = Location::fromName($this->location);
997 public function shareLocation()
999 $cfg = common_config('location', 'share');
1001 if ($cfg == 'always') {
1003 } else if ($cfg == 'never') {
1006 $share = common_config('location', 'sharedefault');
1008 // Check if user has a personal setting for this
1009 $prefs = User_location_prefs::getKV('user_id', $this->id);
1011 if (!empty($prefs)) {
1012 $share = $prefs->share_location;
1020 function hasRole($name)
1023 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
1024 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1026 $has_role = !empty($role);
1027 Event::handle('EndHasRole', array($this, $name, $has_role));
1032 function grantRole($name)
1034 if (Event::handle('StartGrantRole', array($this, $name))) {
1036 $role = new Profile_role();
1038 $role->profile_id = $this->id;
1039 $role->role = $name;
1040 $role->created = common_sql_now();
1042 $result = $role->insert();
1045 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
1048 if ($name == 'owner') {
1049 User::blow('user:site_owner');
1052 Event::handle('EndGrantRole', array($this, $name));
1058 function revokeRole($name)
1060 if (Event::handle('StartRevokeRole', array($this, $name))) {
1062 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1066 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
1067 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1068 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
1071 $result = $role->delete();
1074 common_log_db_error($role, 'DELETE', __FILE__);
1075 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
1076 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1077 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
1080 if ($name == 'owner') {
1081 User::blow('user:site_owner');
1084 Event::handle('EndRevokeRole', array($this, $name));
1090 function isSandboxed()
1092 return $this->hasRole(Profile_role::SANDBOXED);
1095 function isSilenced()
1097 return $this->hasRole(Profile_role::SILENCED);
1102 $this->grantRole(Profile_role::SANDBOXED);
1105 function unsandbox()
1107 $this->revokeRole(Profile_role::SANDBOXED);
1112 $this->grantRole(Profile_role::SILENCED);
1113 if (common_config('notice', 'hidespam')) {
1114 $this->flushVisibility();
1118 function unsilence()
1120 $this->revokeRole(Profile_role::SILENCED);
1121 if (common_config('notice', 'hidespam')) {
1122 $this->flushVisibility();
1126 function flushVisibility()
1129 $stream = new ProfileNoticeStream($this, $this);
1130 $ids = $stream->getNoticeIds(0, CachingNoticeStream::CACHE_WINDOW);
1131 foreach ($ids as $id) {
1132 self::blow('notice:in-scope-for:%d:null', $id);
1137 * Does this user have the right to do X?
1139 * With our role-based authorization, this is merely a lookup for whether the user
1140 * has a particular role. The implementation currently uses a switch statement
1141 * to determine if the user has the pre-defined role to exercise the right. Future
1142 * implementations may allow per-site roles, and different mappings of roles to rights.
1144 * @param $right string Name of the right, usually a constant in class Right
1145 * @return boolean whether the user has the right in question
1147 public function hasRight($right)
1151 if ($this->hasRole(Profile_role::DELETED)) {
1155 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
1158 case Right::DELETEOTHERSNOTICE:
1159 case Right::MAKEGROUPADMIN:
1160 case Right::SANDBOXUSER:
1161 case Right::SILENCEUSER:
1162 case Right::DELETEUSER:
1163 case Right::DELETEGROUP:
1164 case Right::TRAINSPAM:
1165 case Right::REVIEWSPAM:
1166 $result = $this->hasRole(Profile_role::MODERATOR);
1168 case Right::CONFIGURESITE:
1169 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
1171 case Right::GRANTROLE:
1172 case Right::REVOKEROLE:
1173 $result = $this->hasRole(Profile_role::OWNER);
1175 case Right::NEWNOTICE:
1176 case Right::NEWMESSAGE:
1177 case Right::SUBSCRIBE:
1178 case Right::CREATEGROUP:
1179 $result = !$this->isSilenced();
1181 case Right::PUBLICNOTICE:
1182 case Right::EMAILONREPLY:
1183 case Right::EMAILONSUBSCRIBE:
1184 case Right::EMAILONFAVE:
1185 $result = !$this->isSandboxed();
1187 case Right::WEBLOGIN:
1188 $result = !$this->isSilenced();
1191 $result = !$this->isSilenced();
1193 case Right::BACKUPACCOUNT:
1194 $result = common_config('profile', 'backup');
1196 case Right::RESTOREACCOUNT:
1197 $result = common_config('profile', 'restore');
1199 case Right::DELETEACCOUNT:
1200 $result = common_config('profile', 'delete');
1202 case Right::MOVEACCOUNT:
1203 $result = common_config('profile', 'move');
1213 // FIXME: Can't put Notice typing here due to ArrayWrapper
1214 public function hasRepeated($notice)
1216 // XXX: not really a pkey, but should work
1218 $notice = Notice::pkeyGet(array('profile_id' => $this->id,
1219 'repeat_of' => $notice->id));
1221 return !empty($notice);
1225 * Returns an XML string fragment with limited profile information
1226 * as an Atom <author> element.
1228 * Assumes that Atom has been previously set up as the base namespace.
1230 * @param Profile $cur the current authenticated user
1234 function asAtomAuthor($cur = null)
1236 $xs = new XMLStringer(true);
1238 $xs->elementStart('author');
1239 $xs->element('name', null, $this->nickname);
1240 $xs->element('uri', null, $this->getUri());
1243 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1244 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
1245 $xs->element('statusnet:profile_info', $attrs, null);
1247 $xs->elementEnd('author');
1249 return $xs->getString();
1253 * Extra profile info for atom entries
1255 * Clients use some extra profile info in the atom stream.
1256 * This gives it to them.
1258 * @param Profile $scoped The currently logged in/scoped profile
1260 * @return array representation of <statusnet:profile_info> element or null
1263 function profileInfo(Profile $scoped=null)
1265 $profileInfoAttr = array('local_id' => $this->id);
1267 if ($scoped instanceof Profile) {
1268 // Whether the current user is a subscribed to this profile
1269 $profileInfoAttr['following'] = $scoped->isSubscribed($this) ? 'true' : 'false';
1270 // Whether the current user is has blocked this profile
1271 $profileInfoAttr['blocking'] = $scoped->hasBlocked($this) ? 'true' : 'false';
1274 return array('statusnet:profile_info', $profileInfoAttr, null);
1278 * Returns an XML string fragment with profile information as an
1279 * Activity Streams <activity:actor> element.
1281 * Assumes that 'activity' namespace has been previously defined.
1285 function asActivityActor()
1287 return $this->asActivityNoun('actor');
1291 * Returns an XML string fragment with profile information as an
1292 * Activity Streams noun object with the given element type.
1294 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1295 * previously defined.
1297 * @param string $element one of 'actor', 'subject', 'object', 'target'
1301 function asActivityNoun($element)
1303 $noun = $this->asActivityObject();
1304 return $noun->asString('activity:' . $element);
1307 public function asActivityObject()
1309 $object = new ActivityObject();
1311 if (Event::handle('StartActivityObjectFromProfile', array($this, &$object))) {
1312 $object->type = $this->getObjectType();
1313 $object->id = $this->getUri();
1314 $object->title = $this->getBestName();
1315 $object->link = $this->getUrl();
1316 $object->summary = $this->getDescription();
1319 $avatar = Avatar::getUploaded($this);
1320 $object->avatarLinks[] = AvatarLink::fromAvatar($avatar);
1321 } catch (NoAvatarException $e) {
1322 // Could not find an original avatar to link
1326 AVATAR_PROFILE_SIZE,
1331 foreach ($sizes as $size) {
1334 $avatar = Avatar::byProfile($this, $size);
1335 $alink = AvatarLink::fromAvatar($avatar);
1336 } catch (NoAvatarException $e) {
1337 $alink = new AvatarLink();
1338 $alink->type = 'image/png';
1339 $alink->height = $size;
1340 $alink->width = $size;
1341 $alink->url = Avatar::defaultImage($size);
1344 $object->avatarLinks[] = $alink;
1347 if (isset($this->lat) && isset($this->lon)) {
1348 $object->geopoint = (float)$this->lat
1349 . ' ' . (float)$this->lon;
1352 $object->poco = PoCo::fromProfile($this);
1354 if ($this->isLocal()) {
1355 $object->extra[] = array('followers', array('url' => common_local_url('subscribers', array('nickname' => $this->getNickname()))));
1358 Event::handle('EndActivityObjectFromProfile', array($this, &$object));
1365 * Returns the profile's canonical url, not necessarily a uri/unique id
1367 * @return string $profileurl
1369 public function getUrl()
1371 if (empty($this->profileurl) ||
1372 !filter_var($this->profileurl, FILTER_VALIDATE_URL)) {
1373 throw new InvalidUrlException($this->profileurl);
1375 return $this->profileurl;
1378 public function getNickname()
1380 return $this->nickname;
1383 public function getDescription()
1389 * Returns the best URI for a profile. Plugins may override.
1391 * @return string $uri
1393 public function getUri()
1397 // give plugins a chance to set the URI
1398 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1400 // check for a local user first
1401 $user = User::getKV('id', $this->id);
1402 if ($user instanceof User) {
1403 $uri = $user->getUri();
1406 Event::handle('EndGetProfileUri', array($this, &$uri));
1413 * Returns an assumed acct: URI for a profile. Plugins are required.
1415 * @return string $uri
1417 public function getAcctUri()
1421 if (Event::handle('StartGetProfileAcctUri', array($this, &$acct))) {
1422 Event::handle('EndGetProfileAcctUri', array($this, &$acct));
1425 if ($acct === null) {
1426 throw new ProfileNoAcctUriException($this);
1432 function hasBlocked($other)
1434 $block = Profile_block::exists($this, $other);
1435 return !empty($block);
1438 function getAtomFeed()
1442 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1443 $user = User::getKV('id', $this->id);
1444 if (!empty($user)) {
1445 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1446 'format' => 'atom'));
1448 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1455 * Get a Profile object by URI. Will call external plugins for help
1456 * using the event StartGetProfileFromURI.
1458 * @param string $uri A unique identifier for a resource (profile/group/whatever)
1460 static function fromUri($uri)
1464 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1465 // Get a local user when plugin lookup (like OStatus) fails
1466 $user = User::getKV('uri', $uri);
1467 if ($user instanceof User) {
1468 $profile = $user->getProfile();
1470 Event::handle('EndGetProfileFromURI', array($uri, $profile));
1473 if (!$profile instanceof Profile) {
1474 throw new UnknownUriException($uri);
1480 function canRead(Notice $notice)
1482 if ($notice->scope & Notice::SITE_SCOPE) {
1483 $user = $this->getUser();
1489 if ($notice->scope & Notice::ADDRESSEE_SCOPE) {
1490 $replies = $notice->getReplies();
1492 if (!in_array($this->id, $replies)) {
1493 $groups = $notice->getGroups();
1497 foreach ($groups as $group) {
1498 if ($this->isMember($group)) {
1510 if ($notice->scope & Notice::FOLLOWER_SCOPE) {
1511 $author = $notice->getProfile();
1512 if (!Subscription::exists($this, $author)) {
1520 static function current()
1522 $user = common_current_user();
1526 $profile = $user->getProfile();
1532 * Magic function called at serialize() time.
1534 * We use this to drop a couple process-specific references
1535 * from DB_DataObject which can cause trouble in future
1538 * @return array of variable names to include in serialization.
1543 $vars = parent::__sleep();
1544 $skip = array('_user', '_group');
1545 return array_diff($vars, $skip);
1548 public function getProfile()
1554 * This will perform shortenLinks with the connected User object.
1556 * Won't work on remote profiles or groups, so expect a
1557 * NoSuchUserException if you don't know it's a local User.
1559 * @param string $text String to shorten
1560 * @param boolean $always Disrespect minimum length etc.
1562 * @return string link-shortened $text
1564 public function shortenLinks($text, $always=false)
1566 return $this->getUser()->shortenLinks($text, $always);
1569 public function delPref($namespace, $topic) {
1570 return Profile_prefs::setData($this, $namespace, $topic, null);
1573 public function getPref($namespace, $topic, $default=null) {
1574 // If you want an exception to be thrown, call Profile_prefs::getData directly
1576 return Profile_prefs::getData($this, $namespace, $topic, $default);
1577 } catch (NoResultException $e) {
1582 // The same as getPref but will fall back to common_config value for the same namespace/topic
1583 public function getConfigPref($namespace, $topic)
1585 return Profile_prefs::getConfigData($this, $namespace, $topic);
1588 public function setPref($namespace, $topic, $data) {
1589 return Profile_prefs::setData($this, $namespace, $topic, $data);