Passage à Bootstrap 5 (8837d082) · Commits · lib / unicaen / auth

CHANGELOG.md

+7 −0

Original line number	Diff line number	Diff line
		CHANGELOG
		=========

		5.0.0
		-----
		- Migration vers Bootstrap 5 (front-end).
		- Infos à propos de la connexion dans le menu principal : simple bouton 'Connexion' si aucun utilisateur connecté ;
		bouton 'Déconnexion' déplacé dans le popover.

		4.0.2
		-----
		- RoleFormatter : correction pour exploiter la méthode __toString() si présente.
		@@ -13,6 +19,7 @@ CHANGELOG
		-----
		- Passage de Zend à Laminas


		3.2.10
		-----
		- Possibilité d'activer ou non (en config) les logs des échecs d'authentification LDAP.

composer.json

+1 −1

Original line number	Diff line number	Diff line
		@@ -8,7 +8,7 @@
		}
		],
		"require": {
		"unicaen/app": "^4.0",
		"unicaen/app": "^5.0",
		"unicaen/bjy-authorize": "^4.0",
		"jasig/phpcas": "^1.3",
		"ramsey/uuid": "^3.7",

src/UnicaenAuth/View/Helper/AppConnection.php

+23 −12

Original line number	Diff line number	Diff line
		<?php

		namespace UnicaenAuth\View\Helper;

		/**
		* Aide de vue générant le lien et les infos concernant la connexion à l'application.
		* Aide de vue dessinant :
		* - le nom de l'utilisateur connecté éventuel ;
		* - le lien de connexion/déconnexion.
		*
		* @author Bertrand GAUTHIER <bertrand.gauthier@unicaen.fr>
		* @author Unicaen
		*/
		class AppConnection extends \UnicaenApp\View\Helper\AppConnection
		{

		/**
		* Retourne le code HTML généré par cette aide de vue.
		*
		* @return string
		*/
		public function __toString()
		public function __toString(): string
		{
		$connexion = [];
		$parts = [];

		/** @var \UnicaenAuth\View\Helper\UserCurrent $userCurrentHelper */
		$userCurrentHelper = $this->getView()->plugin('userCurrent');
		if ($userCurrentHelper) {
		if ($html = "" . $userCurrentHelper) {
		$parts[] = $html;
		}
		}

		if (($tmp = $this->getView()->plugin('userCurrent'))) {
		$connexion[] = "" . $tmp;
		/** @var \UnicaenAuth\View\Helper\UserConnection $userConnectionHelper */
		$userConnectionHelper = $this->getView()->plugin('userConnection');
		if ($userConnectionHelper) {
		// On ne dessine que le lien de Connexion.
		// Le lien de déconnexion est dessiné dans le popover dédié à l'utilisateur connecté.
		if ($html = $userConnectionHelper->addClass('btn btn-success')->renderConnection()) {
		$parts[] = $html;
		}
		if (($tmp = $this->getView()->plugin('userConnection'))) {
		$connexion[] = "" . $tmp;
		}

		return implode(' \| ', $connexion);
		return implode(' \| ', $parts);
		}
		}
		No newline at end of file

src/UnicaenAuth/View/Helper/UserConnection.php

+81 −17

Original line number	Diff line number	Diff line
		<?php

		namespace UnicaenAuth\View\Helper;

		/**
		* Aide de vue de génération du lien de connexion/déconnexion à l'appli selon qu'un
		* utilisateur est connecté ou pas.
		* Aide de vue dessinant :
		* - soit le lien de connexion à l'appli : {@see renderConnection()}.
		* - soit le lien de déconnexion : {@see renderDisconnection()}.
		* - soit l'un ou l'autre selon qu'un utilisateur est connecté ou pas : {@see render()}.
		*
		* @author Bertrand GAUTHIER <bertrand.gauthier@unicaen.fr>
		* @author Unicaen
		*/
		class UserConnection extends UserAbstract
		{
		/**
		* Point d'entrée.
		*
		* @return UserConnection
		*/
		public function __invoke()
		protected $template = '<a class="%s" href="%s" title="%s">%s</a>';

		protected $classes = [
		'user-connection',
		//'navbar-link',
		];

		public function __invoke(): self
		{
		return $this;
		}

		public function addClass(string $class): self
		{
		$this->classes[] = $class;

		return $this;
		}

		/**
		* Retourne le code HTML généré par cette aide de vue.
		*
		* @return string
		*/
		public function __toString()
		{
		$template = '%s';
		$out = sprintf($template, $this->createConnectionLink());
		return $this->render();
		}

		return $out;
		public function render(): string
		{
		if ($this->getIdentity()) {
		return $this->renderDisconnection();
		} else {
		return $this->renderConnection();
		}
		}

		/**
		* @return string Lien de connexion, ou '' si l'utilisateur est déjà connecté.
		*/
		public function renderConnection(): string
		{
		if ($this->getIdentity()) {
		return '';
		}

		$urlHelper = $this->getView()->plugin('url');
		$href = $urlHelper('zfcuser/login');
		$lib = "Connexion";
		$title = "Cliquez pour vous authentifier";

		if ($this->getTranslator()) {
		$lib = $this->getTranslator()->translate($lib, $this->getTranslatorTextDomain());
		$title = $this->getTranslator()->translate($title, $this->getTranslatorTextDomain());
		}

		$classes = implode(' ', $this->classes);

		return sprintf($this->template, $classes, $href, $title, $lib);
		}

		/**
		* @return string Lien de déconnexion, ou '' si aucun utilisateur n'est connecté.
		*/
		public function renderDisconnection(): string
		{
		if (!$this->getIdentity()) {
		return '';
		}

		$urlHelper = $this->getView()->plugin('url');
		$href = $urlHelper('zfcuser/logout');
		$lib = "Déconnexion";
		$title = "Cliquez pour vous déconnecter";

		if ($this->getTranslator()) {
		$lib = $this->getTranslator()->translate($lib, $this->getTranslatorTextDomain());
		$title = $this->getTranslator()->translate($title, $this->getTranslatorTextDomain());
		}

		$classes = implode(' ', $this->classes);

		return sprintf($this->template, $classes, $href, $title, $lib);
		}

		/**
		*
		* @return string
		* @deprecated Utiliser {@see render()}
		*/
		protected function createConnectionLink()
		{
		@@ -42,11 +106,11 @@ class UserConnection extends UserAbstract

		$urlHelper = $this->getView()->plugin('url');

		$template = '<a class="navbar-link user-connection" href="%s" title="%s">%s</a>';
		$template = '<a class="btn btn-lg btn-outline-primary navbar-link user-connection" href="%s" title="%s">%s</a>';
		if (!$identity) {
		$href = $urlHelper('zfcuser/login');
		$lib = "Connexion";
		$title = "Affiche le formulaire d'authentification";
		$title = "Cliquez pour vous authentifier";
		}
		else {
		$href = $urlHelper('zfcuser/logout');

src/UnicaenAuth/View/Helper/UserCurrent.php

+68 −56

Original line number	Diff line number	Diff line
		@@ -2,11 +2,14 @@
		namespace UnicaenAuth\View\Helper;

		/**
		* Aide de vue affichant toutes les infos concernant l'utilisateur courant.
		* C'est à dire :
		* - "Aucun" + lien de connexion OU BIEN nom de l'utilisateur connecté + lien de déconnexion
		* - profil de l'utilisateur connecté
		* - infos administratives sur l'utilisateur
		* Aide de vue affichant toutes les infos concernant l'utilisateur connecté.
		* C'est à dire le nom de l'utilisateur connecté & son rôle courant.
		*
		* Lorsqu'on clique sur le nom, s'affiche un popover
		* présentant les rôles sélectionnables, des infos administratives, le formulaire d'usurpation (si habilité)
		* et le lien de déconnexion.
		*
		* Si aucun utilisateur n'est connecté, cette aide de vue renvoit ''.
		*
		* @author Bertrand GAUTHIER <bertrand.gauthier@unicaen.fr>
		*/
		@@ -37,14 +40,20 @@ class UserCurrent extends UserAbstract
		*/
		public function __toString(): string
		{
		$id = 'user-current-info';

		$userStatusHelper = $this->getView()->plugin('userStatus'); /* @var $userStatusHelper UserStatus */
		$status = $userStatusHelper(false);
		if (! $this->getIdentity()) {
		return '';
		}

		//
		// Sous la forme d'un lien :
		//
		// - Nom de l'utilisateur connecté, le cas échéant.
		/* @var $userStatusHelper UserStatus */
		$userStatusHelper = $this->view->plugin('userStatus');
		$nom = $userStatusHelper(false);
		// - Rôle courant.
		$role = '';
		$userProfileSelectable = true;

		if ($this->getIdentity()) {
		if ($userProfileSelectable) {
		$role = $this->getUserContext()->getSelectedIdentityRole();
		// cas où aucun rôle n'est sélectionné : on affiche le 1er rôle sélectionnable ou sinon "user"
		@@ -52,50 +61,53 @@ class UserCurrent extends UserAbstract
		$selectableRoles = $this->getUserContext()->getSelectableIdentityRoles();
		$role = current($selectableRoles) ?: $this->getUserContext()->getIdentityRole('user');
		}
		$status .= sprintf(", <small class='role-libelle'>%s</small>", !method_exists($role, '__toString') ? $role->getRoleId() : $role);
		$role = sprintf(
		"<br/><small class='role-libelle'>%s</small>",
		!method_exists($role, '__toString') ? $role->getRoleId() : $role
		);
		}

		$userProfileHelper = $this->getView()->plugin('userProfile'); /* @var $userProfileHelper UserProfile */
		//
		// Dans un popover :
		//
		// - Rôles sélectionnables.
		/* @var \UnicaenAuth\View\Helper\UserProfile $userProfileHelper */
		$userProfileHelper = $this->view->plugin('userProfile');
		$userProfileHelper->setUserProfileSelectable($userProfileSelectable);

		$userInfoHelper = $this->getView()->plugin('userInfo'); /* @var $userInfoHelper UserInfo */

		$content = $userProfileHelper . $userInfoHelper($this->getAffectationFineSiDispo());
		}
		else {
		$content = _("Aucun");
		if ($this->getTranslator()) {
		$content = $this->getTranslator()->translate($content, $this->getTranslatorTextDomain());
		}
		}

		$content = htmlspecialchars(preg_replace('/\r\n\|\n\|\r/', '', $content));

		$title = _("Utilisateur connecté à l'application");
		if ($this->getTranslator()) {
		$title = $this->getTranslator()->translate($title, $this->getTranslatorTextDomain());
		}

		$out = <<<EOS
		<a class="navbar-link"
		id="$id"
		title="$title"
		data-placement="bottom"
		data-toggle="popover"
		data-html="true"
		data-content="$content"
		href="#">$status<span class="caret"></span></a>
		EOS;
		$out .= PHP_EOL;

		$js = <<<EOS
		$(function() {
		$("#$id").popover({ html: true, sanitize: false, container: '#navbar' });
		});
		$roles = (string) $userProfileHelper;
		// - Infos administratives.
		/* @var \UnicaenAuth\View\Helper\UserInfo $userInfoHelper */
		$userInfoHelper = $this->view->plugin('userInfo');
		$infos = (string) $userInfoHelper($this->getAffectationFineSiDispo());
		// - Usurpation d'identité.
		/* @var \UnicaenAuth\View\Helper\UserUsurpationHelper $userUsurpationHelper */
		$userUsurpationHelper = $this->view->plugin('userUsurpation');
		$usurpation = (string) $userUsurpationHelper;
		// - Lien de déconnexion.
		/** @var \UnicaenAuth\View\Helper\UserConnection $userConnectionHelper */
		$userConnectionHelper = $this->getView()->plugin('userConnection');
		$deconnexion = $userConnectionHelper->addClass('btn btn-lg btn-outline-success')->renderDisconnection();

		$linkText = $nom . $role;
		$popoverContent = htmlspecialchars(preg_replace('/\r\n\|\n\|\r/', '',
		$roles .
		$infos .
		$usurpation .
		'<hr>' .
		'<div class="text-center">' . $deconnexion . '</div>'
		));

		return <<<EOS
		<a class="navbar-link dropdown-toggle"
		id="user-current-info"
		data-bs-placement="bottom"
		data-bs-toggle="popover"
		data-bs-container="#navbar"
		data-bs-html="true"
		data-bs-sanitize="false"
		data-bs-content="$popoverContent"
		href="#">$linkText<span class="caret"></span></a>
		EOS;
		$this->getView()->plugin('inlineScript')->offsetSetScript(1000, $js);

		return $out;
		}

		/**