We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

User.php 38.3 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1
<?php
Evan Prodromou's avatar
Evan Prodromou committed
2
/*
3
 * StatusNet - the distributed open-source microblogging tool
4
 * Copyright (C) 2008, 2009, StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
5
 *
Evan Prodromou's avatar
Evan Prodromou committed
6 7 8 9
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
Evan Prodromou's avatar
Evan Prodromou committed
10
 *
Evan Prodromou's avatar
Evan Prodromou committed
11 12 13 14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
Evan Prodromou's avatar
Evan Prodromou committed
15
 *
Evan Prodromou's avatar
Evan Prodromou committed
16 17 18 19
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

20
if (!defined('STATUSNET') && !defined('LACONICA')) {
Evan Prodromou's avatar
Evan Prodromou committed
21 22
    exit(1);
}
23

Evan Prodromou's avatar
Evan Prodromou committed
24 25 26
/**
 * Table Definition for user
 */
Evan Prodromou's avatar
Evan Prodromou committed
27

28
require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
29
require_once 'Validate.php';
Evan Prodromou's avatar
Evan Prodromou committed
30

31
class User extends Managed_DataObject
Evan Prodromou's avatar
Evan Prodromou committed
32
{
33 34 35
    const SUBSCRIBE_POLICY_OPEN = 0;
    const SUBSCRIBE_POLICY_MODERATE = 1;

Evan Prodromou's avatar
Evan Prodromou committed
36 37 38 39 40
    ###START_AUTOCODE
    /* the code below is auto generated do not remove the above tag */

    public $__table = 'user';                            // table name
    public $id;                              // int(4)  primary_key not_null
Evan Prodromou's avatar
Evan Prodromou committed
41
    public $nickname;                        // varchar(64)  unique_key
42
    public $password;                        // varchar(255)
Evan Prodromou's avatar
Evan Prodromou committed
43
    public $email;                           // varchar(255)  unique_key
Evan Prodromou's avatar
Evan Prodromou committed
44
    public $incomingemail;                   // varchar(255)  unique_key
45
    public $emailnotifysub;                  // tinyint(1)   default_1
46
    public $emailnotifyfav;                  // tinyint(1)   default_1
Evan Prodromou's avatar
Evan Prodromou committed
47
    public $emailnotifynudge;                // tinyint(1)   default_1
Evan Prodromou's avatar
Evan Prodromou committed
48
    public $emailnotifymsg;                  // tinyint(1)   default_1
49
    public $emailnotifyattn;                 // tinyint(1)   default_1
mikec's avatar
mikec committed
50
    public $emailmicroid;                    // tinyint(1)   default_1
51 52
    public $language;                        // varchar(50)
    public $timezone;                        // varchar(50)
mikec's avatar
mikec committed
53
    public $emailpost;                       // tinyint(1)   default_1
54
    public $sms;                             // varchar(64)  unique_key
55 56 57 58
    public $carrier;                         // int(4)
    public $smsnotify;                       // tinyint(1)
    public $smsreplies;                      // tinyint(1)
    public $smsemail;                        // varchar(255)
59
    public $uri;                             // varchar(255)  unique_key
60
    public $autosubscribe;                   // tinyint(1)
61
    public $subscribe_policy;                // tinyint(1)
Evan Prodromou's avatar
Evan Prodromou committed
62
    public $urlshorteningservice;            // varchar(50)   default_ur1.ca
63
    public $inboxed;                         // tinyint(1)
64
    public $private_stream;                  // tinyint(1)   default_0
Evan Prodromou's avatar
Evan Prodromou committed
65 66 67 68
    public $created;                         // datetime()   not_null
    public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP

    /* Static get */
69
    function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('User',$k,$v); }
Evan Prodromou's avatar
Evan Prodromou committed
70 71 72

    /* the code above is auto generated do not remove the tag below */
    ###END_AUTOCODE
