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