572 lines
17 KiB
PHP
572 lines
17 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
* @copyright Copyright (c) 2016, Björn Schießle
|
|
*
|
|
* @author Bjoern Schiessle <bjoern@schiessle.org>
|
|
* @author Björn Schießle <bjoern@schiessle.org>
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
* @author Daniel Kesselberg <mail@danielkesselberg.de>
|
|
* @author Joas Schilling <coding@schilljs.com>
|
|
* @author Julius Härtl <jus@bitgrid.net>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
*
|
|
* @license AGPL-3.0
|
|
*
|
|
* This code is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
|
|
namespace OC\Accounts;
|
|
|
|
use libphonenumber\NumberParseException;
|
|
use libphonenumber\PhoneNumber;
|
|
use libphonenumber\PhoneNumberFormat;
|
|
use libphonenumber\PhoneNumberUtil;
|
|
use OCA\Settings\BackgroundJobs\VerifyUserData;
|
|
use OCP\Accounts\IAccount;
|
|
use OCP\Accounts\IAccountManager;
|
|
use OCP\BackgroundJob\IJobList;
|
|
use OCP\DB\QueryBuilder\IQueryBuilder;
|
|
use OCP\IConfig;
|
|
use OCP\IDBConnection;
|
|
use OCP\IUser;
|
|
use Psr\Log\LoggerInterface;
|
|
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
|
|
use Symfony\Component\EventDispatcher\GenericEvent;
|
|
use function json_decode;
|
|
use function json_last_error;
|
|
|
|
/**
|
|
* Class AccountManager
|
|
*
|
|
* Manage system accounts table
|
|
*
|
|
* @group DB
|
|
* @package OC\Accounts
|
|
*/
|
|
class AccountManager implements IAccountManager {
|
|
|
|
/** @var IDBConnection database connection */
|
|
private $connection;
|
|
|
|
/** @var IConfig */
|
|
private $config;
|
|
|
|
/** @var string table name */
|
|
private $table = 'accounts';
|
|
|
|
/** @var string table name */
|
|
private $dataTable = 'accounts_data';
|
|
|
|
/** @var EventDispatcherInterface */
|
|
private $eventDispatcher;
|
|
|
|
/** @var IJobList */
|
|
private $jobList;
|
|
|
|
/** @var LoggerInterface */
|
|
private $logger;
|
|
|
|
public function __construct(IDBConnection $connection,
|
|
IConfig $config,
|
|
EventDispatcherInterface $eventDispatcher,
|
|
IJobList $jobList,
|
|
LoggerInterface $logger) {
|
|
$this->connection = $connection;
|
|
$this->config = $config;
|
|
$this->eventDispatcher = $eventDispatcher;
|
|
$this->jobList = $jobList;
|
|
$this->logger = $logger;
|
|
}
|
|
|
|
/**
|
|
* @param string $input
|
|
* @return string Provided phone number in E.164 format when it was a valid number
|
|
* @throws \InvalidArgumentException When the phone number was invalid or no default region is set and the number doesn't start with a country code
|
|
*/
|
|
protected function parsePhoneNumber(string $input): string {
|
|
$defaultRegion = $this->config->getSystemValueString('default_phone_region', '');
|
|
|
|
if ($defaultRegion === '') {
|
|
// When no default region is set, only +49… numbers are valid
|
|
if (strpos($input, '+') !== 0) {
|
|
throw new \InvalidArgumentException(self::PROPERTY_PHONE);
|
|
}
|
|
|
|
$defaultRegion = 'EN';
|
|
}
|
|
|
|
$phoneUtil = PhoneNumberUtil::getInstance();
|
|
try {
|
|
$phoneNumber = $phoneUtil->parse($input, $defaultRegion);
|
|
if ($phoneNumber instanceof PhoneNumber && $phoneUtil->isValidNumber($phoneNumber)) {
|
|
return $phoneUtil->format($phoneNumber, PhoneNumberFormat::E164);
|
|
}
|
|
} catch (NumberParseException $e) {
|
|
}
|
|
|
|
throw new \InvalidArgumentException(self::PROPERTY_PHONE);
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param string $input
|
|
* @return string
|
|
* @throws \InvalidArgumentException When the website did not have http(s) as protocol or the host name was empty
|
|
*/
|
|
protected function parseWebsite(string $input): string {
|
|
$parts = parse_url($input);
|
|
if (!isset($parts['scheme']) || ($parts['scheme'] !== 'https' && $parts['scheme'] !== 'http')) {
|
|
throw new \InvalidArgumentException(self::PROPERTY_WEBSITE);
|
|
}
|
|
|
|
if (!isset($parts['host']) || $parts['host'] === '') {
|
|
throw new \InvalidArgumentException(self::PROPERTY_WEBSITE);
|
|
}
|
|
|
|
return $input;
|
|
}
|
|
|
|
/**
|
|
* update user record
|
|
*
|
|
* @param IUser $user
|
|
* @param array $data
|
|
* @param bool $throwOnData Set to true if you can inform the user about invalid data
|
|
* @return array The potentially modified data (e.g. phone numbers are converted to E.164 format)
|
|
* @throws \InvalidArgumentException Message is the property that was invalid
|
|
*/
|
|
public function updateUser(IUser $user, array $data, bool $throwOnData = false): array {
|
|
$userData = $this->getUser($user);
|
|
$updated = true;
|
|
|
|
if (isset($data[self::PROPERTY_PHONE]) && $data[self::PROPERTY_PHONE]['value'] !== '') {
|
|
// Sanitize null value.
|
|
$data[self::PROPERTY_PHONE]['value'] = $data[self::PROPERTY_PHONE]['value'] ?? '';
|
|
|
|
try {
|
|
$data[self::PROPERTY_PHONE]['value'] = $this->parsePhoneNumber($data[self::PROPERTY_PHONE]['value']);
|
|
} catch (\InvalidArgumentException $e) {
|
|
if ($throwOnData) {
|
|
throw $e;
|
|
}
|
|
$data[self::PROPERTY_PHONE]['value'] = '';
|
|
}
|
|
}
|
|
|
|
// set a max length
|
|
foreach ($data as $propertyName => $propertyData) {
|
|
if (isset($data[$propertyName]) && isset($data[$propertyName]['value']) && strlen($data[$propertyName]['value']) > 2048) {
|
|
if ($throwOnData) {
|
|
throw new \InvalidArgumentException($propertyName);
|
|
} else {
|
|
$data[$propertyName]['value'] = '';
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isset($data[self::PROPERTY_WEBSITE]) && $data[self::PROPERTY_WEBSITE]['value'] !== '') {
|
|
try {
|
|
$data[self::PROPERTY_WEBSITE]['value'] = $this->parseWebsite($data[self::PROPERTY_WEBSITE]['value']);
|
|
} catch (\InvalidArgumentException $e) {
|
|
if ($throwOnData) {
|
|
throw $e;
|
|
}
|
|
$data[self::PROPERTY_WEBSITE]['value'] = '';
|
|
}
|
|
}
|
|
|
|
$allowedScopes = [
|
|
self::SCOPE_PRIVATE,
|
|
self::SCOPE_LOCAL,
|
|
self::SCOPE_FEDERATED,
|
|
self::SCOPE_PUBLISHED,
|
|
self::VISIBILITY_PRIVATE,
|
|
self::VISIBILITY_CONTACTS_ONLY,
|
|
self::VISIBILITY_PUBLIC,
|
|
];
|
|
|
|
// validate and convert scope values
|
|
foreach ($data as $propertyName => $propertyData) {
|
|
if (isset($propertyData['scope'])) {
|
|
if ($throwOnData && !in_array($propertyData['scope'], $allowedScopes, true)) {
|
|
throw new \InvalidArgumentException('scope');
|
|
}
|
|
|
|
if (
|
|
$propertyData['scope'] === self::SCOPE_PRIVATE
|
|
&& ($propertyName === self::PROPERTY_DISPLAYNAME || $propertyName === self::PROPERTY_EMAIL)
|
|
) {
|
|
if ($throwOnData) {
|
|
// v2-private is not available for these fields
|
|
throw new \InvalidArgumentException('scope');
|
|
} else {
|
|
// default to local
|
|
$data[$propertyName]['scope'] = self::SCOPE_LOCAL;
|
|
}
|
|
} else {
|
|
// migrate scope values to the new format
|
|
// invalid scopes are mapped to a default value
|
|
$data[$propertyName]['scope'] = AccountProperty::mapScopeToV2($propertyData['scope']);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (empty($userData)) {
|
|
$this->insertNewUser($user, $data);
|
|
} elseif ($userData !== $data) {
|
|
$data = $this->checkEmailVerification($userData, $data, $user);
|
|
$data = $this->updateVerifyStatus($userData, $data);
|
|
$this->updateExistingUser($user, $data);
|
|
} else {
|
|
// nothing needs to be done if new and old data set are the same
|
|
$updated = false;
|
|
}
|
|
|
|
if ($updated) {
|
|
$this->eventDispatcher->dispatch(
|
|
'OC\AccountManager::userUpdated',
|
|
new GenericEvent($user, $data)
|
|
);
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* delete user from accounts table
|
|
*
|
|
* @param IUser $user
|
|
*/
|
|
public function deleteUser(IUser $user) {
|
|
$uid = $user->getUID();
|
|
$query = $this->connection->getQueryBuilder();
|
|
$query->delete($this->table)
|
|
->where($query->expr()->eq('uid', $query->createNamedParameter($uid)))
|
|
->execute();
|
|
|
|
$this->deleteUserData($user);
|
|
}
|
|
|
|
/**
|
|
* delete user from accounts table
|
|
*
|
|
* @param IUser $user
|
|
*/
|
|
public function deleteUserData(IUser $user): void {
|
|
$uid = $user->getUID();
|
|
$query = $this->connection->getQueryBuilder();
|
|
$query->delete($this->dataTable)
|
|
->where($query->expr()->eq('uid', $query->createNamedParameter($uid)))
|
|
->execute();
|
|
}
|
|
|
|
/**
|
|
* get stored data from a given user
|
|
*
|
|
* @param IUser $user
|
|
* @return array
|
|
*
|
|
* @deprecated use getAccount instead to make sure migrated properties work correctly
|
|
*/
|
|
public function getUser(IUser $user) {
|
|
$uid = $user->getUID();
|
|
$query = $this->connection->getQueryBuilder();
|
|
$query->select('data')
|
|
->from($this->table)
|
|
->where($query->expr()->eq('uid', $query->createParameter('uid')))
|
|
->setParameter('uid', $uid);
|
|
$result = $query->execute();
|
|
$accountData = $result->fetchAll();
|
|
$result->closeCursor();
|
|
|
|
if (empty($accountData)) {
|
|
$userData = $this->buildDefaultUserRecord($user);
|
|
$this->insertNewUser($user, $userData);
|
|
return $userData;
|
|
}
|
|
|
|
$userDataArray = json_decode($accountData[0]['data'], true);
|
|
$jsonError = json_last_error();
|
|
if ($userDataArray === null || $userDataArray === [] || $jsonError !== JSON_ERROR_NONE) {
|
|
$this->logger->critical("User data of $uid contained invalid JSON (error $jsonError), hence falling back to a default user record");
|
|
return $this->buildDefaultUserRecord($user);
|
|
}
|
|
|
|
$userDataArray = $this->addMissingDefaultValues($userDataArray);
|
|
|
|
return $userDataArray;
|
|
}
|
|
|
|
public function searchUsers(string $property, array $values): array {
|
|
$chunks = array_chunk($values, 500);
|
|
$query = $this->connection->getQueryBuilder();
|
|
$query->select('*')
|
|
->from($this->dataTable)
|
|
->where($query->expr()->eq('name', $query->createNamedParameter($property)))
|
|
->andWhere($query->expr()->in('value', $query->createParameter('values')));
|
|
|
|
$matches = [];
|
|
foreach ($chunks as $chunk) {
|
|
$query->setParameter('values', $chunk, IQueryBuilder::PARAM_STR_ARRAY);
|
|
$result = $query->execute();
|
|
|
|
while ($row = $result->fetch()) {
|
|
$matches[$row['value']] = $row['uid'];
|
|
}
|
|
$result->closeCursor();
|
|
}
|
|
|
|
return $matches;
|
|
}
|
|
|
|
/**
|
|
* check if we need to ask the server for email verification, if yes we create a cronjob
|
|
*
|
|
* @param $oldData
|
|
* @param $newData
|
|
* @param IUser $user
|
|
* @return array
|
|
*/
|
|
protected function checkEmailVerification($oldData, $newData, IUser $user) {
|
|
if ($oldData[self::PROPERTY_EMAIL]['value'] !== $newData[self::PROPERTY_EMAIL]['value']) {
|
|
$this->jobList->add(VerifyUserData::class,
|
|
[
|
|
'verificationCode' => '',
|
|
'data' => $newData[self::PROPERTY_EMAIL]['value'],
|
|
'type' => self::PROPERTY_EMAIL,
|
|
'uid' => $user->getUID(),
|
|
'try' => 0,
|
|
'lastRun' => time()
|
|
]
|
|
);
|
|
$newData[self::PROPERTY_EMAIL]['verified'] = self::VERIFICATION_IN_PROGRESS;
|
|
}
|
|
|
|
return $newData;
|
|
}
|
|
|
|
/**
|
|
* make sure that all expected data are set
|
|
*
|
|
* @param array $userData
|
|
* @return array
|
|
*/
|
|
protected function addMissingDefaultValues(array $userData) {
|
|
foreach ($userData as $key => $value) {
|
|
if (!isset($userData[$key]['verified'])) {
|
|
$userData[$key]['verified'] = self::NOT_VERIFIED;
|
|
}
|
|
}
|
|
|
|
return $userData;
|
|
}
|
|
|
|
/**
|
|
* reset verification status if personal data changed
|
|
*
|
|
* @param array $oldData
|
|
* @param array $newData
|
|
* @return array
|
|
*/
|
|
protected function updateVerifyStatus($oldData, $newData) {
|
|
|
|
// which account was already verified successfully?
|
|
$twitterVerified = isset($oldData[self::PROPERTY_TWITTER]['verified']) && $oldData[self::PROPERTY_TWITTER]['verified'] === self::VERIFIED;
|
|
$websiteVerified = isset($oldData[self::PROPERTY_WEBSITE]['verified']) && $oldData[self::PROPERTY_WEBSITE]['verified'] === self::VERIFIED;
|
|
$emailVerified = isset($oldData[self::PROPERTY_EMAIL]['verified']) && $oldData[self::PROPERTY_EMAIL]['verified'] === self::VERIFIED;
|
|
|
|
// keep old verification status if we don't have a new one
|
|
if (!isset($newData[self::PROPERTY_TWITTER]['verified'])) {
|
|
// keep old verification status if value didn't changed and an old value exists
|
|
$keepOldStatus = $newData[self::PROPERTY_TWITTER]['value'] === $oldData[self::PROPERTY_TWITTER]['value'] && isset($oldData[self::PROPERTY_TWITTER]['verified']);
|
|
$newData[self::PROPERTY_TWITTER]['verified'] = $keepOldStatus ? $oldData[self::PROPERTY_TWITTER]['verified'] : self::NOT_VERIFIED;
|
|
}
|
|
|
|
if (!isset($newData[self::PROPERTY_WEBSITE]['verified'])) {
|
|
// keep old verification status if value didn't changed and an old value exists
|
|
$keepOldStatus = $newData[self::PROPERTY_WEBSITE]['value'] === $oldData[self::PROPERTY_WEBSITE]['value'] && isset($oldData[self::PROPERTY_WEBSITE]['verified']);
|
|
$newData[self::PROPERTY_WEBSITE]['verified'] = $keepOldStatus ? $oldData[self::PROPERTY_WEBSITE]['verified'] : self::NOT_VERIFIED;
|
|
}
|
|
|
|
if (!isset($newData[self::PROPERTY_EMAIL]['verified'])) {
|
|
// keep old verification status if value didn't changed and an old value exists
|
|
$keepOldStatus = $newData[self::PROPERTY_EMAIL]['value'] === $oldData[self::PROPERTY_EMAIL]['value'] && isset($oldData[self::PROPERTY_EMAIL]['verified']);
|
|
$newData[self::PROPERTY_EMAIL]['verified'] = $keepOldStatus ? $oldData[self::PROPERTY_EMAIL]['verified'] : self::VERIFICATION_IN_PROGRESS;
|
|
}
|
|
|
|
// reset verification status if a value from a previously verified data was changed
|
|
if ($twitterVerified &&
|
|
$oldData[self::PROPERTY_TWITTER]['value'] !== $newData[self::PROPERTY_TWITTER]['value']
|
|
) {
|
|
$newData[self::PROPERTY_TWITTER]['verified'] = self::NOT_VERIFIED;
|
|
}
|
|
|
|
if ($websiteVerified &&
|
|
$oldData[self::PROPERTY_WEBSITE]['value'] !== $newData[self::PROPERTY_WEBSITE]['value']
|
|
) {
|
|
$newData[self::PROPERTY_WEBSITE]['verified'] = self::NOT_VERIFIED;
|
|
}
|
|
|
|
if ($emailVerified &&
|
|
$oldData[self::PROPERTY_EMAIL]['value'] !== $newData[self::PROPERTY_EMAIL]['value']
|
|
) {
|
|
$newData[self::PROPERTY_EMAIL]['verified'] = self::NOT_VERIFIED;
|
|
}
|
|
|
|
return $newData;
|
|
}
|
|
|
|
/**
|
|
* add new user to accounts table
|
|
*
|
|
* @param IUser $user
|
|
* @param array $data
|
|
*/
|
|
protected function insertNewUser(IUser $user, array $data): void {
|
|
$uid = $user->getUID();
|
|
$jsonEncodedData = json_encode($data);
|
|
$query = $this->connection->getQueryBuilder();
|
|
$query->insert($this->table)
|
|
->values(
|
|
[
|
|
'uid' => $query->createNamedParameter($uid),
|
|
'data' => $query->createNamedParameter($jsonEncodedData),
|
|
]
|
|
)
|
|
->execute();
|
|
|
|
$this->deleteUserData($user);
|
|
$this->writeUserData($user, $data);
|
|
}
|
|
|
|
/**
|
|
* update existing user in accounts table
|
|
*
|
|
* @param IUser $user
|
|
* @param array $data
|
|
*/
|
|
protected function updateExistingUser(IUser $user, array $data): void {
|
|
$uid = $user->getUID();
|
|
$jsonEncodedData = json_encode($data);
|
|
$query = $this->connection->getQueryBuilder();
|
|
$query->update($this->table)
|
|
->set('data', $query->createNamedParameter($jsonEncodedData))
|
|
->where($query->expr()->eq('uid', $query->createNamedParameter($uid)))
|
|
->execute();
|
|
|
|
$this->deleteUserData($user);
|
|
$this->writeUserData($user, $data);
|
|
}
|
|
|
|
protected function writeUserData(IUser $user, array $data): void {
|
|
$query = $this->connection->getQueryBuilder();
|
|
$query->insert($this->dataTable)
|
|
->values(
|
|
[
|
|
'uid' => $query->createNamedParameter($user->getUID()),
|
|
'name' => $query->createParameter('name'),
|
|
'value' => $query->createParameter('value'),
|
|
]
|
|
);
|
|
foreach ($data as $propertyName => $property) {
|
|
if ($propertyName === self::PROPERTY_AVATAR) {
|
|
continue;
|
|
}
|
|
|
|
$query->setParameter('name', $propertyName)
|
|
->setParameter('value', $property['value'] ?? '');
|
|
$query->execute();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* build default user record in case not data set exists yet
|
|
*
|
|
* @param IUser $user
|
|
* @return array
|
|
*/
|
|
protected function buildDefaultUserRecord(IUser $user) {
|
|
return [
|
|
self::PROPERTY_DISPLAYNAME =>
|
|
[
|
|
'value' => $user->getDisplayName(),
|
|
'scope' => self::SCOPE_FEDERATED,
|
|
'verified' => self::NOT_VERIFIED,
|
|
],
|
|
self::PROPERTY_ADDRESS =>
|
|
[
|
|
'value' => '',
|
|
'scope' => self::SCOPE_LOCAL,
|
|
'verified' => self::NOT_VERIFIED,
|
|
],
|
|
self::PROPERTY_WEBSITE =>
|
|
[
|
|
'value' => '',
|
|
'scope' => self::SCOPE_LOCAL,
|
|
'verified' => self::NOT_VERIFIED,
|
|
],
|
|
self::PROPERTY_EMAIL =>
|
|
[
|
|
'value' => $user->getEMailAddress(),
|
|
'scope' => self::SCOPE_FEDERATED,
|
|
'verified' => self::NOT_VERIFIED,
|
|
],
|
|
self::PROPERTY_AVATAR =>
|
|
[
|
|
'scope' => self::SCOPE_FEDERATED
|
|
],
|
|
self::PROPERTY_PHONE =>
|
|
[
|
|
'value' => '',
|
|
'scope' => self::SCOPE_LOCAL,
|
|
'verified' => self::NOT_VERIFIED,
|
|
],
|
|
self::PROPERTY_TWITTER =>
|
|
[
|
|
'value' => '',
|
|
'scope' => self::SCOPE_LOCAL,
|
|
'verified' => self::NOT_VERIFIED,
|
|
],
|
|
];
|
|
}
|
|
|
|
private function parseAccountData(IUser $user, $data): Account {
|
|
$account = new Account($user);
|
|
foreach ($data as $property => $accountData) {
|
|
$account->setProperty($property, $accountData['value'] ?? '', $accountData['scope'] ?? self::SCOPE_LOCAL, $accountData['verified'] ?? self::NOT_VERIFIED);
|
|
}
|
|
return $account;
|
|
}
|
|
|
|
public function getAccount(IUser $user): IAccount {
|
|
return $this->parseAccountData($user, $this->getUser($user));
|
|
}
|
|
|
|
public function updateAccount(IAccount $account): void {
|
|
$data = [];
|
|
|
|
foreach ($account->getProperties() as $property) {
|
|
$data[$property->getName()] = [
|
|
'value' => $property->getValue(),
|
|
'scope' => $property->getScope(),
|
|
'verified' => $property->getVerified(),
|
|
];
|
|
}
|
|
|
|
$this->updateUser($account->getUser(), $data, true);
|
|
}
|
|
}
|