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 Memcached_DataObject
  32 {
  33     ###START_AUTOCODE
  34     /* the code below is auto generated do not remove the above tag */
  35
  36     public $__table = 'user';                            // table name
  37     public $id;                              // int(4)  primary_key not_null
  38     public $nickname;                        // varchar(64)  unique_key
  39     public $password;                        // varchar(255)
  40     public $email;                           // varchar(255)  unique_key
  41     public $incomingemail;                   // varchar(255)  unique_key
  42     public $emailnotifysub;                  // tinyint(1)   default_1
  43     public $emailnotifyfav;                  // tinyint(1)   default_1
  44     public $emailnotifynudge;                // tinyint(1)   default_1
  45     public $emailnotifymsg;                  // tinyint(1)   default_1
  46     public $emailnotifyattn;                 // tinyint(1)   default_1
  47     public $emailmicroid;                    // tinyint(1)   default_1
  48     public $language;                        // varchar(50)
  49     public $timezone;                        // varchar(50)
  50     public $emailpost;                       // tinyint(1)   default_1
  51     public $jabber;                          // varchar(255)  unique_key
  52     public $jabbernotify;                    // tinyint(1)
  53     public $jabberreplies;                   // tinyint(1)
  54     public $jabbermicroid;                   // tinyint(1)   default_1
  55     public $updatefrompresence;              // tinyint(1)
  56     public $sms;                             // varchar(64)  unique_key
  57     public $carrier;                         // int(4)
  58     public $smsnotify;                       // tinyint(1)
  59     public $smsreplies;                      // tinyint(1)
  60     public $smsemail;                        // varchar(255)
  61     public $uri;                             // varchar(255)  unique_key
  62     public $autosubscribe;                   // tinyint(1)
  63     public $urlshorteningservice;            // varchar(50)   default_ur1.ca
  64     public $inboxed;                         // tinyint(1)
  65     public $design_id;                       // int(4)
  66     public $viewdesigns;                     // tinyint(1)   default_1
  67     public $created;                         // datetime()   not_null
  68     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  69
  70     /* Static get */
  71     function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('User',$k,$v); }
  72
  73     /* the code above is auto generated do not remove the tag below */
  74     ###END_AUTOCODE
  75
  76     function getProfile()
  77     {
  78         return Profile::staticGet('id', $this->id);
  79     }
  80
  81     function isSubscribed($other)
  82     {
  83         assert(!is_null($other));
  84         // XXX: cache results of this query
  85         $sub = Subscription::pkeyGet(array('subscriber' => $this->id,
  86                                            'subscribed' => $other->id));
  87         return (is_null($sub)) ? false : true;
  88     }
  89
  90     // 'update' won't write key columns, so we have to do it ourselves.
  91
  92     function updateKeys(&$orig)
  93     {
  94         $parts = array();
  95         foreach (array('nickname', 'email', 'jabber', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
  96             if (strcmp($this->$k, $orig->$k) != 0) {
  97                 $parts[] = $k . ' = ' . $this->_quote($this->$k);
  98             }
  99         }
 100         if (count($parts) == 0) {
 101             // No changes
 102             return true;
 103         }
 104         $toupdate = implode(', ', $parts);
 105
 106         $table = common_database_tablename($this->tableName());
 107         $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
 108           ' WHERE id = ' . $this->id;
 109         $orig->decache();
 110         $result = $this->query($qry);
 111         if ($result) {
 112             $this->encache();
 113         }
 114         return $result;
 115     }
 116
 117     function allowed_nickname($nickname)
 118     {
 119         // XXX: should already be validated for size, content, etc.
 120
 121         $blacklist = array();
 122
 123         //all directory and file names should be blacklisted
 124         $d = dir(INSTALLDIR);
 125         while (false !== ($entry = $d->read())) {
 126             $blacklist[]=$entry;
 127         }
 128         $d->close();
 129         $merged = array_merge($blacklist, common_config('nickname', 'blacklist'));
 130         return !in_array($nickname, $merged);
 131     }
 132
 133     function getCurrentNotice($dt=null)
 134     {
 135         $profile = $this->getProfile();
 136         if (!$profile) {
 137             return null;
 138         }
 139         return $profile->getCurrentNotice($dt);
 140     }
 141
 142     function getCarrier()
 143     {
 144         return Sms_carrier::staticGet('id', $this->carrier);
 145     }
 146
 147     function subscribeTo($other)
 148     {
 149         $sub = new Subscription();
 150         $sub->subscriber = $this->id;
 151         $sub->subscribed = $other->id;
 152
 153         $sub->created = common_sql_now(); // current time
 154
 155         if (!$sub->insert()) {
 156             return false;
 157         }
 158
 159         return true;
 160     }
 161
 162     function hasBlocked($other)
 163     {
 164
 165         $block = Profile_block::get($this->id, $other->id);
 166
 167         if (is_null($block)) {
 168             $result = false;
 169         } else {
 170             $result = true;
 171             $block->free();
 172         }
 173
 174         return $result;
 175     }
 176
 177     static function register($fields) {
 178
 179         // MAGICALLY put fields into current scope
 180
 181         extract($fields);
 182
 183         $profile = new Profile();
 184
 185         $profile->query('BEGIN');
 186
 187         $profile->nickname = $nickname;
 188         $profile->profileurl = common_profile_url($nickname);
 189
 190         if (!empty($fullname)) {
 191             $profile->fullname = $fullname;
 192         }
 193         if (!empty($homepage)) {
 194             $profile->homepage = $homepage;
 195         }
 196         if (!empty($bio)) {
 197             $profile->bio = $bio;
 198         }
 199         if (!empty($location)) {
 200             $profile->location = $location;
 201         }
 202
 203         $profile->created = common_sql_now();
 204
 205         $id = $profile->insert();
 206
 207         if (empty($id)) {
 208             common_log_db_error($profile, 'INSERT', __FILE__);
 209             return false;
 210         }
 211
 212         $user = new User();
 213
 214         $user->id = $id;
 215         $user->nickname = $nickname;
 216
 217         if (!empty($password)) { // may not have a password for OpenID users
 218             $user->password = common_munge_password($password, $id);
 219         }
 220
 221         // Users who respond to invite email have proven their ownership of that address
 222
 223         if (!empty($code)) {
 224             $invite = Invitation::staticGet($code);
 225             if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
 226                 $user->email = $invite->address;
 227             }
 228         }
 229
 230         // This flag is ignored but still set to 1
 231
 232         $user->inboxed = 1;
 233
 234         $user->created = common_sql_now();
 235         $user->uri = common_user_uri($user);
 236
 237         $result = $user->insert();
 238
 239         if (!$result) {
 240             common_log_db_error($user, 'INSERT', __FILE__);
 241             return false;
 242         }
 243
 244         // Everyone is subscribed to themself
 245
 246         $subscription = new Subscription();
 247         $subscription->subscriber = $user->id;
 248         $subscription->subscribed = $user->id;
 249         $subscription->created = $user->created;
 250
 251         $result = $subscription->insert();
 252
 253         if (!$result) {
 254             common_log_db_error($subscription, 'INSERT', __FILE__);
 255             return false;
 256         }
 257
 258         if (!empty($email) && !$user->email) {
 259
 260             $confirm = new Confirm_address();
 261             $confirm->code = common_confirmation_code(128);
 262             $confirm->user_id = $user->id;
 263             $confirm->address = $email;
 264             $confirm->address_type = 'email';
 265
 266             $result = $confirm->insert();
 267             if (!$result) {
 268                 common_log_db_error($confirm, 'INSERT', __FILE__);
 269                 return false;
 270             }
 271         }
 272
 273         if (!empty($code) && $user->email) {
 274             $user->emailChanged();
 275         }
 276
 277         // Default system subscription
 278
 279         $defnick = common_config('newuser', 'default');
 280
 281         if (!empty($defnick)) {
 282             $defuser = User::staticGet('nickname', $defnick);
 283             if (empty($defuser)) {
 284                 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
 285                            __FILE__);
 286             } else {
 287                 $defsub = new Subscription();
 288                 $defsub->subscriber = $user->id;
 289                 $defsub->subscribed = $defuser->id;
 290                 $defsub->created = $user->created;
 291
 292                 $result = $defsub->insert();
 293
 294                 if (!$result) {
 295                     common_log_db_error($defsub, 'INSERT', __FILE__);
 296                     return false;
 297                 }
 298             }
 299         }
 300
 301         $profile->query('COMMIT');
 302
 303         if ($email && !$user->email) {
 304             mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
 305         }
 306
 307         // Welcome message
 308
 309         $welcome = common_config('newuser', 'welcome');
 310
 311         if (!empty($welcome)) {
 312             $welcomeuser = User::staticGet('nickname', $welcome);
 313             if (empty($welcomeuser)) {
 314                 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
 315                            __FILE__);
 316             } else {
 317                 $notice = Notice::saveNew($welcomeuser->id,
 318                                           sprintf(_('Welcome to %1$s, @%2$s!'),
 319                                                   common_config('site', 'name'),
 320                                                   $user->nickname),
 321                                           'system');
 322                 common_broadcast_notice($notice);
 323             }
 324         }
 325
 326         return $user;
 327     }
 328
 329     // Things we do when the email changes
 330
 331     function emailChanged()
 332     {
 333
 334         $invites = new Invitation();
 335         $invites->address = $this->email;
 336         $invites->address_type = 'email';
 337
 338         if ($invites->find()) {
 339             while ($invites->fetch()) {
 340                 $other = User::staticGet($invites->user_id);
 341                 subs_subscribe_to($other, $this);
 342             }
 343         }
 344     }
 345
 346     function hasFave($notice)
 347     {
 348         $cache = common_memcache();
 349
 350         // XXX: Kind of a hack.
 351
 352         if ($cache) {
 353             // This is the stream of favorite notices, in rev chron
 354             // order. This forces it into cache.
 355
 356             $ids = Fave::stream($this->id, 0, NOTICE_CACHE_WINDOW);
 357
 358             // If it's in the list, then it's a fave
 359
 360             if (in_array($notice->id, $ids)) {
 361                 return true;
 362             }
 363
 364             // If we're not past the end of the cache window,
 365             // then the cache has all available faves, so this one
 366             // is not a fave.
 367
 368             if (count($ids) < NOTICE_CACHE_WINDOW) {
 369                 return false;
 370             }
 371
 372             // Otherwise, cache doesn't have all faves;
 373             // fall through to the default
 374         }
 375
 376         $fave = Fave::pkeyGet(array('user_id' => $this->id,
 377                                     'notice_id' => $notice->id));
 378         return ((is_null($fave)) ? false : true);
 379     }
 380
 381     function mutuallySubscribed($other)
 382     {
 383         return $this->isSubscribed($other) &&
 384           $other->isSubscribed($this);
 385     }
 386
 387     function mutuallySubscribedUsers()
 388     {
 389         // 3-way join; probably should get cached
 390         $UT = common_config('db','type')=='pgsql'?'"user"':'user';
 391         $qry = "SELECT $UT.* " .
 392           "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
 393           "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
 394           'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
 395           "ORDER BY $UT.nickname";
 396         $user = new User();
 397         $user->query(sprintf($qry, $this->id, $this->id));
 398
 399         return $user;
 400     }
 401
 402     function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
 403     {
 404         $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id, $since);
 405         return Notice::getStreamByIds($ids);
 406     }
 407
 408     function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null) {
 409         $profile = $this->getProfile();
 410         if (!$profile) {
 411             return null;
 412         } else {
 413             return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id, $since);
 414         }
 415     }
 416
 417     function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
 418     {
 419         $profile = $this->getProfile();
 420         if (!$profile) {
 421             return null;
 422         } else {
 423             return $profile->getNotices($offset, $limit, $since_id, $before_id, $since);
 424         }
 425     }
 426
 427     function favoriteNotices($offset=0, $limit=NOTICES_PER_PAGE, $own=false)
 428     {
 429         $ids = Fave::stream($this->id, $offset, $limit, $own);
 430         return Notice::getStreamByIds($ids);
 431     }
 432
 433     function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
 434     {
 435         $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, false);
 436
 437         return Notice::getStreamByIds($ids);
 438     }
 439
 440     function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0, $since=null)
 441     {
 442         $ids = Notice_inbox::stream($this->id, $offset, $limit, $since_id, $before_id, $since, true);
 443
 444         return Notice::getStreamByIds($ids);
 445     }
 446
 447     function blowFavesCache()
 448     {
 449         $cache = common_memcache();
 450         if ($cache) {
 451             // Faves don't happen chronologically, so we need to blow
 452             // ;last cache, too
 453             $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id));
 454             $cache->delete(common_cache_key('fave:ids_by_user:'.$this->id.';last'));
 455             $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id));
 456             $cache->delete(common_cache_key('fave:ids_by_user_own:'.$this->id.';last'));
 457         }
 458         $profile = $this->getProfile();
 459         $profile->blowFaveCount();
 460     }
 461
 462     function getSelfTags()
 463     {
 464         return Profile_tag::getTags($this->id, $this->id);
 465     }
 466
 467     function setSelfTags($newtags)
 468     {
 469         return Profile_tag::setTags($this->id, $this->id, $newtags);
 470     }
 471
 472     function block($other)
 473     {
 474         // Add a new block record
 475
 476         $block = new Profile_block();
 477
 478         // Begin a transaction
 479
 480         $block->query('BEGIN');
 481
 482         $block->blocker = $this->id;
 483         $block->blocked = $other->id;
 484
 485         $result = $block->insert();
 486
 487         if (!$result) {
 488             common_log_db_error($block, 'INSERT', __FILE__);
 489             return false;
 490         }
 491
 492         // Cancel their subscription, if it exists
 493
 494         $sub = Subscription::pkeyGet(array('subscriber' => $other->id,
 495                                            'subscribed' => $this->id));
 496
 497         if ($sub) {
 498             $result = $sub->delete();
 499             if (!$result) {
 500                 common_log_db_error($sub, 'DELETE', __FILE__);
 501                 return false;
 502             }
 503         }
 504
 505         $block->query('COMMIT');
 506
 507         return true;
 508     }
 509
 510     function unblock($other)
 511     {
 512         // Get the block record
 513
 514         $block = Profile_block::get($this->id, $other->id);
 515
 516         if (!$block) {
 517             return false;
 518         }
 519
 520         $result = $block->delete();
 521
 522         if (!$result) {
 523             common_log_db_error($block, 'DELETE', __FILE__);
 524             return false;
 525         }
 526
 527         return true;
 528     }
 529
 530     function isMember($group)
 531     {
 532         $profile = $this->getProfile();
 533         return $profile->isMember($group);
 534     }
 535
 536     function isAdmin($group)
 537     {
 538         $profile = $this->getProfile();
 539         return $profile->isAdmin($group);
 540     }
 541
 542     function getGroups($offset=0, $limit=null)
 543     {
 544         $qry =
 545           'SELECT user_group.* ' .
 546           'FROM user_group JOIN group_member '.
 547           'ON user_group.id = group_member.group_id ' .
 548           'WHERE group_member.profile_id = %d ' .
 549           'ORDER BY group_member.created DESC ';
 550
 551         if ($offset) {
 552             if (common_config('db','type') == 'pgsql') {
 553                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 554             } else {
 555                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 556             }
 557         }
 558
 559         $groups = new User_group();
 560
 561         $cnt = $groups->query(sprintf($qry, $this->id));
 562
 563         return $groups;
 564     }
 565
 566     function getSubscriptions($offset=0, $limit=null)
 567     {
 568         $profile = $this->getProfile();
 569         assert(!empty($profile));
 570         return $profile->getSubscriptions($offset, $limit);
 571     }
 572
 573     function getSubscribers($offset=0, $limit=null)
 574     {
 575         $profile = $this->getProfile();
 576         assert(!empty($profile));
 577         return $profile->getSubscribers($offset, $limit);
 578     }
 579
 580     function getTaggedSubscribers($tag, $offset=0, $limit=null)
 581     {
 582         $qry =
 583           'SELECT profile.* ' .
 584           'FROM profile JOIN subscription ' .
 585           'ON profile.id = subscription.subscriber ' .
 586           'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
 587           'AND profile_tag.tagger = subscription.subscribed) ' .
 588           'WHERE subscription.subscribed = %d ' .
 589           "AND profile_tag.tag = '%s' " .
 590           'AND subscription.subscribed != subscription.subscriber ' .
 591           'ORDER BY subscription.created DESC ';
 592
 593         if ($offset) {
 594             $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 595         }
 596
 597         $profile = new Profile();
 598
 599         $cnt = $profile->query(sprintf($qry, $this->id, $tag));
 600
 601         return $profile;
 602     }
 603
 604     function getTaggedSubscriptions($tag, $offset=0, $limit=null)
 605     {
 606         $qry =
 607           'SELECT profile.* ' .
 608           'FROM profile JOIN subscription ' .
 609           'ON profile.id = subscription.subscribed ' .
 610           'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
 611           'AND profile_tag.tagger = subscription.subscriber) ' .
 612           'WHERE subscription.subscriber = %d ' .
 613           "AND profile_tag.tag = '%s' " .
 614           'AND subscription.subscribed != subscription.subscriber ' .
 615           'ORDER BY subscription.created DESC ';
 616
 617         $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 618
 619         $profile = new Profile();
 620
 621         $profile->query(sprintf($qry, $this->id, $tag));
 622
 623         return $profile;
 624     }
 625
 626     function getDesign()
 627     {
 628         return Design::staticGet('id', $this->design_id);
 629     }
 630
 631     function hasRole($name)
 632     {
 633         $role = User_role::pkeyGet(array('user_id' => $this->id,
 634                                          'role' => $name));
 635         return (!empty($role));
 636     }
 637
 638     function grantRole($name)
 639     {
 640         $role = new User_role();
 641
 642         $role->user_id = $this->id;
 643         $role->role    = $name;
 644         $role->created = common_sql_now();
 645
 646         $result = $role->insert();
 647
 648         if (!$result) {
 649             common_log_db_error($role, 'INSERT', __FILE__);
 650             return false;
 651         }
 652
 653         return true;
 654     }
 655
 656     function revokeRole($name)
 657     {
 658         $role = User_role::pkeyGet(array('user_id' => $this->id,
 659                                          'role' => $name));
 660
 661         if (empty($role)) {
 662             throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; does not exist.');
 663         }
 664
 665         $result = $role->delete();
 666
 667         if (!$result) {
 668             common_log_db_error($role, 'DELETE', __FILE__);
 669             throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; database error.');
 670         }
 671
 672         return true;
 673     }
 674
 675     /**
 676      * Does this user have the right to do X?
 677      *
 678      * With our role-based authorization, this is merely a lookup for whether the user
 679      * has a particular role. The implementation currently uses a switch statement
 680      * to determine if the user has the pre-defined role to exercise the right. Future
 681      * implementations may allow per-site roles, and different mappings of roles to rights.
 682      *
 683      * @param $right string Name of the right, usually a constant in class Right
 684      * @return boolean whether the user has the right in question
 685      */
 686
 687     function hasRight($right)
 688     {
 689         $result = false;
 690         if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
 691             switch ($right)
 692             {
 693              case Right::deleteOthersNotice:
 694                 $result = $this->hasRole('moderator');
 695                 break;
 696              default:
 697                 $result = false;
 698                 break;
 699             }
 700         }
 701         return $result;
 702     }
 703
 704     function delete()
 705     {
 706         $profile = $this->getProfile();
 707         $profile->delete();
 708
 709         $related = array('Fave',
 710                          'User_openid',
 711                          'Confirm_address',
 712                          'Remember_me',
 713                          'Foreign_link',
 714                          'Invitation',
 715                          'Notice_inbox',
 716                          );
 717
 718         foreach ($related as $cls) {
 719             $inst = new $cls();
 720             $inst->user_id = $this->id;
 721             $inst->delete();
 722         }
 723
 724         $this->_deleteTags();
 725         $this->_deleteBlocks();
 726
 727         parent::delete();
 728     }
 729
 730     function _deleteTags()
 731     {
 732         $tag = new Profile_tag();
 733         $tag->tagger = $this->id;
 734         $tag->delete();
 735     }
 736
 737     function _deleteBlocks()
 738     {
 739         $block = new Profile_block();
 740         $block->blocker = $this->id;
 741         $block->delete();
 742         // XXX delete group block? Reset blocker?
 743     }
 744 }