coriolis-web/src/plugins/endpoint/default/OptionsSchemaPlugin.ts

/*
Copyright (C) 2017  Cloudbase Solutions SRL
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/* eslint-disable no-param-reassign */

import { defaultSchemaToFields } from './ConnectionSchemaPlugin'

import Utils from '../../../utils/ObjectUtils'

import type { Field } from '../../../@types/Field'
import type { OptionValues, StorageMap } from '../../../@types/Endpoint'
import type { SchemaProperties, SchemaDefinitions } from '../../../@types/Schema'
import type { NetworkMap } from '../../../@types/Network'
import type { InstanceScript } from '../../../@types/Instance'
import { executionOptions, migrationFields } from '../../../constants'

const migrationImageOsTypes = ['windows', 'linux']

export const defaultFillFieldValues = (field: Field, option: OptionValues) => {
  if (field.type === 'string') {
    field.enum = [...option.values]
    if (option.config_default) {
      field.default = typeof option.config_default === 'string' ? option.config_default : option.config_default.id
    }
  }
  if (field.type === 'array') {
    field.enum = [...option.values]
  }
  if (field.type === 'boolean' && option.config_default != null) {
    field.default = typeof option.config_default === 'boolean' ? option.config_default : option.config_default === 'true'
  }
}

export const defaultFillMigrationImageMapValues = (
  field: Field,
  option: OptionValues,
  migrationImageMapFieldName: string,
  imageSuffix: string,
): boolean => {
  if (field.name !== migrationImageMapFieldName) {
    return false
  }
  field.properties = migrationImageOsTypes.map(os => {
    const values = (option.values as any)
      .filter((v: { os_type: string }) => v.os_type === os || v.os_type === 'unknown')
      .sort((v1: { os_type: string }, v2: { os_type: string }) => {
        if (v1.os_type === 'unknown' && v2.os_type !== 'unknown') {
          return 1
        } if (v1.os_type !== 'unknown' && v2.os_type === 'unknown') {
          return -1
        }
        return 0
      })
    const unknownIndex = values.findIndex((v: { os_type: string }) => v.os_type === 'unknown')
    if (unknownIndex > -1 && values.filter((v: { os_type: string }) => v.os_type === 'unknown').length < values.length) {
      values.splice(unknownIndex, 0, { separator: true })
    }

    return {
      name: `${os}${imageSuffix}`,
      type: 'string',
      enum: values,
    }
  })
  return true
}

export const defaultGetDestinationEnv = (
  options?: { [prop: string]: any } | null,
  oldOptions?: { [prop: string]: any } | null,
  imageSuffix?: string,
): any => {
  const env: any = {}
  const specialOptions = ['execute_now', 'separate_vm', 'skip_os_morphing', 'description']
    .concat(migrationFields.map(f => f.name))
    .concat(executionOptions.map(o => o.name))
    .concat(migrationImageOsTypes.map(o => `${o}${imageSuffix}`))

  if (!options) {
    return env
  }

  Object.keys(options).forEach(optionName => {
    if (specialOptions.find(o => o === optionName) || !options || options[optionName] == null || options[optionName] === '') {
      return
    }
    if (typeof options[optionName] === 'object') {
      const oldOption = oldOptions?.[optionName] || {}
      env[optionName] = {
        ...oldOption,
        ...options[optionName],
      }
    } else {
      env[optionName] = options ? Utils.trim(optionName, options[optionName]) : null
    }
  })
  return env
}

export const defaultGetMigrationImageMap = (
  options: { [prop: string]: any } | null | undefined,
  oldOptions: any,
  migrationImageMapFieldName: string,
  imageSuffix: string,
) => {
  const env: any = {}
  const usableOptions = options
  if (!usableOptions) {
    return env
  }

  const hasMigrationMap = Object.keys(usableOptions).find(k => k === migrationImageMapFieldName)
  if (!hasMigrationMap) {
    return env
  }
  migrationImageOsTypes.forEach(os => {
    let value = usableOptions[migrationImageMapFieldName][`${os}${imageSuffix}`]

    // Make sure the migr. image mapping has all the OSes filled,
    // even if only one OS mapping was updated,
    // ie. don't send just the updated OS map to the server, send them all if one was updated.
    if (!value) {
      value = oldOptions?.[migrationImageMapFieldName]?.[`${os}${imageSuffix}`]
      if (!value) {
        return
      }
    }

    if (!env[migrationImageMapFieldName]) {
      env[migrationImageMapFieldName] = {}
    }

    env[migrationImageMapFieldName][`${os}${imageSuffix}`] = value
  })

  return env
}

