Skip to content

added logging to delete loop #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liviu-preda-tsystems merged 2 commits into from
Jul 9, 2024
Merged

added logging to delete loop #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f33a74
added logging to delete loop
memurats Jul 9, 2024
b227fc3
fixed php cs
memurats Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 44 additions & 47 deletions lib/Rules/UserAccountRules.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,23 @@ class UserAccountRules {
/** @var NmcUserService */
private $nmcUserService;

/** @var IUserManager */
private $userManager;
/** @var IUserManager */
private $userManager;

/** @var ProviderMapper */
private $oidcProviderMapper;
/** @var ProviderMapper */
private $oidcProviderMapper;

public function __construct(IConfig $config,
ILogger $logger,
NmcUserService $nmcUserService,
IUserManager $userManager,
ProviderMapper $oidcProviderMapper)
{
ILogger $logger,
NmcUserService $nmcUserService,
IUserManager $userManager,
ProviderMapper $oidcProviderMapper) {
$this->config = $config;
$this->logger = $logger;
$this->nmcUserService = $nmcUserService;
$this->userManager = $userManager;
$this->oidcProviderMapper = $oidcProviderMapper;
}
$this->userManager = $userManager;
$this->oidcProviderMapper = $oidcProviderMapper;
}

/**
* Check whether NextMagentaCloud product is booked on customer.
Expand Down Expand Up @@ -108,20 +107,19 @@ public function withdrawDate($claims) : \DateTime {
}
}

/**
* @param string $displayname
* @param string $testParam
* @return bool
*/
public function isTestAccount(string $displayname, string $testParam = "-test", string $explodeParam = "@"): bool
{
$explode = (str_contains($explodeParam, $displayname)) ? explode($explodeParam, $displayname) : $displayname;
if (is_array($explode)) {
return str_contains($explode[0], $testParam);
} else {
return str_contains($explode, $testParam);
}
}
/**
* @param string $displayname
* @param string $testParam
* @return bool
*/
public function isTestAccount(string $displayname, string $testParam = "-test", string $explodeParam = "@"): bool {
$explode = (str_contains($explodeParam, $displayname)) ? explode($explodeParam, $displayname) : $displayname;
if (is_array($explode)) {
return str_contains($explode[0], $testParam);
} else {
return str_contains($explode, $testParam);
}
}

/**
*
Expand All @@ -132,27 +130,26 @@ public function isTestAccount(string $displayname, string $testParam = "-test",
* `sudo -u www-data php /var/www/nextcloud/occ config:app:set nmcprovisioning userratesurl --value "https://cloud.telekom-dienste.de/tarife"`
*/
public function deriveAccountState(string $uid, ?string $displayname, ?string $mainEmail,
string $quota, object $claims, bool $create = true, $providerName = 'Telekom'): array
{
string $quota, object $claims, bool $create = true, $providerName = 'Telekom'): array {
$this->logger->info("PROV {$uid}: Check user existence");
$this->logger->debug("Account change event: " . json_encode(get_object_vars($claims)));
$this->logger->debug("Provider {$uid}: " . $providerName);
$config = $this->config->getSystemValue('nmc_provisioning', [
'slup_test_account_check' => true,
'slup_test_account_name' => '-test',
'slup_test_account_explode' => '@'
]);
if ($user = $this->nmcUserService->userExists($providerName, $uid, true)) {
$this->logger->debug("Account change event: " . json_encode(get_object_vars($claims)));
$this->logger->debug("Provider {$uid}: " . $providerName);
$config = $this->config->getSystemValue('nmc_provisioning', [
'slup_test_account_check' => true,
'slup_test_account_name' => '-test',
'slup_test_account_explode' => '@'
]);
if ($user = $this->nmcUserService->userExists($providerName, $uid, true)) {
$this->logger->info("PROV {$uid}: Modify existing");
return $this->deriveExistingAccountState($user, $displayname, $mainEmail, $quota, $claims, $providerName);
} elseif ($create || $config['slup_test_account_check'] &&
$this->isTestAccount($displayname,$config['slup_test_account_name'],$config['slup_test_account_explode'])) {
return $this->deriveExistingAccountState($user, $displayname, $mainEmail, $quota, $claims, $providerName);
} elseif ($create || $config['slup_test_account_check'] &&
$this->isTestAccount($displayname, $config['slup_test_account_name'], $config['slup_test_account_explode'])) {
$this->logger->info("PROV {$uid}: Create");
return $this->deriveNewAccountState($uid, $displayname, $mainEmail, $quota, $claims, $providerName);
}else{
$this->logger->info("PROV {$uid}: No create");
return array('allowed' => true, 'reason' => 'No create - please login with the user', 'changed' => true);
}
return $this->deriveNewAccountState($uid, $displayname, $mainEmail, $quota, $claims, $providerName);
} else {
$this->logger->info("PROV {$uid}: No create");
return array('allowed' => true, 'reason' => 'No create - please login with the user', 'changed' => true);
}
}