Evan Prodromou's avatar
Evan Prodromou committed
73

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
    public static function schemaDef()
    {
        return array(
            'description' => 'local users',
            'fields' => array(
                'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'),
                'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname or username, duped in profile'),
                'password' => array('type' => 'varchar', 'length' => 255, 'description' => 'salted password, can be null for OpenID users'),
                'email' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for password recovery etc.'),
                'incomingemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for post-by-email'),
                'emailnotifysub' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of subscriptions'),
                'emailnotifyfav' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of favorites'),
                'emailnotifynudge' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of nudges'),
                'emailnotifymsg' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of direct messages'),
                'emailnotifyattn' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of @-replies'),
                'emailmicroid' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'whether to publish email microid'),
                'language' => array('type' => 'varchar', 'length' => 50, 'description' => 'preferred language'),
                'timezone' => array('type' => 'varchar', 'length' => 50, 'description' => 'timezone'),
                'emailpost' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Post by email'),
                'sms' => array('type' => 'varchar', 'length' => 64, 'description' => 'sms phone number'),
                'carrier' => array('type' => 'int', 'description' => 'foreign key to sms_carrier'),
                'smsnotify' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS'),
                'smsreplies' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS on replies'),
                'smsemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'built from sms and carrier'),
                'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
                'autosubscribe' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'automatically subscribe to users who subscribe to us'),
                'subscribe_policy' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => '0 = anybody can subscribe; 1 = require approval'),
                'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'),
                'inboxed' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'has an inbox been created for this user?'),
                'private_stream' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to limit all notices to followers only'),

                'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
                'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
            ),
            'primary key' => array('id'),
            'unique keys' => array(
                'user_nickname_key' => array('nickname'),
                'user_email_key' => array('email'),
                'user_incomingemail_key' => array('incomingemail'),
                'user_sms_key' => array('sms'),
                'user_uri_key' => array('uri'),
            ),
            'foreign keys' => array(
                'user_id_fkey' => array('profile', array('id' => 'id')),
                'user_carrier_fkey' => array('sms_carrier', array('carrier' => 'id')),
            ),
            'indexes' => array(
                'user_smsemail_idx' => array('smsemail'),
            ),
        );
    }

126 127
    protected $_profile = -1;

128 129 130
    /**
     * @return Profile
     */
131 132
    function getProfile()
    {
133
        if (is_int($this->_profile) && $this->_profile == -1) { // invalid but distinct from null
134 135 136 137
            $this->_profile = Profile::staticGet('id', $this->id);
            if (empty($this->_profile)) {
                throw new UserNoProfileException($this);
            }
138
        }
139 140

        return $this->_profile;
141 142
    }

143 144
    function isSubscribed($other)
    {
145 146
        $profile = $this->getProfile();
        return $profile->isSubscribed($other);
147 148
    }

149 150 151 152 153 154
    function hasPendingSubscription($other)
    {
        $profile = $this->getProfile();
        return $profile->hasPendingSubscription($other);
    }

155
    // 'update' won't write key columns, so we have to do it ourselves.
156

157 158
    function updateKeys(&$orig)
    {
159
        $this->_connect();
160
        $parts = array();
161
        foreach (array('nickname', 'email', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
162 163 164 165 166
            if (strcmp($this->$k, $orig->$k) != 0) {
                $parts[] = $k . ' = ' . $this->_quote($this->$k);
            }
        }
        if (count($parts) == 0) {
Evan Prodromou's avatar
Evan Prodromou committed
167
            // No changes
168 169 170 171
            return true;
        }
        $toupdate = implode(', ', $parts);

172
        $table = common_database_tablename($this->tableName());
173 174 175 176 177 178 179 180 181 182
        $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
          ' WHERE id = ' . $this->id;
        $orig->decache();
        $result = $this->query($qry);
        if ($result) {
            $this->encache();
        }
        return $result;
    }

183 184 185 186 187 188 189 190 191 192
    /**
     * Check whether the given nickname is potentially usable, or if it's
     * excluded by any blacklists on this system.
     *
     * WARNING: INPUT IS NOT VALIDATED OR NORMALIZED. NON-NORMALIZED INPUT
     * OR INVALID INPUT MAY LEAD TO FALSE RESULTS.
     *
     * @param string $nickname
     * @return boolean true if clear, false if blacklisted
     */
193
    static function allowed_nickname($nickname)
194
    {
Evan Prodromou's avatar
Evan Prodromou committed
195
        // XXX: should already be validated for size, content, etc.
196
        $blacklist = common_config('nickname', 'blacklist');
197 198 199 200 201 202 203

        //all directory and file names should be blacklisted
        $d = dir(INSTALLDIR);
        while (false !== ($entry = $d->read())) {
            $blacklist[]=$entry;
        }
        $d->close();
204 205 206 207 208 209 210 211 212

        //all top level names in the router should be blacklisted
        $router = Router::get();
        foreach(array_keys($router->m->getPaths()) as $path){
            if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
                $blacklist[]=$matches[1];
            }
        }
        return !in_array($nickname, $blacklist);
213 214
    }

