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(Profile $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             // Necessary because id has been known to be reissued.
 294             if ($profile->hasRole(Profile_role::DELETED)) {
 295                 $profile->revokeRole(Profile_role::DELETED);
 296             }
 297
 298             $user->id = $id;
 299
 300             if (!empty($uri)) {
 301                 $user->uri = $uri;
 302             } else {
 303                 $user->uri = common_user_uri($user);
 304             }
 305
 306             if (!empty($password)) { // may not have a password for OpenID users
 307                 $user->password = common_munge_password($password);
 308             }
 309
 310             $result = $user->insert();
 311
 312             if ($result === false) {
 313                 common_log_db_error($user, 'INSERT', __FILE__);
 314                 $profile->query('ROLLBACK');
 315                 // TRANS: User data could not be inserted for some reason.
 316                 throw new ServerException(_m('Could not insert user data for new user.'));
 317             }
 318
 319             // Everyone is subscribed to themself
 320
 321             $subscription = new Subscription();
 322             $subscription->subscriber = $user->id;
 323             $subscription->subscribed = $user->id;
 324             $subscription->created = $user->created;
 325
 326             $result = $subscription->insert();
 327
 328             if (!$result) {
 329                 common_log_db_error($subscription, 'INSERT', __FILE__);
 330                 $profile->query('ROLLBACK');
 331                 // TRANS: Subscription data could not be inserted for some reason.
 332                 throw new ServerException(_m('Could not insert subscription data for new user.'));
 333             }
 334
 335             // Mark that this invite was converted
 336
 337             if (!empty($invite)) {
 338                 $invite->convert($user);
 339             }
 340
 341             if (!empty($email) && empty($user->email)) {
 342                 // The actual email will be sent further down, after the database COMMIT
 343
 344                 $confirm = new Confirm_address();
 345                 $confirm->code = common_confirmation_code(128);
 346                 $confirm->user_id = $user->id;
 347                 $confirm->address = $email;
 348                 $confirm->address_type = 'email';
 349
 350                 $result = $confirm->insert();
 351
 352                 if ($result===false) {
 353                     common_log_db_error($confirm, 'INSERT', __FILE__);
 354                     $profile->query('ROLLBACK');
 355                     // TRANS: Email confirmation data could not be inserted for some reason.
 356                     throw new ServerException(_m('Could not insert email confirmation data for new user.'));
 357                 }
 358             }
 359
 360             if (!empty($code) && $user->email) {
 361                 $user->emailChanged();
 362             }
 363
 364             // Default system subscription
 365
 366             $defnick = common_config('newuser', 'default');
 367
 368             if (!empty($defnick)) {
 369                 $defuser = User::getKV('nickname', $defnick);
 370                 if (empty($defuser)) {
 371                     common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
 372                                __FILE__);
 373                 } else {
 374                     Subscription::ensureStart($profile, $defuser->getProfile());
 375                 }
 376             }
 377
 378             $profile->query('COMMIT');
 379
 380             if (!empty($email) && empty($user->email)) {
 381                 try {
 382                     $confirm->sendConfirmation();
 383                 } catch (EmailException $e) {
 384                     common_log(LOG_ERR, "Could not send user registration email for user id=={$profile->getID()}: {$e->getMessage()}");
 385                     if (!$accept_email_fail) {
 386                         throw $e;
 387                     }
 388                 }
 389             }
 390
 391             // Welcome message
 392
 393             $welcome = common_config('newuser', 'welcome');
 394
 395             if (!empty($welcome)) {
 396                 $welcomeuser = User::getKV('nickname', $welcome);
 397                 if (empty($welcomeuser)) {
 398                     common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
 399                                __FILE__);
 400                 } else {
 401                     $notice = Notice::saveNew($welcomeuser->id,
 402                                               // TRANS: Notice given on user registration.
 403                                               // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
 404                                               sprintf(_('Welcome to %1$s, @%2$s!'),
 405                                                       common_config('site', 'name'),
 406                                                       $profile->getNickname()),
 407                                               'system');
 408                 }
 409             }
 410
 411             Event::handle('EndUserRegister', array($profile));
 412         }
 413
 414         if (!$user instanceof User || empty($user->id)) {
 415             throw new ServerException('User could not be registered. Probably an event hook that failed.');
 416         }
 417
 418         return $user;
 419     }
 420
 421     // Things we do when the email changes
 422     function emailChanged()
 423     {
 424
 425         $invites = new Invitation();
 426         $invites->address = $this->email;
 427         $invites->address_type = 'email';
 428
 429         if ($invites->find()) {
 430             while ($invites->fetch()) {
 431                 try {
 432                     $other = Profile::getByID($invites->user_id);
 433                     Subscription::start($other, $this->getProfile());
 434                 } catch (NoResultException $e) {
 435                     // profile did not exist
 436                 } catch (AlreadyFulfilledException $e) {
 437                     // already subscribed to this profile
 438                 } catch (Exception $e) {
 439                     common_log(LOG_ERR, 'On-invitation-completion subscription failed when subscribing '._ve($invites->user_id).' to '.$this->getProfile()->getID().': '._ve($e->getMessage()));
 440                 }
 441             }
 442         }
 443     }
 444
 445     function mutuallySubscribed(Profile $other)
 446     {
 447         return $this->getProfile()->mutuallySubscribed($other);
 448     }
 449
 450     function mutuallySubscribedUsers()
 451     {
 452         // 3-way join; probably should get cached
 453         $UT = common_config('db','type')=='pgsql'?'"user"':'user';
 454         $qry = "SELECT $UT.* " .
 455           "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
 456           "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
 457           'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
 458           "ORDER BY $UT.nickname";
 459         $user = new User();
 460         $user->query(sprintf($qry, $this->id, $this->id));
 461
 462         return $user;
 463     }
 464
 465     function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
 466     {
 467         return $this->getProfile()->getReplies($offset, $limit, $since_id, $before_id);
 468     }
 469
 470     function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
 471         return $this->getProfile()->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
 472     }
 473
 474     function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
 475     {
 476         return $this->getProfile()->getNotices($offset, $limit, $since_id, $before_id);
 477     }
 478
 479     function block(Profile $other)
 480     {
 481         // Add a new block record
 482
 483         // no blocking (and thus unsubbing from) yourself
 484
 485         if ($this->id == $other->id) {
 486             common_log(LOG_WARNING,
 487                 sprintf(
 488                     "Profile ID %d (%s) tried to block themself.",
 489                     $this->id,
 490                     $this->nickname
 491                 )
 492             );
 493             return false;
 494         }
 495
 496         $block = new Profile_block();
 497
 498         // Begin a transaction
 499
 500         $block->query('BEGIN');
 501
 502         $block->blocker = $this->id;
 503         $block->blocked = $other->id;
 504
 505         $result = $block->insert();
 506
 507         if (!$result) {
 508             common_log_db_error($block, 'INSERT', __FILE__);
 509             return false;
 510         }
 511
 512         $self = $this->getProfile();
 513         if (Subscription::exists($other, $self)) {
 514             Subscription::cancel($other, $self);
 515         }
 516         if (Subscription::exists($self, $other)) {
 517             Subscription::cancel($self, $other);
 518         }
 519
 520         $block->query('COMMIT');
 521
 522         return true;
 523     }
 524
 525     function unblock(Profile $other)
 526     {
 527         // Get the block record
 528
 529         $block = Profile_block::exists($this->getProfile(), $other);
 530
 531         if (!$block) {
 532             return false;
 533         }
 534
 535         $result = $block->delete();
 536
 537         if (!$result) {
 538             common_log_db_error($block, 'DELETE', __FILE__);
 539             return false;
 540         }
 541
 542         return true;
 543     }
 544
 545     function isMember(User_group $group)
 546     {
 547         return $this->getProfile()->isMember($group);
 548     }
 549
 550     function isAdmin(User_group $group)
 551     {
 552         return $this->getProfile()->isAdmin($group);
 553     }
 554
 555     function getGroups($offset=0, $limit=null)
 556     {
 557         return $this->getProfile()->getGroups($offset, $limit);
 558     }
 559
 560     /**
 561      * Request to join the given group.
 562      * May throw exceptions on failure.
 563      *
 564      * @param User_group $group
 565      * @return Group_member
 566      */
 567     function joinGroup(User_group $group)
 568     {
 569         return $this->getProfile()->joinGroup($group);
 570     }
 571
 572     /**
 573      * Leave a group that this user is a member of.
 574      *
 575      * @param User_group $group
 576      */
 577     function leaveGroup(User_group $group)
 578     {
 579         return $this->getProfile()->leaveGroup($group);
 580     }
 581
 582     function getSubscribed($offset=0, $limit=null)
 583     {
 584         return $this->getProfile()->getSubscribed($offset, $limit);
 585     }
 586
 587     function getSubscribers($offset=0, $limit=null)
 588     {
 589         return $this->getProfile()->getSubscribers($offset, $limit);
 590     }
 591
 592     function getTaggedSubscribers($tag, $offset=0, $limit=null)
 593     {
 594         return $this->getProfile()->getTaggedSubscribers($tag, $offset, $limit);
 595     }
 596
 597     function getTaggedSubscriptions($tag, $offset=0, $limit=null)
 598     {
 599         return $this->getProfile()->getTaggedSubscriptions($tag, $offset, $limit);
 600     }
 601
 602     function hasRight($right)
 603     {
 604         return $this->getProfile()->hasRight($right);
 605     }
 606
 607     function delete($useWhere=false)
 608     {
 609         if (empty($this->id)) {
 610             common_log(LOG_WARNING, "Ambiguous User->delete(); skipping related tables.");
 611             return parent::delete($useWhere);
 612         }
 613
 614         try {
 615             if (!$this->hasRole(Profile_role::DELETED)) {
 616                 $profile = $this->getProfile();
 617                 $profile->delete();
 618             }
 619         } catch (UserNoProfileException $unp) {
 620             common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
 621         }
 622
 623         $related = array(
 624                          'Confirm_address',
 625                          'Remember_me',
 626                          'Foreign_link',
 627                          'Invitation',
 628                          );
 629
 630         Event::handle('UserDeleteRelated', array($this, &$related));
 631
 632         foreach ($related as $cls) {
 633             $inst = new $cls();
 634             $inst->user_id = $this->id;
 635             $inst->delete();
 636         }
 637
 638         $this->_deleteTags();
 639         $this->_deleteBlocks();
 640
 641         return parent::delete($useWhere);
 642     }
 643
 644     function _deleteTags()
 645     {
 646         $tag = new Profile_tag();
 647         $tag->tagger = $this->id;
 648         $tag->delete();
 649     }
 650
 651     function _deleteBlocks()
 652     {
 653         $block = new Profile_block();
 654         $block->blocker = $this->id;
 655         $block->delete();
 656         // XXX delete group block? Reset blocker?
 657     }
 658
 659     function hasRole($name)
 660     {
 661         return $this->getProfile()->hasRole($name);
 662     }
 663
 664     function grantRole($name)
 665     {
 666         return $this->getProfile()->grantRole($name);
 667     }
 668
 669     function revokeRole($name)
 670     {
 671         return $this->getProfile()->revokeRole($name);
 672     }
 673
 674     function isSandboxed()
 675     {
 676         return $this->getProfile()->isSandboxed();
 677     }
 678
 679     function isSilenced()
 680     {
 681         return $this->getProfile()->isSilenced();
 682     }
 683
 684     function receivesEmailNotifications()
 685     {
 686         // We could do this in one large if statement, but that's not as easy to read
 687         // Don't send notifications if we don't know the user's email address or it is
 688         // explicitly undesired by the user's own settings.
 689         if (empty($this->email) || !$this->emailnotifyattn) {
 690             return false;
 691         }
 692         // Don't send notifications to a user who is sandboxed or silenced
 693         if ($this->isSandboxed() || $this->isSilenced()) {
 694             return false;
 695         }
 696         return true;
 697     }
 698
 699     function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
 700     {
 701         // FIXME: Use another way to get Profile::current() since we
 702         // want to avoid confusion between session user and queue processing.
 703         $stream = new RepeatedByMeNoticeStream($this->getProfile(), Profile::current());
 704         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 705     }
 706
 707
 708     function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
 709     {
 710         // FIXME: Use another way to get Profile::current() since we
 711         // want to avoid confusion between session user and queue processing.
 712         $stream = new RepeatsOfMeNoticeStream($this->getProfile(), Profile::current());
 713         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 714     }
 715
 716     public function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
 717     {
 718         return $this->getProfile()->repeatedToMe($offset, $limit, $since_id, $max_id);
 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         require_once(INSTALLDIR . '/lib/mail.php');
 877
 878         // $confirm_email will be used as a fallback if our user doesn't have a confirmed email
 879         $confirm_email = null;
 880
 881         if (common_is_email($nore)) {
 882             $user = User::getKV('email', common_canonical_email($nore));
 883
 884             // See if it's an unconfirmed email address
 885             if (!$user instanceof User) {
 886                 // Warning: it may actually be legit to have multiple folks
 887                 // who have claimed, but not yet confirmed, the same address.
 888                 // We'll only send to the first one that comes up.
 889                 $confirm_email = new Confirm_address();
 890                 $confirm_email->address = common_canonical_email($nore);
 891                 $confirm_email->address_type = 'email';
 892                 if ($confirm_email->find(true)) {
 893                     $user = User::getKV('id', $confirm_email->user_id);
 894                 }
 895             }
 896
 897             // No luck finding anyone by that email address.
 898             if (!$user instanceof User) {
 899                 if (common_config('site', 'fakeaddressrecovery')) {
 900                     // Return without actually doing anything! We fake address recovery
 901                     // to avoid revealing which email addresses are registered with the site.
 902                     return;
 903                 }
 904                 // TRANS: Information on password recovery form if no known e-mail address was specified.
 905                 throw new ClientException(_('No user with that email address exists here.'));
 906             }
 907         } else {
 908             // This might throw a NicknameException on bad nicknames
 909             $user = User::getKV('nickname', common_canonical_nickname($nore));
 910             if (!$user instanceof User) {
 911                 // TRANS: Information on password recovery form if no known username was specified.
 912                 throw new ClientException(_('No user with that nickname exists here.'));
 913             }
 914         }
 915
 916         // Try to get an unconfirmed email address if they used a user name
 917         if (empty($user->email) && $confirm_email === null) {
 918             $confirm_email = new Confirm_address();
 919             $confirm_email->user_id = $user->id;
 920             $confirm_email->address_type = 'email';
 921             $confirm_email->find();
 922             if (!$confirm_email->fetch()) {
 923                 // Nothing found, so let's reset it to null
 924                 $confirm_email = null;
 925             }
 926         }
 927
 928         if (empty($user->email) && !$confirm_email instanceof Confirm_address) {
 929             // TRANS: Client error displayed on password recovery form if a user does not have a registered e-mail address.
 930             throw new ClientException(_('No registered email address for that user.'));
 931         }
 932
 933         // Success! We have a valid user and a confirmed or unconfirmed email address
 934
 935         $confirm = new Confirm_address();
 936         $confirm->code = common_confirmation_code(128);
 937         $confirm->address_type = 'recover';
 938         $confirm->user_id = $user->id;
 939         $confirm->address = $user->email ?: $confirm_email->address;
 940
 941         if (!$confirm->insert()) {
 942             common_log_db_error($confirm, 'INSERT', __FILE__);
 943             // TRANS: Server error displayed if e-mail address confirmation fails in the database on the password recovery form.
 944             throw new ServerException(_('Error saving address confirmation.'));
 945         }
 946
 947          // @todo FIXME: needs i18n.
 948         $body = "Hey, $user->nickname.";
 949         $body .= "\n\n";
 950         $body .= 'Someone just asked for a new password ' .
 951                  'for this account on ' . common_config('site', 'name') . '.';
 952         $body .= "\n\n";
 953         $body .= 'If it was you, and you want to confirm, use the URL below:';
 954         $body .= "\n\n";
 955         $body .= "\t".common_local_url('recoverpassword',
 956                                    array('code' => $confirm->code));
 957         $body .= "\n\n";
 958         $body .= 'If not, just ignore this message.';
 959         $body .= "\n\n";
 960         $body .= 'Thanks for your time, ';
 961         $body .= "\n";
 962         $body .= common_config('site', 'name');
 963         $body .= "\n";
 964
 965         $headers = _mail_prepare_headers('recoverpassword', $user->nickname, $user->nickname);
 966         // TRANS: Subject for password recovery e-mail.
 967         mail_to_user($user, _('Password recovery requested'), $body, $headers, $confirm->address);
 968     }
 969
 970     function streamModeOnly()
 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_mode_only;
 976             }
 977         }
 978
 979         return false;
 980     }
 981
 982     function streamNicknames()
 983     {
 984         if (common_config('oldschool', 'enabled')) {
 985             $osp = Old_school_prefs::getKV('user_id', $this->id);
 986             if (!empty($osp)) {
 987                 return $osp->stream_nicknames;
 988             }
 989         }
 990         return false;
 991     }
 992
 993     function registrationActivity()
 994     {
 995         $profile = $this->getProfile();
 996
 997         $service = new ActivityObject();
 998
 999         $service->type  = ActivityObject::SERVICE;
1000         $service->title = common_config('site', 'name');
1001         $service->link  = common_root_url();
1002         $service->id    = $service->link;
1003
1004         $act = new Activity();
1005
1006         $act->actor = $profile->asActivityObject();
1007         $act->verb = ActivityVerb::JOIN;
1008
1009         $act->objects[] = $service;
1010
1011         $act->id = TagURI::mint('user:register:%d',
1012                                 $this->id);
1013
1014         $act->time = strtotime($this->created);
1015
1016         $act->title = _("Register");
1017
1018         $act->content = sprintf(_('%1$s joined %2$s.'),
1019                                 $profile->getBestName(),
1020                                 $service->title);
1021         return $act;
1022     }
1023
1024     public function isPrivateStream()
1025     {
1026         return $this->getProfile()->isPrivateStream();
1027     }
1028
1029     public function hasPassword()
1030     {
1031         return !empty($this->password);
1032     }
1033
1034     public function setPassword($password)
1035     {
1036         $orig = clone($this);
1037         $this->password = common_munge_password($password, $this->getProfile());
1038
1039         if ($this->validate() !== true) {
1040             // TRANS: Form validation error on page where to change password.
1041             throw new ServerException(_('Error saving user; invalid.'));
1042         }
1043
1044         if (!$this->update($orig)) {
1045             common_log_db_error($this, 'UPDATE', __FILE__);
1046             // TRANS: Server error displayed on page where to change password when password change
1047             // TRANS: could not be made because of a server error.
1048             throw new ServerException(_('Cannot save new password.'));
1049         }
1050     }
1051
1052     public function delPref($namespace, $topic)
1053     {
1054         return $this->getProfile()->delPref($namespace, $topic);
1055     }
1056
1057     public function getPref($namespace, $topic, $default=null)
1058     {
1059         return $this->getProfile()->getPref($namespace, $topic, $default);
1060     }
1061
1062     public function getConfigPref($namespace, $topic)
1063     {
1064         return $this->getProfile()->getConfigPref($namespace, $topic);
1065     }
1066
1067     public function setPref($namespace, $topic, $data)
1068     {
1069         return $this->getProfile()->setPref($namespace, $topic, $data);
1070     }
1071 }