@lcap/nasl 3.7.3-beta.1 → 3.8.0-beta.2

package/src/concepts/Annotation__.ts

@@ -0,0 +1,344 @@
+import TypeAnnotation from './TypeAnnotation__';
+import BooleanLiteral from './BooleanLiteral__';
+import NewList from './NewList__';
+import StringLiteral from './StringLiteral__';
+import Argument from './Argument__';
+
+//================================================================================
+// 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
+// ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
+//================================================================================
+import { EventPayload, Params } from '../common/EventEmitter';
+import { concept, excludedInJSON, property, getConceptConstructor } from '../decorators';
+
+import * as utils from '../utils';
+import { createUUID } from '../utils/create';
+import * as types from './utils/types';
+import * as asserts from './utils/asserts';
+import BaseNode from '../common/BaseNode';
+import AnnotationProperty from './AnnotationProperty__';
+
+/**
+ * 注解
+ */
+@concept('注解')
+export class Annotation extends BaseNode {
+  /** 类名 */
+  static readonly ConceptName: string = 'Annotation';
+  /**
+   * 是否为抽象类
+   * 抽象类不能产生 concept: string
+   */
+  static isAbstract: boolean = false;
+  /** 继承链 */
+  static readonly inheritanceChain: string[] = ['BaseNode'];
+
+  /**
+   * 产品概念
+   */
+  @property('concept')
+  // @ts-ignore
+  readonly concept!: 'Annotation';
+  /**
+   * 注解标识
+   */
+  @property()
+  name: string;
+
+  /**
+   * 注解描述
+   */
+  @property()
+  description: string;
+
+  /**
+   * 注解属性
+   */
+  @property({
+    objectRef: 'AnnotationProperty',
+    isArray: true,
+    defaultValue: [],
+  })
+  properties: Array<AnnotationProperty> = [];
+
+  /**
+   * 可以应用到的概念
+   */
+  @property({
+    isArray: true,
+    defaultValue: [],
+  })
+  applyTo: Array<'Entity' | 'Logic' | 'View' | 'ViewElement'> = [];
+
+  /**
+   * @param source 需要合并的部分参数
+   */
+  constructor(source?: Partial<Annotation>) {
+    source = Object.assign({}, Annotation.getDefaultOptions(), source);
+    super(source);
+    super.subConstructor(source);
+  }
+
+  static from(source: any, parentNode?: any, parentKey?: string): Annotation {
+    return super.from(source, parentNode, parentKey) as Annotation;
+  }
+
+  getAnnotationPropertyExistingNames(excludedList: Array<AnnotationProperty> = []) {
+    const excludedSet = new Set(excludedList);
+    return ((this.properties as AnnotationProperty[]) || [])
+      .filter((item) => !excludedSet.has(item))
+      .map((item) => item.name);
+  }
+  getAnnotationPropertyUniqueName(name = 'annotationProperty1') {
+    return utils.unique(name, this.getAnnotationPropertyExistingNames(), undefined, false);
+  }
+
+  /**
+   * 插入注解属性
+   * @internal
+   * @param name 注解属性名称，如果不填会自动生成一个唯一名称
+   */
+  _insertAnnotationPropertyAt(name: string, index: number): AnnotationProperty;
+
+  /**
+   * 插入注解属性
+   * @internal
+   * @param annotationPropertyOptions 注解属性参数
+   */
+  _insertAnnotationPropertyAt(
+    annotationPropertyOptions: Partial<AnnotationProperty>,
+    index: number,
+  ): AnnotationProperty;
+
+  /**
+   * 插入注解属性
+   * @internal
+   * @param annotationProperty 已有的注解属性实例
+   */
+  _insertAnnotationPropertyAt(annotationProperty: AnnotationProperty, index: number): AnnotationProperty;
+
+  _insertAnnotationPropertyAt(options: string | Partial<AnnotationProperty> | AnnotationProperty, index: number) {
+    const annotationPropertyOptions: any = {};
+    const relationOptions = { parentNode: this, parentKey: 'properties' };
+    const AnnotationProperty = getConceptConstructor('AnnotationProperty');
+    let annotationProperty: AnnotationProperty;
+    if (!options) {
+      annotationProperty = AnnotationProperty.from(
+        {
+          ...annotationPropertyOptions,
+          name: this.getAnnotationPropertyUniqueName(),
+        },
+        this,
+        'properties',
+      );
+    } else if (typeof options === 'string') {
+      annotationProperty = AnnotationProperty.from(
+        {
+          ...annotationPropertyOptions,
+          name: options,
+        },
+        this,
+        'properties',
+      );
+    } else if (asserts.isAnnotationProperty(options)) {
+      options.ensureDelete(); // 同一实例不支持多处存在
+      annotationProperty = options;
+      Object.assign(annotationProperty, relationOptions);
+    } else {
+      annotationProperty = AnnotationProperty.from(
+        {
+          ...annotationPropertyOptions,
+          ...options,
+        },
+        this,
+        'properties',
+      );
+    }
+    this.properties.splice(index, 0, annotationProperty);
+    return annotationProperty;
+  }
+
+  /**
+   * 插入注解属性
+   * @param name 注解属性名称，如果不填会自动生成一个唯一名称
+   */
+  insertAnnotationPropertyAt(name: string, index: number): AnnotationProperty;
+
+  /**
+   * 插入注解属性
+   * @param annotationPropertyOptions 注解属性参数
+   */
+  insertAnnotationPropertyAt(annotationPropertyOptions: Partial<AnnotationProperty>, index: number): AnnotationProperty;
+
+  /**
+   * 插入注解属性
+   * @param annotationProperty 已有的注解属性实例
+   */
+  insertAnnotationPropertyAt(annotationProperty: AnnotationProperty, index: number): AnnotationProperty;
+
+  insertAnnotationPropertyAt(options: string | Partial<AnnotationProperty> | AnnotationProperty, index: number) {
+    const node = this._insertAnnotationPropertyAt(options as any, index);
+    node.create({
+      index,
+      parentNode: this,
+      parentKey: 'properties',
+    });
+    return node;
+  }
+
+  /**
+   * 添加注解属性
+   * @internal
+   * @param name 注解属性名称，如果不填会自动生成一个唯一名称
+   */
+  _addAnnotationProperty(name?: string): AnnotationProperty;
+
+  /**
+   * 添加注解属性
+   * @internal
+   * @param annotationPropertyOptions 注解属性参数
+   */
+  _addAnnotationProperty(annotationPropertyOptions: Partial<AnnotationProperty>): AnnotationProperty;
+
+  /**
+   * 添加注解属性
+   * @internal
+   * @param annotationProperty 已有的注解属性实例
+   */
+  _addAnnotationProperty(annotationProperty: AnnotationProperty): AnnotationProperty;
+
+  _addAnnotationProperty(options?: string | Partial<AnnotationProperty> | AnnotationProperty) {
+    const index = this.properties.length;
+    return this._insertAnnotationPropertyAt(options as any, index);
+  }
+
+  /**
+   * 添加注解属性
+   * @internal
+   * @param name 注解属性名称，如果不填会自动生成一个唯一名称
+   */
+  addAnnotationProperty(name?: string): AnnotationProperty;
+
+  /**
+   * 添加注解属性
+   * @param annotationPropertyOptions 注解属性参数
+   */
+  addAnnotationProperty(annotationPropertyOptions: Partial<AnnotationProperty>): AnnotationProperty;
+
+  /**
+   * 添加注解属性
+   * @param annotationProperty 已有的注解属性实例
+   */
+  addAnnotationProperty(annotationProperty: AnnotationProperty): AnnotationProperty;
+
+  addAnnotationProperty(options?: string | Partial<AnnotationProperty> | AnnotationProperty) {
+    const node = this._addAnnotationProperty(options as any);
+    const index = this.properties.indexOf(node);
+    node.create({
+      index,
+      parentNode: this,
+      parentKey: 'properties',
+    });
+    return node;
+  }
+
+  /**
+   * 删除注解属性
+   * @param name 注解属性名称
+   */
+  removeAnnotationProperty(name: string): void;
+
+  /**
+   * 删除注解属性
+   * @param annotationProperty 已有的注解属性实例
+   */
+  removeAnnotationProperty(annotationProperty: AnnotationProperty): void;
+
+  removeAnnotationProperty(options: string | AnnotationProperty) {
+    let annotationProperty: AnnotationProperty;
+    if (typeof options === 'string') {
+      annotationProperty = (this.properties as AnnotationProperty[]).find((item) => item.name === options);
+      if (!annotationProperty) {
+        throw new Error('找不到注解属性 ' + options);
+      }
+    } else {
+      annotationProperty = options;
+    }
+    return annotationProperty.delete();
+  }
+
+  //================================================================================
+  // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+  // 自动生成的代码已结束。下面可以手动编写。
+  //================================================================================
+  transToApplyAnno(annoprop?: any) {
+    let anno: any = annoprop || this;
+    let annotationName = anno?.group || anno.name;
+    let annotationNamespace = anno.annotationNamespace || ''; //todo：在 attrGroups 加上
+    let props = anno?.props || anno.properties || [];
+    let args = props?.map((p: any) => {
+      // 不对 defaultValue 只是初始值第一次就变成vueValue 了
+      //  后续变化是vueValue 传给 Argument
+      // 先固定写死为字符串类型  回头调试select多选
+      //  TypeAnnotation => Argument.expression
+      function getExp(p: any) {
+        let t = TypeAnnotation.from(p.typeAnnotation).toNaturalTS();
+        let map: any = {
+          Boolean: 'BooleanLiteral',
+          String: 'StringLiteral',
+          Array: 'todo',
+        };
+        let v = p.default || p.defaultValue?.expression?.value;
+
+        let cons;
+        if (t === 'Boolean') {
+          cons = BooleanLiteral;
+        }
+        if (t === 'String') {
+          cons = StringLiteral;
+        }
+        if (t.includes('List')) {
+          return NewList.from({
+            concept: 'NewList',
+            items: p.defaultValue?.expression.items,
+          });
+        }
+        if (!cons) {
+          console.error('表达式解析错误')
+        };
+
+        // 是不是可以通过创建一个带类型的变量 然后搞个函数传进去 这样就能获取 argument
+        return cons
+          .from({
+            concept: map[t],
+            value: v.toString(),
+          })
+          .toJSON();
+      }
+      // Argument.from()
+      return {
+        concept: 'Argument',
+        name: p.name,
+        expression: getExp(p),
+        keyword: p.name,
+      };
+    });
+    return {
+      concept: 'ApplyAnnotation',
+      annotationNamespace,
+      annotationName,
+      name: annotationName,
+      arguments: args, //[Argument]
+    };
+  }
+  //================================================================================
+  // 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
+  // ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
+  //================================================================================
+}
+
+export default Annotation;
+//================================================================================
+// ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+// 自动生成的代码已结束。下面可以手动编写。
+//================================================================================