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