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