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