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.user.iso;
  
  import org.apache.cloudstack.api.APICommand;
  import org.apache.cloudstack.api.ApiCommandResourceType;
  import org.apache.cloudstack.api.ApiConstants;
  import org.apache.cloudstack.api.BaseListTaggedResourcesCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.ResponseObject.ResponseView;
  import org.apache.cloudstack.api.command.user.UserCmd;
  import org.apache.cloudstack.api.response.GuestOSCategoryResponse;
  import org.apache.cloudstack.api.response.ListResponse;
  import org.apache.cloudstack.api.response.TemplateResponse;
  import org.apache.cloudstack.api.response.ZoneResponse;
  import org.apache.cloudstack.context.CallContext;
  import org.apache.commons.lang3.StringUtils;
  
  import com.cloud.cpu.CPU;
  import com.cloud.server.ResourceTag;
  import com.cloud.template.VirtualMachineTemplate.TemplateFilter;
  import com.cloud.user.Account;
  
  @APICommand(name = "listIsos", description = "Lists all available ISO files.", responseObject = TemplateResponse.class, responseView = ResponseView.Restricted,
          requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
  public class ListIsosCmd extends BaseListTaggedResourcesCmd implements UserCmd {
  
      private static final String s_name = "listisosresponse";
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.BOOTABLE, type = CommandType.BOOLEAN, description = "true if the ISO is bootable, false otherwise")
      private Boolean bootable;
  
      @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "the hypervisor for which to restrict the search")
      private String hypervisor;
  
      @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "list ISO by ID")
      private Long id;
  
      @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "true if the ISO is publicly available to all users, false otherwise.")
      private Boolean publicIso;
  
      @Parameter(name = ApiConstants.IS_READY, type = CommandType.BOOLEAN, description = "list ISOs that are ready to be deployed")
      private Boolean ready;
  
      @Parameter(name = ApiConstants.ISO_FILTER,
                 type = CommandType.STRING,
                 description = "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". "
                     + "* featured : templates that have been marked as featured and public. "
                     + "* self : templates that have been registered or created by the calling user. "
                     + "* selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. "
                     + "* sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. "
                     + "* executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. "
                     + "* community : templates that have been marked as public but not featured. " + "* all : all templates (only usable by admins).")
      private String isoFilter = TemplateFilter.selfexecutable.toString();
  
      @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list all ISOs by name")
      private String isoName;
  
      @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the ID of the zone")
      private Long zoneId;
  
      @Parameter(name=ApiConstants.SHOW_REMOVED, type=CommandType.BOOLEAN, description="show removed ISOs as well")
      private Boolean showRemoved;
  
      @Parameter(name = ApiConstants.SHOW_UNIQUE, type = CommandType.BOOLEAN, description = "If set to true, list only unique isos across zones", since = "4.13.2")
      private Boolean showUnique;
  
      @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN, description = "flag to display the resource image for the isos")
      private Boolean showIcon;
  
      @Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
              description = "the CPU arch of the ISO. Valid options are: x86_64, aarch64",
              since = "4.20")
      private String arch;
  
      @Parameter(name = ApiConstants.OS_CATEGORY_ID, type = CommandType.UUID, entityType= GuestOSCategoryResponse.class,
              description = "the ID of the OS category for the ISO",
              since = "4.21.0")
      private Long osCategoryId;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Boolean isBootable() {
          return bootable;
      }
  
      public String getHypervisor() {
          return hypervisor;
      }
  
      public Long getId() {
          return id;
      }
  
      public Boolean isPublic() {
          return publicIso;
      }
  
      public Boolean isReady() {
          return ready;
      }
  
      public String getIsoFilter() {
          return isoFilter;
      }
  
      public String getIsoName() {
          return isoName;
      }
  
      public Long getZoneId() {
          return zoneId;
      }
  
      public Boolean getShowRemoved() {
          return showRemoved != null && showRemoved;
      }
  
      public Boolean getShowUnique() {
          return showUnique != null && showUnique;
      }
  
      public Long getImageStoreId() {
          return null;
      }
  
      public Boolean getShowIcon () {
          return  showIcon != null ? showIcon : false;
      }
  
      public boolean listInReadyState() {
          Account account = CallContext.current().getCallingAccount();
          // It is account specific if account is admin type and domainId and accountName are not null
          boolean isAccountSpecific = (account == null || _accountService.isAdmin(account.getId())) && (getAccountName() != null) && (getDomainId() != null);
          // Show only those that are downloaded.
          TemplateFilter templateFilter = TemplateFilter.valueOf(getIsoFilter());
          boolean onlyReady =
              (templateFilter == TemplateFilter.featured) || (templateFilter == TemplateFilter.selfexecutable) || (templateFilter == TemplateFilter.sharedexecutable) ||
                  (templateFilter == TemplateFilter.executable && isAccountSpecific) || (templateFilter == TemplateFilter.community);
  
          if (!onlyReady) {
              if (isReady() != null && isReady().booleanValue() != onlyReady) {
                  onlyReady = isReady().booleanValue();
              }
          }
  
          return onlyReady;
      }
  
      public CPU.CPUArch getArch() {
          if (StringUtils.isBlank(arch)) {
              return null;
          }
          return CPU.CPUArch.fromType(arch);
      }
  
      public Long getOsCategoryId() {
          return osCategoryId;
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public String getCommandName() {
          return s_name;
      }
  
      @Override
      public ApiCommandResourceType getApiResourceType() {
          return ApiCommandResourceType.Iso;
      }
  
      @Override
      public void execute() {
          ListResponse<TemplateResponse> response = _queryService.listIsos(this);
          if (response != null && getShowIcon()) {
              _responseGenerator.updateTemplateIsoResponsesForIcons(response.getResponses(),
                      ResourceTag.ResourceObjectType.ISO);
          }
          response.setResponseName(getCommandName());
          setResponseObject(response);
      }
  
      public Long getStoragePoolId() {
          return null;
      };
  }
  