3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
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.
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.
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/>.
20 if (!defined('STATUSNET') && !defined('LACONICA')) {
25 * Table Definition for user
28 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
29 require_once 'Validate.php';
31 class User extends Memcached_DataObject
34 /* the code below is auto generated do not remove the above tag */
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
71 function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('User',$k,$v); }
73 /* the code above is auto generated do not remove the tag below */
78 $profile = Profile::staticGet('id', $this->id);
79 if (empty($profile)) {
80 throw new UserNoProfileException($this);
85 function isSubscribed($other)
87 return Subscription::exists($this->getProfile(), $other);
90 // 'update' won't write key columns, so we have to do it ourselves.
92 function updateKeys(&$orig)
96 foreach (array('nickname', 'email', 'jabber', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
97 if (strcmp($this->$k, $orig->$k) != 0) {
98 $parts[] = $k . ' = ' . $this->_quote($this->$k);
101 if (count($parts) == 0) {
105 $toupdate = implode(', ', $parts);
107 $table = common_database_tablename($this->tableName());
108 $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
109 ' WHERE id = ' . $this->id;
111 $result = $this->query($qry);
118 static function allowed_nickname($nickname)
120 // XXX: should already be validated for size, content, etc.
121 $blacklist = common_config('nickname', 'blacklist');
123 //all directory and file names should be blacklisted
124 $d = dir(INSTALLDIR);
125 while (false !== ($entry = $d->read())) {
130 //all top level names in the router should be blacklisted
131 $router = Router::get();
132 foreach(array_keys($router->m->getPaths()) as $path){
133 if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
134 $blacklist[]=$matches[1];
137 return !in_array($nickname, $blacklist);
141 * Get the most recent notice posted by this user, if any.
143 * @return mixed Notice or null
145 function getCurrentNotice()
147 $profile = $this->getProfile();
148 return $profile->getCurrentNotice();
151 function getCarrier()
153 return Sms_carrier::staticGet('id', $this->carrier);
157 * @deprecated use Subscription::start($sub, $other);
159 function subscribeTo($other)
161 return Subscription::start($this->getProfile(), $other);
164 function hasBlocked($other)
166 $profile = $this->getProfile();
167 return $profile->hasBlocked($other);
171 * Register a new user account and profile and set up default subscriptions.
172 * If a new-user welcome message is configured, this will be sent.
174 * @param array $fields associative array of optional properties
177 * bool 'email_confirmed' pass true to mark email as pre-confirmed
180 * string 'location' informal string description of geolocation
181 * float 'lat' decimal latitude for geolocation
182 * float 'lon' decimal longitude for geolocation
183 * int 'location_id' geoname identifier
184 * int 'location_ns' geoname namespace to interpret location_id
185 * string 'nickname' REQUIRED
186 * string 'password' (may be missing for eg OpenID registrations)
187 * string 'code' invite code
188 * ?string 'uri' permalink to notice; defaults to local notice URL
189 * @return mixed User object or false on failure
191 static function register($fields) {
193 // MAGICALLY put fields into current scope
197 $profile = new Profile();
201 $email = common_canonical_email($email);
204 $nickname = common_canonical_nickname($nickname);
205 $profile->nickname = $nickname;
206 if(! User::allowed_nickname($nickname)){
207 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
211 $profile->profileurl = common_profile_url($nickname);
213 if (!empty($fullname)) {
214 $profile->fullname = $fullname;
216 if (!empty($homepage)) {
217 $profile->homepage = $homepage;
220 $profile->bio = $bio;
222 if (!empty($location)) {
223 $profile->location = $location;
225 $loc = Location::fromName($location);
228 $profile->lat = $loc->lat;
229 $profile->lon = $loc->lon;
230 $profile->location_id = $loc->location_id;
231 $profile->location_ns = $loc->location_ns;
235 $profile->created = common_sql_now();
239 $user->nickname = $nickname;
241 // Users who respond to invite email have proven their ownership of that address
244 $invite = Invitation::staticGet($code);
245 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
246 $user->email = $invite->address;
250 if(isset($email_confirmed) && $email_confirmed) {
251 $user->email = $email;
254 // This flag is ignored but still set to 1
258 // Set default-on options here, otherwise they'll be disabled
259 // initially for sites using caching, since the initial encache
260 // doesn't know about the defaults in the database.
261 $user->emailnotifysub = 1;
262 $user->emailnotifyfav = 1;
263 $user->emailnotifynudge = 1;
264 $user->emailnotifymsg = 1;
265 $user->emailnotifyattn = 1;
266 $user->emailmicroid = 1;
267 $user->emailpost = 1;
268 $user->jabbermicroid = 1;
269 $user->viewdesigns = 1;
271 $user->created = common_sql_now();
273 if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
275 $profile->query('BEGIN');
277 $id = $profile->insert();
280 common_log_db_error($profile, 'INSERT', __FILE__);
289 $user->uri = common_user_uri($user);
292 if (!empty($password)) { // may not have a password for OpenID users
293 $user->password = common_munge_password($password, $id);
296 $result = $user->insert();
299 common_log_db_error($user, 'INSERT', __FILE__);
303 // Everyone gets an inbox
305 $inbox = new Inbox();
307 $inbox->user_id = $user->id;
308 $inbox->notice_ids = '';
310 $result = $inbox->insert();
313 common_log_db_error($inbox, 'INSERT', __FILE__);
317 // Everyone is subscribed to themself
319 $subscription = new Subscription();
320 $subscription->subscriber = $user->id;
321 $subscription->subscribed = $user->id;
322 $subscription->created = $user->created;
324 $result = $subscription->insert();
327 common_log_db_error($subscription, 'INSERT', __FILE__);
331 if (!empty($email) && !$user->email) {
333 $confirm = new Confirm_address();
334 $confirm->code = common_confirmation_code(128);
335 $confirm->user_id = $user->id;
336 $confirm->address = $email;
337 $confirm->address_type = 'email';
339 $result = $confirm->insert();
342 common_log_db_error($confirm, 'INSERT', __FILE__);
347 if (!empty($code) && $user->email) {
348 $user->emailChanged();
351 // Default system subscription
353 $defnick = common_config('newuser', 'default');
355 if (!empty($defnick)) {
356 $defuser = User::staticGet('nickname', $defnick);
357 if (empty($defuser)) {
358 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
361 Subscription::start($user, $defuser);
365 $profile->query('COMMIT');
367 if (!empty($email) && !$user->email) {
368 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
373 $welcome = common_config('newuser', 'welcome');
375 if (!empty($welcome)) {
376 $welcomeuser = User::staticGet('nickname', $welcome);
377 if (empty($welcomeuser)) {
378 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
381 $notice = Notice::saveNew($welcomeuser->id,
382 // TRANS: Notice given on user registration.
383 // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
384 sprintf(_('Welcome to %1$s, @%2$s!'),
385 common_config('site', 'name'),
391 Event::handle('EndUserRegister', array(&$profile, &$user));
397 // Things we do when the email changes
398 function emailChanged()
401 $invites = new Invitation();
402 $invites->address = $this->email;
403 $invites->address_type = 'email';
405 if ($invites->find()) {
406 while ($invites->fetch()) {
407 $other = User::staticGet($invites->user_id);
408 subs_subscribe_to($other, $this);
413 function hasFave($notice)
415 $profile = $this->getProfile();
416 return $profile->hasFave($notice);
419 function mutuallySubscribed($other)
421 return $this->isSubscribed($other) &&
422 $other->isSubscribed($this);
425 function mutuallySubscribedUsers()
427 // 3-way join; probably should get cached
428 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
429 $qry = "SELECT $UT.* " .
430 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
431 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
432 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
433 "ORDER BY $UT.nickname";
435 $user->query(sprintf($qry, $this->id, $this->id));
440 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
442 $ids = Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
443 return Notice::getStreamByIds($ids);
446 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
447 $profile = $this->getProfile();
448 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
451 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
453 $profile = $this->getProfile();
454 return $profile->getNotices($offset, $limit, $since_id, $before_id);
457 function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
459 $ids = Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
460 return Notice::getStreamByIds($ids);
463 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
465 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
468 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
470 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
473 function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
475 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
478 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
480 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
483 function blowFavesCache()
485 $profile = $this->getProfile();
486 $profile->blowFavesCache();
489 function getSelfTags()
491 return Profile_tag::getTags($this->id, $this->id);
494 function setSelfTags($newtags)
496 return Profile_tag::setTags($this->id, $this->id, $newtags);
499 function block($other)
501 // Add a new block record
503 // no blocking (and thus unsubbing from) yourself
505 if ($this->id == $other->id) {
506 common_log(LOG_WARNING,
508 "Profile ID %d (%s) tried to block themself.",
516 $block = new Profile_block();
518 // Begin a transaction
520 $block->query('BEGIN');
522 $block->blocker = $this->id;
523 $block->blocked = $other->id;
525 $result = $block->insert();
528 common_log_db_error($block, 'INSERT', __FILE__);
532 $self = $this->getProfile();
533 if (Subscription::exists($other, $self)) {
534 Subscription::cancel($other, $self);
536 if (Subscription::exists($self, $other)) {
537 Subscription::cancel($self, $other);
540 $block->query('COMMIT');
545 function unblock($other)
547 // Get the block record
549 $block = Profile_block::get($this->id, $other->id);
555 $result = $block->delete();
558 common_log_db_error($block, 'DELETE', __FILE__);
565 function isMember($group)
567 $profile = $this->getProfile();
568 return $profile->isMember($group);
571 function isAdmin($group)
573 $profile = $this->getProfile();
574 return $profile->isAdmin($group);
577 function getGroups($offset=0, $limit=null)
579 $profile = $this->getProfile();
580 return $profile->getGroups($offset, $limit);
583 function getSubscriptions($offset=0, $limit=null)
585 $profile = $this->getProfile();
586 return $profile->getSubscriptions($offset, $limit);
589 function getSubscribers($offset=0, $limit=null)
591 $profile = $this->getProfile();
592 return $profile->getSubscribers($offset, $limit);
595 function getTaggedSubscribers($tag, $offset=0, $limit=null)
598 'SELECT profile.* ' .
599 'FROM profile JOIN subscription ' .
600 'ON profile.id = subscription.subscriber ' .
601 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
602 'AND profile_tag.tagger = subscription.subscribed) ' .
603 'WHERE subscription.subscribed = %d ' .
604 "AND profile_tag.tag = '%s' " .
605 'AND subscription.subscribed != subscription.subscriber ' .
606 'ORDER BY subscription.created DESC ';
609 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
612 $profile = new Profile();
614 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
619 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
622 'SELECT profile.* ' .
623 'FROM profile JOIN subscription ' .
624 'ON profile.id = subscription.subscribed ' .
625 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
626 'AND profile_tag.tagger = subscription.subscriber) ' .
627 'WHERE subscription.subscriber = %d ' .
628 "AND profile_tag.tag = '%s' " .
629 'AND subscription.subscribed != subscription.subscriber ' .
630 'ORDER BY subscription.created DESC ';
632 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
634 $profile = new Profile();
636 $profile->query(sprintf($qry, $this->id, $tag));
643 return Design::staticGet('id', $this->design_id);
646 function hasRight($right)
648 $profile = $this->getProfile();
649 return $profile->hasRight($right);
655 $profile = $this->getProfile();
657 } catch (UserNoProfileException $unp) {
658 common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
661 $related = array('Fave',
668 Event::handle('UserDeleteRelated', array($this, &$related));
670 foreach ($related as $cls) {
672 $inst->user_id = $this->id;
676 $this->_deleteTags();
677 $this->_deleteBlocks();
682 function _deleteTags()
684 $tag = new Profile_tag();
685 $tag->tagger = $this->id;
689 function _deleteBlocks()
691 $block = new Profile_block();
692 $block->blocker = $this->id;
694 // XXX delete group block? Reset blocker?
697 function hasRole($name)
699 $profile = $this->getProfile();
700 return $profile->hasRole($name);
703 function grantRole($name)
705 $profile = $this->getProfile();
706 return $profile->grantRole($name);
709 function revokeRole($name)
711 $profile = $this->getProfile();
712 return $profile->revokeRole($name);
715 function isSandboxed()
717 $profile = $this->getProfile();
718 return $profile->isSandboxed();
721 function isSilenced()
723 $profile = $this->getProfile();
724 return $profile->isSilenced();
727 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
729 $ids = Notice::stream(array($this, '_repeatedByMeDirect'),
731 'user:repeated_by_me:'.$this->id,
732 $offset, $limit, $since_id, $max_id, null);
734 return Notice::getStreamByIds($ids);
737 function _repeatedByMeDirect($offset, $limit, $since_id, $max_id)
739 $notice = new Notice();
741 $notice->selectAdd(); // clears it
742 $notice->selectAdd('id');
744 $notice->profile_id = $this->id;
745 $notice->whereAdd('repeat_of IS NOT NULL');
747 $notice->orderBy('id DESC');
749 if (!is_null($offset)) {
750 $notice->limit($offset, $limit);
753 if ($since_id != 0) {
754 $notice->whereAdd('id > ' . $since_id);
758 $notice->whereAdd('id <= ' . $max_id);
763 if ($notice->find()) {
764 while ($notice->fetch()) {
765 $ids[] = $notice->id;
775 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
777 $ids = Notice::stream(array($this, '_repeatsOfMeDirect'),
779 'user:repeats_of_me:'.$this->id,
780 $offset, $limit, $since_id, $max_id);
782 return Notice::getStreamByIds($ids);
785 function _repeatsOfMeDirect($offset, $limit, $since_id, $max_id)
788 'SELECT DISTINCT original.id AS id ' .
789 'FROM notice original JOIN notice rept ON original.id = rept.repeat_of ' .
790 'WHERE original.profile_id = ' . $this->id . ' ';
792 if ($since_id != 0) {
793 $qry .= 'AND original.id > ' . $since_id . ' ';
797 $qry .= 'AND original.id <= ' . $max_id . ' ';
800 // NOTE: we sort by fave time, not by notice time!
802 $qry .= 'ORDER BY original.id DESC ';
804 if (!is_null($offset)) {
805 $qry .= "LIMIT $limit OFFSET $offset";
810 $notice = new Notice();
812 $notice->query($qry);
814 while ($notice->fetch()) {
815 $ids[] = $notice->id;
824 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
826 throw new Exception("Not implemented since inbox change.");
829 function shareLocation()
831 $cfg = common_config('location', 'share');
833 if ($cfg == 'always') {
835 } else if ($cfg == 'never') {
840 $prefs = User_location_prefs::staticGet('user_id', $this->id);
843 $share = common_config('location', 'sharedefault');
845 $share = $prefs->share_location;
853 static function siteOwner()
855 $owner = self::cacheGet('user:site_owner');
857 if ($owner === false) { // cache miss
859 $pr = new Profile_role();
861 $pr->role = Profile_role::OWNER;
863 $pr->orderBy('created');
867 if ($pr->find(true)) {
868 $owner = User::staticGet('id', $pr->profile_id);
873 self::cacheSet('user:site_owner', $owner);
880 * Pull the primary site account to use in single-user mode.
881 * If a valid user nickname is listed in 'singleuser':'nickname'
882 * in the config, this will be used; otherwise the site owner
883 * account is taken by default.
886 * @throws ServerException if no valid single user account is present
887 * @throws ServerException if called when not in single-user mode
889 static function singleUser()
891 if (common_config('singleuser', 'enabled')) {
895 $nickname = common_config('singleuser', 'nickname');
897 if (!empty($nickname)) {
898 $user = User::staticGet('nickname', $nickname);
901 // if there was no nickname or no user by that nickname,
902 // try the site owner.
905 $user = User::siteOwner();
911 // TRANS: Server exception.
912 throw new ServerException(_('No single user defined for single-user mode.'));
915 // TRANS: Server exception.
916 throw new ServerException(_('Single-user mode code called when not enabled.'));