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
155 function getCurrentNotice()
157 $notice = new Notice();
158 $notice->profile_id = $this->id;
159 // @fixme change this to sort on notice.id only when indexes are updated
160 $notice->orderBy('created DESC, notice.id DESC');
162 if ($notice->find(true)) {
168 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
170 $ids = Notice::stream(array($this, '_streamTaggedDirect'),
172 'profile:notice_ids_tagged:' . $this->id . ':' . $tag,
173 $offset, $limit, $since_id, $max_id);
174 return Notice::getStreamByIds($ids);
177 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
179 // XXX: I'm not sure this is going to be any faster. It probably isn't.
180 $ids = Notice::stream(array($this, '_streamDirect'),
182 'profile:notice_ids:' . $this->id,
183 $offset, $limit, $since_id, $max_id);
185 return Notice::getStreamByIds($ids);
188 function _streamTaggedDirect($tag, $offset, $limit, $since_id, $max_id)
190 // XXX It would be nice to do this without a join
192 $notice = new Notice();
195 "select id from notice join notice_tag on id=notice_id where tag='".
196 $notice->escape($tag) .
197 "' and profile_id=" . $notice->escape($this->id);
199 if ($since_id != 0) {
200 $query .= " and id > $since_id";
204 $query .= " and id < $max_id";
207 $query .= ' order by id DESC';
209 if (!is_null($offset)) {
210 $query .= " LIMIT $limit OFFSET $offset";
213 $notice->query($query);
217 while ($notice->fetch()) {
218 $ids[] = $notice->id;
224 function _streamDirect($offset, $limit, $since_id, $max_id)
226 $notice = new Notice();
228 // Temporary hack until notice_profile_id_idx is updated
229 // to (profile_id, id) instead of (profile_id, created, id).
230 // It's been falling back to PRIMARY instead, which is really
231 // very inefficient for a profile that hasn't posted in a few
232 // months. Even though forcing the index will cause a filesort,
233 // it's usually going to be better.
234 if (common_config('db', 'type') == 'mysql') {
237 "select id from notice force index (notice_profile_id_idx) ".
238 "where profile_id=" . $notice->escape($this->id);
240 if ($since_id != 0) {
241 $query .= " and id > $since_id";
245 $query .= " and id < $max_id";
248 $query .= ' order by id DESC';
250 if (!is_null($offset)) {
251 $query .= " LIMIT $limit OFFSET $offset";
254 $notice->query($query);
258 $notice->profile_id = $this->id;
260 $notice->selectAdd();
261 $notice->selectAdd('id');
263 if ($since_id != 0) {
264 $notice->whereAdd('id > ' . $since_id);
268 $notice->whereAdd('id <= ' . $max_id);
271 $notice->orderBy('id DESC');
273 if (!is_null($offset)) {
274 $notice->limit($offset, $limit);
282 while ($notice->fetch()) {
283 $ids[] = $notice->id;
289 function isMember($group)
291 $mem = new Group_member();
293 $mem->group_id = $group->id;
294 $mem->profile_id = $this->id;
303 function isAdmin($group)
305 $mem = new Group_member();
307 $mem->group_id = $group->id;
308 $mem->profile_id = $this->id;
318 function getGroups($offset=0, $limit=null)
321 'SELECT user_group.* ' .
322 'FROM user_group JOIN group_member '.
323 'ON user_group.id = group_member.group_id ' .
324 'WHERE group_member.profile_id = %d ' .
325 'ORDER BY group_member.created DESC ';
327 if ($offset>0 && !is_null($limit)) {
329 if (common_config('db','type') == 'pgsql') {
330 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
332 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
337 $groups = new User_group();
339 $cnt = $groups->query(sprintf($qry, $this->id));
344 function avatarUrl($size=AVATAR_PROFILE_SIZE)
346 $avatar = $this->getAvatar($size);
348 return $avatar->displayUrl();
350 return Avatar::defaultImage($size);
354 function getSubscriptions($offset=0, $limit=null)
357 'SELECT profile.* ' .
358 'FROM profile JOIN subscription ' .
359 'ON profile.id = subscription.subscribed ' .
360 'WHERE subscription.subscriber = %d ' .
361 'AND subscription.subscribed != subscription.subscriber ' .
362 'ORDER BY subscription.created DESC ';
364 if ($offset>0 && !is_null($limit)){
365 if (common_config('db','type') == 'pgsql') {
366 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
368 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
372 $profile = new Profile();
374 $profile->query(sprintf($qry, $this->id));
379 function getSubscribers($offset=0, $limit=null)
382 'SELECT profile.* ' .
383 'FROM profile JOIN subscription ' .
384 'ON profile.id = subscription.subscriber ' .
385 'WHERE subscription.subscribed = %d ' .
386 'AND subscription.subscribed != subscription.subscriber ' .
387 'ORDER BY subscription.created DESC ';
389 if ($offset>0 && !is_null($limit)){
391 if (common_config('db','type') == 'pgsql') {
392 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
394 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
399 $profile = new Profile();
401 $cnt = $profile->query(sprintf($qry, $this->id));
406 function getApplications($offset = 0, $limit = null)
410 'FROM oauth_application_user u, oauth_application a ' .
411 'WHERE u.profile_id = %d ' .
412 'AND a.id = u.application_id ' .
413 'AND u.access_type > 0 ' .
414 'ORDER BY u.created DESC ';
417 if (common_config('db','type') == 'pgsql') {
418 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
420 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
424 $application = new Oauth_application();
426 $cnt = $application->query(sprintf($qry, $this->id));
431 function subscriptionCount()
433 $c = common_memcache();
436 $cnt = $c->get(common_cache_key('profile:subscription_count:'.$this->id));
437 if (is_integer($cnt)) {
442 $sub = new Subscription();
443 $sub->subscriber = $this->id;
445 $cnt = (int) $sub->count('distinct subscribed');
447 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
450 $c->set(common_cache_key('profile:subscription_count:'.$this->id), $cnt);
456 function subscriberCount()
458 $c = common_memcache();
460 $cnt = $c->get(common_cache_key('profile:subscriber_count:'.$this->id));
461 if (is_integer($cnt)) {
466 $sub = new Subscription();
467 $sub->subscribed = $this->id;
469 $cnt = (int) $sub->count('distinct subscriber');
471 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
474 $c->set(common_cache_key('profile:subscriber_count:'.$this->id), $cnt);
482 $c = common_memcache();
484 $cnt = $c->get(common_cache_key('profile:fave_count:'.$this->id));
485 if (is_integer($cnt)) {
491 $faves->user_id = $this->id;
492 $cnt = (int) $faves->count('distinct notice_id');
495 $c->set(common_cache_key('profile:fave_count:'.$this->id), $cnt);
501 function noticeCount()
503 $c = common_memcache();
506 $cnt = $c->get(common_cache_key('profile:notice_count:'.$this->id));
507 if (is_integer($cnt)) {
512 $notices = new Notice();
513 $notices->profile_id = $this->id;
514 $cnt = (int) $notices->count('distinct id');
517 $c->set(common_cache_key('profile:notice_count:'.$this->id), $cnt);
523 function blowSubscriberCount()
525 $c = common_memcache();
527 $c->delete(common_cache_key('profile:subscriber_count:'.$this->id));
531 function blowSubscriptionCount()
533 $c = common_memcache();
535 $c->delete(common_cache_key('profile:subscription_count:'.$this->id));
539 function blowFaveCount()
541 $c = common_memcache();
543 $c->delete(common_cache_key('profile:fave_count:'.$this->id));
547 function blowNoticeCount()
549 $c = common_memcache();
551 $c->delete(common_cache_key('profile:notice_count:'.$this->id));
555 static function maxBio()
557 $biolimit = common_config('profile', 'biolimit');
558 // null => use global limit (distinct from 0!)
559 if (is_null($biolimit)) {
560 $biolimit = common_config('site', 'textlimit');
565 static function bioTooLong($bio)
567 $biolimit = self::maxBio();
568 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
573 $this->_deleteNotices();
574 $this->_deleteSubscriptions();
575 $this->_deleteMessages();
576 $this->_deleteTags();
577 $this->_deleteBlocks();
579 $related = array('Avatar',
583 Event::handle('ProfileDeleteRelated', array($this, &$related));
585 foreach ($related as $cls) {
587 $inst->profile_id = $this->id;
594 function _deleteNotices()
596 $notice = new Notice();
597 $notice->profile_id = $this->id;
599 if ($notice->find()) {
600 while ($notice->fetch()) {
601 $other = clone($notice);
607 function _deleteSubscriptions()
609 $sub = new Subscription();
610 $sub->subscriber = $this->id;
614 while ($sub->fetch()) {
615 $other = Profile::staticGet('id', $sub->subscribed);
619 if ($other->id == $this->id) {
622 Subscription::cancel($this, $other);
625 $subd = new Subscription();
626 $subd->subscribed = $this->id;
629 while ($subd->fetch()) {
630 $other = Profile::staticGet('id', $subd->subscriber);
634 if ($other->id == $this->id) {
637 Subscription::cancel($other, $this);
640 $self = new Subscription();
642 $self->subscriber = $this->id;
643 $self->subscribed = $this->id;
648 function _deleteMessages()
650 $msg = new Message();
651 $msg->from_profile = $this->id;
654 $msg = new Message();
655 $msg->to_profile = $this->id;
659 function _deleteTags()
661 $tag = new Profile_tag();
662 $tag->tagged = $this->id;
666 function _deleteBlocks()
668 $block = new Profile_block();
669 $block->blocked = $this->id;
672 $block = new Group_block();
673 $block->blocked = $this->id;
677 // XXX: identical to Notice::getLocation.
679 function getLocation()
683 if (!empty($this->location_id) && !empty($this->location_ns)) {
684 $location = Location::fromId($this->location_id, $this->location_ns);
687 if (is_null($location)) { // no ID, or Location::fromId() failed
688 if (!empty($this->lat) && !empty($this->lon)) {
689 $location = Location::fromLatLon($this->lat, $this->lon);
693 if (is_null($location)) { // still haven't found it!
694 if (!empty($this->location)) {
695 $location = Location::fromName($this->location);
702 function hasRole($name)
705 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
706 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
708 $has_role = !empty($role);
709 Event::handle('EndHasRole', array($this, $name, $has_role));
714 function grantRole($name)
716 $role = new Profile_role();
718 $role->profile_id = $this->id;
720 $role->created = common_sql_now();
722 $result = $role->insert();
725 common_log_db_error($role, 'INSERT', __FILE__);
732 function revokeRole($name)
734 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
738 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
739 // TRANS: %1$s is the role name, %2$s is the user ID.
740 throw new Exception(sprintf(_('Cannot revoke role "%s" for user #%2$s; does not exist.'),$name, $this->id));
743 $result = $role->delete();
746 common_log_db_error($role, 'DELETE', __FILE__);
747 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
748 // TRANS: %1$s is the role name, %2$s is the user ID.
749 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$s; database error.'),$name, $this->id));
755 function isSandboxed()
757 return $this->hasRole(Profile_role::SANDBOXED);
760 function isSilenced()
762 return $this->hasRole(Profile_role::SILENCED);
767 $this->grantRole(Profile_role::SANDBOXED);
772 $this->revokeRole(Profile_role::SANDBOXED);
777 $this->grantRole(Profile_role::SILENCED);
782 $this->revokeRole(Profile_role::SILENCED);
786 * Does this user have the right to do X?
788 * With our role-based authorization, this is merely a lookup for whether the user
789 * has a particular role. The implementation currently uses a switch statement
790 * to determine if the user has the pre-defined role to exercise the right. Future
791 * implementations may allow per-site roles, and different mappings of roles to rights.
793 * @param $right string Name of the right, usually a constant in class Right
794 * @return boolean whether the user has the right in question
797 function hasRight($right)
800 if ($this->hasRole(Profile_role::DELETED)) {
803 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
806 case Right::DELETEOTHERSNOTICE:
807 case Right::MAKEGROUPADMIN:
808 case Right::SANDBOXUSER:
809 case Right::SILENCEUSER:
810 case Right::DELETEUSER:
811 $result = $this->hasRole(Profile_role::MODERATOR);
813 case Right::CONFIGURESITE:
814 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
816 case Right::GRANTROLE:
817 case Right::REVOKEROLE:
818 $result = $this->hasRole(Profile_role::OWNER);
820 case Right::NEWNOTICE:
821 case Right::NEWMESSAGE:
822 case Right::SUBSCRIBE:
823 $result = !$this->isSilenced();
825 case Right::PUBLICNOTICE:
826 case Right::EMAILONREPLY:
827 case Right::EMAILONSUBSCRIBE:
828 case Right::EMAILONFAVE:
829 $result = !$this->isSandboxed();
839 function hasRepeated($notice_id)
841 // XXX: not really a pkey, but should work
843 $notice = Memcached_DataObject::pkeyGet('Notice',
844 array('profile_id' => $this->id,
845 'repeat_of' => $notice_id));
847 return !empty($notice);
851 * Returns an XML string fragment with limited profile information
852 * as an Atom <author> element.
854 * Assumes that Atom has been previously set up as the base namespace.
856 * @param Profile $cur the current authenticated user
860 function asAtomAuthor($cur = null)
862 $xs = new XMLStringer(true);
864 $xs->elementStart('author');
865 $xs->element('name', null, $this->nickname);
866 $xs->element('uri', null, $this->getUri());
869 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
870 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
871 $xs->element('statusnet:profile_info', $attrs, null);
873 $xs->elementEnd('author');
875 return $xs->getString();
879 * Returns an XML string fragment with profile information as an
880 * Activity Streams <activity:actor> element.
882 * Assumes that 'activity' namespace has been previously defined.
886 function asActivityActor()
888 return $this->asActivityNoun('actor');
892 * Returns an XML string fragment with profile information as an
893 * Activity Streams noun object with the given element type.
895 * Assumes that 'activity', 'georss', and 'poco' namespace has been
896 * previously defined.
898 * @param string $element one of 'actor', 'subject', 'object', 'target'
902 function asActivityNoun($element)
904 $noun = ActivityObject::fromProfile($this);
905 return $noun->asString('activity:' . $element);
909 * Returns the best URI for a profile. Plugins may override.
911 * @return string $uri
917 // give plugins a chance to set the URI
918 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
920 // check for a local user first
921 $user = User::staticGet('id', $this->id);
926 // return OMB profile if any
927 $remote = Remote_profile::staticGet('id', $this->id);
928 if (!empty($remote)) {
932 Event::handle('EndGetProfileUri', array($this, &$uri));
938 function hasBlocked($other)
940 $block = Profile_block::get($this->id, $other->id);