switch ($accounttype) {
case 'person':
return User::ACCOUNT_TYPE_PERSON;
+
case 'organisation':
return User::ACCOUNT_TYPE_ORGANISATION;
+
case 'news':
return User::ACCOUNT_TYPE_NEWS;
+
case 'community':
return User::ACCOUNT_TYPE_COMMUNITY;
- default:
- return null;
- break;
+
}
+ return null;
}
/**
*
* @return array system account
*/
- public static function getSystemAccount()
+ public static function getSystemAccount(): array
{
$system = Contact::selectFirst([], ['self' => true, 'uid' => 0]);
if (!DBA::isResult($system)) {
throw new Exception(DI::l10n()->t('SERIOUS ERROR: Generation of security keys failed.'));
}
- $system = [];
- $system['uid'] = 0;
- $system['created'] = DateTimeFormat::utcNow();
- $system['self'] = true;
- $system['network'] = Protocol::ACTIVITYPUB;
- $system['name'] = 'System Account';
- $system['addr'] = $system_actor_name . '@' . DI::baseUrl()->getHostname();
- $system['nick'] = $system_actor_name;
- $system['url'] = DI::baseUrl() . '/friendica';
+ $system = [
+ 'uid' => 0,
+ 'created' => DateTimeFormat::utcNow(),
+ 'self' => true,
+ 'network' => Protocol::ACTIVITYPUB,
+ 'name' => 'System Account',
+ 'addr' => $system_actor_name . '@' . DI::baseUrl()->getHostname(),
+ 'nick' => $system_actor_name,
+ 'url' => DI::baseUrl() . '/friendica',
+ 'pubkey' => $keys['pubkey'],
+ 'prvkey' => $keys['prvkey'],
+ 'blocked' => 0,
+ 'pending' => 0,
+ 'contact-type' => Contact::TYPE_RELAY, // In AP this is translated to 'Application'
+ 'name-date' => DateTimeFormat::utcNow(),
+ 'uri-date' => DateTimeFormat::utcNow(),
+ 'avatar-date' => DateTimeFormat::utcNow(),
+ 'closeness' => 0,
+ 'baseurl' => DI::baseUrl(),
+ ];
$system['avatar'] = $system['photo'] = Contact::getDefaultAvatar($system, Proxy::SIZE_SMALL);
- $system['thumb'] = Contact::getDefaultAvatar($system, Proxy::SIZE_THUMB);
- $system['micro'] = Contact::getDefaultAvatar($system, Proxy::SIZE_MICRO);
-
- $system['nurl'] = Strings::normaliseLink($system['url']);
- $system['pubkey'] = $keys['pubkey'];
- $system['prvkey'] = $keys['prvkey'];
- $system['blocked'] = 0;
- $system['pending'] = 0;
- $system['contact-type'] = Contact::TYPE_RELAY; // In AP this is translated to 'Application'
- $system['name-date'] = DateTimeFormat::utcNow();
- $system['uri-date'] = DateTimeFormat::utcNow();
- $system['avatar-date'] = DateTimeFormat::utcNow();
- $system['closeness'] = 0;
- $system['baseurl'] = DI::baseUrl();
- $system['gsid'] = GServer::getID($system['baseurl']);
+ $system['thumb'] = Contact::getDefaultAvatar($system, Proxy::SIZE_THUMB);
+ $system['micro'] = Contact::getDefaultAvatar($system, Proxy::SIZE_MICRO);
+ $system['nurl'] = Strings::normaliseLink($system['url']);
+ $system['gsid'] = GServer::getID($system['baseurl']);
+
Contact::insert($system);
}
*
* @return string actor account name
*/
- public static function getActorName()
+ public static function getActorName(): string
{
$system_actor_name = DI::config()->get('system', 'actor_name');
if (!empty($system_actor_name)) {
/**
* Returns true if a user record exists with the provided id
*
- * @param integer $uid
+ * @param int $uid
+ *
* @return boolean
* @throws Exception
*/
- public static function exists($uid)
+ public static function exists(int $uid): bool
{
return DBA::exists('user', ['uid' => $uid]);
}
* @return array|boolean User record if it exists, false otherwise
* @throws Exception
*/
- public static function getById($uid, array $fields = [])
+ public static function getById(int $uid, array $fields = [])
{
return !empty($uid) ? DBA::selectFirst('user', $fields, ['uid' => $uid]) : [];
}
* @return array|boolean User record if it exists, false otherwise
* @throws Exception
*/
- public static function getByNickname($nickname, array $fields = [])
+ public static function getByNickname(string $nickname, array $fields = [])
{
return DBA::selectFirst('user', $fields, ['nickname' => $nickname]);
}
* @return integer user id
* @throws Exception
*/
- public static function getIdForURL(string $url)
+ public static function getIdForURL(string $url): int
{
// Avoid database queries when the local node hostname isn't even part of the url.
if (!Contact::isLocal($url)) {
/**
* Get a user based on its email
*
- * @param string $email
- * @param array $fields
- *
+ * @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 = [])
+ public static function getByEmail(string $email, array $fields = [])
{
return DBA::selectFirst('user', $fields, ['email' => $email]);
}
* @param array $fields
* @return array user
*/
- public static function getFirstAdmin(array $fields = [])
+ public static function getFirstAdmin(array $fields = []) : array
{
if (!empty(DI::config()->get('config', 'admin_nickname'))) {
return self::getByNickname(DI::config()->get('config', 'admin_nickname'), $fields);
$owner = DBA::selectFirst('owner-view', [], ['uid' => $uid]);
if (!DBA::isResult($owner)) {
- if (!DBA::exists('user', ['uid' => $uid]) || !$repairMissing) {
+ if (!self::exists($uid) || !$repairMissing) {
return false;
}
if (!DBA::exists('profile', ['uid' => $uid])) {
* @return boolean|array
* @throws Exception
*/
- public static function getOwnerDataByNick($nick)
+ public static function getOwnerDataByNick(string $nick)
{
$user = DBA::selectFirst('user', ['uid'], ['nickname' => $nick]);
* @return int group id
* @throws Exception
*/
- public static function getDefaultGroup($uid)
+ public static function getDefaultGroup(int $uid): int
{
$user = DBA::selectFirst('user', ['def_gid'], ['uid' => $uid]);
if (DBA::isResult($user)) {
* @throws HTTPException\ForbiddenException
* @throws HTTPException\NotFoundException
*/
- public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false)
+ public static function getIdFromPasswordAuthentication($user_info, string $password, bool $third_party = false): int
{
// Addons registered with the "authenticate" hook may create the user on the
// fly. `getAuthenticationInfo` will fail if the user doesn't exist yet. If
* @return int User Id if authentication is successful
* @throws HTTPException\ForbiddenException
*/
- public static function getIdFromAuthenticateHooks($username, $password)
+ public static function getIdFromAuthenticateHooks(string $username, string $password): int
{
$addon_auth = [
'username' => $username,
* - User array with at least the uid and the hashed password
*
* @param mixed $user_info
- * @return array
+ * @return array|null Null if not found/determined
* @throws HTTPException\NotFoundException
*/
public static function getAuthenticationInfo($user_info)
* @return string
* @throws Exception
*/
- public static function generateNewPassword()
+ public static function generateNewPassword(): string
{
return ucfirst(Strings::getRandomName(8)) . random_int(1000, 9999);
}
* @return bool
* @throws Exception
*/
- public static function isPasswordExposed($password)
+ public static function isPasswordExposed(string $password): bool
{
$cache = new CacheItemPool();
$cache->changeConfig([
* @param string $password
* @return string
*/
- private static function hashPasswordLegacy($password)
+ private static function hashPasswordLegacy(string $password): string
{
return hash('whirlpool', $password);
}
* @return string
* @throws Exception
*/
- public static function hashPassword($password)
+ public static function hashPassword(string $password): string
{
if (!trim($password)) {
throw new Exception(DI::l10n()->t('Password can\'t be empty'));
return password_hash($password, PASSWORD_DEFAULT);
}
+ /**
+ * Allowed characters are a-z, A-Z, 0-9 and special characters except white spaces, accentuated letters and colon (:).
+ *
+ * Password length is limited to 72 characters if the current default password hashing algorithm is Blowfish.
+ * From the manual: "Using the PASSWORD_BCRYPT as the algorithm, will result in the password parameter being
+ * truncated to a maximum length of 72 bytes."
+ *
+ * @see https://www.php.net/manual/en/function.password-hash.php#refsect1-function.password-hash-parameters
+ *
+ * @param string|null $delimiter Whether the regular expression is meant to be wrapper in delimiter characters
+ * @return string
+ */
+ public static function getPasswordRegExp(string $delimiter = null): string
+ {
+ $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
+
+ if ($delimiter) {
+ $allowed_characters = preg_quote($allowed_characters, $delimiter);
+ }
+
+ return '^[a-zA-Z0-9' . $allowed_characters . ']' . (PASSWORD_DEFAULT !== PASSWORD_BCRYPT ? '{1,72}' : '+') . '$';
+ }
+
/**
* Updates a user row with a new plaintext password
*
* @return bool
* @throws Exception
*/
- public static function updatePassword($uid, $password)
+ public static function updatePassword(int $uid, string $password): bool
{
$password = trim($password);
throw new Exception(DI::l10n()->t('The new password has been exposed in a public data dump, please choose another.'));
}
- $allowed_characters = '!"#$%&\'()*+,-./;<=>?@[\]^_`{|}~';
+ if (PASSWORD_DEFAULT === PASSWORD_BCRYPT && strlen($password) > 72) {
+ throw new Exception(DI::l10n()->t('The password length is limited to 72 characters.'));
+ }
- if (!preg_match('/^[a-z0-9' . preg_quote($allowed_characters, '/') . ']+$/i', $password)) {
+ if (!preg_match('/' . self::getPasswordRegExp('/') . '/', $password)) {
throw new Exception(DI::l10n()->t('The password can\'t contain accentuated letters, white spaces or colons (:)'));
}
* @return bool
* @throws Exception
*/
- private static function updatePasswordHashed($uid, $pasword_hashed)
+ private static function updatePasswordHashed(int $uid, string $pasword_hashed): bool
{
$fields = [
'password' => $pasword_hashed,
* @param string $nickname The nickname that should be checked
* @return boolean True is the nickname is blocked on the node
*/
- public static function isNicknameBlocked($nickname)
+ public static function isNicknameBlocked(string $nickname): bool
{
$forbidden_nicknames = DI::config()->get('system', 'forbidden_nicknames', '');
if (!empty($forbidden_nicknames)) {
* @return string avatar link
* @throws Exception
*/
- public static function getAvatarUrl(array $user, string $size = ''):string
+ public static function getAvatarUrl(array $user, string $size = ''): string
{
if (empty($user['nickname'])) {
DI::logger()->warning('Missing user nickname key', ['trace' => System::callstack(20)]);
* @return string banner link
* @throws Exception
*/
- public static function getBannerUrl(array $user):string
+ public static function getBannerUrl(array $user): string
{
if (empty($user['nickname'])) {
DI::logger()->warning('Missing user nickname key', ['trace' => System::callstack(20)]);
* @throws ImagickException
* @throws Exception
*/
- public static function create(array $data)
+ public static function create(array $data): array
{
$return = ['user' => null, 'password' => ''];
$type = Images::getMimeTypeByData($img_str, $photo, $type);
- $Image = new Image($img_str, $type);
- if ($Image->isValid()) {
- $Image->scaleToSquare(300);
+ $image = new Image($img_str, $type);
+ if ($image->isValid()) {
+ $image->scaleToSquare(300);
$resource_id = Photo::newResource();
// Not using Photo::PROFILE_PHOTOS here, so that it is discovered as translateble string
$profile_album = DI::l10n()->t('Profile Photos');
- $r = Photo::store($Image, $uid, 0, $resource_id, $filename, $profile_album, 4);
+ $r = Photo::store($image, $uid, 0, $resource_id, $filename, $profile_album, 4);
if ($r === false) {
$photo_failure = true;
}
- $Image->scaleDown(80);
+ $image->scaleDown(80);
- $r = Photo::store($Image, $uid, 0, $resource_id, $filename, $profile_album, 5);
+ $r = Photo::store($image, $uid, 0, $resource_id, $filename, $profile_album, 5);
if ($r === false) {
$photo_failure = true;
}
- $Image->scaleDown(48);
+ $image->scaleDown(48);
- $r = Photo::store($Image, $uid, 0, $resource_id, $filename, $profile_album, 6);
+ $r = Photo::store($image, $uid, 0, $resource_id, $filename, $profile_album, 6);
if ($r === false) {
$photo_failure = true;
* @throws Exception
*/
- public static function block(int $uid, bool $block = true)
+ public static function block(int $uid, bool $block = true): bool
{
return DBA::update('user', ['blocked' => $block], ['uid' => $uid]);
}
* @throws HTTPException\InternalServerErrorException
* @throws Exception
*/
- public static function allow(string $hash)
+ public static function allow(string $hash): bool
{
$register = Register::getByHash($hash);
if (!DBA::isResult($register)) {
* @return bool True, if the deny was successfull
* @throws Exception
*/
- public static function deny(string $hash)
+ public static function deny(string $hash): bool
{
$register = Register::getByHash($hash);
if (!DBA::isResult($register)) {
* @param string $email The user's email address
* @param string $nick The user's nick name
* @param string $lang The user's language (default is english)
- *
* @return bool True, if the user was created successfully
* @throws HTTPException\InternalServerErrorException
* @throws ErrorException
* @throws ImagickException
*/
- public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT)
+ public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT): bool
{
if (empty($name) ||
empty($email) ||
* @return NULL|boolean from notification() and email() inherited
* @throws HTTPException\InternalServerErrorException
*/
- public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
+ public static function sendRegisterPendingEmail(array $user, string $sitename, string $siteurl, string $password)
{
$body = Strings::deindent(DI::l10n()->t(
'
* @return NULL|boolean from notification() and email() inherited
* @throws HTTPException\InternalServerErrorException
*/
- public static function sendRegisterOpenEmail(L10n $l10n, $user, $sitename, $siteurl, $password)
+ public static function sendRegisterOpenEmail(L10n $l10n, array $user, string $sitename, string $siteurl, string $password)
{
$preamble = Strings::deindent($l10n->t(
'
* @return bool
* @throws HTTPException\InternalServerErrorException
*/
- public static function remove(int $uid)
+ public static function remove(int $uid): bool
{
if (empty($uid)) {
return false;
* ]
* @throws Exception
*/
- public static function identities($uid)
+ public static function identities(int $uid): array
{
if (empty($uid)) {
return [];
* @param int $uid
* @return bool
*/
- public static function hasIdentities(int $uid):bool
+ public static function hasIdentities(int $uid): bool
{
if (empty($uid)) {
return false;
*
* @throws Exception
*/
- public static function getStatistics()
+ public static function getStatistics(): array
{
$statistics = [
'total_users' => 0,
* @param string $type The type of users, which should get (all, bocked, removed)
* @param string $order Order of the user list (Default is 'contact.name')
* @param bool $descending Order direction (Default is ascending)
- *
- * @return array The list of the users
+ * @return array|bool The list of the users
* @throws Exception
*/
- public static function getList($start = 0, $count = Pager::ITEMS_PER_PAGE, $type = 'all', $order = 'name', bool $descending = false)
+ public static function getList(int $start = 0, int $count = Pager::ITEMS_PER_PAGE, string $type = 'all', string $order = 'name', bool $descending = false)
{
$param = ['limit' => [$start, $count], 'order' => [$order => $descending]];
$condition = [];
$condition['account_removed'] = false;
$condition['blocked'] = false;
break;
+
case 'blocked':
$condition['account_removed'] = false;
$condition['blocked'] = true;
$condition['verified'] = true;
break;
+
case 'removed':
$condition['account_removed'] = true;
break;