@lcap/nasl 0.3.9-beta

package/src/types/logic/Variable.ts

@@ -0,0 +1,294 @@
+import { immutable, excludedInJSON, action } from '../decorators';
+import { config, history, utils, LEVEL_ENUM, Vertex, Logic, PackageJSON, App, WebService, Page, Block, Schema, BaseVariable, ActionOptions } from '..';
+import { paramService } from '../../service/logic';
+import { convert2RefType, convert2SchemaType } from '../data/dataTypeUtils';
+import { getBasicTypeDefaultValue } from '../data/basicTypes';
+import { schemaService } from '../../service/common';
+
+/**
+ * 逻辑局部变量
+ */
+export class Variable extends BaseVariable {
+    /**
+     * 概念类型
+     */
+    @immutable()
+    public readonly level: LEVEL_ENUM = LEVEL_ENUM.variable;
+    /**
+     * 默认值
+     * 按 JSON string 处理
+     * - string: 666 -> '666'
+     * - string: true -> 'true'
+     * - number: 666 -> 666
+     * - boolean: true -> true
+     */
+    @immutable()
+    public readonly defaultValue: string = undefined;
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<Variable>) {
+        super();
+        source && this.assign(source);
+    }
+    /**
+     * 添加逻辑局部变量
+     */
+    @action('添加逻辑局部变量')
+    async create(none?: void, actionOptions?: ActionOptions) {
+        config.defaultApp?.emit('saving');
+
+        const body = this.toJSON();
+        // convert2SchemaType(body.schema);
+        body._posIndex = this.logic.variables.indexOf(this);
+        utils.logger.debug('添加逻辑局部变量', body);
+        const result: Variable = await paramService.create({
+            headers: {
+                appId: config.defaultApp?.id,
+                operationAction: actionOptions?.actionName || 'Variable.create',
+                operationDesc: actionOptions?.actionDesc || `添加逻辑"${this.logic.name}"局部变量"${this.name}"`,
+            },
+            body,
+        });
+        // convert2RefType(result.schema);
+        this.deepPick(result, ['id']);
+        this.assign({ code: this.genCode() });
+
+        if (this.logic.interface) {
+            this.logic.interface.service.emit('interfacesChange');
+        } else if (this.logic.view) {
+            this.logic.view.page.service.emit('pageTreeChange');
+            this.logic.emit('change');
+        }
+
+        await config.defaultApp?.history.load();
+        config.defaultApp?.emit('saved');
+        return this;
+    }
+    /**
+     * 删除逻辑局部变量
+     */
+    @action('删除逻辑局部变量')
+    async delete(none?: void, actionOptions?: ActionOptions) {
+        config.defaultApp?.emit('saving');
+
+        if (this.id) {
+            try {
+                await paramService.delete({
+                    headers: {
+                        appId: config.defaultApp?.id,
+                        operationAction: actionOptions?.actionName || 'Param.create',
+                        operationDesc: actionOptions?.actionDesc || `删除逻辑"${this.logic.name}"局部变量"${this.name}"`,
+                    },
+                    query: {
+                        loValId: this.id,
+                        logicId: this.logic.id,
+                    },
+                });
+            } catch(err) {
+                await config.defaultApp?.history.load();
+                throw err;
+            }
+        }
+
+        const index = this.logic.variables.indexOf(this);
+        ~index && this.logic.variables.splice(index, 1);
+        this.destroy();
+        if (this.logic.interface) {
+            this.logic.interface.service.emit('interfacesChange');
+        } else if (this.logic.view) {
+            this.logic.view.page.service.emit('pageTreeChange');
+            this.logic.emit('change');
+        }
+
+        await config.defaultApp?.history.load();
+        config.defaultApp?.emit('saved');
+    }
+    /**
+     * 修改逻辑局部变量
+     */
+    async update(none?: void, actionOptions?: ActionOptions, then?: () => Promise<any>) {
+        config.defaultApp?.emit('saving');
+
+        const body = this.toJSON();
+        // convert2SchemaType(body.schema);
+        utils.logger.debug('修改逻辑局部变量', body);
+        const result = await paramService.update({
+            headers: {
+                appId: config.defaultApp?.id,
+                operationAction: actionOptions?.actionName || 'Param.update',
+                operationDesc: actionOptions?.actionDesc || `修改逻辑局部变量"${this.name}"`,
+            },
+            body,
+        });
+        this.schema.id = result.schema.id;
+        // convert2RefType(result.schema);
+        // this.plainAssign(result);
+
+        await then?.();
+        await config.defaultApp?.history.load();
+        config.defaultApp?.emit('saved');
+        return this;
+    }
+    /**
+     * 设置逻辑局部变量名称
+     * @param name 名称
+     */
+    @action('设置逻辑局部变量名称')
+    async setName(name: string) {
+        const oldName = this.name;
+        this.assign({ name });
+        await this.update(undefined, {
+            actionDesc: `设置逻辑"${this.logic.name}"的局部变量"${oldName}"的名称为"${name}"`,
+        });
+
+        if (this.logic.interface) {
+            this.logic.interface.service.emit('interfacesChange');
+        } else if (this.logic.view) {
+            this.logic.view.page.service.emit('pageTreeChange');
+            this.logic.emit('change');
+        }
+    }
+    /**
+     * 设置逻辑局部变量描述
+     * @param description 描述
+     */
+    @action('设置逻辑局部变量描述')
+    async setDescription(description: string) {
+        this.assign({ description });
+        await this.update(undefined, {
+            actionDesc: `设置逻辑"${this.logic.name}"的局部变量"${this.name}"的描述为"${description}"`,
+        });
+
+        if (this.logic.interface) {
+            this.logic.interface.service.emit('interfacesChange');
+        } else if (this.logic.view) {
+            this.logic.view.page.service.emit('pageTreeChange');
+            this.logic.emit('change');
+        }
+    }
+    /**
+     * 查找schema 顶点被引用的逻辑顶点列表
+     */
+    async getSchemaUsage() {
+        if (this.schema) {
+            const schemaId = this.schema.type === 'genericType' ? this.id : this.schema.id;
+            const result = await schemaService.getSchemaUsage({
+                query: {
+                    schemaId,
+                    valSource: 'logic',
+                },
+            });
+            return result;
+        }
+    }
+    /**
+     * 设置逻辑局部变量的数据类型
+     */
+    @action('设置逻辑局部变量的数据类型')
+    async setDataType(schema: Schema) {
+        // 用于update失败后还原数据
+        const originalData = {
+            schema: Object.assign({}, this.schema),
+            defaultValue: this.defaultValue,
+        };
+        Object.assign(this.schema, {
+            $ref: undefined, //引用到Entity或者structure
+            type: undefined,
+            format: undefined,
+            typeInstantiation: undefined,
+        });
+        Object.assign(this.schema, schema);
+        // if (this.defaultValue)
+        this.assign({ defaultValue: getBasicTypeDefaultValue() });
+        try {
+            await this.update(undefined, {
+                actionDesc: `设置逻辑"${this.logic.name}"的局部变量"${this.name}"的数据类型为"${this.schema.typeKey}"`,
+            });
+            this.genSchemaChildren();
+
+            if (this.logic.interface) {
+                this.logic.interface.service.emit('interfacesChange');
+            } else if (this.logic.view) {
+                this.logic.view.page.service.emit('pageTreeChange');
+                this.logic.emit('change');
+            }
+        } catch (err) {
+            this.assign(originalData);
+            config.defaultApp?.emit('saved');
+            throw err;
+        }
+    }
+    /**
+     * 设置逻辑局部变量是否为列表
+     * @param isArray
+     */
+    @action('设置逻辑局部变量是否为列表')
+    async setAsList(isArray: boolean) {
+        this.schema.isArray = isArray;
+        this.assign({ defaultValue: getBasicTypeDefaultValue() });
+
+        await this.update(undefined, {
+            actionDesc: `设置逻辑"${this.logic.name}"的局部变量"${this.name}"${isArray ? '为' : '不为'}列表`,
+        });
+        this.genSchemaChildren();
+
+        if (this.logic.interface) {
+            this.logic.interface.service.emit('interfacesChange');
+        } else if (this.logic.view) {
+            this.logic.view.page.service.emit('pageTreeChange');
+            this.logic.emit('change');
+        }
+    }
+    /**
+     * 设置逻辑局部变量的默认值
+     */
+    @action('设置逻辑局部变量的默认值')
+    async setDefaultValue(defaultValue: string) {
+        this.assign({ defaultValue });
+        await this.update(undefined, {
+            actionDesc: `设置逻辑局部变量的默认值`,
+        });
+
+        if (this.logic.interface) {
+            this.logic.interface.service.emit('interfacesChange');
+        } else if (this.logic.view) {
+            this.logic.view.page.service.emit('pageTreeChange');
+            this.logic.emit('change');
+        }
+    }
+    /**
+     * 设置逻辑局部变量是否必须
+     * @param required 必须
+     */
+    @action('设置逻辑局部变量是否必须')
+    async setRequired(required: boolean) {
+        this.assign({ required });
+        await this.update(undefined, {
+            actionDesc: `设置逻辑"${this.logic.name}"的局部变量"${this.name}"为"${required ? '必须' : '不必须'}"`,
+        });
+
+        if (this.logic.interface) {
+            this.logic.interface.service.emit('interfacesChange');
+        } else if (this.logic.view) {
+            this.logic.view.page.service.emit('pageTreeChange');
+            this.logic.emit('change');
+        }
+    }
+    /**
+     * 从后端 JSON 生成规范的 Variable 对象
+     */
+    public static from(source: any, logic: Logic) {
+        convert2RefType(source.schema);
+        source.logic = logic;
+        if (source.id)
+            source.code = 'ID_' + source.id;
+        const variable = new Variable(source);
+        variable.genSchemaChildren();
+        delete variable.expanded;
+
+        return variable;
+    }
+}
+
+export default Variable;

