classes/Profile.php

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