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
33 const SUBSCRIBE_POLICY_OPEN = 0;
34 const SUBSCRIBE_POLICY_MODERATE = 1;
37 /* the code below is auto generated do not remove the above tag */
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 $design_id; // int(4)
65 public $viewdesigns; // tinyint(1) default_1
66 public $created; // datetime() not_null
67 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
70 function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('User',$k,$v); }
72 /* the code above is auto generated do not remove the tag below */
80 $profile = Profile::staticGet('id', $this->id);
81 if (empty($profile)) {
82 throw new UserNoProfileException($this);
87 function isSubscribed($other)
89 $profile = $this->getProfile();
90 return $profile->isSubscribed($other);
93 function hasPendingSubscription($other)
95 $profile = $this->getProfile();
96 return $profile->hasPendingSubscription($other);
99 // 'update' won't write key columns, so we have to do it ourselves.
101 function updateKeys(&$orig)
105 foreach (array('nickname', 'email', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
106 if (strcmp($this->$k, $orig->$k) != 0) {
107 $parts[] = $k . ' = ' . $this->_quote($this->$k);
110 if (count($parts) == 0) {
114 $toupdate = implode(', ', $parts);
116 $table = common_database_tablename($this->tableName());
117 $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
118 ' WHERE id = ' . $this->id;
120 $result = $this->query($qry);
128 * Check whether the given nickname is potentially usable, or if it's
129 * excluded by any blacklists on this system.
131 * WARNING: INPUT IS NOT VALIDATED OR NORMALIZED. NON-NORMALIZED INPUT
132 * OR INVALID INPUT MAY LEAD TO FALSE RESULTS.
134 * @param string $nickname
135 * @return boolean true if clear, false if blacklisted
137 static function allowed_nickname($nickname)
139 // XXX: should already be validated for size, content, etc.
140 $blacklist = common_config('nickname', 'blacklist');
142 //all directory and file names should be blacklisted
143 $d = dir(INSTALLDIR);
144 while (false !== ($entry = $d->read())) {
149 //all top level names in the router should be blacklisted
150 $router = Router::get();
151 foreach(array_keys($router->m->getPaths()) as $path){
152 if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
153 $blacklist[]=$matches[1];
156 return !in_array($nickname, $blacklist);
160 * Get the most recent notice posted by this user, if any.
162 * @return mixed Notice or null
164 function getCurrentNotice()
166 $profile = $this->getProfile();
167 return $profile->getCurrentNotice();
170 function getCarrier()
172 return Sms_carrier::staticGet('id', $this->carrier);
176 * @deprecated use Subscription::start($sub, $other);
178 function subscribeTo($other)
180 return Subscription::start($this->getProfile(), $other);
183 function hasBlocked($other)
185 $profile = $this->getProfile();
186 return $profile->hasBlocked($other);
190 * Register a new user account and profile and set up default subscriptions.
191 * If a new-user welcome message is configured, this will be sent.
193 * @param array $fields associative array of optional properties
196 * bool 'email_confirmed' pass true to mark email as pre-confirmed
199 * string 'location' informal string description of geolocation
200 * float 'lat' decimal latitude for geolocation
201 * float 'lon' decimal longitude for geolocation
202 * int 'location_id' geoname identifier
203 * int 'location_ns' geoname namespace to interpret location_id
204 * string 'nickname' REQUIRED
205 * string 'password' (may be missing for eg OpenID registrations)
206 * string 'code' invite code
207 * ?string 'uri' permalink to notice; defaults to local notice URL
208 * @return mixed User object or false on failure
210 static function register($fields) {
212 // MAGICALLY put fields into current scope
216 $profile = new Profile();
220 $email = common_canonical_email($email);
223 $nickname = common_canonical_nickname($nickname);
224 $profile->nickname = $nickname;
225 if(! User::allowed_nickname($nickname)){
226 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
230 $profile->profileurl = common_profile_url($nickname);
232 if (!empty($fullname)) {
233 $profile->fullname = $fullname;
235 if (!empty($homepage)) {
236 $profile->homepage = $homepage;
239 $profile->bio = $bio;
241 if (!empty($location)) {
242 $profile->location = $location;
244 $loc = Location::fromName($location);
247 $profile->lat = $loc->lat;
248 $profile->lon = $loc->lon;
249 $profile->location_id = $loc->location_id;
250 $profile->location_ns = $loc->location_ns;
254 $profile->created = common_sql_now();
258 $user->nickname = $nickname;
260 // Users who respond to invite email have proven their ownership of that address
263 $invite = Invitation::staticGet($code);
264 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
265 $user->email = $invite->address;
269 if(isset($email_confirmed) && $email_confirmed) {
270 $user->email = $email;
273 // This flag is ignored but still set to 1
277 // Set default-on options here, otherwise they'll be disabled
278 // initially for sites using caching, since the initial encache
279 // doesn't know about the defaults in the database.
280 $user->emailnotifysub = 1;
281 $user->emailnotifyfav = 1;
282 $user->emailnotifynudge = 1;
283 $user->emailnotifymsg = 1;
284 $user->emailnotifyattn = 1;
285 $user->emailmicroid = 1;
286 $user->emailpost = 1;
287 $user->jabbermicroid = 1;
288 $user->viewdesigns = 1;
290 $user->created = common_sql_now();
292 if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
294 $profile->query('BEGIN');
296 $id = $profile->insert();
299 common_log_db_error($profile, 'INSERT', __FILE__);
308 $user->uri = common_user_uri($user);
311 if (!empty($password)) { // may not have a password for OpenID users
312 $user->password = common_munge_password($password, $id);
315 $result = $user->insert();
318 common_log_db_error($user, 'INSERT', __FILE__);
322 // Everyone gets an inbox
324 $inbox = new Inbox();
326 $inbox->user_id = $user->id;
327 $inbox->notice_ids = '';
329 $result = $inbox->insert();
332 common_log_db_error($inbox, 'INSERT', __FILE__);
336 // Everyone is subscribed to themself
338 $subscription = new Subscription();
339 $subscription->subscriber = $user->id;
340 $subscription->subscribed = $user->id;
341 $subscription->created = $user->created;
343 $result = $subscription->insert();
346 common_log_db_error($subscription, 'INSERT', __FILE__);
350 if (!empty($email) && !$user->email) {
352 $confirm = new Confirm_address();
353 $confirm->code = common_confirmation_code(128);
354 $confirm->user_id = $user->id;
355 $confirm->address = $email;
356 $confirm->address_type = 'email';
358 $result = $confirm->insert();
361 common_log_db_error($confirm, 'INSERT', __FILE__);
366 if (!empty($code) && $user->email) {
367 $user->emailChanged();
370 // Default system subscription
372 $defnick = common_config('newuser', 'default');
374 if (!empty($defnick)) {
375 $defuser = User::staticGet('nickname', $defnick);
376 if (empty($defuser)) {
377 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
380 Subscription::start($user, $defuser);
384 $profile->query('COMMIT');
386 if (!empty($email) && !$user->email) {
387 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
392 $welcome = common_config('newuser', 'welcome');
394 if (!empty($welcome)) {
395 $welcomeuser = User::staticGet('nickname', $welcome);
396 if (empty($welcomeuser)) {
397 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
400 $notice = Notice::saveNew($welcomeuser->id,
401 // TRANS: Notice given on user registration.
402 // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
403 sprintf(_('Welcome to %1$s, @%2$s!'),
404 common_config('site', 'name'),
410 Event::handle('EndUserRegister', array(&$profile, &$user));
416 // Things we do when the email changes
417 function emailChanged()
420 $invites = new Invitation();
421 $invites->address = $this->email;
422 $invites->address_type = 'email';
424 if ($invites->find()) {
425 while ($invites->fetch()) {
426 $other = User::staticGet($invites->user_id);
427 subs_subscribe_to($other, $this);
432 function hasFave($notice)
434 $profile = $this->getProfile();
435 return $profile->hasFave($notice);
438 function mutuallySubscribed($other)
440 $profile = $this->getProfile();
441 return $profile->mutuallySubscribed($other);
444 function mutuallySubscribedUsers()
446 // 3-way join; probably should get cached
447 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
448 $qry = "SELECT $UT.* " .
449 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
450 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
451 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
452 "ORDER BY $UT.nickname";
454 $user->query(sprintf($qry, $this->id, $this->id));
459 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
461 return Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
464 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
465 $profile = $this->getProfile();
466 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
469 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
471 $profile = $this->getProfile();
472 return $profile->getNotices($offset, $limit, $since_id, $before_id);
475 function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
477 return Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
480 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
482 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
485 function noticesWithFriendsThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
487 return Inbox::streamNoticesThreaded($this->id, $offset, $limit, $since_id, $before_id, false);
490 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
492 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
495 function noticeInboxThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
497 return Inbox::streamNoticesThreaded($this->id, $offset, $limit, $since_id, $before_id, true);
500 function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
502 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
505 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
507 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
510 function blowFavesCache()
512 $profile = $this->getProfile();
513 $profile->blowFavesCache();
516 function getSelfTags()
518 return Profile_tag::getTagsArray($this->id, $this->id, $this->id);
521 function setSelfTags($newtags, $privacy)
523 return Profile_tag::setTags($this->id, $this->id, $newtags, $privacy);
526 function block($other)
528 // Add a new block record
530 // no blocking (and thus unsubbing from) yourself
532 if ($this->id == $other->id) {
533 common_log(LOG_WARNING,
535 "Profile ID %d (%s) tried to block themself.",
543 $block = new Profile_block();
545 // Begin a transaction
547 $block->query('BEGIN');
549 $block->blocker = $this->id;
550 $block->blocked = $other->id;
552 $result = $block->insert();
555 common_log_db_error($block, 'INSERT', __FILE__);
559 $self = $this->getProfile();
560 if (Subscription::exists($other, $self)) {
561 Subscription::cancel($other, $self);
563 if (Subscription::exists($self, $other)) {
564 Subscription::cancel($self, $other);
567 $block->query('COMMIT');
572 function unblock($other)
574 // Get the block record
576 $block = Profile_block::get($this->id, $other->id);
582 $result = $block->delete();
585 common_log_db_error($block, 'DELETE', __FILE__);
592 function isMember($group)
594 $profile = $this->getProfile();
595 return $profile->isMember($group);
598 function isAdmin($group)
600 $profile = $this->getProfile();
601 return $profile->isAdmin($group);
604 function getGroups($offset=0, $limit=null)
606 $profile = $this->getProfile();
607 return $profile->getGroups($offset, $limit);
611 * Request to join the given group.
612 * May throw exceptions on failure.
614 * @param User_group $group
615 * @return Group_member
617 function joinGroup(User_group $group)
619 $profile = $this->getProfile();
620 return $profile->joinGroup($group);
624 * Leave a group that this user is a member of.
626 * @param User_group $group
628 function leaveGroup(User_group $group)
630 $profile = $this->getProfile();
631 return $profile->leaveGroup($group);
634 function getSubscriptions($offset=0, $limit=null)
636 $profile = $this->getProfile();
637 return $profile->getSubscriptions($offset, $limit);
640 function getSubscribers($offset=0, $limit=null)
642 $profile = $this->getProfile();
643 return $profile->getSubscribers($offset, $limit);
646 function getTaggedSubscribers($tag, $offset=0, $limit=null)
649 'SELECT profile.* ' .
650 'FROM profile JOIN subscription ' .
651 'ON profile.id = subscription.subscriber ' .
652 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
653 'AND profile_tag.tagger = subscription.subscribed) ' .
654 'WHERE subscription.subscribed = %d ' .
655 "AND profile_tag.tag = '%s' " .
656 'AND subscription.subscribed != subscription.subscriber ' .
657 'ORDER BY subscription.created DESC ';
660 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
663 $profile = new Profile();
665 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
670 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
673 'SELECT profile.* ' .
674 'FROM profile JOIN subscription ' .
675 'ON profile.id = subscription.subscribed ' .
676 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
677 'AND profile_tag.tagger = subscription.subscriber) ' .
678 'WHERE subscription.subscriber = %d ' .
679 "AND profile_tag.tag = '%s' " .
680 'AND subscription.subscribed != subscription.subscriber ' .
681 'ORDER BY subscription.created DESC ';
683 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
685 $profile = new Profile();
687 $profile->query(sprintf($qry, $this->id, $tag));
694 return Design::staticGet('id', $this->design_id);
697 function hasRight($right)
699 $profile = $this->getProfile();
700 return $profile->hasRight($right);
706 $profile = $this->getProfile();
708 } catch (UserNoProfileException $unp) {
709 common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
712 $related = array('Fave',
719 Event::handle('UserDeleteRelated', array($this, &$related));
721 foreach ($related as $cls) {
723 $inst->user_id = $this->id;
727 $this->_deleteTags();
728 $this->_deleteBlocks();
733 function _deleteTags()
735 $tag = new Profile_tag();
736 $tag->tagger = $this->id;
740 function _deleteBlocks()
742 $block = new Profile_block();
743 $block->blocker = $this->id;
745 // XXX delete group block? Reset blocker?
748 function hasRole($name)
750 $profile = $this->getProfile();
751 return $profile->hasRole($name);
754 function grantRole($name)
756 $profile = $this->getProfile();
757 return $profile->grantRole($name);
760 function revokeRole($name)
762 $profile = $this->getProfile();
763 return $profile->revokeRole($name);
766 function isSandboxed()
768 $profile = $this->getProfile();
769 return $profile->isSandboxed();
772 function isSilenced()
774 $profile = $this->getProfile();
775 return $profile->isSilenced();
778 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
780 $stream = new RepeatedByMeNoticeStream($this);
781 return $stream->getNotices($offset, $limit, $since_id, $max_id);
785 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
787 $stream = new RepeatsOfMeNoticeStream($this);
789 return $stream->getNotices($offset, $limit, $since_id, $max_id);
793 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
795 throw new Exception("Not implemented since inbox change.");
798 function shareLocation()
800 $cfg = common_config('location', 'share');
802 if ($cfg == 'always') {
804 } else if ($cfg == 'never') {
809 $prefs = User_location_prefs::staticGet('user_id', $this->id);
812 $share = common_config('location', 'sharedefault');
814 $share = $prefs->share_location;
822 static function siteOwner()
824 $owner = self::cacheGet('user:site_owner');
826 if ($owner === false) { // cache miss
828 $pr = new Profile_role();
830 $pr->role = Profile_role::OWNER;
832 $pr->orderBy('created');
836 if ($pr->find(true)) {
837 $owner = User::staticGet('id', $pr->profile_id);
842 self::cacheSet('user:site_owner', $owner);
849 * Pull the primary site account to use in single-user mode.
850 * If a valid user nickname is listed in 'singleuser':'nickname'
851 * in the config, this will be used; otherwise the site owner
852 * account is taken by default.
855 * @throws ServerException if no valid single user account is present
856 * @throws ServerException if called when not in single-user mode
858 static function singleUser()
860 if (common_config('singleuser', 'enabled')) {
864 $nickname = common_config('singleuser', 'nickname');
866 if (!empty($nickname)) {
867 $user = User::staticGet('nickname', $nickname);
870 // if there was no nickname or no user by that nickname,
871 // try the site owner.
874 $user = User::siteOwner();
880 // TRANS: Server exception.
881 throw new ServerException(_('No single user defined for single-user mode.'));
884 // TRANS: Server exception.
885 throw new ServerException(_('Single-user mode code called when not enabled.'));
890 * This is kind of a hack for using external setup code that's trying to
891 * build single-user sites.
893 * Will still return a username if the config singleuser/nickname is set
894 * even if the account doesn't exist, which normally indicates that the
895 * site is horribly misconfigured.
897 * At the moment, we need to let it through so that router setup can
898 * complete, otherwise we won't be able to create the account.
900 * This will be easier when we can more easily create the account and
901 * *then* switch the site to 1user mode without jumping through hoops.
904 * @throws ServerException if no valid single user account is present
905 * @throws ServerException if called when not in single-user mode
907 static function singleUserNickname()
910 $user = User::singleUser();
911 return $user->nickname;
912 } catch (Exception $e) {
913 if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
914 common_log(LOG_WARN, "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.");
915 return common_config('singleuser', 'nickname');
922 * Find and shorten links in the given text using this user's URL shortening
925 * By default, links will be left untouched if the text is shorter than the
926 * configured maximum notice length. Pass true for the $always parameter
927 * to force all links to be shortened regardless.
929 * Side effects: may save file and file_redirection records for referenced URLs.
931 * @param string $text
932 * @param boolean $always
935 public function shortenLinks($text, $always=false)
937 return common_shorten_links($text, $always, $this);
941 * Get a list of OAuth client applications that have access to this
944 function getConnectedApps($offset = 0, $limit = null)
948 'FROM oauth_application_user u, oauth_application a ' .
949 'WHERE u.profile_id = %d ' .
950 'AND a.id = u.application_id ' .
951 'AND u.access_type > 0 ' .
952 'ORDER BY u.created DESC ';
955 if (common_config('db','type') == 'pgsql') {
956 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
958 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
962 $apps = new Oauth_application_user();
964 $cnt = $apps->query(sprintf($qry, $this->id));