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