Merge pull request #95 from THM-Graphs/feature/image-url-conditions

Image url conditions

Author: SamuelSchepp

nakar-client-web/src-gen/api-client/types.gen.ts

@@ -30,6 +30,7 @@ export type NodeConfigurationDto = {
     property: string;
     linkTemplate: string;
     urlEncode: boolean;
+    valueRegex: string;
 };
 
 export type DatabaseConnectionDto = {
@@ -237,6 +238,7 @@ export type UpdateNodeConfigurationRequestBodyDto = {
     property: string;
     linkTemplate: string;
     urlEncode: boolean;
+    valueRegex: string;
 };
 
 export type UpdateDatabaseConnectionRequestBodyDto = {

nakar-client-web/src/shared/cms/NodeConfigurationEditor.tsx

@@ -122,7 +122,7 @@ export function NodeConfigurationEditor(props: {
                 </Form.Label>
                 <Form.Control
                   type="text"
-                  placeholder="https://images.org/{{value}}.png"
+                  placeholder="https://images.org/{{{value}}}.png"
                   className={"font-monospace"}
                   value={props.value.linkTemplate}
                   onChange={(e) => {
@@ -153,6 +153,42 @@ export function NodeConfigurationEditor(props: {
                 />
               </Form.Group>
             </Col>
+            {props.value.type === "image" && (
+              <Col>
+                <Form.Group className="" controlId={`valueRegex_${key}`}>
+                  <Form.Label>
+                    Value Regex{" "}
+                    <OverlayTrigger
+                      overlay={
+                        <Tooltip>
+                          Define a regex expression to filter values.
+                        </Tooltip>
+                      }
+                    >
+                      <i className={"bi bi-info-circle"}></i>
+                    </OverlayTrigger>
+                  </Form.Label>
+                  <Form.Control
+                    type="text"
+                    placeholder=".*\.jpg$"
+                    className={"font-monospace"}
+                    value={props.value.valueRegex}
+                    onChange={(e) => {
+                      props.onChange({
+                        ...props.value,
+                        valueRegex: e.target.value,
+                      });
+                    }}
+                  />
+                </Form.Group>
+                <Form.Text className={"small text-muted"}>
+                  Example:{" "}
+                  <code className={"user-select-text code"}>
+                    commons\.wikimedia\.org
+                  </code>
+                </Form.Text>
+              </Col>
+            )}
           </Row>
         </Stack>
         {props.onDelete != null && (

nakar-client-web/src/shared/cms/NodeConfigurationsEditor.tsx

@@ -17,6 +17,7 @@ export function NodeConfigurationsEditor(props: {
       label: "",
       linkTemplate: "",
       urlEncode: false,
+      valueRegex: "",
     };
     props.onChange([...props.value, newNodeConfiguration]);
   }, [props.value, props.onChange]);

nakar-server/src/api/node-configuration/content-types/node-configuration/schema.json

@@ -36,6 +36,9 @@
     "urlEncode": {
       "type": "boolean",
       "required": false
+    },
+    "valueRegex": {
+      "type": "string"
     }
   }
 }

nakar-server/src/lib/application/AppModule.ts

@@ -24,6 +24,7 @@ import { CommonPropertiesController } from '../http/routes/common-properties/Com
 import { MonitoringService } from '../monitoring/MonitoringService';
 import { MediaService } from '../media/MediaService';
 import { EncryptionService } from '../encryption/EncryptionService';
+import { IsValidRegex } from '../schema/IsValidRegex';
 
 @Module({
   controllers: [
@@ -54,6 +55,7 @@ import { EncryptionService } from '../encryption/EncryptionService';
     MonitoringService,
     MediaService,
     EncryptionService,
+    IsValidRegex,
   ],
 })
 export class AppModule {}

nakar-server/src/lib/database/DatabaseService.ts

@@ -1191,6 +1191,7 @@ export class DatabaseService {
           linkTemplate: newDocument.linkTemplate,
           database: databaseConnection.documentId,
           urlEncode: newDocument.urlEncode,
+          valueRegex: newDocument.valueRegex,
         };
 
       const updatedDocument: Modules.Documents.Result<'api::node-configuration.node-configuration'> | null =

nakar-server/src/lib/http/routes/database-connection/dto/UpdateNodeConfigurationRequestBodyDto.ts

@@ -1,6 +1,13 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { NodeConfigurationTypeDto } from '../../../../schema/dtos/NodeConfigurationTypeDto';
-import { IsBoolean, IsEnum, IsNotEmpty, IsString } from 'class-validator';
+import {
+  IsBoolean,
+  IsEnum,
+  IsNotEmpty,
+  IsString,
+  Validate,
+} from 'class-validator';
+import { IsValidRegex } from '../../../../schema/IsValidRegex';
 
 export class UpdateNodeConfigurationRequestBodyDto {
   @ApiProperty({ type: String })
@@ -27,4 +34,9 @@ export class UpdateNodeConfigurationRequestBodyDto {
   @ApiProperty({ type: Boolean })
   @IsBoolean()
   public urlEncode!: boolean;
+
+  @ApiProperty({ type: String })
+  @IsString()
+  @Validate(IsValidRegex)
+  public valueRegex!: string;
 }

nakar-server/src/lib/live-canvas/graph/NodeIndex.ts

@@ -309,6 +309,19 @@ export class NodeIndex {
       if (value == null) {
         continue;
       }
+
+      // Check regex
+      const regexToUse: string = nodeConfig.valueRegex?.trim() ?? '';
+      if (
+        regexToUse.length > 0 &&
+        !this._valueMatchesRegex(value, regexToUse)
+      ) {
+        this._logger.debug(
+          `Will skip node value for image url, because regex does not match.\nValue: ${value}\nRegex: ${regexToUse}`,
+        );
+        continue;
+      }
+
       const template: HandlebarsTemplateDelegate = Handlebars.compile(
         nodeConfig.linkTemplate,
       );
@@ -370,4 +383,13 @@ export class NodeIndex {
     }
     return null;
   }
+
+  private _valueMatchesRegex(inputString: string, regex: string): boolean {
+    try {
+      return new RegExp(regex).test(inputString);
+    } catch (error: unknown) {
+      this._logger.error(error);
+      return false;
+    }
+  }
 }

nakar-server/src/lib/schema/IsValidRegex.ts

@@ -0,0 +1,25 @@
+import {
+  ValidationArguments,
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+} from 'class-validator';
+
+@ValidatorConstraint({ name: 'isValidRegex', async: false })
+export class IsValidRegex implements ValidatorConstraintInterface {
+  public validate(value: unknown): boolean {
+    if (typeof value !== 'string') {
+      return false;
+    }
+
+    try {
+      new RegExp(value);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+
+  public defaultMessage(args: ValidationArguments): string {
+    return `${args.property} must be a valid regex.`;
+  }
+}

nakar-server/src/lib/schema/SchemaFactoryService.ts

@@ -106,6 +106,7 @@ export class SchemaFactoryService {
             property: nodeConfiguration.property ?? '',
             linkTemplate: nodeConfiguration.linkTemplate ?? '',
             urlEncode: nodeConfiguration.urlEncode ?? false,
+            valueRegex: nodeConfiguration.valueRegex ?? '',
           }),
       ),
       databaseType: match(databaseDBDTO.databaseType)