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