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 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
27 class Profile extends Managed_DataObject
30 /* the code below is auto generated do not remove the above tag */
32 public $__table = 'profile'; // table name
33 public $id; // int(4) primary_key not_null
34 public $nickname; // varchar(64) multiple_key not_null
35 public $fullname; // varchar(255) multiple_key
36 public $profileurl; // varchar(255)
37 public $homepage; // varchar(255) multiple_key
38 public $bio; // text() multiple_key
39 public $location; // varchar(255) multiple_key
40 public $lat; // decimal(10,7)
41 public $lon; // decimal(10,7)
42 public $location_id; // int(4)
43 public $location_ns; // int(4)
44 public $created; // datetime() not_null
45 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
47 public static function schemaDef()
50 'description' => 'local and remote users have profiles',
52 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
53 'nickname' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'nickname or username', 'collate' => 'utf8_general_ci'),
54 'fullname' => array('type' => 'varchar', 'length' => 255, 'description' => 'display name', 'collate' => 'utf8_general_ci'),
55 'profileurl' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL, cached so we dont regenerate'),
56 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'identifying URL', 'collate' => 'utf8_general_ci'),
57 'bio' => array('type' => 'text', 'description' => 'descriptive biography', 'collate' => 'utf8_general_ci'),
58 'location' => array('type' => 'varchar', 'length' => 255, 'description' => 'physical location', 'collate' => 'utf8_general_ci'),
59 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'),
60 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'),
61 'location_id' => array('type' => 'int', 'description' => 'location id if possible'),
62 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'),
64 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
65 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
67 'primary key' => array('id'),
69 'profile_nickname_idx' => array('nickname'),
73 // Add a fulltext index
75 if (common_config('search', 'type') == 'fulltext') {
76 $def['fulltext indexes'] = array('nickname' => array('nickname', 'fullname', 'location', 'bio', 'homepage'));
82 /* the code above is auto generated do not remove the tag below */
85 public static function getByEmail($email)
87 // in the future, profiles should have emails stored...
88 $user = User::getKV('email', $email);
89 if (!($user instanceof User)) {
90 throw new NoSuchUserException(array('email'=>$email));
92 return $user->getProfile();
95 protected $_user = -1; // Uninitialized value distinct from null
97 public function getUser()
99 if ($this->_user === -1) {
100 $this->_user = User::getKV('id', $this->id);
102 if (!$this->_user instanceof User) {
103 throw new NoSuchUserException(array('id'=>$this->id));
109 protected $_group = -1;
111 public function getGroup()
113 if ($this->_group === -1) {
114 $this->_group = User_group::getKV('profile_id', $this->id);
116 if (!$this->_group instanceof User_group) {
117 throw new NoSuchGroupException(array('profile_id'=>$this->id));
120 return $this->_group;
123 public function isGroup()
128 } catch (NoSuchGroupException $e) {
133 public function isLocal()
137 } catch (NoSuchUserException $e) {
143 protected $_avatars = array();
145 public function getAvatar($width, $height=null)
147 return Avatar::byProfile($this, $width, $height);
150 public function setOriginal($filename)
152 $imagefile = new ImageFile($this->id, Avatar::path($filename));
154 $avatar = new Avatar();
155 $avatar->profile_id = $this->id;
156 $avatar->width = $imagefile->width;
157 $avatar->height = $imagefile->height;
158 $avatar->mediatype = image_type_to_mime_type($imagefile->type);
159 $avatar->filename = $filename;
160 $avatar->original = true;
161 $avatar->url = Avatar::url($filename);
162 $avatar->created = common_sql_now();
164 // XXX: start a transaction here
165 if (!Avatar::deleteFromProfile($this, true) || !$avatar->insert()) {
166 // If we can't delete the old avatars, let's abort right here.
167 @unlink(Avatar::path($filename));
171 foreach (array(AVATAR_PROFILE_SIZE, AVATAR_STREAM_SIZE, AVATAR_MINI_SIZE) as $size) {
172 // We don't do a scaled one if original is our scaled size
173 if (!($avatar->width == $size && $avatar->height == $size)) {
175 Avatar::newSize($this, $size);
176 } catch (Exception $e) {
177 // should we abort the generation and live without smaller avatars?
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::listFind('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::listFind('id', $subs);
602 } catch (NoResultException $e) {
608 function getSubscribers($offset=0, $limit=null)
610 $subs = Subscription::getSubscriberIDs($this->id, $offset, $limit);
612 $profiles = Profile::listFind('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($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($other)
761 return Subscription_queue::exists($this, $other);
765 * Are these two profiles subscribed to each other?
767 * @param Profile $other
770 function mutuallySubscribed($other)
772 return $this->isSubscribed($other) &&
773 $other->isSubscribed($this);
776 function hasFave($notice)
778 $fave = Fave::pkeyGet(array('user_id' => $this->id,
779 'notice_id' => $notice->id));
780 return ((is_null($fave)) ? false : true);
785 $c = Cache::instance();
787 $cnt = $c->get(Cache::key('profile:fave_count:'.$this->id));
788 if (is_integer($cnt)) {
794 $faves->user_id = $this->id;
795 $cnt = (int) $faves->count('notice_id');
798 $c->set(Cache::key('profile:fave_count:'.$this->id), $cnt);
804 function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
806 return Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
809 function noticeCount()
811 $c = Cache::instance();
814 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
815 if (is_integer($cnt)) {
820 $notices = new Notice();
821 $notices->profile_id = $this->id;
822 $cnt = (int) $notices->count('distinct id');
825 $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
831 function blowFavesCache()
833 $cache = Cache::instance();
835 // Faves don't happen chronologically, so we need to blow
837 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id));
838 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id.';last'));
839 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id));
840 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id.';last'));
842 $this->blowFaveCount();
845 function blowSubscriberCount()
847 $c = Cache::instance();
849 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
853 function blowSubscriptionCount()
855 $c = Cache::instance();
857 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
861 function blowFaveCount()
863 $c = Cache::instance();
865 $c->delete(Cache::key('profile:fave_count:'.$this->id));
869 function blowNoticeCount()
871 $c = Cache::instance();
873 $c->delete(Cache::key('profile:notice_count:'.$this->id));
877 static function maxBio()
879 $biolimit = common_config('profile', 'biolimit');
880 // null => use global limit (distinct from 0!)
881 if (is_null($biolimit)) {
882 $biolimit = common_config('site', 'textlimit');
887 static function bioTooLong($bio)
889 $biolimit = self::maxBio();
890 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
893 function update($dataObject=false)
895 if (is_object($dataObject) && $this->nickname != $dataObject->nickname) {
897 $local = $this->getUser();
898 common_debug("Updating User ({$this->id}) nickname from {$dataObject->nickname} to {$this->nickname}");
899 $origuser = clone($local);
900 $local->nickname = $this->nickname;
901 $result = $local->updateKeys($origuser);
902 if ($result === false) {
903 common_log_db_error($local, 'UPDATE', __FILE__);
904 // TRANS: Server error thrown when user profile settings could not be updated.
905 throw new ServerException(_('Could not update user nickname.'));
908 // Clear the site owner, in case nickname changed
909 if ($local->hasRole(Profile_role::OWNER)) {
910 User::blow('user:site_owner');
912 } catch (NoSuchUserException $e) {
917 return parent::update($dataObject);
920 function delete($useWhere=false)
922 $this->_deleteNotices();
923 $this->_deleteSubscriptions();
924 $this->_deleteMessages();
925 $this->_deleteTags();
926 $this->_deleteBlocks();
927 Avatar::deleteFromProfile($this, true);
929 // Warning: delete() will run on the batch objects,
930 // not on individual objects.
931 $related = array('Reply',
934 Event::handle('ProfileDeleteRelated', array($this, &$related));
936 foreach ($related as $cls) {
938 $inst->profile_id = $this->id;
942 return parent::delete($useWhere);
945 function _deleteNotices()
947 $notice = new Notice();
948 $notice->profile_id = $this->id;
950 if ($notice->find()) {
951 while ($notice->fetch()) {
952 $other = clone($notice);
958 function _deleteSubscriptions()
960 $sub = new Subscription();
961 $sub->subscriber = $this->id;
965 while ($sub->fetch()) {
966 $other = Profile::getKV('id', $sub->subscribed);
970 if ($other->id == $this->id) {
973 Subscription::cancel($this, $other);
976 $subd = new Subscription();
977 $subd->subscribed = $this->id;
980 while ($subd->fetch()) {
981 $other = Profile::getKV('id', $subd->subscriber);
985 if ($other->id == $this->id) {
988 Subscription::cancel($other, $this);
991 $self = new Subscription();
993 $self->subscriber = $this->id;
994 $self->subscribed = $this->id;
999 function _deleteMessages()
1001 $msg = new Message();
1002 $msg->from_profile = $this->id;
1005 $msg = new Message();
1006 $msg->to_profile = $this->id;
1010 function _deleteTags()
1012 $tag = new Profile_tag();
1013 $tag->tagged = $this->id;
1017 function _deleteBlocks()
1019 $block = new Profile_block();
1020 $block->blocked = $this->id;
1023 $block = new Group_block();
1024 $block->blocked = $this->id;
1028 // XXX: identical to Notice::getLocation.
1030 public function getLocation()
1034 if (!empty($this->location_id) && !empty($this->location_ns)) {
1035 $location = Location::fromId($this->location_id, $this->location_ns);
1038 if (is_null($location)) { // no ID, or Location::fromId() failed
1039 if (!empty($this->lat) && !empty($this->lon)) {
1040 $location = Location::fromLatLon($this->lat, $this->lon);
1044 if (is_null($location)) { // still haven't found it!
1045 if (!empty($this->location)) {
1046 $location = Location::fromName($this->location);
1053 public function shareLocation()
1055 $cfg = common_config('location', 'share');
1057 if ($cfg == 'always') {
1059 } else if ($cfg == 'never') {
1062 $share = common_config('location', 'sharedefault');
1064 // Check if user has a personal setting for this
1065 $prefs = User_location_prefs::getKV('user_id', $this->id);
1067 if (!empty($prefs)) {
1068 $share = $prefs->share_location;
1076 function hasRole($name)
1079 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
1080 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1082 $has_role = !empty($role);
1083 Event::handle('EndHasRole', array($this, $name, $has_role));
1088 function grantRole($name)
1090 if (Event::handle('StartGrantRole', array($this, $name))) {
1092 $role = new Profile_role();
1094 $role->profile_id = $this->id;
1095 $role->role = $name;
1096 $role->created = common_sql_now();
1098 $result = $role->insert();
1101 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
1104 if ($name == 'owner') {
1105 User::blow('user:site_owner');
1108 Event::handle('EndGrantRole', array($this, $name));
1114 function revokeRole($name)
1116 if (Event::handle('StartRevokeRole', array($this, $name))) {
1118 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1122 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
1123 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1124 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
1127 $result = $role->delete();
1130 common_log_db_error($role, 'DELETE', __FILE__);
1131 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
1132 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1133 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
1136 if ($name == 'owner') {
1137 User::blow('user:site_owner');
1140 Event::handle('EndRevokeRole', array($this, $name));
1146 function isSandboxed()
1148 return $this->hasRole(Profile_role::SANDBOXED);
1151 function isSilenced()
1153 return $this->hasRole(Profile_role::SILENCED);
1158 $this->grantRole(Profile_role::SANDBOXED);
1161 function unsandbox()
1163 $this->revokeRole(Profile_role::SANDBOXED);
1168 $this->grantRole(Profile_role::SILENCED);
1169 if (common_config('notice', 'hidespam')) {
1170 $this->flushVisibility();
1174 function unsilence()
1176 $this->revokeRole(Profile_role::SILENCED);
1177 if (common_config('notice', 'hidespam')) {
1178 $this->flushVisibility();
1182 function flushVisibility()
1185 $stream = new ProfileNoticeStream($this, $this);
1186 $ids = $stream->getNoticeIds(0, CachingNoticeStream::CACHE_WINDOW);
1187 foreach ($ids as $id) {
1188 self::blow('notice:in-scope-for:%d:null', $id);
1193 * Does this user have the right to do X?
1195 * With our role-based authorization, this is merely a lookup for whether the user
1196 * has a particular role. The implementation currently uses a switch statement
1197 * to determine if the user has the pre-defined role to exercise the right. Future
1198 * implementations may allow per-site roles, and different mappings of roles to rights.
1200 * @param $right string Name of the right, usually a constant in class Right
1201 * @return boolean whether the user has the right in question
1203 public function hasRight($right)
1207 if ($this->hasRole(Profile_role::DELETED)) {
1211 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
1214 case Right::DELETEOTHERSNOTICE:
1215 case Right::MAKEGROUPADMIN:
1216 case Right::SANDBOXUSER:
1217 case Right::SILENCEUSER:
1218 case Right::DELETEUSER:
1219 case Right::DELETEGROUP:
1220 case Right::TRAINSPAM:
1221 case Right::REVIEWSPAM:
1222 $result = $this->hasRole(Profile_role::MODERATOR);
1224 case Right::CONFIGURESITE:
1225 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
1227 case Right::GRANTROLE:
1228 case Right::REVOKEROLE:
1229 $result = $this->hasRole(Profile_role::OWNER);
1231 case Right::NEWNOTICE:
1232 case Right::NEWMESSAGE:
1233 case Right::SUBSCRIBE:
1234 case Right::CREATEGROUP:
1235 $result = !$this->isSilenced();
1237 case Right::PUBLICNOTICE:
1238 case Right::EMAILONREPLY:
1239 case Right::EMAILONSUBSCRIBE:
1240 case Right::EMAILONFAVE:
1241 $result = !$this->isSandboxed();
1243 case Right::WEBLOGIN:
1244 $result = !$this->isSilenced();
1247 $result = !$this->isSilenced();
1249 case Right::BACKUPACCOUNT:
1250 $result = common_config('profile', 'backup');
1252 case Right::RESTOREACCOUNT:
1253 $result = common_config('profile', 'restore');
1255 case Right::DELETEACCOUNT:
1256 $result = common_config('profile', 'delete');
1258 case Right::MOVEACCOUNT:
1259 $result = common_config('profile', 'move');
1269 // FIXME: Can't put Notice typing here due to ArrayWrapper
1270 public function hasRepeated($notice)
1272 // XXX: not really a pkey, but should work
1274 $notice = Notice::pkeyGet(array('profile_id' => $this->id,
1275 'repeat_of' => $notice->id));
1277 return !empty($notice);
1281 * Returns an XML string fragment with limited profile information
1282 * as an Atom <author> element.
1284 * Assumes that Atom has been previously set up as the base namespace.
1286 * @param Profile $cur the current authenticated user
1290 function asAtomAuthor($cur = null)
1292 $xs = new XMLStringer(true);
1294 $xs->elementStart('author');
1295 $xs->element('name', null, $this->nickname);
1296 $xs->element('uri', null, $this->getUri());
1299 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1300 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
1301 $xs->element('statusnet:profile_info', $attrs, null);
1303 $xs->elementEnd('author');
1305 return $xs->getString();
1309 * Extra profile info for atom entries
1311 * Clients use some extra profile info in the atom stream.
1312 * This gives it to them.
1314 * @param User $cur Current user
1316 * @return array representation of <statusnet:profile_info> element or null
1319 function profileInfo($cur)
1321 $profileInfoAttr = array('local_id' => $this->id);
1324 // Whether the current user is a subscribed to this profile
1325 $profileInfoAttr['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1326 // Whether the current user is has blocked this profile
1327 $profileInfoAttr['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
1330 return array('statusnet:profile_info', $profileInfoAttr, null);
1334 * Returns an XML string fragment with profile information as an
1335 * Activity Streams <activity:actor> element.
1337 * Assumes that 'activity' namespace has been previously defined.
1341 function asActivityActor()
1343 return $this->asActivityNoun('actor');
1347 * Returns an XML string fragment with profile information as an
1348 * Activity Streams noun object with the given element type.
1350 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1351 * previously defined.
1353 * @param string $element one of 'actor', 'subject', 'object', 'target'
1357 function asActivityNoun($element)
1359 $noun = ActivityObject::fromProfile($this);
1360 return $noun->asString('activity:' . $element);
1364 * Returns the profile's canonical url, not necessarily a uri/unique id
1366 * @return string $profileurl
1368 public function getUrl()
1370 if (empty($this->profileurl) ||
1371 !filter_var($this->profileurl, FILTER_VALIDATE_URL)) {
1372 throw new InvalidUrlException($this->profileurl);
1374 return $this->profileurl;
1378 * Returns the best URI for a profile. Plugins may override.
1380 * @return string $uri
1382 public function getUri()
1386 // give plugins a chance to set the URI
1387 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1389 // check for a local user first
1390 $user = User::getKV('id', $this->id);
1392 if (!empty($user)) {
1396 Event::handle('EndGetProfileUri', array($this, &$uri));
1403 * Returns an assumed acct: URI for a profile. Plugins are required.
1405 * @return string $uri
1407 public function getAcctUri()
1411 if (Event::handle('StartGetProfileAcctUri', array($this, &$acct))) {
1412 Event::handle('EndGetProfileAcctUri', array($this, &$acct));
1415 if ($acct === null) {
1416 throw new ProfileNoAcctUriException($this);
1422 function hasBlocked($other)
1424 $block = Profile_block::exists($this, $other);
1425 return !empty($block);
1428 function getAtomFeed()
1432 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1433 $user = User::getKV('id', $this->id);
1434 if (!empty($user)) {
1435 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1436 'format' => 'atom'));
1438 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1444 static function fromURI($uri)
1448 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1450 $user = User::getKV('uri', $uri);
1451 if (!empty($user)) {
1452 $profile = $user->getProfile();
1454 Event::handle('EndGetProfileFromURI', array($uri, $profile));
1460 function canRead(Notice $notice)
1462 if ($notice->scope & Notice::SITE_SCOPE) {
1463 $user = $this->getUser();
1469 if ($notice->scope & Notice::ADDRESSEE_SCOPE) {
1470 $replies = $notice->getReplies();
1472 if (!in_array($this->id, $replies)) {
1473 $groups = $notice->getGroups();
1477 foreach ($groups as $group) {
1478 if ($this->isMember($group)) {
1490 if ($notice->scope & Notice::FOLLOWER_SCOPE) {
1491 $author = $notice->getProfile();
1492 if (!Subscription::exists($this, $author)) {
1500 static function current()
1502 $user = common_current_user();
1506 $profile = $user->getProfile();
1512 * Magic function called at serialize() time.
1514 * We use this to drop a couple process-specific references
1515 * from DB_DataObject which can cause trouble in future
1518 * @return array of variable names to include in serialization.
1523 $vars = parent::__sleep();
1524 $skip = array('_user', '_avatars');
1525 return array_diff($vars, $skip);
1528 public function getProfile()