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);
367 * Request a subscription to another local or remote profile.
368 * This will result in either the subscription going through
369 * immediately, being queued for approval, or being rejected
372 * @param Profile $profile
373 * @return mixed: Subscription or Subscription_queue object on success
374 * @throws Exception of various types on invalid state
376 function subscribe($profile)
382 * Cancel an outstanding subscription request to the other profile.
384 * @param Profile $profile
386 function cancelSubscribe($profile)
388 $request = Subscribe_join_queue::pkeyGet(array('subscriber' => $this->id,
389 'subscribed' => $profile->id));
391 if (Event::handle('StartCancelSubscription', array($this, $profile))) {
393 Event::handle('EndCancelSubscription', array($this, $profile));
400 * @param <type> $profile
402 function completeSubscribe($profile)
407 function getSubscriptions($offset=0, $limit=null)
409 $subs = Subscription::bySubscriber($this->id,
415 while ($subs->fetch()) {
416 $profile = Profile::staticGet($subs->subscribed);
418 $profiles[] = $profile;
422 return new ArrayWrapper($profiles);
425 function getSubscribers($offset=0, $limit=null)
427 $subs = Subscription::bySubscribed($this->id,
433 while ($subs->fetch()) {
434 $profile = Profile::staticGet($subs->subscriber);
436 $profiles[] = $profile;
440 return new ArrayWrapper($profiles);
443 function subscriptionCount()
445 $c = Cache::instance();
448 $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
449 if (is_integer($cnt)) {
454 $sub = new Subscription();
455 $sub->subscriber = $this->id;
457 $cnt = (int) $sub->count('distinct subscribed');
459 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
462 $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
468 function subscriberCount()
470 $c = Cache::instance();
472 $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
473 if (is_integer($cnt)) {
478 $sub = new Subscription();
479 $sub->subscribed = $this->id;
480 $sub->whereAdd('subscriber != subscribed');
481 $cnt = (int) $sub->count('distinct subscriber');
484 $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
491 * Is this profile subscribed to another profile?
493 * @param Profile $other
496 function isSubscribed($other)
498 return Subscription::exists($this, $other);
502 * Are these two profiles subscribed to each other?
504 * @param Profile $other
507 function mutuallySubscribed($other)
509 return $this->isSubscribed($other) &&
510 $other->isSubscribed($this);
513 function hasFave($notice)
515 $cache = Cache::instance();
517 // XXX: Kind of a hack.
519 if (!empty($cache)) {
520 // This is the stream of favorite notices, in rev chron
521 // order. This forces it into cache.
523 $ids = Fave::idStream($this->id, 0, CachingNoticeStream::CACHE_WINDOW);
525 // If it's in the list, then it's a fave
527 if (in_array($notice->id, $ids)) {
531 // If we're not past the end of the cache window,
532 // then the cache has all available faves, so this one
535 if (count($ids) < CachingNoticeStream::CACHE_WINDOW) {
539 // Otherwise, cache doesn't have all faves;
540 // fall through to the default
543 $fave = Fave::pkeyGet(array('user_id' => $this->id,
544 'notice_id' => $notice->id));
545 return ((is_null($fave)) ? false : true);
550 $c = Cache::instance();
552 $cnt = $c->get(Cache::key('profile:fave_count:'.$this->id));
553 if (is_integer($cnt)) {
559 $faves->user_id = $this->id;
560 $cnt = (int) $faves->count('distinct notice_id');
563 $c->set(Cache::key('profile:fave_count:'.$this->id), $cnt);
569 function noticeCount()
571 $c = Cache::instance();
574 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
575 if (is_integer($cnt)) {
580 $notices = new Notice();
581 $notices->profile_id = $this->id;
582 $cnt = (int) $notices->count('distinct id');
585 $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
591 function blowFavesCache()
593 $cache = Cache::instance();
595 // Faves don't happen chronologically, so we need to blow
597 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id));
598 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id.';last'));
599 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id));
600 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id.';last'));
602 $this->blowFaveCount();
605 function blowSubscriberCount()
607 $c = Cache::instance();
609 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
613 function blowSubscriptionCount()
615 $c = Cache::instance();
617 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
621 function blowFaveCount()
623 $c = Cache::instance();
625 $c->delete(Cache::key('profile:fave_count:'.$this->id));
629 function blowNoticeCount()
631 $c = Cache::instance();
633 $c->delete(Cache::key('profile:notice_count:'.$this->id));
637 static function maxBio()
639 $biolimit = common_config('profile', 'biolimit');
640 // null => use global limit (distinct from 0!)
641 if (is_null($biolimit)) {
642 $biolimit = common_config('site', 'textlimit');
647 static function bioTooLong($bio)
649 $biolimit = self::maxBio();
650 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
655 $this->_deleteNotices();
656 $this->_deleteSubscriptions();
657 $this->_deleteMessages();
658 $this->_deleteTags();
659 $this->_deleteBlocks();
660 $this->delete_avatars();
662 // Warning: delete() will run on the batch objects,
663 // not on individual objects.
664 $related = array('Reply',
667 Event::handle('ProfileDeleteRelated', array($this, &$related));
669 foreach ($related as $cls) {
671 $inst->profile_id = $this->id;
678 function _deleteNotices()
680 $notice = new Notice();
681 $notice->profile_id = $this->id;
683 if ($notice->find()) {
684 while ($notice->fetch()) {
685 $other = clone($notice);
691 function _deleteSubscriptions()
693 $sub = new Subscription();
694 $sub->subscriber = $this->id;
698 while ($sub->fetch()) {
699 $other = Profile::staticGet('id', $sub->subscribed);
703 if ($other->id == $this->id) {
706 Subscription::cancel($this, $other);
709 $subd = new Subscription();
710 $subd->subscribed = $this->id;
713 while ($subd->fetch()) {
714 $other = Profile::staticGet('id', $subd->subscriber);
718 if ($other->id == $this->id) {
721 Subscription::cancel($other, $this);
724 $self = new Subscription();
726 $self->subscriber = $this->id;
727 $self->subscribed = $this->id;
732 function _deleteMessages()
734 $msg = new Message();
735 $msg->from_profile = $this->id;
738 $msg = new Message();
739 $msg->to_profile = $this->id;
743 function _deleteTags()
745 $tag = new Profile_tag();
746 $tag->tagged = $this->id;
750 function _deleteBlocks()
752 $block = new Profile_block();
753 $block->blocked = $this->id;
756 $block = new Group_block();
757 $block->blocked = $this->id;
761 // XXX: identical to Notice::getLocation.
763 function getLocation()
767 if (!empty($this->location_id) && !empty($this->location_ns)) {
768 $location = Location::fromId($this->location_id, $this->location_ns);
771 if (is_null($location)) { // no ID, or Location::fromId() failed
772 if (!empty($this->lat) && !empty($this->lon)) {
773 $location = Location::fromLatLon($this->lat, $this->lon);
777 if (is_null($location)) { // still haven't found it!
778 if (!empty($this->location)) {
779 $location = Location::fromName($this->location);
786 function hasRole($name)
789 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
790 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
792 $has_role = !empty($role);
793 Event::handle('EndHasRole', array($this, $name, $has_role));
798 function grantRole($name)
800 if (Event::handle('StartGrantRole', array($this, $name))) {
802 $role = new Profile_role();
804 $role->profile_id = $this->id;
806 $role->created = common_sql_now();
808 $result = $role->insert();
811 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
814 if ($name == 'owner') {
815 User::blow('user:site_owner');
818 Event::handle('EndGrantRole', array($this, $name));
824 function revokeRole($name)
826 if (Event::handle('StartRevokeRole', array($this, $name))) {
828 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
832 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
833 // TRANS: %1$s is the role name, %2$s is the user ID (number).
834 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
837 $result = $role->delete();
840 common_log_db_error($role, 'DELETE', __FILE__);
841 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
842 // TRANS: %1$s is the role name, %2$s is the user ID (number).
843 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
846 if ($name == 'owner') {
847 User::blow('user:site_owner');
850 Event::handle('EndRevokeRole', array($this, $name));
856 function isSandboxed()
858 return $this->hasRole(Profile_role::SANDBOXED);
861 function isSilenced()
863 return $this->hasRole(Profile_role::SILENCED);
868 $this->grantRole(Profile_role::SANDBOXED);
873 $this->revokeRole(Profile_role::SANDBOXED);
878 $this->grantRole(Profile_role::SILENCED);
883 $this->revokeRole(Profile_role::SILENCED);
887 * Does this user have the right to do X?
889 * With our role-based authorization, this is merely a lookup for whether the user
890 * has a particular role. The implementation currently uses a switch statement
891 * to determine if the user has the pre-defined role to exercise the right. Future
892 * implementations may allow per-site roles, and different mappings of roles to rights.
894 * @param $right string Name of the right, usually a constant in class Right
895 * @return boolean whether the user has the right in question
897 function hasRight($right)
901 if ($this->hasRole(Profile_role::DELETED)) {
905 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
908 case Right::DELETEOTHERSNOTICE:
909 case Right::MAKEGROUPADMIN:
910 case Right::SANDBOXUSER:
911 case Right::SILENCEUSER:
912 case Right::DELETEUSER:
913 case Right::DELETEGROUP:
914 $result = $this->hasRole(Profile_role::MODERATOR);
916 case Right::CONFIGURESITE:
917 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
919 case Right::GRANTROLE:
920 case Right::REVOKEROLE:
921 $result = $this->hasRole(Profile_role::OWNER);
923 case Right::NEWNOTICE:
924 case Right::NEWMESSAGE:
925 case Right::SUBSCRIBE:
926 case Right::CREATEGROUP:
927 $result = !$this->isSilenced();
929 case Right::PUBLICNOTICE:
930 case Right::EMAILONREPLY:
931 case Right::EMAILONSUBSCRIBE:
932 case Right::EMAILONFAVE:
933 $result = !$this->isSandboxed();
935 case Right::WEBLOGIN:
936 $result = !$this->isSilenced();
939 $result = !$this->isSilenced();
941 case Right::BACKUPACCOUNT:
942 $result = common_config('profile', 'backup');
944 case Right::RESTOREACCOUNT:
945 $result = common_config('profile', 'restore');
947 case Right::DELETEACCOUNT:
948 $result = common_config('profile', 'delete');
950 case Right::MOVEACCOUNT:
951 $result = common_config('profile', 'move');
961 function hasRepeated($notice_id)
963 // XXX: not really a pkey, but should work
965 $notice = Memcached_DataObject::pkeyGet('Notice',
966 array('profile_id' => $this->id,
967 'repeat_of' => $notice_id));
969 return !empty($notice);
973 * Returns an XML string fragment with limited profile information
974 * as an Atom <author> element.
976 * Assumes that Atom has been previously set up as the base namespace.
978 * @param Profile $cur the current authenticated user
982 function asAtomAuthor($cur = null)
984 $xs = new XMLStringer(true);
986 $xs->elementStart('author');
987 $xs->element('name', null, $this->nickname);
988 $xs->element('uri', null, $this->getUri());
991 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
992 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
993 $xs->element('statusnet:profile_info', $attrs, null);
995 $xs->elementEnd('author');
997 return $xs->getString();
1001 * Extra profile info for atom entries
1003 * Clients use some extra profile info in the atom stream.
1004 * This gives it to them.
1006 * @param User $cur Current user
1008 * @return array representation of <statusnet:profile_info> element or null
1011 function profileInfo($cur)
1013 $profileInfoAttr = array('local_id' => $this->id);
1016 // Whether the current user is a subscribed to this profile
1017 $profileInfoAttr['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1018 // Whether the current user is has blocked this profile
1019 $profileInfoAttr['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
1022 return array('statusnet:profile_info', $profileInfoAttr, null);
1026 * Returns an XML string fragment with profile information as an
1027 * Activity Streams <activity:actor> element.
1029 * Assumes that 'activity' namespace has been previously defined.
1033 function asActivityActor()
1035 return $this->asActivityNoun('actor');
1039 * Returns an XML string fragment with profile information as an
1040 * Activity Streams noun object with the given element type.
1042 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1043 * previously defined.
1045 * @param string $element one of 'actor', 'subject', 'object', 'target'
1049 function asActivityNoun($element)
1051 $noun = ActivityObject::fromProfile($this);
1052 return $noun->asString('activity:' . $element);
1056 * Returns the best URI for a profile. Plugins may override.
1058 * @return string $uri
1064 // give plugins a chance to set the URI
1065 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1067 // check for a local user first
1068 $user = User::staticGet('id', $this->id);
1070 if (!empty($user)) {
1073 // return OMB profile if any
1074 $remote = Remote_profile::staticGet('id', $this->id);
1075 if (!empty($remote)) {
1076 $uri = $remote->uri;
1079 Event::handle('EndGetProfileUri', array($this, &$uri));
1085 function hasBlocked($other)
1087 $block = Profile_block::get($this->id, $other->id);
1089 if (empty($block)) {
1098 function getAtomFeed()
1102 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1103 $user = User::staticGet('id', $this->id);
1104 if (!empty($user)) {
1105 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1106 'format' => 'atom'));
1108 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1114 static function fromURI($uri)
1118 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1119 // Get a local user or remote (OMB 0.1) profile
1120 $user = User::staticGet('uri', $uri);
1121 if (!empty($user)) {
1122 $profile = $user->getProfile();
1124 $remote_profile = Remote_profile::staticGet('uri', $uri);
1125 if (!empty($remote_profile)) {
1126 $profile = Profile::staticGet('id', $remote_profile->profile_id);
1129 Event::handle('EndGetProfileFromURI', array($uri, $profile));