[backend] saved filter module updated (#6044)

Author: ValentinBouzinFiligran

opencti-platform/opencti-graphql/graphql-codegen.yml

@@ -55,6 +55,7 @@ generates:
         DraftWorkspace: ../modules/draftWorkspace/draftWorkspace-types#BasicStoreEntityDraftWorkspace
         ExclusionList: ../modules/exclusionList/exclusionList-types#BasicStoreEntityExclusionList
         FintelTemplate: ../modules/fintelTemplate/fintelTemplate-types#BasicStoreEntityFintelTemplate
+        SavedFilter: ../modules/savedFilter/savedFilter-types#BasicStoreEntitySavedFilter
   ./graphql.schema.json:
     plugins:
       - "introspection"

opencti-platform/opencti-graphql/src/generated/graphql.ts

@@ -0,0 +1,14 @@
+import type { StixSavedFilter, StoreEntitySavedFilter } from './savedFilter-types';
+import { buildStixObject } from '../../database/stix-converter';
+
+const convertSavedFiltersToStix = (instance: StoreEntitySavedFilter): StixSavedFilter => {
+  const stixObject = buildStixObject(instance);
+  return {
+    ...stixObject,
+    name: instance.name,
+    filter: instance.filter,
+    scope: instance.scope,
+  };
+};
+
+export default convertSavedFiltersToStix;

opencti-platform/opencti-graphql/src/modules/filter/savedFilter-domain.ts

@@ -0,0 +1,15 @@
+import { type BasicStoreEntitySavedFilter, ENTITY_TYPE_SAVED_FILTER, StoreEntitySavedFilter } from './savedFilter-types';
+import type { AuthContext, AuthUser } from '../../types/user';
+import { listEntitiesPaginated } from '../../database/middleware-loader';
+import type { QuerySavedFiltersArgs, SavedFilterAddInput } from '../../generated/graphql';
+import { createInternalObject, deleteInternalObject } from '../../domain/internalObject';
+
+export const findAll = (context: AuthContext, user: AuthUser, args: QuerySavedFiltersArgs) => {
+  return listEntitiesPaginated<BasicStoreEntitySavedFilter>(context, user, [ENTITY_TYPE_SAVED_FILTER], args);
+};
+export const addSavedFilter = (context: AuthContext, user: AuthUser, input: SavedFilterAddInput) => {
+  return createInternalObject<StoreEntitySavedFilter>(context, user, input, ENTITY_TYPE_SAVED_FILTER);
+};
+export const deleteSavedFilter = (context: AuthContext, user: AuthUser, savedFilterId: string) => {
+  return deleteInternalObject(context, user, savedFilterId, ENTITY_TYPE_SAVED_FILTER);
+};

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-converter.ts

@@ -0,0 +1,8 @@
+import { registerGraphqlSchema } from '../../graphql/schema';
+import savedFilterTypeDefs from './savedFilter.graphql';
+import savedFilterResolver from './savedFilter-resolver';
+
+registerGraphqlSchema({
+  schema: savedFilterTypeDefs,
+  resolver: savedFilterResolver
+});

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-domain.ts

@@ -0,0 +1,25 @@
+import type { BasicStoreEntity, StoreEntity } from '../../types/store';
+import type { StixObject } from '../../types/stix-common';
+
+export const ENTITY_TYPE_SAVED_FILTER = 'SavedFilter';
+
+export interface BasicStoreEntitySavedFilter extends BasicStoreEntity {
+  user: string
+  name: string
+  filter: string
+  scope: string[]
+}
+
+export interface StoreEntitySavedFilter extends StoreEntity {
+  user: string
+  name: string
+  filter: string
+  scope: string[]
+}
+
+export interface StixSavedFilter extends StixObject {
+  user: string
+  name: string
+  filter: string
+  scope: string[]
+}

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-graphql.ts

@@ -1,12 +1,13 @@
 type SavedFilter implements InternalObject & BasicObject {
     id: ID!
-    name: String!
     standard_id: String!
     entity_type: String!
     parent_types: [String]!
+    # SavedFilters
+    name: String!
     filters: String!
+    scope: [String!]
     created_at: DateTime!
-    scope: [String]
 }
 
 type SavedFilterEdge {
@@ -37,7 +38,7 @@ type Query {
 }
 
 type Mutation {
-    savedFilterAdd(input: SavedFilterAddInput): SavedFilter @auth
+    savedFilterAdd(input: SavedFilterAddInput!): SavedFilter @auth
     savedFilterDelete(id: ID!): ID @auth
 #    savedFiltersDelete(): ID @auth
 }

opencti-platform/opencti-graphql/src/modules/filter/savedFilter-resolver.ts renamed to opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-resolver.ts

@@ -0,0 +1,79 @@
+import { v4 as uuidv4 } from 'uuid';
+import { ENTITY_TYPE_USER } from 'src/schema/internalObject';
+import convertSavedFiltersToStix from './savedFilter-converter';
+import { ENTITY_TYPE_SAVED_FILTER, type StoreEntitySavedFilter, type StixSavedFilter } from './savedFilter-types';
+import { ABSTRACT_INTERNAL_OBJECT } from '../../schema/general';
+import { type ModuleDefinition, registerDefinition } from '../../schema/module';
+import { isFeatureEnabled } from '../../config/conf';
+
+const SAVED_FILTER_DEFINITION: ModuleDefinition<StoreEntitySavedFilter, StixSavedFilter> = {
+  type: {
+    id: 'saved-filter',
+    name: ENTITY_TYPE_SAVED_FILTER,
+    category: ABSTRACT_INTERNAL_OBJECT,
+    aliased: false,
+  },
+  identifier: {
+    definition: {
+      [ENTITY_TYPE_SAVED_FILTER]: () => uuidv4()
+    },
+  },
+  attributes: [
+    {
+      name: 'user',
+      label: 'User',
+      type: 'string',
+      format: 'id',
+      entityTypes: [ENTITY_TYPE_USER],
+      mandatoryType: 'no',
+      editDefault: false,
+      multiple: false,
+      upsert: true,
+      isFilterable: true
+    },
+    {
+      name: 'name',
+      label: 'Name',
+      type: 'string',
+      format: 'short',
+      mandatoryType: 'external',
+      editDefault: false,
+      multiple: false,
+      upsert: false,
+      isFilterable: true
+    },
+    {
+      name: 'filter',
+      label: 'Filter',
+      type: 'string',
+      format: 'short',
+      mandatoryType: 'external',
+      editDefault: false,
+      multiple: true,
+      upsert: false,
+      isFilterable: true
+    },
+    {
+      name: 'scope',
+      label: 'Scope',
+      type: 'string',
+      format: 'short',
+      mandatoryType: 'external',
+      editDefault: false,
+      multiple: true,
+      upsert: false,
+      isFilterable: true
+    }
+  ],
+  relations: [],
+  representative: (instance: StixSavedFilter) => {
+    return instance.name;
+  },
+  converter: convertSavedFiltersToStix,
+};
+
+const isSavedFiltersEnabled = isFeatureEnabled('SAVED_FILTERS');
+
+if (isSavedFiltersEnabled) {
+  registerDefinition(SAVED_FILTER_DEFINITION);
+}

opencti-platform/opencti-graphql/src/modules/savedFilter/savedFilter-types.ts

@@ -6,6 +6,7 @@ import { ENTITY_TYPE_DELETE_OPERATION } from '../modules/deleteOperation/deleteO
 import { ENTITY_TYPE_DRAFT_WORKSPACE } from '../modules/draftWorkspace/draftWorkspace-types';
 import { ENTITY_TYPE_EXCLUSION_LIST } from '../modules/exclusionList/exclusionList-types';
 import { ENTITY_TYPE_FINTEL_TEMPLATE } from '../modules/fintelTemplate/fintelTemplate-types';
+import { ENTITY_TYPE_SAVED_FILTER } from '../modules/savedFilter/savedFilter-types';
 
 export const ENTITY_TYPE_SETTINGS = 'Settings';
 export const ENTITY_TYPE_MIGRATION_STATUS = 'MigrationStatus';
@@ -45,6 +46,7 @@ const DATED_INTERNAL_OBJECTS = [
   ENTITY_TYPE_DELETE_OPERATION,
   ENTITY_TYPE_DRAFT_WORKSPACE,
   ENTITY_TYPE_EXCLUSION_LIST,
+  ENTITY_TYPE_SAVED_FILTER,
 ];
 const INTERNAL_OBJECTS = [
   ENTITY_TYPE_SETTINGS,
@@ -74,6 +76,7 @@ const INTERNAL_OBJECTS = [
   ENTITY_TYPE_DRAFT_WORKSPACE,
   ENTITY_TYPE_EXCLUSION_LIST,
   ENTITY_TYPE_FINTEL_TEMPLATE,
+  ENTITY_TYPE_SAVED_FILTER,
 ];
 const HISTORY_OBJECTS = [ENTITY_TYPE_WORK];