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()) {
128 function delete_avatars($original=true)
130 $avatar = new Avatar();
131 $avatar->profile_id = $this->id;
133 while ($avatar->fetch()) {
134 if ($avatar->original) {
135 if ($original == false) {
145 * Gets either the full name (if filled) or the nickname.
149 function getBestName()
151 return ($this->fullname) ? $this->fullname : $this->nickname;
155 * Gets the full name (if filled) with nickname as a parenthetical, or the nickname alone
156 * if no fullname is provided.
160 function getFancyName()
162 if ($this->fullname) {
163 // TRANS: Full name of a profile or group followed by nickname in parens
164 return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->fullname, $this->nickname);
166 return $this->nickname;
171 * Get the most recent notice posted by this user, if any.
173 * @return mixed Notice or null
176 function getCurrentNotice()
178 $notice = $this->getNotices(0, 1);
180 if ($notice->fetch()) {
187 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
189 $ids = Notice::stream(array($this, '_streamTaggedDirect'),
191 'profile:notice_ids_tagged:' . $this->id . ':' . $tag,
192 $offset, $limit, $since_id, $max_id);
193 return Notice::getStreamByIds($ids);
196 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
198 // XXX: I'm not sure this is going to be any faster. It probably isn't.
199 $ids = Notice::stream(array($this, '_streamDirect'),
201 'profile:notice_ids:' . $this->id,
202 $offset, $limit, $since_id, $max_id);
204 return Notice::getStreamByIds($ids);
207 function _streamTaggedDirect($tag, $offset, $limit, $since_id, $max_id)
209 // XXX It would be nice to do this without a join
211 $notice = new Notice();
214 "select id from notice join notice_tag on id=notice_id where tag='".
215 $notice->escape($tag) .
216 "' and profile_id=" . $notice->escape($this->id);
218 if ($since_id != 0) {
219 $query .= " and id > $since_id";
223 $query .= " and id <= $max_id";
226 $query .= ' order by id DESC';
228 if (!is_null($offset)) {
229 $query .= " LIMIT $limit OFFSET $offset";
232 $notice->query($query);
236 while ($notice->fetch()) {
237 $ids[] = $notice->id;
243 function _streamDirect($offset, $limit, $since_id, $max_id)
245 $notice = new Notice();
247 // Temporary hack until notice_profile_id_idx is updated
248 // to (profile_id, id) instead of (profile_id, created, id).
249 // It's been falling back to PRIMARY instead, which is really
250 // very inefficient for a profile that hasn't posted in a few
251 // months. Even though forcing the index will cause a filesort,
252 // it's usually going to be better.
253 if (common_config('db', 'type') == 'mysql') {
256 "select id from notice force index (notice_profile_id_idx) ".
257 "where profile_id=" . $notice->escape($this->id);
259 if ($since_id != 0) {
260 $query .= " and id > $since_id";
264 $query .= " and id <= $max_id";
267 $query .= ' order by id DESC';
269 if (!is_null($offset)) {
270 $query .= " LIMIT $limit OFFSET $offset";
273 $notice->query($query);
277 $notice->profile_id = $this->id;
279 $notice->selectAdd();
280 $notice->selectAdd('id');
282 if ($since_id != 0) {
283 $notice->whereAdd('id > ' . $since_id);
287 $notice->whereAdd('id <= ' . $max_id);
290 $notice->orderBy('id DESC');
292 if (!is_null($offset)) {
293 $notice->limit($offset, $limit);
301 while ($notice->fetch()) {
302 $ids[] = $notice->id;
308 function isMember($group)
310 $mem = new Group_member();
312 $mem->group_id = $group->id;
313 $mem->profile_id = $this->id;
322 function isAdmin($group)
324 $mem = new Group_member();
326 $mem->group_id = $group->id;
327 $mem->profile_id = $this->id;
337 function getGroups($offset=0, $limit=null)
340 'SELECT user_group.* ' .
341 'FROM user_group JOIN group_member '.
342 'ON user_group.id = group_member.group_id ' .
343 'WHERE group_member.profile_id = %d ' .
344 'ORDER BY group_member.created DESC ';
346 if ($offset>0 && !is_null($limit)) {
348 if (common_config('db','type') == 'pgsql') {
349 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
351 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
356 $groups = new User_group();
358 $cnt = $groups->query(sprintf($qry, $this->id));
363 function avatarUrl($size=AVATAR_PROFILE_SIZE)
365 $avatar = $this->getAvatar($size);
367 return $avatar->displayUrl();
369 return Avatar::defaultImage($size);
373 function getSubscriptions($offset=0, $limit=null)
376 'SELECT profile.* ' .
377 'FROM profile JOIN subscription ' .
378 'ON profile.id = subscription.subscribed ' .
379 'WHERE subscription.subscriber = %d ' .
380 'AND subscription.subscribed != subscription.subscriber ' .
381 'ORDER BY subscription.created DESC ';
383 if ($offset>0 && !is_null($limit)){
384 if (common_config('db','type') == 'pgsql') {
385 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
387 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
391 $profile = new Profile();
393 $profile->query(sprintf($qry, $this->id));
398 function getSubscribers($offset=0, $limit=null)
401 'SELECT profile.* ' .
402 'FROM profile JOIN subscription ' .
403 'ON profile.id = subscription.subscriber ' .
404 'WHERE subscription.subscribed = %d ' .
405 'AND subscription.subscribed != subscription.subscriber ' .
406 'ORDER BY subscription.created DESC ';
408 if ($offset>0 && !is_null($limit)){
410 if (common_config('db','type') == 'pgsql') {
411 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
413 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
418 $profile = new Profile();
420 $cnt = $profile->query(sprintf($qry, $this->id));
425 function getConnectedApps($offset = 0, $limit = null)
429 'FROM oauth_application_user u, oauth_application a ' .
430 'WHERE u.profile_id = %d ' .
431 'AND a.id = u.application_id ' .
432 'AND u.access_type > 0 ' .
433 'ORDER BY u.created DESC ';
436 if (common_config('db','type') == 'pgsql') {
437 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
439 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
443 $apps = new Oauth_application_user();
445 $cnt = $apps->query(sprintf($qry, $this->id));
450 function subscriptionCount()
452 $c = common_memcache();
455 $cnt = $c->get(common_cache_key('profile:subscription_count:'.$this->id));
456 if (is_integer($cnt)) {
461 $sub = new Subscription();
462 $sub->subscriber = $this->id;
464 $cnt = (int) $sub->count('distinct subscribed');
466 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
469 $c->set(common_cache_key('profile:subscription_count:'.$this->id), $cnt);
475 function subscriberCount()
477 $c = common_memcache();
479 $cnt = $c->get(common_cache_key('profile:subscriber_count:'.$this->id));
480 if (is_integer($cnt)) {
485 $sub = new Subscription();
486 $sub->subscribed = $this->id;
487 $sub->whereAdd('subscriber != subscribed');
488 $cnt = (int) $sub->count('distinct subscriber');
491 $c->set(common_cache_key('profile:subscriber_count:'.$this->id), $cnt);
497 function hasFave($notice)
499 $cache = common_memcache();
501 // XXX: Kind of a hack.
503 if (!empty($cache)) {
504 // This is the stream of favorite notices, in rev chron
505 // order. This forces it into cache.
507 $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
509 // If it's in the list, then it's a fave
511 if (in_array($notice->id, $ids)) {
515 // If we're not past the end of the cache window,
516 // then the cache has all available faves, so this one
519 if (count($ids) < NOTICE_CACHE_WINDOW) {
523 // Otherwise, cache doesn't have all faves;
524 // fall through to the default
527 $fave = Fave::pkeyGet(array('user_id' => $this->id,
528 'notice_id' => $notice->id));
529 return ((is_null($fave)) ? false : true);
534 $c = common_memcache();
536 $cnt = $c->get(common_cache_key('profile:fave_count:'.$this->id));
537 if (is_integer($cnt)) {
543 $faves->user_id = $this->id;
544 $cnt = (int) $faves->count('distinct notice_id');
547 $c->set(common_cache_key('profile:fave_count:'.$this->id), $cnt);
553 function noticeCount()
555 $c = common_memcache();
558 $cnt = $c->get(common_cache_key('profile:notice_count:'.$this->id));
559 if (is_integer($cnt)) {
564 $notices = new Notice();
565 $notices->profile_id = $this->id;
566 $cnt = (int) $notices->count('distinct id');
569 $c->set(common_cache_key('profile:notice_count:'.$this->id), $cnt);
575 function blowFavesCache()
577 $cache = common_memcache();
579 // Faves don't happen chronologically, so we need to blow
581 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
582 $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
583 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
584 $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
586 $this->blowFaveCount();
589 function blowSubscriberCount()
591 $c = common_memcache();
593 $c->delete(common_cache_key('profile:subscriber_count:'.$this->id));
597 function blowSubscriptionCount()
599 $c = common_memcache();
601 $c->delete(common_cache_key('profile:subscription_count:'.$this->id));
605 function blowFaveCount()
607 $c = common_memcache();
609 $c->delete(common_cache_key('profile:fave_count:'.$this->id));
613 function blowNoticeCount()
615 $c = common_memcache();
617 $c->delete(common_cache_key('profile:notice_count:'.$this->id));
621 static function maxBio()
623 $biolimit = common_config('profile', 'biolimit');
624 // null => use global limit (distinct from 0!)
625 if (is_null($biolimit)) {
626 $biolimit = common_config('site', 'textlimit');
631 static function bioTooLong($bio)
633 $biolimit = self::maxBio();
634 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
639 $this->_deleteNotices();
640 $this->_deleteSubscriptions();
641 $this->_deleteMessages();
642 $this->_deleteTags();
643 $this->_deleteBlocks();
645 $related = array('Avatar',
649 Event::handle('ProfileDeleteRelated', array($this, &$related));
651 foreach ($related as $cls) {
653 $inst->profile_id = $this->id;
660 function _deleteNotices()
662 $notice = new Notice();
663 $notice->profile_id = $this->id;
665 if ($notice->find()) {
666 while ($notice->fetch()) {
667 $other = clone($notice);
673 function _deleteSubscriptions()
675 $sub = new Subscription();
676 $sub->subscriber = $this->id;
680 while ($sub->fetch()) {
681 $other = Profile::staticGet('id', $sub->subscribed);
685 if ($other->id == $this->id) {
688 Subscription::cancel($this, $other);
691 $subd = new Subscription();
692 $subd->subscribed = $this->id;
695 while ($subd->fetch()) {
696 $other = Profile::staticGet('id', $subd->subscriber);
700 if ($other->id == $this->id) {
703 Subscription::cancel($other, $this);
706 $self = new Subscription();
708 $self->subscriber = $this->id;
709 $self->subscribed = $this->id;
714 function _deleteMessages()
716 $msg = new Message();
717 $msg->from_profile = $this->id;
720 $msg = new Message();
721 $msg->to_profile = $this->id;
725 function _deleteTags()
727 $tag = new Profile_tag();
728 $tag->tagged = $this->id;
732 function _deleteBlocks()
734 $block = new Profile_block();
735 $block->blocked = $this->id;
738 $block = new Group_block();
739 $block->blocked = $this->id;
743 // XXX: identical to Notice::getLocation.
745 function getLocation()
749 if (!empty($this->location_id) && !empty($this->location_ns)) {
750 $location = Location::fromId($this->location_id, $this->location_ns);
753 if (is_null($location)) { // no ID, or Location::fromId() failed
754 if (!empty($this->lat) && !empty($this->lon)) {
755 $location = Location::fromLatLon($this->lat, $this->lon);
759 if (is_null($location)) { // still haven't found it!
760 if (!empty($this->location)) {
761 $location = Location::fromName($this->location);
768 function hasRole($name)
771 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
772 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
774 $has_role = !empty($role);
775 Event::handle('EndHasRole', array($this, $name, $has_role));
780 function grantRole($name)
782 if (Event::handle('StartGrantRole', array($this, $name))) {
784 $role = new Profile_role();
786 $role->profile_id = $this->id;
788 $role->created = common_sql_now();
790 $result = $role->insert();
793 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
796 Event::handle('EndGrantRole', array($this, $name));
802 function revokeRole($name)
804 if (Event::handle('StartRevokeRole', array($this, $name))) {
806 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
810 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
811 // TRANS: %1$s is the role name, %2$s is the user ID (number).
812 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
815 $result = $role->delete();
818 common_log_db_error($role, 'DELETE', __FILE__);
819 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
820 // TRANS: %1$s is the role name, %2$s is the user ID (number).
821 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
824 Event::handle('EndRevokeRole', array($this, $name));
830 function isSandboxed()
832 return $this->hasRole(Profile_role::SANDBOXED);
835 function isSilenced()
837 return $this->hasRole(Profile_role::SILENCED);
842 $this->grantRole(Profile_role::SANDBOXED);
847 $this->revokeRole(Profile_role::SANDBOXED);
852 $this->grantRole(Profile_role::SILENCED);
857 $this->revokeRole(Profile_role::SILENCED);
861 * Does this user have the right to do X?
863 * With our role-based authorization, this is merely a lookup for whether the user
864 * has a particular role. The implementation currently uses a switch statement
865 * to determine if the user has the pre-defined role to exercise the right. Future
866 * implementations may allow per-site roles, and different mappings of roles to rights.
868 * @param $right string Name of the right, usually a constant in class Right
869 * @return boolean whether the user has the right in question
871 function hasRight($right)
875 if ($this->hasRole(Profile_role::DELETED)) {
879 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
882 case Right::DELETEOTHERSNOTICE:
883 case Right::MAKEGROUPADMIN:
884 case Right::SANDBOXUSER:
885 case Right::SILENCEUSER:
886 case Right::DELETEUSER:
887 case Right::DELETEGROUP:
888 $result = $this->hasRole(Profile_role::MODERATOR);
890 case Right::CONFIGURESITE:
891 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
893 case Right::GRANTROLE:
894 case Right::REVOKEROLE:
895 $result = $this->hasRole(Profile_role::OWNER);
897 case Right::NEWNOTICE:
898 case Right::NEWMESSAGE:
899 case Right::SUBSCRIBE:
900 $result = !$this->isSilenced();
902 case Right::PUBLICNOTICE:
903 case Right::EMAILONREPLY:
904 case Right::EMAILONSUBSCRIBE:
905 case Right::EMAILONFAVE:
906 $result = !$this->isSandboxed();
916 function hasRepeated($notice_id)
918 // XXX: not really a pkey, but should work
920 $notice = Memcached_DataObject::pkeyGet('Notice',
921 array('profile_id' => $this->id,
922 'repeat_of' => $notice_id));
924 return !empty($notice);
928 * Returns an XML string fragment with limited profile information
929 * as an Atom <author> element.
931 * Assumes that Atom has been previously set up as the base namespace.
933 * @param Profile $cur the current authenticated user
937 function asAtomAuthor($cur = null)
939 $xs = new XMLStringer(true);
941 $xs->elementStart('author');
942 $xs->element('name', null, $this->nickname);
943 $xs->element('uri', null, $this->getUri());
946 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
947 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
948 $xs->element('statusnet:profile_info', $attrs, null);
950 $xs->elementEnd('author');
952 return $xs->getString();
956 * Returns an XML string fragment with profile information as an
957 * Activity Streams <activity:actor> element.
959 * Assumes that 'activity' namespace has been previously defined.
963 function asActivityActor()
965 return $this->asActivityNoun('actor');
969 * Returns an XML string fragment with profile information as an
970 * Activity Streams noun object with the given element type.
972 * Assumes that 'activity', 'georss', and 'poco' namespace has been
973 * previously defined.
975 * @param string $element one of 'actor', 'subject', 'object', 'target'
979 function asActivityNoun($element)
981 $noun = ActivityObject::fromProfile($this);
982 return $noun->asString('activity:' . $element);
986 * Returns the best URI for a profile. Plugins may override.
988 * @return string $uri
994 // give plugins a chance to set the URI
995 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
997 // check for a local user first
998 $user = User::staticGet('id', $this->id);
1000 if (!empty($user)) {
1003 // return OMB profile if any
1004 $remote = Remote_profile::staticGet('id', $this->id);
1005 if (!empty($remote)) {
1006 $uri = $remote->uri;
1009 Event::handle('EndGetProfileUri', array($this, &$uri));
1015 function hasBlocked($other)
1017 $block = Profile_block::get($this->id, $other->id);
1019 if (empty($block)) {
1028 function getAtomFeed()
1032 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1033 $user = User::staticGet('id', $this->id);
1034 if (!empty($user)) {
1035 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1036 'format' => 'atom'));
1038 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1044 static function fromURI($uri)
1048 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1049 // Get a local user or remote (OMB 0.1) profile
1050 $user = User::staticGet('uri', $uri);
1051 if (!empty($user)) {
1052 $profile = $user->getProfile();
1054 $remote_profile = Remote_profile::staticGet('uri', $uri);
1055 if (!empty($remote_profile)) {
1056 $profile = Profile::staticGet('id', $remote_profile->profile_id);
1059 Event::handle('EndGetProfileFromURI', array($uri, $profile));