X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=classes%2FUser.php;h=c232b2b12f307c8c2ee2e0d60cc069a3746612f4;hb=HEAD;hp=2b390bb90bbdea80a26555c0f53375ea71772bf3;hpb=f323f234d7a5f0e1e24c83b1b9df1e7251cad102;p=quix0rs-gnu-social.git diff --git a/classes/User.php b/classes/User.php index 2b390bb90b..c232b2b12f 100644 --- a/classes/User.php +++ b/classes/User.php @@ -34,15 +34,14 @@ class User extends Managed_DataObject public $__table = 'user'; // table name public $id; // int(4) primary_key not_null public $nickname; // varchar(64) unique_key - public $password; // varchar(255) - public $email; // varchar(255) unique_key - public $incomingemail; // varchar(255) unique_key + public $password; // varchar(191) not 255 because utf8mb4 takes more space + public $email; // varchar(191) unique_key not 255 because utf8mb4 takes more space + public $incomingemail; // varchar(191) unique_key not 255 because utf8mb4 takes more space public $emailnotifysub; // tinyint(1) default_1 public $emailnotifyfav; // tinyint(1) default_1 public $emailnotifynudge; // tinyint(1) default_1 public $emailnotifymsg; // tinyint(1) default_1 public $emailnotifyattn; // tinyint(1) default_1 - public $emailmicroid; // tinyint(1) default_1 public $language; // varchar(50) public $timezone; // varchar(50) public $emailpost; // tinyint(1) default_1 @@ -50,12 +49,11 @@ class User extends Managed_DataObject public $carrier; // int(4) public $smsnotify; // tinyint(1) public $smsreplies; // tinyint(1) - public $smsemail; // varchar(255) - public $uri; // varchar(255) unique_key + public $smsemail; // varchar(191) not 255 because utf8mb4 takes more space + public $uri; // varchar(191) unique_key not 255 because utf8mb4 takes more space public $autosubscribe; // tinyint(1) public $subscribe_policy; // tinyint(1) public $urlshorteningservice; // varchar(50) default_ur1.ca - public $inboxed; // tinyint(1) public $private_stream; // tinyint(1) default_0 public $created; // datetime() not_null public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP @@ -70,15 +68,14 @@ class User extends Managed_DataObject 'fields' => array( 'id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname or username, duped in profile'), - 'password' => array('type' => 'varchar', 'length' => 255, 'description' => 'salted password, can be null for OpenID users'), - 'email' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for password recovery etc.'), - 'incomingemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'email address for post-by-email'), + 'password' => array('type' => 'varchar', 'length' => 191, 'description' => 'salted password, can be null for OpenID users'), + 'email' => array('type' => 'varchar', 'length' => 191, 'description' => 'email address for password recovery etc.'), + 'incomingemail' => array('type' => 'varchar', 'length' => 191, 'description' => 'email address for post-by-email'), 'emailnotifysub' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of subscriptions'), - 'emailnotifyfav' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of favorites'), + 'emailnotifyfav' => array('type' => 'int', 'size' => 'tiny', 'default' => null, 'description' => 'Notify by email of favorites'), 'emailnotifynudge' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of nudges'), 'emailnotifymsg' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of direct messages'), 'emailnotifyattn' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Notify by email of @-replies'), - 'emailmicroid' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'whether to publish email microid'), 'language' => array('type' => 'varchar', 'length' => 50, 'description' => 'preferred language'), 'timezone' => array('type' => 'varchar', 'length' => 50, 'description' => 'timezone'), 'emailpost' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'Post by email'), @@ -86,12 +83,11 @@ class User extends Managed_DataObject 'carrier' => array('type' => 'int', 'description' => 'foreign key to sms_carrier'), 'smsnotify' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS'), 'smsreplies' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to send notices to SMS on replies'), - 'smsemail' => array('type' => 'varchar', 'length' => 255, 'description' => 'built from sms and carrier'), - 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), + 'smsemail' => array('type' => 'varchar', 'length' => 191, 'description' => 'built from sms and carrier'), + 'uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'universally unique identifier, usually a tag URI'), 'autosubscribe' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'automatically subscribe to users who subscribe to us'), 'subscribe_policy' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => '0 = anybody can subscribe; 1 = require approval'), 'urlshorteningservice' => array('type' => 'varchar', 'length' => 50, 'default' => 'internal', 'description' => 'service to use for auto-shortening URLs'), - 'inboxed' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'has an inbox been created for this user?'), 'private_stream' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'whether to limit all notices to followers only'), 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), @@ -115,7 +111,7 @@ class User extends Managed_DataObject ); } - protected $_profile = null; + protected $_profile = array(); /** * @return Profile @@ -124,52 +120,49 @@ class User extends Managed_DataObject */ public function getProfile() { - if (!($this->_profile instanceof Profile)) { - $this->_profile = Profile::getKV('id', $this->id); - if (!($this->_profile instanceof Profile)) { + if (!isset($this->_profile[$this->id])) { + $profile = Profile::getKV('id', $this->id); + if (!$profile instanceof Profile) { throw new UserNoProfileException($this); } + $this->_profile[$this->id] = $profile; } - - return $this->_profile; + return $this->_profile[$this->id]; } - function isSubscribed(Profile $other) + public function sameAs(Profile $other) { - return $this->getProfile()->isSubscribed($other); + return $this->getProfile()->sameAs($other); } - function hasPendingSubscription($other) + public function getUri() { - return $this->getProfile()->hasPendingSubscription($other); + return $this->uri; } - // 'update' won't write key columns, so we have to do it ourselves. + public function getNickname() + { + return $this->getProfile()->getNickname(); + } - function updateKeys(&$orig) + static function getByNickname($nickname) { - $this->_connect(); - $parts = array(); - foreach (array('nickname', 'email', 'incomingemail', 'sms', 'carrier', 'smsemail') as $k) { - if (strcmp($this->$k, $orig->$k) != 0) { - $parts[] = $k . ' = ' . $this->_quote($this->$k); - } - } - if (count($parts) == 0) { - // No changes - return true; - } - $toupdate = implode(', ', $parts); - - $table = common_database_tablename($this->tableName()); - $qry = 'UPDATE ' . $table . ' SET ' . $toupdate . - ' WHERE id = ' . $this->id; - $orig->decache(); - $result = $this->query($qry); - if ($result) { - $this->encache(); + $user = User::getKV('nickname', $nickname); + if (!$user instanceof User) { + throw new NoSuchUserException(array('nickname' => $nickname)); } - return $result; + + return $user; + } + + function isSubscribed(Profile $other) + { + return $this->getProfile()->isSubscribed($other); + } + + function hasPendingSubscription(Profile $other) + { + return $this->getProfile()->hasPendingSubscription($other); } /** @@ -211,9 +204,10 @@ class User extends Managed_DataObject * string 'password' (may be missing for eg OpenID registrations) * string 'code' invite code * ?string 'uri' permalink to notice; defaults to local notice URL - * @return mixed User object or false on failure + * @return User object + * @throws Exception on failure */ - static function register(array $fields) { + static function register(array $fields, $accept_email_fail=false) { // MAGICALLY put fields into current scope @@ -225,12 +219,8 @@ class User extends Managed_DataObject $email = common_canonical_email($email); } - try { - $profile->nickname = Nickname::normalize($nickname, true); - } catch (NicknameException $e) { - common_log(LOG_WARNING, sprintf('Bad nickname during User registration for %s: %s', $nickname, $e->getMessage()), __FILE__); - return false; - } + // Normalize _and_ check whether it is in use. Throw NicknameException on failure. + $profile->nickname = Nickname::normalize($nickname, true); $profile->profileurl = common_profile_url($profile->nickname); @@ -268,7 +258,7 @@ class User extends Managed_DataObject if (!empty($code)) { $invite = Invitation::getKV($code); - if ($invite && $invite->address && $invite->address_type == 'email' && $invite->address == $email) { + if ($invite instanceof Invitation && $invite->address && $invite->address_type == 'email' && $invite->address == $email) { $user->email = $invite->address; } } @@ -277,21 +267,14 @@ class User extends Managed_DataObject $user->email = $email; } - // This flag is ignored but still set to 1 - - $user->inboxed = 1; - // Set default-on options here, otherwise they'll be disabled // initially for sites using caching, since the initial encache // doesn't know about the defaults in the database. $user->emailnotifysub = 1; - $user->emailnotifyfav = 1; $user->emailnotifynudge = 1; $user->emailnotifymsg = 1; $user->emailnotifyattn = 1; - $user->emailmicroid = 1; $user->emailpost = 1; - $user->jabbermicroid = 1; $user->created = common_sql_now(); @@ -302,7 +285,9 @@ class User extends Managed_DataObject $id = $profile->insert(); if ($id === false) { common_log_db_error($profile, 'INSERT', __FILE__); - return false; + $profile->query('ROLLBACK'); + // TRANS: Profile data could not be inserted for some reason. + throw new ServerException(_m('Could not insert profile data for new user.')); } $user->id = $id; @@ -314,7 +299,7 @@ class User extends Managed_DataObject } if (!empty($password)) { // may not have a password for OpenID users - $user->password = common_munge_password($password, $id); + $user->password = common_munge_password($password); } $result = $user->insert(); @@ -322,21 +307,8 @@ class User extends Managed_DataObject if ($result === false) { common_log_db_error($user, 'INSERT', __FILE__); $profile->query('ROLLBACK'); - return false; - } - - // Everyone gets an inbox - - $inbox = new Inbox(); - - $inbox->user_id = $user->id; - $inbox->notice_ids = ''; - - $result = $inbox->insert(); - - if (!$result) { - common_log_db_error($inbox, 'INSERT', __FILE__); - return false; + // TRANS: User data could not be inserted for some reason. + throw new ServerException(_m('Could not insert user data for new user.')); } // Everyone is subscribed to themself @@ -351,7 +323,8 @@ class User extends Managed_DataObject if (!$result) { common_log_db_error($subscription, 'INSERT', __FILE__); $profile->query('ROLLBACK'); - return false; + // TRANS: Subscription data could not be inserted for some reason. + throw new ServerException(_m('Could not insert subscription data for new user.')); } // Mark that this invite was converted @@ -373,7 +346,8 @@ class User extends Managed_DataObject if (!$result) { common_log_db_error($confirm, 'INSERT', __FILE__); $profile->query('ROLLBACK'); - return false; + // TRANS: Email confirmation data could not be inserted for some reason. + throw new ServerException(_m('Could not insert email confirmation data for new user.')); } } @@ -391,14 +365,21 @@ class User extends Managed_DataObject common_log(LOG_WARNING, sprintf("Default user %s does not exist.", $defnick), __FILE__); } else { - Subscription::start($profile, $defuser->getProfile()); + Subscription::ensureStart($profile, $defuser->getProfile()); } } $profile->query('COMMIT'); - if (!empty($email) && !$user->email) { - mail_confirm_address($user, $confirm->code, $profile->nickname, $email); + if (!empty($email) && !empty($user->email)) { + try { + mail_confirm_address($user, $confirm->code, $profile->nickname, $email); + } catch (EmailException $e) { + common_log(LOG_ERR, "Could not send user registration email for user id=={$user->id}: {$e->getMessage()}"); + if (!$accept_email_fail) { + throw $e; + } + } } // Welcome message @@ -424,6 +405,10 @@ class User extends Managed_DataObject Event::handle('EndUserRegister', array($profile)); } + if (!$user instanceof User) { + throw new ServerException('User could not be registered. Probably an event hook that failed.'); + } + return $user; } @@ -450,12 +435,7 @@ class User extends Managed_DataObject } } - function hasFave($notice) - { - return $this->getProfile()->hasFave($notice); - } - - function mutuallySubscribed($other) + function mutuallySubscribed(Profile $other) { return $this->getProfile()->mutuallySubscribed($other); } @@ -477,7 +457,7 @@ class User extends Managed_DataObject function getReplies($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) { - return Reply::stream($this->id, $offset, $limit, $since_id, $before_id); + return $this->getProfile()->getReplies($offset, $limit, $since_id, $before_id); } function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) { @@ -489,67 +469,6 @@ class User extends Managed_DataObject return $this->getProfile()->getNotices($offset, $limit, $since_id, $before_id); } - function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0) - { - return $this->getProfile()->favoriteNotices($own, $offset, $limit, $since_id, $max_id); - } - - function noticeInbox($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) - { - $stream = new InboxNoticeStream($this); - return $stream->getNotices($offset, $limit, $since_id, $before_id); - } - - // DEPRECATED, use noticeInbox() - - function noticesWithFriends($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) - { - return $this->noticeInbox($offset, $limit, $since_id, $before_id); - } - - // DEPRECATED, use noticeInbox() - - function noticesWithFriendsThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) - { - return $this->noticeInbox($offset, $limit, $since_id, $before_id); - } - - // DEPRECATED, use noticeInbox() - - function noticeInboxThreaded($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) - { - return $this->noticeInbox($offset, $limit, $since_id, $before_id); - } - - // DEPRECATED, use noticeInbox() - - function friendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) - { - return $this->noticeInbox($offset, $limit, $since_id, $before_id); - } - - // DEPRECATED, use noticeInbox() - - function ownFriendsTimeline($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $before_id=0) - { - $this->noticeInbox($offset, $limit, $since_id, $before_id); - } - - function blowFavesCache() - { - $this->getProfile()->blowFavesCache(); - } - - function getSelfTags() - { - return Profile_tag::getTagsArray($this->id, $this->id, $this->id); - } - - function setSelfTags($newtags, $privacy) - { - return Profile_tag::setTags($this->id, $this->id, $newtags, $privacy); - } - function block(Profile $other) { // Add a new block record @@ -686,13 +605,15 @@ class User extends Managed_DataObject } try { - $profile = $this->getProfile(); - $profile->delete(); + if (!$this->hasRole(Profile_role::DELETED)) { + $profile = $this->getProfile(); + $profile->delete(); + } } catch (UserNoProfileException $unp) { common_log(LOG_INFO, "User {$this->nickname} has no profile; continuing deletion."); } - $related = array('Fave', + $related = array( 'Confirm_address', 'Remember_me', 'Foreign_link', @@ -753,6 +674,21 @@ class User extends Managed_DataObject return $this->getProfile()->isSilenced(); } + function receivesEmailNotifications() + { + // We could do this in one large if statement, but that's not as easy to read + // Don't send notifications if we don't know the user's email address or it is + // explicitly undesired by the user's own settings. + if (empty($this->email) || !$this->emailnotifyattn) { + return false; + } + // Don't send notifications to a user who is sandboxed or silenced + if ($this->isSandboxed() || $this->isSilenced()) { + return false; + } + return true; + } + function repeatedByMe($offset=0, $limit=20, $since_id=null, $max_id=null) { $stream = new RepeatedByMeNoticeStream($this); @@ -767,11 +703,9 @@ class User extends Managed_DataObject return $stream->getNotices($offset, $limit, $since_id, $max_id); } - - function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null) + public function repeatedToMe($offset=0, $limit=20, $since_id=null, $max_id=null) { - // TRANS: Exception thrown when trying view "repeated to me". - throw new Exception(_('Not implemented since inbox change.')); + return $this->getProfile()->repeatedToMe($offset, $limit, $since_id, $max_id); } public static function siteOwner() @@ -929,57 +863,59 @@ class User extends Managed_DataObject static function recoverPassword($nore) { - $user = User::getKV('email', common_canonical_email($nore)); - - if (!$user) { - try { - $user = User::getKV('nickname', common_canonical_nickname($nore)); - } catch (NicknameException $e) { - // invalid + // $confirm_email will be used as a fallback if our user doesn't have a confirmed email + $confirm_email = null; + + if (common_is_email($nore)) { + $user = User::getKV('email', common_canonical_email($nore)); + + // See if it's an unconfirmed email address + if (!$user instanceof User) { + // Warning: it may actually be legit to have multiple folks + // who have claimed, but not yet confirmed, the same address. + // We'll only send to the first one that comes up. + $confirm_email = new Confirm_address(); + $confirm_email->address = common_canonical_email($nore); + $confirm_email->address_type = 'email'; + if ($confirm_email->find(true)) { + $user = User::getKV('id', $confirm_email->user_id); + } } - } - // See if it's an unconfirmed email address - - if (!$user) { - // Warning: it may actually be legit to have multiple folks - // who have claimed, but not yet confirmed, the same address. - // We'll only send to the first one that comes up. - $confirm_email = new Confirm_address(); - $confirm_email->address = common_canonical_email($nore); - $confirm_email->address_type = 'email'; - $confirm_email->find(); - if ($confirm_email->fetch()) { - $user = User::getKV($confirm_email->user_id); - } else { - $confirm_email = null; + // No luck finding anyone by that email address. + if (!$user instanceof User) { + if (common_config('site', 'fakeaddressrecovery')) { + // Return without actually doing anything! We fake address recovery + // to avoid revealing which email addresses are registered with the site. + return; + } + // TRANS: Information on password recovery form if no known e-mail address was specified. + throw new ClientException(_('No user with that email address exists here.')); } } else { - $confirm_email = null; - } - - if (!$user) { - // TRANS: Information on password recovery form if no known username or e-mail address was specified. - throw new ClientException(_('No user with that email address or username.')); - return; + // This might throw a NicknameException on bad nicknames + $user = User::getKV('nickname', common_canonical_nickname($nore)); + if (!$user instanceof User) { + // TRANS: Information on password recovery form if no known username was specified. + throw new ClientException(_('No user with that nickname exists here.')); + } } // Try to get an unconfirmed email address if they used a user name - - if (!$user->email && !$confirm_email) { + if (empty($user->email) && $confirm_email === null) { $confirm_email = new Confirm_address(); $confirm_email->user_id = $user->id; $confirm_email->address_type = 'email'; $confirm_email->find(); if (!$confirm_email->fetch()) { + // Nothing found, so let's reset it to null $confirm_email = null; } } - if (!$user->email && !$confirm_email) { + if (empty($user->email) && !$confirm_email instanceof Confirm_address) { // TRANS: Client error displayed on password recovery form if a user does not have a registered e-mail address. throw new ClientException(_('No registered email address for that user.')); - return; } // Success! We have a valid user and a confirmed or unconfirmed email address @@ -988,13 +924,12 @@ class User extends Managed_DataObject $confirm->code = common_confirmation_code(128); $confirm->address_type = 'recover'; $confirm->user_id = $user->id; - $confirm->address = (!empty($user->email)) ? $user->email : $confirm_email->address; + $confirm->address = $user->email ?: $confirm_email->address; if (!$confirm->insert()) { common_log_db_error($confirm, 'INSERT', __FILE__); // TRANS: Server error displayed if e-mail address confirmation fails in the database on the password recovery form. throw new ServerException(_('Error saving address confirmation.')); - return; } // @todo FIXME: needs i18n. @@ -1032,18 +967,6 @@ class User extends Managed_DataObject return false; } - function conversationTree() - { - if (common_config('oldschool', 'enabled')) { - $osp = Old_school_prefs::getKV('user_id', $this->id); - if (!empty($osp)) { - return $osp->conversation_tree; - } - } - - return false; - } - function streamNicknames() { if (common_config('oldschool', 'enabled')) { @@ -1068,7 +991,7 @@ class User extends Managed_DataObject $act = new Activity(); - $act->actor = ActivityObject::fromProfile($profile); + $act->actor = $profile->asActivityObject(); $act->verb = ActivityVerb::JOIN; $act->objects[] = $service; @@ -1085,4 +1008,52 @@ class User extends Managed_DataObject $service->title); return $act; } + + public function isPrivateStream() + { + return $this->getProfile()->isPrivateStream(); + } + + public function hasPassword() + { + return !empty($this->password); + } + + public function setPassword($password) + { + $orig = clone($this); + $this->password = common_munge_password($password, $this->getProfile()); + + if ($this->validate() !== true) { + // TRANS: Form validation error on page where to change password. + throw new ServerException(_('Error saving user; invalid.')); + } + + if (!$this->update($orig)) { + common_log_db_error($this, 'UPDATE', __FILE__); + // TRANS: Server error displayed on page where to change password when password change + // TRANS: could not be made because of a server error. + throw new ServerException(_('Cannot save new password.')); + } + } + + public function delPref($namespace, $topic) + { + return $this->getProfile()->delPref($namespace, $topic); + } + + public function getPref($namespace, $topic, $default=null) + { + return $this->getProfile()->getPref($namespace, $topic, $default); + } + + public function getConfigPref($namespace, $topic) + { + return $this->getProfile()->getConfigPref($namespace, $topic); + } + + public function setPref($namespace, $topic, $data) + { + return $this->getProfile()->setPref($namespace, $topic, $data); + } }