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