package/src/types/logic/expressions/BinaryExpression.ts

@@ -0,0 +1,35 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 二元表达式
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class BinaryExpression extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.BinaryExpression;
+    /**
+     * 左边项
+     */
+    @immutable()
+    public readonly left: ExpressionNode = undefined;
+    /**
+     * 右边项
+     */
+    @immutable()
+    public readonly right: ExpressionNode = undefined;
+    /**
+     * 运算符
+     */
+    @immutable()
+    public readonly operator: string = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return `${this.left.toScript()} ${this.operator} ${this.right.toScript()}`;
+    }
+}

package/src/types/logic/expressions/BooleanLiteral.ts

@@ -0,0 +1,25 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 布尔字面量
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class BooleanLiteral extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.BooleanLiteral;
+    /**
+     * 字面量的值
+     */
+    @immutable()
+    public readonly value: string = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return String(this.value);
+    }
+}

package/src/types/logic/expressions/Identifier.ts

@@ -0,0 +1,36 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 标识符
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class Identifier extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.Identifier;
+    /**
+     * 标识符名称
+     */
+    @immutable()
+    public readonly name: string = undefined;
+    /**
+     * 标识符代码
+     * @example ID_c7019c2dfcfb4efba65a5ae98b1c8d8b
+     */
+    @immutable()
+    public readonly code: string = undefined;
+    /**
+     * 变量引用
+     */
+    @immutable()
+    public readonly schemaRef: string = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return this.code || this.name;
+    }
+}

