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.
  package org.apache.cloudstack.api.command.admin.diagnostics;
  
  import java.util.List;
  
  import javax.inject.Inject;
  
  import org.apache.cloudstack.acl.RoleType;
  import org.apache.cloudstack.api.APICommand;
  import org.apache.cloudstack.api.ApiArgValidator;
  import org.apache.cloudstack.api.ApiCommandResourceType;
  import org.apache.cloudstack.api.ApiConstants;
  import org.apache.cloudstack.api.BaseAsyncCmd;
  import org.apache.cloudstack.api.BaseCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.ServerApiException;
  import org.apache.cloudstack.api.response.SystemVmResponse;
  import org.apache.cloudstack.api.response.diagnostics.GetDiagnosticsDataResponse;
  import org.apache.cloudstack.context.CallContext;
  import org.apache.cloudstack.diagnostics.DiagnosticsService;
  import org.apache.commons.lang3.StringUtils;
  import org.apache.commons.validator.routines.UrlValidator;
  
  import com.cloud.event.EventTypes;
  import com.cloud.exception.InsufficientCapacityException;
  import com.cloud.exception.ResourceUnavailableException;
  import com.cloud.user.Account;
  import com.cloud.utils.exception.CloudRuntimeException;
  import com.cloud.vm.VirtualMachine;
  
  @APICommand(name = "getDiagnosticsData",
          responseObject = GetDiagnosticsDataResponse.class,
          entityType = {VirtualMachine.class},
          responseHasSensitiveInfo = false,
          requestHasSensitiveInfo = false,
          description = "Get diagnostics and files from system VMs",
          since = "4.14.0.0",
          authorized = {RoleType.Admin})
  public class GetDiagnosticsDataCmd extends BaseAsyncCmd {
  
      @Inject
      private DiagnosticsService diagnosticsService;
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
      @Parameter(name = ApiConstants.TARGET_ID,
              type = BaseCmd.CommandType.UUID,
              entityType = SystemVmResponse.class,
              required = true,
              validations = {ApiArgValidator.PositiveNumber},
              description = "The ID of the system VM instance to retrieve diagnostics data files from")
      private Long id;
  
      @Parameter(name = ApiConstants.FILES,
              type = BaseCmd.CommandType.LIST,
              collectionType = BaseCmd.CommandType.STRING,
              description = "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.")
      private List<String> filesList;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Long getId() {
          return id;
      }
  
      public List<String> getFilesList() {
          return filesList;
      }
  
      /////////////////////////////////////////////////////
      /////////////////// Implementation //////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public long getEntityOwnerId() {
          Account account = CallContext.current().getCallingAccount();
          if (account != null) {
              return account.getId();
          }
          return Account.ACCOUNT_ID_SYSTEM;
      }
  
      @Override
      public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException {
          try {
              String downloadUrl = diagnosticsService.getDiagnosticsDataCommand(this);
              UrlValidator urlValidator = new UrlValidator();
              if (StringUtils.isEmpty(downloadUrl)) {
                  throw new CloudRuntimeException("Failed to retrieve diagnostics files");
              }
              GetDiagnosticsDataResponse response = new GetDiagnosticsDataResponse();
              if (urlValidator.isValid(downloadUrl)){
                  response.setUrl(downloadUrl);
                  response.setObjectName("diagnostics");
                  response.setResponseName(getCommandName());
                  this.setResponseObject(response);
              } else {
                  throw new CloudRuntimeException("failed to generate valid download url: " + downloadUrl);
              }
          } catch (ServerApiException e) {
              throw new CloudRuntimeException("Internal exception caught while retrieving diagnostics files: ", e);
          }
      }
  
      @Override
      public String getEventType() {
          VirtualMachine.Type vmType = _entityMgr.findById(VirtualMachine.class, getId()).getType();
          String eventType = "";
          switch (vmType) {
              case ConsoleProxy:
                  eventType = EventTypes.EVENT_PROXY_DIAGNOSTICS;
                  break;
              case SecondaryStorageVm:
                  eventType = EventTypes.EVENT_SSVM_DIAGNOSTICS;
                  break;
              case DomainRouter:
                  eventType = EventTypes.EVENT_ROUTER_DIAGNOSTICS;
                  break;
          }
          return eventType;
      }
  
      @Override
      public String getEventDescription() {
          return "Getting diagnostics data files from system vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
      }
  
      @Override
      public Long getApiResourceId() {
          return getId();
      }
  
      @Override
      public ApiCommandResourceType getApiResourceType() {
  
          VirtualMachine.Type vmType = _entityMgr.findById(VirtualMachine.class, getId()).getType();
          switch (vmType) {
              case ConsoleProxy:
                  return ApiCommandResourceType.ConsoleProxy;
              case SecondaryStorageVm:
                  return ApiCommandResourceType.SystemVm;
              case DomainRouter:
                  return ApiCommandResourceType.DomainRouter;
          }
          return null;
      }
  }
  