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 public function getNickname()
145 return $this->getProfile()->getNickname();
148 static function getByNickname($nickname)
150 $user = User::getKV('nickname', $nickname);
151 if (!$user instanceof User) {
152 throw new NoSuchUserException(array('nickname' => $nickname));
158 function isSubscribed(Profile $other)
160 return $this->getProfile()->isSubscribed($other);
163 function hasPendingSubscription(Profile $other)
165 return $this->getProfile()->hasPendingSubscription($other);
169 * Get the most recent notice posted by this user, if any.
171 * @return mixed Notice or null
173 function getCurrentNotice()
175 return $this->getProfile()->getCurrentNotice();
178 function getCarrier()
180 return Sms_carrier::getKV('id', $this->carrier);
183 function hasBlocked($other)
185 return $this->getProfile()->hasBlocked($other);
189 * Register a new user account and profile and set up default subscriptions.
190 * If a new-user welcome message is configured, this will be sent.
192 * @param array $fields associative array of optional properties
195 * bool 'email_confirmed' pass true to mark email as pre-confirmed
198 * string 'location' informal string description of geolocation
199 * float 'lat' decimal latitude for geolocation
200 * float 'lon' decimal longitude for geolocation
201 * int 'location_id' geoname identifier
202 * int 'location_ns' geoname namespace to interpret location_id
203 * string 'nickname' REQUIRED
204 * string 'password' (may be missing for eg OpenID registrations)
205 * string 'code' invite code
206 * ?string 'uri' permalink to notice; defaults to local notice URL
207 * @return User object
208 * @throws Exception on failure
210 static function register(array $fields, $accept_email_fail=false) {
212 // MAGICALLY put fields into current scope
216 $profile = new Profile();
218 if (!empty($email)) {
219 $email = common_canonical_email($email);
222 // Normalize _and_ check whether it is in use. Throw NicknameException on failure.
223 $profile->nickname = Nickname::normalize($nickname, true);
225 $profile->profileurl = common_profile_url($profile->nickname);
227 if (!empty($fullname)) {
228 $profile->fullname = $fullname;
230 if (!empty($homepage)) {
231 $profile->homepage = $homepage;
234 $profile->bio = $bio;
236 if (!empty($location)) {
237 $profile->location = $location;
239 $loc = Location::fromName($location);
242 $profile->lat = $loc->lat;
243 $profile->lon = $loc->lon;
244 $profile->location_id = $loc->location_id;
245 $profile->location_ns = $loc->location_ns;
249 $profile->created = common_sql_now();
253 $user->nickname = $profile->nickname;
257 // Users who respond to invite email have proven their ownership of that address
260 $invite = Invitation::getKV($code);
261 if ($invite instanceof Invitation && $invite->address && $invite->address_type == 'email' && $invite->address == $email) {
262 $user->email = $invite->address;
266 if(isset($email_confirmed) && $email_confirmed) {
267 $user->email = $email;
270 // Set default-on options here, otherwise they'll be disabled
271 // initially for sites using caching, since the initial encache
272 // doesn't know about the defaults in the database.
273 $user->emailnotifysub = 1;
274 $user->emailnotifynudge = 1;
275 $user->emailnotifymsg = 1;
276 $user->emailnotifyattn = 1;
277 $user->emailpost = 1;
279 $user->created = common_sql_now();
281 if (Event::handle('StartUserRegister', array($profile))) {
283 $profile->query('BEGIN');
285 $id = $profile->insert();
287 common_log_db_error($profile, 'INSERT', __FILE__);
288 $profile->query('ROLLBACK');
289 // TRANS: Profile data could not be inserted for some reason.
290 throw new ServerException(_m('Could not insert profile data for new user.'));
298 $user->uri = common_user_uri($user);
301 if (!empty($password)) { // may not have a password for OpenID users
302 $user->password = common_munge_password($password);
305 $result = $user->insert();
307 if ($result === false) {
308 common_log_db_error($user, 'INSERT', __FILE__);
309 $profile->query('ROLLBACK');
310 // TRANS: User data could not be inserted for some reason.
311 throw new ServerException(_m('Could not insert user data for new user.'));
314 // Everyone is subscribed to themself
316 $subscription = new Subscription();
317 $subscription->subscriber = $user->id;
318 $subscription->subscribed = $user->id;
319 $subscription->created = $user->created;
321 $result = $subscription->insert();
324 common_log_db_error($subscription, 'INSERT', __FILE__);
325 $profile->query('ROLLBACK');
326 // TRANS: Subscription data could not be inserted for some reason.
327 throw new ServerException(_m('Could not insert subscription data for new user.'));
330 // Mark that this invite was converted
332 if (!empty($invite)) {
333 $invite->convert($user);
336 if (!empty($email) && !$user->email) {
338 $confirm = new Confirm_address();
339 $confirm->code = common_confirmation_code(128);
340 $confirm->user_id = $user->id;
341 $confirm->address = $email;
342 $confirm->address_type = 'email';
344 $result = $confirm->insert();
347 common_log_db_error($confirm, 'INSERT', __FILE__);
348 $profile->query('ROLLBACK');
349 // TRANS: Email confirmation data could not be inserted for some reason.
350 throw new ServerException(_m('Could not insert email confirmation data for new user.'));
354 if (!empty($code) && $user->email) {
355 $user->emailChanged();
358 // Default system subscription
360 $defnick = common_config('newuser', 'default');
362 if (!empty($defnick)) {
363 $defuser = User::getKV('nickname', $defnick);
364 if (empty($defuser)) {
365 common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick),
368 Subscription::ensureStart($profile, $defuser->getProfile());
372 $profile->query('COMMIT');
374 if (!empty($email) && !empty($user->email)) {
376 mail_confirm_address($user, $confirm->code, $profile->nickname, $email);
377 } catch (EmailException $e) {
378 common_log(LOG_ERR, "Could not send user registration email for user id=={$user->id}: {$e->getMessage()}");
379 if (!$accept_email_fail) {
387 $welcome = common_config('newuser', 'welcome');
389 if (!empty($welcome)) {
390 $welcomeuser = User::getKV('nickname', $welcome);
391 if (empty($welcomeuser)) {
392 common_log(LOG_WARNING, sprintf("Welcome user %s does not exist.", $defnick),
395 $notice = Notice::saveNew($welcomeuser->id,
396 // TRANS: Notice given on user registration.
397 // TRANS: %1$s is the sitename, $2$s is the registering user's nickname.
398 sprintf(_('Welcome to %1$s, @%2$s!'),
399 common_config('site', 'name'),
405 Event::handle('EndUserRegister', array($profile));
408 if (!$user instanceof User) {
409 throw new ServerException('User could not be registered. Probably an event hook that failed.');
415 // Things we do when the email changes
416 function emailChanged()
419 $invites = new Invitation();
420 $invites->address = $this->email;
421 $invites->address_type = 'email';
423 if ($invites->find()) {
424 while ($invites->fetch()) {
426 $other = Profile::getKV('id', $invites->user_id);
427 if (!($other instanceof Profile)) { // remove when getKV throws exceptions
430 Subscription::start($other, $this->getProfile());
431 } catch (Exception $e) {
438 function mutuallySubscribed(Profile $other)
440 return $this->getProfile()->mutuallySubscribed($other);
443 function mutuallySubscribedUsers()
445 // 3-way join; probably should get cached
446 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
447 $qry = "SELECT $UT.* " .
448 "FROM subscription sub1 JOIN $UT ON sub1.subscribed = $UT.id " .
449 "JOIN subscription sub2 ON $UT.id = sub2.subscriber " .
450 'WHERE sub1.subscriber = %d and sub2.subscribed = %d ' .
451 "ORDER BY $UT.nickname";
453 $user->query(sprintf($qry, $this->id, $this->id));
458 function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
460 return $this->getProfile()->getReplies($offset, $limit, $since_id, $before_id);
463 function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) {
464 return $this->getProfile()->getTaggedNotices($tag, $offset, $limit, $since_id, $before_id);
467 function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0)
469 return $this->getProfile()->getNotices($offset, $limit, $since_id, $before_id);
472 function block(Profile $other)
474 // Add a new block record
476 // no blocking (and thus unsubbing from) yourself
478 if ($this->id == $other->id) {
479 common_log(LOG_WARNING,
481 "Profile ID %d (%s) tried to block themself.",
489 $block = new Profile_block();
491 // Begin a transaction
493 $block->query('BEGIN');
495 $block->blocker = $this->id;
496 $block->blocked = $other->id;
498 $result = $block->insert();
501 common_log_db_error($block, 'INSERT', __FILE__);
505 $self = $this->getProfile();
506 if (Subscription::exists($other, $self)) {
507 Subscription::cancel($other, $self);
509 if (Subscription::exists($self, $other)) {
510 Subscription::cancel($self, $other);
513 $block->query('COMMIT');
518 function unblock(Profile $other)
520 // Get the block record
522 $block = Profile_block::exists($this->getProfile(), $other);
528 $result = $block->delete();
531 common_log_db_error($block, 'DELETE', __FILE__);
538 function isMember(User_group $group)
540 return $this->getProfile()->isMember($group);
543 function isAdmin(User_group $group)
545 return $this->getProfile()->isAdmin($group);
548 function getGroups($offset=0, $limit=null)
550 return $this->getProfile()->getGroups($offset, $limit);
554 * Request to join the given group.
555 * May throw exceptions on failure.
557 * @param User_group $group
558 * @return Group_member
560 function joinGroup(User_group $group)
562 return $this->getProfile()->joinGroup($group);
566 * Leave a group that this user is a member of.
568 * @param User_group $group
570 function leaveGroup(User_group $group)
572 return $this->getProfile()->leaveGroup($group);
575 function getSubscribed($offset=0, $limit=null)
577 return $this->getProfile()->getSubscribed($offset, $limit);
580 function getSubscribers($offset=0, $limit=null)
582 return $this->getProfile()->getSubscribers($offset, $limit);
585 function getTaggedSubscribers($tag, $offset=0, $limit=null)
587 return $this->getProfile()->getTaggedSubscribers($tag, $offset, $limit);
590 function getTaggedSubscriptions($tag, $offset=0, $limit=null)
592 return $this->getProfile()->getTaggedSubscriptions($tag, $offset, $limit);
595 function hasRight($right)
597 return $this->getProfile()->hasRight($right);
600 function delete($useWhere=false)
602 if (empty($this->id)) {
603 common_log(LOG_WARNING, "Ambiguous User->delete(); skipping related tables.");
604 return parent::delete($useWhere);
608 if (!$this->hasRole(Profile_role::DELETED)) {
609 $profile = $this->getProfile();
612 } catch (UserNoProfileException $unp) {
613 common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion.");
623 Event::handle('UserDeleteRelated', array($this, &$related));
625 foreach ($related as $cls) {
627 $inst->user_id = $this->id;
631 $this->_deleteTags();
632 $this->_deleteBlocks();
634 return parent::delete($useWhere);
637 function _deleteTags()
639 $tag = new Profile_tag();
640 $tag->tagger = $this->id;
644 function _deleteBlocks()
646 $block = new Profile_block();
647 $block->blocker = $this->id;
649 // XXX delete group block? Reset blocker?
652 function hasRole($name)
654 return $this->getProfile()->hasRole($name);
657 function grantRole($name)
659 return $this->getProfile()->grantRole($name);
662 function revokeRole($name)
664 return $this->getProfile()->revokeRole($name);
667 function isSandboxed()
669 return $this->getProfile()->isSandboxed();
672 function isSilenced()
674 return $this->getProfile()->isSilenced();
677 function receivesEmailNotifications()
679 // We could do this in one large if statement, but that's not as easy to read
680 // Don't send notifications if we don't know the user's email address or it is
681 // explicitly undesired by the user's own settings.
682 if (empty($this->email) || !$this->emailnotifyattn) {
685 // Don't send notifications to a user who is sandboxed or silenced
686 if ($this->isSandboxed() || $this->isSilenced()) {
692 function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null)
694 $stream = new RepeatedByMeNoticeStream($this);
695 return $stream->getNotices($offset, $limit, $since_id, $max_id);
699 function repeatsOfMe($offset=0, $limit=20, $since_id=null, $max_id=null)
701 $stream = new RepeatsOfMeNoticeStream($this);
703 return $stream->getNotices($offset, $limit, $since_id, $max_id);
706 public function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null)
708 return $this->getProfile()->repeatedToMe($offset, $limit, $since_id, $max_id);
711 public static function siteOwner()
713 $owner = self::cacheGet('user:site_owner');
715 if ($owner === false) { // cache miss
717 $pr = new Profile_role();
718 $pr->role = Profile_role::OWNER;
719 $pr->orderBy('created');
722 if (!$pr->find(true)) {
723 throw new NoResultException($pr);
726 $owner = User::getKV('id', $pr->profile_id);
728 self::cacheSet('user:site_owner', $owner);
731 if ($owner instanceof User) {
735 throw new ServerException(_('No site owner configured.'));
739 * Pull the primary site account to use in single-user mode.
740 * If a valid user nickname is listed in 'singleuser':'nickname'
741 * in the config, this will be used; otherwise the site owner
742 * account is taken by default.
745 * @throws ServerException if no valid single user account is present
746 * @throws ServerException if called when not in single-user mode
748 public static function singleUser()
750 if (!common_config('singleuser', 'enabled')) {
751 // TRANS: Server exception.
752 throw new ServerException(_('Single-user mode code called when not enabled.'));
755 if ($nickname = common_config('singleuser', 'nickname')) {
756 $user = User::getKV('nickname', $nickname);
757 if ($user instanceof User) {
762 // If there was no nickname or no user by that nickname,
763 // try the site owner. Throws exception if not configured.
764 return User::siteOwner();
768 * This is kind of a hack for using external setup code that's trying to
769 * build single-user sites.
771 * Will still return a username if the config singleuser/nickname is set
772 * even if the account doesn't exist, which normally indicates that the
773 * site is horribly misconfigured.
775 * At the moment, we need to let it through so that router setup can
776 * complete, otherwise we won't be able to create the account.
778 * This will be easier when we can more easily create the account and
779 * *then* switch the site to 1user mode without jumping through hoops.
782 * @throws ServerException if no valid single user account is present
783 * @throws ServerException if called when not in single-user mode
785 static function singleUserNickname()
788 $user = User::singleUser();
789 return $user->nickname;
790 } catch (Exception $e) {
791 if (common_config('singleuser', 'enabled') && common_config('singleuser', 'nickname')) {
792 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.");
793 return common_config('singleuser', 'nickname');
800 * Find and shorten links in the given text using this user's URL shortening
803 * By default, links will be left untouched if the text is shorter than the
804 * configured maximum notice length. Pass true for the $always parameter
805 * to force all links to be shortened regardless.
807 * Side effects: may save file and file_redirection records for referenced URLs.
809 * @param string $text
810 * @param boolean $always
813 public function shortenLinks($text, $always=false)
815 return common_shorten_links($text, $always, $this);
819 * Get a list of OAuth client applications that have access to this
822 function getConnectedApps($offset = 0, $limit = null)
826 'FROM oauth_application_user u, oauth_application a ' .
827 'WHERE u.profile_id = %d ' .
828 'AND a.id = u.application_id ' .
829 'AND u.access_type > 0 ' .
830 'ORDER BY u.created DESC ';
833 if (common_config('db','type') == 'pgsql') {
834 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
836 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
840 $apps = new Oauth_application_user();
842 $cnt = $apps->query(sprintf($qry, $this->id));
848 * Magic function called at serialize() time.
850 * We use this to drop a couple process-specific references
851 * from DB_DataObject which can cause trouble in future
854 * @return array of variable names to include in serialization.
859 $vars = parent::__sleep();
860 $skip = array('_profile');
861 return array_diff($vars, $skip);
864 static function recoverPassword($nore)
866 // $confirm_email will be used as a fallback if our user doesn't have a confirmed email
867 $confirm_email = null;
869 if (common_is_email($nore)) {
870 $user = User::getKV('email', common_canonical_email($nore));
872 // See if it's an unconfirmed email address
873 if (!$user instanceof User) {
874 // Warning: it may actually be legit to have multiple folks
875 // who have claimed, but not yet confirmed, the same address.
876 // We'll only send to the first one that comes up.
877 $confirm_email = new Confirm_address();
878 $confirm_email->address = common_canonical_email($nore);
879 $confirm_email->address_type = 'email';
880 if ($confirm_email->find(true)) {
881 $user = User::getKV('id', $confirm_email->user_id);
885 // No luck finding anyone by that email address.
886 if (!$user instanceof User) {
887 if (common_config('site', 'fakeaddressrecovery')) {
888 // Return without actually doing anything! We fake address recovery
889 // to avoid revealing which email addresses are registered with the site.
892 // TRANS: Information on password recovery form if no known e-mail address was specified.
893 throw new ClientException(_('No user with that email address exists here.'));
896 // This might throw a NicknameException on bad nicknames
897 $user = User::getKV('nickname', common_canonical_nickname($nore));
898 if (!$user instanceof User) {
899 // TRANS: Information on password recovery form if no known username was specified.
900 throw new ClientException(_('No user with that nickname exists here.'));
904 // Try to get an unconfirmed email address if they used a user name
905 if (empty($user->email) && $confirm_email === null) {
906 $confirm_email = new Confirm_address();
907 $confirm_email->user_id = $user->id;
908 $confirm_email->address_type = 'email';
909 $confirm_email->find();
910 if (!$confirm_email->fetch()) {
911 // Nothing found, so let's reset it to null
912 $confirm_email = null;
916 if (empty($user->email) && !$confirm_email instanceof Confirm_address) {
917 // TRANS: Client error displayed on password recovery form if a user does not have a registered e-mail address.
918 throw new ClientException(_('No registered email address for that user.'));
921 // Success! We have a valid user and a confirmed or unconfirmed email address
923 $confirm = new Confirm_address();
924 $confirm->code = common_confirmation_code(128);
925 $confirm->address_type = 'recover';
926 $confirm->user_id = $user->id;
927 $confirm->address = $user->email ?: $confirm_email->address;
929 if (!$confirm->insert()) {
930 common_log_db_error($confirm, 'INSERT', __FILE__);
931 // TRANS: Server error displayed if e-mail address confirmation fails in the database on the password recovery form.
932 throw new ServerException(_('Error saving address confirmation.'));
935 // @todo FIXME: needs i18n.
936 $body = "Hey, $user->nickname.";
938 $body .= 'Someone just asked for a new password ' .
939 'for this account on ' . common_config('site', 'name') . '.';
941 $body .= 'If it was you, and you want to confirm, use the URL below:';
943 $body .= "\t".common_local_url('recoverpassword',
944 array('code' => $confirm->code));
946 $body .= 'If not, just ignore this message.';
948 $body .= 'Thanks for your time, ';
950 $body .= common_config('site', 'name');
953 $headers = _mail_prepare_headers('recoverpassword', $user->nickname, $user->nickname);
954 // TRANS: Subject for password recovery e-mail.
955 mail_to_user($user, _('Password recovery requested'), $body, $headers, $confirm->address);
958 function streamModeOnly()
960 if (common_config('oldschool', 'enabled')) {
961 $osp = Old_school_prefs::getKV('user_id', $this->id);
963 return $osp->stream_mode_only;
970 function streamNicknames()
972 if (common_config('oldschool', 'enabled')) {
973 $osp = Old_school_prefs::getKV('user_id', $this->id);
975 return $osp->stream_nicknames;
981 function registrationActivity()
983 $profile = $this->getProfile();
985 $service = new ActivityObject();
987 $service->type = ActivityObject::SERVICE;
988 $service->title = common_config('site', 'name');
989 $service->link = common_root_url();
990 $service->id = $service->link;
992 $act = new Activity();
994 $act->actor = $profile->asActivityObject();
995 $act->verb = ActivityVerb::JOIN;
997 $act->objects[] = $service;
999 $act->id = TagURI::mint('user:register:%d',
1002 $act->time = strtotime($this->created);
1004 $act->title = _("Register");
1006 $act->content = sprintf(_('%1$s joined %2$s.'),
1007 $profile->getBestName(),
1012 public function isPrivateStream()
1014 return $this->getProfile()->isPrivateStream();
1017 public function hasPassword()
1019 return !empty($this->password);
1022 public function setPassword($password)
1024 $orig = clone($this);
1025 $this->password = common_munge_password($password, $this->getProfile());
1027 if ($this->validate() !== true) {
1028 // TRANS: Form validation error on page where to change password.
1029 throw new ServerException(_('Error saving user; invalid.'));
1032 if (!$this->update($orig)) {
1033 common_log_db_error($this, 'UPDATE', __FILE__);
1034 // TRANS: Server error displayed on page where to change password when password change
1035 // TRANS: could not be made because of a server error.
1036 throw new ServerException(_('Cannot save new password.'));
1040 public function delPref($namespace, $topic)
1042 return $this->getProfile()->delPref($namespace, $topic);
1045 public function getPref($namespace, $topic, $default=null)
1047 return $this->getProfile()->getPref($namespace, $topic, $default);
1050 public function getConfigPref($namespace, $topic)
1052 return $this->getProfile()->getConfigPref($namespace, $topic);
1055 public function setPref($namespace, $topic, $data)
1057 return $this->getProfile()->setPref($namespace, $topic, $data);