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(_m('FANCYNAME','%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 = common_memcache();
 453
 454         if (!empty($c)) {
 455             $cnt = $c->get(common_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(common_cache_key('profile:subscription_count:'.$this->id), $cnt);
 470         }
 471
 472         return $cnt;
 473     }
 474
 475     function subscriberCount()
 476     {
 477         $c = common_memcache();
 478         if (!empty($c)) {
 479             $cnt = $c->get(common_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(common_cache_key('profile:subscriber_count:'.$this->id), $cnt);
 492         }
 493
 494         return $cnt;
 495     }
 496
 497     /**
 498      * Is this profile subscribed to another profile?
 499      *
 500      * @param Profile $other
 501      * @return boolean
 502      */
 503     function isSubscribed($other)
 504     {
 505         return Subscription::exists($this, $other);
 506     }
 507
 508     /**
 509      * Are these two profiles subscribed to each other?
 510      *
 511      * @param Profile $other
 512      * @return boolean
 513      */
 514     function mutuallySubscribed($other)
 515     {
 516         return $this->isSubscribed($other) &&
 517           $other->isSubscribed($this);
 518     }
 519
 520     function hasFave($notice)
 521     {
 522         $cache = common_memcache();
 523
 524         // XXX: Kind of a hack.
 525
 526         if (!empty($cache)) {
 527             // This is the stream of favorite notices, in rev chron
 528             // order. This forces it into cache.
 529
 530             $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
 531
 532             // If it's in the list, then it's a fave
 533
 534             if (in_array($notice->id, $ids)) {
 535                 return true;
 536             }
 537
 538             // If we're not past the end of the cache window,
 539             // then the cache has all available faves, so this one
 540             // is not a fave.
 541
 542             if (count($ids) < NOTICE_CACHE_WINDOW) {
 543                 return false;
 544             }
 545
 546             // Otherwise, cache doesn't have all faves;
 547             // fall through to the default
 548         }
 549
 550         $fave = Fave::pkeyGet(array('user_id' => $this->id,
 551                                     'notice_id' => $notice->id));
 552         return ((is_null($fave)) ? false : true);
 553     }
 554
 555     function faveCount()
 556     {
 557         $c = common_memcache();
 558         if (!empty($c)) {
 559             $cnt = $c->get(common_cache_key('profile:fave_count:'.$this->id));
 560             if (is_integer($cnt)) {
 561                 return (int) $cnt;
 562             }
 563         }
 564
 565         $faves = new Fave();
 566         $faves->user_id = $this->id;
 567         $cnt = (int) $faves->count('distinct notice_id');
 568
 569         if (!empty($c)) {
 570             $c->set(common_cache_key('profile:fave_count:'.$this->id), $cnt);
 571         }
 572
 573         return $cnt;
 574     }
 575
 576     function noticeCount()
 577     {
 578         $c = common_memcache();
 579
 580         if (!empty($c)) {
 581             $cnt = $c->get(common_cache_key('profile:notice_count:'.$this->id));
 582             if (is_integer($cnt)) {
 583                 return (int) $cnt;
 584             }
 585         }
 586
 587         $notices = new Notice();
 588         $notices->profile_id = $this->id;
 589         $cnt = (int) $notices->count('distinct id');
 590
 591         if (!empty($c)) {
 592             $c->set(common_cache_key('profile:notice_count:'.$this->id), $cnt);
 593         }
 594
 595         return $cnt;
 596     }
 597
 598     function blowFavesCache()
 599     {
 600         $cache = common_memcache();
 601         if ($cache) {
 602             // Faves don't happen chronologically, so we need to blow
 603             // ;last cache, too
 604             $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
 605             $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
 606             $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
 607             $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
 608         }
 609         $this->blowFaveCount();
 610     }
 611
 612     function blowSubscriberCount()
 613     {
 614         $c = common_memcache();
 615         if (!empty($c)) {
 616             $c->delete(common_cache_key('profile:subscriber_count:'.$this->id));
 617         }
 618     }
 619
 620     function blowSubscriptionCount()
 621     {
 622         $c = common_memcache();
 623         if (!empty($c)) {
 624             $c->delete(common_cache_key('profile:subscription_count:'.$this->id));
 625         }
 626     }
 627
 628     function blowFaveCount()
 629     {
 630         $c = common_memcache();
 631         if (!empty($c)) {
 632             $c->delete(common_cache_key('profile:fave_count:'.$this->id));
 633         }
 634     }
 635
 636     function blowNoticeCount()
 637     {
 638         $c = common_memcache();
 639         if (!empty($c)) {
 640             $c->delete(common_cache_key('profile:notice_count:'.$this->id));
 641         }
 642     }
 643
 644     static function maxBio()
 645     {
 646         $biolimit = common_config('profile', 'biolimit');
 647         // null => use global limit (distinct from 0!)
 648         if (is_null($biolimit)) {
 649             $biolimit = common_config('site', 'textlimit');
 650         }
 651         return $biolimit;
 652     }
 653
 654     static function bioTooLong($bio)
 655     {
 656         $biolimit = self::maxBio();
 657         return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
 658     }
 659
 660     function delete()
 661     {
 662         $this->_deleteNotices();
 663         $this->_deleteSubscriptions();
 664         $this->_deleteMessages();
 665         $this->_deleteTags();
 666         $this->_deleteBlocks();
 667
 668         $related = array('Avatar',
 669                          'Reply',
 670                          'Group_member',
 671                          );
 672         Event::handle('ProfileDeleteRelated', array($this, &$related));
 673
 674         foreach ($related as $cls) {
 675             $inst = new $cls();
 676             $inst->profile_id = $this->id;
 677             $inst->delete();
 678         }
 679
 680         parent::delete();
 681     }
 682
 683     function _deleteNotices()
 684     {
 685         $notice = new Notice();
 686         $notice->profile_id = $this->id;
 687
 688         if ($notice->find()) {
 689             while ($notice->fetch()) {
 690                 $other = clone($notice);
 691                 $other->delete();
 692             }
 693         }
 694     }
 695
 696     function _deleteSubscriptions()
 697     {
 698         $sub = new Subscription();
 699         $sub->subscriber = $this->id;
 700
 701         $sub->find();
 702
 703         while ($sub->fetch()) {
 704             $other = Profile::staticGet('id', $sub->subscribed);
 705             if (empty($other)) {
 706                 continue;
 707             }
 708             if ($other->id == $this->id) {
 709                 continue;
 710             }
 711             Subscription::cancel($this, $other);
 712         }
 713
 714         $subd = new Subscription();
 715         $subd->subscribed = $this->id;
 716         $subd->find();
 717
 718         while ($subd->fetch()) {
 719             $other = Profile::staticGet('id', $subd->subscriber);
 720             if (empty($other)) {
 721                 continue;
 722             }
 723             if ($other->id == $this->id) {
 724                 continue;
 725             }
 726             Subscription::cancel($other, $this);
 727         }
 728
 729         $self = new Subscription();
 730
 731         $self->subscriber = $this->id;
 732         $self->subscribed = $this->id;
 733
 734         $self->delete();
 735     }
 736
 737     function _deleteMessages()
 738     {
 739         $msg = new Message();
 740         $msg->from_profile = $this->id;
 741         $msg->delete();
 742
 743         $msg = new Message();
 744         $msg->to_profile = $this->id;
 745         $msg->delete();
 746     }
 747
 748     function _deleteTags()
 749     {
 750         $tag = new Profile_tag();
 751         $tag->tagged = $this->id;
 752         $tag->delete();
 753     }
 754
 755     function _deleteBlocks()
 756     {
 757         $block = new Profile_block();
 758         $block->blocked = $this->id;
 759         $block->delete();
 760
 761         $block = new Group_block();
 762         $block->blocked = $this->id;
 763         $block->delete();
 764     }
 765
 766     // XXX: identical to Notice::getLocation.
 767
 768     function getLocation()
 769     {
 770         $location = null;
 771
 772         if (!empty($this->location_id) && !empty($this->location_ns)) {
 773             $location = Location::fromId($this->location_id, $this->location_ns);
 774         }
 775
 776         if (is_null($location)) { // no ID, or Location::fromId() failed
 777             if (!empty($this->lat) && !empty($this->lon)) {
 778                 $location = Location::fromLatLon($this->lat, $this->lon);
 779             }
 780         }
 781
 782         if (is_null($location)) { // still haven't found it!
 783             if (!empty($this->location)) {
 784                 $location = Location::fromName($this->location);
 785             }
 786         }
 787
 788         return $location;
 789     }
 790
 791     function hasRole($name)
 792     {
 793         $has_role = false;
 794         if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
 795             $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
 796                                                 'role' => $name));
 797             $has_role = !empty($role);
 798             Event::handle('EndHasRole', array($this, $name, $has_role));
 799         }
 800         return $has_role;
 801     }
 802
 803     function grantRole($name)
 804     {
 805         if (Event::handle('StartGrantRole', array($this, $name))) {
 806
 807             $role = new Profile_role();
 808
 809             $role->profile_id = $this->id;
 810             $role->role       = $name;
 811             $role->created    = common_sql_now();
 812
 813             $result = $role->insert();
 814
 815             if (!$result) {
 816                 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
 817             }
 818
 819             Event::handle('EndGrantRole', array($this, $name));
 820         }
 821
 822         return $result;
 823     }
 824
 825     function revokeRole($name)
 826     {
 827         if (Event::handle('StartRevokeRole', array($this, $name))) {
 828
 829             $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
 830                                                 'role' => $name));
 831
 832             if (empty($role)) {
 833                 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
 834                 // TRANS: %1$s is the role name, %2$s is the user ID (number).
 835                 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
 836             }
 837
 838             $result = $role->delete();
 839
 840             if (!$result) {
 841                 common_log_db_error($role, 'DELETE', __FILE__);
 842                 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
 843                 // TRANS: %1$s is the role name, %2$s is the user ID (number).
 844                 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
 845             }
 846
 847             Event::handle('EndRevokeRole', array($this, $name));
 848
 849             return true;
 850         }
 851     }
 852
 853     function isSandboxed()
 854     {
 855         return $this->hasRole(Profile_role::SANDBOXED);
 856     }
 857
 858     function isSilenced()
 859     {
 860         return $this->hasRole(Profile_role::SILENCED);
 861     }
 862
 863     function sandbox()
 864     {
 865         $this->grantRole(Profile_role::SANDBOXED);
 866     }
 867
 868     function unsandbox()
 869     {
 870         $this->revokeRole(Profile_role::SANDBOXED);
 871     }
 872
 873     function silence()
 874     {
 875         $this->grantRole(Profile_role::SILENCED);
 876     }
 877
 878     function unsilence()
 879     {
 880         $this->revokeRole(Profile_role::SILENCED);
 881     }
 882
 883     /**
 884      * Does this user have the right to do X?
 885      *
 886      * With our role-based authorization, this is merely a lookup for whether the user
 887      * has a particular role. The implementation currently uses a switch statement
 888      * to determine if the user has the pre-defined role to exercise the right. Future
 889      * implementations may allow per-site roles, and different mappings of roles to rights.
 890      *
 891      * @param $right string Name of the right, usually a constant in class Right
 892      * @return boolean whether the user has the right in question
 893      */
 894     function hasRight($right)
 895     {
 896         $result = false;
 897
 898         if ($this->hasRole(Profile_role::DELETED)) {
 899             return false;
 900         }
 901
 902         if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
 903             switch ($right)
 904             {
 905             case Right::DELETEOTHERSNOTICE:
 906             case Right::MAKEGROUPADMIN:
 907             case Right::SANDBOXUSER:
 908             case Right::SILENCEUSER:
 909             case Right::DELETEUSER:
 910             case Right::DELETEGROUP:
 911                 $result = $this->hasRole(Profile_role::MODERATOR);
 912                 break;
 913             case Right::CONFIGURESITE:
 914                 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
 915                 break;
 916             case Right::GRANTROLE:
 917             case Right::REVOKEROLE:
 918                 $result = $this->hasRole(Profile_role::OWNER);
 919                 break;
 920             case Right::NEWNOTICE:
 921             case Right::NEWMESSAGE:
 922             case Right::SUBSCRIBE:
 923                 $result = !$this->isSilenced();
 924                 break;
 925             case Right::PUBLICNOTICE:
 926             case Right::EMAILONREPLY:
 927             case Right::EMAILONSUBSCRIBE:
 928             case Right::EMAILONFAVE:
 929                 $result = !$this->isSandboxed();
 930                 break;
 931             default:
 932                 $result = false;
 933                 break;
 934             }
 935         }
 936         return $result;
 937     }
 938
 939     function hasRepeated($notice_id)
 940     {
 941         // XXX: not really a pkey, but should work
 942
 943         $notice = Memcached_DataObject::pkeyGet('Notice',
 944                                                 array('profile_id' => $this->id,
 945                                                       'repeat_of' => $notice_id));
 946
 947         return !empty($notice);
 948     }
 949
 950     /**
 951      * Returns an XML string fragment with limited profile information
 952      * as an Atom <author> element.
 953      *
 954      * Assumes that Atom has been previously set up as the base namespace.
 955      *
 956      * @param Profile $cur the current authenticated user
 957      *
 958      * @return string
 959      */
 960     function asAtomAuthor($cur = null)
 961     {
 962         $xs = new XMLStringer(true);
 963
 964         $xs->elementStart('author');
 965         $xs->element('name', null, $this->nickname);
 966         $xs->element('uri', null, $this->getUri());
 967         if ($cur != null) {
 968             $attrs = Array();
 969             $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
 970             $attrs['blocking']  = $cur->hasBlocked($this) ? 'true' : 'false';
 971             $xs->element('statusnet:profile_info', $attrs, null);
 972         }
 973         $xs->elementEnd('author');
 974
 975         return $xs->getString();
 976     }
 977
 978     /**
 979      * Returns an XML string fragment with profile information as an
 980      * Activity Streams <activity:actor> element.
 981      *
 982      * Assumes that 'activity' namespace has been previously defined.
 983      *
 984      * @return string
 985      */
 986     function asActivityActor()
 987     {
 988         return $this->asActivityNoun('actor');
 989     }
 990
 991     /**
 992      * Returns an XML string fragment with profile information as an
 993      * Activity Streams noun object with the given element type.
 994      *
 995      * Assumes that 'activity', 'georss', and 'poco' namespace has been
 996      * previously defined.
 997      *
 998      * @param string $element one of 'actor', 'subject', 'object', 'target'
 999      *
1000      * @return string
1001      */
1002     function asActivityNoun($element)
1003     {
1004         $noun = ActivityObject::fromProfile($this);
1005         return $noun->asString('activity:' . $element);
1006     }
1007
1008     /**
1009      * Returns the best URI for a profile. Plugins may override.
1010      *
1011      * @return string $uri
1012      */
1013     function getUri()
1014     {
1015         $uri = null;
1016
1017         // give plugins a chance to set the URI
1018         if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1019
1020             // check for a local user first
1021             $user = User::staticGet('id', $this->id);
1022
1023             if (!empty($user)) {
1024                 $uri = $user->uri;
1025             } else {
1026                 // return OMB profile if any
1027                 $remote = Remote_profile::staticGet('id', $this->id);
1028                 if (!empty($remote)) {
1029                     $uri = $remote->uri;
1030                 }
1031             }
1032             Event::handle('EndGetProfileUri', array($this, &$uri));
1033         }
1034
1035         return $uri;
1036     }
1037
1038     function hasBlocked($other)
1039     {
1040         $block = Profile_block::get($this->id, $other->id);
1041
1042         if (empty($block)) {
1043             $result = false;
1044         } else {
1045             $result = true;
1046         }
1047
1048         return $result;
1049     }
1050
1051     function getAtomFeed()
1052     {
1053         $feed = null;
1054
1055         if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1056             $user = User::staticGet('id', $this->id);
1057             if (!empty($user)) {
1058                 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1059                                                                   'format' => 'atom'));
1060             }
1061             Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1062         }
1063
1064         return $feed;
1065     }
1066
1067     static function fromURI($uri)
1068     {
1069         $profile = null;
1070
1071         if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1072             // Get a local user or remote (OMB 0.1) profile
1073             $user = User::staticGet('uri', $uri);
1074             if (!empty($user)) {
1075                 $profile = $user->getProfile();
1076             } else {
1077                 $remote_profile = Remote_profile::staticGet('uri', $uri);
1078                 if (!empty($remote_profile)) {
1079                     $profile = Profile::staticGet('id', $remote_profile->profile_id);
1080                 }
1081             }
1082             Event::handle('EndGetProfileFromURI', array($uri, $profile));
1083         }
1084
1085         return $profile;
1086     }
1087 }