215 216 217 218 219 220
    /**
     * Get the most recent notice posted by this user, if any.
     *
     * @return mixed Notice or null
     */
    function getCurrentNotice()
221
    {
222
        $profile = $this->getProfile();
223
        return $profile->getCurrentNotice();
224 225
    }

226 227
    function getCarrier()
    {
228 229 230
        return Sms_carrier::staticGet('id', $this->carrier);
    }

231 232 233
    /**
     * @deprecated use Subscription::start($sub, $other);
     */
234 235
    function subscribeTo($other)
    {
236
        return Subscription::start($this->getProfile(), $other);
237
    }
238

239 240
    function hasBlocked($other)
    {
241 242
        $profile = $this->getProfile();
        return $profile->hasBlocked($other);
243 244
    }

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
    /**
     * Register a new user account and profile and set up default subscriptions.
     * If a new-user welcome message is configured, this will be sent.
     *
     * @param array $fields associative array of optional properties
     *              string 'bio'
     *              string 'email'
     *              bool 'email_confirmed' pass true to mark email as pre-confirmed
     *              string 'fullname'
     *              string 'homepage'
     *              string 'location' informal string description of geolocation
     *              float 'lat' decimal latitude for geolocation
     *              float 'lon' decimal longitude for geolocation
     *              int 'location_id' geoname identifier
     *              int 'location_ns' geoname namespace to interpret location_id
     *              string 'nickname' REQUIRED
     *              string 'password' (may be missing for eg OpenID registrations)
     *              string 'code' invite code
     *              ?string 'uri' permalink to notice; defaults to local notice URL
     * @return mixed User object or false on failure
     */
266
    static function register($fields) {
267

Evan Prodromou's avatar
Evan Prodromou committed
268
        // MAGICALLY put fields into current scope
Evan Prodromou's avatar
Evan Prodromou committed
269

270
        extract($fields);
Evan Prodromou's avatar
Evan Prodromou committed
271

272
        $profile = new Profile();
273

274 275 276 277 278 279
        if(!empty($email))
        {
            $email = common_canonical_email($email);
        }

        $nickname = common_canonical_nickname($nickname);
280
        $profile->nickname = $nickname;
281 282
        if(! User::allowed_nickname($nickname)){
            common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
283
                       __FILE__);
284
            return false;
285
        }
286
        $profile->profileurl = common_profile_url($nickname);
Evan Prodromou's avatar
Evan Prodromou committed
287

288
        if (!empty($fullname)) {
289 290
            $profile->fullname = $fullname;
        }
291
        if (!empty($homepage)) {
292 293
            $profile->homepage = $homepage;
        }
294
        if (!empty($bio)) {
295 296
            $profile->bio = $bio;
        }
297
        if (!empty($location)) {
298
            $profile->location = $location;
299 300 301 302 303 304 305 306 307

            $loc = Location::fromName($location);

            if (!empty($loc)) {
                $profile->lat         = $loc->lat;
                $profile->lon         = $loc->lon;
                $profile->location_id = $loc->location_id;
                $profile->location_ns = $loc->location_ns;
            }
308
        }
Evan Prodromou's avatar
Evan Prodromou committed
309

310
        $profile->created = common_sql_now();
Evan Prodromou's avatar
Evan Prodromou committed
311

312
        $user = new User();
Evan Prodromou's avatar
Evan Prodromou committed
313

314
        $user->nickname = $nickname;
Evan Prodromou's avatar
Evan Prodromou committed
315

316 317
        $invite = null;

Evan Prodromou's avatar
Evan Prodromou committed
318
        // Users who respond to invite email have proven their ownership of that address
319

320
        if (!empty($code)) {
321 322 323 324 325 326
            $invite = Invitation::staticGet($code);
            if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
                $user->email = $invite->address;
            }
        }

327 328 329 330
        if(isset($email_confirmed) && $email_confirmed) {
            $user->email = $email;
        }

Evan Prodromou's avatar
Evan Prodromou committed
331
        // This flag is ignored but still set to 1
