classes/User.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('GNUSOCIAL')) { exit(1); }
  21
  22 /**
  23  * Table Definition for user
  24  */
  25
  26 class User extends Managed_DataObject
  27 {
  28     const SUBSCRIBE_POLICY_OPEN = 0;
  29     const SUBSCRIBE_POLICY_MODERATE = 1;
  30
  31     ###START_AUTOCODE
  32     /* the code below is auto generated do not remove the above tag */
  33
  34     public $__table = 'user';                            // table name
  35     public $id;                              // int(4)  primary_key not_null
  36     public $nickname;                        // varchar(64)  unique_key
  37     public $password;                        // varchar(255)
  38     public $email;                           // varchar(255)  unique_key
  39     public $incomingemail;                   // varchar(255)  unique_key
  40     public $emailnotifysub;                  // tinyint(1)   default_1
  41     public $emailnotifyfav;                  // tinyint(1)   default_1
  42     public $emailnotifynudge;                // tinyint(1)   default_1
  43     public $emailnotifymsg;                  // tinyint(1)   default_1
  44     public $emailnotifyattn;                 // tinyint(1)   default_1
  45     public $emailmicroid;                    // tinyint(1)   default_1
  46     public $language;                        // varchar(50)
  47     public $timezone;                        // varchar(50)
  48     public $emailpost;                       // tinyint(1)   default_1
  49     public $sms;                             // varchar(64)  unique_key
  50     public $carrier;                         // int(4)
  51     public $smsnotify;                       // tinyint(1)
  52     public $smsreplies;                      // tinyint(1)
  53     public $smsemail;                        // varchar(255)
  54     public $uri;                             // varchar(255)  unique_key
  55     public $autosubscribe;                   // tinyint(1)
  56     public $subscribe_policy;                // tinyint(1)
  57     public $urlshorteningservice;            // varchar(50)   default_ur1.ca
  58     public $private_stream;                  // tinyint(1)   default_0
  59     public $created;                         // datetime()   not_null
  60     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  61
  62     /* the code above is auto generated do not remove the tag below */
  63     ###END_AUTOCODE
  64
  65     public static function schemaDef()
  66     {
  67         return array(
  68             'description' => 'local users',
  69             'fields' => array(
  70                 'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'),
  71                 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname or username, duped in profile'),
  72                 'password' => array('type' => 'varchar', 'length' => 255, 'description' => 'salted password, can be null for OpenID users'),
  73                 'email' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for password recovery etc.'),
  74                 'incomingemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for post-by-email'),
  75                 'emailnotifysub' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of subscriptions'),
  76                 'emailnotifyfav' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of favorites'),
  77                 'emailnotifynudge' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of nudges'),
  78                 'emailnotifymsg' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of direct messages'),
  79                 'emailnotifyattn' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of @-replies'),
  80                 'emailmicroid' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'whether to publish email microid'),
  81                 'language' => array('type' => 'varchar', 'length' => 50, 'description' => 'preferred language'),
  82                 'timezone' => array('type' => 'varchar', 'length' => 50, 'description' => 'timezone'),
  83                 'emailpost' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Post by email'),
  84                 'sms' => array('type' => 'varchar', 'length' => 64, 'description' => 'sms phone number'),
  85                 'carrier' => array('type' => 'int', 'description' => 'foreign key to sms_carrier'),
  86                 'smsnotify' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS'),
  87                 'smsreplies' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS on replies'),
  88                 'smsemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'built from sms and carrier'),
  89                 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
  90                 'autosubscribe' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'automatically subscribe to users who subscribe to us'),
  91                 'subscribe_policy' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => '0 = anybody can subscribe; 1 = require approval'),
  92                 'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'),
  93                 'private_stream' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to limit all notices to followers only'),
  94
  95                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  96                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  97             ),
  98             'primary key' => array('id'),
  99             'unique keys' => array(
 100                 'user_nickname_key' => array('nickname'),
 101                 'user_email_key' => array('email'),
 102                 'user_incomingemail_key' => array('incomingemail'),
 103                 'user_sms_key' => array('sms'),
 104                 'user_uri_key' => array('uri'),
 105             ),
 106             'foreign keys' => array(
 107                 'user_id_fkey' => array('profile', array('id' => 'id')),
 108                 'user_carrier_fkey' => array('sms_carrier', array('carrier' => 'id')),
 109             ),
 110             'indexes' => array(
 111                 'user_smsemail_idx' => array('smsemail'),
 112             ),
 113         );
 114     }
 115
 116     protected $_profile = null;
 117
 118     /**
 119      * @return Profile
 120      *
 121      * @throws UserNoProfileException if user has no profile
 122      */
 123     public function getProfile()
 124     {
 125         if (!($this->_profile instanceof Profile)) {
 126             $this->_profile = Profile::getKV('id', $this->id);
 127             if (!($this->_profile instanceof Profile)) {
 128                 throw new UserNoProfileException($this);
 129             }
 130         }
 131
 132         return $this->_profile;
 133     }
 134
 135     public function getUri()
 136     {
 137         return $this->uri;
 138     }
 139
 140     function isSubscribed(Profile $other)
 141     {
 142         return $this->getProfile()->isSubscribed($other);
 143     }
 144
 145     function hasPendingSubscription($other)
 146     {
 147         return $this->getProfile()->hasPendingSubscription($other);
 148     }
 149
 150     // 'update' won't write key columns, so we have to do it ourselves.
 151
 152     function updateKeys(&$orig)
 153     {
 154         $this->_connect();
 155         $parts = array();
 156         foreach (array('nickname', 'email', 'incomingemail', 'sms', 'carrier', 'smsemail') as $k) {
 157             if (strcmp($this->$k, $orig->$k) != 0) {
 158                 $parts[] = $k . ' = ' . $this->_quote($this->$k);
 159             }
 160         }
 161         if (count($parts) == 0) {
 162             // No changes
 163             return true;
 164         }
 165         $toupdate = implode(', ', $parts);
 166
 167         $table = common_database_tablename($this->tableName());
 168         $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
 169           ' WHERE id = ' . $this->id;
 170         $orig->decache();
 171         $result = $this->query($qry);
 172         if ($result) {
 173             $this->encache();
 174         }
 175         return $result;
 176     }
 177
 178     /**
 179      * Get the most recent notice posted by this user, if any.
 180      *
 181      * @return mixed Notice or null
 182      */
 183     function getCurrentNotice()
 184     {
 185         return $this->getProfile()->getCurrentNotice();
 186     }
 187
 188     function getCarrier()
 189     {
 190         return Sms_carrier::getKV('id', $this->carrier);
 191     }
 192
 193     function hasBlocked($other)
 194     {
 195         return $this->getProfile()->hasBlocked($other);
 196     }
 197
 198     /**
 199      * Register a new user account and profile and set up default subscriptions.
 200      * If a new-user welcome message is configured, this will be sent.
 201      *
 202      * @param array $fields associative array of optional properties
 203      *              string 'bio'
 204      *              string 'email'
 205      *              bool 'email_confirmed' pass true to mark email as pre-confirmed
 206      *              string 'fullname'
 207      *              string 'homepage'
 208      *              string 'location' informal string description of geolocation
 209      *              float 'lat' decimal latitude for geolocation
 210      *              float 'lon' decimal longitude for geolocation
 211      *              int 'location_id' geoname identifier
 212      *              int 'location_ns' geoname namespace to interpret location_id
 213      *              string 'nickname' REQUIRED
 214      *              string 'password' (may be missing for eg OpenID registrations)
 215      *              string 'code' invite code
 216      *              ?string 'uri' permalink to notice; defaults to local notice URL
 217      * @return mixed User object or false on failure
 218      */
 219     static function register(array $fields) {
 220
 221         // MAGICALLY put fields into current scope
 222
 223         extract($fields);
 224
 225         $profile = new Profile();
 226
 227         if (!empty($email)) {
 228             $email = common_canonical_email($email);
 229         }
 230
 231         try {
 232             $profile->nickname = Nickname::normalize($nickname, true);
 233         } catch (NicknameException $e) {
 234             common_log(LOG_WARNING, sprintf('Bad nickname during User registration for %s: %s', $nickname, $e->getMessage()), __FILE__);
 235             return false;
 236         }
 237
 238         $profile->profileurl = common_profile_url($profile->nickname);
 239
 240         if (!empty($fullname)) {
 241             $profile->fullname = $fullname;
 242         }
 243         if (!empty($homepage)) {
 244             $profile->homepage = $homepage;
 245         }
 246         if (!empty($bio)) {
 247             $profile->bio = $bio;
 248         }
 249         if (!empty($location)) {
 250             $profile->location = $location;
 251
 252             $loc = Location::fromName($location);
 253
 254             if (!empty($loc)) {
 255                 $profile->lat         = $loc->lat;
 256                 $profile->lon         = $loc->lon;
 257                 $profile->location_id = $loc->location_id;
 258                 $profile->location_ns = $loc->location_ns;
 259             }
 260         }
 261
 262         $profile->created = common_sql_now();
 263
 264         $user = new User();
 265
 266         $user->nickname = $profile->nickname;
 267
 268         $invite = null;
 269
 270         // Users who respond to invite email have proven their ownership of that address
 271
 272         if (!empty($code)) {
 273             $invite = Invitation::getKV($code);
 274             if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
 275                 $user->email = $invite->address;
 276             }
 277         }
 278
 279         if(isset($email_confirmed) && $email_confirmed) {
 280             $user->email = $email;
 281         }
 282
 283         // Set default-on options here, otherwise they'll be disabled
 284         // initially for sites using caching, since the initial encache
 285         // doesn't know about the defaults in the database.
 286         $user->emailnotifysub = 1;
 287         $user->emailnotifyfav = 1;
 288         $user->emailnotifynudge = 1;
 289         $user->emailnotifymsg = 1;
 290         $user->emailnotifyattn = 1;
 291         $user->emailmicroid = 1;
 292         $user->emailpost = 1;
 293         $user->jabbermicroid = 1;
 294
 295         $user->created = common_sql_now();
 296
 297         if (Event::handle('StartUserRegister', array($profile))) {
 298
 299             $profile->query('BEGIN');
 300
 301             $id = $profile->insert();
 302             if ($id === false) {
 303                 common_log_db_error($profile, 'INSERT', __FILE__);
 304                 return false;
 305             }
 306
 307             $user->id = $id;
 308
 309             if (!empty($uri)) {
 310                 $user->uri = $uri;
 311             } else {
 312                 $user->uri = common_user_uri($user);
 313             }
 314
 315             if (!empty($password)) { // may not have a password for OpenID users
 316                 $user->password = common_munge_password($password, $id);
 317             }
 318
 319             $result = $user->insert();
 320
 321             if ($result === false) {
 322                 common_log_db_error($user, 'INSERT', __FILE__);
 323                 $profile->query('ROLLBACK');
 324                 return false;
 325             }
 326
 327             // Everyone is subscribed to themself
 328
 329             $subscription = new Subscription();
 330             $subscription->subscriber = $user->id;
 331             $subscription->subscribed = $user->id;
 332             $subscription->created = $user->created;
 333
 334             $result = $subscription->insert();
 335
 336             if (!$result) {
 337                 common_log_db_error($subscription, 'INSERT', __FILE__);
 338                 $profile->query('ROLLBACK');
 339                 return false;
 340             }
 341
 342             // Mark that this invite was converted
 343
 344             if (!empty($invite)) {
 345                 $invite->convert($user);
 346             }
 347
 348             if (!empty($email) && !$user->email) {
 349
 350                 $confirm = new Confirm_address();
 351                 $confirm->code = common_confirmation_code(128);
 352                 $confirm->user_id = $user->id;
 353                 $confirm->address = $email;
 354                 $confirm->address_type = 'email';
 355
 356                 $result = $confirm->insert();
 357
 358                 if (!$result) {
 359                     common_log_db_error($confirm, 'INSERT', __FILE__);
 360                     $profile->query('ROLLBACK');
 361                     return false;
 362                 }
 363             }
 364
 365             if (!empty($code) && $user->email) {
 366                 $user->emailChanged();
 367             }
 368
 369             // Default system subscription
 370
 371             $defnick = common_config('newuser', 'default');
 372
 373             if (!empty($defnick)) {
 374                 $defuser = User::getKV('nickname', $defnick);
 375                 if (empty($defuser)) {
 376                     common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
 377                                __FILE__);
 378                 } else {
 379                     Subscription::start($profile, $defuser->getProfile());
 380                 }
 381             }
 382
 383             $profile->query('COMMIT');
 384
 385             if (!empty($email) && !$user->email) {
 386                 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
 387             }
 388
 389             // Welcome message
 390
 391             $welcome = common_config('newuser', 'welcome');
 392
 393             if (!empty($welcome)) {
 394                 $welcomeuser = User::getKV('nickname', $welcome);
 395                 if (empty($welcomeuser)) {
 396                     common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
 397                                __FILE__);
 398                 } else {
 399                     $notice = Notice::saveNew($welcomeuser->id,
 400                                               // TRANS: Notice given on user registration.
 401                                               // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
 402                                               sprintf(_('Welcome to %1$s, @%2$s!'),
 403                                                       common_config('site', 'name'),
 404                                                       $user->nickname),
 405                                               'system');
 406                 }
 407             }
 408
 409             Event::handle('EndUserRegister', array($profile));
 410         }
 411
 412         return $user;
 413     }
 414
 415     // Things we do when the email changes
 416     function emailChanged()
 417     {
 418
 419         $invites = new Invitation();
 420         $invites->address = $this->email;
 421         $invites->address_type = 'email';
 422
 423         if ($invites->find()) {
 424             while ($invites->fetch()) {
 425                 try {
 426                     $other = Profile::getKV('id', $invites->user_id);
 427                     if (!($other instanceof Profile)) {    // remove when getKV throws exceptions
 428                         continue;
 429                     }
 430                     Subscription::start($other, $this->getProfile());
 431                 } catch (Exception $e) {
 432                     continue;
 433                 }
 434             }
 435         }
 436     }
 437
 438     function hasFave($notice)
 439     {
 440         return $this->getProfile()->hasFave($notice);
 441     }
 442
 443     function mutuallySubscribed($other)
 444     {
 445         return $this->getProfile()->mutuallySubscribed($other);
 446     }
 447
 448     function mutuallySubscribedUsers()
 449     {
 450         // 3-way join; probably should get cached
 451         $UT = common_config('db','type')=='pgsql'?'"user"':'user';
 452         $qry = "SELECT $UT.* " .
 453           "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
 454           "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
 455           'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
 456           "ORDER BY $UT.nickname";
 457         $user = new User();
 458         $user->query(sprintf($qry, $this->id, $this->id));
 459
 460         return $user;
 461     }
 462
 463     function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
 464     {
 465         return Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
 466     }
 467
 468     function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
 469         return $this->getProfile()->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
 470     }
 471
 472     function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
 473     {
 474         return $this->getProfile()->getNotices($offset, $limit, $since_id, $before_id);
 475     }
 476
 477     function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
 478     {
 479         return $this->getProfile()->favoriteNotices($own, $offset, $limit, $since_id, $max_id);
 480     }
 481
 482     function blowFavesCache()
 483     {
 484         $this->getProfile()->blowFavesCache();
 485     }
 486
 487     function getSelfTags()
 488     {
 489         return Profile_tag::getTagsArray($this->id, $this->id, $this->id);
 490     }
 491
 492     function setSelfTags($newtags, $privacy)
 493     {
 494         return Profile_tag::setTags($this->id, $this->id, $newtags, $privacy);
 495     }
 496
 497     function block(Profile $other)
 498     {
 499         // Add a new block record
 500
 501         // no blocking (and thus unsubbing from) yourself
 502
 503         if ($this->id == $other->id) {
 504             common_log(LOG_WARNING,
 505                 sprintf(
 506                     "Profile ID %d (%s) tried to block themself.",
 507                     $this->id,
 508                     $this->nickname
 509                 )
 510             );
 511             return false;
 512         }
 513
 514         $block = new Profile_block();
 515
 516         // Begin a transaction
 517
 518         $block->query('BEGIN');
 519
 520         $block->blocker = $this->id;
 521         $block->blocked = $other->id;
 522
 523         $result = $block->insert();
 524
 525         if (!$result) {
 526             common_log_db_error($block, 'INSERT', __FILE__);
 527             return false;
 528         }
 529
 530         $self = $this->getProfile();
 531         if (Subscription::exists($other, $self)) {
 532             Subscription::cancel($other, $self);
 533         }
 534         if (Subscription::exists($self, $other)) {
 535             Subscription::cancel($self, $other);
 536         }
 537
 538         $block->query('COMMIT');
 539
 540         return true;
 541     }
 542
 543     function unblock(Profile $other)
 544     {
 545         // Get the block record
 546
 547         $block = Profile_block::exists($this->getProfile(), $other);
 548
 549         if (!$block) {
 550             return false;
 551         }
 552
 553         $result = $block->delete();
 554
 555         if (!$result) {
 556             common_log_db_error($block, 'DELETE', __FILE__);
 557             return false;
 558         }
 559
 560         return true;
 561     }
 562
 563     function isMember(User_group $group)
 564     {
 565         return $this->getProfile()->isMember($group);
 566     }
 567
 568     function isAdmin(User_group $group)
 569     {
 570         return $this->getProfile()->isAdmin($group);
 571     }
 572
 573     function getGroups($offset=0, $limit=null)
 574     {
 575         return $this->getProfile()->getGroups($offset, $limit);
 576     }
 577
 578     /**
 579      * Request to join the given group.
 580      * May throw exceptions on failure.
 581      *
 582      * @param User_group $group
 583      * @return Group_member
 584      */
 585     function joinGroup(User_group $group)
 586     {
 587         return $this->getProfile()->joinGroup($group);
 588     }
 589
 590     /**
 591      * Leave a group that this user is a member of.
 592      *
 593      * @param User_group $group
 594      */
 595     function leaveGroup(User_group $group)
 596     {
 597         return $this->getProfile()->leaveGroup($group);
 598     }
 599
 600     function getSubscribed($offset=0, $limit=null)
 601     {
 602         return $this->getProfile()->getSubscribed($offset, $limit);
 603     }
 604
 605     function getSubscribers($offset=0, $limit=null)
 606     {
 607         return $this->getProfile()->getSubscribers($offset, $limit);
 608     }
 609
 610     function getTaggedSubscribers($tag, $offset=0, $limit=null)
 611     {
 612         return $this->getProfile()->getTaggedSubscribers($tag, $offset, $limit);
 613     }
 614
 615     function getTaggedSubscriptions($tag, $offset=0, $limit=null)
 616     {
 617         return $this->getProfile()->getTaggedSubscriptions($tag, $offset, $limit);
 618     }
 619
 620     function hasRight($right)
 621     {
 622         return $this->getProfile()->hasRight($right);
 623     }
 624
 625     function delete($useWhere=false)
 626     {
 627         if (empty($this->id)) {
 628             common_log(LOG_WARNING, "Ambiguous User->delete(); skipping related tables.");
 629             return parent::delete($useWhere);
 630         }
 631
 632         try {
 633             $profile = $this->getProfile();
 634             $profile->delete();
 635         } catch (UserNoProfileException $unp) {
 636             common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
 637         }
 638
 639         $related = array('Fave',
 640                          'Confirm_address',
 641                          'Remember_me',
 642                          'Foreign_link',
 643                          'Invitation',
 644                          );
 645
 646         Event::handle('UserDeleteRelated', array($this, &$related));
 647
 648         foreach ($related as $cls) {
 649             $inst = new $cls();
 650             $inst->user_id = $this->id;
 651             $inst->delete();
 652         }
 653
 654         $this->_deleteTags();
 655         $this->_deleteBlocks();
 656
 657         return parent::delete($useWhere);
 658     }
 659
 660     function _deleteTags()
 661     {
 662         $tag = new Profile_tag();
 663         $tag->tagger = $this->id;
 664         $tag->delete();
 665     }
 666
 667     function _deleteBlocks()
 668     {
 669         $block = new Profile_block();
 670         $block->blocker = $this->id;
 671         $block->delete();
 672         // XXX delete group block? Reset blocker?
 673     }
 674
 675     function hasRole($name)
 676     {
 677         return $this->getProfile()->hasRole($name);
 678     }
 679
 680     function grantRole($name)
 681     {
 682         return $this->getProfile()->grantRole($name);
 683     }
 684
 685     function revokeRole($name)
 686     {
 687         return $this->getProfile()->revokeRole($name);
 688     }
 689
 690     function isSandboxed()
 691     {
 692         return $this->getProfile()->isSandboxed();
 693     }
 694
 695     function isSilenced()
 696     {
 697         return $this->getProfile()->isSilenced();
 698     }
 699
 700     function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
 701     {
 702         $stream = new RepeatedByMeNoticeStream($this);
 703         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 704     }
 705
 706
 707     function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
 708     {
 709         $stream = new RepeatsOfMeNoticeStream($this);
 710
 711         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 712     }
 713
 714
 715     function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
 716     {
 717         // TRANS: Exception thrown when trying view "repeated to me".
 718         throw new Exception(_('Not implemented since inbox change.'));
 719     }
 720
 721     public static function siteOwner()
 722     {
 723         $owner = self::cacheGet('user:site_owner');
 724
 725         if ($owner === false) { // cache miss
 726
 727             $pr = new Profile_role();
 728             $pr->role = Profile_role::OWNER;
 729             $pr->orderBy('created');
 730             $pr->limit(1);
 731
 732             if (!$pr->find(true)) {
 733                 throw new NoResultException($pr);
 734             }
 735
 736             $owner = User::getKV('id', $pr->profile_id);
 737
 738             self::cacheSet('user:site_owner', $owner);
 739         }
 740
 741         if ($owner instanceof User) {
 742             return $owner;
 743         }
 744
 745         throw new ServerException(_('No site owner configured.'));
 746     }
 747
 748     /**
 749      * Pull the primary site account to use in single-user mode.
 750      * If a valid user nickname is listed in 'singleuser':'nickname'
 751      * in the config, this will be used; otherwise the site owner
 752      * account is taken by default.
 753      *
 754      * @return User
 755      * @throws ServerException if no valid single user account is present
 756      * @throws ServerException if called when not in single-user mode
 757      */
 758     public static function singleUser()
 759     {
 760         if (!common_config('singleuser', 'enabled')) {
 761             // TRANS: Server exception.
 762             throw new ServerException(_('Single-user mode code called when not enabled.'));
 763         }
 764
 765         if ($nickname = common_config('singleuser', 'nickname')) {
 766             $user = User::getKV('nickname', $nickname);
 767             if ($user instanceof User) {
 768                 return $user;
 769             }
 770         }
 771
 772         // If there was no nickname or no user by that nickname,
 773         // try the site owner. Throws exception if not configured.
 774         return User::siteOwner();
 775     }
 776
 777     /**
 778      * This is kind of a hack for using external setup code that's trying to
 779      * build single-user sites.
 780      *
 781      * Will still return a username if the config singleuser/nickname is set
 782      * even if the account doesn't exist, which normally indicates that the
 783      * site is horribly misconfigured.
 784      *
 785      * At the moment, we need to let it through so that router setup can
 786      * complete, otherwise we won't be able to create the account.
 787      *
 788      * This will be easier when we can more easily create the account and
 789      * *then* switch the site to 1user mode without jumping through hoops.
 790      *
 791      * @return string
 792      * @throws ServerException if no valid single user account is present
 793      * @throws ServerException if called when not in single-user mode
 794      */
 795     static function singleUserNickname()
 796     {
 797         try {
 798             $user = User::singleUser();
 799             return $user->nickname;
 800         } catch (Exception $e) {
 801             if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
 802                 common_log(LOG_WARNING, "Warning: code attempting to pull single-user nickname when the account does not exist. If this is not setup time, this is probably a bug.");
 803                 return common_config('singleuser', 'nickname');
 804             }
 805             throw $e;
 806         }
 807     }
 808
 809     /**
 810      * Find and shorten links in the given text using this user's URL shortening
 811      * settings.
 812      *
 813      * By default, links will be left untouched if the text is shorter than the
 814      * configured maximum notice length. Pass true for the $always parameter
 815      * to force all links to be shortened regardless.
 816      *
 817      * Side effects: may save file and file_redirection records for referenced URLs.
 818      *
 819      * @param string $text
 820      * @param boolean $always
 821      * @return string
 822      */
 823     public function shortenLinks($text, $always=false)
 824     {
 825         return common_shorten_links($text, $always, $this);
 826     }
 827
 828     /*
 829      * Get a list of OAuth client applications that have access to this
 830      * user's account.
 831      */
 832     function getConnectedApps($offset = 0, $limit = null)
 833     {
 834         $qry =
 835           'SELECT u.* ' .
 836           'FROM oauth_application_user u, oauth_application a ' .
 837           'WHERE u.profile_id = %d ' .
 838           'AND a.id = u.application_id ' .
 839           'AND u.access_type > 0 ' .
 840           'ORDER BY u.created DESC ';
 841
 842         if ($offset > 0) {
 843             if (common_config('db','type') == 'pgsql') {
 844                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 845             } else {
 846                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 847             }
 848         }
 849
 850         $apps = new Oauth_application_user();
 851
 852         $cnt = $apps->query(sprintf($qry, $this->id));
 853
 854         return $apps;
 855     }
 856
 857     /**
 858      * Magic function called at serialize() time.
 859      *
 860      * We use this to drop a couple process-specific references
 861      * from DB_DataObject which can cause trouble in future
 862      * processes.
 863      *
 864      * @return array of variable names to include in serialization.
 865      */
 866
 867     function __sleep()
 868     {
 869         $vars = parent::__sleep();
 870         $skip = array('_profile');
 871         return array_diff($vars, $skip);
 872     }
 873
 874     static function recoverPassword($nore)
 875     {
 876         $user = User::getKV('email', common_canonical_email($nore));
 877
 878         if (!$user) {
 879             try {
 880                 $user = User::getKV('nickname', common_canonical_nickname($nore));
 881             } catch (NicknameException $e) {
 882                 // invalid
 883             }
 884         }
 885
 886         // See if it's an unconfirmed email address
 887
 888         if (!$user) {
 889             // Warning: it may actually be legit to have multiple folks
 890             // who have claimed, but not yet confirmed, the same address.
 891             // We'll only send to the first one that comes up.
 892             $confirm_email = new Confirm_address();
 893             $confirm_email->address = common_canonical_email($nore);
 894             $confirm_email->address_type = 'email';
 895             $confirm_email->find();
 896             if ($confirm_email->fetch()) {
 897                 $user = User::getKV($confirm_email->user_id);
 898             } else {
 899                 $confirm_email = null;
 900             }
 901         } else {
 902             $confirm_email = null;
 903         }
 904
 905         if (!$user) {
 906             // TRANS: Information on password recovery form if no known username or e-mail address was specified.
 907             throw new ClientException(_('No user with that email address or username.'));
 908             return;
 909         }
 910
 911         // Try to get an unconfirmed email address if they used a user name
 912
 913         if (!$user->email && !$confirm_email) {
 914             $confirm_email = new Confirm_address();
 915             $confirm_email->user_id = $user->id;
 916             $confirm_email->address_type = 'email';
 917             $confirm_email->find();
 918             if (!$confirm_email->fetch()) {
 919                 $confirm_email = null;
 920             }
 921         }
 922
 923         if (!$user->email && !$confirm_email) {
 924             // TRANS: Client error displayed on password recovery form if a user does not have a registered e-mail address.
 925             throw new ClientException(_('No registered email address for that user.'));
 926             return;
 927         }
 928
 929         // Success! We have a valid user and a confirmed or unconfirmed email address
 930
 931         $confirm = new Confirm_address();
 932         $confirm->code = common_confirmation_code(128);
 933         $confirm->address_type = 'recover';
 934         $confirm->user_id = $user->id;
 935         $confirm->address = (!empty($user->email)) ? $user->email : $confirm_email->address;
 936
 937         if (!$confirm->insert()) {
 938             common_log_db_error($confirm, 'INSERT', __FILE__);
 939             // TRANS: Server error displayed if e-mail address confirmation fails in the database on the password recovery form.
 940             throw new ServerException(_('Error saving address confirmation.'));
 941             return;
 942         }
 943
 944          // @todo FIXME: needs i18n.
 945         $body = "Hey, $user->nickname.";
 946         $body .= "\n\n";
 947         $body .= 'Someone just asked for a new password ' .
 948                  'for this account on ' . common_config('site', 'name') . '.';
 949         $body .= "\n\n";
 950         $body .= 'If it was you, and you want to confirm, use the URL below:';
 951         $body .= "\n\n";
 952         $body .= "\t".common_local_url('recoverpassword',
 953                                    array('code' => $confirm->code));
 954         $body .= "\n\n";
 955         $body .= 'If not, just ignore this message.';
 956         $body .= "\n\n";
 957         $body .= 'Thanks for your time, ';
 958         $body .= "\n";
 959         $body .= common_config('site', 'name');
 960         $body .= "\n";
 961
 962         $headers = _mail_prepare_headers('recoverpassword', $user->nickname, $user->nickname);
 963         // TRANS: Subject for password recovery e-mail.
 964         mail_to_user($user, _('Password recovery requested'), $body, $headers, $confirm->address);
 965     }
 966
 967     function streamModeOnly()
 968     {
 969         if (common_config('oldschool', 'enabled')) {
 970             $osp = Old_school_prefs::getKV('user_id', $this->id);
 971             if (!empty($osp)) {
 972                 return $osp->stream_mode_only;
 973             }
 974         }
 975
 976         return false;
 977     }
 978
 979     function conversationTree()
 980     {
 981         if (common_config('oldschool', 'enabled')) {
 982             $osp = Old_school_prefs::getKV('user_id', $this->id);
 983             if (!empty($osp)) {
 984                 return $osp->conversation_tree;
 985             }
 986         }
 987
 988         return false;
 989     }
 990
 991     function streamNicknames()
 992     {
 993         if (common_config('oldschool', 'enabled')) {
 994             $osp = Old_school_prefs::getKV('user_id', $this->id);
 995             if (!empty($osp)) {
 996                 return $osp->stream_nicknames;
 997             }
 998         }
 999         return false;
1000     }
1001
1002     function registrationActivity()
1003     {
1004         $profile = $this->getProfile();
1005
1006         $service = new ActivityObject();
1007
1008         $service->type  = ActivityObject::SERVICE;
1009         $service->title = common_config('site', 'name');
1010         $service->link  = common_root_url();
1011         $service->id    = $service->link;
1012
1013         $act = new Activity();
1014
1015         $act->actor = ActivityObject::fromProfile($profile);
1016         $act->verb = ActivityVerb::JOIN;
1017
1018         $act->objects[] = $service;
1019
1020         $act->id = TagURI::mint('user:register:%d',
1021                                 $this->id);
1022
1023         $act->time = strtotime($this->created);
1024
1025         $act->title = _("Register");
1026
1027         $act->content = sprintf(_('%1$s joined %2$s.'),
1028                                 $profile->getBestName(),
1029                                 $service->title);
1030         return $act;
1031     }
1032 }