/*
    * Copyright 2012-2025 CodeLibs Project and the Others.
    *
    * 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.codelibs.fess.app.web.base;
  
  import static org.codelibs.core.stream.StreamUtil.stream;
  
  import java.util.HashMap;
  import java.util.Locale;
  import java.util.Map;
  
  import org.codelibs.core.lang.StringUtil;
  import org.codelibs.fess.entity.FacetInfo;
  import org.codelibs.fess.entity.GeoInfo;
  import org.codelibs.fess.entity.HighlightInfo;
  import org.codelibs.fess.entity.SearchRequestParams;
  import org.codelibs.fess.mylasta.direction.FessConfig;
  import org.codelibs.fess.util.ComponentUtil;
  import org.lastaflute.web.util.LaRequestUtil;
  import org.lastaflute.web.validation.theme.conversion.ValidateTypeFailure;
  
  import jakarta.validation.constraints.Size;
  
  /**
   * Base search form class that extends SearchRequestParams.
   * Provides form fields and methods for handling search requests in the web interface.
   * Contains validation constraints and convenience methods for parameter processing.
   */
  public class SearchForm extends SearchRequestParams {
  
      /**
       * Map of additional search fields with their values.
       */
      public Map<String, String[]> fields = new HashMap<>();
  
      /**
       * Map of advanced search conditions.
       */
      public Map<String, String[]> as = new HashMap<>();
  
      /**
       * The main search query string.
       */
      @Size(max = 1000)
      public String q;
  
      /**
       * The sort parameter for search results.
       */
      @Size(max = 1000)
      public String sort;
  
      /**
       * The number of search results to return per page.
       */
      @ValidateTypeFailure
      public Integer num;
  
      /**
       * Array of language codes to filter search results.
       */
      public String[] lang;
  
      /**
       * Array of additional query strings to exclude from search.
       */
      public String[] ex_q;
  
      /**
       * The starting position for search results pagination.
       */
      @ValidateTypeFailure
      public Integer start;
  
      /**
       * The offset for search results.
       */
      @ValidateTypeFailure
      public Integer offset;
  
      /**
       * The page number for pagination.
       */
      @ValidateTypeFailure
      public Integer pn;
  
      /**
      * Similar document hash for finding related documents.
      */
     @Size(max = 1000)
     public String sdh;
 
     /**
      * Parameter to control tracking of total hits in search results.
      */
     @Size(max = 100)
     public String track_total_hits;
 
     /**
      * Default constructor for SearchForm.
      */
     public SearchForm() {
         super();
     }
 
     // advance
 
     @Override
     public int getStartPosition() {
         if (start == null) {
             start = ComponentUtil.getFessConfig().getPagingSearchPageStartAsInteger();
         }
         return start;
     }
 
     @Override
     public int getOffset() {
         if (offset == null) {
             offset = 0;
         }
         return offset;
     }
 
     @Override
     public int getPageSize() {
         final FessConfig fessConfig = ComponentUtil.getFessConfig();
         if (num == null) {
             num = fessConfig.getPagingSearchPageSizeAsInteger();
         } else {
             try {
                 if (num.intValue() > fessConfig.getPagingSearchPageMaxSizeAsInteger().intValue() || num.intValue() <= 0) {
                     num = fessConfig.getPagingSearchPageMaxSizeAsInteger();
                 }
             } catch (final NumberFormatException e) {
                 num = fessConfig.getPagingSearchPageSizeAsInteger();
             }
         }
         return num;
     }
 
     @Override
     public String getQuery() {
         return q;
     }
 
     @Override
     public String[] getExtraQueries() {
         return stream(ex_q).get(stream -> stream.filter(StringUtil::isNotBlank).distinct().toArray(n -> new String[n]));
     }
 
     @Override
     public Map<String, String[]> getFields() {
         return fields;
     }
 
     @Override
     public String[] getLanguages() {
         return stream(lang).get(stream -> stream.filter(StringUtil::isNotBlank).distinct().toArray(n -> new String[n]));
     }
 
     @Override
     public GeoInfo getGeoInfo() {
         return LaRequestUtil.getOptionalRequest()
                 .map(this::createGeoInfo)
                 .orElseGet(() -> ComponentUtil.getQueryHelper().getDefaultGeoInfo());
     }
 
     @Override
     public FacetInfo getFacetInfo() {
         return ComponentUtil.getQueryHelper().getDefaultFacetInfo();
     }
 
     @Override
     public HighlightInfo getHighlightInfo() {
         return ComponentUtil.getViewHelper().createHighlightInfo();
     }
 
     @Override
     public String getSort() {
         return sort;
     }
 
     @Override
     public Object getAttribute(final String name) {
         return LaRequestUtil.getOptionalRequest().map(req -> req.getAttribute(name)).orElse(null);
     }
 
     @Override
     public Locale getLocale() {
         return ComponentUtil.getRequestManager().getUserLocale();
     }
 
     @Override
     public SearchRequestType getType() {
         return SearchRequestType.SEARCH;
     }
 
     @Override
     public String getSimilarDocHash() {
         return sdh;
     }
 
     @Override
     public Map<String, String[]> getConditions() {
         return as;
     }
 
     @Override
     public String getTrackTotalHits() {
         return track_total_hits;
     }
 
 }