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;
150 # Get latest notice on or before date; default now
151 function getCurrentNotice($dt=null)
153 $notice = new Notice();
154 $notice->profile_id = $this->id;
156 $notice->whereAdd('created < "' . $dt . '"');
158 $notice->orderBy('created DESC, notice.id DESC');
160 if ($notice->find(true)) {
166 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
168 $ids = Notice::stream(array($this, '_streamTaggedDirect'),
170 'profile:notice_ids_tagged:' . $this->id . ':' . $tag,
171 $offset, $limit, $since_id, $max_id);
172 return Notice::getStreamByIds($ids);
175 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
177 // XXX: I'm not sure this is going to be any faster. It probably isn't.
178 $ids = Notice::stream(array($this, '_streamDirect'),
180 'profile:notice_ids:' . $this->id,
181 $offset, $limit, $since_id, $max_id);
183 return Notice::getStreamByIds($ids);
186 function _streamTaggedDirect($tag, $offset, $limit, $since_id, $max_id)
188 // XXX It would be nice to do this without a join
190 $notice = new Notice();
193 "select id from notice join notice_tag on id=notice_id where tag='".
194 $notice->escape($tag) .
195 "' and profile_id=" . $notice->escape($this->id);
197 if ($since_id != 0) {
198 $query .= " and id > $since_id";
202 $query .= " and id < $max_id";
205 $query .= ' order by id DESC';
207 if (!is_null($offset)) {
208 $query .= " LIMIT $limit OFFSET $offset";
211 $notice->query($query);
215 while ($notice->fetch()) {
216 $ids[] = $notice->id;
222 function _streamDirect($offset, $limit, $since_id, $max_id)
224 $notice = new Notice();
226 $notice->profile_id = $this->id;
228 $notice->selectAdd();
229 $notice->selectAdd('id');
231 if ($since_id != 0) {
232 $notice->whereAdd('id > ' . $since_id);
236 $notice->whereAdd('id <= ' . $max_id);
239 $notice->orderBy('id DESC');
241 if (!is_null($offset)) {
242 $notice->limit($offset, $limit);
247 if ($notice->find()) {
248 while ($notice->fetch()) {
249 $ids[] = $notice->id;
256 function isMember($group)
258 $mem = new Group_member();
260 $mem->group_id = $group->id;
261 $mem->profile_id = $this->id;
270 function isAdmin($group)
272 $mem = new Group_member();
274 $mem->group_id = $group->id;
275 $mem->profile_id = $this->id;
285 function getGroups($offset=0, $limit=null)
288 'SELECT user_group.* ' .
289 'FROM user_group JOIN group_member '.
290 'ON user_group.id = group_member.group_id ' .
291 'WHERE group_member.profile_id = %d ' .
292 'ORDER BY group_member.created DESC ';
294 if ($offset>0 && !is_null($limit)) {
296 if (common_config('db','type') == 'pgsql') {
297 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
299 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
304 $groups = new User_group();
306 $cnt = $groups->query(sprintf($qry, $this->id));
311 function avatarUrl($size=AVATAR_PROFILE_SIZE)
313 $avatar = $this->getAvatar($size);
315 return $avatar->displayUrl();
317 return Avatar::defaultImage($size);
321 function getSubscriptions($offset=0, $limit=null)
324 'SELECT profile.* ' .
325 'FROM profile JOIN subscription ' .
326 'ON profile.id = subscription.subscribed ' .
327 'WHERE subscription.subscriber = %d ' .
328 'AND subscription.subscribed != subscription.subscriber ' .
329 'ORDER BY subscription.created DESC ';
331 if ($offset>0 && !is_null($limit)){
332 if (common_config('db','type') == 'pgsql') {
333 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
335 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
339 $profile = new Profile();
341 $profile->query(sprintf($qry, $this->id));
346 function getSubscribers($offset=0, $limit=null)
349 'SELECT profile.* ' .
350 'FROM profile JOIN subscription ' .
351 'ON profile.id = subscription.subscriber ' .
352 'WHERE subscription.subscribed = %d ' .
353 'AND subscription.subscribed != subscription.subscriber ' .
354 'ORDER BY subscription.created DESC ';
356 if ($offset>0 && !is_null($limit)){
358 if (common_config('db','type') == 'pgsql') {
359 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
361 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
366 $profile = new Profile();
368 $cnt = $profile->query(sprintf($qry, $this->id));
373 function getApplications($offset = 0, $limit = null)
377 'FROM oauth_application_user u, oauth_application a ' .
378 'WHERE u.profile_id = %d ' .
379 'AND a.id = u.application_id ' .
380 'AND u.access_type > 0 ' .
381 'ORDER BY u.created DESC ';
384 if (common_config('db','type') == 'pgsql') {
385 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
387 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
391 $application = new Oauth_application();
393 $cnt = $application->query(sprintf($qry, $this->id));
398 function subscriptionCount()
400 $c = common_memcache();
403 $cnt = $c->get(common_cache_key('profile:subscription_count:'.$this->id));
404 if (is_integer($cnt)) {
409 $sub = new Subscription();
410 $sub->subscriber = $this->id;
412 $cnt = (int) $sub->count('distinct subscribed');
414 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
417 $c->set(common_cache_key('profile:subscription_count:'.$this->id), $cnt);
423 function subscriberCount()
425 $c = common_memcache();
427 $cnt = $c->get(common_cache_key('profile:subscriber_count:'.$this->id));
428 if (is_integer($cnt)) {
433 $sub = new Subscription();
434 $sub->subscribed = $this->id;
436 $cnt = (int) $sub->count('distinct subscriber');
438 $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
441 $c->set(common_cache_key('profile:subscriber_count:'.$this->id), $cnt);
449 $c = common_memcache();
451 $cnt = $c->get(common_cache_key('profile:fave_count:'.$this->id));
452 if (is_integer($cnt)) {
458 $faves->user_id = $this->id;
459 $cnt = (int) $faves->count('distinct notice_id');
462 $c->set(common_cache_key('profile:fave_count:'.$this->id), $cnt);
468 function noticeCount()
470 $c = common_memcache();
473 $cnt = $c->get(common_cache_key('profile:notice_count:'.$this->id));
474 if (is_integer($cnt)) {
479 $notices = new Notice();
480 $notices->profile_id = $this->id;
481 $cnt = (int) $notices->count('distinct id');
484 $c->set(common_cache_key('profile:notice_count:'.$this->id), $cnt);
490 function blowSubscriberCount()
492 $c = common_memcache();
494 $c->delete(common_cache_key('profile:subscriber_count:'.$this->id));
498 function blowSubscriptionCount()
500 $c = common_memcache();
502 $c->delete(common_cache_key('profile:subscription_count:'.$this->id));
506 function blowFaveCount()
508 $c = common_memcache();
510 $c->delete(common_cache_key('profile:fave_count:'.$this->id));
514 function blowNoticeCount()
516 $c = common_memcache();
518 $c->delete(common_cache_key('profile:notice_count:'.$this->id));
522 static function maxBio()
524 $biolimit = common_config('profile', 'biolimit');
525 // null => use global limit (distinct from 0!)
526 if (is_null($biolimit)) {
527 $biolimit = common_config('site', 'textlimit');
532 static function bioTooLong($bio)
534 $biolimit = self::maxBio();
535 return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
540 $this->_deleteNotices();
541 $this->_deleteSubscriptions();
542 $this->_deleteMessages();
543 $this->_deleteTags();
544 $this->_deleteBlocks();
546 $related = array('Avatar',
550 Event::handle('ProfileDeleteRelated', array($this, &$related));
552 foreach ($related as $cls) {
554 $inst->profile_id = $this->id;
561 function _deleteNotices()
563 $notice = new Notice();
564 $notice->profile_id = $this->id;
566 if ($notice->find()) {
567 while ($notice->fetch()) {
568 $other = clone($notice);
574 function _deleteSubscriptions()
576 $sub = new Subscription();
577 $sub->subscriber = $this->id;
580 $subd = new Subscription();
581 $subd->subscribed = $this->id;
585 function _deleteMessages()
587 $msg = new Message();
588 $msg->from_profile = $this->id;
591 $msg = new Message();
592 $msg->to_profile = $this->id;
596 function _deleteTags()
598 $tag = new Profile_tag();
599 $tag->tagged = $this->id;
603 function _deleteBlocks()
605 $block = new Profile_block();
606 $block->blocked = $this->id;
609 $block = new Group_block();
610 $block->blocked = $this->id;
614 // XXX: identical to Notice::getLocation.
616 function getLocation()
620 if (!empty($this->location_id) && !empty($this->location_ns)) {
621 $location = Location::fromId($this->location_id, $this->location_ns);
624 if (is_null($location)) { // no ID, or Location::fromId() failed
625 if (!empty($this->lat) && !empty($this->lon)) {
626 $location = Location::fromLatLon($this->lat, $this->lon);
630 if (is_null($location)) { // still haven't found it!
631 if (!empty($this->location)) {
632 $location = Location::fromName($this->location);
639 function hasRole($name)
642 if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
643 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
645 $has_role = !empty($role);
646 Event::handle('EndHasRole', array($this, $name, $has_role));
651 function grantRole($name)
653 $role = new Profile_role();
655 $role->profile_id = $this->id;
657 $role->created = common_sql_now();
659 $result = $role->insert();
662 common_log_db_error($role, 'INSERT', __FILE__);
669 function revokeRole($name)
671 $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
675 throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; does not exist.');
678 $result = $role->delete();
681 common_log_db_error($role, 'DELETE', __FILE__);
682 throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; database error.');
688 function isSandboxed()
690 return $this->hasRole(Profile_role::SANDBOXED);
693 function isSilenced()
695 return $this->hasRole(Profile_role::SILENCED);
700 $this->grantRole(Profile_role::SANDBOXED);
705 $this->revokeRole(Profile_role::SANDBOXED);
710 $this->grantRole(Profile_role::SILENCED);
715 $this->revokeRole(Profile_role::SILENCED);
719 * Does this user have the right to do X?
721 * With our role-based authorization, this is merely a lookup for whether the user
722 * has a particular role. The implementation currently uses a switch statement
723 * to determine if the user has the pre-defined role to exercise the right. Future
724 * implementations may allow per-site roles, and different mappings of roles to rights.
726 * @param $right string Name of the right, usually a constant in class Right
727 * @return boolean whether the user has the right in question
730 function hasRight($right)
733 if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
736 case Right::DELETEOTHERSNOTICE:
737 case Right::MAKEGROUPADMIN:
738 case Right::SANDBOXUSER:
739 case Right::SILENCEUSER:
740 case Right::DELETEUSER:
741 $result = $this->hasRole(Profile_role::MODERATOR);
743 case Right::CONFIGURESITE:
744 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
746 case Right::GRANTROLE:
747 case Right::REVOKEROLE:
748 $result = $this->hasRole(Profile_role::OWNER);
750 case Right::NEWNOTICE:
751 case Right::NEWMESSAGE:
752 case Right::SUBSCRIBE:
753 $result = !$this->isSilenced();
755 case Right::PUBLICNOTICE:
756 case Right::EMAILONREPLY:
757 case Right::EMAILONSUBSCRIBE:
758 case Right::EMAILONFAVE:
759 $result = !$this->isSandboxed();
769 function hasRepeated($notice_id)
771 // XXX: not really a pkey, but should work
773 $notice = Memcached_DataObject::pkeyGet('Notice',
774 array('profile_id' => $this->id,
775 'repeat_of' => $notice_id));
777 return !empty($notice);
781 * Returns an XML string fragment with limited profile information
782 * as an Atom <author> element.
784 * Assumes that Atom has been previously set up as the base namespace.
788 function asAtomAuthor()
790 $xs = new XMLStringer(true);
792 $xs->elementStart('author');
793 $xs->element('name', null, $this->nickname);
794 $xs->element('uri', null, $this->getUri());
795 $xs->elementEnd('author');
797 return $xs->getString();
801 * Returns an XML string fragment with profile information as an
802 * Activity Streams <activity:actor> element.
804 * Assumes that 'activity' namespace has been previously defined.
808 function asActivityActor()
810 return $this->asActivityNoun('actor');
814 * Returns an XML string fragment with profile information as an
815 * Activity Streams noun object with the given element type.
817 * Assumes that 'activity', 'georss', and 'poco' namespace has been
818 * previously defined.
820 * @param string $element one of 'actor', 'subject', 'object', 'target'
824 function asActivityNoun($element)
826 $noun = ActivityObject::fromProfile($this);
827 return $noun->asString('activity:' . $element);
831 * Returns the best URI for a profile. Plugins may override.
833 * @return string $uri
839 // give plugins a chance to set the URI
840 if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
842 // check for a local user first
843 $user = User::staticGet('id', $this->id);
848 // return OMB profile if any
849 $remote = Remote_profile::staticGet('id', $this->id);
850 if (!empty($remote)) {
854 Event::handle('EndGetProfileUri', array($this, &$uri));
860 function hasBlocked($other)
862 $block = Profile_block::get($this->id, $other->id);