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);
479 $c = common_memcache();
481 $cnt = $c->get(common_cache_key('profile:fave_count:'.$this->id));
482 if (is_integer($cnt)) {
488 $faves->user_id = $this->id;
489 $cnt = (int) $faves->count('distinct notice_id');
492 $c->set(common_cache_key('profile:fave_count:'.$this->id), $cnt);
498 function noticeCount()
500 $c = common_memcache();
503 $cnt = $c->get(common_cache_key('profile:notice_count:'.$this->id));
504 if (is_integer($cnt)) {
509 $notices = new Notice();
510 $notices->profile_id = $this->id;
511 $cnt = (int) $notices->count('distinct id');
514 $c->set(common_cache_key('profile:notice_count:'.$this->id), $cnt);
520 function blowSubscriberCount()
522 $c = common_memcache();
524 $c->delete(common_cache_key('profile:subscriber_count:'.$this->id));
528 function blowSubscriptionCount()
530 $c = common_memcache();
532 $c->delete(common_cache_key('profile:subscription_count:'.$this->id));
536 function blowFaveCount()
538 $c = common_memcache();
540 $c->delete(common_cache_key('profile:fave_count:'.$this->id));
544 function blowNoticeCount()
546 $c = common_memcache();
548 $c->delete(common_cache_key('profile:notice_count:'.$this->id));
552 static function maxBio()
554 $biolimit = common_config('profile', 'biolimit');
555 // null => use global limit (distinct from 0!)
556 if (is_null($biolimit)) {
557 $biolimit = common_config('site', 'textlimit');
562 static function bioTooLong($bio)
564 $biolimit = self::maxBio();
565 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
570 $this->_deleteNotices();
571 $this->_deleteSubscriptions();
572 $this->_deleteMessages();
573 $this->_deleteTags();
574 $this->_deleteBlocks();
576 $related = array('Avatar',
580 Event::handle('ProfileDeleteRelated', array($this, &$related));
582 foreach ($related as $cls) {
584 $inst->profile_id = $this->id;
591 function _deleteNotices()
593 $notice = new Notice();
594 $notice->profile_id = $this->id;
596 if ($notice->find()) {
597 while ($notice->fetch()) {
598 $other = clone($notice);
604 function _deleteSubscriptions()
606 $sub = new Subscription();
607 $sub->subscriber = $this->id;
611 while ($sub->fetch()) {
612 $other = Profile::staticGet('id', $sub->subscribed);
616 if ($other->id == $this->id) {
619 Subscription::cancel($this, $other);
622 $subd = new Subscription();
623 $subd->subscribed = $this->id;
626 while ($subd->fetch()) {
627 $other = Profile::staticGet('id', $subd->subscriber);
631 if ($other->id == $this->id) {
634 Subscription::cancel($other, $this);
637 $self = new Subscription();
639 $self->subscriber = $this->id;
640 $self->subscribed = $this->id;
645 function _deleteMessages()
647 $msg = new Message();
648 $msg->from_profile = $this->id;
651 $msg = new Message();
652 $msg->to_profile = $this->id;
656 function _deleteTags()
658 $tag = new Profile_tag();
659 $tag->tagged = $this->id;
663 function _deleteBlocks()
665 $block = new Profile_block();
666 $block->blocked = $this->id;
669 $block = new Group_block();
670 $block->blocked = $this->id;
674 // XXX: identical to Notice::getLocation.
676 function getLocation()
680 if (!empty($this->location_id) && !empty($this->location_ns)) {
681 $location = Location::fromId($this->location_id, $this->location_ns);
684 if (is_null($location)) { // no ID, or Location::fromId() failed
685 if (!empty($this->lat) && !empty($this->lon)) {
686 $location = Location::fromLatLon($this->lat, $this->lon);
690 if (is_null($location)) { // still haven't found it!
691 if (!empty($this->location)) {
692 $location = Location::fromName($this->location);
699 function hasRole($name)
702 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
703 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
705 $has_role = !empty($role);
706 Event::handle('EndHasRole', array($this, $name, $has_role));
711 function grantRole($name)
713 $role = new Profile_role();
715 $role->profile_id = $this->id;
717 $role->created = common_sql_now();
719 $result = $role->insert();
722 common_log_db_error($role, 'INSERT', __FILE__);
729 function revokeRole($name)
731 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
735 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
736 // TRANS: %1$s is the role name, %2$s is the user ID (number).
737 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
740 $result = $role->delete();
743 common_log_db_error($role, 'DELETE', __FILE__);
744 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
745 // TRANS: %1$s is the role name, %2$s is the user ID (number).
746 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
752 function isSandboxed()
754 return $this->hasRole(Profile_role::SANDBOXED);
757 function isSilenced()
759 return $this->hasRole(Profile_role::SILENCED);
764 $this->grantRole(Profile_role::SANDBOXED);
769 $this->revokeRole(Profile_role::SANDBOXED);
774 $this->grantRole(Profile_role::SILENCED);
779 $this->revokeRole(Profile_role::SILENCED);
783 * Does this user have the right to do X?
785 * With our role-based authorization, this is merely a lookup for whether the user
786 * has a particular role. The implementation currently uses a switch statement
787 * to determine if the user has the pre-defined role to exercise the right. Future
788 * implementations may allow per-site roles, and different mappings of roles to rights.
790 * @param $right string Name of the right, usually a constant in class Right
791 * @return boolean whether the user has the right in question
794 function hasRight($right)
797 if ($this->hasRole(Profile_role::DELETED)) {
800 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
803 case Right::DELETEOTHERSNOTICE:
804 case Right::MAKEGROUPADMIN:
805 case Right::SANDBOXUSER:
806 case Right::SILENCEUSER:
807 case Right::DELETEUSER:
808 $result = $this->hasRole(Profile_role::MODERATOR);
810 case Right::CONFIGURESITE:
811 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
813 case Right::GRANTROLE:
814 case Right::REVOKEROLE:
815 $result = $this->hasRole(Profile_role::OWNER);
817 case Right::NEWNOTICE:
818 case Right::NEWMESSAGE:
819 case Right::SUBSCRIBE:
820 $result = !$this->isSilenced();
822 case Right::PUBLICNOTICE:
823 case Right::EMAILONREPLY:
824 case Right::EMAILONSUBSCRIBE:
825 case Right::EMAILONFAVE:
826 $result = !$this->isSandboxed();
836 function hasRepeated($notice_id)
838 // XXX: not really a pkey, but should work
840 $notice = Memcached_DataObject::pkeyGet('Notice',
841 array('profile_id' => $this->id,
842 'repeat_of' => $notice_id));
844 return !empty($notice);
848 * Returns an XML string fragment with limited profile information
849 * as an Atom <author> element.
851 * Assumes that Atom has been previously set up as the base namespace.
853 * @param Profile $cur the current authenticated user
857 function asAtomAuthor($cur = null)
859 $xs = new XMLStringer(true);
861 $xs->elementStart('author');
862 $xs->element('name', null, $this->nickname);
863 $xs->element('uri', null, $this->getUri());
866 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
867 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
868 $xs->element('statusnet:profile_info', $attrs, null);
870 $xs->elementEnd('author');
872 return $xs->getString();
876 * Returns an XML string fragment with profile information as an
877 * Activity Streams <activity:actor> element.
879 * Assumes that 'activity' namespace has been previously defined.
883 function asActivityActor()
885 return $this->asActivityNoun('actor');
889 * Returns an XML string fragment with profile information as an
890 * Activity Streams noun object with the given element type.
892 * Assumes that 'activity', 'georss', and 'poco' namespace has been
893 * previously defined.
895 * @param string $element one of 'actor', 'subject', 'object', 'target'
899 function asActivityNoun($element)
901 $noun = ActivityObject::fromProfile($this);
902 return $noun->asString('activity:' . $element);
906 * Returns the best URI for a profile. Plugins may override.
908 * @return string $uri
914 // give plugins a chance to set the URI
915 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
917 // check for a local user first
918 $user = User::staticGet('id', $this->id);
923 // return OMB profile if any
924 $remote = Remote_profile::staticGet('id', $this->id);
925 if (!empty($remote)) {
929 Event::handle('EndGetProfileUri', array($this, &$uri));
935 function hasBlocked($other)
937 $block = Profile_block::get($this->id, $other->id);
948 function getAtomFeed()
952 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
953 $user = User::staticGet('id', $this->id);
955 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
956 'format' => 'atom'));
958 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
964 static function fromURI($uri)
968 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
969 // Get a local user or remote (OMB 0.1) profile
970 $user = User::staticGet('uri', $uri);
972 $profile = $user->getProfile();
974 $remote_profile = Remote_profile::staticGet('uri', $uri);
975 if (!empty($remote_profile)) {
976 $profile = Profile::staticGet('id', $remote_profile->profile_id);
979 Event::handle('EndGetProfileFromURI', array($uri, $profile));