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