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()) {
189 if ($notice instanceof ArrayWrapper) {
190 // hack for things trying to work with single notices
191 return $notice->_items[0];
199 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
201 $stream = new TaggedProfileNoticeStream($this, $tag);
203 return $stream->getNotices($offset, $limit, $since_id, $max_id);
206 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
208 $stream = new ProfileNoticeStream($this);
210 return $stream->getNotices($offset, $limit, $since_id, $max_id);
213 function isMember($group)
215 $mem = new Group_member();
217 $mem->group_id = $group->id;
218 $mem->profile_id = $this->id;
227 function isAdmin($group)
229 $mem = new Group_member();
231 $mem->group_id = $group->id;
232 $mem->profile_id = $this->id;
242 function isPendingMember($group)
244 $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
245 'group_id' => $group->id));
246 return !empty($request);
249 function getGroups($offset=0, $limit=null)
252 'SELECT user_group.* ' .
253 'FROM user_group JOIN group_member '.
254 'ON user_group.id = group_member.group_id ' .
255 'WHERE group_member.profile_id = %d ' .
256 'ORDER BY group_member.created DESC ';
258 if ($offset>0 && !is_null($limit)) {
260 if (common_config('db','type') == 'pgsql') {
261 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
263 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
268 $groups = new User_group();
270 $cnt = $groups->query(sprintf($qry, $this->id));
276 * Request to join the given group.
277 * May throw exceptions on failure.
279 * @param User_group $group
280 * @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
282 function joinGroup(User_group $group)
285 if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
286 $join = Group_join_queue::saveNew($this, $group);
288 if (Event::handle('StartJoinGroup', array($group, $this))) {
289 $join = Group_member::join($group->id, $this->id);
290 Event::handle('EndJoinGroup', array($group, $this));
294 // Send any applicable notifications...
301 * Leave a group that this profile is a member of.
303 * @param User_group $group
305 function leaveGroup(User_group $group)
307 if (Event::handle('StartLeaveGroup', array($group, $this))) {
308 Group_member::leave($group->id, $this->id);
309 Event::handle('EndLeaveGroup', array($group, $this));
313 function avatarUrl($size=AVATAR_PROFILE_SIZE)
315 $avatar = $this->getAvatar($size);
317 return $avatar->displayUrl();
319 return Avatar::defaultImage($size);
323 function getSubscriptions($offset=0, $limit=null)
325 $subs = Subscription::bySubscriber($this->id,
331 while ($subs->fetch()) {
332 $profile = Profile::staticGet($subs->subscribed);
334 $profiles[] = $profile;
338 return new ArrayWrapper($profiles);
341 function getSubscribers($offset=0, $limit=null)
343 $subs = Subscription::bySubscribed($this->id,
349 while ($subs->fetch()) {
350 $profile = Profile::staticGet($subs->subscriber);
352 $profiles[] = $profile;
356 return new ArrayWrapper($profiles);
359 function subscriptionCount()
361 $c = Cache::instance();
364 $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
365 if (is_integer($cnt)) {
370 $sub = new Subscription();
371 $sub->subscriber = $this->id;
373 $cnt = (int) $sub->count('distinct subscribed');
375 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
378 $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
384 function subscriberCount()
386 $c = Cache::instance();
388 $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
389 if (is_integer($cnt)) {
394 $sub = new Subscription();
395 $sub->subscribed = $this->id;
396 $sub->whereAdd('subscriber != subscribed');
397 $cnt = (int) $sub->count('distinct subscriber');
400 $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
407 * Is this profile subscribed to another profile?
409 * @param Profile $other
412 function isSubscribed($other)
414 return Subscription::exists($this, $other);
418 * Are these two profiles subscribed to each other?
420 * @param Profile $other
423 function mutuallySubscribed($other)
425 return $this->isSubscribed($other) &&
426 $other->isSubscribed($this);
429 function hasFave($notice)
431 $cache = Cache::instance();
433 // XXX: Kind of a hack.
435 if (!empty($cache)) {
436 // This is the stream of favorite notices, in rev chron
437 // order. This forces it into cache.
439 $ids = Fave::idStream($this->id, 0, CachingNoticeStream::CACHE_WINDOW);
441 // If it's in the list, then it's a fave
443 if (in_array($notice->id, $ids)) {
447 // If we're not past the end of the cache window,
448 // then the cache has all available faves, so this one
451 if (count($ids) < CachingNoticeStream::CACHE_WINDOW) {
455 // Otherwise, cache doesn't have all faves;
456 // fall through to the default
459 $fave = Fave::pkeyGet(array('user_id' => $this->id,
460 'notice_id' => $notice->id));
461 return ((is_null($fave)) ? false : true);
466 $c = Cache::instance();
468 $cnt = $c->get(Cache::key('profile:fave_count:'.$this->id));
469 if (is_integer($cnt)) {
475 $faves->user_id = $this->id;
476 $cnt = (int) $faves->count('distinct notice_id');
479 $c->set(Cache::key('profile:fave_count:'.$this->id), $cnt);
485 function noticeCount()
487 $c = Cache::instance();
490 $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
491 if (is_integer($cnt)) {
496 $notices = new Notice();
497 $notices->profile_id = $this->id;
498 $cnt = (int) $notices->count('distinct id');
501 $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
507 function blowFavesCache()
509 $cache = Cache::instance();
511 // Faves don't happen chronologically, so we need to blow
513 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id));
514 $cache->delete(Cache::key('fave:ids_by_user:'.$this->id.';last'));
515 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id));
516 $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id.';last'));
518 $this->blowFaveCount();
521 function blowSubscriberCount()
523 $c = Cache::instance();
525 $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
529 function blowSubscriptionCount()
531 $c = Cache::instance();
533 $c->delete(Cache::key('profile:subscription_count:'.$this->id));
537 function blowFaveCount()
539 $c = Cache::instance();
541 $c->delete(Cache::key('profile:fave_count:'.$this->id));
545 function blowNoticeCount()
547 $c = Cache::instance();
549 $c->delete(Cache::key('profile:notice_count:'.$this->id));
553 static function maxBio()
555 $biolimit = common_config('profile', 'biolimit');
556 // null => use global limit (distinct from 0!)
557 if (is_null($biolimit)) {
558 $biolimit = common_config('site', 'textlimit');
563 static function bioTooLong($bio)
565 $biolimit = self::maxBio();
566 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
571 $this->_deleteNotices();
572 $this->_deleteSubscriptions();
573 $this->_deleteMessages();
574 $this->_deleteTags();
575 $this->_deleteBlocks();
576 $this->delete_avatars();
578 // Warning: delete() will run on the batch objects,
579 // not on individual objects.
580 $related = array('Reply',
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 if (Event::handle('StartGrantRole', array($this, $name))) {
718 $role = new Profile_role();
720 $role->profile_id = $this->id;
722 $role->created = common_sql_now();
724 $result = $role->insert();
727 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
730 if ($name == 'owner') {
731 User::blow('user:site_owner');
734 Event::handle('EndGrantRole', array($this, $name));
740 function revokeRole($name)
742 if (Event::handle('StartRevokeRole', array($this, $name))) {
744 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
748 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
749 // TRANS: %1$s is the role name, %2$s is the user ID (number).
750 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
753 $result = $role->delete();
756 common_log_db_error($role, 'DELETE', __FILE__);
757 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
758 // TRANS: %1$s is the role name, %2$s is the user ID (number).
759 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
762 if ($name == 'owner') {
763 User::blow('user:site_owner');
766 Event::handle('EndRevokeRole', array($this, $name));
772 function isSandboxed()
774 return $this->hasRole(Profile_role::SANDBOXED);
777 function isSilenced()
779 return $this->hasRole(Profile_role::SILENCED);
784 $this->grantRole(Profile_role::SANDBOXED);
789 $this->revokeRole(Profile_role::SANDBOXED);
794 $this->grantRole(Profile_role::SILENCED);
799 $this->revokeRole(Profile_role::SILENCED);
803 * Does this user have the right to do X?
805 * With our role-based authorization, this is merely a lookup for whether the user
806 * has a particular role. The implementation currently uses a switch statement
807 * to determine if the user has the pre-defined role to exercise the right. Future
808 * implementations may allow per-site roles, and different mappings of roles to rights.
810 * @param $right string Name of the right, usually a constant in class Right
811 * @return boolean whether the user has the right in question
813 function hasRight($right)
817 if ($this->hasRole(Profile_role::DELETED)) {
821 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
824 case Right::DELETEOTHERSNOTICE:
825 case Right::MAKEGROUPADMIN:
826 case Right::SANDBOXUSER:
827 case Right::SILENCEUSER:
828 case Right::DELETEUSER:
829 case Right::DELETEGROUP:
830 $result = $this->hasRole(Profile_role::MODERATOR);
832 case Right::CONFIGURESITE:
833 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
835 case Right::GRANTROLE:
836 case Right::REVOKEROLE:
837 $result = $this->hasRole(Profile_role::OWNER);
839 case Right::NEWNOTICE:
840 case Right::NEWMESSAGE:
841 case Right::SUBSCRIBE:
842 case Right::CREATEGROUP:
843 $result = !$this->isSilenced();
845 case Right::PUBLICNOTICE:
846 case Right::EMAILONREPLY:
847 case Right::EMAILONSUBSCRIBE:
848 case Right::EMAILONFAVE:
849 $result = !$this->isSandboxed();
851 case Right::WEBLOGIN:
852 $result = !$this->isSilenced();
855 $result = !$this->isSilenced();
857 case Right::BACKUPACCOUNT:
858 $result = common_config('profile', 'backup');
860 case Right::RESTOREACCOUNT:
861 $result = common_config('profile', 'restore');
863 case Right::DELETEACCOUNT:
864 $result = common_config('profile', 'delete');
866 case Right::MOVEACCOUNT:
867 $result = common_config('profile', 'move');
877 function hasRepeated($notice_id)
879 // XXX: not really a pkey, but should work
881 $notice = Memcached_DataObject::pkeyGet('Notice',
882 array('profile_id' => $this->id,
883 'repeat_of' => $notice_id));
885 return !empty($notice);
889 * Returns an XML string fragment with limited profile information
890 * as an Atom <author> element.
892 * Assumes that Atom has been previously set up as the base namespace.
894 * @param Profile $cur the current authenticated user
898 function asAtomAuthor($cur = null)
900 $xs = new XMLStringer(true);
902 $xs->elementStart('author');
903 $xs->element('name', null, $this->nickname);
904 $xs->element('uri', null, $this->getUri());
907 $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
908 $attrs['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
909 $xs->element('statusnet:profile_info', $attrs, null);
911 $xs->elementEnd('author');
913 return $xs->getString();
917 * Extra profile info for atom entries
919 * Clients use some extra profile info in the atom stream.
920 * This gives it to them.
922 * @param User $cur Current user
924 * @return array representation of <statusnet:profile_info> element or null
927 function profileInfo($cur)
929 $profileInfoAttr = array('local_id' => $this->id);
932 // Whether the current user is a subscribed to this profile
933 $profileInfoAttr['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
934 // Whether the current user is has blocked this profile
935 $profileInfoAttr['blocking'] = $cur->hasBlocked($this) ? 'true' : 'false';
938 return array('statusnet:profile_info', $profileInfoAttr, null);
942 * Returns an XML string fragment with profile information as an
943 * Activity Streams <activity:actor> element.
945 * Assumes that 'activity' namespace has been previously defined.
949 function asActivityActor()
951 return $this->asActivityNoun('actor');
955 * Returns an XML string fragment with profile information as an
956 * Activity Streams noun object with the given element type.
958 * Assumes that 'activity', 'georss', and 'poco' namespace has been
959 * previously defined.
961 * @param string $element one of 'actor', 'subject', 'object', 'target'
965 function asActivityNoun($element)
967 $noun = ActivityObject::fromProfile($this);
968 return $noun->asString('activity:' . $element);
972 * Returns the best URI for a profile. Plugins may override.
974 * @return string $uri
980 // give plugins a chance to set the URI
981 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
983 // check for a local user first
984 $user = User::staticGet('id', $this->id);
989 // return OMB profile if any
990 $remote = Remote_profile::staticGet('id', $this->id);
991 if (!empty($remote)) {
995 Event::handle('EndGetProfileUri', array($this, &$uri));
1001 function hasBlocked($other)
1003 $block = Profile_block::get($this->id, $other->id);
1005 if (empty($block)) {
1014 function getAtomFeed()
1018 if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1019 $user = User::staticGet('id', $this->id);
1020 if (!empty($user)) {
1021 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1022 'format' => 'atom'));
1024 Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1030 static function fromURI($uri)
1034 if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1035 // Get a local user or remote (OMB 0.1) profile
1036 $user = User::staticGet('uri', $uri);
1037 if (!empty($user)) {
1038 $profile = $user->getProfile();
1040 $remote_profile = Remote_profile::staticGet('uri', $uri);
1041 if (!empty($remote_profile)) {
1042 $profile = Profile::staticGet('id', $remote_profile->profile_id);
1045 Event::handle('EndGetProfileFromURI', array($uri, $profile));