classes/Profile.php

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