export default class OptionsSchemaParser {
  static migrationImageMapFieldName = 'migr_image_map'

  static imageSuffix = '_os_image'

  static parseSchemaToFields(
    schema: SchemaProperties, schemaDefinitions?: SchemaDefinitions | null, dictionaryKey?: string,
  ) {
    return defaultSchemaToFields(schema, schemaDefinitions, dictionaryKey)
  }

  static fillFieldValues(field: Field, options: OptionValues[], customFieldName?: string) {
    const option = options
      .find(f => (customFieldName ? f.name === customFieldName : f.name === field.name))
    if (!option) {
      return
    }
    if (!defaultFillMigrationImageMapValues(
      field,
      option,
      this.migrationImageMapFieldName,
      this.imageSuffix,
    )) {
      defaultFillFieldValues(field, option)
    }
  }

  static getDestinationEnv(options?: { [prop: string]: any } | null, oldOptions?: any) {
    const env = {
      ...defaultGetDestinationEnv(
        options,
        oldOptions,
        this.imageSuffix,
      ),
      ...defaultGetMigrationImageMap(
        options,
        oldOptions,
        this.migrationImageMapFieldName,
        this.imageSuffix,
      ),
    }
    return env
  }

  static getNetworkMap(networkMappings: NetworkMap[] | null | undefined) {
    const payload: any = {}
    if (networkMappings && networkMappings.length) {
      const hasSecurityGroups = Boolean(networkMappings
        .find(nm => nm.targetNetwork.security_groups))
      networkMappings.forEach(mapping => {
        let target
        if (hasSecurityGroups) {
          target = {
            id: mapping.targetNetwork.id,
            security_groups: mapping.targetSecurityGroups
              ? mapping.targetSecurityGroups.map(s => (typeof s === 'string' ? s : s.id))
              : [],
          }
        } else {
          target = mapping.targetNetwork.id
        }
        payload[mapping.sourceNic.network_name] = target
      })
    }
    return payload
  }

  static getStorageMap(
    defaultStorage: string | null | undefined,
    storageMap: StorageMap[] | null,
    configDefault?: string | null,
  ) {
    if (!defaultStorage && !storageMap) {
      return null
    }

    const payload: any = {}
    if (defaultStorage) {
      payload.default = defaultStorage
    }

    if (!storageMap) {
      return payload
    }

    storageMap.forEach(mapping => {
      if (mapping.target.id === null && !configDefault) {
        return
      }

      if (mapping.type === 'backend') {
        if (!payload.backend_mappings) {
          payload.backend_mappings = []
        }
        payload.backend_mappings.push({
          source: mapping.source.storage_backend_identifier,
          destination: mapping.target.id === null ? configDefault : mapping.target.name,
        })
      } else {
        if (!payload.disk_mappings) {
          payload.disk_mappings = []
        }
        payload.disk_mappings.push({
          disk_id: mapping.source.id.toString(),
          destination: mapping.target.id === null ? configDefault : mapping.target.name,
        })
      }
    })
    return payload
  }

  static getUserScripts(uploadedUserScripts: InstanceScript[]) {
    const payload: any = {}
    const globalScripts = uploadedUserScripts.filter(s => s.global)
    if (globalScripts.length) {
      payload.global = {}
      globalScripts.forEach(script => {
        payload.global[script.global || ''] = script.scriptContent
      })
    }
    const instanceScripts = uploadedUserScripts.filter(s => s.instanceName)
    if (instanceScripts.length) {
      payload.instances = {}
      instanceScripts.forEach(script => {
        payload.instances[script.instanceName || ''] = script.scriptContent
      })
    }
    return payload
  }
}