Evan Prodromou's avatar
Evan Prodromou committed
332

Evan Prodromou's avatar
Evan Prodromou committed
333
        $user->inboxed = 1;
334

335 336 337 338 339 340 341 342 343 344 345 346
        // Set default-on options here, otherwise they'll be disabled
        // initially for sites using caching, since the initial encache
        // doesn't know about the defaults in the database.
        $user->emailnotifysub = 1;
        $user->emailnotifyfav = 1;
        $user->emailnotifynudge = 1;
        $user->emailnotifymsg = 1;
        $user->emailnotifyattn = 1;
        $user->emailmicroid = 1;
        $user->emailpost = 1;
        $user->jabbermicroid = 1;

347 348
        $user->created = common_sql_now();

349
        if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
350

351
            $profile->query('BEGIN');
352

353
            $id = $profile->insert();
354

355 356 357 358
            if (empty($id)) {
                common_log_db_error($profile, 'INSERT', __FILE__);
                return false;
            }
359

360
            $user->id = $id;
Evan Prodromou's avatar
Evan Prodromou committed
361 362 363 364 365 366 367

            if (!empty($uri)) {
                $user->uri = $uri;
            } else {
                $user->uri = common_user_uri($user);
            }

368 369 370
            if (!empty($password)) { // may not have a password for OpenID users
                $user->password = common_munge_password($password, $id);
            }
371

372
            $result = $user->insert();
373

374 375 376 377
            if (!$result) {
                common_log_db_error($user, 'INSERT', __FILE__);
                return false;
            }
Evan Prodromou's avatar
Evan Prodromou committed
378

379
            // Everyone gets an inbox
380

381
            $inbox = new Inbox();
382

383 384
            $inbox->user_id = $user->id;
            $inbox->notice_ids = '';
385

386
            $result = $inbox->insert();
387 388

            if (!$result) {
389
                common_log_db_error($inbox, 'INSERT', __FILE__);
Evan Prodromou's avatar
TRUE  
Evan Prodromou committed
390
                return false;
391 392
            }

393
            // Everyone is subscribed to themself
Evan Prodromou's avatar
Evan Prodromou committed
394

395 396 397 398
            $subscription = new Subscription();
            $subscription->subscriber = $user->id;
            $subscription->subscribed = $user->id;
            $subscription->created = $user->created;
399

400
            $result = $subscription->insert();
401

402 403 404 405 406
            if (!$result) {
                common_log_db_error($subscription, 'INSERT', __FILE__);
                return false;
            }

407 408 409 410 411 412
            // Mark that this invite was converted

            if (!empty($invite)) {
                $invite->convert($user);
            }

413 414 415 416 417 418 419
            if (!empty($email) && !$user->email) {

                $confirm = new Confirm_address();
                $confirm->code = common_confirmation_code(128);
                $confirm->user_id = $user->id;
                $confirm->address = $email;
                $confirm->address_type = 'email';
420

421
                $result = $confirm->insert();
422 423

                if (!$result) {
424
                    common_log_db_error($confirm, 'INSERT', __FILE__);
425 426 427 428
                    return false;
                }
            }

429 430 431
            if (!empty($code) && $user->email) {
                $user->emailChanged();
            }
Evan Prodromou's avatar
Evan Prodromou committed
432

433
            // Default system subscription
Evan Prodromou's avatar
Evan Prodromou committed
434

435
            $defnick = common_config('newuser', 'default');
436

437 438 439 440 441 442
            if (!empty($defnick)) {
                $defuser = User::staticGet('nickname', $defnick);
                if (empty($defuser)) {
                    common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
                               __FILE__);
                } else {
443
                    Subscription::start($user, $defuser);
444
                }
445
            }
446

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
            $profile->query('COMMIT');

            if (!empty($email) && !$user->email) {
                mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
            }

            // Welcome message

            $welcome = common_config('newuser', 'welcome');

            if (!empty($welcome)) {
                $welcomeuser = User::staticGet('nickname', $welcome);
                if (empty($welcomeuser)) {
                    common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
                               __FILE__);
                } else {
                    $notice = Notice::saveNew($welcomeuser->id,
464 465
                                              // TRANS: Notice given on user registration.
                                              // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
466 467 468 469 470
                                              sprintf(_('Welcome to %1$s, @%2$s!'),
                                                      common_config('site', 'name'),
                                                      $user->nickname),
                                              'system');
                }
