Files
Phraseanet/lib/Alchemy/Phrasea/Helper/User/Manage.php
Aina Sitraka d6849fd580 PHRAS-4007: Auth provider - add keycloak provider - openid (#4462)
* keycloak provider

* add readme

* comment regenarete password

* add exclusive option to provider an column can_renew_passwor to user

* default exclusive false

* always compatible with psauth

* bump image tag .env

* bump Version to 4.1.8-rc9

* bump version to rc12

* add autoconnect
2024-04-30 14:15:56 +02:00

284 lines
12 KiB
PHP

<?php
/*
* This file is part of Phraseanet
*
* (c) 2005-2016 Alchemy
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Alchemy\Phrasea\Helper\User;
use Alchemy\Phrasea\Application;
use Alchemy\Phrasea\Application\Helper\NotifierAware;
use Alchemy\Phrasea\Core\LazyLocator;
use Alchemy\Phrasea\Helper\Helper;
use Alchemy\Phrasea\Model\Repositories\UserRepository;
use Alchemy\Phrasea\Notification\Receiver;
use Alchemy\Phrasea\Notification\Mail\MailRequestPasswordSetup;
use Alchemy\Phrasea\Notification\Mail\MailRequestEmailConfirmation;
use Alchemy\Phrasea\Model\Entities\User;
use Doctrine\Persistence\ObjectManager;
use Symfony\Component\HttpFoundation\Request;
class Manage extends Helper
{
use NotifierAware;
/** @var array */
protected $query_parms;
/** @var int */
protected $usr_id;
public function __construct(Application $app, Request $Request)
{
parent::__construct($app, $Request);
$this->setDelivererLocator(new LazyLocator($app, 'notification.deliverer'));
}
/**
* @return User[]
*/
public function export()
{
$request = $this->request;
$offset_start = (int) $request->get('offset_start');
$offset_start = $offset_start < 0 ? 0 : $offset_start;
$this->query_parms = [
'inactives' => $request->get('inactives'),
'like_field' => $request->get('like_field'),
'like_type' => $this->request->get('like_type'),
'like_value' => $request->get('like_value'),
'sbas_id' => $request->get('sbas_id'),
'base_id' => $request->get('base_id'),
'last_model' => $this->request->get('last_model'),
'filter_guest_user' => $this->request->get('filter_guest_user') ? true : false,
'filter_phantoms_only' => $this->request->get('filter_phantoms_only') ? true : false,
'filter_model_only' => $this->request->get('filter_model_only') ? true : false,
'filter_mail_locked_only' => $this->request->get('filter_mail_locked_only') ? true : false,
'filter_grace_period_only' => $this->request->get('filter_grace_period_only') ? true : false,
'filter_with_api_only' => $this->request->get('filter_with_api_only') ? true : false,
'srt' => $request->get("srt", \User_Query::SORT_CREATIONDATE),
'ord' => $request->get("ord", \User_Query::ORD_DESC),
'offset_start' => $offset_start,
];
/** @var \User_Query $query */
$query = $this->app['phraseanet.user-query'];
if (is_array($this->query_parms['base_id']))
$query->on_base_ids($this->query_parms['base_id']);
elseif (is_array($this->query_parms['sbas_id']))
$query->on_sbas_ids($this->query_parms['sbas_id']);
$results = $query->sort_by($this->query_parms["srt"], $this->query_parms["ord"])
->like($this->query_parms['like_field'], $this->query_parms['like_value'], $this->query_parms['like_type'])
->last_model_is($this->query_parms['last_model'])
->templates_only($this->query_parms['filter_model_only'])
->mail_locked_only($this->query_parms['filter_mail_locked_only'])
->grace_period_only($this->query_parms['filter_grace_period_only'])
->with_api_only($this->query_parms['filter_with_api_only'])
->get_inactives($this->query_parms['inactives'])
->include_templates(false)
->include_invite($this->query_parms['filter_guest_user'])
->phantoms_only($this->query_parms['filter_phantoms_only'])
->on_bases_where_i_am($this->app->getAclForUser($this->app->getAuthenticatedUser()), [\ACL::CANADMIN])
->execute();
return $results->get_results();
}
public function search()
{
$offset_start = (int) $this->request->get('offset_start');
$offset_start = $offset_start < 0 ? 0 : $offset_start;
$results_quantity = (int) $this->request->get('per_page');
$results_quantity = ($results_quantity < 10 || $results_quantity > 50) ? 20 : $results_quantity;
$this->query_parms = [
'inactives' => $this->request->get('inactives'),
'like_field' => $this->request->get('like_field'),
'like_type' => $this->request->get('like_type'),
'like_value' => $this->request->get('like_value'),
'date_field' => $this->request->get('date_field'),
'date_operator' => $this->request->get('date_operator'),
'date_value' => $this->request->get('date_value'),
'sbas_id' => $this->request->get('sbas_id'),
'base_id' => $this->request->get('base_id'),
'last_model' => $this->request->get('last_model'),
'filter_guest_user' => $this->request->get('filter_guest_user') ? true : false,
'filter_phantoms_only' => $this->request->get('filter_phantoms_only') ? true : false,
'filter_model_only' => $this->request->get('filter_model_only') ? true : false,
'filter_mail_locked_only' => $this->request->get('filter_mail_locked_only') ? true : false,
'filter_grace_period_only' => $this->request->get('filter_grace_period_only') ? true : false,
'filter_with_api_only' => $this->request->get('filter_with_api_only') ? true : false,
'srt' => $this->request->get("srt", \User_Query::SORT_CREATIONDATE),
'ord' => $this->request->get("ord", \User_Query::ORD_DESC),
'per_page' => $results_quantity,
'offset_start' => $offset_start,
];
/** @var \User_Query $query */
$query = $this->app['phraseanet.user-query'];
if (is_array($this->query_parms['base_id']))
$query->on_base_ids($this->query_parms['base_id']);
elseif (is_array($this->query_parms['sbas_id']))
$query->on_sbas_ids($this->query_parms['sbas_id']);
$results = $query->sort_by($this->query_parms["srt"], $this->query_parms["ord"])
->like($this->query_parms['like_field'], $this->query_parms['like_value'], $this->query_parms['like_type'])
->date_filter($this->query_parms['date_field'], $this->query_parms['date_value'], $this->query_parms['date_operator'])
->last_model_is($this->query_parms['last_model'])
->get_inactives($this->query_parms['inactives'])
->templates_only($this->query_parms['filter_model_only'])
->mail_locked_only($this->query_parms['filter_mail_locked_only'])
->grace_period_only($this->query_parms['filter_grace_period_only'])
->with_api_only($this->query_parms['filter_with_api_only'])
->include_invite($this->query_parms['filter_guest_user'])
->phantoms_only($this->query_parms['filter_phantoms_only'])
->on_bases_where_i_am($this->app->getAclForUser($this->app->getAuthenticatedUser()), [\ACL::CANADMIN])
->limit($offset_start, $results_quantity)
->execute();
if (null === $invite = $this->app['repo.users']->findByLogin(User::USER_GUEST)) {
$invite = $this->app['manipulator.user']->createUser(User::USER_GUEST, User::USER_GUEST);
}
if (null === $autoregister = $this->app['repo.users']->findByLogin(User::USER_AUTOREGISTER)) {
$autoregister = $this->app['manipulator.user']->createUser(User::USER_AUTOREGISTER, User::USER_AUTOREGISTER);
}
foreach ($this->query_parms as $k => $v) {
if (is_null($v))
$this->query_parms[$k] = false;
}
$query = $this->app['phraseanet.user-query'];
$templates = $query
->only_user_templates(true)
->execute()->get_results();
return [
'users' => $results,
'parm' => $this->query_parms,
'invite_user' => $invite,
'autoregister_user' => $autoregister,
'templates' => $templates
];
}
public function createNewUser()
{
$email = trim($this->request->get('value'));
if ( ! \Swift_Validate::email($email)) {
throw new \Exception_InvalidArgument('Invalid mail address');
}
if (null === $createdUser = $this->app['repo.users']->findByEmail($email)) {
$createdUser = $this->app['manipulator.user']->createUser($email, $this->app['random.medium']->generateString(128), $email);
$sendCredential = (bool) $this->request->get('send_credentials', false);
if ((bool) $this->request->get('validate_mail', false)) {
$createdUser->setMailLocked(true);
// if $sendCredential is also true,password setup is sent after mail confirmation
$this->sendAccountUnlockEmail($createdUser, $sendCredential);
}
if ($sendCredential == true && (bool) $this->request->get('validate_mail', false) == false) {
$this->sendPasswordSetupMail($createdUser);
}
}
$this->usr_id = $createdUser->getId();
return $createdUser;
}
public function createTemplate()
{
$name = $this->request->get('value');
if (trim($name) === '') {
throw new \Exception_InvalidArgument('Invalid template name');
}
$created_user = $this->app['manipulator.user']->createTemplate($name, $this->app->getAuthenticatedUser());
$this->usr_id = $this->app->getAuthenticatedUser()->getId();
return $created_user;
}
public function sendAccountUnlockEmail(User $user, $sendCredentials = false)
{
$receiver = Receiver::fromUser($user);
$token = $this->app['manipulator.token']->createAccountUnlockToken($user);
$mail = MailRequestEmailConfirmation::create($this->app, $receiver);
$mail->setButtonUrl($this->app->url('login_register_confirm', ['code' => $token->getValue(), 'send_credentials' => $sendCredentials]));
$mail->setExpiration($token->getExpiration());
if (($locale = $user->getLocale()) != null) {
$mail->setLocale($locale);
}
$this->deliver($mail);
}
public function sendPasswordSetupMail(User $user)
{
$receiver = Receiver::fromUser($user);
$token = $this->app['manipulator.token']->createResetPasswordToken($user);
$mail = MailRequestPasswordSetup::create($this->app, $receiver);
$mail->setButtonUrl($this->app->url('login_renew_password', ['token' => $token->getValue()]));
$mail->setLogin($user->getLogin());
if (($locale = $user->getLocale()) != null) {
$mail->setLocale($locale);
}
$this->deliver($mail);
}
public function setMailLocked()
{
/** @var UserRepository $userRepository */
$userRepository = $this->app['repo.users'];
$user = $userRepository->find($this->request->request->get('user_id'));
$status = $this->request->request->get('action') == 'locked' ? true : false;
$user->setMailLocked($status);
$this->getObjectManager()->persist($user);
$this->getObjectManager()->flush();
}
public function setCanRenewPassword()
{
/** @var UserRepository $userRepository */
$userRepository = $this->app['repo.users'];
$user = $userRepository->find($this->request->request->get('user_id'));
$status = $this->request->request->get('action') == 'can-renew' ? true : false;
$user->setCanRenewPassword($status);
$this->getObjectManager()->persist($user);
$this->getObjectManager()->flush();
}
/**
* @return ObjectManager
*/
private function getObjectManager()
{
return $this->app['orm.em'];
}
}