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 $ids = Notice::stream(array($this, '_streamTaggedDirect'),
203 'profile:notice_ids_tagged:' . $this->id . ':' . $tag,
204 $offset, $limit, $since_id, $max_id);
205 return Notice::getStreamByIds($ids);
208 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
210 // XXX: I'm not sure this is going to be any faster. It probably isn't.
211 $ids = Notice::stream(array($this, '_streamDirect'),
213 'profile:notice_ids:' . $this->id,
214 $offset, $limit, $since_id, $max_id);
216 return Notice::getStreamByIds($ids);
219 function _streamTaggedDirect($tag, $offset, $limit, $since_id, $max_id)
221 // XXX It would be nice to do this without a join
222 // (necessary to do it efficiently on accounts with long history)
224 $notice = new Notice();
227 "select id from notice join notice_tag on id=notice_id where tag='".
228 $notice->escape($tag) .
229 "' and profile_id=" . intval($this->id);
231 $since = Notice::whereSinceId($since_id, 'id', 'notice.created');
233 $query .= " and ($since)";
236 $max = Notice::whereMaxId($max_id, 'id', 'notice.created');
238 $query .= " and ($max)";
241 $query .= ' order by notice.created DESC, id DESC';
243 if (!is_null($offset)) {
244 $query .= " LIMIT " . intval($limit) . " OFFSET " . intval($offset);
247 $notice->query($query);
251 while ($notice->fetch()) {
252 $ids[] = $notice->id;
258 function _streamDirect($offset, $limit, $since_id, $max_id)
260 $notice = new Notice();
262 $notice->profile_id = $this->id;
264 $notice->selectAdd();
265 $notice->selectAdd('id');
267 Notice::addWhereSinceId($notice, $since_id);
268 Notice::addWhereMaxId($notice, $max_id);
270 $notice->orderBy('created DESC, id DESC');
272 if (!is_null($offset)) {
273 $notice->limit($offset, $limit);
280 while ($notice->fetch()) {
281 $ids[] = $notice->id;
287 function isMember($group)
289 $mem = new Group_member();
291 $mem->group_id = $group->id;
292 $mem->profile_id = $this->id;
301 function isAdmin($group)
303 $mem = new Group_member();
305 $mem->group_id = $group->id;
306 $mem->profile_id = $this->id;
316 function getGroups($offset=0, $limit=null)
319 'SELECT user_group.* ' .
320 'FROM user_group JOIN group_member '.
321 'ON user_group.id = group_member.group_id ' .
322 'WHERE group_member.profile_id = %d ' .
323 'ORDER BY group_member.created DESC ';
325 if ($offset>0 && !is_null($limit)) {
327 if (common_config('db','type') == 'pgsql') {
328 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
330 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
335 $groups = new User_group();
337 $cnt = $groups->query(sprintf($qry, $this->id));
343 * Request to join the given group.
344 * May throw exceptions on failure.
346 * @param User_group $group
347 * @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
349 function joinGroup(User_group $group)
352 if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
353 $ok = Group_join_queue::saveNew($this, $group);
355 if (Event::handle('StartJoinGroup', array($group, $this))) {
356 $ok = Group_member::join($group->id, $this->id);
357 Event::handle('EndJoinGroup', array($group, $this));
364 * Leave a group that this profile is a member of.
366 * @param User_group $group
368 function leaveGroup(User_group $group)
370 if (Event::handle('StartLeaveGroup', array($group, $this))) {
371 Group_member::leave($group->id, $this->id);
372 Event::handle('EndLeaveGroup', array($group, $this));
376 function avatarUrl($size=AVATAR_PROFILE_SIZE)
378 $avatar = $this->getAvatar($size);
380 return $avatar->displayUrl();
382 return Avatar::defaultImage($size);
386 function getSubscriptions($offset=0, $limit=null)
388 $subs = Subscription::bySubscriber($this->id,
394 while ($subs->fetch()) {
395 $profile = Profile::staticGet($subs->subscribed);
397 $profiles[] = $profile;
401 return new ArrayWrapper($profiles);
404 function getSubscribers($offset=0, $limit=null)
406 $subs = Subscription::bySubscribed($this->id,
412 while ($subs->fetch()) {
413 $profile = Profile::staticGet($subs->subscriber);
415 $profiles[] = $profile;
419 return new ArrayWrapper($profiles);
422 function subscriptionCount()
424 $c = Cache::instance();
427 $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
428 if (is_integer($cnt)) {
433 $sub = new Subscription();
434 $sub->subscriber = $this->id;
436 $cnt = (int) $sub->count('distinct subscribed');
438 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
441 $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
447 function subscriberCount()
449 $c = Cache::instance();
451 $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
452 if (is_integer($cnt)) {
457 $sub = new Subscription();
458 $sub->subscribed = $this->id;
459 $sub->whereAdd('subscriber != subscribed');
460 $cnt = (int) $sub->count('distinct subscriber');
463 $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
470 * Is this profile subscribed to another profile?
472 * @param Profile $other
475 function isSubscribed($other)
477 return Subscription::exists($this, $other);
481 * Are these two profiles subscribed to each other?
483 * @param Profile $other
486 function mutuallySubscribed($other)
488 return $this->isSubscribed($other) &&
489 $other->isSubscribed($this);
492 function hasFave($notice)
494 $cache = Cache::instance();
496 // XXX: Kind of a hack.
498 if (!empty($cache)) {
499 // This is the stream of favorite notices, in rev chron
500 // order. This forces it into cache.
502 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
504 // If it's in the list, then it's a fave
506 if (in_array($notice->id, $ids)) {
510 // If we're not past the end of the cache window,
511 // then the cache has all available faves, so this one
514 if (count($ids) < NOTICE_CACHE_WINDOW) {
518 // Otherwise, cache doesn't have all faves;
519 // fall through to the default
522 $fave = Fave::pkeyGet(array('user_id' => $this->id,
523 'notice_id' => $notice->id));
524 return ((is_null($fave)) ? false : true);
529 $c = Cache::instance();
531 $cnt = $c->get(Cache::key('profile:fave_count:'.$this->id));
532 if (is_integer($cnt)) {
538 $faves->user_id = $this->id;
539 $cnt = (int) $faves->count('distinct notice_id');
542 $c->set(Cache::key('profile:fave_count:'.$this->id), $cnt);
548 function noticeCount()
550 $c = Cache::instance();
553 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
554 if (is_integer($cnt)) {
559 $notices = new Notice();
560 $notices->profile_id = $this->id;
561 $cnt = (int) $notices->count('distinct id');
564 $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
570 function blowFavesCache()
572 $cache = Cache::instance();
574 // Faves don't happen chronologically, so we need to blow
576 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id));
577 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id.';last'));
578 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id));
579 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id.';last'));
581 $this->blowFaveCount();
584 function blowSubscriberCount()
586 $c = Cache::instance();
588 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
592 function blowSubscriptionCount()
594 $c = Cache::instance();
596 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
600 function blowFaveCount()
602 $c = Cache::instance();
604 $c->delete(Cache::key('profile:fave_count:'.$this->id));
608 function blowNoticeCount()
610 $c = Cache::instance();
612 $c->delete(Cache::key('profile:notice_count:'.$this->id));
616 static function maxBio()
618 $biolimit = common_config('profile', 'biolimit');
619 // null => use global limit (distinct from 0!)
620 if (is_null($biolimit)) {
621 $biolimit = common_config('site', 'textlimit');
626 static function bioTooLong($bio)
628 $biolimit = self::maxBio();
629 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
634 $this->_deleteNotices();
635 $this->_deleteSubscriptions();
636 $this->_deleteMessages();
637 $this->_deleteTags();
638 $this->_deleteBlocks();
639 $this->delete_avatars();
641 // Warning: delete() will run on the batch objects,
642 // not on individual objects.
643 $related = array('Reply',
646 Event::handle('ProfileDeleteRelated', array($this, &$related));
648 foreach ($related as $cls) {
650 $inst->profile_id = $this->id;
657 function _deleteNotices()
659 $notice = new Notice();
660 $notice->profile_id = $this->id;
662 if ($notice->find()) {
663 while ($notice->fetch()) {
664 $other = clone($notice);
670 function _deleteSubscriptions()
672 $sub = new Subscription();
673 $sub->subscriber = $this->id;
677 while ($sub->fetch()) {
678 $other = Profile::staticGet('id', $sub->subscribed);
682 if ($other->id == $this->id) {
685 Subscription::cancel($this, $other);
688 $subd = new Subscription();
689 $subd->subscribed = $this->id;
692 while ($subd->fetch()) {
693 $other = Profile::staticGet('id', $subd->subscriber);
697 if ($other->id == $this->id) {
700 Subscription::cancel($other, $this);
703 $self = new Subscription();
705 $self->subscriber = $this->id;
706 $self->subscribed = $this->id;
711 function _deleteMessages()
713 $msg = new Message();
714 $msg->from_profile = $this->id;
717 $msg = new Message();
718 $msg->to_profile = $this->id;
722 function _deleteTags()
724 $tag = new Profile_tag();
725 $tag->tagged = $this->id;
729 function _deleteBlocks()
731 $block = new Profile_block();
732 $block->blocked = $this->id;
735 $block = new Group_block();
736 $block->blocked = $this->id;
740 // XXX: identical to Notice::getLocation.
742 function getLocation()
746 if (!empty($this->location_id) && !empty($this->location_ns)) {
747 $location = Location::fromId($this->location_id, $this->location_ns);
750 if (is_null($location)) { // no ID, or Location::fromId() failed
751 if (!empty($this->lat) && !empty($this->lon)) {
752 $location = Location::fromLatLon($this->lat, $this->lon);
756 if (is_null($location)) { // still haven't found it!
757 if (!empty($this->location)) {
758 $location = Location::fromName($this->location);
765 function hasRole($name)
768 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
769 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
771 $has_role = !empty($role);
772 Event::handle('EndHasRole', array($this, $name, $has_role));
777 function grantRole($name)
779 if (Event::handle('StartGrantRole', array($this, $name))) {
781 $role = new Profile_role();
783 $role->profile_id = $this->id;
785 $role->created = common_sql_now();
787 $result = $role->insert();
790 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
793 if ($name == 'owner') {
794 User::blow('user:site_owner');
797 Event::handle('EndGrantRole', array($this, $name));
803 function revokeRole($name)
805 if (Event::handle('StartRevokeRole', array($this, $name))) {
807 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
811 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
812 // TRANS: %1$s is the role name, %2$s is the user ID (number).
813 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
816 $result = $role->delete();
819 common_log_db_error($role, 'DELETE', __FILE__);
820 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
821 // TRANS: %1$s is the role name, %2$s is the user ID (number).
822 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
825 if ($name == 'owner') {
826 User::blow('user:site_owner');
829 Event::handle('EndRevokeRole', array($this, $name));
835 function isSandboxed()
837 return $this->hasRole(Profile_role::SANDBOXED);
840 function isSilenced()
842 return $this->hasRole(Profile_role::SILENCED);
847 $this->grantRole(Profile_role::SANDBOXED);
852 $this->revokeRole(Profile_role::SANDBOXED);
857 $this->grantRole(Profile_role::SILENCED);
862 $this->revokeRole(Profile_role::SILENCED);
866 * Does this user have the right to do X?
868 * With our role-based authorization, this is merely a lookup for whether the user
869 * has a particular role. The implementation currently uses a switch statement
870 * to determine if the user has the pre-defined role to exercise the right. Future
871 * implementations may allow per-site roles, and different mappings of roles to rights.
873 * @param $right string Name of the right, usually a constant in class Right
874 * @return boolean whether the user has the right in question
876 function hasRight($right)
880 if ($this->hasRole(Profile_role::DELETED)) {
884 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
887 case Right::DELETEOTHERSNOTICE:
888 case Right::MAKEGROUPADMIN:
889 case Right::SANDBOXUSER:
890 case Right::SILENCEUSER:
891 case Right::DELETEUSER:
892 case Right::DELETEGROUP:
893 $result = $this->hasRole(Profile_role::MODERATOR);
895 case Right::CONFIGURESITE:
896 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
898 case Right::GRANTROLE:
899 case Right::REVOKEROLE:
900 $result = $this->hasRole(Profile_role::OWNER);
902 case Right::NEWNOTICE:
903 case Right::NEWMESSAGE:
904 case Right::SUBSCRIBE:
905 case Right::CREATEGROUP:
906 $result = !$this->isSilenced();
908 case Right::PUBLICNOTICE:
909 case Right::EMAILONREPLY:
910 case Right::EMAILONSUBSCRIBE:
911 case Right::EMAILONFAVE:
912 $result = !$this->isSandboxed();
914 case Right::WEBLOGIN:
915 $result = !$this->isSilenced();
918 $result = !$this->isSilenced();
920 case Right::BACKUPACCOUNT:
921 $result = common_config('profile', 'backup');
923 case Right::RESTOREACCOUNT:
924 $result = common_config('profile', 'restore');
926 case Right::DELETEACCOUNT:
927 $result = common_config('profile', 'delete');
929 case Right::MOVEACCOUNT:
930 $result = common_config('profile', 'move');
940 function hasRepeated($notice_id)
942 // XXX: not really a pkey, but should work
944 $notice = Memcached_DataObject::pkeyGet('Notice',
945 array('profile_id' => $this->id,
946 'repeat_of' => $notice_id));
948 return !empty($notice);
952 * Returns an XML string fragment with limited profile information
953 * as an Atom <author> element.
955 * Assumes that Atom has been previously set up as the base namespace.
957 * @param Profile $cur the current authenticated user
961 function asAtomAuthor($cur = null)
963 $xs = new XMLStringer(true);
965 $xs->elementStart('author');
966 $xs->element('name', null, $this->nickname);
967 $xs->element('uri', null, $this->getUri());
970 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
971 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
972 $xs->element('statusnet:profile_info', $attrs, null);
974 $xs->elementEnd('author');
976 return $xs->getString();
980 * Extra profile info for atom entries
982 * Clients use some extra profile info in the atom stream.
983 * This gives it to them.
985 * @param User $cur Current user
987 * @return array representation of <statusnet:profile_info> element or null
990 function profileInfo($cur)
992 $profileInfoAttr = array('local_id' => $this->id);
995 // Whether the current user is a subscribed to this profile
996 $profileInfoAttr['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
997 // Whether the current user is has blocked this profile
998 $profileInfoAttr['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
1001 return array('statusnet:profile_info', $profileInfoAttr, null);
1005 * Returns an XML string fragment with profile information as an
1006 * Activity Streams <activity:actor> element.
1008 * Assumes that 'activity' namespace has been previously defined.
1012 function asActivityActor()
1014 return $this->asActivityNoun('actor');
1018 * Returns an XML string fragment with profile information as an
1019 * Activity Streams noun object with the given element type.
1021 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1022 * previously defined.
1024 * @param string $element one of 'actor', 'subject', 'object', 'target'
1028 function asActivityNoun($element)
1030 $noun = ActivityObject::fromProfile($this);
1031 return $noun->asString('activity:' . $element);
1035 * Returns the best URI for a profile. Plugins may override.
1037 * @return string $uri
1043 // give plugins a chance to set the URI
1044 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1046 // check for a local user first
1047 $user = User::staticGet('id', $this->id);
1049 if (!empty($user)) {
1052 // return OMB profile if any
1053 $remote = Remote_profile::staticGet('id', $this->id);
1054 if (!empty($remote)) {
1055 $uri = $remote->uri;
1058 Event::handle('EndGetProfileUri', array($this, &$uri));
1064 function hasBlocked($other)
1066 $block = Profile_block::get($this->id, $other->id);
1068 if (empty($block)) {
1077 function getAtomFeed()
1081 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1082 $user = User::staticGet('id', $this->id);
1083 if (!empty($user)) {
1084 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1085 'format' => 'atom'));
1087 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1093 static function fromURI($uri)
1097 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1098 // Get a local user or remote (OMB 0.1) profile
1099 $user = User::staticGet('uri', $uri);
1100 if (!empty($user)) {
1101 $profile = $user->getProfile();
1103 $remote_profile = Remote_profile::staticGet('uri', $uri);
1104 if (!empty($remote_profile)) {
1105 $profile = Profile::staticGet('id', $remote_profile->profile_id);
1108 Event::handle('EndGetProfileFromURI', array($uri, $profile));