package/src/types/logic/expressions/LogicalExpression.ts

@@ -0,0 +1,35 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 逻辑二元表达式
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class LogicalExpression extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.LogicalExpression;
+    /**
+     * 左边项
+     */
+    @immutable()
+    public readonly left: ExpressionNode = undefined;
+    /**
+     * 右边项
+     */
+    @immutable()
+    public readonly right: ExpressionNode = undefined;
+    /**
+     * 运算符
+     */
+    @immutable()
+    public readonly operator: string = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return `${this.left.toScript()} ${this.operator} ${this.right.toScript()}`;
+    }
+}

package/src/types/logic/expressions/MemberExpression.ts

@@ -0,0 +1,33 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 成员表达式
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class MemberExpression extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.MemberExpression;
+    /**
+     * 对象
+     */
+    @immutable()
+    public readonly object: ExpressionNode = undefined;
+    /**
+     * 属性
+     */
+    @immutable()
+    public readonly property: ExpressionNode = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        if (String(this.property.type).endsWith('Literal'))
+            return `${this.object.toScript()}[${this.property.toScript()}]`;
+        else // 生成代码尽量简洁一些，目前属性没有特殊字符的情况
+            return `${this.object.toScript()}.${this.property.toScript()}`;
+    }
+}

package/src/types/logic/expressions/NullLiteral.ts

