]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/User.php
Added documentation
[friendica.git] / src / Model / User.php
index 40b6c4ff15e0da18f4e181b49963716278c562d1..141ecf059802d88d7956801262b593e6ec8c925d 100644 (file)
@@ -7,7 +7,6 @@ namespace Friendica\Model;
 
 use DivineOmega\PasswordExposed;
 use Exception;
-use Friendica\Core\Addon;
 use Friendica\Core\Config;
 use Friendica\Core\Hook;
 use Friendica\Core\L10n;
@@ -17,27 +16,76 @@ use Friendica\Core\Protocol;
 use Friendica\Core\System;
 use Friendica\Core\Worker;
 use Friendica\Database\DBA;
+use Friendica\Model\Photo;
+use Friendica\Model\TwoFactor\AppSpecificPassword;
 use Friendica\Object\Image;
 use Friendica\Util\Crypto;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Network;
 use Friendica\Util\Strings;
+use Friendica\Worker\Delivery;
 use LightOpenID;
 
-require_once 'boot.php';
-require_once 'include/dba.php';
-require_once 'include/enotify.php';
-require_once 'include/text.php';
 /**
  * @brief This class handles User related functions
  */
 class User
 {
+       /**
+        * Page/profile types
+        *
+        * PAGE_FLAGS_NORMAL is a typical personal profile account
+        * PAGE_FLAGS_SOAPBOX automatically approves all friend requests as Contact::SHARING, (readonly)
+        * PAGE_FLAGS_COMMUNITY automatically approves all friend requests as Contact::SHARING, but with
+        *      write access to wall and comments (no email and not included in page owner's ACL lists)
+        * PAGE_FLAGS_FREELOVE automatically approves all friend requests as full friends (Contact::FRIEND).
+        *
+        * @{
+        */
+       const PAGE_FLAGS_NORMAL    = 0;
+       const PAGE_FLAGS_SOAPBOX   = 1;
+       const PAGE_FLAGS_COMMUNITY = 2;
+       const PAGE_FLAGS_FREELOVE  = 3;
+       const PAGE_FLAGS_BLOG      = 4;
+       const PAGE_FLAGS_PRVGROUP  = 5;
+       /**
+        * @}
+        */
+
+       /**
+        * Account types
+        *
+        * ACCOUNT_TYPE_PERSON - the account belongs to a person
+        *      Associated page types: PAGE_FLAGS_NORMAL, PAGE_FLAGS_SOAPBOX, PAGE_FLAGS_FREELOVE
+        *
+        * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
+        *      Associated page type: PAGE_FLAGS_SOAPBOX
+        *
+        * ACCOUNT_TYPE_NEWS - the account is a news reflector
+        *      Associated page type: PAGE_FLAGS_SOAPBOX
+        *
+        * ACCOUNT_TYPE_COMMUNITY - the account is community forum
+        *      Associated page types: PAGE_COMMUNITY, PAGE_FLAGS_PRVGROUP
+        *
+        * ACCOUNT_TYPE_RELAY - the account is a relay
+        *      This will only be assigned to contacts, not to user accounts
+        * @{
+        */
+       const ACCOUNT_TYPE_PERSON =       0;
+       const ACCOUNT_TYPE_ORGANISATION = 1;
+       const ACCOUNT_TYPE_NEWS =         2;
+       const ACCOUNT_TYPE_COMMUNITY =    3;
+       const ACCOUNT_TYPE_RELAY =        4;
+       /**
+        * @}
+        */
+
        /**
         * Returns true if a user record exists with the provided id
         *
         * @param  integer $uid
         * @return boolean
+        * @throws Exception
         */
        public static function exists($uid)
        {
@@ -46,11 +94,24 @@ class User
 
        /**
         * @param  integer       $uid
+        * @param array          $fields
         * @return array|boolean User record if it exists, false otherwise
+        * @throws Exception
         */
-       public static function getById($uid)
+       public static function getById($uid, array $fields = [])
        {
-               return DBA::selectFirst('user', [], ['uid' => $uid]);
+               return DBA::selectFirst('user', $fields, ['uid' => $uid]);
+       }
+
+       /**
+        * @param  string        $nickname
+        * @param array          $fields
+        * @return array|boolean User record if it exists, false otherwise
+        * @throws Exception
+        */
+       public static function getByNickname($nickname, array $fields = [])
+       {
+               return DBA::selectFirst('user', $fields, ['nickname' => $nickname]);
        }
 
        /**
@@ -59,6 +120,7 @@ class User
         * @param string $url
         *
         * @return integer user id
+        * @throws Exception
         */
        public static function getIdForURL($url)
        {
@@ -70,13 +132,30 @@ class User
                }
        }
 
+       /**
+        * Get a user based on its email
+        *
+        * @param string        $email
+        * @param array          $fields
+        *
+        * @return array|boolean User record if it exists, false otherwise
+        *
+        * @throws Exception
+        */
+       public static function getByEmail($email, array $fields = [])
+       {
+               return DBA::selectFirst('user', $fields, ['email' => $email]);
+       }
+
        /**
         * @brief Get owner data by user id
         *
         * @param int $uid
+        * @param boolean $check_valid Test if data is invalid and correct it
         * @return boolean|array
+        * @throws Exception
         */
-       public static function getOwnerDataById($uid) {
+       public static function getOwnerDataById($uid, $check_valid = true) {
                $r = DBA::fetchFirst("SELECT
                        `contact`.*,
                        `user`.`prvkey` AS `uprvkey`,
@@ -86,7 +165,8 @@ class User
                        `user`.`spubkey`,
                        `user`.`page-flags`,
                        `user`.`account-type`,
-                       `user`.`prvnets`
+                       `user`.`prvnets`,
+                       `user`.`account_removed`
                        FROM `contact`
                        INNER JOIN `user`
                                ON `user`.`uid` = `contact`.`uid`
@@ -98,6 +178,41 @@ class User
                if (!DBA::isResult($r)) {
                        return false;
                }
+
+               if (empty($r['nickname'])) {
+                       return false;
+               }
+
+               if (!$check_valid) {
+                       return $r;
+               }
+
+               // Check if the returned data is valid, otherwise fix it. See issue #6122
+
+               // Check for correct url and normalised nurl
+               $url = System::baseUrl() . '/profile/' . $r['nickname'];
+               $repair = ($r['url'] != $url) || ($r['nurl'] != Strings::normaliseLink($r['url']));
+
+               if (!$repair) {
+                       // Check if "addr" is present and correct
+                       $addr = $r['nickname'] . '@' . substr(System::baseUrl(), strpos(System::baseUrl(), '://') + 3);
+                       $repair = ($addr != $r['addr']);
+               }
+
+               if (!$repair) {
+                       // Check if the avatar field is filled and the photo directs to the correct path
+                       $avatar = Photo::selectFirst(['resource-id'], ['uid' => $uid, 'profile' => true]);
+                       if (DBA::isResult($avatar)) {
+                               $repair = empty($r['avatar']) || !strpos($r['photo'], $avatar['resource-id']);
+                       }
+               }
+
+               if ($repair) {
+                       Contact::updateSelfFromUserID($uid);
+                       // Return the corrected data and avoid a loop
+                       $r = self::getOwnerDataById($uid, false);
+               }
+
                return $r;
        }
 
@@ -106,6 +221,7 @@ class User
         *
         * @param int $nick
         * @return boolean|array
+        * @throws Exception
         */
        public static function getOwnerDataByNick($nick)
        {
@@ -125,6 +241,7 @@ class User
         * @param string $network network name
         *
         * @return int group id
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function getDefaultGroup($uid, $network = '')
        {
@@ -151,17 +268,18 @@ class User
        /**
         * Authenticate a user with a clear text password
         *
-        * @brief Authenticate a user with a clear text password
-        * @param mixed $user_info
+        * @brief      Authenticate a user with a clear text password
+        * @param mixed  $user_info
         * @param string $password
+        * @param bool   $third_party
         * @return int|boolean
         * @deprecated since version 3.6
-        * @see User::getIdFromPasswordAuthentication()
+        * @see        User::getIdFromPasswordAuthentication()
         */
-       public static function authenticate($user_info, $password)
+       public static function authenticate($user_info, $password, $third_party = false)
        {
                try {
-                       return self::getIdFromPasswordAuthentication($user_info, $password);
+                       return self::getIdFromPasswordAuthentication($user_info, $password, $third_party);
                } catch (Exception $ex) {
                        return false;
                }
@@ -171,19 +289,25 @@ class User
         * Returns the user id associated with a successful password authentication
         *
         * @brief Authenticate a user with a clear text password
-        * @param mixed $user_info
+        * @param mixed  $user_info
         * @param string $password
+        * @param bool   $third_party
         * @return int User Id if authentication is successful
         * @throws Exception
         */
-       public static function getIdFromPasswordAuthentication($user_info, $password)
+       public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false)
        {
                $user = self::getAuthenticationInfo($user_info);
 
-               if (strpos($user['password'], '$') === false) {
+               if ($third_party && PConfig::get($user['uid'], '2fa', 'verified')) {
+                       // Third-party apps can't verify two-factor authentication, we use app-specific passwords instead
+                       if (AppSpecificPassword::authenticateUser($user['uid'], $password)) {
+                               return $user['uid'];
+                       }
+               } elseif (strpos($user['password'], '$') === false) {
                        //Legacy hash that has not been replaced by a new hash yet
                        if (self::hashPasswordLegacy($password) === $user['password']) {
-                               self::updatePassword($user['uid'], $password);
+                               self::updatePasswordHashed($user['uid'], self::hashPassword($password));
 
                                return $user['uid'];
                        }
@@ -191,14 +315,14 @@ class User
                        //Legacy hash that has been double-hashed and not replaced by a new hash yet
                        //Warning: `legacy_password` is not necessary in sync with the content of `password`
                        if (password_verify(self::hashPasswordLegacy($password), $user['password'])) {
-                               self::updatePassword($user['uid'], $password);
+                               self::updatePasswordHashed($user['uid'], self::hashPassword($password));
 
                                return $user['uid'];
                        }
                } elseif (password_verify($password, $user['password'])) {
                        //New password hash
                        if (password_needs_rehash($user['password'], PASSWORD_DEFAULT)) {
-                               self::updatePassword($user['uid'], $password);
+                               self::updatePasswordHashed($user['uid'], self::hashPassword($password));
                        }
 
                        return $user['uid'];
@@ -271,7 +395,7 @@ class User
         */
        public static function generateNewPassword()
        {
-               return Strings::getRandomName(6) . mt_rand(100, 9999);
+               return ucfirst(Strings::getRandomName(8)) . mt_rand(1000, 9999);
        }
 
        /**
@@ -308,6 +432,7 @@ class User
         *
         * @param string $password
         * @return string
+        * @throws Exception
         */
        public static function hashPassword($password)
        {
@@ -324,9 +449,26 @@ class User
         * @param int    $uid
         * @param string $password
         * @return bool
+        * @throws Exception
         */
        public static function updatePassword($uid, $password)
        {
+               $password = trim($password);
+
+               if (empty($password)) {
+                       throw new Exception(L10n::t('Empty passwords are not allowed.'));
+               }
+
+               if (!Config::get('system', 'disable_password_exposed', false) && self::isPasswordExposed($password)) {
+                       throw new Exception(L10n::t('The new password has been exposed in a public data dump, please choose another.'));
+               }
+
+               $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
+
+               if (!preg_match('/^[a-z0-9' . preg_quote($allowed_characters, '/') . ']+$/i', $password)) {
+                       throw new Exception(L10n::t('The password can\'t contain accentuated letters, white spaces or colons (:)'));
+               }
+
                return self::updatePasswordHashed($uid, self::hashPassword($password));
        }
 
@@ -337,6 +479,7 @@ class User
         * @param int    $uid
         * @param string $pasword_hashed
         * @return bool
+        * @throws Exception
         */
        private static function updatePasswordHashed($uid, $pasword_hashed)
        {
@@ -358,6 +501,7 @@ class User
         *
         * @param string $nickname The nickname that should be checked
         * @return boolean True is the nickname is blocked on the node
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function isNicknameBlocked($nickname)
        {
@@ -391,17 +535,19 @@ class User
         * - Create self-contact
         * - Create profile image
         *
-        * @param array $data
-        * @return string
-        * @throw Exception
+        * @param  array $data
+        * @return array
+        * @throws \ErrorException
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
+        * @throws Exception
         */
        public static function create(array $data)
        {
-               $a = get_app();
+               $a = \get_app();
                $return = ['user' => null, 'password' => ''];
 
                $using_invites = Config::get('system', 'invitation_only');
-               $num_invites   = Config::get('system', 'number_invites');
 
                $invite_id  = !empty($data['invite_id'])  ? Strings::escapeTags(trim($data['invite_id']))  : '';
                $username   = !empty($data['username'])   ? Strings::escapeTags(trim($data['username']))   : '';
@@ -464,8 +610,6 @@ class User
                        $openid_url = '';
                }
 
-               $err = '';
-
                // collapse multiple spaces in name
                $username = preg_replace('/ +/', ' ', $username);
 
@@ -672,12 +816,12 @@ class User
                                }
 
                                if (!$photo_failure) {
-                                       DBA::update('photo', ['profile' => 1], ['resource-id' => $hash]);
+                                       Photo::update(['profile' => 1], ['resource-id' => $hash]);
                                }
                        }
                }
 
-               Addon::callHooks('register_account', $uid);
+               Hook::callAll('register_account', $uid);
 
                $return['user'] = $user;
                return $return;
@@ -691,6 +835,7 @@ class User
         * @param string $siteurl
         * @param string $password Plaintext password
         * @return NULL|boolean from notification() and email() inherited
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
        {
@@ -726,6 +871,7 @@ class User
         * @param string $siteurl
         * @param string $password Plaintext password
         * @return NULL|boolean from notification() and email() inherited
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function sendRegisterOpenEmail($user, $sitename, $siteurl, $password)
        {
@@ -762,7 +908,7 @@ class User
                        If you ever want to delete your account, you can do so at %3$s/removeme
 
                        Thank you and welcome to %2$s.',
-                       $user['email'], $sitename, $siteurl, $user['username'], $password
+                       $user['nickname'], $sitename, $siteurl, $user['username'], $password
                ));
 
                return notification([
@@ -778,7 +924,8 @@ class User
 
        /**
         * @param object $uid user to remove
-        * @return void
+        * @return bool
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function remove($uid)
        {
@@ -786,8 +933,6 @@ class User
                        return false;
                }
 
-               $a = get_app();
-
                Logger::log('Removing user: ' . $uid);
 
                $user = DBA::selectFirst('user', [], ['uid' => $uid]);
@@ -800,14 +945,14 @@ class User
 
                // The user and related data will be deleted in "cron_expire_and_remove_users" (cronjobs.php)
                DBA::update('user', ['account_removed' => true, 'account_expires_on' => DateTimeFormat::utc('now + 7 day')], ['uid' => $uid]);
-               Worker::add(PRIORITY_HIGH, 'Notifier', 'removeme', $uid);
+               Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::REMOVAL, $uid);
 
                // Send an update to the directory
                $self = DBA::selectFirst('contact', ['url'], ['uid' => $uid, 'self' => true]);
                Worker::add(PRIORITY_LOW, 'Directory', $self['url']);
 
                // Remove the user relevant data
-               Worker::add(PRIORITY_LOW, 'RemoveUser', $uid);
+               Worker::add(PRIORITY_NEGLIGIBLE, 'RemoveUser', $uid);
 
                return true;
        }
@@ -819,18 +964,19 @@ class User
         * @return array All identities for this user
         *
         * Example for a return:
-        *      [
-        *              [
-        *                      'uid' => 1,
-        *                      'username' => 'maxmuster',
-        *                      'nickname' => 'Max Mustermann'
-        *              ],
-        *              [
-        *                      'uid' => 2,
-        *                      'username' => 'johndoe',
-        *                      'nickname' => 'John Doe'
-        *              ]
-        *      ]
+        *    [
+        *        [
+        *            'uid' => 1,
+        *            'username' => 'maxmuster',
+        *            'nickname' => 'Max Mustermann'
+        *        ],
+        *        [
+        *            'uid' => 2,
+        *            'username' => 'johndoe',
+        *            'nickname' => 'John Doe'
+        *        ]
+        *    ]
+        * @throws Exception
         */
        public static function identities($uid)
        {
@@ -881,4 +1027,51 @@ class User
 
                return $identities;
        }
+
+       /**
+        * Returns statistical information about the current users of this node
+        *
+        * @return array
+        *
+        * @throws Exception
+        */
+       public static function getStatistics()
+       {
+               $statistics = [
+                       'total_users'           => 0,
+                       'active_users_halfyear' => 0,
+                       'active_users_monthly'  => 0,
+               ];
+
+               $userStmt = DBA::p("SELECT `user`.`uid`, `user`.`login_date`, `contact`.`last-item`
+                       FROM `user`
+                       INNER JOIN `profile` ON `profile`.`uid` = `user`.`uid` AND `profile`.`is-default`
+                       INNER JOIN `contact` ON `contact`.`uid` = `user`.`uid` AND `contact`.`self`
+                       WHERE (`profile`.`publish` OR `profile`.`net-publish`) AND `user`.`verified`
+                               AND NOT `user`.`blocked` AND NOT `user`.`account_removed`
+                               AND NOT `user`.`account_expired`");
+
+               if (!DBA::isResult($userStmt)) {
+                       return $statistics;
+               }
+
+               $halfyear = time() - (180 * 24 * 60 * 60);
+               $month = time() - (30 * 24 * 60 * 60);
+
+               while ($user = DBA::fetch($userStmt)) {
+                       $statistics['total_users']++;
+
+                       if ((strtotime($user['login_date']) > $halfyear) ||
+                               (strtotime($user['last-item']) > $halfyear)) {
+                               $statistics['active_users_halfyear']++;
+                       }
+
+                       if ((strtotime($user['login_date']) > $month) ||
+                               (strtotime($user['last-item']) > $month)) {
+                               $statistics['active_users_monthly']++;
+                       }
+               }
+
+               return $statistics;
+       }
 }