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()) {
195 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
197 $ids = Notice::stream(array($this, '_streamTaggedDirect'),
199 'profile:notice_ids_tagged:' . $this->id . ':' . $tag,
200 $offset, $limit, $since_id, $max_id);
201 return Notice::getStreamByIds($ids);
204 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
206 // XXX: I'm not sure this is going to be any faster. It probably isn't.
207 $ids = Notice::stream(array($this, '_streamDirect'),
209 'profile:notice_ids:' . $this->id,
210 $offset, $limit, $since_id, $max_id);
212 return Notice::getStreamByIds($ids);
215 function _streamTaggedDirect($tag, $offset, $limit, $since_id, $max_id)
217 // XXX It would be nice to do this without a join
219 $notice = new Notice();
222 "select id from notice join notice_tag on id=notice_id where tag='".
223 $notice->escape($tag) .
224 "' and profile_id=" . $notice->escape($this->id);
226 if ($since_id != 0) {
227 $query .= " and id > $since_id";
231 $query .= " and id <= $max_id";
234 $query .= ' order by id DESC';
236 if (!is_null($offset)) {
237 $query .= " LIMIT $limit OFFSET $offset";
240 $notice->query($query);
244 while ($notice->fetch()) {
245 $ids[] = $notice->id;
251 function _streamDirect($offset, $limit, $since_id, $max_id)
253 $notice = new Notice();
255 // Temporary hack until notice_profile_id_idx is updated
256 // to (profile_id, id) instead of (profile_id, created, id).
257 // It's been falling back to PRIMARY instead, which is really
258 // very inefficient for a profile that hasn't posted in a few
259 // months. Even though forcing the index will cause a filesort,
260 // it's usually going to be better.
261 if (common_config('db', 'type') == 'mysql') {
264 "select id from notice force index (notice_profile_id_idx) ".
265 "where profile_id=" . $notice->escape($this->id);
267 if ($since_id != 0) {
268 $query .= " and id > $since_id";
272 $query .= " and id <= $max_id";
275 $query .= ' order by id DESC';
277 if (!is_null($offset)) {
278 $query .= " LIMIT $limit OFFSET $offset";
281 $notice->query($query);
285 $notice->profile_id = $this->id;
287 $notice->selectAdd();
288 $notice->selectAdd('id');
290 if ($since_id != 0) {
291 $notice->whereAdd('id > ' . $since_id);
295 $notice->whereAdd('id <= ' . $max_id);
298 $notice->orderBy('id DESC');
300 if (!is_null($offset)) {
301 $notice->limit($offset, $limit);
309 while ($notice->fetch()) {
310 $ids[] = $notice->id;
316 function isMember($group)
318 $mem = new Group_member();
320 $mem->group_id = $group->id;
321 $mem->profile_id = $this->id;
330 function isAdmin($group)
332 $mem = new Group_member();
334 $mem->group_id = $group->id;
335 $mem->profile_id = $this->id;
345 function getGroups($offset=0, $limit=null)
348 'SELECT user_group.* ' .
349 'FROM user_group JOIN group_member '.
350 'ON user_group.id = group_member.group_id ' .
351 'WHERE group_member.profile_id = %d ' .
352 'ORDER BY group_member.created DESC ';
354 if ($offset>0 && !is_null($limit)) {
356 if (common_config('db','type') == 'pgsql') {
357 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
359 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
364 $groups = new User_group();
366 $cnt = $groups->query(sprintf($qry, $this->id));
371 function avatarUrl($size=AVATAR_PROFILE_SIZE)
373 $avatar = $this->getAvatar($size);
375 return $avatar->displayUrl();
377 return Avatar::defaultImage($size);
381 function getSubscriptions($offset=0, $limit=null)
384 'SELECT profile.* ' .
385 'FROM profile JOIN subscription ' .
386 'ON profile.id = subscription.subscribed ' .
387 'WHERE subscription.subscriber = %d ' .
388 'AND subscription.subscribed != subscription.subscriber ' .
389 'ORDER BY subscription.created DESC ';
391 if ($offset>0 && !is_null($limit)){
392 if (common_config('db','type') == 'pgsql') {
393 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
395 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
399 $profile = new Profile();
401 $profile->query(sprintf($qry, $this->id));
406 function getSubscribers($offset=0, $limit=null)
409 'SELECT profile.* ' .
410 'FROM profile JOIN subscription ' .
411 'ON profile.id = subscription.subscriber ' .
412 'WHERE subscription.subscribed = %d ' .
413 'AND subscription.subscribed != subscription.subscriber ' .
414 'ORDER BY subscription.created DESC ';
416 if ($offset>0 && !is_null($limit)){
418 if (common_config('db','type') == 'pgsql') {
419 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
421 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
426 $profile = new Profile();
428 $cnt = $profile->query(sprintf($qry, $this->id));
433 function getConnectedApps($offset = 0, $limit = null)
437 'FROM oauth_application_user u, oauth_application a ' .
438 'WHERE u.profile_id = %d ' .
439 'AND a.id = u.application_id ' .
440 'AND u.access_type > 0 ' .
441 'ORDER BY u.created DESC ';
444 if (common_config('db','type') == 'pgsql') {
445 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
447 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
451 $apps = new Oauth_application_user();
453 $cnt = $apps->query(sprintf($qry, $this->id));
458 function subscriptionCount()
460 $c = common_memcache();
463 $cnt = $c->get(common_cache_key('profile:subscription_count:'.$this->id));
464 if (is_integer($cnt)) {
469 $sub = new Subscription();
470 $sub->subscriber = $this->id;
472 $cnt = (int) $sub->count('distinct subscribed');
474 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
477 $c->set(common_cache_key('profile:subscription_count:'.$this->id), $cnt);
483 function subscriberCount()
485 $c = common_memcache();
487 $cnt = $c->get(common_cache_key('profile:subscriber_count:'.$this->id));
488 if (is_integer($cnt)) {
493 $sub = new Subscription();
494 $sub->subscribed = $this->id;
495 $sub->whereAdd('subscriber != subscribed');
496 $cnt = (int) $sub->count('distinct subscriber');
499 $c->set(common_cache_key('profile:subscriber_count:'.$this->id), $cnt);
506 * Is this profile subscribed to another profile?
508 * @param Profile $other
511 function isSubscribed($other)
513 return Subscription::exists($this, $other);
517 * Are these two profiles subscribed to each other?
519 * @param Profile $other
522 function mutuallySubscribed($other)
524 return $this->isSubscribed($other) &&
525 $other->isSubscribed($this);
528 function hasFave($notice)
530 $cache = common_memcache();
532 // XXX: Kind of a hack.
534 if (!empty($cache)) {
535 // This is the stream of favorite notices, in rev chron
536 // order. This forces it into cache.
538 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
540 // If it's in the list, then it's a fave
542 if (in_array($notice->id, $ids)) {
546 // If we're not past the end of the cache window,
547 // then the cache has all available faves, so this one
550 if (count($ids) < NOTICE_CACHE_WINDOW) {
554 // Otherwise, cache doesn't have all faves;
555 // fall through to the default
558 $fave = Fave::pkeyGet(array('user_id' => $this->id,
559 'notice_id' => $notice->id));
560 return ((is_null($fave)) ? false : true);
565 $c = common_memcache();
567 $cnt = $c->get(common_cache_key('profile:fave_count:'.$this->id));
568 if (is_integer($cnt)) {
574 $faves->user_id = $this->id;
575 $cnt = (int) $faves->count('distinct notice_id');
578 $c->set(common_cache_key('profile:fave_count:'.$this->id), $cnt);
584 function noticeCount()
586 $c = common_memcache();
589 $cnt = $c->get(common_cache_key('profile:notice_count:'.$this->id));
590 if (is_integer($cnt)) {
595 $notices = new Notice();
596 $notices->profile_id = $this->id;
597 $cnt = (int) $notices->count('distinct id');
600 $c->set(common_cache_key('profile:notice_count:'.$this->id), $cnt);
606 function blowFavesCache()
608 $cache = common_memcache();
610 // Faves don't happen chronologically, so we need to blow
612 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
613 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
614 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
615 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
617 $this->blowFaveCount();
620 function blowSubscriberCount()
622 $c = common_memcache();
624 $c->delete(common_cache_key('profile:subscriber_count:'.$this->id));
628 function blowSubscriptionCount()
630 $c = common_memcache();
632 $c->delete(common_cache_key('profile:subscription_count:'.$this->id));
636 function blowFaveCount()
638 $c = common_memcache();
640 $c->delete(common_cache_key('profile:fave_count:'.$this->id));
644 function blowNoticeCount()
646 $c = common_memcache();
648 $c->delete(common_cache_key('profile:notice_count:'.$this->id));
652 static function maxBio()
654 $biolimit = common_config('profile', 'biolimit');
655 // null => use global limit (distinct from 0!)
656 if (is_null($biolimit)) {
657 $biolimit = common_config('site', 'textlimit');
662 static function bioTooLong($bio)
664 $biolimit = self::maxBio();
665 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
670 $this->_deleteNotices();
671 $this->_deleteSubscriptions();
672 $this->_deleteMessages();
673 $this->_deleteTags();
674 $this->_deleteBlocks();
675 $this->delete_avatars();
677 // Warning: delete() will run on the batch objects,
678 // not on individual objects.
679 $related = array('Reply',
682 Event::handle('ProfileDeleteRelated', array($this, &$related));
684 foreach ($related as $cls) {
686 $inst->profile_id = $this->id;
693 function _deleteNotices()
695 $notice = new Notice();
696 $notice->profile_id = $this->id;
698 if ($notice->find()) {
699 while ($notice->fetch()) {
700 $other = clone($notice);
706 function _deleteSubscriptions()
708 $sub = new Subscription();
709 $sub->subscriber = $this->id;
713 while ($sub->fetch()) {
714 $other = Profile::staticGet('id', $sub->subscribed);
718 if ($other->id == $this->id) {
721 Subscription::cancel($this, $other);
724 $subd = new Subscription();
725 $subd->subscribed = $this->id;
728 while ($subd->fetch()) {
729 $other = Profile::staticGet('id', $subd->subscriber);
733 if ($other->id == $this->id) {
736 Subscription::cancel($other, $this);
739 $self = new Subscription();
741 $self->subscriber = $this->id;
742 $self->subscribed = $this->id;
747 function _deleteMessages()
749 $msg = new Message();
750 $msg->from_profile = $this->id;
753 $msg = new Message();
754 $msg->to_profile = $this->id;
758 function _deleteTags()
760 $tag = new Profile_tag();
761 $tag->tagged = $this->id;
765 function _deleteBlocks()
767 $block = new Profile_block();
768 $block->blocked = $this->id;
771 $block = new Group_block();
772 $block->blocked = $this->id;
776 // XXX: identical to Notice::getLocation.
778 function getLocation()
782 if (!empty($this->location_id) && !empty($this->location_ns)) {
783 $location = Location::fromId($this->location_id, $this->location_ns);
786 if (is_null($location)) { // no ID, or Location::fromId() failed
787 if (!empty($this->lat) && !empty($this->lon)) {
788 $location = Location::fromLatLon($this->lat, $this->lon);
792 if (is_null($location)) { // still haven't found it!
793 if (!empty($this->location)) {
794 $location = Location::fromName($this->location);
801 function hasRole($name)
804 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
805 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
807 $has_role = !empty($role);
808 Event::handle('EndHasRole', array($this, $name, $has_role));
813 function grantRole($name)
815 if (Event::handle('StartGrantRole', array($this, $name))) {
817 $role = new Profile_role();
819 $role->profile_id = $this->id;
821 $role->created = common_sql_now();
823 $result = $role->insert();
826 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
829 Event::handle('EndGrantRole', array($this, $name));
835 function revokeRole($name)
837 if (Event::handle('StartRevokeRole', array($this, $name))) {
839 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
843 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
844 // TRANS: %1$s is the role name, %2$s is the user ID (number).
845 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
848 $result = $role->delete();
851 common_log_db_error($role, 'DELETE', __FILE__);
852 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
853 // TRANS: %1$s is the role name, %2$s is the user ID (number).
854 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
857 Event::handle('EndRevokeRole', array($this, $name));
863 function isSandboxed()
865 return $this->hasRole(Profile_role::SANDBOXED);
868 function isSilenced()
870 return $this->hasRole(Profile_role::SILENCED);
875 $this->grantRole(Profile_role::SANDBOXED);
880 $this->revokeRole(Profile_role::SANDBOXED);
885 $this->grantRole(Profile_role::SILENCED);
890 $this->revokeRole(Profile_role::SILENCED);
894 * Does this user have the right to do X?
896 * With our role-based authorization, this is merely a lookup for whether the user
897 * has a particular role. The implementation currently uses a switch statement
898 * to determine if the user has the pre-defined role to exercise the right. Future
899 * implementations may allow per-site roles, and different mappings of roles to rights.
901 * @param $right string Name of the right, usually a constant in class Right
902 * @return boolean whether the user has the right in question
904 function hasRight($right)
908 if ($this->hasRole(Profile_role::DELETED)) {
912 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
915 case Right::DELETEOTHERSNOTICE:
916 case Right::MAKEGROUPADMIN:
917 case Right::SANDBOXUSER:
918 case Right::SILENCEUSER:
919 case Right::DELETEUSER:
920 case Right::DELETEGROUP:
921 $result = $this->hasRole(Profile_role::MODERATOR);
923 case Right::CONFIGURESITE:
924 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
926 case Right::GRANTROLE:
927 case Right::REVOKEROLE:
928 $result = $this->hasRole(Profile_role::OWNER);
930 case Right::NEWNOTICE:
931 case Right::NEWMESSAGE:
932 case Right::SUBSCRIBE:
933 $result = !$this->isSilenced();
935 case Right::PUBLICNOTICE:
936 case Right::EMAILONREPLY:
937 case Right::EMAILONSUBSCRIBE:
938 case Right::EMAILONFAVE:
939 $result = !$this->isSandboxed();
949 function hasRepeated($notice_id)
951 // XXX: not really a pkey, but should work
953 $notice = Memcached_DataObject::pkeyGet('Notice',
954 array('profile_id' => $this->id,
955 'repeat_of' => $notice_id));
957 return !empty($notice);
961 * Returns an XML string fragment with limited profile information
962 * as an Atom <author> element.
964 * Assumes that Atom has been previously set up as the base namespace.
966 * @param Profile $cur the current authenticated user
970 function asAtomAuthor($cur = null)
972 $xs = new XMLStringer(true);
974 $xs->elementStart('author');
975 $xs->element('name', null, $this->nickname);
976 $xs->element('uri', null, $this->getUri());
979 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
980 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
981 $xs->element('statusnet:profile_info', $attrs, null);
983 $xs->elementEnd('author');
985 return $xs->getString();
989 * Returns an XML string fragment with profile information as an
990 * Activity Streams <activity:actor> element.
992 * Assumes that 'activity' namespace has been previously defined.
996 function asActivityActor()
998 return $this->asActivityNoun('actor');
1002 * Returns an XML string fragment with profile information as an
1003 * Activity Streams noun object with the given element type.
1005 * Assumes that 'activity', 'georss', and 'poco' namespace has been
1006 * previously defined.
1008 * @param string $element one of 'actor', 'subject', 'object', 'target'
1012 function asActivityNoun($element)
1014 $noun = ActivityObject::fromProfile($this);
1015 return $noun->asString('activity:' . $element);
1019 * Returns the best URI for a profile. Plugins may override.
1021 * @return string $uri
1027 // give plugins a chance to set the URI
1028 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1030 // check for a local user first
1031 $user = User::staticGet('id', $this->id);
1033 if (!empty($user)) {
1036 // return OMB profile if any
1037 $remote = Remote_profile::staticGet('id', $this->id);
1038 if (!empty($remote)) {
1039 $uri = $remote->uri;
1042 Event::handle('EndGetProfileUri', array($this, &$uri));
1048 function hasBlocked($other)
1050 $block = Profile_block::get($this->id, $other->id);
1052 if (empty($block)) {
1061 function getAtomFeed()
1065 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1066 $user = User::staticGet('id', $this->id);
1067 if (!empty($user)) {
1068 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1069 'format' => 'atom'));
1071 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1077 static function fromURI($uri)
1081 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1082 // Get a local user or remote (OMB 0.1) profile
1083 $user = User::staticGet('uri', $uri);
1084 if (!empty($user)) {
1085 $profile = $user->getProfile();
1087 $remote_profile = Remote_profile::staticGet('uri', $uri);
1088 if (!empty($remote_profile)) {
1089 $profile = Profile::staticGet('id', $remote_profile->profile_id);
1092 Event::handle('EndGetProfileFromURI', array($uri, $profile));