Fix QuotaSummaryCmd

Author: Julien Hervot de Mattos Vaz

plugins/database/quota/src/main/java/org/apache/cloudstack/api/command/QuotaSummaryCmd.java

@@ -16,17 +16,20 @@
 //under the License.
 package org.apache.cloudstack.api.command;
 
-import com.cloud.user.Account;
 import com.cloud.utils.Pair;
 
+
+import org.apache.cloudstack.api.ACL;
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.BaseListCmd;
 import org.apache.cloudstack.api.Parameter;
+import org.apache.cloudstack.api.response.AccountResponse;
 import org.apache.cloudstack.api.response.DomainResponse;
-import org.apache.cloudstack.api.response.ListResponse;
 import org.apache.cloudstack.api.response.QuotaResponseBuilder;
 import org.apache.cloudstack.api.response.QuotaSummaryResponse;
+import org.apache.cloudstack.api.response.ProjectResponse;
+import org.apache.cloudstack.api.response.ListResponse;
 import org.apache.cloudstack.quota.QuotaAccountStateFilter;
 import org.apache.cloudstack.quota.QuotaService;
 import org.apache.commons.lang3.ObjectUtils;
@@ -41,6 +44,16 @@
         requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
 public class QuotaSummaryCmd extends BaseListCmd {
 
+    @Inject
+    QuotaResponseBuilder quotaResponseBuilder;
+
+    @Inject
+    QuotaService quotaService;
+
+    @ACL
+    @Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "ID of the account for which balance will be listed. Can not be specified with projectId.")
+    private Long accountId;
+
     @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, required = false, description = "Optional, Account Id for which statement needs to be generated")
     private String accountName;
 
@@ -52,15 +65,13 @@ public class QuotaSummaryCmd extends BaseListCmd {
     private Boolean listAll;
 
     @Parameter(name = ApiConstants.ACCOUNT_STATE_TO_SHOW, type = CommandType.STRING, description =  "Possible values are [ALL, ACTIVE, REMOVED]. ALL will list summaries for " +
-            "active and removed accounts; ACTIVE will list summaries only for active accounts; REMOVED will list summaries only for removed accounts. The default value is ACTIVE.”, 
-            since = “4.21.0)
+            "active and removed accounts; ACTIVE will list summaries only for active accounts; REMOVED will list summaries only for removed accounts. The default value is ACTIVE.",
+            since = "4.21.0")
     private String accountStateToShow;
 