471
            }
472 473

            Event::handle('EndUserRegister', array(&$profile, &$user));
474 475
        }

476 477
        return $user;
    }
478

Evan Prodromou's avatar
Evan Prodromou committed
479
    // Things we do when the email changes
480 481
    function emailChanged()
    {
Evan Prodromou's avatar
Evan Prodromou committed
482

483 484 485
        $invites = new Invitation();
        $invites->address = $this->email;
        $invites->address_type = 'email';
Evan Prodromou's avatar
Evan Prodromou committed
486

487 488 489 490 491 492 493
        if ($invites->find()) {
            while ($invites->fetch()) {
                $other = User::staticGet($invites->user_id);
                subs_subscribe_to($other, $this);
            }
        }
    }
Evan Prodromou's avatar
Evan Prodromou committed
494

495 496
    function hasFave($notice)
    {
Zach Copley's avatar
Zach Copley committed
497 498
        $profile = $this->getProfile();
        return $profile->hasFave($notice);
499
    }
Evan Prodromou's avatar
Evan Prodromou committed
500

501 502
    function mutuallySubscribed($other)
    {
503 504
        $profile = $this->getProfile();
        return $profile->mutuallySubscribed($other);
505
    }
506

Evan Prodromou's avatar
Evan Prodromou committed
507 508 509 510
    function mutuallySubscribedUsers()
    {
        // 3-way join; probably should get cached
        $UT = common_config('db','type')=='pgsql'?'"user"':'user';
511 512 513
        $qry = "SELECT $UT.* " .
          "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
          "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
514
          'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
515
          "ORDER BY $UT.nickname";
516 517 518 519 520 521
        $user = new User();
        $user->query(sprintf($qry, $this->id, $this->id));

        return $user;
    }

522
    function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
523
    {
524
        return Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
525
    }
526

527
    function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
528
        $profile = $this->getProfile();
529
        return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
530 531
    }

532
    function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
Evan Prodromou's avatar
Evan Prodromou committed
533
    {
534
        $profile = $this->getProfile();
535
        return $profile->getNotices($offset, $limit, $since_id, $before_id);
536
    }
537

538
    function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
Evan Prodromou's avatar
Evan Prodromou committed
539
    {
540
        return Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
541
    }
542

543
    function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
Evan Prodromou's avatar
Evan Prodromou committed
544
    {
545 546
        $stream = new InboxNoticeStream($this);
        return $stream->getNotices($offset, $limit, $since_id, $before_id);
547 548
    }

549 550 551
    // DEPRECATED, use noticeInbox()

    function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
552
    {
Evan Prodromou's avatar
Evan Prodromou committed
553
        return $this->noticeInbox($offset, $limit, $since_id, $before_id);
554 555
    }

556 557 558
    // DEPRECATED, use noticeInbox()

    function noticesWithFriendsThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
559
    {
Evan Prodromou's avatar
Evan Prodromou committed
560
        return $this->noticeInbox($offset, $limit, $since_id, $before_id);
561
    }
562

563 564
    // DEPRECATED, use noticeInbox()

565 566
    function noticeInboxThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
    {
Evan Prodromou's avatar
Evan Prodromou committed
567
        return $this->noticeInbox($offset, $limit, $since_id, $before_id);
568 569
    }

570 571
    // DEPRECATED, use noticeInbox()

572
    function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
573
    {
Evan Prodromou's avatar
Evan Prodromou committed
574
        return $this->noticeInbox($offset, $limit, $since_id, $before_id);
575 576
    }

577 578
    // DEPRECATED, use noticeInbox()

579
    function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
580
    {
581
        $this->noticeInbox($offset, $limit, $since_id, $before_id);
582 583
    }

Evan Prodromou's avatar
Evan Prodromou committed
584 585
    function blowFavesCache()
    {
586
        $profile = $this->getProfile();
Zach Copley's avatar
Zach Copley committed
587
        $profile->blowFavesCache();
588
    }
589

Evan Prodromou's avatar
Evan Prodromou committed
590 591
    function getSelfTags()
    {
Shashi Gowda's avatar
Shashi Gowda committed
592
        return Profile_tag::getTagsArray($this->id, $this->id, $this->id);
593
    }
594

