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