plugins/transforms/ssh/src/main/java/org/apache/hop/pipeline/transforms/ssh/SSHMeta.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hop.pipeline.transforms.ssh;

import org.apache.hop.core.CheckResult;
import org.apache.hop.core.ICheckResult;
import org.apache.hop.core.annotations.Transform;
import org.apache.hop.core.encryption.Encr;
import org.apache.hop.core.exception.HopTransformException;
import org.apache.hop.core.exception.HopXmlException;
import org.apache.hop.core.row.IRowMeta;
import org.apache.hop.core.row.IValueMeta;
import org.apache.hop.core.row.value.ValueMetaBoolean;
import org.apache.hop.core.row.value.ValueMetaString;
import org.apache.hop.core.util.Utils;
import org.apache.hop.core.variables.IVariables;
import org.apache.hop.core.vfs.HopVfs;
import org.apache.hop.core.xml.XmlHandler;
import org.apache.hop.i18n.BaseMessages;
import org.apache.hop.metadata.api.IHopMetadataProvider;
import org.apache.hop.pipeline.Pipeline;
import org.apache.hop.pipeline.PipelineMeta;
import org.apache.hop.pipeline.transform.*;
import org.w3c.dom.Node;

import java.util.List;

@Transform(
    id = "SSH",
    image = "ssh.svg",
    name = "i18n::SSH.Name",
    description = "i18n::SSH.Description",
    categoryDescription = "i18n:org.apache.hop.pipeline.transform:BaseTransform.Category.Utility",
    keywords = "i18n::SSHMeta.keyword",
    documentationUrl = "/pipeline/transforms/runssh.html")
public class SSHMeta extends BaseTransformMeta implements ITransformMeta<SSH, SSHData> {
  static Class<?> PKG = SSHMeta.class; // For Translator
  private static int DEFAULT_PORT = 22;

  private String command;
  private boolean dynamicCommandField;
  /** dynamic command fieldname */
  private String commandfieldname;

  private String serverName;
  private String port;
  private String userName;
  private String password;
  // key
  private boolean usePrivateKey;
  private String keyFileName;
  private String passPhrase;

  private String stdOutFieldName;
  private String stdErrFieldName;
  private String timeOut;
  // Proxy
  private String proxyHost;
  private String proxyPort;
  private String proxyUsername;
  private String proxyPassword;

  public SSHMeta() {
    super(); // allocate BaseTransformMeta
  }

  @Override
  public void loadXml(Node transformNode, IHopMetadataProvider metadataProvider)
      throws HopXmlException {
    readData(transformNode);
  }

  @Override
  public Object clone() {
    SSHMeta retval = (SSHMeta) super.clone();

    return retval;
  }

  @Override
  public void setDefault() {
    dynamicCommandField = false;
    command = null;
    commandfieldname = null;
    port = String.valueOf(DEFAULT_PORT);
    serverName = null;
    userName = null;
    password = null;
    usePrivateKey = true;
    keyFileName = null;
    stdOutFieldName = "stdOut";
    stdErrFieldName = "stdErr";
    timeOut = "0";
    proxyHost = null;
    proxyPort = null;
    proxyUsername = null;
    proxyPassword = null;
  }

  /** @return Returns the serverName. */
  public String getServerName() {
    return serverName;
  }

  /** @param serverName The serverName to set. */
  public void setServerName(String serverName) {
    this.serverName = serverName;
  }

  /** @return Returns the userName. */
  public String getuserName() {
    return userName;
  }

  /** @param userName The userName to set. */
  public void setuserName(String userName) {
    this.userName = userName;
  }

  /** @param password The password to set. */
  public void setpassword(String password) {
    this.password = password;
  }

  /** @return Returns the password. */
  public String getpassword() {
    return password;
  }

  /** @param commandfieldname The commandfieldname to set. */
  public void setcommandfieldname(String commandfieldname) {
    this.commandfieldname = commandfieldname;
  }

  /** @return Returns the commandfieldname. */
  public String getcommandfieldname() {
    return commandfieldname;
  }

  /** @param command The commandfieldname to set. */
  public void setCommand(String command) {
    this.command = command;
  }

  /** @return Returns the command. */
  public String getCommand() {
    return command;
  }

  /** @param value The dynamicCommandField to set. */
  public void setDynamicCommand(boolean value) {
    this.dynamicCommandField = value;
  }

  /** @return Returns the dynamicCommandField. */
  public boolean isDynamicCommand() {
    return dynamicCommandField;
  }

  /** @return Returns the port. */
  public String getPort() {
    return port;
  }

  /** @param port The port to set. */
  public void setPort(String port) {
    this.port = port;
  }

  public void usePrivateKey(boolean value) {
    this.usePrivateKey = value;
  }

  /** @return Returns the usePrivateKey. */
  public boolean isusePrivateKey() {
    return usePrivateKey;
  }

  /** @param value The keyFileName to set. */
  public void setKeyFileName(String value) {
    this.keyFileName = value;
  }

  /** @return Returns the keyFileName. */
  public String getKeyFileName() {
    return keyFileName;
  }