Shashi Gowda's avatar
Shashi Gowda committed
595
    function setSelfTags($newtags, $privacy)
Evan Prodromou's avatar
Evan Prodromou committed
596
    {
Shashi Gowda's avatar
Shashi Gowda committed
597
        return Profile_tag::setTags($this->id, $this->id, $newtags, $privacy);
598
    }
Evan Prodromou's avatar
Evan Prodromou committed
599

600 601
    function block($other)
    {
Evan Prodromou's avatar
Evan Prodromou committed
602
        // Add a new block record
Evan Prodromou's avatar
Evan Prodromou committed
603

604 605 606 607 608
        // no blocking (and thus unsubbing from) yourself

        if ($this->id == $other->id) {
            common_log(LOG_WARNING,
                sprintf(
609
                    "Profile ID %d (%s) tried to block themself.",
610 611
                    $this->id,
                    $this->nickname
612 613 614 615 616
                )
            );
            return false;
        }

Evan Prodromou's avatar
Evan Prodromou committed
617 618
        $block = new Profile_block();

Evan Prodromou's avatar
Evan Prodromou committed
619
        // Begin a transaction
Evan Prodromou's avatar
Evan Prodromou committed
620 621 622 623 624 625 626 627 628 629 630 631 632

        $block->query('BEGIN');

        $block->blocker = $this->id;
        $block->blocked = $other->id;

        $result = $block->insert();

        if (!$result) {
            common_log_db_error($block, 'INSERT', __FILE__);
            return false;
        }

633 634 635 636
        $self = $this->getProfile();
        if (Subscription::exists($other, $self)) {
            Subscription::cancel($other, $self);
        }
637 638 639
        if (Subscription::exists($self, $other)) {
            Subscription::cancel($self, $other);
        }
Evan Prodromou's avatar
Evan Prodromou committed
640 641 642 643 644 645

        $block->query('COMMIT');

        return true;
    }

646 647
    function unblock($other)
    {
Evan Prodromou's avatar
Evan Prodromou committed
648
        // Get the block record
Evan Prodromou's avatar
Evan Prodromou committed
649

650
        $block = Profile_block::get($this->id, $other->id);
Evan Prodromou's avatar
Evan Prodromou committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665

        if (!$block) {
            return false;
        }

        $result = $block->delete();

        if (!$result) {
            common_log_db_error($block, 'DELETE', __FILE__);
            return false;
        }

        return true;
    }

666 667
    function isMember($group)
    {
668 669
        $profile = $this->getProfile();
        return $profile->isMember($group);
670 671 672 673
    }

    function isAdmin($group)
    {
674 675
        $profile = $this->getProfile();
        return $profile->isAdmin($group);
676
    }
677

Evan Prodromou's avatar
Evan Prodromou committed
678
    function getGroups($offset=0, $limit=null)
679
    {
680 681
        $profile = $this->getProfile();
        return $profile->getGroups($offset, $limit);
Evan Prodromou's avatar
Evan Prodromou committed
682 683
    }

684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
    /**
     * Request to join the given group.
     * May throw exceptions on failure.
     *
     * @param User_group $group
     * @return Group_member
     */
    function joinGroup(User_group $group)
    {
        $profile = $this->getProfile();
        return $profile->joinGroup($group);
    }

    /**
     * Leave a group that this user is a member of.
     *
     * @param User_group $group
     */
    function leaveGroup(User_group $group)
    {
        $profile = $this->getProfile();
        return $profile->leaveGroup($group);
    }

Evan Prodromou's avatar
Evan Prodromou committed
708 709
    function getSubscriptions($offset=0, $limit=null)
    {
710 711
        $profile = $this->getProfile();
        return $profile->getSubscriptions($offset, $limit);
Evan Prodromou's avatar
Evan Prodromou committed
712 713 714 715
    }

    function getSubscribers($offset=0, $limit=null)
    {
716 717
        $profile = $this->getProfile();
        return $profile->getSubscribers($offset, $limit);
718
    }
