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 public function isLocal()
113 } catch (NoSuchUserException $e) {
119 protected $_avatars = array();
121 public function getAvatar($width, $height=null)
123 return Avatar::byProfile($this, $width, $height);
126 public function setOriginal($filename)
128 $imagefile = new ImageFile($this->id, Avatar::path($filename));
130 $avatar = new Avatar();
131 $avatar->profile_id = $this->id;
132 $avatar->width = $imagefile->width;
133 $avatar->height = $imagefile->height;
134 $avatar->mediatype = image_type_to_mime_type($imagefile->type);
135 $avatar->filename = $filename;
136 $avatar->original = true;
137 $avatar->url = Avatar::url($filename);
138 $avatar->created = common_sql_now();
140 // XXX: start a transaction here
141 if (!Avatar::deleteFromProfile($this, true) || !$avatar->insert()) {
142 // If we can't delete the old avatars, let's abort right here.
143 @unlink(Avatar::path($filename));
147 foreach (array(AVATAR_PROFILE_SIZE, AVATAR_STREAM_SIZE, AVATAR_MINI_SIZE) as $size) {
148 // We don't do a scaled one if original is our scaled size
149 if (!($avatar->width == $size && $avatar->height == $size)) {
151 Avatar::newSize($this, $size);
152 } catch (Exception $e) {
153 // should we abort the generation and live without smaller avatars?
162 * Gets either the full name (if filled) or the nickname.
166 function getBestName()
168 return ($this->fullname) ? $this->fullname : $this->nickname;
172 * Gets the full name (if filled) with nickname as a parenthetical, or the nickname alone
173 * if no fullname is provided.
177 function getFancyName()
179 if ($this->fullname) {
180 // TRANS: Full name of a profile or group (%1$s) followed by nickname (%2$s) in parentheses.
181 return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->fullname, $this->nickname);
183 return $this->nickname;
188 * Get the most recent notice posted by this user, if any.
190 * @return mixed Notice or null
192 function getCurrentNotice()
194 $notice = $this->getNotices(0, 1);
196 if ($notice->fetch()) {
197 if ($notice instanceof ArrayWrapper) {
198 // hack for things trying to work with single notices
199 return $notice->_items[0];
207 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
209 $stream = new TaggedProfileNoticeStream($this, $tag);
211 return $stream->getNotices($offset, $limit, $since_id, $max_id);
214 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0, Profile $scoped=null)
216 $stream = new ProfileNoticeStream($this, $scoped);
218 return $stream->getNotices($offset, $limit, $since_id, $max_id);
221 function isMember($group)
223 $groups = $this->getGroups(0, null);
224 $gs = $groups->fetchAll();
225 foreach ($gs as $g) {
226 if ($group->id == $g->id) {
233 function isAdmin($group)
235 $gm = Group_member::pkeyGet(array('profile_id' => $this->id,
236 'group_id' => $group->id));
237 return (!empty($gm) && $gm->is_admin);
240 function isPendingMember($group)
242 $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
243 'group_id' => $group->id));
244 return !empty($request);
247 function getGroups($offset=0, $limit=PROFILES_PER_PAGE)
251 $keypart = sprintf('profile:groups:%d', $this->id);
253 $idstring = self::cacheGet($keypart);
255 if ($idstring !== false) {
256 $ids = explode(',', $idstring);
258 $gm = new Group_member();
260 $gm->profile_id = $this->id;
263 while ($gm->fetch()) {
264 $ids[] = $gm->group_id;
268 self::cacheSet($keypart, implode(',', $ids));
271 if (!is_null($offset) && !is_null($limit)) {
272 $ids = array_slice($ids, $offset, $limit);
275 return User_group::multiGet('id', $ids);
278 function isTagged($peopletag)
280 $tag = Profile_tag::pkeyGet(array('tagger' => $peopletag->tagger,
281 'tagged' => $this->id,
282 'tag' => $peopletag->tag));
286 function canTag($tagged)
288 if (empty($tagged)) {
292 if ($tagged->id == $this->id) {
296 $all = common_config('peopletag', 'allow_tagging', 'all');
297 $local = common_config('peopletag', 'allow_tagging', 'local');
298 $remote = common_config('peopletag', 'allow_tagging', 'remote');
299 $subs = common_config('peopletag', 'allow_tagging', 'subs');
305 $tagged_user = $tagged->getUser();
306 if (!empty($tagged_user)) {
311 return (Subscription::exists($this, $tagged) ||
312 Subscription::exists($tagged, $this));
313 } else if ($remote) {
319 function getLists($auth_user, $offset=0, $limit=null, $since_id=0, $max_id=0)
323 $keypart = sprintf('profile:lists:%d', $this->id);
325 $idstr = self::cacheGet($keypart);
327 if ($idstr !== false) {
328 $ids = explode(',', $idstr);
330 $list = new Profile_list();
332 $list->selectAdd('id');
333 $list->tagger = $this->id;
334 $list->selectAdd('id as "cursor"');
337 $list->whereAdd('id > '.$since_id);
341 $list->whereAdd('id <= '.$max_id);
344 if($offset>=0 && !is_null($limit)) {
345 $list->limit($offset, $limit);
348 $list->orderBy('id DESC');
351 while ($list->fetch()) {
356 self::cacheSet($keypart, implode(',', $ids));
359 $showPrivate = (($auth_user instanceof User ||
360 $auth_user instanceof Profile) &&
361 $auth_user->id === $this->id);
365 foreach ($ids as $id) {
366 $list = Profile_list::getKV('id', $id);
368 ($showPrivate || !$list->private)) {
370 if (!isset($list->cursor)) {
371 $list->cursor = $list->id;
378 return new ArrayWrapper($lists);
382 * Get tags that other people put on this profile, in reverse-chron order
384 * @param (Profile|User) $auth_user Authorized user (used for privacy)
385 * @param int $offset Offset from latest
386 * @param int $limit Max number to get
387 * @param datetime $since_id max date
388 * @param datetime $max_id min date
390 * @return Profile_list resulting lists
393 function getOtherTags($auth_user=null, $offset=0, $limit=null, $since_id=0, $max_id=0)
395 $list = new Profile_list();
397 $qry = sprintf('select profile_list.*, unix_timestamp(profile_tag.modified) as "cursor" ' .
398 'from profile_tag join profile_list '.
399 'on (profile_tag.tagger = profile_list.tagger ' .
400 ' and profile_tag.tag = profile_list.tag) ' .
401 'where profile_tag.tagged = %d ',
405 if ($auth_user instanceof User || $auth_user instanceof Profile) {
406 $qry .= sprintf('AND ( ( profile_list.private = false ) ' .
407 'OR ( profile_list.tagger = %d AND ' .
408 'profile_list.private = true ) )',
411 $qry .= 'AND profile_list.private = 0 ';
415 $qry .= sprintf('AND (cursor > %d) ', $since_id);
419 $qry .= sprintf('AND (cursor < %d) ', $max_id);
422 $qry .= 'ORDER BY profile_tag.modified DESC ';
424 if ($offset >= 0 && !is_null($limit)) {
425 $qry .= sprintf('LIMIT %d OFFSET %d ', $limit, $offset);
432 function getPrivateTags($offset=0, $limit=null, $since_id=0, $max_id=0)
434 $tags = new Profile_list();
435 $tags->private = true;
436 $tags->tagger = $this->id;
439 $tags->whereAdd('id > '.$since_id);
443 $tags->whereAdd('id <= '.$max_id);
446 if($offset>=0 && !is_null($limit)) {
447 $tags->limit($offset, $limit);
450 $tags->orderBy('id DESC');
456 function hasLocalTags()
458 $tags = new Profile_tag();
460 $tags->joinAdd(array('tagger', 'user:id'));
461 $tags->whereAdd('tagged = '.$this->id);
462 $tags->whereAdd('tagger != '.$this->id);
467 return ($tags->N == 0) ? false : true;
470 function getTagSubscriptions($offset=0, $limit=null, $since_id=0, $max_id=0)
472 $lists = new Profile_list();
473 $subs = new Profile_tag_subscription();
475 $lists->joinAdd(array('id', 'profile_tag_subscription:profile_tag_id'));
477 #@fixme: postgres (round(date_part('epoch', my_date)))
478 $lists->selectAdd('unix_timestamp(profile_tag_subscription.created) as "cursor"');
480 $lists->whereAdd('profile_tag_subscription.profile_id = '.$this->id);
483 $lists->whereAdd('cursor > '.$since_id);
487 $lists->whereAdd('cursor <= '.$max_id);
490 if($offset>=0 && !is_null($limit)) {
491 $lists->limit($offset, $limit);
494 $lists->orderBy('"cursor" DESC');
501 * Request to join the given group.
502 * May throw exceptions on failure.
504 * @param User_group $group
505 * @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
507 function joinGroup(User_group $group)
510 if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
511 $join = Group_join_queue::saveNew($this, $group);
513 if (Event::handle('StartJoinGroup', array($group, $this))) {
514 $join = Group_member::join($group->id, $this->id);
515 self::blow('profile:groups:%d', $this->id);
516 self::blow('group:member_ids:%d', $group->id);
517 self::blow('group:member_count:%d', $group->id);
518 Event::handle('EndJoinGroup', array($group, $this));
522 // Send any applicable notifications...
529 * Leave a group that this profile is a member of.
531 * @param User_group $group
533 function leaveGroup(User_group $group)
535 if (Event::handle('StartLeaveGroup', array($group, $this))) {
536 Group_member::leave($group->id, $this->id);
537 self::blow('profile:groups:%d', $this->id);
538 self::blow('group:member_ids:%d', $group->id);
539 self::blow('group:member_count:%d', $group->id);
540 Event::handle('EndLeaveGroup', array($group, $this));
544 function avatarUrl($size=AVATAR_PROFILE_SIZE)
546 return Avatar::urlByProfile($this, $size);
549 function getSubscribed($offset=0, $limit=null)
551 $subs = Subscription::getSubscribedIDs($this->id, $offset, $limit);
553 $profiles = Profile::listFind('id', $subs);
554 } catch (NoResultException $e) {
560 function getSubscribers($offset=0, $limit=null)
562 $subs = Subscription::getSubscriberIDs($this->id, $offset, $limit);
564 $profiles = Profile::listFind('id', $subs);
565 } catch (NoResultException $e) {
571 function getTaggedSubscribers($tag, $offset=0, $limit=null)
574 'SELECT profile.* ' .
575 'FROM profile JOIN subscription ' .
576 'ON profile.id = subscription.subscriber ' .
577 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
578 'AND profile_tag.tagger = subscription.subscribed) ' .
579 'WHERE subscription.subscribed = %d ' .
580 "AND profile_tag.tag = '%s' " .
581 'AND subscription.subscribed != subscription.subscriber ' .
582 'ORDER BY subscription.created DESC ';
585 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
588 $profile = new Profile();
590 $cnt = $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
595 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
598 'SELECT profile.* ' .
599 'FROM profile JOIN subscription ' .
600 'ON profile.id = subscription.subscribed ' .
601 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
602 'AND profile_tag.tagger = subscription.subscriber) ' .
603 'WHERE subscription.subscriber = %d ' .
604 "AND profile_tag.tag = '%s' " .
605 'AND subscription.subscribed != subscription.subscriber ' .
606 'ORDER BY subscription.created DESC ';
608 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
610 $profile = new Profile();
612 $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
618 * Get pending subscribers, who have not yet been approved.
624 function getRequests($offset=0, $limit=null)
627 'SELECT profile.* ' .
628 'FROM profile JOIN subscription_queue '.
629 'ON profile.id = subscription_queue.subscriber ' .
630 'WHERE subscription_queue.subscribed = %d ' .
631 'ORDER BY subscription_queue.created DESC ';
633 if ($limit != null) {
634 if (common_config('db','type') == 'pgsql') {
635 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
637 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
641 $members = new Profile();
643 $members->query(sprintf($qry, $this->id));
647 function subscriptionCount()
649 $c = Cache::instance();
652 $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
653 if (is_integer($cnt)) {
658 $sub = new Subscription();
659 $sub->subscriber = $this->id;
661 $cnt = (int) $sub->count('distinct subscribed');
663 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
666 $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
672 function subscriberCount()
674 $c = Cache::instance();
676 $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
677 if (is_integer($cnt)) {
682 $sub = new Subscription();
683 $sub->subscribed = $this->id;
684 $sub->whereAdd('subscriber != subscribed');
685 $cnt = (int) $sub->count('distinct subscriber');
688 $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
695 * Is this profile subscribed to another profile?
697 * @param Profile $other
700 function isSubscribed($other)
702 return Subscription::exists($this, $other);
706 * Check if a pending subscription request is outstanding for this...
708 * @param Profile $other
711 function hasPendingSubscription($other)
713 return Subscription_queue::exists($this, $other);
717 * Are these two profiles subscribed to each other?
719 * @param Profile $other
722 function mutuallySubscribed($other)
724 return $this->isSubscribed($other) &&
725 $other->isSubscribed($this);
728 function hasFave($notice)
730 $fave = Fave::pkeyGet(array('user_id' => $this->id,
731 'notice_id' => $notice->id));
732 return ((is_null($fave)) ? false : true);
737 $c = Cache::instance();
739 $cnt = $c->get(Cache::key('profile:fave_count:'.$this->id));
740 if (is_integer($cnt)) {
746 $faves->user_id = $this->id;
747 $cnt = (int) $faves->count('notice_id');
750 $c->set(Cache::key('profile:fave_count:'.$this->id), $cnt);
756 function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
758 return Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
761 function noticeCount()
763 $c = Cache::instance();
766 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
767 if (is_integer($cnt)) {
772 $notices = new Notice();
773 $notices->profile_id = $this->id;
774 $cnt = (int) $notices->count('distinct id');
777 $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
783 function blowFavesCache()
785 $cache = Cache::instance();
787 // Faves don't happen chronologically, so we need to blow
789 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id));
790 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id.';last'));
791 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id));
792 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id.';last'));
794 $this->blowFaveCount();
797 function blowSubscriberCount()
799 $c = Cache::instance();
801 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
805 function blowSubscriptionCount()
807 $c = Cache::instance();
809 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
813 function blowFaveCount()
815 $c = Cache::instance();
817 $c->delete(Cache::key('profile:fave_count:'.$this->id));
821 function blowNoticeCount()
823 $c = Cache::instance();
825 $c->delete(Cache::key('profile:notice_count:'.$this->id));
829 static function maxBio()
831 $biolimit = common_config('profile', 'biolimit');
832 // null => use global limit (distinct from 0!)
833 if (is_null($biolimit)) {
834 $biolimit = common_config('site', 'textlimit');
839 static function bioTooLong($bio)
841 $biolimit = self::maxBio();
842 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
845 function update($dataObject=false)
847 if (is_object($dataObject) && $this->nickname != $dataObject->nickname) {
849 $local = $this->getUser();
850 common_debug("Updating User ({$this->id}) nickname from {$dataObject->nickname} to {$this->nickname}");
851 $origuser = clone($local);
852 $local->nickname = $this->nickname;
853 $result = $local->updateKeys($origuser);
854 if ($result === false) {
855 common_log_db_error($local, 'UPDATE', __FILE__);
856 // TRANS: Server error thrown when user profile settings could not be updated.
857 throw new ServerException(_('Could not update user nickname.'));
860 // Clear the site owner, in case nickname changed
861 if ($local->hasRole(Profile_role::OWNER)) {
862 User::blow('user:site_owner');
864 } catch (NoSuchUserException $e) {
869 return parent::update($dataObject);
874 $this->_deleteNotices();
875 $this->_deleteSubscriptions();
876 $this->_deleteMessages();
877 $this->_deleteTags();
878 $this->_deleteBlocks();
879 Avatar::deleteFromProfile($this, true);
881 // Warning: delete() will run on the batch objects,
882 // not on individual objects.
883 $related = array('Reply',
886 Event::handle('ProfileDeleteRelated', array($this, &$related));
888 foreach ($related as $cls) {
890 $inst->profile_id = $this->id;
897 function _deleteNotices()
899 $notice = new Notice();
900 $notice->profile_id = $this->id;
902 if ($notice->find()) {
903 while ($notice->fetch()) {
904 $other = clone($notice);
910 function _deleteSubscriptions()
912 $sub = new Subscription();
913 $sub->subscriber = $this->id;
917 while ($sub->fetch()) {
918 $other = Profile::getKV('id', $sub->subscribed);
922 if ($other->id == $this->id) {
925 Subscription::cancel($this, $other);
928 $subd = new Subscription();
929 $subd->subscribed = $this->id;
932 while ($subd->fetch()) {
933 $other = Profile::getKV('id', $subd->subscriber);
937 if ($other->id == $this->id) {
940 Subscription::cancel($other, $this);
943 $self = new Subscription();
945 $self->subscriber = $this->id;
946 $self->subscribed = $this->id;
951 function _deleteMessages()
953 $msg = new Message();
954 $msg->from_profile = $this->id;
957 $msg = new Message();
958 $msg->to_profile = $this->id;
962 function _deleteTags()
964 $tag = new Profile_tag();
965 $tag->tagged = $this->id;
969 function _deleteBlocks()
971 $block = new Profile_block();
972 $block->blocked = $this->id;
975 $block = new Group_block();
976 $block->blocked = $this->id;
980 // XXX: identical to Notice::getLocation.
982 public function getLocation()
986 if (!empty($this->location_id) && !empty($this->location_ns)) {
987 $location = Location::fromId($this->location_id, $this->location_ns);
990 if (is_null($location)) { // no ID, or Location::fromId() failed
991 if (!empty($this->lat) && !empty($this->lon)) {
992 $location = Location::fromLatLon($this->lat, $this->lon);
996 if (is_null($location)) { // still haven't found it!
997 if (!empty($this->location)) {
998 $location = Location::fromName($this->location);
1005 public function shareLocation()
1007 $cfg = common_config('location', 'share');
1009 if ($cfg == 'always') {
1011 } else if ($cfg == 'never') {
1014 $share = common_config('location', 'sharedefault');
1016 // Check if user has a personal setting for this
1017 $prefs = User_location_prefs::getKV('user_id', $this->id);
1019 if (!empty($prefs)) {
1020 $share = $prefs->share_location;
1028 function hasRole($name)
1031 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
1032 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1034 $has_role = !empty($role);
1035 Event::handle('EndHasRole', array($this, $name, $has_role));
1040 function grantRole($name)
1042 if (Event::handle('StartGrantRole', array($this, $name))) {
1044 $role = new Profile_role();
1046 $role->profile_id = $this->id;
1047 $role->role = $name;
1048 $role->created = common_sql_now();
1050 $result = $role->insert();
1053 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
1056 if ($name == 'owner') {
1057 User::blow('user:site_owner');
1060 Event::handle('EndGrantRole', array($this, $name));
1066 function revokeRole($name)
1068 if (Event::handle('StartRevokeRole', array($this, $name))) {
1070 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1074 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
1075 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1076 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
1079 $result = $role->delete();
1082 common_log_db_error($role, 'DELETE', __FILE__);
1083 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
1084 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1085 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
1088 if ($name == 'owner') {
1089 User::blow('user:site_owner');
1092 Event::handle('EndRevokeRole', array($this, $name));
1098 function isSandboxed()
1100 return $this->hasRole(Profile_role::SANDBOXED);
1103 function isSilenced()
1105 return $this->hasRole(Profile_role::SILENCED);
1110 $this->grantRole(Profile_role::SANDBOXED);
1113 function unsandbox()
1115 $this->revokeRole(Profile_role::SANDBOXED);
1120 $this->grantRole(Profile_role::SILENCED);
1121 if (common_config('notice', 'hidespam')) {
1122 $this->flushVisibility();
1126 function unsilence()
1128 $this->revokeRole(Profile_role::SILENCED);
1129 if (common_config('notice', 'hidespam')) {
1130 $this->flushVisibility();
1134 function flushVisibility()
1137 $stream = new ProfileNoticeStream($this, $this);
1138 $ids = $stream->getNoticeIds(0, CachingNoticeStream::CACHE_WINDOW);
1139 foreach ($ids as $id) {
1140 self::blow('notice:in-scope-for:%d:null', $id);
1145 * Does this user have the right to do X?
1147 * With our role-based authorization, this is merely a lookup for whether the user
1148 * has a particular role. The implementation currently uses a switch statement
1149 * to determine if the user has the pre-defined role to exercise the right. Future
1150 * implementations may allow per-site roles, and different mappings of roles to rights.
1152 * @param $right string Name of the right, usually a constant in class Right
1153 * @return boolean whether the user has the right in question
1155 public function hasRight($right)
1159 if ($this->hasRole(Profile_role::DELETED)) {
1163 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
1166 case Right::DELETEOTHERSNOTICE:
1167 case Right::MAKEGROUPADMIN:
1168 case Right::SANDBOXUSER:
1169 case Right::SILENCEUSER:
1170 case Right::DELETEUSER:
1171 case Right::DELETEGROUP:
1172 case Right::TRAINSPAM:
1173 case Right::REVIEWSPAM:
1174 $result = $this->hasRole(Profile_role::MODERATOR);
1176 case Right::CONFIGURESITE:
1177 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
1179 case Right::GRANTROLE:
1180 case Right::REVOKEROLE:
1181 $result = $this->hasRole(Profile_role::OWNER);
1183 case Right::NEWNOTICE:
1184 case Right::NEWMESSAGE:
1185 case Right::SUBSCRIBE:
1186 case Right::CREATEGROUP:
1187 $result = !$this->isSilenced();
1189 case Right::PUBLICNOTICE:
1190 case Right::EMAILONREPLY:
1191 case Right::EMAILONSUBSCRIBE:
1192 case Right::EMAILONFAVE:
1193 $result = !$this->isSandboxed();
1195 case Right::WEBLOGIN:
1196 $result = !$this->isSilenced();
1199 $result = !$this->isSilenced();
1201 case Right::BACKUPACCOUNT:
1202 $result = common_config('profile', 'backup');
1204 case Right::RESTOREACCOUNT:
1205 $result = common_config('profile', 'restore');
1207 case Right::DELETEACCOUNT:
1208 $result = common_config('profile', 'delete');
1210 case Right::MOVEACCOUNT:
1211 $result = common_config('profile', 'move');
1221 // FIXME: Can't put Notice typing here due to ArrayWrapper
1222 public function hasRepeated($notice)
1224 // XXX: not really a pkey, but should work
1226 $notice = Notice::pkeyGet(array('profile_id' => $this->id,
1227 'repeat_of' => $notice->id));
1229 return !empty($notice);
1233 * Returns an XML string fragment with limited profile information
1234 * as an Atom <author> element.
1236 * Assumes that Atom has been previously set up as the base namespace.
1238 * @param Profile $cur the current authenticated user
1242 function asAtomAuthor($cur = null)
1244 $xs = new XMLStringer(true);
1246 $xs->elementStart('author');
1247 $xs->element('name', null, $this->nickname);
1248 $xs->element('uri', null, $this->getUri());
1251 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1252 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
1253 $xs->element('statusnet:profile_info', $attrs, null);
1255 $xs->elementEnd('author');
1257 return $xs->getString();
1261 * Extra profile info for atom entries
1263 * Clients use some extra profile info in the atom stream.
1264 * This gives it to them.
1266 * @param User $cur Current user
1268 * @return array representation of <statusnet:profile_info> element or null
1271 function profileInfo($cur)
1273 $profileInfoAttr = array('local_id' => $this->id);
1276 // Whether the current user is a subscribed to this profile
1277 $profileInfoAttr['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1278 // Whether the current user is has blocked this profile
1279 $profileInfoAttr['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
1282 return array('statusnet:profile_info', $profileInfoAttr, null);
1286 * Returns an XML string fragment with profile information as an
1287 * Activity Streams <activity:actor> element.
1289 * Assumes that 'activity' namespace has been previously defined.
1293 function asActivityActor()
1295 return $this->asActivityNoun('actor');
1299 * Returns an XML string fragment with profile information as an
1300 * Activity Streams noun object with the given element type.
1302 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1303 * previously defined.
1305 * @param string $element one of 'actor', 'subject', 'object', 'target'
1309 function asActivityNoun($element)
1311 $noun = ActivityObject::fromProfile($this);
1312 return $noun->asString('activity:' . $element);
1316 * Returns the profile's canonical url, not necessarily a uri/unique id
1318 * @return string $profileurl
1320 public function getUrl()
1322 if (empty($this->profileurl) ||
1323 !filter_var($this->profileurl, FILTER_VALIDATE_URL)) {
1324 throw new InvalidUrlException($this->profileurl);
1326 return $this->profileurl;
1330 * Returns the best URI for a profile. Plugins may override.
1332 * @return string $uri
1334 public function getUri()
1338 // give plugins a chance to set the URI
1339 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1341 // check for a local user first
1342 $user = User::getKV('id', $this->id);
1344 if (!empty($user)) {
1348 Event::handle('EndGetProfileUri', array($this, &$uri));
1355 * Returns an assumed acct: URI for a profile. Plugins are required.
1357 * @return string $uri
1359 public function getAcctUri()
1363 if (Event::handle('StartGetProfileAcctUri', array($this, &$acct))) {
1364 Event::handle('EndGetProfileAcctUri', array($this, &$acct));
1367 if ($acct === null) {
1368 throw new ProfileNoAcctUriException($this);
1374 function hasBlocked($other)
1376 $block = Profile_block::exists($this, $other);
1377 return !empty($block);
1380 function getAtomFeed()
1384 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1385 $user = User::getKV('id', $this->id);
1386 if (!empty($user)) {
1387 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1388 'format' => 'atom'));
1390 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1396 static function fromURI($uri)
1400 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1402 $user = User::getKV('uri', $uri);
1403 if (!empty($user)) {
1404 $profile = $user->getProfile();
1406 Event::handle('EndGetProfileFromURI', array($uri, $profile));
1412 function canRead(Notice $notice)
1414 if ($notice->scope & Notice::SITE_SCOPE) {
1415 $user = $this->getUser();
1421 if ($notice->scope & Notice::ADDRESSEE_SCOPE) {
1422 $replies = $notice->getReplies();
1424 if (!in_array($this->id, $replies)) {
1425 $groups = $notice->getGroups();
1429 foreach ($groups as $group) {
1430 if ($this->isMember($group)) {
1442 if ($notice->scope & Notice::FOLLOWER_SCOPE) {
1443 $author = $notice->getProfile();
1444 if (!Subscription::exists($this, $author)) {
1452 static function current()
1454 $user = common_current_user();
1458 $profile = $user->getProfile();
1464 * Magic function called at serialize() time.
1466 * We use this to drop a couple process-specific references
1467 * from DB_DataObject which can cause trouble in future
1470 * @return array of variable names to include in serialization.
1475 $vars = parent::__sleep();
1476 $skip = array('_user', '_avatars');
1477 return array_diff($vars, $skip);
1480 public function getProfile()