abilityUtils.ts 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. import RoleUtils from '~/services/rights/roleUtils'
  2. import {AbilitiesType} from '~/types/interfaces'
  3. import YamlDenormalizer from "~/services/data/serializer/denormalizer/yamlDenormalizer";
  4. import {MongoAbility} from "@casl/ability/dist/types/Ability";
  5. import {AnyJson} from "~/types/data";
  6. import {useEach} from "#imports";
  7. import {ABILITIES} from "~/types/enum/enums";
  8. /**
  9. * Classe permettant de mener des opérations sur les habilités
  10. */
  11. class AbilityUtils {
  12. private readonly ability: MongoAbility = {} as MongoAbility
  13. private readonly accessProfile: any
  14. private readonly organizationProfile: any
  15. /**
  16. * @constructor
  17. */
  18. constructor(
  19. ability: MongoAbility,
  20. accessProfile: any,
  21. organizationProfile: any,
  22. ) {
  23. this.ability = ability
  24. this.accessProfile = accessProfile
  25. this.organizationProfile = organizationProfile
  26. }
  27. /**
  28. * Définit les abilities de l'utilisateur selon son profil
  29. */
  30. setupAbilities() {
  31. // Nécessaire pour que l'update des habilités soit correcte après la phase SSR
  32. this.ability.update(this.accessProfile.abilities)
  33. // const abilities: Array<AbilitiesType> = this.buildAbilities();
  34. // this.accessProfile.abilities = abilities
  35. // this.ability.update(abilities)
  36. // Au moment où l'on effectue une action organizationProfileStore.setProfile, il faut aller récupérer
  37. // les différentes habilités que l'utilisateur peut effectuer. (Tout cela se passe en SSR)
  38. const unsubscribe = this.organizationProfile.$onAction(({
  39. name, // name of the action
  40. store, // store instance, same as `someStore`
  41. args, // array of parameters passed to the action
  42. after, // hook after the action returns or resolves
  43. onError, // hook if the action throws or rejects
  44. }: any) => {
  45. after((result: any)=>{
  46. if (name === 'setProfile'){
  47. //On récupère les habilités
  48. const abilities: Array<AbilitiesType> = this.buildAbilities();
  49. //On les store puis on update le service ability pour le mettre à jour.
  50. this.accessProfile.abilities = abilities
  51. this.ability.update(abilities)
  52. // Unsubscribe pour éviter les memory leaks
  53. unsubscribe()
  54. }
  55. })
  56. })
  57. }
  58. /**
  59. * Récupération de l'ensemble des habilités de l'utilisateur, qu'elles soient par Roles ou par Config
  60. *
  61. * @return {Array<AbilitiesType>}
  62. */
  63. buildAbilities(): Array<AbilitiesType> {
  64. const abilitiesByRoles: Array<AbilitiesType> = this.buildAbilitiesFromRoles(this.accessProfile.roles)
  65. const abilitiesByConfig = this.buildAbilitiesFromConfig('./config/abilities/config.yaml')
  66. return abilitiesByRoles.concat(abilitiesByConfig)
  67. }
  68. /**
  69. * Adaptation et transformations des roles symfony en abilities Casl
  70. *
  71. * @param {Array<string>} roles
  72. * @return {Array<AbilitiesType>}
  73. */
  74. buildAbilitiesFromRoles(roles: Array<string>): Array<AbilitiesType> {
  75. return RoleUtils.rolesToAbilities(roles)
  76. }
  77. /**
  78. * Charge les habilités depuis les fichiers de configuration
  79. *
  80. * @param {string} configPath
  81. * @return {Array<AbilitiesType>}
  82. */
  83. buildAbilitiesFromConfig(configPath: string): Array<AbilitiesType> {
  84. const doc = YamlDenormalizer.denormalize({path: configPath})
  85. const fromConfig = doc.abilities
  86. const abilities: Array<AbilitiesType> = []
  87. useEach(fromConfig, (ability: { action: ABILITIES, services: object }, subject: string) => {
  88. const { action, services } = ability
  89. if (this.hasConfigAbility(services)) {
  90. abilities.push({ action, subject })
  91. }
  92. })
  93. return abilities
  94. }
  95. /**
  96. * Parcourt les services définis dans la configuration, et établit si oui ou non l'habilité est autorisée
  97. *
  98. * @return {boolean}
  99. * @param services
  100. */
  101. hasConfigAbility(services: AnyJson) {
  102. const handlerMap: any = {
  103. hasRole: (parameters: any) => this.hasRoles(parameters),
  104. hasAbility: (parameters: any) => this.hasAbilities(parameters),
  105. hasProfile: (parameters: any) => this.hasProfileAmong(parameters),
  106. isAdminAccount: (parameters: any) => this.accessProfile.isAdminAccount,
  107. hasModule: (parameters: any) => this.hasModule(parameters),
  108. isSchool: (parameters: any) => this.organizationProfile.isSchool,
  109. isArtist: (parameters: any) => this.organizationProfile.isArtist,
  110. isManagerProduct: (parameters: any) => this.organizationProfile.isManagerProduct,
  111. isOrganizationWithChildren: (parameters: any) => this.organizationProfile.hasChildren,
  112. isAssociation: (parameters: any) => this.organizationProfile.isAssociation,
  113. isShowAdherentList: (parameters: any) => this.organizationProfile.isShowAdherentList,
  114. isCmf: (parameters: any) => this.organizationProfile.isCmf,
  115. getWebsite: (parameters: any) => this.organizationProfile.getWebsite,
  116. }
  117. let hasAbility = true
  118. useEach(services, (handlers: Array<{ function: string, parameters?: Array<any>, result?: any }>, service: string) => {
  119. useEach(handlers, (handler: { function: string, parameters?: Array<any>, result?: any }) => {
  120. const expectedResult: boolean = handler.result ?? true;
  121. const parametersArray = handler.parameters ?? []
  122. useEach(parametersArray, (parameters: any) => {
  123. const actualResult = handlerMap[handler.function](parameters ?? null)
  124. if (actualResult !== expectedResult) {
  125. hasAbility = false
  126. return false
  127. }
  128. })
  129. if (!hasAbility) { return false }
  130. })
  131. if (!hasAbility) { return false }
  132. })
  133. return hasAbility
  134. }
  135. /**
  136. * Est-ce que l'utilisateur possède la ou les habilités
  137. *
  138. * @param {Array<AbilitiesType>} abilities Habilités à tester
  139. * @return {boolean}
  140. */
  141. hasAbilities(abilities: Array<AbilitiesType>|null): boolean{
  142. useEach(abilities ?? [], (ability) => {
  143. if (!this.ability.can(ability.action, ability.subject)) {
  144. return false
  145. }
  146. })
  147. return true
  148. }
  149. /**
  150. * Teste le profil d'un utilisateur
  151. *
  152. * @param {string} profile : profile à tester
  153. * @return {boolean}
  154. */
  155. private testProfile(profile: string): boolean {
  156. const factory: {[key: string]: boolean|null} = {
  157. 'admin': this.accessProfile.isAdmin,
  158. 'administratifManager': this.accessProfile.isAdministratifManager,
  159. 'pedagogicManager': this.accessProfile.isPedagogicManager,
  160. 'financialManager': this.accessProfile.isFinancialManager,
  161. 'caMember': this.accessProfile.isCaMember,
  162. 'student': this.accessProfile.isStudent,
  163. 'teacher': this.accessProfile.isTeacher,
  164. 'member': this.accessProfile.isMember,
  165. 'other': this.accessProfile.isOther,
  166. 'guardian': this.accessProfile.isGuardian,
  167. 'payor': this.accessProfile.isPayer,
  168. }
  169. return factory[profile] ?? false
  170. }
  171. /**
  172. * Retourne vrai si l'utilisateur connecté possède l'un des profils passés en paramètre
  173. *
  174. * @param {Array<string>} profiles Profils à tester
  175. * @return {boolean}
  176. */
  177. hasProfileAmong (profiles: Array<string>|null): boolean {
  178. if (null === profiles)
  179. return true;
  180. useEach(profiles, (profile) => {
  181. if (this.testProfile(profile)) {
  182. return true
  183. }
  184. })
  185. return false
  186. }
  187. /**
  188. * Est-ce que l'utilisateur possède le rôle donné ?
  189. *
  190. * @return {boolean}
  191. * @param role
  192. */
  193. hasRole(role: string|null): boolean {
  194. return role === null || this.accessProfile.roles.includes(role)
  195. }
  196. /**
  197. * Est-ce que l'utilisateur possède tous les rôles donnés ?
  198. *
  199. * @return {boolean}
  200. * @param roles
  201. */
  202. hasRoles(roles: Array<string>): boolean {
  203. useEach(roles, (r: string) => {
  204. if (!this.accessProfile.roles.includes(r)) {
  205. return false
  206. }
  207. })
  208. return true
  209. }
  210. /**
  211. * Est-ce que l'organisation possède le module donné
  212. *
  213. * @return {boolean}
  214. * @param module
  215. */
  216. hasModule(module: string): boolean {
  217. return this.organizationProfile.modules.includes(module)
  218. }
  219. }
  220. export default AbilityUtils