/*
    * 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.query;
  
  import java.util.Locale;
  
  import org.apache.commons.lang3.StringUtils;
  import org.apache.logging.log4j.LogManager;
  import org.apache.logging.log4j.Logger;
  import org.apache.lucene.search.Query;
  import org.apache.lucene.search.WildcardQuery;
  import org.codelibs.core.lang.StringUtil;
  import org.codelibs.fess.Constants;
  import org.codelibs.fess.entity.QueryContext;
  import org.codelibs.fess.exception.InvalidQueryException;
  import org.codelibs.fess.mylasta.direction.FessConfig;
  import org.codelibs.fess.util.ComponentUtil;
  import org.lastaflute.core.message.UserMessages;
  import org.opensearch.index.query.QueryBuilder;
  import org.opensearch.index.query.QueryBuilders;
  
  /**
   * Query command for handling wildcard queries.
   * Converts Lucene WildcardQuery objects to OpenSearch QueryBuilder objects,
   * supporting wildcard pattern matching with configurable case sensitivity.
   */
  public class WildcardQueryCommand extends QueryCommand {
  
      /**
       * Default constructor.
       */
      public WildcardQueryCommand() {
          super();
      }
  
      private static final Logger logger = LogManager.getLogger(WildcardQueryCommand.class);
  
      /**
       * Flag indicating whether wildcard terms should be converted to lowercase.
       */
      protected boolean lowercaseWildcard = true;
  
      @Override
      protected String getQueryClassName() {
          return WildcardQuery.class.getSimpleName();
      }
  
      @Override
      public QueryBuilder execute(final QueryContext context, final Query query, final float boost) {
          if (query instanceof final WildcardQuery wildcardQuery) {
              if (logger.isDebugEnabled()) {
                  logger.debug("WildcardQuery: query={}, boost={}", query, boost);
              }
              return convertWildcardQuery(context, wildcardQuery, boost);
          }
          throw new InvalidQueryException(messages -> messages.addErrorsInvalidQueryUnknown(UserMessages.GLOBAL_PROPERTY_KEY),
                  "Unknown q: " + query.getClass() + " => " + query);
      }
  
      /**
       * Converts a wildcard query to an appropriate OpenSearch QueryBuilder.
       *
       * @param context The query context containing field and search information
       * @param wildcardQuery The Lucene wildcard query to convert
       * @param boost The boost factor to apply to the query
       * @return The converted OpenSearch QueryBuilder
       */
      protected QueryBuilder convertWildcardQuery(final QueryContext context, final WildcardQuery wildcardQuery, final float boost) {
          final FessConfig fessConfig = ComponentUtil.getFessConfig();
          final String field = getSearchField(context.getDefaultField(), wildcardQuery.getField());
          if (Constants.DEFAULT_FIELD.equals(field)) {
              final String text = wildcardQuery.getTerm().text();
              context.addFieldLog(field, text);
              final String highlightText = StringUtils.strip(text, "*");
              if (StringUtil.isNotBlank(highlightText)) {
                  context.addHighlightedQuery(highlightText);
              }
              return buildDefaultQueryBuilder(fessConfig, context,
                      (f, b) -> QueryBuilders.wildcardQuery(f, toLowercaseWildcard(text)).boost(b * boost));
          }
  
          if (isSearchField(field)) {
              final String text = wildcardQuery.getTerm().text();
              context.addFieldLog(field, text);
              final String highlightText = StringUtils.strip(text, "*");
              if (StringUtil.isNotBlank(highlightText)) {
                 context.addHighlightedQuery(highlightText);
             }
             return QueryBuilders.wildcardQuery(field, toLowercaseWildcard(text)).boost(boost);
         }
 
         final String query = wildcardQuery.getTerm().toString();
         final StringBuilder queryBuf = new StringBuilder(query.length() + 2);
         if (!query.startsWith("*")) {
             queryBuf.append('*');
         }
         queryBuf.append(toLowercaseWildcard(query));
         if (!query.endsWith("*")) {
             queryBuf.append('*');
         }
         final String origQuery = queryBuf.toString();
         context.addFieldLog(Constants.DEFAULT_FIELD, origQuery);
         final String highlightText = StringUtils.strip(query, "*");
         if (StringUtil.isNotBlank(highlightText)) {
             context.addHighlightedQuery(highlightText);
         }
         return buildDefaultQueryBuilder(fessConfig, context, (f, b) -> QueryBuilders.wildcardQuery(f, origQuery).boost(b * boost));
     }
 
     /**
      * Converts a wildcard value to lowercase if configured to do so.
      *
      * @param value The wildcard value to potentially convert
      * @return The value in lowercase if lowercaseWildcard is true, otherwise the original value
      */
     protected String toLowercaseWildcard(final String value) {
         if (lowercaseWildcard) {
             return value.toLowerCase(Locale.ROOT);
         }
         return value;
     }
 
     /**
      * Sets whether wildcard terms should be converted to lowercase.
      *
      * @param lowercaseWildcard True to convert wildcard terms to lowercase, false otherwise
      */
     public void setLowercaseWildcard(final boolean lowercaseWildcard) {
         this.lowercaseWildcard = lowercaseWildcard;
     }
 }