  /** @param value The passPhrase to set. */
  public void setPassphrase(String value) {
    this.passPhrase = value;
  }

  /** @return Returns the passPhrase. */
  public String getPassphrase() {
    return passPhrase;
  }

  /*
   * @param timeOut The timeOut to set.
   */
  public void setTimeOut(String timeOut) {
    this.timeOut = timeOut;
  }

  /** @return Returns the timeOut. */
  public String getTimeOut() {
    return timeOut;
  }

  /** @param value The stdOutFieldName to set. */
  public void setstdOutFieldName(String value) {
    this.stdOutFieldName = value;
  }

  /** @return Returns the stdOutFieldName. */
  public String getStdOutFieldName() {
    return stdOutFieldName;
  }

  /** @param value The stdErrFieldName to set. */
  public void setStdErrFieldName(String value) {
    this.stdErrFieldName = value;
  }

  /** @return Returns the stdErrFieldName. */
  public String getStdErrFieldName() {
    return stdErrFieldName;
  }

  /** @param value The proxyHost to set. */
  public void setProxyHost(String value) {
    this.proxyHost = value;
  }

  /** @return Returns the proxyHost. */
  public String getProxyHost() {
    return proxyHost;
  }

  /** @param value The proxyPort to set. */
  public void setProxyPort(String value) {
    this.proxyPort = value;
  }

  /** @return Returns the proxyPort. */
  public String getProxyPort() {
    return proxyPort;
  }

  /** @param value The proxyUsername to set. */
  public void setProxyUsername(String value) {
    this.proxyUsername = value;
  }

  /** @return Returns the proxyUsername. */
  public String getProxyUsername() {
    return proxyUsername;
  }

  /** @param value The proxyPassword to set. */
  public void setProxyPassword(String value) {
    this.proxyPassword = value;
  }

  /** @return Returns the proxyPassword. */
  public String getProxyPassword() {
    return proxyPassword;
  }

  @Override
  public String getXml() {
    StringBuilder retval = new StringBuilder();

    retval
        .append("    ")
        .append(XmlHandler.addTagValue("dynamicCommandField", dynamicCommandField));
    retval.append("    ").append(XmlHandler.addTagValue("command", command));
    retval.append("    ").append(XmlHandler.addTagValue("commandfieldname", commandfieldname));
    retval.append("    ").append(XmlHandler.addTagValue("port", port));
    retval.append("    ").append(XmlHandler.addTagValue("servername", serverName));
    retval.append("    ").append(XmlHandler.addTagValue("userName", userName));
    retval
        .append("    ")
        .append(
            XmlHandler.addTagValue("password", Encr.encryptPasswordIfNotUsingVariables(password)));
    retval.append("    ").append(XmlHandler.addTagValue("usePrivateKey", usePrivateKey));
    retval.append("    ").append(XmlHandler.addTagValue("keyFileName", keyFileName));
    retval
        .append("    ")
        .append(
            XmlHandler.addTagValue(
                "passPhrase", Encr.encryptPasswordIfNotUsingVariables(passPhrase)));
    retval.append("    ").append(XmlHandler.addTagValue("stdOutFieldName", stdOutFieldName));
    retval.append("    ").append(XmlHandler.addTagValue("stdErrFieldName", stdErrFieldName));
    retval.append("    ").append(XmlHandler.addTagValue("timeOut", timeOut));
    retval.append("    ").append(XmlHandler.addTagValue("proxyHost", proxyHost));
    retval.append("    ").append(XmlHandler.addTagValue("proxyPort", proxyPort));
    retval.append("    ").append(XmlHandler.addTagValue("proxyUsername", proxyUsername));
    retval
        .append("    ")
        .append(
            XmlHandler.addTagValue(
                "proxyPassword", Encr.encryptPasswordIfNotUsingVariables(proxyPassword)));
    return retval.toString();
  }

  private void readData(Node transformNode) throws HopXmlException {
    try {
      dynamicCommandField =
          "Y".equalsIgnoreCase(XmlHandler.getTagValue(transformNode, "dynamicCommandField"));
      command = XmlHandler.getTagValue(transformNode, "command");
      commandfieldname = XmlHandler.getTagValue(transformNode, "commandfieldname");
      port = XmlHandler.getTagValue(transformNode, "port");
      serverName = XmlHandler.getTagValue(transformNode, "servername");
      userName = XmlHandler.getTagValue(transformNode, "userName");
      password =
          Encr.decryptPasswordOptionallyEncrypted(
              XmlHandler.getTagValue(transformNode, "password"));

      usePrivateKey = "Y".equalsIgnoreCase(XmlHandler.getTagValue(transformNode, "usePrivateKey"));
      keyFileName = XmlHandler.getTagValue(transformNode, "keyFileName");
      passPhrase =
          Encr.decryptPasswordOptionallyEncrypted(
              XmlHandler.getTagValue(transformNode, "passPhrase"));
      stdOutFieldName = XmlHandler.getTagValue(transformNode, "stdOutFieldName");
      stdErrFieldName = XmlHandler.getTagValue(transformNode, "stdErrFieldName");
      timeOut = XmlHandler.getTagValue(transformNode, "timeOut");
      proxyHost = XmlHandler.getTagValue(transformNode, "proxyHost");
      proxyPort = XmlHandler.getTagValue(transformNode, "proxyPort");
      proxyUsername = XmlHandler.getTagValue(transformNode, "proxyUsername");
      proxyPassword =
          Encr.decryptPasswordOptionallyEncrypted(
              XmlHandler.getTagValue(transformNode, "proxyPassword"));

    } catch (Exception e) {
      throw new HopXmlException(
          BaseMessages.getString(PKG, "SSHMeta.Exception.UnableToReadTransformMeta"), e);
    }
  }