719 720 721 722 723 724 725 726 727 728

    function getTaggedSubscribers($tag, $offset=0, $limit=null)
    {
        $qry =
          'SELECT profile.* ' .
          'FROM profile JOIN subscription ' .
          'ON profile.id = subscription.subscriber ' .
          'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
          'AND profile_tag.tagger = subscription.subscribed) ' .
          'WHERE subscription.subscribed = %d ' .
729
          "AND profile_tag.tag = '%s' " .
730 731 732 733
          'AND subscription.subscribed != subscription.subscriber ' .
          'ORDER BY subscription.created DESC ';

        if ($offset) {
734
            $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
        }

        $profile = new Profile();

        $cnt = $profile->query(sprintf($qry, $this->id, $tag));

        return $profile;
    }

    function getTaggedSubscriptions($tag, $offset=0, $limit=null)
    {
        $qry =
          'SELECT profile.* ' .
          'FROM profile JOIN subscription ' .
          'ON profile.id = subscription.subscribed ' .
          'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
          'AND profile_tag.tagger = subscription.subscriber) ' .
          'WHERE subscription.subscriber = %d ' .
753
          "AND profile_tag.tag = '%s' " .
754 755 756
          'AND subscription.subscribed != subscription.subscriber ' .
          'ORDER BY subscription.created DESC ';

757
        $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
758 759 760 761 762 763 764

        $profile = new Profile();

        $profile->query(sprintf($qry, $this->id, $tag));

        return $profile;
    }
765

Evan Prodromou's avatar
Evan Prodromou committed
766 767
    function hasRight($right)
    {
768 769
        $profile = $this->getProfile();
        return $profile->hasRight($right);
Evan Prodromou's avatar
Evan Prodromou committed
770
    }
771 772 773

    function delete()
    {
774 775 776 777 778 779
        try {
            $profile = $this->getProfile();
            $profile->delete();
        } catch (UserNoProfileException $unp) {
            common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
        }
780 781 782 783 784 785 786

        $related = array('Fave',
                         'Confirm_address',
                         'Remember_me',
                         'Foreign_link',
                         'Invitation',
                         );
787

788
        Event::handle('UserDeleteRelated', array($this, &$related));
789 790 791 792 793 794 795 796

        foreach ($related as $cls) {
            $inst = new $cls();
            $inst->user_id = $this->id;
            $inst->delete();
        }

        $this->_deleteTags();
Evan Prodromou's avatar
Evan Prodromou committed
797
        $this->_deleteBlocks();
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815

        parent::delete();
    }

    function _deleteTags()
    {
        $tag = new Profile_tag();
        $tag->tagger = $this->id;
        $tag->delete();
    }

    function _deleteBlocks()
    {
        $block = new Profile_block();
        $block->blocker = $this->id;
        $block->delete();
        // XXX delete group block? Reset blocker?
    }
816

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
    function hasRole($name)
    {
        $profile = $this->getProfile();
        return $profile->hasRole($name);
    }

    function grantRole($name)
    {
        $profile = $this->getProfile();
        return $profile->grantRole($name);
    }

    function revokeRole($name)
    {
        $profile = $this->getProfile();
        return $profile->revokeRole($name);
    }

835 836
    function isSandboxed()
    {
837 838
        $profile = $this->getProfile();
        return $profile->isSandboxed();
839 840 841 842
    }

    function isSilenced()
    {
843 844
        $profile = $this->getProfile();
        return $profile->isSilenced();
845
    }
846 847 848

    function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
    {
849
        $stream = new RepeatedByMeNoticeStream($this);
850
        return $stream->getNotices($offset, $limit, $since_id, $max_id);
851 852
    }

853 854 855

    function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
    {
856
        $stream = new RepeatsOfMeNoticeStream($this);
857

858
        return $stream->getNotices($offset, $limit, $since_id, $max_id);
859 860
    }

861 862 863

    function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
    {
864 865
        // TRANS: Exception thrown when trying view "repeated to me".
        throw new Exception(_('Not implemented since inbox change.'));
866
    }
867 868 869

    function shareLocation()
    {
870
        $cfg = common_config('location', 'share');
871

872 873 874 875 876 877
        if ($cfg == 'always') {
            return true;
        } else if ($cfg == 'never') {
            return false;
        } else { // user
            $share = true;
878

879
            $prefs = User_location_prefs::staticGet('user_id', $this->id);
880

881 882 883 884 885 886 887 888 889
            if (empty($prefs)) {
                $share = common_config('location', 'sharedefault');
            } else {
                $share = $prefs->share_location;
                $prefs->free();
            }

            return $share;
        }
890
    }
