R/pluginConfig.R

In alteryx/jeeves: A helper for developing predictive tools in Alteryx

#' Make plugin configuration xml file from macro
#' 
#' 
#' @export
#' @param yxmc path to macro
#' @param saveToFile file to save config.xml to
writePluginConfig <- function(yxmc, saveToFile = NULL){
  x <- getIO(yxmc)
  y <- do.call(makePluginConfig, x)
  if (!is.null(saveToFile)){
    saveXML(y, file = saveToFile)
    return(saveToFile)
  } else {
    return(y)
  }
}

#' @export
#' @inheritParams writePluginConfig
#' @rdname writePluginConfig
yxmc2PluginConfig <- function(yxmc, saveToFile = NULL){
  .Deprecated('writePluginConfig')
  writePluginConfig(yxmc = yxmc, saveToFile = saveToFile)
}


#' Helper function to create plugin configuration xml file
#' 
#' 
#' @import XML
#' @param inputs inputs
#' @param outputs outputs
#' @param pluginName pluginName
#' @param properties properties
#' @param helpLink help link
#' @examples 
#' \dontrun{
#'   x = list(
#'     inputs = list(
#'       list(Name = 'Input A', Abbrev = "A"),
#'       list(Name = 'Input B', Abbrev = "B")
#'     ),
#'     outputs = list(
#'       list(Name = 'Output C', Abbrev = "C")
#'     ),
#'     pluginName = 'Foo'
#'   )
#'   do.call(makePluginConfig, x)
#' }
#' @keywords internal
makePluginConfig <- function(inputs, outputs, pluginName, properties = NULL, 
    helpLink = ""){
  dirs <- dirNames()
  d = suppressWarnings(XML::xmlTree("AlteryxJavaScriptPlugin"))
  d$addNode("EngineSettings", attrs= list(
    EngineDLL = "Macro",
    EngineDLLEntryPoint = sprintf("%s/%s/%s.yxmc", pluginName, dirs$macros, pluginName),
    SDKVersion = "10.1"
  ))
  d$addNode("GuiSettings", attrs = list(
    Html = sprintf("%sGui.html", pluginName),
    Icon = sprintf("%sIcon.png", pluginName),
    SDKVersion = "10.1",
    Help = helpLink
  ), close = F)
  d$addNode("InputConnections", .children = sapply(inputs, function(x){
    d$addNode("Connection", attrs = list(
      Name = x$Name,
      AllowMultiple = "False",
      Optional = if (is.null(x$Optional)) "False" else x$Optional,
      Type = "Connection",
      Label = if (x$Abbrev == "NULL") "" else x$Abbrev
    ))
  }))
  d$addNode("OutputConnections", .children = sapply(outputs, function(x){
    d$addNode("Connection", attrs = list(
      Name = x$Name,
      AllowMultiple = "False",
      Optional = "False",
      Type = "Connection",
      Label = if (x$Abbrev == "NULL") "" else x$Abbrev
    ))
  }))
  d$closeNode()
  if (!is.null(properties)){
    if (properties[['Name']] == '{{ pluginName }}'){
      properties[['Name']] = pluginName
    }
    d$addNode("Properties", close = F)
    d$addNode(
      "MetaInfo", 
      .children = sapply(names(properties), function(k){
        d$addNode(k, properties[[k]])
      })
    )
  }
  d$closeNode()
  d$value() 
}

getProperties <- function(r){
  props <- getNodeSet(r, "//Properties//MetaInfo[not(@*)]")[[1]]
  nms <- xmlSApply(props, xmlName)
  vals <- xmlSApply(props, xmlValue)
  setNames(as.list(vals), nms)
}

# Get input/output configuration information from a macro
getIO <- function(template){
  xml <- XML::xmlInternalTreeParse(template)
  r <- XML::xmlRoot(xml)
  g <- getNodeSet(r, '//Question')
  l <- lapply(g, XML::xmlToList)
  getMacroIO <- function(type = 'MacroInput'){
    toolIds = unlist(Filter(Negate(is.null), sapply(l, function(d){
      if (d$Type == type) d$ToolId[['value']]
    })))
    inputs <- lapply(toolIds, function(i){
      query = sprintf('//Node[@ToolID="%s"]//Properties//Configuration', i)
      node = getNodeSet(r, query)
      XML::xmlToList(node[[1]])[c('Name', 'Abbrev', 'Optional')]
    })
    lapply(inputs, function(x){
      if (is.null(x$Abbrev)){
        x$Abbrev = ""
      } else {
        x$Abbrev = gsub("\n|\\s+", "", x$Abbrev)
      }
      return(x)
    })
  }
  help <- getNodeSet(r, '//MacroCustomHelpLink')
  helpLink = if (length(help) > 0){
    xmlValue(help[[1]])
  } else {
    ""
  }
  d <- list(
    inputs = getMacroIO('MacroInput'),
    outputs = getMacroIO('MacroOutput'),
    pluginName = tools::file_path_sans_ext(basename(template)),
    properties = getProperties(r),
    helpLink = paste0(sub("AlteryxHelp:", "", helpLink), ".htm")
  )
  if (length(d$inputs) == 0){
    d$inputs <- getMacroIO('LockInMacroInput')
  }
  return(d)
}

# Make plugin configuration xml file from macro
makeConfigFile <- function(yxmc){
  doc <- xmlTreeParse(yxmc)
  root <- xmlRoot(doc)
  props <- Filter(function(x){length(x) > 0}, getProperties(root))
  ayxPlugin <- newXMLNode("AlteryxJavaScriptPlugin", 
    newXMLNode("Properties", 
      newXMLNode("MetaInfo", lapply(names(props), function(k){
        newXMLNode(k, props[[k]])
      }))
    )
  )
  xmlDoc(ayxPlugin) 
}