classes/Profile.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 /**
  23  * Table Definition for profile
  24  */
  25 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
  26
  27 class Profile extends Memcached_DataObject
  28 {
  29     ###START_AUTOCODE
  30     /* the code below is auto generated do not remove the above tag */
  31
  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
  46
  47     /* Static get */
  48     function staticGet($k,$v=NULL) {
  49         return Memcached_DataObject::staticGet('Profile',$k,$v);
  50     }
  51
  52     /* the code above is auto generated do not remove the tag below */
  53     ###END_AUTOCODE
  54
  55     function getUser()
  56     {
  57         return User::staticGet('id', $this->id);
  58     }
  59
  60     function getAvatar($width, $height=null)
  61     {
  62         if (is_null($height)) {
  63             $height = $width;
  64         }
  65         return Avatar::pkeyGet(array('profile_id' => $this->id,
  66                                      'width' => $width,
  67                                      'height' => $height));
  68     }
  69
  70     function getOriginalAvatar()
  71     {
  72         $avatar = DB_DataObject::factory('avatar');
  73         $avatar->profile_id = $this->id;
  74         $avatar->original = true;
  75         if ($avatar->find(true)) {
  76             return $avatar;
  77         } else {
  78             return null;
  79         }
  80     }
  81
  82     function setOriginal($filename)
  83     {
  84         $imagefile = new ImageFile($this->id, Avatar::path($filename));
  85
  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
  95
  96         // XXX: start a transaction here
  97
  98         if (!$this->delete_avatars() || !$avatar->insert()) {
  99             @unlink(Avatar::path($filename));
 100             return null;
 101         }
 102
 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);
 107
 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
 118
 119                 if (!$scaled->insert()) {
 120                     return null;
 121                 }
 122             }
 123         }
 124
 125         return $avatar;
 126     }
 127
 128     /**
 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.
 132      *
 133      * @param boolean $original true to delete only the original-size file
 134      * @return <type>
 135      */
 136     function delete_avatars($original=true)
 137     {
 138         $avatar = new Avatar();
 139         $avatar->profile_id = $this->id;
 140         $avatar->find();
 141         while ($avatar->fetch()) {
 142             if ($avatar->original) {
 143                 if ($original == false) {
 144                     continue;
 145                 }
 146             }
 147             $avatar->delete();
 148         }
 149         return true;
 150     }
 151
 152     /**
 153      * Gets either the full name (if filled) or the nickname.
 154      *
 155      * @return string
 156      */
 157     function getBestName()
 158     {
 159         return ($this->fullname) ? $this->fullname : $this->nickname;
 160     }
 161
 162     /**
 163      * Gets the full name (if filled) with nickname as a parenthetical, or the nickname alone
 164      * if no fullname is provided.
 165      *
 166      * @return string
 167      */
 168     function getFancyName()
 169     {
 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);
 173         } else {
 174             return $this->nickname;
 175         }
 176     }
 177
 178     /**
 179      * Get the most recent notice posted by this user, if any.
 180      *
 181      * @return mixed Notice or null
 182      */
 183
 184     function getCurrentNotice()
 185     {
 186         $notice = $this->getNotices(0, 1);
 187
 188         if ($notice->fetch()) {
 189             if ($notice instanceof ArrayWrapper) {
 190                 // hack for things trying to work with single notices
 191                 return $notice->_items[0];
 192             }
 193             return $notice;
 194         } else {
 195             return null;
 196         }
 197     }
 198
 199     function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
 200     {
 201         $ids = Notice::stream(array($this, '_streamTaggedDirect'),
 202                               array($tag),
 203                               'profile:notice_ids_tagged:' . $this->id . ':' . $tag,
 204                               $offset, $limit, $since_id, $max_id);
 205         return Notice::getStreamByIds($ids);
 206     }
 207
 208     function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
 209     {
 210         // XXX: I'm not sure this is going to be any faster. It probably isn't.
 211         $ids = Notice::stream(array($this, '_streamDirect'),
 212                               array(),
 213                               'profile:notice_ids:' . $this->id,
 214                               $offset, $limit, $since_id, $max_id);
 215
 216         return Notice::getStreamByIds($ids);
 217     }
 218
 219     function _streamTaggedDirect($tag, $offset, $limit, $since_id, $max_id)
 220     {
 221         // XXX It would be nice to do this without a join
 222         // (necessary to do it efficiently on accounts with long history)
 223
 224         $notice = new Notice();
 225
 226         $query =
 227           "select id from notice join notice_tag on id=notice_id where tag='".
 228           $notice->escape($tag) .
 229           "' and profile_id=" . intval($this->id);
 230
 231         $since = Notice::whereSinceId($since_id, 'id', 'notice.created');
 232         if ($since) {
 233             $query .= " and ($since)";
 234         }
 235
 236         $max = Notice::whereMaxId($max_id, 'id', 'notice.created');
 237         if ($max) {
 238             $query .= " and ($max)";
 239         }
 240
 241         $query .= ' order by notice.created DESC, id DESC';
 242
 243         if (!is_null($offset)) {
 244             $query .= " LIMIT " . intval($limit) . " OFFSET " . intval($offset);
 245         }
 246
 247         $notice->query($query);
 248
 249         $ids = array();
 250
 251         while ($notice->fetch()) {
 252             $ids[] = $notice->id;
 253         }
 254
 255         return $ids;
 256     }
 257
 258     function _streamDirect($offset, $limit, $since_id, $max_id)
 259     {
 260         $notice = new Notice();
 261
 262         $notice->profile_id = $this->id;
 263
 264         $notice->selectAdd();
 265         $notice->selectAdd('id');
 266
 267         Notice::addWhereSinceId($notice, $since_id);
 268         Notice::addWhereMaxId($notice, $max_id);
 269
 270         $notice->orderBy('created DESC, id DESC');
 271
 272         if (!is_null($offset)) {
 273             $notice->limit($offset, $limit);
 274         }
 275
 276         $notice->find();
 277
 278         $ids = array();
 279
 280         while ($notice->fetch()) {
 281             $ids[] = $notice->id;
 282         }
 283
 284         return $ids;
 285     }
 286
 287     function isMember($group)
 288     {
 289         $mem = new Group_member();
 290
 291         $mem->group_id = $group->id;
 292         $mem->profile_id = $this->id;
 293
 294         if ($mem->find()) {
 295             return true;
 296         } else {
 297             return false;
 298         }
 299     }
 300
 301     function isAdmin($group)
 302     {
 303         $mem = new Group_member();
 304
 305         $mem->group_id = $group->id;
 306         $mem->profile_id = $this->id;
 307         $mem->is_admin = 1;
 308
 309         if ($mem->find()) {
 310             return true;
 311         } else {
 312             return false;
 313         }
 314     }
 315
 316     function isPendingMember($group)
 317     {
 318         $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
 319                                                    'group_id' => $group->id));
 320         return !empty($request);
 321     }
 322
 323     function getGroups($offset=0, $limit=null)
 324     {
 325         $qry =
 326           'SELECT user_group.* ' .
 327           'FROM user_group JOIN group_member '.
 328           'ON user_group.id = group_member.group_id ' .
 329           'WHERE group_member.profile_id = %d ' .
 330           'ORDER BY group_member.created DESC ';
 331
 332         if ($offset>0 && !is_null($limit)) {
 333             if ($offset) {
 334                 if (common_config('db','type') == 'pgsql') {
 335                     $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 336                 } else {
 337                     $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 338                 }
 339             }
 340         }
 341
 342         $groups = new User_group();
 343
 344         $cnt = $groups->query(sprintf($qry, $this->id));
 345
 346         return $groups;
 347     }
 348
 349     /**
 350      * Request to join the given group.
 351      * May throw exceptions on failure.
 352      *
 353      * @param User_group $group
 354      * @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
 355      */
 356     function joinGroup(User_group $group)
 357     {
 358         $ok = null;
 359         if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
 360             $ok = Group_join_queue::saveNew($this, $group);
 361         } else {
 362             if (Event::handle('StartJoinGroup', array($group, $this))) {
 363                 $ok = Group_member::join($group->id, $this->id);
 364                 Event::handle('EndJoinGroup', array($group, $this));
 365             }
 366         }
 367         return $ok;
 368     }
 369
 370     /**
 371      * Cancel a pending group join...
 372      *
 373      * @param User_group $group
 374      */
 375     function cancelJoinGroup(User_group $group)
 376     {
 377         $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
 378                                                    'group_id' => $group->id));
 379         if ($request) {
 380             if (Event::handle('StartCancelJoinGroup', array($group, $this))) {
 381                 $request->delete();
 382                 Event::handle('EndCancelJoinGroup', array($group, $this));
 383             }
 384         }
 385     }
 386
 387     /**
 388      * Complete a pending group join on our end...
 389      *
 390      * @param User_group $group
 391      */
 392     function completeJoinGroup(User_group $group)
 393     {
 394         $ok = null;
 395         $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
 396                                                    'group_id' => $group->id));
 397         if ($request) {
 398             if (Event::handle('StartJoinGroup', array($group, $this))) {
 399                 $ok = Group_member::join($group->id, $this->id);
 400                 $request->delete();
 401                 Event::handle('EndJoinGroup', array($group, $this));
 402             }
 403         } else {
 404             throw new Exception(_m('Invalid group join approval: not pending.'));
 405         }
 406         return $ok;
 407     }
 408
 409     /**
 410      * Leave a group that this profile is a member of.
 411      *
 412      * @param User_group $group
 413      */
 414     function leaveGroup(User_group $group)
 415     {
 416         if (Event::handle('StartLeaveGroup', array($group, $this))) {
 417             Group_member::leave($group->id, $this->id);
 418             Event::handle('EndLeaveGroup', array($group, $this));
 419         }
 420     }
 421
 422     function avatarUrl($size=AVATAR_PROFILE_SIZE)
 423     {
 424         $avatar = $this->getAvatar($size);
 425         if ($avatar) {
 426             return $avatar->displayUrl();
 427         } else {
 428             return Avatar::defaultImage($size);
 429         }
 430     }
 431
 432     function getSubscriptions($offset=0, $limit=null)
 433     {
 434         $subs = Subscription::bySubscriber($this->id,
 435                                            $offset,
 436                                            $limit);
 437
 438         $profiles = array();
 439
 440         while ($subs->fetch()) {
 441             $profile = Profile::staticGet($subs->subscribed);
 442             if ($profile) {
 443                 $profiles[] = $profile;
 444             }
 445         }
 446
 447         return new ArrayWrapper($profiles);
 448     }
 449
 450     function getSubscribers($offset=0, $limit=null)
 451     {
 452         $subs = Subscription::bySubscribed($this->id,
 453                                            $offset,
 454                                            $limit);
 455
 456         $profiles = array();
 457
 458         while ($subs->fetch()) {
 459             $profile = Profile::staticGet($subs->subscriber);
 460             if ($profile) {
 461                 $profiles[] = $profile;
 462             }
 463         }
 464
 465         return new ArrayWrapper($profiles);
 466     }
 467
 468     function subscriptionCount()
 469     {
 470         $c = Cache::instance();
 471
 472         if (!empty($c)) {
 473             $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
 474             if (is_integer($cnt)) {
 475                 return (int) $cnt;
 476             }
 477         }
 478
 479         $sub = new Subscription();
 480         $sub->subscriber = $this->id;
 481
 482         $cnt = (int) $sub->count('distinct subscribed');
 483
 484         $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
 485
 486         if (!empty($c)) {
 487             $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
 488         }
 489
 490         return $cnt;
 491     }
 492
 493     function subscriberCount()
 494     {
 495         $c = Cache::instance();
 496         if (!empty($c)) {
 497             $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
 498             if (is_integer($cnt)) {
 499                 return (int) $cnt;
 500             }
 501         }
 502
 503         $sub = new Subscription();
 504         $sub->subscribed = $this->id;
 505         $sub->whereAdd('subscriber != subscribed');
 506         $cnt = (int) $sub->count('distinct subscriber');
 507
 508         if (!empty($c)) {
 509             $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
 510         }
 511
 512         return $cnt;
 513     }
 514
 515     /**
 516      * Is this profile subscribed to another profile?
 517      *
 518      * @param Profile $other
 519      * @return boolean
 520      */
 521     function isSubscribed($other)
 522     {
 523         return Subscription::exists($this, $other);
 524     }
 525
 526     /**
 527      * Are these two profiles subscribed to each other?
 528      *
 529      * @param Profile $other
 530      * @return boolean
 531      */
 532     function mutuallySubscribed($other)
 533     {
 534         return $this->isSubscribed($other) &&
 535           $other->isSubscribed($this);
 536     }
 537
 538     function hasFave($notice)
 539     {
 540         $cache = Cache::instance();
 541
 542         // XXX: Kind of a hack.
 543
 544         if (!empty($cache)) {
 545             // This is the stream of favorite notices, in rev chron
 546             // order. This forces it into cache.
 547
 548             $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
 549
 550             // If it's in the list, then it's a fave
 551
 552             if (in_array($notice->id, $ids)) {
 553                 return true;
 554             }
 555
 556             // If we're not past the end of the cache window,
 557             // then the cache has all available faves, so this one
 558             // is not a fave.
 559
 560             if (count($ids) < NOTICE_CACHE_WINDOW) {
 561                 return false;
 562             }
 563
 564             // Otherwise, cache doesn't have all faves;
 565             // fall through to the default
 566         }
 567
 568         $fave = Fave::pkeyGet(array('user_id' => $this->id,
 569                                     'notice_id' => $notice->id));
 570         return ((is_null($fave)) ? false : true);
 571     }
 572
 573     function faveCount()
 574     {
 575         $c = Cache::instance();
 576         if (!empty($c)) {
 577             $cnt = $c->get(Cache::key('profile:fave_count:'.$this->id));
 578             if (is_integer($cnt)) {
 579                 return (int) $cnt;
 580             }
 581         }
 582
 583         $faves = new Fave();
 584         $faves->user_id = $this->id;
 585         $cnt = (int) $faves->count('distinct notice_id');
 586
 587         if (!empty($c)) {
 588             $c->set(Cache::key('profile:fave_count:'.$this->id), $cnt);
 589         }
 590
 591         return $cnt;
 592     }
 593
 594     function noticeCount()
 595     {
 596         $c = Cache::instance();
 597
 598         if (!empty($c)) {
 599             $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
 600             if (is_integer($cnt)) {
 601                 return (int) $cnt;
 602             }
 603         }
 604
 605         $notices = new Notice();
 606         $notices->profile_id = $this->id;
 607         $cnt = (int) $notices->count('distinct id');
 608
 609         if (!empty($c)) {
 610             $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
 611         }
 612
 613         return $cnt;
 614     }
 615
 616     function blowFavesCache()
 617     {
 618         $cache = Cache::instance();
 619         if ($cache) {
 620             // Faves don't happen chronologically, so we need to blow
 621             // ;last cache, too
 622             $cache->delete(Cache::key('fave:ids_by_user:'.$this->id));
 623             $cache->delete(Cache::key('fave:ids_by_user:'.$this->id.';last'));
 624             $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id));
 625             $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id.';last'));
 626         }
 627         $this->blowFaveCount();
 628     }
 629
 630     function blowSubscriberCount()
 631     {
 632         $c = Cache::instance();
 633         if (!empty($c)) {
 634             $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
 635         }
 636     }
 637
 638     function blowSubscriptionCount()
 639     {
 640         $c = Cache::instance();
 641         if (!empty($c)) {
 642             $c->delete(Cache::key('profile:subscription_count:'.$this->id));
 643         }
 644     }
 645
 646     function blowFaveCount()
 647     {
 648         $c = Cache::instance();
 649         if (!empty($c)) {
 650             $c->delete(Cache::key('profile:fave_count:'.$this->id));
 651         }
 652     }
 653
 654     function blowNoticeCount()
 655     {
 656         $c = Cache::instance();
 657         if (!empty($c)) {
 658             $c->delete(Cache::key('profile:notice_count:'.$this->id));
 659         }
 660     }
 661
 662     static function maxBio()
 663     {
 664         $biolimit = common_config('profile', 'biolimit');
 665         // null => use global limit (distinct from 0!)
 666         if (is_null($biolimit)) {
 667             $biolimit = common_config('site', 'textlimit');
 668         }
 669         return $biolimit;
 670     }
 671
 672     static function bioTooLong($bio)
 673     {
 674         $biolimit = self::maxBio();
 675         return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
 676     }
 677
 678     function delete()
 679     {
 680         $this->_deleteNotices();
 681         $this->_deleteSubscriptions();
 682         $this->_deleteMessages();
 683         $this->_deleteTags();
 684         $this->_deleteBlocks();
 685         $this->delete_avatars();
 686
 687         // Warning: delete() will run on the batch objects,
 688         // not on individual objects.
 689         $related = array('Reply',
 690                          'Group_member',
 691                          );
 692         Event::handle('ProfileDeleteRelated', array($this, &$related));
 693
 694         foreach ($related as $cls) {
 695             $inst = new $cls();
 696             $inst->profile_id = $this->id;
 697             $inst->delete();
 698         }
 699
 700         parent::delete();
 701     }
 702
 703     function _deleteNotices()
 704     {
 705         $notice = new Notice();
 706         $notice->profile_id = $this->id;
 707
 708         if ($notice->find()) {
 709             while ($notice->fetch()) {
 710                 $other = clone($notice);
 711                 $other->delete();
 712             }
 713         }
 714     }
 715
 716     function _deleteSubscriptions()
 717     {
 718         $sub = new Subscription();
 719         $sub->subscriber = $this->id;
 720
 721         $sub->find();
 722
 723         while ($sub->fetch()) {
 724             $other = Profile::staticGet('id', $sub->subscribed);
 725             if (empty($other)) {
 726                 continue;
 727             }
 728             if ($other->id == $this->id) {
 729                 continue;
 730             }
 731             Subscription::cancel($this, $other);
 732         }
 733
 734         $subd = new Subscription();
 735         $subd->subscribed = $this->id;
 736         $subd->find();
 737
 738         while ($subd->fetch()) {
 739             $other = Profile::staticGet('id', $subd->subscriber);
 740             if (empty($other)) {
 741                 continue;
 742             }
 743             if ($other->id == $this->id) {
 744                 continue;
 745             }
 746             Subscription::cancel($other, $this);
 747         }
 748
 749         $self = new Subscription();
 750
 751         $self->subscriber = $this->id;
 752         $self->subscribed = $this->id;
 753
 754         $self->delete();
 755     }
 756
 757     function _deleteMessages()
 758     {
 759         $msg = new Message();
 760         $msg->from_profile = $this->id;
 761         $msg->delete();
 762
 763         $msg = new Message();
 764         $msg->to_profile = $this->id;
 765         $msg->delete();
 766     }
 767
 768     function _deleteTags()
 769     {
 770         $tag = new Profile_tag();
 771         $tag->tagged = $this->id;
 772         $tag->delete();
 773     }
 774
 775     function _deleteBlocks()
 776     {
 777         $block = new Profile_block();
 778         $block->blocked = $this->id;
 779         $block->delete();
 780
 781         $block = new Group_block();
 782         $block->blocked = $this->id;
 783         $block->delete();
 784     }
 785
 786     // XXX: identical to Notice::getLocation.
 787
 788     function getLocation()
 789     {
 790         $location = null;
 791
 792         if (!empty($this->location_id) && !empty($this->location_ns)) {
 793             $location = Location::fromId($this->location_id, $this->location_ns);
 794         }
 795
 796         if (is_null($location)) { // no ID, or Location::fromId() failed
 797             if (!empty($this->lat) && !empty($this->lon)) {
 798                 $location = Location::fromLatLon($this->lat, $this->lon);
 799             }
 800         }
 801
 802         if (is_null($location)) { // still haven't found it!
 803             if (!empty($this->location)) {
 804                 $location = Location::fromName($this->location);
 805             }
 806         }
 807
 808         return $location;
 809     }
 810
 811     function hasRole($name)
 812     {
 813         $has_role = false;
 814         if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
 815             $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
 816                                                 'role' => $name));
 817             $has_role = !empty($role);
 818             Event::handle('EndHasRole', array($this, $name, $has_role));
 819         }
 820         return $has_role;
 821     }
 822
 823     function grantRole($name)
 824     {
 825         if (Event::handle('StartGrantRole', array($this, $name))) {
 826
 827             $role = new Profile_role();
 828
 829             $role->profile_id = $this->id;
 830             $role->role       = $name;
 831             $role->created    = common_sql_now();
 832
 833             $result = $role->insert();
 834
 835             if (!$result) {
 836                 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
 837             }
 838
 839             if ($name == 'owner') {
 840                 User::blow('user:site_owner');
 841             }
 842
 843             Event::handle('EndGrantRole', array($this, $name));
 844         }
 845
 846         return $result;
 847     }
 848
 849     function revokeRole($name)
 850     {
 851         if (Event::handle('StartRevokeRole', array($this, $name))) {
 852
 853             $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
 854                                                 'role' => $name));
 855
 856             if (empty($role)) {
 857                 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
 858                 // TRANS: %1$s is the role name, %2$s is the user ID (number).
 859                 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
 860             }
 861
 862             $result = $role->delete();
 863
 864             if (!$result) {
 865                 common_log_db_error($role, 'DELETE', __FILE__);
 866                 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
 867                 // TRANS: %1$s is the role name, %2$s is the user ID (number).
 868                 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
 869             }
 870
 871             if ($name == 'owner') {
 872                 User::blow('user:site_owner');
 873             }
 874
 875             Event::handle('EndRevokeRole', array($this, $name));
 876
 877             return true;
 878         }
 879     }
 880
 881     function isSandboxed()
 882     {
 883         return $this->hasRole(Profile_role::SANDBOXED);
 884     }
 885
 886     function isSilenced()
 887     {
 888         return $this->hasRole(Profile_role::SILENCED);
 889     }
 890
 891     function sandbox()
 892     {
 893         $this->grantRole(Profile_role::SANDBOXED);
 894     }
 895
 896     function unsandbox()
 897     {
 898         $this->revokeRole(Profile_role::SANDBOXED);
 899     }
 900
 901     function silence()
 902     {
 903         $this->grantRole(Profile_role::SILENCED);
 904     }
 905
 906     function unsilence()
 907     {
 908         $this->revokeRole(Profile_role::SILENCED);
 909     }
 910
 911     /**
 912      * Does this user have the right to do X?
 913      *
 914      * With our role-based authorization, this is merely a lookup for whether the user
 915      * has a particular role. The implementation currently uses a switch statement
 916      * to determine if the user has the pre-defined role to exercise the right. Future
 917      * implementations may allow per-site roles, and different mappings of roles to rights.
 918      *
 919      * @param $right string Name of the right, usually a constant in class Right
 920      * @return boolean whether the user has the right in question
 921      */
 922     function hasRight($right)
 923     {
 924         $result = false;
 925
 926         if ($this->hasRole(Profile_role::DELETED)) {
 927             return false;
 928         }
 929
 930         if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
 931             switch ($right)
 932             {
 933             case Right::DELETEOTHERSNOTICE:
 934             case Right::MAKEGROUPADMIN:
 935             case Right::SANDBOXUSER:
 936             case Right::SILENCEUSER:
 937             case Right::DELETEUSER:
 938             case Right::DELETEGROUP:
 939                 $result = $this->hasRole(Profile_role::MODERATOR);
 940                 break;
 941             case Right::CONFIGURESITE:
 942                 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
 943                 break;
 944             case Right::GRANTROLE:
 945             case Right::REVOKEROLE:
 946                 $result = $this->hasRole(Profile_role::OWNER);
 947                 break;
 948             case Right::NEWNOTICE:
 949             case Right::NEWMESSAGE:
 950             case Right::SUBSCRIBE:
 951             case Right::CREATEGROUP:
 952                 $result = !$this->isSilenced();
 953                 break;
 954             case Right::PUBLICNOTICE:
 955             case Right::EMAILONREPLY:
 956             case Right::EMAILONSUBSCRIBE:
 957             case Right::EMAILONFAVE:
 958                 $result = !$this->isSandboxed();
 959                 break;
 960             case Right::WEBLOGIN:
 961                 $result = !$this->isSilenced();
 962                 break;
 963             case Right::API:
 964                 $result = !$this->isSilenced();
 965                 break;
 966             case Right::BACKUPACCOUNT:
 967                 $result = common_config('profile', 'backup');
 968                 break;
 969             case Right::RESTOREACCOUNT:
 970                 $result = common_config('profile', 'restore');
 971                 break;
 972             case Right::DELETEACCOUNT:
 973                 $result = common_config('profile', 'delete');
 974                 break;
 975             case Right::MOVEACCOUNT:
 976                 $result = common_config('profile', 'move');
 977                 break;
 978             default:
 979                 $result = false;
 980                 break;
 981             }
 982         }
 983         return $result;
 984     }
 985
 986     function hasRepeated($notice_id)
 987     {
 988         // XXX: not really a pkey, but should work
 989
 990         $notice = Memcached_DataObject::pkeyGet('Notice',
 991                                                 array('profile_id' => $this->id,
 992                                                       'repeat_of' => $notice_id));
 993
 994         return !empty($notice);
 995     }
 996
 997     /**
 998      * Returns an XML string fragment with limited profile information
 999      * as an Atom <author> element.
1000      *
1001      * Assumes that Atom has been previously set up as the base namespace.
1002      *
1003      * @param Profile $cur the current authenticated user
1004      *
1005      * @return string
1006      */
1007     function asAtomAuthor($cur = null)
1008     {
1009         $xs = new XMLStringer(true);
1010
1011         $xs->elementStart('author');
1012         $xs->element('name', null, $this->nickname);
1013         $xs->element('uri', null, $this->getUri());
1014         if ($cur != null) {
1015             $attrs = Array();
1016             $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1017             $attrs['blocking']  = $cur->hasBlocked($this) ? 'true' : 'false';
1018             $xs->element('statusnet:profile_info', $attrs, null);
1019         }
1020         $xs->elementEnd('author');
1021
1022         return $xs->getString();
1023     }
1024
1025     /**
1026      * Extra profile info for atom entries
1027      *
1028      * Clients use some extra profile info in the atom stream.
1029      * This gives it to them.
1030      *
1031      * @param User $cur Current user
1032      *
1033      * @return array representation of <statusnet:profile_info> element or null
1034      */
1035
1036     function profileInfo($cur)
1037     {
1038         $profileInfoAttr = array('local_id' => $this->id);
1039
1040         if ($cur != null) {
1041             // Whether the current user is a subscribed to this profile
1042             $profileInfoAttr['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1043             // Whether the current user is has blocked this profile
1044             $profileInfoAttr['blocking']  = $cur->hasBlocked($this) ? 'true' : 'false';
1045         }
1046
1047         return array('statusnet:profile_info', $profileInfoAttr, null);
1048     }
1049
1050     /**
1051      * Returns an XML string fragment with profile information as an
1052      * Activity Streams <activity:actor> element.
1053      *
1054      * Assumes that 'activity' namespace has been previously defined.
1055      *
1056      * @return string
1057      */
1058     function asActivityActor()
1059     {
1060         return $this->asActivityNoun('actor');
1061     }
1062
1063     /**
1064      * Returns an XML string fragment with profile information as an
1065      * Activity Streams noun object with the given element type.
1066      *
1067      * Assumes that 'activity', 'georss', and 'poco' namespace has been
1068      * previously defined.
1069      *
1070      * @param string $element one of 'actor', 'subject', 'object', 'target'
1071      *
1072      * @return string
1073      */
1074     function asActivityNoun($element)
1075     {
1076         $noun = ActivityObject::fromProfile($this);
1077         return $noun->asString('activity:' . $element);
1078     }
1079
1080     /**
1081      * Returns the best URI for a profile. Plugins may override.
1082      *
1083      * @return string $uri
1084      */
1085     function getUri()
1086     {
1087         $uri = null;
1088
1089         // give plugins a chance to set the URI
1090         if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1091
1092             // check for a local user first
1093             $user = User::staticGet('id', $this->id);
1094
1095             if (!empty($user)) {
1096                 $uri = $user->uri;
1097             } else {
1098                 // return OMB profile if any
1099                 $remote = Remote_profile::staticGet('id', $this->id);
1100                 if (!empty($remote)) {
1101                     $uri = $remote->uri;
1102                 }
1103             }
1104             Event::handle('EndGetProfileUri', array($this, &$uri));
1105         }
1106
1107         return $uri;
1108     }
1109
1110     function hasBlocked($other)
1111     {
1112         $block = Profile_block::get($this->id, $other->id);
1113
1114         if (empty($block)) {
1115             $result = false;
1116         } else {
1117             $result = true;
1118         }
1119
1120         return $result;
1121     }
1122
1123     function getAtomFeed()
1124     {
1125         $feed = null;
1126
1127         if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1128             $user = User::staticGet('id', $this->id);
1129             if (!empty($user)) {
1130                 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1131                                                                   'format' => 'atom'));
1132             }
1133             Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1134         }
1135
1136         return $feed;
1137     }
1138
1139     static function fromURI($uri)
1140     {
1141         $profile = null;
1142
1143         if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1144             // Get a local user or remote (OMB 0.1) profile
1145             $user = User::staticGet('uri', $uri);
1146             if (!empty($user)) {
1147                 $profile = $user->getProfile();
1148             } else {
1149                 $remote_profile = Remote_profile::staticGet('uri', $uri);
1150                 if (!empty($remote_profile)) {
1151                     $profile = Profile::staticGet('id', $remote_profile->profile_id);
1152                 }
1153             }
1154             Event::handle('EndGetProfileFromURI', array($uri, $profile));
1155         }
1156
1157         return $profile;
1158     }
1159 }