/*
* Copyright 1998-2014 University Corporation for Atmospheric Research/Unidata
*
* Portions of this software were developed by the Unidata Program at the
* University Corporation for Atmospheric Research.
*
* Access and use of this software shall impose the following obligations
* and understandings on the user. The user is granted the right, without
* any fee or cost, to use, copy, modify, alter, enhance and distribute
* this software, and any derivative works thereof, and its supporting
* documentation for any purpose whatsoever, provided that this entire
* notice appears in all copies of the software, derivative works and
* supporting documentation. Further, UCAR requests that the user credit
* UCAR/Unidata in any publications that result from the use of this
* software or in any product that includes this software. The names UCAR
* and/or Unidata, however, may not be used in any advertising or publicity
* to endorse or promote any products or commercial entity unless specific
* written permission is obtained from UCAR/Unidata. The user also
* understands that UCAR/Unidata is not obligated to provide the user with
* any support, consulting, training or assistance of any kind with regard
* to the use, operation and performance of this software nor to provide
* the user with any updates, revisions, new versions or "bug fixes."
*
* THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package thredds.server.catalogservice;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.util.HtmlUtils;
import thredds.catalog.util.DeepCopyUtils;
import thredds.servlet.HtmlWriter;
import thredds.servlet.ThreddsConfig;
import thredds.server.config.TdsContext;
import thredds.server.config.HtmlConfig;
import thredds.catalog.*;
import java.util.List;
import java.util.Map;
import java.util.HashMap;
import java.net.URI;
import java.io.IOException;
/**
* Handle all requests for catalog services on remote catalogs. Supported
* services are:
* <ol>
* <li>catalog validation,</li>
* <li>catalog subsetting, and</li>
* <li>HTML views of catalogs (full or subset) and datasets.</li>
* <p/>
* <p/>
* Currently, handles the following TDS requests:
* <ul>
* <li>Mapping="/remoteCatalogService"</li>
* </ul>
* <p/>
* <p> NOTE: Only supported if CatalogServices/allowRemote is set to "true" in threddsConfig.xml.
* <p/>
* <p> Uses the following information from an HTTP request:
* <ul>
* <li>The "catalog" parameter gives the URI of a remote catalog.</li>
* <li>The "command" parameter must either be empty or have one of the
* following values: "SHOW", "SUBSET", or "VALIDATE", see
* {@link Command}.</li>
* <li>The "dataset" parameter identifies a dataset contained by the
* local catalog. [Used only in "SUBSET" requests.]</li>
* <li>The "htmlView" parameter indicates if an HTML or XML view is
* desired. [Used only in "SUBSET" requests.]</li>
* <li>The "verbose" parameter indicates if the output of a "VALIDATE"
* request should be verbose ("true") or not ("false" or not given).</li>
* </ul>
* <p/>
* <p>Constraints on the above information:
* <ul>
* <li>The catalog URI must be absolute and is expected to reference a
* THREDDS catalog XML document.</li>
* <li>The "dataset" parameter must either be empty or contain the value
* of a dataset ID contained in the catalog.</li>
* <li>If the "command" parameter is empty, it will default to "SHOW" if
* the "dataset" parameter is empty, otherwise it will default to "SUBSET".</li>
* </ul>
* <p/>
* <p>The above information is contained in a {@link RemoteCatalogRequest}
* command object, default values are set during binding by
* {@link RemoteCatalogRequestDataBinder}, and constraints are enforced by
* {@link RemoteCatalogRequestValidator}.
*
* @author edavis
* @see thredds.util.TdsPathUtils#extractPath(HttpServletRequest req, String removePrefix)
* @see Command
* @see RemoteCatalogRequest
* @see RemoteCatalogRequestDataBinder
* @see RemoteCatalogRequestValidator
* @since 4.0
*/
@Component
@RequestMapping(value = {"/remoteCatalogService", "/remoteCatalogValidation.html"})
public class RemoteCatalogServiceController {
private org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(getClass());
@Autowired
private TdsContext tdsContext;
@Autowired
private HtmlWriter htmlWriter;
@RequestMapping("**")
protected ModelAndView handleAll(HttpServletRequest request, HttpServletResponse response) throws Exception {
HtmlConfig htmlConfig = this.tdsContext.getHtmlConfig();
try {
// Send error response if remote catalog service requests are not allowed.
// ToDo Look - Move this into TdsConfig?
boolean allowRemote = ThreddsConfig.getBoolean("CatalogServices.allowRemote", false);
if (!allowRemote) {
response.sendError(HttpServletResponse.SC_FORBIDDEN, "Catalog services not supported for remote catalogs.");
return null;
}
//
if (request.getServletPath().equals("/remoteCatalogValidation.html")) {
Map<String, Object> model = new HashMap<>();
htmlConfig.addHtmlConfigInfoToModel(model);
return new ModelAndView("/thredds/server/catalogservice/validationForm", model);
}
// Bind HTTP request to a LocalCatalogRequest.
BindingResult bindingResult = CatalogServiceUtils.bindAndValidateRemoteCatalogRequest(request);
// If any binding or validation errors, return BAD_REQUEST.
if (bindingResult.hasErrors()) {
StringBuilder msg = new StringBuilder("Bad request");
List<ObjectError> oeList = bindingResult.getAllErrors();
for (ObjectError e : oeList)
msg.append(": ").append(e.getDefaultMessage() != null ? e.getDefaultMessage() : e.toString());
log.info("handleRequestInternal(): " + msg);
response.sendError(HttpServletResponse.SC_BAD_REQUEST, msg.toString());
return null;
}
// Retrieve the resulting RemoteCatalogRequest.
RemoteCatalogRequest catalogServiceRequest = (RemoteCatalogRequest) bindingResult.getTarget();
// Determine path and catalogPath
URI uri = catalogServiceRequest.getCatalogUri();
// Check for matching catalog.
InvCatalogImpl catalog;
InvCatalogFactory fac = InvCatalogFactory.getDefaultFactory(true);
try {
catalog = fac.readXML(uri);
} catch (Throwable t) {
String msg = "Error reading catalog [" + uri + "]: " + t.getMessage();
log.error("handleRequestInternal(): " + msg);
response.sendError(HttpServletResponse.SC_BAD_REQUEST, msg);
return null;
}
// Check whether a catalog was found.
if (catalog == null) {
String msg = "Failed to read catalog [" + uri + "].";
log.error("handleRequestInternal(): " + msg);
response.sendError(HttpServletResponse.SC_BAD_REQUEST, msg);
return null;
}
// Check catalog validity.
StringBuilder validateMess = new StringBuilder();
// boolean verbose = catalogServiceRequest.isVerbose();
catalog.check(validateMess, false);
if (catalog.hasFatalError()) {
// ToDo LOOK - This "Validate" header was in CatalogServicesServlet so added here. Do we need it?
response.setHeader("Validate", "FAIL");
return CatalogServiceUtils.constructValidationErrorModelAndView(uri, validateMess.toString(), htmlConfig);
}
// ToDo LOOK - This "Validate" header was in CatalogServicesServlet so added here. Do we need it?
response.setHeader("Validate", "OK");
///////////////////////////////////////////
// Otherwise, handle catalog as indicated by "command".
if (catalogServiceRequest.getCommand().equals(Command.SHOW)) {
this.htmlWriter.writeCatalog(request, response, catalog, false);
return null;
} else if (catalogServiceRequest.getCommand().equals(Command.SUBSET)) {
String datasetId = catalogServiceRequest.getDataset();
InvDataset dataset = catalog.findDatasetByID(datasetId);
if (dataset == null) {
String msg = "Did not find dataset [" + HtmlUtils.htmlEscape(datasetId) + "] in catalog [" + uri + "].";
log.info("handleRequestInternal(): " + msg);
response.sendError(HttpServletResponse.SC_BAD_REQUEST, msg);
return null;
}
if (catalogServiceRequest.isHtmlView()) {
this.htmlWriter.showDataset(uri.toString(), (InvDatasetImpl) dataset, request, response, false);
return null;
} else {
InvCatalog subsetCat = DeepCopyUtils.subsetCatalogOnDataset(catalog, dataset);
return new ModelAndView("threddsInvCatXmlView", "catalog", subsetCat);
}
} else if (catalogServiceRequest.getCommand().equals(Command.VALIDATE)) {
return CatalogServiceUtils.constructValidationMessageModelAndView(uri, validateMess.toString(), htmlConfig);
} else {
String msg = "Unsupported request command [" + catalogServiceRequest.getCommand() + "].";
log.error("handleRequestInternal(): " + msg + " -- NOTE: Should have been caught on input validation.");
response.sendError(HttpServletResponse.SC_BAD_REQUEST, msg);
return null;
}
} catch (IOException e) {
log.error("handleRequestInternal(): Trouble writing to response.", e);
return null;
} catch (Throwable e) {
log.error("handleRequestInternal(): Problem handling request.", e);
if (!response.isCommitted()) response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
return null;
}
}
}