  @Override
  public void check(
      List<ICheckResult> remarks,
      PipelineMeta pipelineMeta,
      TransformMeta transformMeta,
      IRowMeta prev,
      String[] input,
      String[] output,
      IRowMeta info,
      IVariables variables,
      IHopMetadataProvider metadataProvider) {

    CheckResult cr;
    String errorMessage = "";

    // Target hostname
    if (Utils.isEmpty(getServerName())) {
      errorMessage = BaseMessages.getString(PKG, "SSHMeta.CheckResult.TargetHostMissing");
      cr = new CheckResult(ICheckResult.TYPE_RESULT_ERROR, errorMessage, transformMeta);
      remarks.add(cr);
    } else {
      errorMessage = BaseMessages.getString(PKG, "SSHMeta.CheckResult.TargetHostOK");
      cr = new CheckResult(ICheckResult.TYPE_RESULT_OK, errorMessage, transformMeta);
      remarks.add(cr);
    }
    if (isusePrivateKey()) {
      String keyfilename = variables.resolve(getKeyFileName());
      if (Utils.isEmpty(keyfilename)) {
        errorMessage = BaseMessages.getString(PKG, "SSHMeta.CheckResult.PrivateKeyFileNameMissing");
        cr = new CheckResult(ICheckResult.TYPE_RESULT_ERROR, errorMessage, transformMeta);
        remarks.add(cr);
      } else {
        errorMessage = BaseMessages.getString(PKG, "SSHMeta.CheckResult.PrivateKeyFileNameOK");
        cr = new CheckResult(ICheckResult.TYPE_RESULT_OK, errorMessage, transformMeta);
        remarks.add(cr);
        boolean keyFileExists = false;
        try {
          keyFileExists = HopVfs.fileExists(keyfilename);
        } catch (Exception e) {
          /* Ignore */
        }
        if (!keyFileExists) {
          errorMessage =
              BaseMessages.getString(
                  PKG, "SSHMeta.CheckResult.PrivateKeyFileNotExist", keyfilename);
          cr = new CheckResult(ICheckResult.TYPE_RESULT_ERROR, errorMessage, transformMeta);
          remarks.add(cr);
        } else {
          errorMessage =
              BaseMessages.getString(PKG, "SSHMeta.CheckResult.PrivateKeyFileExists", keyfilename);
          cr = new CheckResult(ICheckResult.TYPE_RESULT_OK, errorMessage, transformMeta);
          remarks.add(cr);
        }
      }
    }

    // See if we have input streams leading to this transform!
    if (input.length > 0) {
      cr =
          new CheckResult(
              ICheckResult.TYPE_RESULT_OK,
              BaseMessages.getString(PKG, "SSHMeta.CheckResult.ReceivingInfoFromOtherTransforms"),
              transformMeta);
      remarks.add(cr);
    } else {
      cr =
          new CheckResult(
              ICheckResult.TYPE_RESULT_ERROR,
              BaseMessages.getString(PKG, "SSHMeta.CheckResult.NoInpuReceived"),
              transformMeta);
      remarks.add(cr);
    }
  }

  @Override
  public void getFields(
      IRowMeta row,
      String name,
      IRowMeta[] info,
      TransformMeta nextTransform,
      IVariables variables,
      IHopMetadataProvider metadataProvider)
      throws HopTransformException {

    if (!isDynamicCommand()) {
      row.clear();
    }
    IValueMeta v = new ValueMetaString(variables.resolve(getStdOutFieldName()));
    v.setOrigin(name);
    row.addValueMeta(v);

    String stderrfield = variables.resolve(getStdErrFieldName());
    if (!Utils.isEmpty(stderrfield)) {
      v = new ValueMetaBoolean(stderrfield);
      v.setOrigin(name);
      row.addValueMeta(v);
    }
  }

  @Override
  public ITransform createTransform(
      TransformMeta transformMeta,
      SSHData data,
      int cnr,
      PipelineMeta pipelineMeta,
      Pipeline pipeline) {
    return new SSH(transformMeta, this, data, cnr, pipelineMeta, pipeline);
  }

  @Override
  public SSHData getTransformData() {
    return new SSHData();
  }

  @Override
  public boolean supportsErrorHandling() {
    return true;
  }

  /** Returns the Input/Output metadata for this transform. */
  @Override
  public ITransformIOMeta getTransformIOMeta() {
    return new TransformIOMeta(isDynamicCommand(), true, false, false, false, false);
  }
}