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 // 'update' won't write key columns, so we have to do it ourselves.
95 function updateKeys(&$orig)
99 foreach (array('nickname', 'email', 'incomingemail', 'sms', 'carrier', 'smsemail', 'language', 'timezone') as $k) {
100 if (strcmp($this->$k, $orig->$k) != 0) {
101 $parts[] = $k . ' = ' . $this->_quote($this->$k);
104 if (count($parts) == 0) {
108 $toupdate = implode(', ', $parts);
110 $table = common_database_tablename($this->tableName());
111 $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
112 ' WHERE id = ' . $this->id;
114 $result = $this->query($qry);
122 * Check whether the given nickname is potentially usable, or if it's
123 * excluded by any blacklists on this system.
125 * WARNING: INPUT IS NOT VALIDATED OR NORMALIZED. NON-NORMALIZED INPUT
126 * OR INVALID INPUT MAY LEAD TO FALSE RESULTS.
128 * @param string $nickname
129 * @return boolean true if clear, false if blacklisted
131 static function allowed_nickname($nickname)
133 // XXX: should already be validated for size, content, etc.
134 $blacklist = common_config('nickname', 'blacklist');
136 //all directory and file names should be blacklisted
137 $d = dir(INSTALLDIR);
138 while (false !== ($entry = $d->read())) {
143 //all top level names in the router should be blacklisted
144 $router = Router::get();
145 foreach(array_keys($router->m->getPaths()) as $path){
146 if(preg_match('/^\/(.*?)[\/\?]/',$path,$matches)){
147 $blacklist[]=$matches[1];
150 return !in_array($nickname, $blacklist);
154 * Get the most recent notice posted by this user, if any.
156 * @return mixed Notice or null
158 function getCurrentNotice()
160 $profile = $this->getProfile();
161 return $profile->getCurrentNotice();
164 function getCarrier()
166 return Sms_carrier::staticGet('id', $this->carrier);
170 * @deprecated use Subscription::start($sub, $other);
172 function subscribeTo($other)
174 return Subscription::start($this->getProfile(), $other);
177 function hasBlocked($other)
179 $profile = $this->getProfile();
180 return $profile->hasBlocked($other);
184 * Register a new user account and profile and set up default subscriptions.
185 * If a new-user welcome message is configured, this will be sent.
187 * @param array $fields associative array of optional properties
190 * bool 'email_confirmed' pass true to mark email as pre-confirmed
193 * string 'location' informal string description of geolocation
194 * float 'lat' decimal latitude for geolocation
195 * float 'lon' decimal longitude for geolocation
196 * int 'location_id' geoname identifier
197 * int 'location_ns' geoname namespace to interpret location_id
198 * string 'nickname' REQUIRED
199 * string 'password' (may be missing for eg OpenID registrations)
200 * string 'code' invite code
201 * ?string 'uri' permalink to notice; defaults to local notice URL
202 * @return mixed User object or false on failure
204 static function register($fields) {
206 // MAGICALLY put fields into current scope
210 $profile = new Profile();
214 $email = common_canonical_email($email);
217 $nickname = common_canonical_nickname($nickname);
218 $profile->nickname = $nickname;
219 if(! User::allowed_nickname($nickname)){
220 common_log(LOG_WARNING, sprintf("Attempted to register a nickname that is not allowed: %s", $profile->nickname),
224 $profile->profileurl = common_profile_url($nickname);
226 if (!empty($fullname)) {
227 $profile->fullname = $fullname;
229 if (!empty($homepage)) {
230 $profile->homepage = $homepage;
233 $profile->bio = $bio;
235 if (!empty($location)) {
236 $profile->location = $location;
238 $loc = Location::fromName($location);
241 $profile->lat = $loc->lat;
242 $profile->lon = $loc->lon;
243 $profile->location_id = $loc->location_id;
244 $profile->location_ns = $loc->location_ns;
248 $profile->created = common_sql_now();
252 $user->nickname = $nickname;
254 // Users who respond to invite email have proven their ownership of that address
257 $invite = Invitation::staticGet($code);
258 if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
259 $user->email = $invite->address;
263 if(isset($email_confirmed) && $email_confirmed) {
264 $user->email = $email;
267 // This flag is ignored but still set to 1
271 // Set default-on options here, otherwise they'll be disabled
272 // initially for sites using caching, since the initial encache
273 // doesn't know about the defaults in the database.
274 $user->emailnotifysub = 1;
275 $user->emailnotifyfav = 1;
276 $user->emailnotifynudge = 1;
277 $user->emailnotifymsg = 1;
278 $user->emailnotifyattn = 1;
279 $user->emailmicroid = 1;
280 $user->emailpost = 1;
281 $user->jabbermicroid = 1;
282 $user->viewdesigns = 1;
284 $user->created = common_sql_now();
286 if (Event::handle('StartUserRegister', array(&$user, &$profile))) {
288 $profile->query('BEGIN');
290 $id = $profile->insert();
293 common_log_db_error($profile, 'INSERT', __FILE__);
302 $user->uri = common_user_uri($user);
305 if (!empty($password)) { // may not have a password for OpenID users
306 $user->password = common_munge_password($password, $id);
309 $result = $user->insert();
312 common_log_db_error($user, 'INSERT', __FILE__);
316 // Everyone gets an inbox
318 $inbox = new Inbox();
320 $inbox->user_id = $user->id;
321 $inbox->notice_ids = '';
323 $result = $inbox->insert();
326 common_log_db_error($inbox, 'INSERT', __FILE__);
330 // Everyone is subscribed to themself
332 $subscription = new Subscription();
333 $subscription->subscriber = $user->id;
334 $subscription->subscribed = $user->id;
335 $subscription->created = $user->created;
337 $result = $subscription->insert();
340 common_log_db_error($subscription, 'INSERT', __FILE__);
344 if (!empty($email) && !$user->email) {
346 $confirm = new Confirm_address();
347 $confirm->code = common_confirmation_code(128);
348 $confirm->user_id = $user->id;
349 $confirm->address = $email;
350 $confirm->address_type = 'email';
352 $result = $confirm->insert();
355 common_log_db_error($confirm, 'INSERT', __FILE__);
360 if (!empty($code) && $user->email) {
361 $user->emailChanged();
364 // Default system subscription
366 $defnick = common_config('newuser', 'default');
368 if (!empty($defnick)) {
369 $defuser = User::staticGet('nickname', $defnick);
370 if (empty($defuser)) {
371 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
374 Subscription::start($user, $defuser);
378 $profile->query('COMMIT');
380 if (!empty($email) && !$user->email) {
381 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
386 $welcome = common_config('newuser', 'welcome');
388 if (!empty($welcome)) {
389 $welcomeuser = User::staticGet('nickname', $welcome);
390 if (empty($welcomeuser)) {
391 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
394 $notice = Notice::saveNew($welcomeuser->id,
395 // TRANS: Notice given on user registration.
396 // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
397 sprintf(_('Welcome to %1$s, @%2$s!'),
398 common_config('site', 'name'),
404 Event::handle('EndUserRegister', array(&$profile, &$user));
410 // Things we do when the email changes
411 function emailChanged()
414 $invites = new Invitation();
415 $invites->address = $this->email;
416 $invites->address_type = 'email';
418 if ($invites->find()) {
419 while ($invites->fetch()) {
420 $other = User::staticGet($invites->user_id);
421 subs_subscribe_to($other, $this);
426 function hasFave($notice)
428 $profile = $this->getProfile();
429 return $profile->hasFave($notice);
432 function mutuallySubscribed($other)
434 $profile = $this->getProfile();
435 return $profile->mutuallySubscribed($other);
438 function mutuallySubscribedUsers()
440 // 3-way join; probably should get cached
441 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
442 $qry = "SELECT $UT.* " .
443 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
444 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
445 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
446 "ORDER BY $UT.nickname";
448 $user->query(sprintf($qry, $this->id, $this->id));
453 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
455 return Reply::stream($this->id, $offset, $limit, $since_id, $before_id);
458 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
459 $profile = $this->getProfile();
460 return $profile->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
463 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
465 $profile = $this->getProfile();
466 return $profile->getNotices($offset, $limit, $since_id, $before_id);
469 function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
471 return Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
474 function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
476 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
479 function noticesWithFriendsThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
481 return Inbox::streamNoticesThreaded($this->id, $offset, $limit, $since_id, $before_id, false);
484 function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
486 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
489 function noticeInboxThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
491 return Inbox::streamNoticesThreaded($this->id, $offset, $limit, $since_id, $before_id, true);
494 function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
496 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, false);
499 function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
501 return Inbox::streamNotices($this->id, $offset, $limit, $since_id, $before_id, true);
504 function blowFavesCache()
506 $profile = $this->getProfile();
507 $profile->blowFavesCache();
510 function getSelfTags()
512 return Profile_tag::getTags($this->id, $this->id);
515 function setSelfTags($newtags)
517 return Profile_tag::setTags($this->id, $this->id, $newtags);
520 function block($other)
522 // Add a new block record
524 // no blocking (and thus unsubbing from) yourself
526 if ($this->id == $other->id) {
527 common_log(LOG_WARNING,
529 "Profile ID %d (%s) tried to block themself.",
537 $block = new Profile_block();
539 // Begin a transaction
541 $block->query('BEGIN');
543 $block->blocker = $this->id;
544 $block->blocked = $other->id;
546 $result = $block->insert();
549 common_log_db_error($block, 'INSERT', __FILE__);
553 $self = $this->getProfile();
554 if (Subscription::exists($other, $self)) {
555 Subscription::cancel($other, $self);
557 if (Subscription::exists($self, $other)) {
558 Subscription::cancel($self, $other);
561 $block->query('COMMIT');
566 function unblock($other)
568 // Get the block record
570 $block = Profile_block::get($this->id, $other->id);
576 $result = $block->delete();
579 common_log_db_error($block, 'DELETE', __FILE__);
586 function isMember($group)
588 $profile = $this->getProfile();
589 return $profile->isMember($group);
592 function isAdmin($group)
594 $profile = $this->getProfile();
595 return $profile->isAdmin($group);
598 function getGroups($offset=0, $limit=null)
600 $profile = $this->getProfile();
601 return $profile->getGroups($offset, $limit);
605 * Request to join the given group.
606 * May throw exceptions on failure.
608 * @param User_group $group
609 * @return Group_member
611 function joinGroup(User_group $group)
613 $profile = $this->getProfile();
614 return $profile->joinGroup($group);
618 * Leave a group that this user is a member of.
620 * @param User_group $group
622 function leaveGroup(User_group $group)
624 $profile = $this->getProfile();
625 return $profile->leaveGroup($group);
628 function getSubscriptions($offset=0, $limit=null)
630 $profile = $this->getProfile();
631 return $profile->getSubscriptions($offset, $limit);
634 function getSubscribers($offset=0, $limit=null)
636 $profile = $this->getProfile();
637 return $profile->getSubscribers($offset, $limit);
640 function getTaggedSubscribers($tag, $offset=0, $limit=null)
643 'SELECT profile.* ' .
644 'FROM profile JOIN subscription ' .
645 'ON profile.id = subscription.subscriber ' .
646 'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
647 'AND profile_tag.tagger = subscription.subscribed) ' .
648 'WHERE subscription.subscribed = %d ' .
649 "AND profile_tag.tag = '%s' " .
650 'AND subscription.subscribed != subscription.subscriber ' .
651 'ORDER BY subscription.created DESC ';
654 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
657 $profile = new Profile();
659 $cnt = $profile->query(sprintf($qry, $this->id, $tag));
664 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
667 'SELECT profile.* ' .
668 'FROM profile JOIN subscription ' .
669 'ON profile.id = subscription.subscribed ' .
670 'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
671 'AND profile_tag.tagger = subscription.subscriber) ' .
672 'WHERE subscription.subscriber = %d ' .
673 "AND profile_tag.tag = '%s' " .
674 'AND subscription.subscribed != subscription.subscriber ' .
675 'ORDER BY subscription.created DESC ';
677 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
679 $profile = new Profile();
681 $profile->query(sprintf($qry, $this->id, $tag));
688 return Design::staticGet('id', $this->design_id);
691 function hasRight($right)
693 $profile = $this->getProfile();
694 return $profile->hasRight($right);
700 $profile = $this->getProfile();
702 } catch (UserNoProfileException $unp) {
703 common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
706 $related = array('Fave',
713 Event::handle('UserDeleteRelated', array($this, &$related));
715 foreach ($related as $cls) {
717 $inst->user_id = $this->id;
721 $this->_deleteTags();
722 $this->_deleteBlocks();
727 function _deleteTags()
729 $tag = new Profile_tag();
730 $tag->tagger = $this->id;
734 function _deleteBlocks()
736 $block = new Profile_block();
737 $block->blocker = $this->id;
739 // XXX delete group block? Reset blocker?
742 function hasRole($name)
744 $profile = $this->getProfile();
745 return $profile->hasRole($name);
748 function grantRole($name)
750 $profile = $this->getProfile();
751 return $profile->grantRole($name);
754 function revokeRole($name)
756 $profile = $this->getProfile();
757 return $profile->revokeRole($name);
760 function isSandboxed()
762 $profile = $this->getProfile();
763 return $profile->isSandboxed();
766 function isSilenced()
768 $profile = $this->getProfile();
769 return $profile->isSilenced();
772 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
774 $stream = new RepeatedByMeNoticeStream($this);
775 return $stream->getNotices($offset, $limit, $since_id, $max_id);
779 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
781 $stream = new RepeatsOfMeNoticeStream($this);
783 return $stream->getNotices($offset, $limit, $since_id, $max_id);
787 function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
789 throw new Exception("Not implemented since inbox change.");
792 function shareLocation()
794 $cfg = common_config('location', 'share');
796 if ($cfg == 'always') {
798 } else if ($cfg == 'never') {
803 $prefs = User_location_prefs::staticGet('user_id', $this->id);
806 $share = common_config('location', 'sharedefault');
808 $share = $prefs->share_location;
816 static function siteOwner()
818 $owner = self::cacheGet('user:site_owner');
820 if ($owner === false) { // cache miss
822 $pr = new Profile_role();
824 $pr->role = Profile_role::OWNER;
826 $pr->orderBy('created');
830 if ($pr->find(true)) {
831 $owner = User::staticGet('id', $pr->profile_id);
836 self::cacheSet('user:site_owner', $owner);
843 * Pull the primary site account to use in single-user mode.
844 * If a valid user nickname is listed in 'singleuser':'nickname'
845 * in the config, this will be used; otherwise the site owner
846 * account is taken by default.
849 * @throws ServerException if no valid single user account is present
850 * @throws ServerException if called when not in single-user mode
852 static function singleUser()
854 if (common_config('singleuser', 'enabled')) {
858 $nickname = common_config('singleuser', 'nickname');
860 if (!empty($nickname)) {
861 $user = User::staticGet('nickname', $nickname);
864 // if there was no nickname or no user by that nickname,
865 // try the site owner.
868 $user = User::siteOwner();
874 // TRANS: Server exception.
875 throw new ServerException(_('No single user defined for single-user mode.'));
878 // TRANS: Server exception.
879 throw new ServerException(_('Single-user mode code called when not enabled.'));
884 * This is kind of a hack for using external setup code that's trying to
885 * build single-user sites.
887 * Will still return a username if the config singleuser/nickname is set
888 * even if the account doesn't exist, which normally indicates that the
889 * site is horribly misconfigured.
891 * At the moment, we need to let it through so that router setup can
892 * complete, otherwise we won't be able to create the account.
894 * This will be easier when we can more easily create the account and
895 * *then* switch the site to 1user mode without jumping through hoops.
898 * @throws ServerException if no valid single user account is present
899 * @throws ServerException if called when not in single-user mode
901 static function singleUserNickname()
904 $user = User::singleUser();
905 return $user->nickname;
906 } catch (Exception $e) {
907 if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
908 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.");
909 return common_config('singleuser', 'nickname');
916 * Find and shorten links in the given text using this user's URL shortening
919 * By default, links will be left untouched if the text is shorter than the
920 * configured maximum notice length. Pass true for the $always parameter
921 * to force all links to be shortened regardless.
923 * Side effects: may save file and file_redirection records for referenced URLs.
925 * @param string $text
926 * @param boolean $always
929 public function shortenLinks($text, $always=false)
931 return common_shorten_links($text, $always, $this);
935 * Get a list of OAuth client applications that have access to this
938 function getConnectedApps($offset = 0, $limit = null)
942 'FROM oauth_application_user u, oauth_application a ' .
943 'WHERE u.profile_id = %d ' .
944 'AND a.id = u.application_id ' .
945 'AND u.access_type > 0 ' .
946 'ORDER BY u.created DESC ';
949 if (common_config('db','type') == 'pgsql') {
950 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
952 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
956 $apps = new Oauth_application_user();
958 $cnt = $apps->query(sprintf($qry, $this->id));