/**
Expand All @@ -161,7 +158,7 @@ public function deriveAccountState(string $uid, ?string $displayname, ?string $m
* In many negative cases, no user account is created at all.
*/
protected function deriveNewAccountState(string $uid, ?string $displayname, ?string $mainEmail,
string $quota, object $claims, $providerName) : array {
string $quota, object $claims, $providerName) : array {
if (is_null($displayname)) {
$this->logger->error("{$uid}: New user without displayName");
return array('allowed' => false, 'reason' => 'No displayname no new account', 'changed' => false);
Expand All @@ -180,7 +177,7 @@ protected function deriveNewAccountState(string $uid, ?string $displayname, ?str
return array('allowed' => false, 'reason' => 'No tariff no new account', 'changed' => false, 'redirect' => $withdrawUrl);
}

$this->nmcUserService->create($providerName, $uid, $displayname, $mainEmail, $quota);
$this->nmcUserService->create($providerName, $uid, $displayname, $mainEmail, $quota);
$this->logger->info("{$uid}: New user created");
return array('allowed' => true, 'reason' => 'Created', 'changed' => true);
}
Expand Down Expand Up @@ -212,7 +209,7 @@ public function deriveExistingAccountState(User|IUser $user, ?string $displaynam

// update case
// user is active and gets update
//TODO Check is update required????
//TODO Check is update required????
$this->nmcUserService->update($user, $displayname, $mainEmail, $quota, true);
return array('allowed' => true, 'reason' => 'Updated', 'changed' => true);
} else {
Expand Down
191 changes: 94 additions & 97 deletions lib/User/NmcUserService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ public function userExists(string $provider, string $username, bool $returnUser
try {
$user = $this->findUser($provider, $username);

if ($returnUser){
return $user;
}
if ($returnUser) {
return $user;
}

return true;
} catch (NotFoundException $eNotFound) {
Expand Down Expand Up @@ -239,41 +239,39 @@ public function findAll(string $provider, string $pattern = null, ?int $limit =
/**
* Encapsulation
*/
protected function createOidcUser(string $providerId, string $username, string $displayname)
{
protected function createOidcUser(string $providerId, string $username, string $displayname) {
// old way with hashed names only:
// return $this->oidcUserMapper->getOrCreate($providerId, $username);
$userId = $this->computeUserId($providerId, $username);
$user = new User();
$user->setUserId($userId);
$this->logger->debug("PROV displayname");
$user->setDisplayName($displayname);
$this->logger->debug("PROV displayname");
$user->setDisplayName($displayname);
return $this->oidcUserMapper->insert($user);
}

protected function createAccountUser(IUser $user, $email, string $quota, bool $enabled)
{
/*if ($altemail !== null) {
$this->logger->debug("PROV altemail");
$userAccount = $this->accountManager->getAccount($user);
$userAccount->setProperty(IAccountManager::PROPERTY_ADDRESS, $altemail,
IAccountManager::SCOPE_PRIVATE, IAccountManager::VERIFIED);
$this->accountManager->updateAccount($userAccount);
}*/

if ($email !== null) {
$this->logger->debug("PROV email");
$user->setEMailAddress($email);
}

$this->logger->debug("PROV quota");
$user->setQuota($quota);
$this->autoGroupMatch($user, $quota);
$this->logger->debug("PROV enable");
$user->setEnabled($enabled);
/*$this->logger->debug("PROV migration flag");
$this->setMigrationFlag($user->getUID(), $migrated);*/
}
protected function createAccountUser(IUser $user, $email, string $quota, bool $enabled) {
/*if ($altemail !== null) {
$this->logger->debug("PROV altemail");
$userAccount = $this->accountManager->getAccount($user);
$userAccount->setProperty(IAccountManager::PROPERTY_ADDRESS, $altemail,
IAccountManager::SCOPE_PRIVATE, IAccountManager::VERIFIED);
$this->accountManager->updateAccount($userAccount);
}*/

if ($email !== null) {
$this->logger->debug("PROV email");
$user->setEMailAddress($email);
}

$this->logger->debug("PROV quota");
$user->setQuota($quota);
$this->autoGroupMatch($user, $quota);
$this->logger->debug("PROV enable");
$user->setEnabled($enabled);
/*$this->logger->debug("PROV migration flag");
$this->setMigrationFlag($user->getUID(), $migrated);*/
}


/**
Expand All @@ -290,94 +288,93 @@ public function create(string $provider,
throw new UserExistException("OpenID user " . $provider . ":" . $username . " already exists!");
}*/

//Create oidc user
//Create oidc user
$this->logger->debug("PROV create db user");
$oidcUser = $this->createOidcUser($providerId, $username, $displayname);
$oidcUser = $this->createOidcUser($providerId, $username, $displayname);

//Create account user
//Create account user
$this->logger->debug("PROV standard account");
$user = $this->userManager->get($oidcUser->getUserId());
$this->logger->info("UserID: ".$oidcUser->getUserId());
$this->createAccountUser($user, $email, $quota, $enabled);

/* try {
$this->logger->debug("PROV folder");
$this->serverc->get('UserFolder')->create($user->getUID());
$userFolder = $this->serverc->getUserFolder($user->getUID());
\OC::$server->getLogger()->debug('nmcuser_oidc: User folder created "' . $user->getUID() . '", exists=' . ($this->serverc->getRootFolder()->nodeExists('/' . $user->getUID() . '/files') ? 'true' : 'false'), ['app' => 'debug_create']);

// Write a temporary file to the user home to make sure it is properly setup
// FIXME: Remove once the issue with the missing user directory on concurrent webdav requests are sorted out
$file = $userFolder->newFile('.userCreateTemp');
$file->delete();

// copy skeleton
\OC_Util::copySkeleton($user->getUID(), $userFolder);
} catch (NotPermittedException $ex) {
\OC::$server->getLogger()->logException($ex, ['app' => 'nmcuser_oidc']);
throw new ForbiddenException("Newly created user cannot init home folder. Reason:\n" . $ex->getMessage());
}*/
$this->createAccountUser($user, $email, $quota, $enabled);

/* try {
$this->logger->debug("PROV folder");
$this->serverc->get('UserFolder')->create($user->getUID());
$userFolder = $this->serverc->getUserFolder($user->getUID());
\OC::$server->getLogger()->debug('nmcuser_oidc: User folder created "' . $user->getUID() . '", exists=' . ($this->serverc->getRootFolder()->nodeExists('/' . $user->getUID() . '/files') ? 'true' : 'false'), ['app' => 'debug_create']);

// Write a temporary file to the user home to make sure it is properly setup
// FIXME: Remove once the issue with the missing user directory on concurrent webdav requests are sorted out
$file = $userFolder->newFile('.userCreateTemp');
$file->delete();

// copy skeleton
\OC_Util::copySkeleton($user->getUID(), $userFolder);
} catch (NotPermittedException $ex) {
\OC::$server->getLogger()->logException($ex, ['app' => 'nmcuser_oidc']);
throw new ForbiddenException("Newly created user cannot init home folder. Reason:\n" . $ex->getMessage());
}*/

return [
'id' => $oidcUser->getUserId()
];
}

protected function updateUserSettings(IUser $user, string|null $email, string|null $quota, bool $enabled){
if (!empty($email) &&
strtolower($email) !== strtolower($user->getEMailAddress())) {
$this->logger->debug("PROV email {$user->getUID()} old: {$user->getEMailAddress()} new: {$email}");
$user->setEMailAddress($email);
}

//Its enough to check the string value from quota, the group mapping is matching with exact quota string
if (!is_null($quota) &&
$quota !== $user->getQuota()) {
$this->logger->debug("PROV quota {$user->getUID()} old: {$user->getQuota()} new: {$quota}");
$user->setQuota($quota);
$this->autoGroupMatch($user, $quota);
}

if ($enabled !== $user->isEnabled()) {
$user->setEnabled($enabled);
}
}

protected function updateOidcUser(User $oidcUser, string|null $displayname)
{
//Check is displayname changed
if (!is_null($displayname) &&
$displayname !== $oidcUser->getDisplayName()) {
$this->logger->debug("PROV displayname {$oidcUser->getUserId()} old: {$oidcUser->getDisplayName()} new: {$displayname}");
$oidcUser->setDisplayName($displayname);
$this->oidcUserMapper->update($oidcUser);
}
}

public function update(User|IUser $user,
protected function updateUserSettings(IUser $user, string|null $email, string|null $quota, bool $enabled) {
if (!empty($email) &&
strtolower($email) !== strtolower($user->getEMailAddress())) {
$this->logger->debug("PROV email {$user->getUID()} old: {$user->getEMailAddress()} new: {$email}");
$user->setEMailAddress($email);
}

//Its enough to check the string value from quota, the group mapping is matching with exact quota string
if (!is_null($quota) &&
$quota !== $user->getQuota()) {
$this->logger->debug("PROV quota {$user->getUID()} old: {$user->getQuota()} new: {$quota}");
$user->setQuota($quota);
$this->autoGroupMatch($user, $quota);
}

if ($enabled !== $user->isEnabled()) {
$user->setEnabled($enabled);
}
}

protected function updateOidcUser(User $oidcUser, string|null $displayname) {
//Check is displayname changed
if (!is_null($displayname) &&
$displayname !== $oidcUser->getDisplayName()) {
$this->logger->debug("PROV displayname {$oidcUser->getUserId()} old: {$oidcUser->getDisplayName()} new: {$displayname}");
$oidcUser->setDisplayName($displayname);
$this->oidcUserMapper->update($oidcUser);
}
}

public function update(User|IUser $user,
$displayname = null,
$email = null,
$quota = null,
bool $enabled = null) {
$this->logger->debug("PROV standard account");
$oidcUser = $this->oidcUserMapper->getUser($user->getUID());
// $userAccount = $this->accountManager->getAccount($user);
// $userAccount = $this->accountManager->getAccount($user);

/* if ($altemail !== null) {
$this->logger->debug("PROV altemail");
$userAccount->setProperty(IAccountManager::PROPERTY_ADDRESS, $altemail,
IAccountManager::SCOPE_PRIVATE, IAccountManager::VERIFIED);
$this->accountManager->updateAccount($userAccount);
}*/
/* if ($altemail !== null) {
$this->logger->debug("PROV altemail");
$userAccount->setProperty(IAccountManager::PROPERTY_ADDRESS, $altemail,
IAccountManager::SCOPE_PRIVATE, IAccountManager::VERIFIED);
$this->accountManager->updateAccount($userAccount);
}*/

/* if ($migrated !== null) {
$this->logger->debug("PROV migration flag");
$this->setMigrationFlag($user->getUID(), $migrated);
}*/
/* if ($migrated !== null) {
$this->logger->debug("PROV migration flag");
$this->setMigrationFlag($user->getUID(), $migrated);
}*/

$this->updateOidcUser($oidcUser, $displayname);
$this->updateOidcUser($oidcUser, $displayname);

$this->updateUserSettings($user, $email, $quota, $enabled);
$this->updateUserSettings($user, $email, $quota, $enabled);

$this->logger->debug("PROV read state");
$userState = [
Expand Down
2 changes: 2 additions & 0 deletions lib/User/UserAccountDeletionJob.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ public function run($arguments) {
foreach ($expiredUids as $uid) {
try {
$user = $this->userManager->get($uid);
$this->logger->info("Deleting " . $uid);
$user->delete();
$this->logger->info(\count($uid) . " deleted");
} catch (\Throwable $e) {
$this->logger->logException($e, [
'message' => $uid . ': Deletion failed with ' . $e->getMessage(),
Expand Down