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)) {
107 $scaled_filename = $imagefile->resize($size);
109 //$scaled = DB_DataObject::factory('avatar');
110 $scaled = new Avatar();
111 $scaled->profile_id = $this->id;
112 $scaled->width = $size;
113 $scaled->height = $size;
114 $scaled->original = false;
115 $scaled->mediatype = image_type_to_mime_type($imagefile->type);
116 $scaled->filename = $scaled_filename;
117 $scaled->url = Avatar::url($scaled_filename);
118 $scaled->created = DB_DataObject_Cast::dateTime(); # current time
120 if (!$scaled->insert()) {
129 function delete_avatars($original=true)
131 $avatar = new Avatar();
132 $avatar->profile_id = $this->id;
134 while ($avatar->fetch()) {
135 if ($avatar->original) {
136 if ($original == false) {
145 function getBestName()
147 return ($this->fullname) ? $this->fullname : $this->nickname;
151 * Get the most recent notice posted by this user, if any.
153 * @return mixed Notice or null
156 function getCurrentNotice()
158 $notice = $this->getNotices(0, 1);
160 if ($notice->fetch()) {
167 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
169 $ids = Notice::stream(array($this, '_streamTaggedDirect'),
171 'profile:notice_ids_tagged:' . $this->id . ':' . $tag,
172 $offset, $limit, $since_id, $max_id);
173 return Notice::getStreamByIds($ids);
176 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
178 // XXX: I'm not sure this is going to be any faster. It probably isn't.
179 $ids = Notice::stream(array($this, '_streamDirect'),
181 'profile:notice_ids:' . $this->id,
182 $offset, $limit, $since_id, $max_id);
184 return Notice::getStreamByIds($ids);
187 function _streamTaggedDirect($tag, $offset, $limit, $since_id, $max_id)
189 // XXX It would be nice to do this without a join
191 $notice = new Notice();
194 "select id from notice join notice_tag on id=notice_id where tag='".
195 $notice->escape($tag) .
196 "' and profile_id=" . $notice->escape($this->id);
198 if ($since_id != 0) {
199 $query .= " and id > $since_id";
203 $query .= " and id < $max_id";
206 $query .= ' order by id DESC';
208 if (!is_null($offset)) {
209 $query .= " LIMIT $limit OFFSET $offset";
212 $notice->query($query);
216 while ($notice->fetch()) {
217 $ids[] = $notice->id;
223 function _streamDirect($offset, $limit, $since_id, $max_id)
225 $notice = new Notice();
227 // Temporary hack until notice_profile_id_idx is updated
228 // to (profile_id, id) instead of (profile_id, created, id).
229 // It's been falling back to PRIMARY instead, which is really
230 // very inefficient for a profile that hasn't posted in a few
231 // months. Even though forcing the index will cause a filesort,
232 // it's usually going to be better.
233 if (common_config('db', 'type') == 'mysql') {
236 "select id from notice force index (notice_profile_id_idx) ".
237 "where profile_id=" . $notice->escape($this->id);
239 if ($since_id != 0) {
240 $query .= " and id > $since_id";
244 $query .= " and id < $max_id";
247 $query .= ' order by id DESC';
249 if (!is_null($offset)) {
250 $query .= " LIMIT $limit OFFSET $offset";
253 $notice->query($query);
257 $notice->profile_id = $this->id;
259 $notice->selectAdd();
260 $notice->selectAdd('id');
262 if ($since_id != 0) {
263 $notice->whereAdd('id > ' . $since_id);
267 $notice->whereAdd('id <= ' . $max_id);
270 $notice->orderBy('id DESC');
272 if (!is_null($offset)) {
273 $notice->limit($offset, $limit);
281 while ($notice->fetch()) {
282 $ids[] = $notice->id;
288 function isMember($group)
290 $mem = new Group_member();
292 $mem->group_id = $group->id;
293 $mem->profile_id = $this->id;
302 function isAdmin($group)
304 $mem = new Group_member();
306 $mem->group_id = $group->id;
307 $mem->profile_id = $this->id;
317 function getGroups($offset=0, $limit=null)
320 'SELECT user_group.* ' .
321 'FROM user_group JOIN group_member '.
322 'ON user_group.id = group_member.group_id ' .
323 'WHERE group_member.profile_id = %d ' .
324 'ORDER BY group_member.created DESC ';
326 if ($offset>0 && !is_null($limit)) {
328 if (common_config('db','type') == 'pgsql') {
329 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
331 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
336 $groups = new User_group();
338 $cnt = $groups->query(sprintf($qry, $this->id));
343 function avatarUrl($size=AVATAR_PROFILE_SIZE)
345 $avatar = $this->getAvatar($size);
347 return $avatar->displayUrl();
349 return Avatar::defaultImage($size);
353 function getSubscriptions($offset=0, $limit=null)
356 'SELECT profile.* ' .
357 'FROM profile JOIN subscription ' .
358 'ON profile.id = subscription.subscribed ' .
359 'WHERE subscription.subscriber = %d ' .
360 'AND subscription.subscribed != subscription.subscriber ' .
361 'ORDER BY subscription.created DESC ';
363 if ($offset>0 && !is_null($limit)){
364 if (common_config('db','type') == 'pgsql') {
365 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
367 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
371 $profile = new Profile();
373 $profile->query(sprintf($qry, $this->id));
378 function getSubscribers($offset=0, $limit=null)
381 'SELECT profile.* ' .
382 'FROM profile JOIN subscription ' .
383 'ON profile.id = subscription.subscriber ' .
384 'WHERE subscription.subscribed = %d ' .
385 'AND subscription.subscribed != subscription.subscriber ' .
386 'ORDER BY subscription.created DESC ';
388 if ($offset>0 && !is_null($limit)){
390 if (common_config('db','type') == 'pgsql') {
391 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
393 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
398 $profile = new Profile();
400 $cnt = $profile->query(sprintf($qry, $this->id));
405 function getApplications($offset = 0, $limit = null)
409 'FROM oauth_application_user u, oauth_application a ' .
410 'WHERE u.profile_id = %d ' .
411 'AND a.id = u.application_id ' .
412 'AND u.access_type > 0 ' .
413 'ORDER BY u.created DESC ';
416 if (common_config('db','type') == 'pgsql') {
417 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
419 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
423 $application = new Oauth_application();
425 $cnt = $application->query(sprintf($qry, $this->id));
430 function subscriptionCount()
432 $c = common_memcache();
435 $cnt = $c->get(common_cache_key('profile:subscription_count:'.$this->id));
436 if (is_integer($cnt)) {
441 $sub = new Subscription();
442 $sub->subscriber = $this->id;
444 $cnt = (int) $sub->count('distinct subscribed');
446 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
449 $c->set(common_cache_key('profile:subscription_count:'.$this->id), $cnt);
455 function subscriberCount()
457 $c = common_memcache();
459 $cnt = $c->get(common_cache_key('profile:subscriber_count:'.$this->id));
460 if (is_integer($cnt)) {
465 $sub = new Subscription();
466 $sub->subscribed = $this->id;
467 $sub->whereAdd('subscriber != subscribed');
468 $cnt = (int) $sub->count('distinct subscriber');
471 $c->set(common_cache_key('profile:subscriber_count:'.$this->id), $cnt);
477 function hasFave($notice)
479 $cache = common_memcache();
481 // XXX: Kind of a hack.
483 if (!empty($cache)) {
484 // This is the stream of favorite notices, in rev chron
485 // order. This forces it into cache.
487 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
489 // If it's in the list, then it's a fave
491 if (in_array($notice->id, $ids)) {
495 // If we're not past the end of the cache window,
496 // then the cache has all available faves, so this one
499 if (count($ids) < NOTICE_CACHE_WINDOW) {
503 // Otherwise, cache doesn't have all faves;
504 // fall through to the default
507 $fave = Fave::pkeyGet(array('user_id' => $this->id,
508 'notice_id' => $notice->id));
509 return ((is_null($fave)) ? false : true);
514 $c = common_memcache();
516 $cnt = $c->get(common_cache_key('profile:fave_count:'.$this->id));
517 if (is_integer($cnt)) {
523 $faves->user_id = $this->id;
524 $cnt = (int) $faves->count('distinct notice_id');
527 $c->set(common_cache_key('profile:fave_count:'.$this->id), $cnt);
533 function noticeCount()
535 $c = common_memcache();
538 $cnt = $c->get(common_cache_key('profile:notice_count:'.$this->id));
539 if (is_integer($cnt)) {
544 $notices = new Notice();
545 $notices->profile_id = $this->id;
546 $cnt = (int) $notices->count('distinct id');
549 $c->set(common_cache_key('profile:notice_count:'.$this->id), $cnt);
555 function blowFavesCache()
557 $cache = common_memcache();
559 // Faves don't happen chronologically, so we need to blow
561 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
562 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
563 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
564 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
566 $this->blowFaveCount();
569 function blowSubscriberCount()
571 $c = common_memcache();
573 $c->delete(common_cache_key('profile:subscriber_count:'.$this->id));
577 function blowSubscriptionCount()
579 $c = common_memcache();
581 $c->delete(common_cache_key('profile:subscription_count:'.$this->id));
585 function blowFaveCount()
587 $c = common_memcache();
589 $c->delete(common_cache_key('profile:fave_count:'.$this->id));
593 function blowNoticeCount()
595 $c = common_memcache();
597 $c->delete(common_cache_key('profile:notice_count:'.$this->id));
601 static function maxBio()
603 $biolimit = common_config('profile', 'biolimit');
604 // null => use global limit (distinct from 0!)
605 if (is_null($biolimit)) {
606 $biolimit = common_config('site', 'textlimit');
611 static function bioTooLong($bio)
613 $biolimit = self::maxBio();
614 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
619 $this->_deleteNotices();
620 $this->_deleteSubscriptions();
621 $this->_deleteMessages();
622 $this->_deleteTags();
623 $this->_deleteBlocks();
625 $related = array('Avatar',
629 Event::handle('ProfileDeleteRelated', array($this, &$related));
631 foreach ($related as $cls) {
633 $inst->profile_id = $this->id;
640 function _deleteNotices()
642 $notice = new Notice();
643 $notice->profile_id = $this->id;
645 if ($notice->find()) {
646 while ($notice->fetch()) {
647 $other = clone($notice);
653 function _deleteSubscriptions()
655 $sub = new Subscription();
656 $sub->subscriber = $this->id;
660 while ($sub->fetch()) {
661 $other = Profile::staticGet('id', $sub->subscribed);
665 if ($other->id == $this->id) {
668 Subscription::cancel($this, $other);
671 $subd = new Subscription();
672 $subd->subscribed = $this->id;
675 while ($subd->fetch()) {
676 $other = Profile::staticGet('id', $subd->subscriber);
680 if ($other->id == $this->id) {
683 Subscription::cancel($other, $this);
686 $self = new Subscription();
688 $self->subscriber = $this->id;
689 $self->subscribed = $this->id;
694 function _deleteMessages()
696 $msg = new Message();
697 $msg->from_profile = $this->id;
700 $msg = new Message();
701 $msg->to_profile = $this->id;
705 function _deleteTags()
707 $tag = new Profile_tag();
708 $tag->tagged = $this->id;
712 function _deleteBlocks()
714 $block = new Profile_block();
715 $block->blocked = $this->id;
718 $block = new Group_block();
719 $block->blocked = $this->id;
723 // XXX: identical to Notice::getLocation.
725 function getLocation()
729 if (!empty($this->location_id) && !empty($this->location_ns)) {
730 $location = Location::fromId($this->location_id, $this->location_ns);
733 if (is_null($location)) { // no ID, or Location::fromId() failed
734 if (!empty($this->lat) && !empty($this->lon)) {
735 $location = Location::fromLatLon($this->lat, $this->lon);
739 if (is_null($location)) { // still haven't found it!
740 if (!empty($this->location)) {
741 $location = Location::fromName($this->location);
748 function hasRole($name)
751 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
752 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
754 $has_role = !empty($role);
755 Event::handle('EndHasRole', array($this, $name, $has_role));
760 function grantRole($name)
762 $role = new Profile_role();
764 $role->profile_id = $this->id;
766 $role->created = common_sql_now();
768 $result = $role->insert();
771 common_log_db_error($role, 'INSERT', __FILE__);
778 function revokeRole($name)
780 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
784 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
785 // TRANS: %1$s is the role name, %2$s is the user ID (number).
786 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
789 $result = $role->delete();
792 common_log_db_error($role, 'DELETE', __FILE__);
793 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
794 // TRANS: %1$s is the role name, %2$s is the user ID (number).
795 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
801 function isSandboxed()
803 return $this->hasRole(Profile_role::SANDBOXED);
806 function isSilenced()
808 return $this->hasRole(Profile_role::SILENCED);
813 $this->grantRole(Profile_role::SANDBOXED);
818 $this->revokeRole(Profile_role::SANDBOXED);
823 $this->grantRole(Profile_role::SILENCED);
828 $this->revokeRole(Profile_role::SILENCED);
832 * Does this user have the right to do X?
834 * With our role-based authorization, this is merely a lookup for whether the user
835 * has a particular role. The implementation currently uses a switch statement
836 * to determine if the user has the pre-defined role to exercise the right. Future
837 * implementations may allow per-site roles, and different mappings of roles to rights.
839 * @param $right string Name of the right, usually a constant in class Right
840 * @return boolean whether the user has the right in question
843 function hasRight($right)
846 if ($this->hasRole(Profile_role::DELETED)) {
849 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
852 case Right::DELETEOTHERSNOTICE:
853 case Right::MAKEGROUPADMIN:
854 case Right::SANDBOXUSER:
855 case Right::SILENCEUSER:
856 case Right::DELETEUSER:
857 $result = $this->hasRole(Profile_role::MODERATOR);
859 case Right::CONFIGURESITE:
860 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
862 case Right::GRANTROLE:
863 case Right::REVOKEROLE:
864 $result = $this->hasRole(Profile_role::OWNER);
866 case Right::NEWNOTICE:
867 case Right::NEWMESSAGE:
868 case Right::SUBSCRIBE:
869 $result = !$this->isSilenced();
871 case Right::PUBLICNOTICE:
872 case Right::EMAILONREPLY:
873 case Right::EMAILONSUBSCRIBE:
874 case Right::EMAILONFAVE:
875 $result = !$this->isSandboxed();
885 function hasRepeated($notice_id)
887 // XXX: not really a pkey, but should work
889 $notice = Memcached_DataObject::pkeyGet('Notice',
890 array('profile_id' => $this->id,
891 'repeat_of' => $notice_id));
893 return !empty($notice);
897 * Returns an XML string fragment with limited profile information
898 * as an Atom <author> element.
900 * Assumes that Atom has been previously set up as the base namespace.
902 * @param Profile $cur the current authenticated user
906 function asAtomAuthor($cur = null)
908 $xs = new XMLStringer(true);
910 $xs->elementStart('author');
911 $xs->element('name', null, $this->nickname);
912 $xs->element('uri', null, $this->getUri());
915 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
916 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
917 $xs->element('statusnet:profile_info', $attrs, null);
919 $xs->elementEnd('author');
921 return $xs->getString();
925 * Returns an XML string fragment with profile information as an
926 * Activity Streams <activity:actor> element.
928 * Assumes that 'activity' namespace has been previously defined.
932 function asActivityActor()
934 return $this->asActivityNoun('actor');
938 * Returns an XML string fragment with profile information as an
939 * Activity Streams noun object with the given element type.
941 * Assumes that 'activity', 'georss', and 'poco' namespace has been
942 * previously defined.
944 * @param string $element one of 'actor', 'subject', 'object', 'target'
948 function asActivityNoun($element)
950 $noun = ActivityObject::fromProfile($this);
951 return $noun->asString('activity:' . $element);
955 * Returns the best URI for a profile. Plugins may override.
957 * @return string $uri
963 // give plugins a chance to set the URI
964 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
966 // check for a local user first
967 $user = User::staticGet('id', $this->id);
972 // return OMB profile if any
973 $remote = Remote_profile::staticGet('id', $this->id);
974 if (!empty($remote)) {
978 Event::handle('EndGetProfileUri', array($this, &$uri));
984 function hasBlocked($other)
986 $block = Profile_block::get($this->id, $other->id);
997 function getAtomFeed()
1001 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1002 $user = User::staticGet('id', $this->id);
1003 if (!empty($user)) {
1004 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1005 'format' => 'atom'));
1007 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1013 static function fromURI($uri)
1017 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1018 // Get a local user or remote (OMB 0.1) profile
1019 $user = User::staticGet('uri', $uri);
1020 if (!empty($user)) {
1021 $profile = $user->getProfile();
1023 $remote_profile = Remote_profile::staticGet('uri', $uri);
1024 if (!empty($remote_profile)) {
1025 $profile = Profile::staticGet('id', $remote_profile->profile_id);
1028 Event::handle('EndGetProfileFromURI', array($uri, $profile));