/*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you 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.apache.syncope.core.persistence.api.search;
  
  import java.net.URLDecoder;
  import java.nio.charset.StandardCharsets;
  import org.apache.commons.lang3.exception.ExceptionUtils;
  import org.apache.cxf.jaxrs.ext.search.SearchBean;
  import org.apache.cxf.jaxrs.ext.search.SearchCondition;
  import org.apache.syncope.common.lib.SyncopeClientException;
  import org.apache.syncope.common.lib.search.AbstractFiqlSearchConditionBuilder;
  import org.apache.syncope.common.lib.search.SyncopeFiqlParser;
  import org.apache.syncope.common.lib.types.ClientExceptionType;
  import org.identityconnectors.framework.common.objects.filter.Filter;
  
  /**
   * Converts FIQL expressions to ConnId's {@link Filter}.
   */
  public final class FilterConverter {
  
      /**
       * Parses a FIQL expression into ConnId's {@link Filter}, using {@link SyncopeFiqlParser}.
       *
       * @param fiql FIQL string
       * @return {@link Filter} instance for given FIQL expression
       */
      public static Filter convert(final String fiql) {
          SyncopeFiqlParser<SearchBean> parser = new SyncopeFiqlParser<>(
                  SearchBean.class, AbstractFiqlSearchConditionBuilder.CONTEXTUAL_PROPERTIES);
  
          try {
              FilterVisitor visitor = new FilterVisitor();
              SearchCondition<SearchBean> sc = parser.parse(URLDecoder.decode(fiql, StandardCharsets.UTF_8));
              sc.accept(visitor);
  
              return visitor.getQuery();
          } catch (Exception e) {
              SyncopeClientException sce = SyncopeClientException.build(ClientExceptionType.InvalidSearchParameters);
              sce.getElements().add(fiql);
              sce.getElements().add(ExceptionUtils.getRootCauseMessage(e));
              throw sce;
          }
      }
  
      private FilterConverter() {
          // empty constructor for static utility class        
      }
  }