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     function delete_avatars($original=true)
 129     {
 130         $avatar = new Avatar();
 131         $avatar->profile_id = $this->id;
 132         $avatar->find();
 133         while ($avatar->fetch()) {
 134             if ($avatar->original) {
 135                 if ($original == false) {
 136                     continue;
 137                 }
 138             }
 139             $avatar->delete();
 140         }
 141         return true;
 142     }
 143
 144     function getBestName()
 145     {
 146         return ($this->fullname) ? $this->fullname : $this->nickname;
 147     }
 148
 149     /**
 150      * Get the most recent notice posted by this user, if any.
 151      *
 152      * @return mixed Notice or null
 153      */
 154
 155     function getCurrentNotice()
 156     {
 157         $notice = $this->getNotices(0, 1);
 158
 159         if ($notice->fetch()) {
 160             return $notice;
 161         } else {
 162             return null;
 163         }
 164     }
 165
 166     function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
 167     {
 168         $ids = Notice::stream(array($this, '_streamTaggedDirect'),
 169                               array($tag),
 170                               'profile:notice_ids_tagged:' . $this->id . ':' . $tag,
 171                               $offset, $limit, $since_id, $max_id);
 172         return Notice::getStreamByIds($ids);
 173     }
 174
 175     function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
 176     {
 177         // XXX: I'm not sure this is going to be any faster. It probably isn't.
 178         $ids = Notice::stream(array($this, '_streamDirect'),
 179                               array(),
 180                               'profile:notice_ids:' . $this->id,
 181                               $offset, $limit, $since_id, $max_id);
 182
 183         return Notice::getStreamByIds($ids);
 184     }
 185
 186     function _streamTaggedDirect($tag, $offset, $limit, $since_id, $max_id)
 187     {
 188         // XXX It would be nice to do this without a join
 189
 190         $notice = new Notice();
 191
 192         $query =
 193           "select id from notice join notice_tag on id=notice_id where tag='".
 194           $notice->escape($tag) .
 195           "' and profile_id=" . $notice->escape($this->id);
 196
 197         if ($since_id != 0) {
 198             $query .= " and id > $since_id";
 199         }
 200
 201         if ($max_id != 0) {
 202             $query .= " and id <= $max_id";
 203         }
 204
 205         $query .= ' order by id DESC';
 206
 207         if (!is_null($offset)) {
 208             $query .= " LIMIT $limit OFFSET $offset";
 209         }
 210
 211         $notice->query($query);
 212
 213         $ids = array();
 214
 215         while ($notice->fetch()) {
 216             $ids[] = $notice->id;
 217         }
 218
 219         return $ids;
 220     }
 221
 222     function _streamDirect($offset, $limit, $since_id, $max_id)
 223     {
 224         $notice = new Notice();
 225
 226         // Temporary hack until notice_profile_id_idx is updated
 227         // to (profile_id, id) instead of (profile_id, created, id).
 228         // It's been falling back to PRIMARY instead, which is really
 229         // very inefficient for a profile that hasn't posted in a few
 230         // months. Even though forcing the index will cause a filesort,
 231         // it's usually going to be better.
 232         if (common_config('db', 'type') == 'mysql') {
 233             $index = '';
 234             $query =
 235               "select id from notice force index (notice_profile_id_idx) ".
 236               "where profile_id=" . $notice->escape($this->id);
 237
 238             if ($since_id != 0) {
 239                 $query .= " and id > $since_id";
 240             }
 241
 242             if ($max_id != 0) {
 243                 $query .= " and id <= $max_id";
 244             }
 245
 246             $query .= ' order by id DESC';
 247
 248             if (!is_null($offset)) {
 249                 $query .= " LIMIT $limit OFFSET $offset";
 250             }
 251
 252             $notice->query($query);
 253         } else {
 254             $index = '';
 255
 256             $notice->profile_id = $this->id;
 257
 258             $notice->selectAdd();
 259             $notice->selectAdd('id');
 260
 261             if ($since_id != 0) {
 262                 $notice->whereAdd('id > ' . $since_id);
 263             }
 264
 265             if ($max_id != 0) {
 266                 $notice->whereAdd('id <= ' . $max_id);
 267             }
 268
 269             $notice->orderBy('id DESC');
 270
 271             if (!is_null($offset)) {
 272                 $notice->limit($offset, $limit);
 273             }
 274
 275             $notice->find();
 276         }
 277
 278         $ids = array();
 279
 280         while ($notice->fetch()) {
 281             $ids[] = $notice->id;
 282         }
 283
 284         return $ids;
 285     }
 286
 287     function isMember($group)
 288     {
 289         $mem = new Group_member();
 290
 291         $mem->group_id = $group->id;
 292         $mem->profile_id = $this->id;
 293
 294         if ($mem->find()) {
 295             return true;
 296         } else {
 297             return false;
 298         }
 299     }
 300
 301     function isAdmin($group)
 302     {
 303         $mem = new Group_member();
 304
 305         $mem->group_id = $group->id;
 306         $mem->profile_id = $this->id;
 307         $mem->is_admin = 1;
 308
 309         if ($mem->find()) {
 310             return true;
 311         } else {
 312             return false;
 313         }
 314     }
 315
 316     function getGroups($offset=0, $limit=null)
 317     {
 318         $qry =
 319           'SELECT user_group.* ' .
 320           'FROM user_group JOIN group_member '.
 321           'ON user_group.id = group_member.group_id ' .
 322           'WHERE group_member.profile_id = %d ' .
 323           'ORDER BY group_member.created DESC ';
 324
 325         if ($offset>0 && !is_null($limit)) {
 326             if ($offset) {
 327                 if (common_config('db','type') == 'pgsql') {
 328                     $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 329                 } else {
 330                     $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 331                 }
 332             }
 333         }
 334
 335         $groups = new User_group();
 336
 337         $cnt = $groups->query(sprintf($qry, $this->id));
 338
 339         return $groups;
 340     }
 341
 342     function avatarUrl($size=AVATAR_PROFILE_SIZE)
 343     {
 344         $avatar = $this->getAvatar($size);
 345         if ($avatar) {
 346             return $avatar->displayUrl();
 347         } else {
 348             return Avatar::defaultImage($size);
 349         }
 350     }
 351
 352     function getSubscriptions($offset=0, $limit=null)
 353     {
 354         $qry =
 355           'SELECT profile.* ' .
 356           'FROM profile JOIN subscription ' .
 357           'ON profile.id = subscription.subscribed ' .
 358           'WHERE subscription.subscriber = %d ' .
 359           'AND subscription.subscribed != subscription.subscriber ' .
 360           'ORDER BY subscription.created DESC ';
 361
 362         if ($offset>0 && !is_null($limit)){
 363             if (common_config('db','type') == 'pgsql') {
 364                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 365             } else {
 366                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 367             }
 368         }
 369
 370         $profile = new Profile();
 371
 372         $profile->query(sprintf($qry, $this->id));
 373
 374         return $profile;
 375     }
 376
 377     function getSubscribers($offset=0, $limit=null)
 378     {
 379         $qry =
 380           'SELECT profile.* ' .
 381           'FROM profile JOIN subscription ' .
 382           'ON profile.id = subscription.subscriber ' .
 383           'WHERE subscription.subscribed = %d ' .
 384           'AND subscription.subscribed != subscription.subscriber ' .
 385           'ORDER BY subscription.created DESC ';
 386
 387         if ($offset>0 && !is_null($limit)){
 388             if ($offset) {
 389                 if (common_config('db','type') == 'pgsql') {
 390                     $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 391                 } else {
 392                     $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 393                 }
 394             }
 395         }
 396
 397         $profile = new Profile();
 398
 399         $cnt = $profile->query(sprintf($qry, $this->id));
 400
 401         return $profile;
 402     }
 403
 404     function getConnectedApps($offset = 0, $limit = null)
 405     {
 406         $qry =
 407           'SELECT u.* ' .
 408           'FROM oauth_application_user u, oauth_application a ' .
 409           'WHERE u.profile_id = %d ' .
 410           'AND a.id = u.application_id ' .
 411           'AND u.access_type > 0 ' .
 412           'ORDER BY u.created DESC ';
 413
 414         if ($offset > 0) {
 415             if (common_config('db','type') == 'pgsql') {
 416                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 417             } else {
 418                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 419             }
 420         }
 421
 422         $apps = new Oauth_application_user();
 423
 424         $cnt = $apps->query(sprintf($qry, $this->id));
 425
 426         return $apps;
 427     }
 428
 429     function subscriptionCount()
 430     {
 431         $c = common_memcache();
 432
 433         if (!empty($c)) {
 434             $cnt = $c->get(common_cache_key('profile:subscription_count:'.$this->id));
 435             if (is_integer($cnt)) {
 436                 return (int) $cnt;
 437             }
 438         }
 439
 440         $sub = new Subscription();
 441         $sub->subscriber = $this->id;
 442
 443         $cnt = (int) $sub->count('distinct subscribed');
 444
 445         $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
 446
 447         if (!empty($c)) {
 448             $c->set(common_cache_key('profile:subscription_count:'.$this->id), $cnt);
 449         }
 450
 451         return $cnt;
 452     }
 453
 454     function subscriberCount()
 455     {
 456         $c = common_memcache();
 457         if (!empty($c)) {
 458             $cnt = $c->get(common_cache_key('profile:subscriber_count:'.$this->id));
 459             if (is_integer($cnt)) {
 460                 return (int) $cnt;
 461             }
 462         }
 463
 464         $sub = new Subscription();
 465         $sub->subscribed = $this->id;
 466         $sub->whereAdd('subscriber != subscribed');
 467         $cnt = (int) $sub->count('distinct subscriber');
 468
 469         if (!empty($c)) {
 470             $c->set(common_cache_key('profile:subscriber_count:'.$this->id), $cnt);
 471         }
 472
 473         return $cnt;
 474     }
 475
 476     /**
 477      * Is this profile subscribed to another profile?
 478      *
 479      * @param Profile $other
 480      * @return boolean
 481      */
 482     function isSubscribed($other)
 483     {
 484         return Subscription::exists($this, $other);
 485     }
 486
 487     /**
 488      * Are these two profiles subscribed to each other?
 489      *
 490      * @param Profile $other
 491      * @return boolean
 492      */
 493     function mutuallySubscribed($other)
 494     {
 495         return $this->isSubscribed($other) &&
 496           $other->isSubscribed($this);
 497     }
 498
 499     function hasFave($notice)
 500     {
 501         $cache = common_memcache();
 502
 503         // XXX: Kind of a hack.
 504
 505         if (!empty($cache)) {
 506             // This is the stream of favorite notices, in rev chron
 507             // order. This forces it into cache.
 508
 509             $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
 510
 511             // If it's in the list, then it's a fave
 512
 513             if (in_array($notice->id, $ids)) {
 514                 return true;
 515             }
 516
 517             // If we're not past the end of the cache window,
 518             // then the cache has all available faves, so this one
 519             // is not a fave.
 520
 521             if (count($ids) < NOTICE_CACHE_WINDOW) {
 522                 return false;
 523             }
 524
 525             // Otherwise, cache doesn't have all faves;
 526             // fall through to the default
 527         }
 528
 529         $fave = Fave::pkeyGet(array('user_id' => $this->id,
 530                                     'notice_id' => $notice->id));
 531         return ((is_null($fave)) ? false : true);
 532     }
 533
 534     function faveCount()
 535     {
 536         $c = common_memcache();
 537         if (!empty($c)) {
 538             $cnt = $c->get(common_cache_key('profile:fave_count:'.$this->id));
 539             if (is_integer($cnt)) {
 540                 return (int) $cnt;
 541             }
 542         }
 543
 544         $faves = new Fave();
 545         $faves->user_id = $this->id;
 546         $cnt = (int) $faves->count('distinct notice_id');
 547
 548         if (!empty($c)) {
 549             $c->set(common_cache_key('profile:fave_count:'.$this->id), $cnt);
 550         }
 551
 552         return $cnt;
 553     }
 554
 555     function noticeCount()
 556     {
 557         $c = common_memcache();
 558
 559         if (!empty($c)) {
 560             $cnt = $c->get(common_cache_key('profile:notice_count:'.$this->id));
 561             if (is_integer($cnt)) {
 562                 return (int) $cnt;
 563             }
 564         }
 565
 566         $notices = new Notice();
 567         $notices->profile_id = $this->id;
 568         $cnt = (int) $notices->count('distinct id');
 569
 570         if (!empty($c)) {
 571             $c->set(common_cache_key('profile:notice_count:'.$this->id), $cnt);
 572         }
 573
 574         return $cnt;
 575     }
 576
 577     function blowFavesCache()
 578     {
 579         $cache = common_memcache();
 580         if ($cache) {
 581             // Faves don't happen chronologically, so we need to blow
 582             // ;last cache, too
 583             $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
 584             $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
 585             $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
 586             $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
 587         }
 588         $this->blowFaveCount();
 589     }
 590
 591     function blowSubscriberCount()
 592     {
 593         $c = common_memcache();
 594         if (!empty($c)) {
 595             $c->delete(common_cache_key('profile:subscriber_count:'.$this->id));
 596         }
 597     }
 598
 599     function blowSubscriptionCount()
 600     {
 601         $c = common_memcache();
 602         if (!empty($c)) {
 603             $c->delete(common_cache_key('profile:subscription_count:'.$this->id));
 604         }
 605     }
 606
 607     function blowFaveCount()
 608     {
 609         $c = common_memcache();
 610         if (!empty($c)) {
 611             $c->delete(common_cache_key('profile:fave_count:'.$this->id));
 612         }
 613     }
 614
 615     function blowNoticeCount()
 616     {
 617         $c = common_memcache();
 618         if (!empty($c)) {
 619             $c->delete(common_cache_key('profile:notice_count:'.$this->id));
 620         }
 621     }
 622
 623     static function maxBio()
 624     {
 625         $biolimit = common_config('profile', 'biolimit');
 626         // null => use global limit (distinct from 0!)
 627         if (is_null($biolimit)) {
 628             $biolimit = common_config('site', 'textlimit');
 629         }
 630         return $biolimit;
 631     }
 632
 633     static function bioTooLong($bio)
 634     {
 635         $biolimit = self::maxBio();
 636         return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
 637     }
 638
 639     function delete()
 640     {
 641         $this->_deleteNotices();
 642         $this->_deleteSubscriptions();
 643         $this->_deleteMessages();
 644         $this->_deleteTags();
 645         $this->_deleteBlocks();
 646
 647         $related = array('Avatar',
 648                          'Reply',
 649                          'Group_member',
 650                          );
 651         Event::handle('ProfileDeleteRelated', array($this, &$related));
 652
 653         foreach ($related as $cls) {
 654             $inst = new $cls();
 655             $inst->profile_id = $this->id;
 656             $inst->delete();
 657         }
 658
 659         parent::delete();
 660     }
 661
 662     function _deleteNotices()
 663     {
 664         $notice = new Notice();
 665         $notice->profile_id = $this->id;
 666
 667         if ($notice->find()) {
 668             while ($notice->fetch()) {
 669                 $other = clone($notice);
 670                 $other->delete();
 671             }
 672         }
 673     }
 674
 675     function _deleteSubscriptions()
 676     {
 677         $sub = new Subscription();
 678         $sub->subscriber = $this->id;
 679
 680         $sub->find();
 681
 682         while ($sub->fetch()) {
 683             $other = Profile::staticGet('id', $sub->subscribed);
 684             if (empty($other)) {
 685                 continue;
 686             }
 687             if ($other->id == $this->id) {
 688                 continue;
 689             }
 690             Subscription::cancel($this, $other);
 691         }
 692
 693         $subd = new Subscription();
 694         $subd->subscribed = $this->id;
 695         $subd->find();
 696
 697         while ($subd->fetch()) {
 698             $other = Profile::staticGet('id', $subd->subscriber);
 699             if (empty($other)) {
 700                 continue;
 701             }
 702             if ($other->id == $this->id) {
 703                 continue;
 704             }
 705             Subscription::cancel($other, $this);
 706         }
 707
 708         $self = new Subscription();
 709
 710         $self->subscriber = $this->id;
 711         $self->subscribed = $this->id;
 712
 713         $self->delete();
 714     }
 715
 716     function _deleteMessages()
 717     {
 718         $msg = new Message();
 719         $msg->from_profile = $this->id;
 720         $msg->delete();
 721
 722         $msg = new Message();
 723         $msg->to_profile = $this->id;
 724         $msg->delete();
 725     }
 726
 727     function _deleteTags()
 728     {
 729         $tag = new Profile_tag();
 730         $tag->tagged = $this->id;
 731         $tag->delete();
 732     }
 733
 734     function _deleteBlocks()
 735     {
 736         $block = new Profile_block();
 737         $block->blocked = $this->id;
 738         $block->delete();
 739
 740         $block = new Group_block();
 741         $block->blocked = $this->id;
 742         $block->delete();
 743     }
 744
 745     // XXX: identical to Notice::getLocation.
 746
 747     function getLocation()
 748     {
 749         $location = null;
 750
 751         if (!empty($this->location_id) && !empty($this->location_ns)) {
 752             $location = Location::fromId($this->location_id, $this->location_ns);
 753         }
 754
 755         if (is_null($location)) { // no ID, or Location::fromId() failed
 756             if (!empty($this->lat) && !empty($this->lon)) {
 757                 $location = Location::fromLatLon($this->lat, $this->lon);
 758             }
 759         }
 760
 761         if (is_null($location)) { // still haven't found it!
 762             if (!empty($this->location)) {
 763                 $location = Location::fromName($this->location);
 764             }
 765         }
 766
 767         return $location;
 768     }
 769
 770     function hasRole($name)
 771     {
 772         $has_role = false;
 773         if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
 774             $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
 775                                                 'role' => $name));
 776             $has_role = !empty($role);
 777             Event::handle('EndHasRole', array($this, $name, $has_role));
 778         }
 779         return $has_role;
 780     }
 781
 782     function grantRole($name)
 783     {
 784         if (Event::handle('StartGrantRole', array($this, $name))) {
 785
 786             $role = new Profile_role();
 787
 788             $role->profile_id = $this->id;
 789             $role->role       = $name;
 790             $role->created    = common_sql_now();
 791
 792             $result = $role->insert();
 793
 794             if (!$result) {
 795                 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
 796             }
 797
 798             Event::handle('EndGrantRole', array($this, $name));
 799         }
 800
 801         return $result;
 802     }
 803
 804     function revokeRole($name)
 805     {
 806         if (Event::handle('StartRevokeRole', array($this, $name))) {
 807
 808             $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
 809                                                 'role' => $name));
 810
 811             if (empty($role)) {
 812                 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
 813                 // TRANS: %1$s is the role name, %2$s is the user ID (number).
 814                 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
 815             }
 816
 817             $result = $role->delete();
 818
 819             if (!$result) {
 820                 common_log_db_error($role, 'DELETE', __FILE__);
 821                 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
 822                 // TRANS: %1$s is the role name, %2$s is the user ID (number).
 823                 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
 824             }
 825
 826             Event::handle('EndRevokeRole', array($this, $name));
 827
 828             return true;
 829         }
 830     }
 831
 832     function isSandboxed()
 833     {
 834         return $this->hasRole(Profile_role::SANDBOXED);
 835     }
 836
 837     function isSilenced()
 838     {
 839         return $this->hasRole(Profile_role::SILENCED);
 840     }
 841
 842     function sandbox()
 843     {
 844         $this->grantRole(Profile_role::SANDBOXED);
 845     }
 846
 847     function unsandbox()
 848     {
 849         $this->revokeRole(Profile_role::SANDBOXED);
 850     }
 851
 852     function silence()
 853     {
 854         $this->grantRole(Profile_role::SILENCED);
 855     }
 856
 857     function unsilence()
 858     {
 859         $this->revokeRole(Profile_role::SILENCED);
 860     }
 861
 862     /**
 863      * Does this user have the right to do X?
 864      *
 865      * With our role-based authorization, this is merely a lookup for whether the user
 866      * has a particular role. The implementation currently uses a switch statement
 867      * to determine if the user has the pre-defined role to exercise the right. Future
 868      * implementations may allow per-site roles, and different mappings of roles to rights.
 869      *
 870      * @param $right string Name of the right, usually a constant in class Right
 871      * @return boolean whether the user has the right in question
 872      */
 873     function hasRight($right)
 874     {
 875         $result = false;
 876
 877         if ($this->hasRole(Profile_role::DELETED)) {
 878             return false;
 879         }
 880
 881         if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
 882             switch ($right)
 883             {
 884             case Right::DELETEOTHERSNOTICE:
 885             case Right::MAKEGROUPADMIN:
 886             case Right::SANDBOXUSER:
 887             case Right::SILENCEUSER:
 888             case Right::DELETEUSER:
 889             case Right::DELETEGROUP:
 890                 $result = $this->hasRole(Profile_role::MODERATOR);
 891                 break;
 892             case Right::CONFIGURESITE:
 893                 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
 894                 break;
 895             case Right::GRANTROLE:
 896             case Right::REVOKEROLE:
 897                 $result = $this->hasRole(Profile_role::OWNER);
 898                 break;
 899             case Right::NEWNOTICE:
 900             case Right::NEWMESSAGE:
 901             case Right::SUBSCRIBE:
 902                 $result = !$this->isSilenced();
 903                 break;
 904             case Right::PUBLICNOTICE:
 905             case Right::EMAILONREPLY:
 906             case Right::EMAILONSUBSCRIBE:
 907             case Right::EMAILONFAVE:
 908                 $result = !$this->isSandboxed();
 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      * Returns an XML string fragment with profile information as an
 959      * Activity Streams <activity:actor> element.
 960      *
 961      * Assumes that 'activity' namespace has been previously defined.
 962      *
 963      * @return string
 964      */
 965     function asActivityActor()
 966     {
 967         return $this->asActivityNoun('actor');
 968     }
 969
 970     /**
 971      * Returns an XML string fragment with profile information as an
 972      * Activity Streams noun object with the given element type.
 973      *
 974      * Assumes that 'activity', 'georss', and 'poco' namespace has been
 975      * previously defined.
 976      *
 977      * @param string $element one of 'actor', 'subject', 'object', 'target'
 978      *
 979      * @return string
 980      */
 981     function asActivityNoun($element)
 982     {
 983         $noun = ActivityObject::fromProfile($this);
 984         return $noun->asString('activity:' . $element);
 985     }
 986
 987     /**
 988      * Returns the best URI for a profile. Plugins may override.
 989      *
 990      * @return string $uri
 991      */
 992     function getUri()
 993     {
 994         $uri = null;
 995
 996         // give plugins a chance to set the URI
 997         if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
 998
 999             // check for a local user first
1000             $user = User::staticGet('id', $this->id);
1001
1002             if (!empty($user)) {
1003                 $uri = $user->uri;
1004             } else {
1005                 // return OMB profile if any
1006                 $remote = Remote_profile::staticGet('id', $this->id);
1007                 if (!empty($remote)) {
1008                     $uri = $remote->uri;
1009                 }
1010             }
1011             Event::handle('EndGetProfileUri', array($this, &$uri));
1012         }
1013
1014         return $uri;
1015     }
1016
1017     function hasBlocked($other)
1018     {
1019         $block = Profile_block::get($this->id, $other->id);
1020
1021         if (empty($block)) {
1022             $result = false;
1023         } else {
1024             $result = true;
1025         }
1026
1027         return $result;
1028     }
1029
1030     function getAtomFeed()
1031     {
1032         $feed = null;
1033
1034         if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1035             $user = User::staticGet('id', $this->id);
1036             if (!empty($user)) {
1037                 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1038                                                                   'format' => 'atom'));
1039             }
1040             Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1041         }
1042
1043         return $feed;
1044     }
1045
1046     static function fromURI($uri)
1047     {
1048         $profile = null;
1049
1050         if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1051             // Get a local user or remote (OMB 0.1) profile
1052             $user = User::staticGet('uri', $uri);
1053             if (!empty($user)) {
1054                 $profile = $user->getProfile();
1055             } else {
1056                 $remote_profile = Remote_profile::staticGet('uri', $uri);
1057                 if (!empty($remote_profile)) {
1058                     $profile = Profile::staticGet('id', $remote_profile->profile_id);
1059                 }
1060             }
1061             Event::handle('EndGetProfileFromURI', array($uri, $profile));
1062         }
1063
1064         return $profile;
1065     }
1066 }