Evan Prodromou's avatar
Evan Prodromou committed
891 892 893 894 895 896 897 898 899 900 901 902 903

    static function siteOwner()
    {
        $owner = self::cacheGet('user:site_owner');

        if ($owner === false) { // cache miss

            $pr = new Profile_role();

            $pr->role = Profile_role::OWNER;

            $pr->orderBy('created');

Evan Prodromou's avatar
Evan Prodromou committed
904
            $pr->limit(1);
Evan Prodromou's avatar
Evan Prodromou committed
905

Evan Prodromou's avatar
Evan Prodromou committed
906
            if ($pr->find(true)) {
Evan Prodromou's avatar
Evan Prodromou committed
907 908 909 910 911 912 913 914 915 916
                $owner = User::staticGet('id', $pr->profile_id);
            } else {
                $owner = null;
            }

            self::cacheSet('user:site_owner', $owner);
        }

        return $owner;
    }
917 918 919 920 921 922 923 924 925 926 927 928 929 930

    /**
     * Pull the primary site account to use in single-user mode.
     * If a valid user nickname is listed in 'singleuser':'nickname'
     * in the config, this will be used; otherwise the site owner
     * account is taken by default.
     *
     * @return User
     * @throws ServerException if no valid single user account is present
     * @throws ServerException if called when not in single-user mode
     */
    static function singleUser()
    {
        if (common_config('singleuser', 'enabled')) {
931 932 933

            $user = null;

934
            $nickname = common_config('singleuser', 'nickname');
935 936

            if (!empty($nickname)) {
937
                $user = User::staticGet('nickname', $nickname);
938 939 940 941 942 943
            }

            // if there was no nickname or no user by that nickname,
            // try the site owner.

            if (empty($user)) {
944 945
                $user = User::siteOwner();
            }
946 947

            if (!empty($user)) {
948 949
                return $user;
            } else {
950 951
                // TRANS: Server exception.
                throw new ServerException(_('No single user defined for single-user mode.'));
952 953
            }
        } else {
954
            // TRANS: Server exception.
955 956 957
            throw new ServerException(_('Single-user mode code called when not enabled.'));
        }
    }
958

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
    /**
     * This is kind of a hack for using external setup code that's trying to
     * build single-user sites.
     *
     * Will still return a username if the config singleuser/nickname is set
     * even if the account doesn't exist, which normally indicates that the
     * site is horribly misconfigured.
     *
     * At the moment, we need to let it through so that router setup can
     * complete, otherwise we won't be able to create the account.
     *
     * This will be easier when we can more easily create the account and
     * *then* switch the site to 1user mode without jumping through hoops.
     *
     * @return string
     * @throws ServerException if no valid single user account is present
     * @throws ServerException if called when not in single-user mode
     */
    static function singleUserNickname()
    {
        try {
            $user = User::singleUser();
            return $user->nickname;
        } catch (Exception $e) {
            if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
Zach Copley's avatar
Zach Copley committed
984
                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.");
985 986 987 988 989
                return common_config('singleuser', 'nickname');
            }
            throw $e;
        }
    }
990

991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
    /**
     * Find and shorten links in the given text using this user's URL shortening
     * settings.
     *
     * By default, links will be left untouched if the text is shorter than the
     * configured maximum notice length. Pass true for the $always parameter
     * to force all links to be shortened regardless.
     *
     * Side effects: may save file and file_redirection records for referenced URLs.
     *
     * @param string $text
     * @param boolean $always
     * @return string
     */
    public function shortenLinks($text, $always=false)
    {
        return common_shorten_links($text, $always, $this);
    }
1009 1010

    /*
1011
     * Get a list of OAuth client applications that have access to this
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
     * user's account.
     */
    function getConnectedApps($offset = 0, $limit = null)
    {
        $qry =
          'SELECT u.* ' .
          'FROM oauth_application_user u, oauth_application a ' .
          'WHERE u.profile_id = %d ' .
          'AND a.id = u.application_id ' .
          'AND u.access_type > 0 ' .
          'ORDER BY u.created DESC ';

        if ($offset > 0) {
            if (common_config('db','type') == 'pgsql') {
                $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
            } else {
                $qry .= ' LIMIT ' . $offset . ', ' . $limit;
            }
        }

        $apps = new Oauth_application_user();

        $cnt = $apps->query(sprintf($qry, $this->id));

        return $apps;
    }
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054