feat: ACL indexer

Author: raideer

src/indexer/IndexManager.ts

@@ -14,14 +14,22 @@ import { AutoloadNamespaceIndexData } from './autoload-namespace/AutoloadNamespa
 import { EventsIndexData } from './events/EventsIndexData';
 import Logger from 'util/Logger';
 import { IndexerKey } from 'types/indexer';
+import AclIndexer from './acl/AclIndexer';
+import { AclIndexData } from './acl/AclIndexData';
 
-type IndexerInstance = DiIndexer | ModuleIndexer | AutoloadNamespaceIndexer | EventsIndexer;
+type IndexerInstance =
+  | DiIndexer
+  | ModuleIndexer
+  | AutoloadNamespaceIndexer
+  | EventsIndexer
+  | AclIndexer;
 
 type IndexerDataMap = {
   [DiIndexer.KEY]: DiIndexData;
   [ModuleIndexer.KEY]: ModuleIndexData;
   [AutoloadNamespaceIndexer.KEY]: AutoloadNamespaceIndexData;
   [EventsIndexer.KEY]: EventsIndexData;
+  [AclIndexer.KEY]: AclIndexData;
 };
 
 class IndexManager {
@@ -34,6 +42,7 @@ class IndexManager {
       new ModuleIndexer(),
       new AutoloadNamespaceIndexer(),
       new EventsIndexer(),
+      new AclIndexer(),
     ];
     this.indexStorage = new IndexStorage();
   }
@@ -148,23 +157,25 @@ class IndexManager {
       return undefined;
     }
 
-    if (id === DiIndexer.KEY) {
-      return new DiIndexData(data) as IndexerDataMap[T];
-    }
+    switch (id) {
+      case DiIndexer.KEY:
+        return new DiIndexData(data) as IndexerDataMap[T];
 
-    if (id === ModuleIndexer.KEY) {
-      return new ModuleIndexData(data) as IndexerDataMap[T];
-    }
+      case ModuleIndexer.KEY:
+        return new ModuleIndexData(data) as IndexerDataMap[T];
 
-    if (id === AutoloadNamespaceIndexer.KEY) {
-      return new AutoloadNamespaceIndexData(data) as IndexerDataMap[T];
-    }
+      case AutoloadNamespaceIndexer.KEY:
+        return new AutoloadNamespaceIndexData(data) as IndexerDataMap[T];
 
-    if (id === EventsIndexer.KEY) {
-      return new EventsIndexData(data) as IndexerDataMap[T];
-    }
+      case EventsIndexer.KEY:
+        return new EventsIndexData(data) as IndexerDataMap[T];
+
+      case AclIndexer.KEY:
+        return new AclIndexData(data) as IndexerDataMap[T];
 
-    return undefined;
+      default:
+        return undefined;
+    }
   }
 
   protected async indexFileInner(

src/indexer/acl/AclIndexData.ts

@@ -0,0 +1,4 @@
+import { Acl } from './types';
+import { AbstractIndexData } from 'indexer/AbstractIndexData';
+
+export class AclIndexData extends AbstractIndexData<Acl[]> {}

src/indexer/acl/AclIndexer.ts

@@ -0,0 +1,93 @@
+import { RelativePattern, Uri } from 'vscode';
+import { XMLParser } from 'fast-xml-parser';
+import { get, map } from 'lodash-es';
+import { Indexer } from 'indexer/Indexer';
+import FileSystem from 'util/FileSystem';
+import { IndexerKey } from 'types/indexer';
+import { Acl } from './types';
+
+interface Element {
+  '@_id'?: string;
+  '@_title'?: string;
+  '@_description'?: string;
+  '@_sortOrder'?: string;
+  '@_disabled'?: string;
+  resource?: Element[];
+}
+
+export default class AclIndexer extends Indexer<Acl[]> {
+  public static readonly KEY = 'acl';
+
+  private xmlParser: XMLParser;
+
+  public constructor() {
+    super();
+
+    this.xmlParser = new XMLParser({
+      ignoreAttributes: false,
+      attributeNamePrefix: '@_',
+      isArray: name => {
+        return name === 'resource';
+      },
+    });
+  }
+
+  public getVersion(): number {
+    return 1;
+  }
+
+  public getId(): IndexerKey {
+    return AclIndexer.KEY;
+  }
+
+  public getName(): string {
+    return 'acl.xml';
+  }
+
+  public getPattern(uri: Uri): RelativePattern {
+    return new RelativePattern(uri, '**/etc/acl.xml');
+  }
+
+  public async indexFile(uri: Uri): Promise<Acl[]> {
+    const xml = await FileSystem.readFile(uri);
+
+    const parsed = this.xmlParser.parse(xml);
+
+    const events = get(parsed, 'config.acl.resources.resource', []);
+
+    const acls = [];
+
+    for (const event of events) {
+      acls.push(...this.getResources(event, uri));
+    }
+
+    return acls;
+  }
+
+  private getResources(element: Element, uri: Uri): Acl[] {
+    const parent = get(element, '@_id', undefined);
+    const resources = get(element, 'resource', []);
+
+    const acls: Acl[] = [];
+
+    for (const resource of resources) {
+      if (Array.isArray(resource.resource)) {
+        acls.push(...this.getResources(resource, uri));
+      }
+
+      if (resource['@_id'] && resource['@_title']) {
+        acls.push({
+          id: resource['@_id'],
+          title: resource['@_title'],
+          description: resource['@_description'],
+          sortOrder: resource['@_sortOrder'] ? parseInt(resource['@_sortOrder'], 10) : undefined,
+          disabled: resource['@_disabled'] === 'true',
+          parent,
+          path: uri.fsPath,
+        });
+      }
+    }
+
+    return acls;
+  }
+}

src/indexer/acl/types.ts

@@ -0,0 +1,9 @@
+export interface Acl {
+  id: string;
+  path: string;
+  title: string;
+  description?: string;
+  sortOrder?: number;
+  disabled?: boolean;
+  parent?: string;
+}