Removed string concatenated SQL & sqlSearch from Staff (Fineract-854)

This commit is contained in:
Manthan Surkar
2020-09-06 03:50:25 +03:00
committed by Petri Tuomola
parent dc092d7e18
commit e74204e740
4 changed files with 30 additions and 43 deletions
@@ -281,7 +281,7 @@ public class BulkImportWorkbookPopulatorServiceImpl implements BulkImportWorkboo
private List<StaffData> fetchStaff(final Long staffId) { private List<StaffData> fetchStaff(final Long staffId) {
List<StaffData> staff = null; List<StaffData> staff = null;
if (staffId == null) { if (staffId == null) {
staff = (List) this.staffReadPlatformService.retrieveAllStaff(null, null, Boolean.FALSE, null); staff = (List) this.staffReadPlatformService.retrieveAllStaff(null, Boolean.FALSE, null);
} else { } else {
staff = new ArrayList<>(); staff = new ArrayList<>();
staff.add(this.staffReadPlatformService.retrieveStaff(staffId)); staff.add(this.staffReadPlatformService.retrieveStaff(staffId));
@@ -118,7 +118,6 @@ public class StaffApiResource {
@ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = StaffApiResourceSwagger.GetStaffResponse.class)))), @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = StaffApiResourceSwagger.GetStaffResponse.class)))),
@ApiResponse(responseCode = "200", description = "GET https://DomainName/api/v1/staff?status={ACTIVE|INACTIVE|ALL}", content = @Content(schema = @Schema(implementation = StaffApiResourceSwagger.GetStaffResponse.class))) }) @ApiResponse(responseCode = "200", description = "GET https://DomainName/api/v1/staff?status={ACTIVE|INACTIVE|ALL}", content = @Content(schema = @Schema(implementation = StaffApiResourceSwagger.GetStaffResponse.class))) })
public String retrieveStaff(@Context final UriInfo uriInfo, public String retrieveStaff(@Context final UriInfo uriInfo,
@QueryParam("sqlSearch") @Parameter(description = "sqlSearch") final String sqlSearch,
@QueryParam("officeId") @Parameter(description = "officeId") final Long officeId, @QueryParam("officeId") @Parameter(description = "officeId") final Long officeId,
@DefaultValue("false") @QueryParam("staffInOfficeHierarchy") @Parameter(description = "staffInOfficeHierarchy") final boolean staffInOfficeHierarchy, @DefaultValue("false") @QueryParam("staffInOfficeHierarchy") @Parameter(description = "staffInOfficeHierarchy") final boolean staffInOfficeHierarchy,
@DefaultValue("false") @QueryParam("loanOfficersOnly") @Parameter(description = "loanOfficersOnly") final boolean loanOfficersOnly, @DefaultValue("false") @QueryParam("loanOfficersOnly") @Parameter(description = "loanOfficersOnly") final boolean loanOfficersOnly,
@@ -130,7 +129,7 @@ public class StaffApiResource {
if (staffInOfficeHierarchy) { if (staffInOfficeHierarchy) {
staff = this.readPlatformService.retrieveAllStaffInOfficeAndItsParentOfficeHierarchy(officeId, loanOfficersOnly); staff = this.readPlatformService.retrieveAllStaffInOfficeAndItsParentOfficeHierarchy(officeId, loanOfficersOnly);
} else { } else {
staff = this.readPlatformService.retrieveAllStaff(sqlSearch, officeId, loanOfficersOnly, status); staff = this.readPlatformService.retrieveAllStaff(officeId, loanOfficersOnly, status);
} }
final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters()); final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
@@ -34,7 +34,7 @@ public interface StaffReadPlatformService {
*/ */
Collection<StaffData> retrieveAllStaffInOfficeAndItsParentOfficeHierarchy(Long officeId, boolean loanOfficersOnly); Collection<StaffData> retrieveAllStaffInOfficeAndItsParentOfficeHierarchy(Long officeId, boolean loanOfficersOnly);
Collection<StaffData> retrieveAllStaff(String sqlSearch, Long officeId, boolean loanOfficersOnly, String status); Collection<StaffData> retrieveAllStaff(Long officeId, boolean loanOfficersOnly, String status);
Object[] hasAssociatedItems(Long staffId); Object[] hasAssociatedItems(Long staffId);
} }
@@ -24,12 +24,12 @@ import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.apache.commons.lang3.StringUtils;
import org.apache.fineract.infrastructure.core.domain.JdbcSupport; import org.apache.fineract.infrastructure.core.domain.JdbcSupport;
import org.apache.fineract.infrastructure.core.exception.UnrecognizedQueryParamException; import org.apache.fineract.infrastructure.core.exception.UnrecognizedQueryParamException;
import org.apache.fineract.infrastructure.core.service.RoutingDataSource; import org.apache.fineract.infrastructure.core.service.RoutingDataSource;
import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext; import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
import org.apache.fineract.infrastructure.security.utils.ColumnValidator; import org.apache.fineract.infrastructure.security.utils.ColumnValidator;
import org.apache.fineract.infrastructure.security.utils.SQLBuilder;
import org.apache.fineract.organisation.staff.data.StaffData; import org.apache.fineract.organisation.staff.data.StaffData;
import org.apache.fineract.organisation.staff.exception.StaffNotFoundException; import org.apache.fineract.organisation.staff.exception.StaffNotFoundException;
import org.apache.fineract.portfolio.client.domain.ClientStatus; import org.apache.fineract.portfolio.client.domain.ClientStatus;
@@ -159,7 +159,10 @@ public class StaffReadPlatformServiceImpl implements StaffReadPlatformService {
@Override @Override
public Collection<StaffData> retrieveAllLoanOfficersInOfficeById(final Long officeId) { public Collection<StaffData> retrieveAllLoanOfficersInOfficeById(final Long officeId) {
return retrieveAllStaff(" office_id = ? and is_loan_officer=1 and o.hierarchy like ?", officeId); SQLBuilder extraCriteria = new SQLBuilder();
extraCriteria.addCriteria(" office_id = ", officeId);
extraCriteria.addCriteria(" is_loan_officer= = ", 1);
return retrieveAllStaff(extraCriteria);
} }
@Override @Override
@@ -204,67 +207,52 @@ public class StaffReadPlatformServiceImpl implements StaffReadPlatformService {
} }
@Override @Override
public Collection<StaffData> retrieveAllStaff(final String sqlSearch, final Long officeId, final boolean loanOfficersOnly, public Collection<StaffData> retrieveAllStaff(final Long officeId, final boolean loanOfficersOnly, final String status) {
final String status) { final SQLBuilder extraCriteria = getStaffCriteria(officeId, loanOfficersOnly, status);
final String extraCriteria = getStaffCriteria(sqlSearch, officeId, loanOfficersOnly, status); return retrieveAllStaff(extraCriteria);
return retrieveAllStaff(extraCriteria, officeId);
} }
private Collection<StaffData> retrieveAllStaff(final String extraCriteria, Long officeId) { private Collection<StaffData> retrieveAllStaff(final SQLBuilder extraCriteria) {
final StaffMapper rm = new StaffMapper(); final StaffMapper rm = new StaffMapper();
String sql = "select " + rm.schema(); String sql = "select " + rm.schema();
final String hierarchy = this.context.authenticatedUser().getOffice().getHierarchy() + "%"; final String hierarchy = this.context.authenticatedUser().getOffice().getHierarchy() + "%";
if (StringUtils.isNotBlank(extraCriteria)) { // adding the Authorization criteria so that a user cannot see an
sql += " where " + extraCriteria; // employee who does not belong to his office or a sub office for his
} // office.
sql = sql + " order by s.lastname"; extraCriteria.addCriteria(" o.hierarchy like ", hierarchy);
if (officeId == null) {
return this.jdbcTemplate.query(sql, rm, new Object[] { hierarchy }); sql += " " + extraCriteria.getSQLTemplate();
} sql = sql + " order by s.lastname ";
return this.jdbcTemplate.query(sql, rm, new Object[] { officeId, hierarchy });
return this.jdbcTemplate.query(sql, rm, extraCriteria.getArguments());
} }
private String getStaffCriteria(final String sqlSearch, final Long officeId, final boolean loanOfficersOnly, final String status) { private SQLBuilder getStaffCriteria(final Long officeId, final boolean loanOfficersOnly, final String status) {
final StringBuilder extraCriteria = new StringBuilder(200); final SQLBuilder extraCriteria = new SQLBuilder();
extraCriteria.addNonNullCriteria(" s.office_id = ", officeId);
if (sqlSearch != null) {
extraCriteria.append(" and (").append(sqlSearch).append(")");
final StaffMapper rm = new StaffMapper();
this.columnValidator.validateSqlInjection(rm.schema(), sqlSearch);
}
if (officeId != null) {
extraCriteria.append(" and s.office_id = ? ");
}
if (loanOfficersOnly) { if (loanOfficersOnly) {
extraCriteria.append(" and s.is_loan_officer is true "); extraCriteria.addCriteria(" s.is_loan_officer is ", " true ");
} }
// Passing status parameter to get ACTIVE (By Default), INACTIVE or ALL // Passing status parameter to get ACTIVE (By Default), INACTIVE or ALL
// (Both active and Inactive) employees // (Both active and Inactive) employees
if (status != null) { if (status != null) {
if (status.equalsIgnoreCase("active")) { if (status.equalsIgnoreCase("active")) {
extraCriteria.append(" and s.is_active = 1 "); extraCriteria.addCriteria(" s.is_active =", 1);
} else if (status.equalsIgnoreCase("inActive")) { } else if (status.equalsIgnoreCase("inActive")) {
extraCriteria.append(" and s.is_active = 0 "); extraCriteria.addCriteria(" s.is_active =", 0);
} else { } else {
if (!status.equalsIgnoreCase("all")) { if (!status.equalsIgnoreCase("all")) {
throw new UnrecognizedQueryParamException("status", status, new Object[] { "all", "active", "inactive" }); throw new UnrecognizedQueryParamException("status", status, new Object[] { "all", "active", "inactive" });
} }
} }
} }
// adding the Authorization criteria so that a user cannot see an
// employee who does not belong to his office or a sub office for his
// office.
extraCriteria.append(" and o.hierarchy like ? "); return extraCriteria;
if (StringUtils.isNotBlank(extraCriteria.toString())) {
extraCriteria.delete(0, 4);
}
// remove begin four letter including a space from the string.
return extraCriteria.toString();
} }
@Override @Override