import RoleUtils from '~/services/rights/roleUtils' import {AbilitiesType} from '~/types/interfaces' import {MongoAbility} from "@casl/ability/dist/types/Ability"; import {ABILITIES} from "~/types/enum/enums"; import yaml from "yaml-import"; import * as _ from 'lodash-es' interface Condition { function: string parameters?: Array expectedResult?: any } /** * Classe permettant de mener des opérations sur les habilités */ class AbilityBuilder { private readonly ability: MongoAbility = {} as MongoAbility private readonly accessProfile: any private readonly organizationProfile: any private readonly configFile = './config/abilities/config.yaml' private abilities: Array = [] /** * @constructor */ constructor( ability: MongoAbility, accessProfile: any, organizationProfile: any, ) { this.ability = ability this.accessProfile = accessProfile this.organizationProfile = organizationProfile } /** * Construit et renvoie l'ensemble des habilités de l'utilisateur, qu'elles soient issues de ses roles * ou de la configuration * * @return {Array} */ buildAbilities(): Array { // Build from roles this.abilities = this.buildAbilitiesFromRoles() this.ability.update(this.abilities) // Build from config this.abilities = this.abilities.concat(this.buildAbilitiesFromConfig()) this.ability.update(this.abilities) return this.abilities } /** * Adaptation et transformations des roles symfony en abilities Casl */ buildAbilitiesFromRoles() { return RoleUtils.rolesToAbilities(this.accessProfile.roles) } /** * Charge les habilités depuis les fichiers de configuration */ buildAbilitiesFromConfig() { const abilitiesByConfig: Array = [] const doc = yaml.read(this.configFile) const fromConfig = doc.abilities _.each(fromConfig, (ability: { action: ABILITIES, conditions: Array }, subject: string) => { let { action, conditions } = ability if (!Array.isArray(conditions)) { // Special: la denormalization ne produit pas une array s'il n'y a qu'un seul élément conditions = [conditions] } if (this.hasConfigAbility(conditions as Array, subject)) { abilitiesByConfig.push({ action, subject }) } }) return abilitiesByConfig } /** * Parcourt les services définis dans la configuration, et établit si oui ou non l'habilité est autorisée * * @return {boolean} * @param conditions Les conditions à l'obtention de l'habileté, telles que définies dans les fichiers de config * @param subject For debugging purpose only */ hasConfigAbility(conditions: Array, subject: string = '') { return conditions.every((condition) => this.execAndValidateCondition(condition, subject)) } // noinspection JSUnusedGlobalSymbols /** * Correspondances entre les noms des fonctions définies dans les conditions des fichiers de configuration et * les méthodes correspondantes * * TODO: voir pourquoi on a besoin d'accepter un param null pour le hasProfile? */ handlerMap: any = { accessHasAllRoleAbilities: (parameters: any) => this.hasAllRoleAbilities(parameters), accessHasAnyRoleAbility: (parameters: any) => this.hasAnyRoleAbility(parameters), accessHasAnyProfile: (parameters: any) => parameters === null || this.hasAnyProfile(parameters), organizationHasAllModules: (parameters: any) => this.hasAllModules(parameters), organizationHasAnyModule: (parameters: any) => this.hasAnyModule(parameters), accessIsAdminAccount: (parameters: any) => this.accessProfile.isAdminAccount, organizationIsSchool: (parameters: any) => this.organizationProfile.isSchool, organizationIsArtist: (parameters: any) => this.organizationProfile.isArtist, organizationIsManagerProduct: (parameters: any) => this.organizationProfile.isManagerProduct, organizationHasChildren: (parameters: any) => this.organizationProfile.hasChildren, organizationIsAssociation: (parameters: any) => this.organizationProfile.isAssociation, organizationIsShowAdherentList: (parameters: any) => this.organizationProfile.isShowAdherentList, organizationIsCmf: (parameters: any) => this.organizationProfile.isCmf, organizationHasWebsite: (parameters: any) => this.organizationProfile.getWebsite, } /** * Exécute la fonction associée à la condition, et compare le résultat obtenu au résultat attendu (true par défaut) * * @param condition Un condition à la possession d'une habilité, telle que définie dans les fichiers de config * @param subject For debugging purpose only * @private */ protected execAndValidateCondition( condition: Condition, subject: string = '' ) { const expectedResult: boolean = condition.expectedResult ?? true; const parameters = condition.parameters ?? [] if (!(condition.function in this.handlerMap)) { throw new Error('unknown condition function : ' + condition.function) } const actualResult = this.handlerMap[condition.function](parameters ?? null) return actualResult === expectedResult } /** * Est-ce que l'utilisateur possède l'habilité en paramètre * * @return {boolean} * @param ability */ hasRoleAbility(ability: AbilitiesType): boolean { return this.ability.can(ability.action, ability.subject) } /** * Est-ce que l'utilisateur possède toutes les habilités passées en paramètre * * @param {Array} abilities Habilités à tester * @return {boolean} */ hasAllRoleAbilities(abilities: Array): boolean { return abilities.every(ability => this.hasRoleAbility(ability)) } /** * Est-ce que l'utilisateur possède au moins l'une des habilités passées en paramètre * * @param {Array} abilities Habilités à tester * @return {boolean} */ hasAnyRoleAbility(abilities: Array): boolean { return abilities.some(ability => this.hasRoleAbility(ability)) } /** * Teste si l'utilisateur possède le profil donné * * @param {string} profile Profil à tester * @return {boolean} */ hasProfile(profile: string): boolean { return { 'admin': this.accessProfile.isAdmin, 'administratifManager': this.accessProfile.isAdministratifManager, 'pedagogicManager': this.accessProfile.isPedagogicManager, 'financialManager': this.accessProfile.isFinancialManager, 'caMember': this.accessProfile.isCaMember, 'student': this.accessProfile.isStudent, 'teacher': this.accessProfile.isTeacher, 'member': this.accessProfile.isMember, 'other': this.accessProfile.isOther, 'guardian': this.accessProfile.isGuardian, 'payor': this.accessProfile.isPayer, }[profile] ?? false } /** * Retourne vrai si l'utilisateur connecté possède l'un des profils passés en paramètre * * @param {Array} profiles Profils à tester * @return {boolean} */ hasAnyProfile (profiles: Array): boolean { return profiles.some(p => this.hasProfile(p)) } /** * Retourne vrai si l'utilisateur connecté possède tous les profils passés en paramètre * * @param {Array} profiles Profils à tester * @return {boolean} */ hasAllProfiles (profiles: Array): boolean { return profiles.every(p => this.hasProfile(p)) } /** * Est-ce que l'utilisateur possède le rôle donné ? * * @return {boolean} * @param role */ hasRole(role: string): boolean { return this.accessProfile.hasRole(role) } /** * L'utilisateur possède-t-il au moins l'un des rôles donnés * * @return {boolean} * @param roles */ hasAnyRole(roles: Array): boolean { return roles.some(r => this.hasRole(r)) } /** * L'utilisateur possède-t-il tous les rôles donnés * * @return {boolean} * @param roles */ hasAllRoles(roles: Array): boolean { return roles.every(r => this.hasRole(r)) } /** * Est-ce que l'organisation possède le module donné * * @return {boolean} * @param module */ hasModule(module: string): boolean { return this.organizationProfile.hasModule(module) } /** * Est-ce que l'organisation possède au moins un des modules donnés * * @param modules * @return {boolean} */ hasAnyModule(modules: Array): boolean { return modules.some(r => this.hasModule(r)) } /** * Est-ce que l'organisation possède-t-il tous les modules donnés * * @param modules * @return {boolean} */ hasAllModules(modules: Array): boolean { return modules.every(r => this.hasModule(r)) } } export default AbilityBuilder