/*
 * 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.validation.Validator;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;

import thredds.util.StringValidateEncodeUtils;

/**
 * Validates the contents of a {@link LocalCatalogRequest} command object.
 * <p/>
 * More details in {@link LocalCatalogServiceController}
 *
 * @author edavis
 * @see LocalCatalogServiceController
 * @see LocalCatalogRequest
 * @since 4.0
 */
public class LocalCatalogRequestValidator implements Validator {

  public LocalCatalogRequestValidator() {
  }

  private boolean htmlView = false;

  public boolean isHtmlView() {
    return htmlView;
  }

  public void setHtmlView(boolean htmlView) {
    this.htmlView = htmlView;
  }

  public boolean supports(Class clazz) {
    return LocalCatalogRequest.class.equals(clazz);
  }

  public void validate(Object obj, Errors e) {
    LocalCatalogRequest rcr = (LocalCatalogRequest) obj;

    // Validate "path"
    String path = rcr.getPath();
    ValidationUtils.rejectIfEmpty(e, "path", "path.empty", "No path given in request.");

    // ToDo move this back into a javax.servlet.Filter
    if (!StringValidateEncodeUtils.validPath(path))
      e.rejectValue("path", "path.notValidPath", "The \"path\" field must be a valid path.");

    if (path != null) {
      if (this.htmlView && !path.endsWith(".html"))
        e.rejectValue("path", "path.notHmlRequest", "The \"path\" [" + path + "] field must end in \".html\".");

      else if (!this.htmlView && !path.endsWith(".xml"))
        e.rejectValue("path", "path.notXmlRequest", "The \"path\" field must end in \".xml\".");
    }

    // Validate "command" - not empty
    ValidationUtils.rejectIfEmpty(e, "command", "command.empty");
    if (rcr.getCommand().equals(Command.VALIDATE))
      e.rejectValue("command", "command.invalidRequest.VALIDATE", "The \"command\" field may not be VALIDATE.");

    // When command.equals( SUBSET),
    // - validate "dataset" - not empty
    if (rcr.getCommand().equals(Command.SUBSET))
      ValidationUtils.rejectIfEmpty(e, "dataset", "dataset.empty", "No dataset specified in SUBSET request.");
  }
}