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