@lcap/nasl 3.2.0-beta.3 → 3.3.0-alpha

package/src/concepts/Connection__.ts

@@ -0,0 +1,426 @@
+import { v4 as uuidv4 } from 'uuid';
+import { getNodeByNodeCallee } from '../automate/engine/utils';
+import { TranslatorState, shiftState, withSourceMap, createCompilerState, indent } from '../translator';
+
+//= ===============================================================================
+// 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
+// ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
+//= ===============================================================================
+import { EventPayload, Params } from '../common/EventEmitter';
+import { concept, excludedInJSON, property } from '../decorators';
+
+import * as utils from '../utils';
+import BaseNode from '../common/BaseNode';
+import classMap from '../common/classMap';
+import ConfigProperty from './ConfigProperty__';
+import Module from './Module__';
+import App from './App__';
+import Connector from './Connector__';
+
+/**
+ * 连接
+ */
+@concept('连接')
+export class Connection extends BaseNode {
+  /**
+   * 产品概念
+   */
+  @property()
+  concept: 'Connection' = 'Connection';
+
+  /**
+   * namespace
+   */
+  @property()
+  namespace: string = undefined;
+
+  /**
+   * 连接名称
+   */
+  @property()
+  name: string = undefined;
+
+  /**
+   * 连接标题
+   */
+  @property()
+  title: string = undefined;
+
+  /**
+   * 配置属性列表
+   */
+  @property('ConfigProperty')
+  properties: Array<ConfigProperty> = [];
+
+  /**
+   * 祖先 Module
+   */
+  get module() {
+    return this.getAncestor('Module') as Module;
+  }
+
+  /**
+   * 祖先 App
+   */
+  get app() {
+    return this.getAncestor('App') as App;
+  }
+
+  /**
+   * @param source 需要合并的部分参数
+   */
+  constructor(source?: Partial<Connection>) {
+    // @ts-ignore
+    source = { ...Connection.getDefaultOptions(), ...source };
+    super(source);
+    super.subConstructor(source);
+  }
+
+  getClassName() {
+    return 'Connection';
+  }
+
+  static from(source: any, parentNode?: any, parentKey?: string): Connection {
+    return super.from(source, parentNode, parentKey) as Connection;
+  }
+
+  /**
+   * 从父级删除该节点
+   * @internal
+   */
+  _delete() {
+    let params: Params = null;
+    if (this.parentNode) {
+      params = (this.parentNode as any)?.__removeConnection?.(this);
+    }
+    return params;
+  }
+
+  /**
+   * 设置namespace
+   */
+  setNamespace(namespace: string) {
+    const object = {
+      namespace,
+    };
+    this.update({
+      ...object,
+    });
+  }
+
+  /**
+   * 设置连接名称
+   */
+  setName(name: string) {
+    const object = {
+      name,
+    };
+    this.update({
+      ...object,
+      field: 'name',
+    });
+  }
+
+  /**
+   * 设置连接标题
+   */
+  setTitle(title: string) {
+    const object = {
+      title,
+    };
+    this.update({
+      ...object,
+    });
+  }
+
+  /**
+   * 设置配置属性列表
+   */
+  setProperties(properties: Array<ConfigProperty>) {
+    const object = {
+      properties,
+    };
+    this.update({
+      ...object,
+    });
+  }
+
+  getConfigPropertyExistingNames(excludedList: Array<ConfigProperty> = []) {
+    const excludedSet = new Set(excludedList);
+    return ((this.properties as ConfigProperty[]) || []).filter((item) => !excludedSet.has(item)).map((item) => item.name);
+  }
+
+  getConfigPropertyUniqueName(name = 'configProperty1') {
+    return utils.unique(name, this.getConfigPropertyExistingNames(), undefined, false);
+  }
+
+  /**
+   * 插入配置属性
+   * @internal
+   * @param name 配置属性名称，如果不填会自动生成一个唯一名称
+   */
+  _insertConfigPropertyAt(name: string, index: number): ConfigProperty;
+
+  /**
+   * 插入配置属性
+   * @internal
+   * @param configPropertyOptions 配置属性参数
+   */
+  _insertConfigPropertyAt(configPropertyOptions: Partial<ConfigProperty>, index: number): ConfigProperty;
+
+  /**
+   * 插入配置属性
+   * @internal
+   * @param configProperty 已有的配置属性实例
+   */
+  _insertConfigPropertyAt(configProperty: ConfigProperty, index: number): ConfigProperty;
+
+  _insertConfigPropertyAt(options: string | Partial<ConfigProperty> | ConfigProperty, index: number) {
+    const configPropertyOptions: any = {};
+    const relationOptions = { parentNode: this, parentKey: 'properties' };
+    let configProperty: ConfigProperty;
+    if (!options) {
+      configProperty = ConfigProperty.from(
+        {
+          ...configPropertyOptions,
+          name: this.getConfigPropertyUniqueName(),
+        },
+        this,
+        'properties'
+      );
+    } else if (typeof options === 'string') {
+      configProperty = ConfigProperty.from(
+        {
+          ...configPropertyOptions,
+          name: options,
+        },
+        this,
+        'properties'
+      );
+    } else if (options instanceof ConfigProperty) {
+      options.ensureDelete(); // 同一实例不支持多处存在
+      configProperty = options;
+      Object.assign(configProperty, relationOptions);
+    } else {
+      configProperty = ConfigProperty.from(
+        {
+          ...configPropertyOptions,
+          ...options,
+        },
+        this,
+        'properties'
+      );
+    }
+    this.properties.splice(index, 0, configProperty);
+    return configProperty;
+  }
+
+  /**
+   * 插入配置属性
+   * @param name 配置属性名称，如果不填会自动生成一个唯一名称
+   */
+  insertConfigPropertyAt(name: string, index: number): ConfigProperty;
+
+  /**
+   * 插入配置属性
+   * @param configPropertyOptions 配置属性参数
+   */
+  insertConfigPropertyAt(configPropertyOptions: Partial<ConfigProperty>, index: number): ConfigProperty;
+
+  /**
+   * 插入配置属性
+   * @param configProperty 已有的配置属性实例
+   */
+  insertConfigPropertyAt(configProperty: ConfigProperty, index: number): ConfigProperty;
+
+  insertConfigPropertyAt(options: string | Partial<ConfigProperty> | ConfigProperty, index: number) {
+    const node = this._insertConfigPropertyAt(options as any, index);
+    node.create({
+      index,
+      parentNode: this,
+      parentKey: 'properties',
+    });
+    return node;
+  }
+
+  /**
+   * 添加配置属性
+   * @internal
+   * @param name 配置属性名称，如果不填会自动生成一个唯一名称
+   */
+  _addConfigProperty(name?: string): ConfigProperty;
+
+  /**
+   * 添加配置属性
+   * @internal
+   * @param configPropertyOptions 配置属性参数
+   */
+  _addConfigProperty(configPropertyOptions: Partial<ConfigProperty>): ConfigProperty;
+
+  /**
+   * 添加配置属性
+   * @internal
+   * @param configProperty 已有的配置属性实例
+   */
+  _addConfigProperty(configProperty: ConfigProperty): ConfigProperty;
+
+  _addConfigProperty(options?: string | Partial<ConfigProperty> | ConfigProperty) {
+    const index = this.properties.length;
+    return this._insertConfigPropertyAt(options as any, index);
+  }
+
+  /**
+   * 添加配置属性
+   * @internal
+   * @param name 配置属性名称，如果不填会自动生成一个唯一名称
+   */
+  addConfigProperty(name?: string): ConfigProperty;
+
+  /**
+   * 添加配置属性
+   * @param configPropertyOptions 配置属性参数
+   */
+  addConfigProperty(configPropertyOptions: Partial<ConfigProperty>): ConfigProperty;
+
+  /**
+   * 添加配置属性
+   * @param configProperty 已有的配置属性实例
+   */
+  addConfigProperty(configProperty: ConfigProperty): ConfigProperty;
+
+  addConfigProperty(options?: string | Partial<ConfigProperty> | ConfigProperty) {
+    const node = this._addConfigProperty(options as any);
+    const index = this.properties.indexOf(node);
+    node.create({
+      index,
+      parentNode: this,
+      parentKey: 'properties',
+    });
+    return node;
+  }
+
+  /**
+   * 删除配置属性
+   * @param name 配置属性名称
+   */
+  removeConfigProperty(name: string): void;
+
+  /**
+   * 删除配置属性
+   * @param configProperty 已有的配置属性实例
+   */
+  removeConfigProperty(configProperty: ConfigProperty): void;
+
+  removeConfigProperty(options: string | ConfigProperty) {
+    let configProperty: ConfigProperty;
+    if (typeof options === 'string') {
+      configProperty = (this.properties as ConfigProperty[]).find((item) => item.name === options);
+      if (!configProperty) {
+        throw new Error(`找不到配置属性 ${options}`);
+      }
+    } else {
+      configProperty = options;
+    }
+    return configProperty.delete();
+  }
+
+  __removeConfigProperty(configProperty: ConfigProperty) {
+    const { parentKey } = configProperty;
+    const params: Params = {
+      parentNode: this,
+      parentKey,
+      index: -1,
+      object: null,
+      oldObject: configProperty,
+    };
+    if (parentKey) {
+      params.parentKey = parentKey;
+      if (Array.isArray((this as any)[parentKey])) {
+        const index = (this as any)[parentKey].indexOf(configProperty);
+        ~index && (this as any)[parentKey].splice(index, 1);
+        params.index = index;
+      } else if ((this as any)[parentKey] === configProperty) {
+        params.index = 0;
+        (this as any)[parentKey] = undefined;
+      }
+    }
+    return params;
+  }
+
+  //= ===============================================================================
+  // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+  // 自动生成的代码已结束。下面可以手动编写。
+  //= ===============================================================================
+
+  /**
+   * 获取connector 类型
+   */
+  get connector() {
+    return getNodeByNodeCallee(this.rootNode, this.namespace) as Connector;
+  }
+
+  getConnectorType(): String {
+    return this.connector?.connectorKind;
+  }
+
+  getConnectorName(): String {
+    return this.connector?.name;
+  }
+
+  /**
+   * 生成宿主语言的文件路径
+   * @param name 一般不用传，用于 rename
+   */
+  getEmbeddedFilePath(name = this.name) {
+    return `/embedded/${this.app.name}/connections/${this.name}.ts`;
+  }
+
+  getTsNamespace() {
+    return 'app.connections';
+  }
+
+  toEmbeddedTSFile() {
+    let code = `namespace ${this.getTsNamespace()} {\n`;
+
+    const state = createCompilerState(code, { tabSize: 1 });
+    try {
+      code += this.toEmbeddedTS(state);
+    } catch (err) {
+      console.log(err, '有问题翻译失败');
+      code += '';
+      console.log(err);
+    }
+    code += '}\n';
+    return {
+      code,
+      filePath: this.getEmbeddedFilePath(),
+      sourceMap: state.sourceMap,
+    };
+  }
+
+  @withSourceMap()
+  toEmbeddedTS(state?: TranslatorState, prependCode?: string, noName?: boolean, prefix?: boolean): string {
+    let code = '';
+    code += `export function ${this.name}(`;
+    code += 'cb: Function';
+    code += `) {\n`;
+    code += '\n';
+    code += indent((state?.tabSize || 0) + 1);
+    code += 'return cb();\n';
+    code += `${indent(state?.tabSize || 0 + 4)}}`;
+    code += '\n';
+    return code;
+  }
+
+  //= ===============================================================================
+  // 从这里开始到结尾注释之间的代码由 NASL Workbench 自动生成，请不手动修改！
+  // ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓   ↓
+  //= ===============================================================================
+}
+
+classMap.Connection = Connection;
+export default Connection;
+//= ===============================================================================
+// ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+// 自动生成的代码已结束。下面可以手动编写。
+//= ===============================================================================