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