content: // 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.
  //
  // Automatically generated by addcopyright.py at 01/29/2013
  // Apache License, Version 2.0 (the "License"); you may not use this
  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  //
  // Automatically generated by addcopyright.py at 04/03/2012
  package com.cloud.baremetal.networkservice;
  
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import javax.naming.ConfigurationException;
  
  import org.apache.commons.lang3.StringUtils;
  
  import com.trilead.ssh2.SCPClient;
  
  import com.cloud.agent.api.Answer;
  import com.cloud.agent.api.Command;
  import com.cloud.agent.api.HostVmStateReportEntry;
  import com.cloud.agent.api.PingCommand;
  import com.cloud.agent.api.PingRoutingCommand;
  import com.cloud.agent.api.baremetal.PreparePxeServerAnswer;
  import com.cloud.agent.api.baremetal.PreparePxeServerCommand;
  import com.cloud.agent.api.baremetal.PrepareCreateTemplateCommand;
  import com.cloud.agent.api.routing.VmDataCommand;
  import com.cloud.utils.script.Script;
  import com.cloud.utils.ssh.SSHCmdHelper;
  
  public class BaremetalPingPxeResource extends BaremetalPxeResourceBase {
      private static final String Name = "BaremetalPingPxeResource";
      String _storageServer;
      String _pingDir;
      String _share;
      String _dir;
      String _tftpDir;
      String _cifsUserName;
      String _cifsPassword;
  
      @Override
      public boolean configure(String name, Map<String, Object> params) throws ConfigurationException {
          super.configure(name, params);
          _storageServer = (String)params.get(BaremetalPxeService.PXE_PARAM_PING_STORAGE_SERVER_IP);
          _pingDir = (String)params.get(BaremetalPxeService.PXE_PARAM_PING_ROOT_DIR);
          _tftpDir = (String)params.get(BaremetalPxeService.PXE_PARAM_TFTP_DIR);
          _cifsUserName = (String)params.get(BaremetalPxeService.PXE_PARAM_PING_STORAGE_SERVER_USERNAME);
          _cifsPassword = (String)params.get(BaremetalPxeService.PXE_PARAM_PING_STORAGE_SERVER_PASSWORD);
  
          if (_podId == null) {
              throw new ConfigurationException("No Pod specified");
          }
  
          if (_storageServer == null) {
              throw new ConfigurationException("No storage server specified");
          }
  
          if (_tftpDir == null) {
              throw new ConfigurationException("No tftp directory specified");
          }
  
          if (_pingDir == null) {
              throw new ConfigurationException("No PING directory specified");
          }
  
          if (_cifsUserName == null || _cifsUserName.equalsIgnoreCase("")) {
              _cifsUserName = "xxx";
          }
  
          if (_cifsPassword == null || _cifsPassword.equalsIgnoreCase("")) {
              _cifsPassword = "xxx";
          }
  
          String pingDirs[] = _pingDir.split("/");
          if (pingDirs.length != 2) {
              throw new ConfigurationException("PING dir should have format like myshare/direcotry, eg: windows/64bit");
          }
          _share = pingDirs[0];
          _dir = pingDirs[1];
  
          com.trilead.ssh2.Connection sshConnection = new com.trilead.ssh2.Connection(_ip, 22);
  
          logger.debug(String.format("Trying to connect to PING PXE server(IP=%1$s, username=%2$s, password=%3$s", _ip, _username, "******"));
          try {
              sshConnection.connect(null, 60000, 60000);
              if (!sshConnection.authenticateWithPassword(_username, _password)) {
                  logger.debug("SSH Failed to authenticate");
                  throw new ConfigurationException(String.format("Cannot connect to PING PXE server(IP=%1$s, username=%2$s, password=%3$s", _ip, _username, "******"));
              }
  
              String cmd = String.format("[ -f /%1$s/pxelinux.0 ] && [ -f /%2$s/kernel ] && [ -f /%3$s/initrd.gz ] ", _tftpDir, _tftpDir, _tftpDir);
              if (!SSHCmdHelper.sshExecuteCmd(sshConnection, cmd)) {
                  throw new ConfigurationException("Miss files in TFTP directory at " + _tftpDir + " check if pxelinux.0, kernel initrd.gz are here");
              }
  
              SCPClient scp = new SCPClient(sshConnection);
              String prepareScript = "scripts/network/ping/prepare_tftp_bootfile.py";
              String prepareScriptPath = Script.findScript("", prepareScript);
              if (prepareScriptPath == null) {
                  throw new ConfigurationException("Can not find prepare_tftp_bootfile.py at " + prepareScriptPath);
              }
              scp.put(prepareScriptPath, "/usr/bin/", "0755");
  
              String userDataScript = "scripts/network/ping/baremetal_user_data.py";
              String userDataScriptPath = Script.findScript("", userDataScript);
              if (userDataScriptPath == null) {
                  throw new ConfigurationException("Can not find baremetal_user_data.py at " + userDataScriptPath);
              }
              scp.put(userDataScriptPath, "/usr/bin/", "0755");
  
              return true;
          } catch (Exception e) {
              throw new ConfigurationException(e.getMessage());
          } finally {
              if (sshConnection != null) {
                  sshConnection.close();
              }
          }
      }
  
      @Override
      public PingCommand getCurrentStatus(long id) {
          com.trilead.ssh2.Connection sshConnection = SSHCmdHelper.acquireAuthorizedConnection(_ip, _username, _password);
          if (sshConnection == null) {
              return null;
          } else {
              SSHCmdHelper.releaseSshConnection(sshConnection);
              return new PingRoutingCommand(getType(), id, new HashMap<String, HostVmStateReportEntry>());
          }
      }
  
      protected PreparePxeServerAnswer execute(PreparePxeServerCommand cmd) {
          com.trilead.ssh2.Connection sshConnection = new com.trilead.ssh2.Connection(_ip, 22);
          try {
              sshConnection.connect(null, 60000, 60000);
              if (!sshConnection.authenticateWithPassword(_username, _password)) {
                  logger.debug("SSH Failed to authenticate");
                  throw new ConfigurationException(String.format("Cannot connect to PING PXE server(IP=%1$s, username=%2$s, password=%3$s", _ip, _username, _password));
              }
  
              String script =
                  String.format("python /usr/bin/prepare_tftp_bootfile.py restore %1$s %2$s %3$s %4$s %5$s %6$s %7$s %8$s %9$s %10$s %11$s", _tftpDir, cmd.getMac(),
                      _storageServer, _share, _dir, cmd.getTemplate(), _cifsUserName, _cifsPassword, cmd.getIp(), cmd.getNetMask(), cmd.getGateWay());
              if (!SSHCmdHelper.sshExecuteCmd(sshConnection, script)) {
                  return new PreparePxeServerAnswer(cmd, "prepare PING at " + _ip + " failed, command:" + script);
              }
              logger.debug("Prepare Ping PXE server successfully");
  
              return new PreparePxeServerAnswer(cmd);
          } catch (Exception e) {
              logger.debug("Prepare PING pxe server failed", e);
              return new PreparePxeServerAnswer(cmd, e.getMessage());
          } finally {
              if (sshConnection != null) {
                  sshConnection.close();
              }
          }
      }
  
      protected Answer execute(PrepareCreateTemplateCommand cmd) {
          com.trilead.ssh2.Connection sshConnection = new com.trilead.ssh2.Connection(_ip, 22);
          try {
              sshConnection.connect(null, 60000, 60000);
              if (!sshConnection.authenticateWithPassword(_username, _password)) {
                  logger.debug("SSH Failed to authenticate");
                  throw new ConfigurationException(String.format("Cannot connect to PING PXE server(IP=%1$s, username=%2$s, password=%3$s", _ip, _username, _password));
              }
  
              String script =
                  String.format("python /usr/bin/prepare_tftp_bootfile.py backup %1$s %2$s %3$s %4$s %5$s %6$s %7$s %8$s %9$s %10$s %11$s", _tftpDir, cmd.getMac(),
                      _storageServer, _share, _dir, cmd.getTemplate(), _cifsUserName, _cifsPassword, cmd.getIp(), cmd.getNetMask(), cmd.getGateWay());
              if (!SSHCmdHelper.sshExecuteCmd(sshConnection, script)) {
                  return new Answer(cmd, false, "prepare for creating template failed, command:" + script);
              }
              logger.debug("Prepare for creating template successfully");
  
              return new Answer(cmd, true, "Success");
          } catch (Exception e) {
              logger.debug("Prepare for creating baremetal template failed", e);
              return new Answer(cmd, false, e.getMessage());
          } finally {
              if (sshConnection != null) {
                  sshConnection.close();
              }
          }
      }
  
      @Override
      public Answer executeRequest(Command cmd) {
          if (cmd instanceof PreparePxeServerCommand) {
              return execute((PreparePxeServerCommand)cmd);
          } else if (cmd instanceof PrepareCreateTemplateCommand) {
              return execute((PrepareCreateTemplateCommand)cmd);
          } else if (cmd instanceof VmDataCommand) {
              return execute((VmDataCommand)cmd);
          } else {
              return super.executeRequest(cmd);
          }
      }
  
      private Answer execute(VmDataCommand cmd) {
          com.trilead.ssh2.Connection sshConnection = new com.trilead.ssh2.Connection(_ip, 22);
          try {
              List<String[]> vmData = cmd.getVmData();
              StringBuilder sb = new StringBuilder();
              for (String[] data : vmData) {
                  String folder = data[0];
                  String file = data[1];
                  String contents = (data[2] == null) ? "none" : data[2];
                  sb.append(cmd.getVmIpAddress());
                  sb.append(",");
                  sb.append(folder);
                  sb.append(",");
                  sb.append(file);
                  sb.append(",");
                  sb.append(contents);
                  sb.append(";");
              }
              String arg = StringUtils.stripEnd(sb.toString(), ";");
  
              sshConnection.connect(null, 60000, 60000);
              if (!sshConnection.authenticateWithPassword(_username, _password)) {
                  logger.debug("SSH Failed to authenticate");
                  throw new ConfigurationException(String.format("Cannot connect to PING PXE server(IP=%1$s, username=%2$s, password=%3$s", _ip, _username, _password));
              }
  
              String script = String.format("python /usr/bin/baremetal_user_data.py '%s'", arg);
              if (!SSHCmdHelper.sshExecuteCmd(sshConnection, script)) {
                  return new Answer(cmd, false, "Failed to add user data, command:" + script);
              }
  
              return new Answer(cmd, true, "Success");
          } catch (Exception e) {
              logger.debug("Prepare for creating baremetal template failed", e);
              return new Answer(cmd, false, e.getMessage());
          } finally {
              if (sshConnection != null) {
                  sshConnection.close();
              }
          }
      }
  }
  