-    @Inject
-    QuotaResponseBuilder quotaResponseBuilder;
-
-    @Inject
-    QuotaService quotaService;
+    @ACL
+    @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Project Id for which balance will be listed. Can not be specified with accountId.")
+    private Long projectId;
 
     @Override
     public void execute() {
@@ -72,6 +83,14 @@ public void execute() {
         setResponseObject(response);
     }
 
+    public Long getAccountId() {
+        return accountId;
+    }
+
+    public void setAccountId(Long accountId) {
+        this.accountId = accountId;
+    }
+
     public String getAccountName() {
         return accountName;
     }
@@ -96,6 +115,10 @@ public void setListAll(Boolean listAll) {
         this.listAll = listAll;
     }
 
+    public Long getProjectId() {
+        return projectId;
+    }
+
     public QuotaAccountStateFilter getAccountStateToShow() {
         if (StringUtils.isNotBlank(accountStateToShow)) {
             QuotaAccountStateFilter state = QuotaAccountStateFilter.getValue(accountStateToShow);
@@ -109,7 +132,9 @@ public QuotaAccountStateFilter getAccountStateToShow() {
 
     @Override
     public long getEntityOwnerId() {
-        return Account.ACCOUNT_ID_SYSTEM;
+        if (ObjectUtils.allNull(accountId, accountName, projectId)) {
+            return -1;
+        }
+        return quotaService.finalizeAccountId(accountId, accountName, domainId, projectId);
     }
-
 }

plugins/database/quota/src/main/java/org/apache/cloudstack/api/response/QuotaSummaryResponse.java

@@ -53,11 +53,11 @@ public class QuotaSummaryResponse extends BaseResponse {
     private State state;
 
     @SerializedName("domainremoved")
-    @Param(description = "If the domain is removed or not")
+    @Param(description = "If the domain is removed or not", since = "4.21.0")
     private boolean domainRemoved;
 
     @SerializedName("accountremoved")
-    @Param(description = "If the account is removed or not")
+    @Param(description = "If the account is removed or not", since = "4.21.0")
     private boolean accountRemoved;
 
     @SerializedName("quota")
@@ -81,15 +81,15 @@ public class QuotaSummaryResponse extends BaseResponse {
     private boolean quotaEnabled;
 
     @SerializedName("projectname")
-    @Param(description = "Name of the project")
+    @Param(description = "Name of the project", since = "4.21.0")
     private String projectName;
 
     @SerializedName("projectid")
-    @Param(description = "Project's id")
+    @Param(description = "Project's id", since = "4.21.0")
     private String projectId;
 
     @SerializedName("projectremoved")
-    @Param(description = "Whether the project is removed or not")
+    @Param(description = "Whether the project is removed or not", since = "4.21.0")
     private Boolean projectRemoved;
 
     public String getAccountId() {

plugins/database/quota/src/main/java/org/apache/cloudstack/quota/QuotaService.java

@@ -40,4 +40,6 @@ public interface QuotaService extends PluggableService {
 
     boolean saveQuotaAccount(AccountVO account, BigDecimal aggrUsage, Date endDate);
 
+    Long finalizeAccountId(Long accountId, String accountName, Long domainId, Long projectId);
+
 }

plugins/database/quota/src/main/java/org/apache/cloudstack/quota/QuotaServiceImpl.java

@@ -26,6 +26,12 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
+import com.cloud.projects.Project;
+import com.cloud.projects.ProjectManager;
+import com.cloud.user.AccountService;
+import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.ApiErrorCode;
+import org.apache.cloudstack.api.ServerApiException;
 import org.apache.cloudstack.api.command.QuotaBalanceCmd;
 import org.apache.cloudstack.api.command.QuotaConfigureEmailCmd;
 import org.apache.cloudstack.api.command.QuotaCreditsCmd;
@@ -74,6 +80,8 @@ public class QuotaServiceImpl extends ManagerBase implements QuotaService, Confi
     @Inject
     private AccountDao _accountDao;
     @Inject
+    private AccountService accountService;
+    @Inject
     private QuotaAccountDao _quotaAcc;
     @Inject
     private QuotaUsageDao _quotaUsageDao;
@@ -85,6 +93,8 @@ public class QuotaServiceImpl extends ManagerBase implements QuotaService, Confi
     private QuotaBalanceDao _quotaBalanceDao;
     @Inject
     private QuotaResponseBuilder _respBldr;
+    @Inject
+    private ProjectManager projectMgr;
 
     private TimeZone _usageTimezone;
 
@@ -275,6 +285,48 @@ public boolean saveQuotaAccount(final AccountVO account, final BigDecimal aggrUs
         }
     }
 
+    /**
+     * Returns the Id of the account that will be used when provided with either accountId, projectId or accountName and domainId.
+     */
+    @Override
+    public Long finalizeAccountId(Long accountId, String accountName, Long domainId, Long projectId) {
+        if (projectId != null) {
+            if (accountId != null || accountName != null) {
+                throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Project and account can not be specified together.");
+            }
+            final Project project = projectMgr.getProject(projectId);
+            if (project == null) {
+                throw new ServerApiException(ApiErrorCode.PARAM_ERROR, String.format("Unable to find project with id: [%s].", projectId));
+            }
+            if (project.getState() != Project.State.Active) {
+                throw new ServerApiException(ApiErrorCode.PARAM_ERROR, String.format("Project with projectId [%s] is not active.", projectId));
+            }
+            return project.getProjectAccountId();
+        }
+
+        if (accountId != null) {
+            if (accountService.getActiveAccountById(accountId) != null) {
+                return accountId;
+            }
+            throw new InvalidParameterValueException(String.format("Unable to find account with accountId: [%s].", accountId));
+        }
+
+        if (accountName == null && domainId == null) {
+            throw new ServerApiException(ApiErrorCode.PARAM_ERROR, String.format("Either %s or %s is required.", ApiConstants.ACCOUNT_ID, ApiConstants.PROJECT_ID));
+        }
+        try {
+            Account activeAccount = accountService.getActiveAccountByName(accountName, domainId);
+            if (activeAccount != null) {
+                return activeAccount.getId();
+            }
+        } catch (InvalidParameterValueException exception) {
+            throw new ServerApiException(ApiErrorCode.PARAM_ERROR, String.format("Both %s and %s are needed if using either. Consider using %s instead.",
+                    ApiConstants.ACCOUNT, ApiConstants.DOMAIN_ID, ApiConstants.ACCOUNT_ID));
+        }
+        throw new InvalidParameterValueException(String.format("Unable to find account by name: [%s] on domain: [%s]", accountName, domainId));
+    }
+
+
     @Override
     public void setMinBalance(Long accountId, Double balance) {
         QuotaAccountVO acc = _quotaAcc.findByIdQuotaAccount(accountId);