@@ -0,0 +1,20 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * null 字面量
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class NullLiteral extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.NullLiteral;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return 'null';
+    }
+}

package/src/types/logic/expressions/NumericLiteral.ts

@@ -0,0 +1,25 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 数字字面量
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class BooleanLiteral extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.BooleanLiteral;
+    /**
+     * 字面量的值
+     */
+    @immutable()
+    public readonly value: string = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return String(this.value);
+    }
+}

package/src/types/logic/expressions/StringLiteral.ts

@@ -0,0 +1,25 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 文本字面量
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class StringLiteral extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.StringLiteral;
+    /**
+     * 字面量的值
+     */
+    @immutable()
+    public readonly value: string = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return `'${this.value}'`;
+    }
+}

package/src/types/logic/expressions/UnaryExpression.ts

@@ -0,0 +1,30 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 一元表达式
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class UnaryExpression extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.UnaryExpression;
+    /**
+     * 运算符
+     */
+     @immutable()
+     public readonly operator: string = undefined;
+    /**
+     * 参数
+     */
+    @immutable()
+    public readonly argument: ExpressionNode = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return `${this.operator}${this.argument}`;
+    }
+}

package/src/types/logic/expressions/Unparsed.ts

@@ -0,0 +1,25 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 未解析的表达式
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class Unparsed extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.Unparsed;
+    /**
+     * 表达式的代码
+     */
+    @immutable()
+    public readonly code: string = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return this.code;
+    }
+}

package/src/types/logic/nodes/AssignmentExpression.ts

@@ -0,0 +1,30 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LogicItem, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 赋值
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class AssignmentExpression extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.AssignmentExpression;
+    /**
+     * 左边项
+     */
+    @immutable()
+    public readonly left: LogicItem = undefined;
+    /**
+     * 右边项
+     */
+    @immutable()
+    public readonly right: LogicItem = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return `${this.left.toScript()} = ${this.right.toScript()}`;
+    }
+}

package/src/types/logic/nodes/BuiltInFuncParam.ts

@@ -0,0 +1,35 @@
+import { immutable } from '../../decorators';
+import { ExpressionNode, LOGIC_TYPE } from '../LogicItem';
+
+/**
+ * 内置函数参数
+ * @TODO: 当前类目前主要用于生成文档
+ */
+export class BuiltInFuncParam extends ExpressionNode {
+    /**
+     * 逻辑节点类型
+     */
+    @immutable()
+    public readonly type: LOGIC_TYPE = LOGIC_TYPE.BuiltInFuncParam;
+    /**
+     * 参数名
+     */
+    @immutable()
+    public readonly name: string = undefined;
+    /**
+     * 参数类型
+     */
+    @immutable()
+    public readonly schema: any = undefined;
+    /**
+     * 参数值
+     */
+    @immutable()
+    public readonly builtInFuncParamValue: ExpressionNode = undefined;
+    /**
+     * 生成 JS 脚本
+     */
+    toScript() {
+        return this.builtInFuncParamValue ? this.builtInFuncParamValue.toScript() : null;
+    }
+}