3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, 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 Memcached_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
48 function staticGet($k,$v=NULL) {
49 return Memcached_DataObject::staticGet('Profile',$k,$v);
52 /* the code above is auto generated do not remove the tag below */
57 return User::staticGet('id', $this->id);
60 function getAvatar($width, $height=null)
62 if (is_null($height)) {
65 return Avatar::pkeyGet(array('profile_id' => $this->id,
67 'height' => $height));
70 function getOriginalAvatar()
72 $avatar = DB_DataObject::factory('avatar');
73 $avatar->profile_id = $this->id;
74 $avatar->original = true;
75 if ($avatar->find(true)) {
82 function setOriginal($filename)
84 $imagefile = new ImageFile($this->id, Avatar::path($filename));
86 $avatar = new Avatar();
87 $avatar->profile_id = $this->id;
88 $avatar->width = $imagefile->width;
89 $avatar->height = $imagefile->height;
90 $avatar->mediatype = image_type_to_mime_type($imagefile->type);
91 $avatar->filename = $filename;
92 $avatar->original = true;
93 $avatar->url = Avatar::url($filename);
94 $avatar->created = DB_DataObject_Cast::dateTime(); # current time
96 // XXX: start a transaction here
98 if (!$this->delete_avatars() || !$avatar->insert()) {
99 @unlink(Avatar::path($filename));
103 foreach (array(AVATAR_PROFILE_SIZE, AVATAR_STREAM_SIZE, AVATAR_MINI_SIZE) as $size) {
104 // We don't do a scaled one if original is our scaled size
105 if (!($avatar->width == $size && $avatar->height == $size)) {
106 $scaled_filename = $imagefile->resize($size);
108 //$scaled = DB_DataObject::factory('avatar');
109 $scaled = new Avatar();
110 $scaled->profile_id = $this->id;
111 $scaled->width = $size;
112 $scaled->height = $size;
113 $scaled->original = false;
114 $scaled->mediatype = image_type_to_mime_type($imagefile->type);
115 $scaled->filename = $scaled_filename;
116 $scaled->url = Avatar::url($scaled_filename);
117 $scaled->created = DB_DataObject_Cast::dateTime(); # current time
119 if (!$scaled->insert()) {
129 * Delete attached avatars for this user from the database and filesystem.
130 * This should be used instead of a batch delete() to ensure that files
131 * get removed correctly.
133 * @param boolean $original true to delete only the original-size file
136 function delete_avatars($original=true)
138 $avatar = new Avatar();
139 $avatar->profile_id = $this->id;
141 while ($avatar->fetch()) {
142 if ($avatar->original) {
143 if ($original == false) {
153 * Gets either the full name (if filled) or the nickname.
157 function getBestName()
159 return ($this->fullname) ? $this->fullname : $this->nickname;
163 * Gets the full name (if filled) with nickname as a parenthetical, or the nickname alone
164 * if no fullname is provided.
168 function getFancyName()
170 if ($this->fullname) {
171 // TRANS: Full name of a profile or group followed by nickname in parens
172 return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->fullname, $this->nickname);
174 return $this->nickname;
179 * Get the most recent notice posted by this user, if any.
181 * @return mixed Notice or null
184 function getCurrentNotice()
186 $notice = $this->getNotices(0, 1);
188 if ($notice->fetch()) {
189 if ($notice instanceof ArrayWrapper) {
190 // hack for things trying to work with single notices
191 return $notice->_items[0];
199 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
201 $stream = new TaggedProfileNoticeStream($this, $tag);
203 return $stream->getNotices($offset, $limit, $since_id, $max_id);
206 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
208 $stream = new ProfileNoticeStream($this);
210 return $stream->getNotices($offset, $limit, $since_id, $max_id);
213 function isMember($group)
215 $mem = new Group_member();
217 $mem->group_id = $group->id;
218 $mem->profile_id = $this->id;
227 function isAdmin($group)
229 $mem = new Group_member();
231 $mem->group_id = $group->id;
232 $mem->profile_id = $this->id;
242 function isPendingMember($group)
244 $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
245 'group_id' => $group->id));
246 return !empty($request);
249 function getGroups($offset=0, $limit=null)
252 'SELECT user_group.* ' .
253 'FROM user_group JOIN group_member '.
254 'ON user_group.id = group_member.group_id ' .
255 'WHERE group_member.profile_id = %d ' .
256 'ORDER BY group_member.created DESC ';
258 if ($offset>0 && !is_null($limit)) {
260 if (common_config('db','type') == 'pgsql') {
261 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
263 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
268 $groups = new User_group();
270 $cnt = $groups->query(sprintf($qry, $this->id));
276 * Request to join the given group.
277 * May throw exceptions on failure.
279 * @param User_group $group
280 * @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
282 function joinGroup(User_group $group)
285 if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
286 $join = Group_join_queue::saveNew($this, $group);
288 if (Event::handle('StartJoinGroup', array($group, $this))) {
289 $join = Group_member::join($group->id, $this->id);
290 Event::handle('EndJoinGroup', array($group, $this));
294 // Send any applicable notifications...
301 * Leave a group that this profile is a member of.
303 * @param User_group $group
305 function leaveGroup(User_group $group)
307 if (Event::handle('StartLeaveGroup', array($group, $this))) {
308 Group_member::leave($group->id, $this->id);
309 Event::handle('EndLeaveGroup', array($group, $this));
313 function avatarUrl($size=AVATAR_PROFILE_SIZE)
315 $avatar = $this->getAvatar($size);
317 return $avatar->displayUrl();
319 return Avatar::defaultImage($size);
323 function getSubscriptions($offset=0, $limit=null)
325 $subs = Subscription::bySubscriber($this->id,
331 while ($subs->fetch()) {
332 $profile = Profile::staticGet($subs->subscribed);
334 $profiles[] = $profile;
338 return new ArrayWrapper($profiles);
341 function getSubscribers($offset=0, $limit=null)
343 $subs = Subscription::bySubscribed($this->id,
349 while ($subs->fetch()) {
350 $profile = Profile::staticGet($subs->subscriber);
352 $profiles[] = $profile;
356 return new ArrayWrapper($profiles);
360 * Get pending subscribers, who have not yet been approved.
366 function getRequests($offset=0, $limit=null)
369 'SELECT profile.* ' .
370 'FROM profile JOIN subscription_queue '.
371 'ON profile.id = subscription_queue.subscriber ' .
372 'WHERE subscription_queue.subscribed = %d ' .
373 'ORDER BY subscription_queue.created DESC ';
375 if ($limit != null) {
376 if (common_config('db','type') == 'pgsql') {
377 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
379 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
383 $members = new Profile();
385 $members->query(sprintf($qry, $this->id));
389 function subscriptionCount()
391 $c = Cache::instance();
394 $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
395 if (is_integer($cnt)) {
400 $sub = new Subscription();
401 $sub->subscriber = $this->id;
403 $cnt = (int) $sub->count('distinct subscribed');
405 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
408 $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
414 function subscriberCount()
416 $c = Cache::instance();
418 $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
419 if (is_integer($cnt)) {
424 $sub = new Subscription();
425 $sub->subscribed = $this->id;
426 $sub->whereAdd('subscriber != subscribed');
427 $cnt = (int) $sub->count('distinct subscriber');
430 $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
437 * Is this profile subscribed to another profile?
439 * @param Profile $other
442 function isSubscribed($other)
444 return Subscription::exists($this, $other);
448 * Check if a pending subscription request is outstanding for this...
450 * @param Profile $other
453 function hasPendingSubscription($other)
455 return Subscription_queue::exists($this, $other);
459 * Are these two profiles subscribed to each other?
461 * @param Profile $other
464 function mutuallySubscribed($other)
466 return $this->isSubscribed($other) &&
467 $other->isSubscribed($this);
470 function hasFave($notice)
472 $cache = Cache::instance();
474 // XXX: Kind of a hack.
476 if (!empty($cache)) {
477 // This is the stream of favorite notices, in rev chron
478 // order. This forces it into cache.
480 $ids = Fave::idStream($this->id, 0, CachingNoticeStream::CACHE_WINDOW);
482 // If it's in the list, then it's a fave
484 if (in_array($notice->id, $ids)) {
488 // If we're not past the end of the cache window,
489 // then the cache has all available faves, so this one
492 if (count($ids) < CachingNoticeStream::CACHE_WINDOW) {
496 // Otherwise, cache doesn't have all faves;
497 // fall through to the default
500 $fave = Fave::pkeyGet(array('user_id' => $this->id,
501 'notice_id' => $notice->id));
502 return ((is_null($fave)) ? false : true);
507 $c = Cache::instance();
509 $cnt = $c->get(Cache::key('profile:fave_count:'.$this->id));
510 if (is_integer($cnt)) {
516 $faves->user_id = $this->id;
517 $cnt = (int) $faves->count('distinct notice_id');
520 $c->set(Cache::key('profile:fave_count:'.$this->id), $cnt);
526 function noticeCount()
528 $c = Cache::instance();
531 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
532 if (is_integer($cnt)) {
537 $notices = new Notice();
538 $notices->profile_id = $this->id;
539 $cnt = (int) $notices->count('distinct id');
542 $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
548 function blowFavesCache()
550 $cache = Cache::instance();
552 // Faves don't happen chronologically, so we need to blow
554 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id));
555 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id.';last'));
556 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id));
557 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id.';last'));
559 $this->blowFaveCount();
562 function blowSubscriberCount()
564 $c = Cache::instance();
566 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
570 function blowSubscriptionCount()
572 $c = Cache::instance();
574 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
578 function blowFaveCount()
580 $c = Cache::instance();
582 $c->delete(Cache::key('profile:fave_count:'.$this->id));
586 function blowNoticeCount()
588 $c = Cache::instance();
590 $c->delete(Cache::key('profile:notice_count:'.$this->id));
594 static function maxBio()
596 $biolimit = common_config('profile', 'biolimit');
597 // null => use global limit (distinct from 0!)
598 if (is_null($biolimit)) {
599 $biolimit = common_config('site', 'textlimit');
604 static function bioTooLong($bio)
606 $biolimit = self::maxBio();
607 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
612 $this->_deleteNotices();
613 $this->_deleteSubscriptions();
614 $this->_deleteMessages();
615 $this->_deleteTags();
616 $this->_deleteBlocks();
617 $this->delete_avatars();
619 // Warning: delete() will run on the batch objects,
620 // not on individual objects.
621 $related = array('Reply',
624 Event::handle('ProfileDeleteRelated', array($this, &$related));
626 foreach ($related as $cls) {
628 $inst->profile_id = $this->id;
635 function _deleteNotices()
637 $notice = new Notice();
638 $notice->profile_id = $this->id;
640 if ($notice->find()) {
641 while ($notice->fetch()) {
642 $other = clone($notice);
648 function _deleteSubscriptions()
650 $sub = new Subscription();
651 $sub->subscriber = $this->id;
655 while ($sub->fetch()) {
656 $other = Profile::staticGet('id', $sub->subscribed);
660 if ($other->id == $this->id) {
663 Subscription::cancel($this, $other);
666 $subd = new Subscription();
667 $subd->subscribed = $this->id;
670 while ($subd->fetch()) {
671 $other = Profile::staticGet('id', $subd->subscriber);
675 if ($other->id == $this->id) {
678 Subscription::cancel($other, $this);
681 $self = new Subscription();
683 $self->subscriber = $this->id;
684 $self->subscribed = $this->id;
689 function _deleteMessages()
691 $msg = new Message();
692 $msg->from_profile = $this->id;
695 $msg = new Message();
696 $msg->to_profile = $this->id;
700 function _deleteTags()
702 $tag = new Profile_tag();
703 $tag->tagged = $this->id;
707 function _deleteBlocks()
709 $block = new Profile_block();
710 $block->blocked = $this->id;
713 $block = new Group_block();
714 $block->blocked = $this->id;
718 // XXX: identical to Notice::getLocation.
720 function getLocation()
724 if (!empty($this->location_id) && !empty($this->location_ns)) {
725 $location = Location::fromId($this->location_id, $this->location_ns);
728 if (is_null($location)) { // no ID, or Location::fromId() failed
729 if (!empty($this->lat) && !empty($this->lon)) {
730 $location = Location::fromLatLon($this->lat, $this->lon);
734 if (is_null($location)) { // still haven't found it!
735 if (!empty($this->location)) {
736 $location = Location::fromName($this->location);
743 function hasRole($name)
746 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
747 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
749 $has_role = !empty($role);
750 Event::handle('EndHasRole', array($this, $name, $has_role));
755 function grantRole($name)
757 if (Event::handle('StartGrantRole', array($this, $name))) {
759 $role = new Profile_role();
761 $role->profile_id = $this->id;
763 $role->created = common_sql_now();
765 $result = $role->insert();
768 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
771 if ($name == 'owner') {
772 User::blow('user:site_owner');
775 Event::handle('EndGrantRole', array($this, $name));
781 function revokeRole($name)
783 if (Event::handle('StartRevokeRole', array($this, $name))) {
785 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
789 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
790 // TRANS: %1$s is the role name, %2$s is the user ID (number).
791 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
794 $result = $role->delete();
797 common_log_db_error($role, 'DELETE', __FILE__);
798 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
799 // TRANS: %1$s is the role name, %2$s is the user ID (number).
800 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
803 if ($name == 'owner') {
804 User::blow('user:site_owner');
807 Event::handle('EndRevokeRole', array($this, $name));
813 function isSandboxed()
815 return $this->hasRole(Profile_role::SANDBOXED);
818 function isSilenced()
820 return $this->hasRole(Profile_role::SILENCED);
825 $this->grantRole(Profile_role::SANDBOXED);
830 $this->revokeRole(Profile_role::SANDBOXED);
835 $this->grantRole(Profile_role::SILENCED);
840 $this->revokeRole(Profile_role::SILENCED);
844 * Does this user have the right to do X?
846 * With our role-based authorization, this is merely a lookup for whether the user
847 * has a particular role. The implementation currently uses a switch statement
848 * to determine if the user has the pre-defined role to exercise the right. Future
849 * implementations may allow per-site roles, and different mappings of roles to rights.
851 * @param $right string Name of the right, usually a constant in class Right
852 * @return boolean whether the user has the right in question
854 function hasRight($right)
858 if ($this->hasRole(Profile_role::DELETED)) {
862 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
865 case Right::DELETEOTHERSNOTICE:
866 case Right::MAKEGROUPADMIN:
867 case Right::SANDBOXUSER:
868 case Right::SILENCEUSER:
869 case Right::DELETEUSER:
870 case Right::DELETEGROUP:
871 $result = $this->hasRole(Profile_role::MODERATOR);
873 case Right::CONFIGURESITE:
874 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
876 case Right::GRANTROLE:
877 case Right::REVOKEROLE:
878 $result = $this->hasRole(Profile_role::OWNER);
880 case Right::NEWNOTICE:
881 case Right::NEWMESSAGE:
882 case Right::SUBSCRIBE:
883 case Right::CREATEGROUP:
884 $result = !$this->isSilenced();
886 case Right::PUBLICNOTICE:
887 case Right::EMAILONREPLY:
888 case Right::EMAILONSUBSCRIBE:
889 case Right::EMAILONFAVE:
890 $result = !$this->isSandboxed();
892 case Right::WEBLOGIN:
893 $result = !$this->isSilenced();
896 $result = !$this->isSilenced();
898 case Right::BACKUPACCOUNT:
899 $result = common_config('profile', 'backup');
901 case Right::RESTOREACCOUNT:
902 $result = common_config('profile', 'restore');
904 case Right::DELETEACCOUNT:
905 $result = common_config('profile', 'delete');
907 case Right::MOVEACCOUNT:
908 $result = common_config('profile', 'move');
918 function hasRepeated($notice_id)
920 // XXX: not really a pkey, but should work
922 $notice = Memcached_DataObject::pkeyGet('Notice',
923 array('profile_id' => $this->id,
924 'repeat_of' => $notice_id));
926 return !empty($notice);
930 * Returns an XML string fragment with limited profile information
931 * as an Atom <author> element.
933 * Assumes that Atom has been previously set up as the base namespace.
935 * @param Profile $cur the current authenticated user
939 function asAtomAuthor($cur = null)
941 $xs = new XMLStringer(true);
943 $xs->elementStart('author');
944 $xs->element('name', null, $this->nickname);
945 $xs->element('uri', null, $this->getUri());
948 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
949 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
950 $xs->element('statusnet:profile_info', $attrs, null);
952 $xs->elementEnd('author');
954 return $xs->getString();
958 * Extra profile info for atom entries
960 * Clients use some extra profile info in the atom stream.
961 * This gives it to them.
963 * @param User $cur Current user
965 * @return array representation of <statusnet:profile_info> element or null
968 function profileInfo($cur)
970 $profileInfoAttr = array('local_id' => $this->id);
973 // Whether the current user is a subscribed to this profile
974 $profileInfoAttr['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
975 // Whether the current user is has blocked this profile
976 $profileInfoAttr['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
979 return array('statusnet:profile_info', $profileInfoAttr, null);
983 * Returns an XML string fragment with profile information as an
984 * Activity Streams <activity:actor> element.
986 * Assumes that 'activity' namespace has been previously defined.
990 function asActivityActor()
992 return $this->asActivityNoun('actor');
996 * Returns an XML string fragment with profile information as an
997 * Activity Streams noun object with the given element type.
999 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1000 * previously defined.
1002 * @param string $element one of 'actor', 'subject', 'object', 'target'
1006 function asActivityNoun($element)
1008 $noun = ActivityObject::fromProfile($this);
1009 return $noun->asString('activity:' . $element);
1013 * Returns the best URI for a profile. Plugins may override.
1015 * @return string $uri
1021 // give plugins a chance to set the URI
1022 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1024 // check for a local user first
1025 $user = User::staticGet('id', $this->id);
1027 if (!empty($user)) {
1030 // return OMB profile if any
1031 $remote = Remote_profile::staticGet('id', $this->id);
1032 if (!empty($remote)) {
1033 $uri = $remote->uri;
1036 Event::handle('EndGetProfileUri', array($this, &$uri));
1042 function hasBlocked($other)
1044 $block = Profile_block::get($this->id, $other->id);
1046 if (empty($block)) {
1055 function getAtomFeed()
1059 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1060 $user = User::staticGet('id', $this->id);
1061 if (!empty($user)) {
1062 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1063 'format' => 'atom'));
1065 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1071 static function fromURI($uri)
1075 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1076 // Get a local user or remote (OMB 0.1) profile
1077 $user = User::staticGet('uri', $uri);
1078 if (!empty($user)) {
1079 $profile = $user->getProfile();
1081 $remote_profile = Remote_profile::staticGet('uri', $uri);
1082 if (!empty($remote_profile)) {
1083 $profile = Profile::staticGet('id', $remote_profile->profile_id);
1086 Event::handle('EndGetProfileFromURI', array($uri, $profile));