DataviewController.java

/*
 * Copyright 2019 Global Crop Diversity Trust
 *
 * Licensed 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.gringlobal.api.v1.impl;

import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;

import org.gringlobal.api.exception.NotFoundElement;
import org.gringlobal.api.v1.ApiBaseController;
import org.gringlobal.api.v1.Pagination;
import org.gringlobal.compatibility.service.DataviewService;
import org.gringlobal.model.SysDataview;
import org.gringlobal.service.DataviewServices;
import org.gringlobal.soap.Datatable;
import org.gringlobal.spring.CSVMessageConverter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Lazy;
import org.springframework.data.domain.Pageable;
import org.springframework.http.MediaType;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import org.springdoc.api.annotations.ParameterObject;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;

@RestController("dataviewApi1")
@RequestMapping(DataviewController.API_URL)
@Tag(name = "Dataview")
@PreAuthorize("isAuthenticated()")
public class DataviewController extends ApiBaseController {

	/** The Constant API_URL. */
	public static final String API_URL = ApiBaseController.APIv1_BASE + "/dataview";

	@Autowired
	private DataviewService dataviewService;

	@Autowired
	@Lazy
	private DataviewServices.SysDataviewService sysDataviewService;

	@PreAuthorize("hasRole('GROUP_ADMIN')")
	@PostMapping(value = "/{dataviewName}", produces = { MediaType.APPLICATION_JSON_VALUE, CSVMessageConverter.TEXT_CSV_VALUE })
	@Operation(deprecated = true, description = "Will be removed in 2024.5. Admin only.")
	public Datatable getData(
		@PathVariable(required = true, name = "dataviewName") final String dataviewName,
		@ParameterObject final Pagination page,
		@RequestBody final Map<String, String> parameterList
	) throws Exception {

		var p = page.toPageRequest(MAX_PAGE_SIZE, DEFAULT_PAGE_SIZE);
		return dataviewService.getData(dataviewName, parameterList, (int) p.getOffset(), p.getPageSize(), null);
	}

	@GetMapping("/web-reports")
	public List<SysDataview> getWebReports() {
		return sysDataviewService.list(Pageable.unpaged()).stream()
			.filter(dv -> Objects.equals("Web Reports", dv.getCategoryCode()))
			.sorted(Comparator.comparing(SysDataview::getDataviewName))
			.collect(Collectors.toList());
	}

	@GetMapping("/web-reports/{dataviewName}")
	public SysDataview getWebReport(@PathVariable final String dataviewName) {
		var dataview = sysDataviewService.load(dataviewName);
		if (! Objects.equals("Web Reports", dataview.getCategoryCode())) {
			throw new NotFoundElement("No such Web Report");
		}
		return dataview;
	}

	/**
	 * Get data for "Web Report" dataviews with custom parameters.
	 * 
	 * @since 2024.4
	 * @param dataviewName Name of "Web Report"
	 * @param page Pagination params
	 * @param parameterList List of parameters for this Dataview
	 * @return
	 */
	@PostMapping(value = "/web-reports/{dataviewName}", produces = { MediaType.APPLICATION_JSON_VALUE, CSVMessageConverter.TEXT_CSV_VALUE })
	public Datatable getWebReportData(
		@PathVariable(required = true, name = "dataviewName") String dataviewName,
		@ParameterObject final Pagination page,
		@RequestBody final Map<String, String> parameterList
	) throws Exception {

		var dataview = sysDataviewService.load(dataviewName);
		if (! Objects.equals("Web Reports", dataview.getCategoryCode())) {
			throw new NotFoundElement("No such Web Report");
		}

		var p = page.toPageRequest(MAX_PAGE_SIZE, DEFAULT_PAGE_SIZE);
		return dataviewService.getData(dataviewName, parameterList, (int) p.getOffset(), p.getPageSize(), null);
	}

}