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 * Cancel a pending group join...
303 * @param User_group $group
305 function cancelJoinGroup(User_group $group)
307 $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
308 'group_id' => $group->id));
310 if (Event::handle('StartCancelJoinGroup', array($group, $this))) {
312 Event::handle('EndCancelJoinGroup', array($group, $this));
318 * Complete a pending group join on our end...
320 * @param User_group $group
322 function completeJoinGroup(User_group $group)
325 $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
326 'group_id' => $group->id));
328 if (Event::handle('StartJoinGroup', array($group, $this))) {
329 $join = Group_member::join($group->id, $this->id);
331 Event::handle('EndJoinGroup', array($group, $this));
334 // TRANS: Exception thrown trying to approve a non-existing group join request.
335 throw new Exception(_('Invalid group join approval: not pending.'));
344 * Leave a group that this profile is a member of.
346 * @param User_group $group
348 function leaveGroup(User_group $group)
350 if (Event::handle('StartLeaveGroup', array($group, $this))) {
351 Group_member::leave($group->id, $this->id);
352 Event::handle('EndLeaveGroup', array($group, $this));
356 function avatarUrl($size=AVATAR_PROFILE_SIZE)
358 $avatar = $this->getAvatar($size);
360 return $avatar->displayUrl();
362 return Avatar::defaultImage($size);
366 function getSubscriptions($offset=0, $limit=null)
368 $subs = Subscription::bySubscriber($this->id,
374 while ($subs->fetch()) {
375 $profile = Profile::staticGet($subs->subscribed);
377 $profiles[] = $profile;
381 return new ArrayWrapper($profiles);
384 function getSubscribers($offset=0, $limit=null)
386 $subs = Subscription::bySubscribed($this->id,
392 while ($subs->fetch()) {
393 $profile = Profile::staticGet($subs->subscriber);
395 $profiles[] = $profile;
399 return new ArrayWrapper($profiles);
402 function subscriptionCount()
404 $c = Cache::instance();
407 $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
408 if (is_integer($cnt)) {
413 $sub = new Subscription();
414 $sub->subscriber = $this->id;
416 $cnt = (int) $sub->count('distinct subscribed');
418 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
421 $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
427 function subscriberCount()
429 $c = Cache::instance();
431 $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
432 if (is_integer($cnt)) {
437 $sub = new Subscription();
438 $sub->subscribed = $this->id;
439 $sub->whereAdd('subscriber != subscribed');
440 $cnt = (int) $sub->count('distinct subscriber');
443 $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
450 * Is this profile subscribed to another profile?
452 * @param Profile $other
455 function isSubscribed($other)
457 return Subscription::exists($this, $other);
461 * Are these two profiles subscribed to each other?
463 * @param Profile $other
466 function mutuallySubscribed($other)
468 return $this->isSubscribed($other) &&
469 $other->isSubscribed($this);
472 function hasFave($notice)
474 $cache = Cache::instance();
476 // XXX: Kind of a hack.
478 if (!empty($cache)) {
479 // This is the stream of favorite notices, in rev chron
480 // order. This forces it into cache.
482 $ids = Fave::idStream($this->id, 0, CachingNoticeStream::CACHE_WINDOW);
484 // If it's in the list, then it's a fave
486 if (in_array($notice->id, $ids)) {
490 // If we're not past the end of the cache window,
491 // then the cache has all available faves, so this one
494 if (count($ids) < CachingNoticeStream::CACHE_WINDOW) {
498 // Otherwise, cache doesn't have all faves;
499 // fall through to the default
502 $fave = Fave::pkeyGet(array('user_id' => $this->id,
503 'notice_id' => $notice->id));
504 return ((is_null($fave)) ? false : true);
509 $c = Cache::instance();
511 $cnt = $c->get(Cache::key('profile:fave_count:'.$this->id));
512 if (is_integer($cnt)) {
518 $faves->user_id = $this->id;
519 $cnt = (int) $faves->count('distinct notice_id');
522 $c->set(Cache::key('profile:fave_count:'.$this->id), $cnt);
528 function noticeCount()
530 $c = Cache::instance();
533 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
534 if (is_integer($cnt)) {
539 $notices = new Notice();
540 $notices->profile_id = $this->id;
541 $cnt = (int) $notices->count('distinct id');
544 $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
550 function blowFavesCache()
552 $cache = Cache::instance();
554 // Faves don't happen chronologically, so we need to blow
556 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id));
557 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id.';last'));
558 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id));
559 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id.';last'));
561 $this->blowFaveCount();
564 function blowSubscriberCount()
566 $c = Cache::instance();
568 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
572 function blowSubscriptionCount()
574 $c = Cache::instance();
576 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
580 function blowFaveCount()
582 $c = Cache::instance();
584 $c->delete(Cache::key('profile:fave_count:'.$this->id));
588 function blowNoticeCount()
590 $c = Cache::instance();
592 $c->delete(Cache::key('profile:notice_count:'.$this->id));
596 static function maxBio()
598 $biolimit = common_config('profile', 'biolimit');
599 // null => use global limit (distinct from 0!)
600 if (is_null($biolimit)) {
601 $biolimit = common_config('site', 'textlimit');
606 static function bioTooLong($bio)
608 $biolimit = self::maxBio();
609 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
614 $this->_deleteNotices();
615 $this->_deleteSubscriptions();
616 $this->_deleteMessages();
617 $this->_deleteTags();
618 $this->_deleteBlocks();
619 $this->delete_avatars();
621 // Warning: delete() will run on the batch objects,
622 // not on individual objects.
623 $related = array('Reply',
626 Event::handle('ProfileDeleteRelated', array($this, &$related));
628 foreach ($related as $cls) {
630 $inst->profile_id = $this->id;
637 function _deleteNotices()
639 $notice = new Notice();
640 $notice->profile_id = $this->id;
642 if ($notice->find()) {
643 while ($notice->fetch()) {
644 $other = clone($notice);
650 function _deleteSubscriptions()
652 $sub = new Subscription();
653 $sub->subscriber = $this->id;
657 while ($sub->fetch()) {
658 $other = Profile::staticGet('id', $sub->subscribed);
662 if ($other->id == $this->id) {
665 Subscription::cancel($this, $other);
668 $subd = new Subscription();
669 $subd->subscribed = $this->id;
672 while ($subd->fetch()) {
673 $other = Profile::staticGet('id', $subd->subscriber);
677 if ($other->id == $this->id) {
680 Subscription::cancel($other, $this);
683 $self = new Subscription();
685 $self->subscriber = $this->id;
686 $self->subscribed = $this->id;
691 function _deleteMessages()
693 $msg = new Message();
694 $msg->from_profile = $this->id;
697 $msg = new Message();
698 $msg->to_profile = $this->id;
702 function _deleteTags()
704 $tag = new Profile_tag();
705 $tag->tagged = $this->id;
709 function _deleteBlocks()
711 $block = new Profile_block();
712 $block->blocked = $this->id;
715 $block = new Group_block();
716 $block->blocked = $this->id;
720 // XXX: identical to Notice::getLocation.
722 function getLocation()
726 if (!empty($this->location_id) && !empty($this->location_ns)) {
727 $location = Location::fromId($this->location_id, $this->location_ns);
730 if (is_null($location)) { // no ID, or Location::fromId() failed
731 if (!empty($this->lat) && !empty($this->lon)) {
732 $location = Location::fromLatLon($this->lat, $this->lon);
736 if (is_null($location)) { // still haven't found it!
737 if (!empty($this->location)) {
738 $location = Location::fromName($this->location);
745 function hasRole($name)
748 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
749 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
751 $has_role = !empty($role);
752 Event::handle('EndHasRole', array($this, $name, $has_role));
757 function grantRole($name)
759 if (Event::handle('StartGrantRole', array($this, $name))) {
761 $role = new Profile_role();
763 $role->profile_id = $this->id;
765 $role->created = common_sql_now();
767 $result = $role->insert();
770 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
773 if ($name == 'owner') {
774 User::blow('user:site_owner');
777 Event::handle('EndGrantRole', array($this, $name));
783 function revokeRole($name)
785 if (Event::handle('StartRevokeRole', array($this, $name))) {
787 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
791 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
792 // TRANS: %1$s is the role name, %2$s is the user ID (number).
793 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
796 $result = $role->delete();
799 common_log_db_error($role, 'DELETE', __FILE__);
800 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
801 // TRANS: %1$s is the role name, %2$s is the user ID (number).
802 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
805 if ($name == 'owner') {
806 User::blow('user:site_owner');
809 Event::handle('EndRevokeRole', array($this, $name));
815 function isSandboxed()
817 return $this->hasRole(Profile_role::SANDBOXED);
820 function isSilenced()
822 return $this->hasRole(Profile_role::SILENCED);
827 $this->grantRole(Profile_role::SANDBOXED);
832 $this->revokeRole(Profile_role::SANDBOXED);
837 $this->grantRole(Profile_role::SILENCED);
842 $this->revokeRole(Profile_role::SILENCED);
846 * Does this user have the right to do X?
848 * With our role-based authorization, this is merely a lookup for whether the user
849 * has a particular role. The implementation currently uses a switch statement
850 * to determine if the user has the pre-defined role to exercise the right. Future
851 * implementations may allow per-site roles, and different mappings of roles to rights.
853 * @param $right string Name of the right, usually a constant in class Right
854 * @return boolean whether the user has the right in question
856 function hasRight($right)
860 if ($this->hasRole(Profile_role::DELETED)) {
864 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
867 case Right::DELETEOTHERSNOTICE:
868 case Right::MAKEGROUPADMIN:
869 case Right::SANDBOXUSER:
870 case Right::SILENCEUSER:
871 case Right::DELETEUSER:
872 case Right::DELETEGROUP:
873 $result = $this->hasRole(Profile_role::MODERATOR);
875 case Right::CONFIGURESITE:
876 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
878 case Right::GRANTROLE:
879 case Right::REVOKEROLE:
880 $result = $this->hasRole(Profile_role::OWNER);
882 case Right::NEWNOTICE:
883 case Right::NEWMESSAGE:
884 case Right::SUBSCRIBE:
885 case Right::CREATEGROUP:
886 $result = !$this->isSilenced();
888 case Right::PUBLICNOTICE:
889 case Right::EMAILONREPLY:
890 case Right::EMAILONSUBSCRIBE:
891 case Right::EMAILONFAVE:
892 $result = !$this->isSandboxed();
894 case Right::WEBLOGIN:
895 $result = !$this->isSilenced();
898 $result = !$this->isSilenced();
900 case Right::BACKUPACCOUNT:
901 $result = common_config('profile', 'backup');
903 case Right::RESTOREACCOUNT:
904 $result = common_config('profile', 'restore');
906 case Right::DELETEACCOUNT:
907 $result = common_config('profile', 'delete');
909 case Right::MOVEACCOUNT:
910 $result = common_config('profile', 'move');
920 function hasRepeated($notice_id)
922 // XXX: not really a pkey, but should work
924 $notice = Memcached_DataObject::pkeyGet('Notice',
925 array('profile_id' => $this->id,
926 'repeat_of' => $notice_id));
928 return !empty($notice);
932 * Returns an XML string fragment with limited profile information
933 * as an Atom <author> element.
935 * Assumes that Atom has been previously set up as the base namespace.
937 * @param Profile $cur the current authenticated user
941 function asAtomAuthor($cur = null)
943 $xs = new XMLStringer(true);
945 $xs->elementStart('author');
946 $xs->element('name', null, $this->nickname);
947 $xs->element('uri', null, $this->getUri());
950 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
951 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
952 $xs->element('statusnet:profile_info', $attrs, null);
954 $xs->elementEnd('author');
956 return $xs->getString();
960 * Extra profile info for atom entries
962 * Clients use some extra profile info in the atom stream.
963 * This gives it to them.
965 * @param User $cur Current user
967 * @return array representation of <statusnet:profile_info> element or null
970 function profileInfo($cur)
972 $profileInfoAttr = array('local_id' => $this->id);
975 // Whether the current user is a subscribed to this profile
976 $profileInfoAttr['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
977 // Whether the current user is has blocked this profile
978 $profileInfoAttr['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
981 return array('statusnet:profile_info', $profileInfoAttr, null);
985 * Returns an XML string fragment with profile information as an
986 * Activity Streams <activity:actor> element.
988 * Assumes that 'activity' namespace has been previously defined.
992 function asActivityActor()
994 return $this->asActivityNoun('actor');
998 * Returns an XML string fragment with profile information as an
999 * Activity Streams noun object with the given element type.
1001 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1002 * previously defined.
1004 * @param string $element one of 'actor', 'subject', 'object', 'target'
1008 function asActivityNoun($element)
1010 $noun = ActivityObject::fromProfile($this);
1011 return $noun->asString('activity:' . $element);
1015 * Returns the best URI for a profile. Plugins may override.
1017 * @return string $uri
1023 // give plugins a chance to set the URI
1024 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1026 // check for a local user first
1027 $user = User::staticGet('id', $this->id);
1029 if (!empty($user)) {
1032 // return OMB profile if any
1033 $remote = Remote_profile::staticGet('id', $this->id);
1034 if (!empty($remote)) {
1035 $uri = $remote->uri;
1038 Event::handle('EndGetProfileUri', array($this, &$uri));
1044 function hasBlocked($other)
1046 $block = Profile_block::get($this->id, $other->id);
1048 if (empty($block)) {
1057 function getAtomFeed()
1061 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1062 $user = User::staticGet('id', $this->id);
1063 if (!empty($user)) {
1064 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1065 'format' => 'atom'));
1067 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1073 static function fromURI($uri)
1077 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1078 // Get a local user or remote (OMB 0.1) profile
1079 $user = User::staticGet('uri', $uri);
1080 if (!empty($user)) {
1081 $profile = $user->getProfile();
1083 $remote_profile = Remote_profile::staticGet('uri', $uri);
1084 if (!empty($remote_profile)) {
1085 $profile = Profile::staticGet('id', $remote_profile->profile_id);
1088 Event::handle('EndGetProfileFromURI', array($uri, $profile));