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('GNUSOCIAL')) { exit(1); }
23 * Table Definition for user
26 class User extends Managed_DataObject
28 const SUBSCRIBE_POLICY_OPEN = 0;
29 const SUBSCRIBE_POLICY_MODERATE = 1;
32 /* the code below is auto generated do not remove the above tag */
34 public $__table = 'user'; // table name
35 public $id; // int(4) primary_key not_null
36 public $nickname; // varchar(64) unique_key
37 public $password; // varchar(191) not 255 because utf8mb4 takes more space
38 public $email; // varchar(191) unique_key not 255 because utf8mb4 takes more space
39 public $incomingemail; // varchar(191) unique_key not 255 because utf8mb4 takes more space
40 public $emailnotifysub; // tinyint(1) default_1
41 public $emailnotifyfav; // tinyint(1) default_1
42 public $emailnotifynudge; // tinyint(1) default_1
43 public $emailnotifymsg; // tinyint(1) default_1
44 public $emailnotifyattn; // tinyint(1) default_1
45 public $language; // varchar(50)
46 public $timezone; // varchar(50)
47 public $emailpost; // tinyint(1) default_1
48 public $sms; // varchar(64) unique_key
49 public $carrier; // int(4)
50 public $smsnotify; // tinyint(1)
51 public $smsreplies; // tinyint(1)
52 public $smsemail; // varchar(191) not 255 because utf8mb4 takes more space
53 public $uri; // varchar(191) unique_key not 255 because utf8mb4 takes more space
54 public $autosubscribe; // tinyint(1)
55 public $subscribe_policy; // tinyint(1)
56 public $urlshorteningservice; // varchar(50) default_ur1.ca
57 public $private_stream; // tinyint(1) default_0
58 public $created; // datetime() not_null
59 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
61 /* the code above is auto generated do not remove the tag below */
64 public static function schemaDef()
67 'description' => 'local users',
69 'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'),
70 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname or username, duped in profile'),
71 'password' => array('type' => 'varchar', 'length' => 191, 'description' => 'salted password, can be null for OpenID users'),
72 'email' => array('type' => 'varchar', 'length' => 191, 'description' => 'email address for password recovery etc.'),
73 'incomingemail' => array('type' => 'varchar', 'length' => 191, 'description' => 'email address for post-by-email'),
74 'emailnotifysub' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of subscriptions'),
75 'emailnotifyfav' => array('type' => 'int', 'size' => 'tiny', 'default' => null, 'description' => 'Notify by email of favorites'),
76 'emailnotifynudge' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of nudges'),
77 'emailnotifymsg' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of direct messages'),
78 'emailnotifyattn' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of @-replies'),
79 'language' => array('type' => 'varchar', 'length' => 50, 'description' => 'preferred language'),
80 'timezone' => array('type' => 'varchar', 'length' => 50, 'description' => 'timezone'),
81 'emailpost' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Post by email'),
82 'sms' => array('type' => 'varchar', 'length' => 64, 'description' => 'sms phone number'),
83 'carrier' => array('type' => 'int', 'description' => 'foreign key to sms_carrier'),
84 'smsnotify' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS'),
85 'smsreplies' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS on replies'),
86 'smsemail' => array('type' => 'varchar', 'length' => 191, 'description' => 'built from sms and carrier'),
87 'uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'universally unique identifier, usually a tag URI'),
88 'autosubscribe' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'automatically subscribe to users who subscribe to us'),
89 'subscribe_policy' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => '0 = anybody can subscribe; 1 = require approval'),
90 'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'),
91 'private_stream' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to limit all notices to followers only'),
93 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
94 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
96 'primary key' => array('id'),
97 'unique keys' => array(
98 'user_nickname_key' => array('nickname'),
99 'user_email_key' => array('email'),
100 'user_incomingemail_key' => array('incomingemail'),
101 'user_sms_key' => array('sms'),
102 'user_uri_key' => array('uri'),
104 'foreign keys' => array(
105 'user_id_fkey' => array('profile', array('id' => 'id')),
106 'user_carrier_fkey' => array('sms_carrier', array('carrier' => 'id')),
109 'user_smsemail_idx' => array('smsemail'),
114 protected $_profile = array();
119 * @throws UserNoProfileException if user has no profile
121 public function getProfile()
123 if (!isset($this->_profile[$this->id])) {
124 $profile = Profile::getKV('id', $this->id);
125 if (!$profile instanceof Profile) {
126 throw new UserNoProfileException($this);
128 $this->_profile[$this->id] = $profile;
130 return $this->_profile[$this->id];
133 public function sameAs(Profile $other)
135 return $this->getProfile()->sameAs($other);
138 public function getUri()
143 static function getByUri($uri)
147 if (!$user->find(true)) {
148 throw new NoResultException($user);
153 public function getNickname()
155 return $this->getProfile()->getNickname();
158 static function getByNickname($nickname)
160 $user = User::getKV('nickname', $nickname);
161 if (!$user instanceof User) {
162 throw new NoSuchUserException(array('nickname' => $nickname));
168 function isSubscribed(Profile $other)
170 return $this->getProfile()->isSubscribed($other);
173 function hasPendingSubscription(Profile $other)
175 return $this->getProfile()->hasPendingSubscription($other);
179 * Get the most recent notice posted by this user, if any.
181 * @return mixed Notice or null
183 function getCurrentNotice()
185 return $this->getProfile()->getCurrentNotice();
188 function getCarrier()
190 return Sms_carrier::getKV('id', $this->carrier);
193 function hasBlocked(Profile $other)
195 return $this->getProfile()->hasBlocked($other);
199 * Register a new user account and profile and set up default subscriptions.
200 * If a new-user welcome message is configured, this will be sent.
202 * @param array $fields associative array of optional properties
205 * bool 'email_confirmed' pass true to mark email as pre-confirmed
208 * string 'location' informal string description of geolocation
209 * float 'lat' decimal latitude for geolocation
210 * float 'lon' decimal longitude for geolocation
211 * int 'location_id' geoname identifier
212 * int 'location_ns' geoname namespace to interpret location_id
213 * string 'nickname' REQUIRED
214 * string 'password' (may be missing for eg OpenID registrations)
215 * string 'code' invite code
216 * ?string 'uri' permalink to notice; defaults to local notice URL
217 * @return User object
218 * @throws Exception on failure
220 static function register(array $fields, $accept_email_fail=false) {
222 // MAGICALLY put fields into current scope
226 $profile = new Profile();
228 if (!empty($email)) {
229 $email = common_canonical_email($email);
232 // Normalize _and_ check whether it is in use. Throw NicknameException on failure.
233 $profile->nickname = Nickname::normalize($nickname, true);
235 $profile->profileurl = common_profile_url($profile->nickname);
237 if (!empty($fullname)) {
238 $profile->fullname = $fullname;
240 if (!empty($homepage)) {
241 $profile->homepage = $homepage;
244 $profile->bio = $bio;
246 if (!empty($location)) {
247 $profile->location = $location;
249 $loc = Location::fromName($location);
252 $profile->lat = $loc->lat;
253 $profile->lon = $loc->lon;
254 $profile->location_id = $loc->location_id;
255 $profile->location_ns = $loc->location_ns;
259 $profile->created = common_sql_now();
263 $user->nickname = $profile->nickname;
267 // Users who respond to invite email have proven their ownership of that address
270 $invite = Invitation::getKV($code);
271 if ($invite instanceof Invitation && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
272 $user->email = $invite->address;
276 if(isset($email_confirmed) && $email_confirmed) {
277 $user->email = $email;
280 // Set default-on options here, otherwise they'll be disabled
281 // initially for sites using caching, since the initial encache
282 // doesn't know about the defaults in the database.
283 $user->emailnotifysub = 1;
284 $user->emailnotifynudge = 1;
285 $user->emailnotifymsg = 1;
286 $user->emailnotifyattn = 1;
287 $user->emailpost = 1;
289 $user->created = common_sql_now();
291 if (Event::handle('StartUserRegister', array($profile))) {
293 $profile->query('BEGIN');
295 $id = $profile->insert();
297 common_log_db_error($profile, 'INSERT', __FILE__);
298 $profile->query('ROLLBACK');
299 // TRANS: Profile data could not be inserted for some reason.
300 throw new ServerException(_m('Could not insert profile data for new user.'));
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);
315 $result = $user->insert();
317 if ($result === false) {
318 common_log_db_error($user, 'INSERT', __FILE__);
319 $profile->query('ROLLBACK');
320 // TRANS: User data could not be inserted for some reason.
321 throw new ServerException(_m('Could not insert user data for new user.'));
324 // Everyone is subscribed to themself
326 $subscription = new Subscription();
327 $subscription->subscriber = $user->id;
328 $subscription->subscribed = $user->id;
329 $subscription->created = $user->created;
331 $result = $subscription->insert();
334 common_log_db_error($subscription, 'INSERT', __FILE__);
335 $profile->query('ROLLBACK');
336 // TRANS: Subscription data could not be inserted for some reason.
337 throw new ServerException(_m('Could not insert subscription data for new user.'));
340 // Mark that this invite was converted
342 if (!empty($invite)) {
343 $invite->convert($user);
346 if (!empty($email) && empty($user->email)) {
347 // The actual email will be sent further down, after the database COMMIT
349 $confirm = new Confirm_address();
350 $confirm->code = common_confirmation_code(128);
351 $confirm->user_id = $user->id;
352 $confirm->address = $email;
353 $confirm->address_type = 'email';
355 $result = $confirm->insert();
357 if ($result===false) {
358 common_log_db_error($confirm, 'INSERT', __FILE__);
359 $profile->query('ROLLBACK');
360 // TRANS: Email confirmation data could not be inserted for some reason.
361 throw new ServerException(_m('Could not insert email confirmation data for new user.'));
365 if (!empty($code) && $user->email) {
366 $user->emailChanged();
369 // Default system subscription
371 $defnick = common_config('newuser', 'default');
373 if (!empty($defnick)) {
374 $defuser = User::getKV('nickname', $defnick);
375 if (empty($defuser)) {
376 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
379 Subscription::ensureStart($profile, $defuser->getProfile());
383 $profile->query('COMMIT');
385 if (!empty($email) && empty($user->email)) {
387 $confirm->sendConfirmation();
388 } catch (EmailException $e) {
389 common_log(LOG_ERR, "Could not send user registration email for user id=={$profile->getID()}: {$e->getMessage()}");
390 if (!$accept_email_fail) {
398 $welcome = common_config('newuser', 'welcome');
400 if (!empty($welcome)) {
401 $welcomeuser = User::getKV('nickname', $welcome);
402 if (empty($welcomeuser)) {
403 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
406 $notice = Notice::saveNew($welcomeuser->id,
407 // TRANS: Notice given on user registration.
408 // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
409 sprintf(_('Welcome to %1$s, @%2$s!'),
410 common_config('site', 'name'),
411 $profile->getNickname()),
416 Event::handle('EndUserRegister', array($profile));
419 if (!$user instanceof User || empty($user->id)) {
420 throw new ServerException('User could not be registered. Probably an event hook that failed.');
426 // Things we do when the email changes
427 function emailChanged()
430 $invites = new Invitation();
431 $invites->address = $this->email;
432 $invites->address_type = 'email';
434 if ($invites->find()) {
435 while ($invites->fetch()) {
437 $other = Profile::getByID($invites->user_id);
438 Subscription::start($other, $this->getProfile());
439 } catch (NoResultException $e) {
440 // profile did not exist
441 } catch (AlreadyFulfilledException $e) {
442 // already subscribed to this profile
443 } catch (Exception $e) {
444 common_log(LOG_ERR, 'On-invitation-completion subscription failed when subscribing '._ve($invites->user_id).' to '.$this->getProfile()->getID().': '._ve($e->getMessage()));
450 function mutuallySubscribed(Profile $other)
452 return $this->getProfile()->mutuallySubscribed($other);
455 function mutuallySubscribedUsers()
457 // 3-way join; probably should get cached
458 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
459 $qry = "SELECT $UT.* " .
460 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
461 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
462 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
463 "ORDER BY $UT.nickname";
465 $user->query(sprintf($qry, $this->id, $this->id));
470 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
472 return $this->getProfile()->getReplies($offset, $limit, $since_id, $before_id);
475 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
476 return $this->getProfile()->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
479 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
481 return $this->getProfile()->getNotices($offset, $limit, $since_id, $before_id);
484 function block(Profile $other)
486 // Add a new block record
488 // no blocking (and thus unsubbing from) yourself
490 if ($this->id == $other->id) {
491 common_log(LOG_WARNING,
493 "Profile ID %d (%s) tried to block themself.",
501 $block = new Profile_block();
503 // Begin a transaction
505 $block->query('BEGIN');
507 $block->blocker = $this->id;
508 $block->blocked = $other->id;
510 $result = $block->insert();
513 common_log_db_error($block, 'INSERT', __FILE__);
517 $self = $this->getProfile();
518 if (Subscription::exists($other, $self)) {
519 Subscription::cancel($other, $self);
521 if (Subscription::exists($self, $other)) {
522 Subscription::cancel($self, $other);
525 $block->query('COMMIT');
530 function unblock(Profile $other)
532 // Get the block record
534 $block = Profile_block::exists($this->getProfile(), $other);
540 $result = $block->delete();
543 common_log_db_error($block, 'DELETE', __FILE__);
550 function isMember(User_group $group)
552 return $this->getProfile()->isMember($group);
555 function isAdmin(User_group $group)
557 return $this->getProfile()->isAdmin($group);
560 function getGroups($offset=0, $limit=null)
562 return $this->getProfile()->getGroups($offset, $limit);
566 * Request to join the given group.
567 * May throw exceptions on failure.
569 * @param User_group $group
570 * @return Group_member
572 function joinGroup(User_group $group)
574 return $this->getProfile()->joinGroup($group);
578 * Leave a group that this user is a member of.
580 * @param User_group $group
582 function leaveGroup(User_group $group)
584 return $this->getProfile()->leaveGroup($group);
587 function getSubscribed($offset=0, $limit=null)
589 return $this->getProfile()->getSubscribed($offset, $limit);
592 function getSubscribers($offset=0, $limit=null)
594 return $this->getProfile()->getSubscribers($offset, $limit);
597 function getTaggedSubscribers($tag, $offset=0, $limit=null)
599 return $this->getProfile()->getTaggedSubscribers($tag, $offset, $limit);
602 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
604 return $this->getProfile()->getTaggedSubscriptions($tag, $offset, $limit);
607 function hasRight($right)
609 return $this->getProfile()->hasRight($right);
612 function delete($useWhere=false)
614 if (empty($this->id)) {
615 common_log(LOG_WARNING, "Ambiguous User->delete(); skipping related tables.");
616 return parent::delete($useWhere);
620 if (!$this->hasRole(Profile_role::DELETED)) {
621 $profile = $this->getProfile();
624 } catch (UserNoProfileException $unp) {
625 common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
635 Event::handle('UserDeleteRelated', array($this, &$related));
637 foreach ($related as $cls) {
639 $inst->user_id = $this->id;
643 $this->_deleteTags();
644 $this->_deleteBlocks();
646 return parent::delete($useWhere);
649 function _deleteTags()
651 $tag = new Profile_tag();
652 $tag->tagger = $this->id;
656 function _deleteBlocks()
658 $block = new Profile_block();
659 $block->blocker = $this->id;
661 // XXX delete group block? Reset blocker?
664 function hasRole($name)
666 return $this->getProfile()->hasRole($name);
669 function grantRole($name)
671 return $this->getProfile()->grantRole($name);
674 function revokeRole($name)
676 return $this->getProfile()->revokeRole($name);
679 function isSandboxed()
681 return $this->getProfile()->isSandboxed();
684 function isSilenced()
686 return $this->getProfile()->isSilenced();
689 function receivesEmailNotifications()
691 // We could do this in one large if statement, but that's not as easy to read
692 // Don't send notifications if we don't know the user's email address or it is
693 // explicitly undesired by the user's own settings.
694 if (empty($this->email) || !$this->emailnotifyattn) {
697 // Don't send notifications to a user who is sandboxed or silenced
698 if ($this->isSandboxed() || $this->isSilenced()) {
704 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
706 // FIXME: Use another way to get Profile::current() since we
707 // want to avoid confusion between session user and queue processing.
708 $stream = new RepeatedByMeNoticeStream($this->getProfile(), Profile::current());
709 return $stream->getNotices($offset, $limit, $since_id, $max_id);
713 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
715 // FIXME: Use another way to get Profile::current() since we
716 // want to avoid confusion between session user and queue processing.
717 $stream = new RepeatsOfMeNoticeStream($this->getProfile(), Profile::current());
718 return $stream->getNotices($offset, $limit, $since_id, $max_id);
721 public function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
723 return $this->getProfile()->repeatedToMe($offset, $limit, $since_id, $max_id);
726 public static function siteOwner()
728 $owner = self::cacheGet('user:site_owner');
730 if ($owner === false) { // cache miss
732 $pr = new Profile_role();
733 $pr->role = Profile_role::OWNER;
734 $pr->orderBy('created');
737 if (!$pr->find(true)) {
738 throw new NoResultException($pr);
741 $owner = User::getKV('id', $pr->profile_id);
743 self::cacheSet('user:site_owner', $owner);
746 if ($owner instanceof User) {
750 throw new ServerException(_('No site owner configured.'));
754 * Pull the primary site account to use in single-user mode.
755 * If a valid user nickname is listed in 'singleuser':'nickname'
756 * in the config, this will be used; otherwise the site owner
757 * account is taken by default.
760 * @throws ServerException if no valid single user account is present
761 * @throws ServerException if called when not in single-user mode
763 public static function singleUser()
765 if (!common_config('singleuser', 'enabled')) {
766 // TRANS: Server exception.
767 throw new ServerException(_('Single-user mode code called when not enabled.'));
770 if ($nickname = common_config('singleuser', 'nickname')) {
771 $user = User::getKV('nickname', $nickname);
772 if ($user instanceof User) {
777 // If there was no nickname or no user by that nickname,
778 // try the site owner. Throws exception if not configured.
779 return User::siteOwner();
783 * This is kind of a hack for using external setup code that's trying to
784 * build single-user sites.
786 * Will still return a username if the config singleuser/nickname is set
787 * even if the account doesn't exist, which normally indicates that the
788 * site is horribly misconfigured.
790 * At the moment, we need to let it through so that router setup can
791 * complete, otherwise we won't be able to create the account.
793 * This will be easier when we can more easily create the account and
794 * *then* switch the site to 1user mode without jumping through hoops.
797 * @throws ServerException if no valid single user account is present
798 * @throws ServerException if called when not in single-user mode
800 static function singleUserNickname()
803 $user = User::singleUser();
804 return $user->nickname;
805 } catch (Exception $e) {
806 if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
807 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.");
808 return common_config('singleuser', 'nickname');
815 * Find and shorten links in the given text using this user's URL shortening
818 * By default, links will be left untouched if the text is shorter than the
819 * configured maximum notice length. Pass true for the $always parameter
820 * to force all links to be shortened regardless.
822 * Side effects: may save file and file_redirection records for referenced URLs.
824 * @param string $text
825 * @param boolean $always
828 public function shortenLinks($text, $always=false)
830 return common_shorten_links($text, $always, $this);
834 * Get a list of OAuth client applications that have access to this
837 function getConnectedApps($offset = 0, $limit = null)
841 'FROM oauth_application_user u, oauth_application a ' .
842 'WHERE u.profile_id = %d ' .
843 'AND a.id = u.application_id ' .
844 'AND u.access_type > 0 ' .
845 'ORDER BY u.created DESC ';
848 if (common_config('db','type') == 'pgsql') {
849 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
851 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
855 $apps = new Oauth_application_user();
857 $cnt = $apps->query(sprintf($qry, $this->id));
863 * Magic function called at serialize() time.
865 * We use this to drop a couple process-specific references
866 * from DB_DataObject which can cause trouble in future
869 * @return array of variable names to include in serialization.
874 $vars = parent::__sleep();
875 $skip = array('_profile');
876 return array_diff($vars, $skip);
879 static function recoverPassword($nore)
881 require_once(INSTALLDIR . '/lib/mail.php');
883 // $confirm_email will be used as a fallback if our user doesn't have a confirmed email
884 $confirm_email = null;
886 if (common_is_email($nore)) {
887 $user = User::getKV('email', common_canonical_email($nore));
889 // See if it's an unconfirmed email address
890 if (!$user instanceof User) {
891 // Warning: it may actually be legit to have multiple folks
892 // who have claimed, but not yet confirmed, the same address.
893 // We'll only send to the first one that comes up.
894 $confirm_email = new Confirm_address();
895 $confirm_email->address = common_canonical_email($nore);
896 $confirm_email->address_type = 'email';
897 if ($confirm_email->find(true)) {
898 $user = User::getKV('id', $confirm_email->user_id);
902 // No luck finding anyone by that email address.
903 if (!$user instanceof User) {
904 if (common_config('site', 'fakeaddressrecovery')) {
905 // Return without actually doing anything! We fake address recovery
906 // to avoid revealing which email addresses are registered with the site.
909 // TRANS: Information on password recovery form if no known e-mail address was specified.
910 throw new ClientException(_('No user with that email address exists here.'));
913 // This might throw a NicknameException on bad nicknames
914 $user = User::getKV('nickname', common_canonical_nickname($nore));
915 if (!$user instanceof User) {
916 // TRANS: Information on password recovery form if no known username was specified.
917 throw new ClientException(_('No user with that nickname exists here.'));
921 // Try to get an unconfirmed email address if they used a user name
922 if (empty($user->email) && $confirm_email === null) {
923 $confirm_email = new Confirm_address();
924 $confirm_email->user_id = $user->id;
925 $confirm_email->address_type = 'email';
926 $confirm_email->find();
927 if (!$confirm_email->fetch()) {
928 // Nothing found, so let's reset it to null
929 $confirm_email = null;
933 if (empty($user->email) && !$confirm_email instanceof Confirm_address) {
934 // TRANS: Client error displayed on password recovery form if a user does not have a registered e-mail address.
935 throw new ClientException(_('No registered email address for that user.'));
938 // Success! We have a valid user and a confirmed or unconfirmed email address
940 $confirm = new Confirm_address();
941 $confirm->code = common_confirmation_code(128);
942 $confirm->address_type = 'recover';
943 $confirm->user_id = $user->id;
944 $confirm->address = $user->email ?: $confirm_email->address;
946 if (!$confirm->insert()) {
947 common_log_db_error($confirm, 'INSERT', __FILE__);
948 // TRANS: Server error displayed if e-mail address confirmation fails in the database on the password recovery form.
949 throw new ServerException(_('Error saving address confirmation.'));
952 // @todo FIXME: needs i18n.
953 $body = "Hey, $user->nickname.";
955 $body .= 'Someone just asked for a new password ' .
956 'for this account on ' . common_config('site', 'name') . '.';
958 $body .= 'If it was you, and you want to confirm, use the URL below:';
960 $body .= "\t".common_local_url('recoverpassword',
961 array('code' => $confirm->code));
963 $body .= 'If not, just ignore this message.';
965 $body .= 'Thanks for your time, ';
967 $body .= common_config('site', 'name');
970 $headers = _mail_prepare_headers('recoverpassword', $user->nickname, $user->nickname);
971 // TRANS: Subject for password recovery e-mail.
972 mail_to_user($user, _('Password recovery requested'), $body, $headers, $confirm->address);
975 function streamModeOnly()
977 if (common_config('oldschool', 'enabled')) {
978 $osp = Old_school_prefs::getKV('user_id', $this->id);
980 return $osp->stream_mode_only;
987 function streamNicknames()
989 if (common_config('oldschool', 'enabled')) {
990 $osp = Old_school_prefs::getKV('user_id', $this->id);
992 return $osp->stream_nicknames;
998 function registrationActivity()
1000 $profile = $this->getProfile();
1002 $service = new ActivityObject();
1004 $service->type = ActivityObject::SERVICE;
1005 $service->title = common_config('site', 'name');
1006 $service->link = common_root_url();
1007 $service->id = $service->link;
1009 $act = new Activity();
1011 $act->actor = $profile->asActivityObject();
1012 $act->verb = ActivityVerb::JOIN;
1014 $act->objects[] = $service;
1016 $act->id = TagURI::mint('user:register:%d',
1019 $act->time = strtotime($this->created);
1021 $act->title = _("Register");
1023 $act->content = sprintf(_('%1$s joined %2$s.'),
1024 $profile->getBestName(),
1029 public function isPrivateStream()
1031 return $this->getProfile()->isPrivateStream();
1034 public function hasPassword()
1036 return !empty($this->password);
1039 public function setPassword($password)
1041 $orig = clone($this);
1042 $this->password = common_munge_password($password, $this->getProfile());
1044 if ($this->validate() !== true) {
1045 // TRANS: Form validation error on page where to change password.
1046 throw new ServerException(_('Error saving user; invalid.'));
1049 if (!$this->update($orig)) {
1050 common_log_db_error($this, 'UPDATE', __FILE__);
1051 // TRANS: Server error displayed on page where to change password when password change
1052 // TRANS: could not be made because of a server error.
1053 throw new ServerException(_('Cannot save new password.'));
1057 public function delPref($namespace, $topic)
1059 return $this->getProfile()->delPref($namespace, $topic);
1062 public function getPref($namespace, $topic, $default=null)
1064 return $this->getProfile()->getPref($namespace, $topic, $default);
1067 public function getConfigPref($namespace, $topic)
1069 return $this->getProfile()->getConfigPref($namespace, $topic);
1072 public function setPref($namespace, $topic, $data)
1074 return $this->getProfile()->setPref($namespace, $topic, $data);