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