/**
    * This file Copyright (c) 2018 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.admincentral.findbar.sniff;
  
  import static info.magnolia.periscope.operation.OperationResult.successfulResult;
  
  import info.magnolia.admincentral.findbar.PeriscopeAppDetailCreator;
  import info.magnolia.admincentral.findbar.PeriscopeAppDetailCreator.AppDetail;
  import info.magnolia.cms.util.QueryUtil;
  import info.magnolia.periscope.operation.OperationResult;
  import info.magnolia.periscope.sniff.PatternCommandSniffer;
  import info.magnolia.ui.api.location.LocationController;
  import info.magnolia.ui.contentapp.detail.DetailLocation;
  import info.magnolia.ui.contentapp.detail.DetailView;
  
  import java.util.Optional;
  import java.util.regex.Matcher;
  import java.util.regex.Pattern;
  
  import javax.jcr.Node;
  import javax.jcr.NodeIterator;
  import javax.jcr.RepositoryException;
  import javax.jcr.query.Query;
  
  /**
   * Abstract class which takes care of executing a {@link Query#JCR_SQL2 JCR-SQL2} and returning a request
   * as a {@link OperationResult}.
   *
   * Implementors of this sniff should override {@link #buildQuery(String)} method in order to execute different
   * {@link Query#JCR_SQL2 JCR-SQL2} queries.
   */
  public abstract class AbstractFindCommandSniffer extends PatternCommandSniffer {
  
      private final LocationController locationController;
      private final PeriscopeAppDetailCreator periscopeAppDetailCreator;
      private final Pattern commandPattern;
  
      public AbstractFindCommandSniffer(LocationController locationController, PeriscopeAppDetailCreator periscopeAppDetailCreator, Pattern commandPattern) {
          this.locationController = locationController;
          this.periscopeAppDetailCreator = periscopeAppDetailCreator;
          this.commandPattern = commandPattern;
      }
  
      protected abstract String buildQuery(String content);
  
      @Override
      protected Pattern getPattern() {
          return commandPattern;
      }
  
      @Override
      protected OperationResult execute(Matcher matcher) {
          // As can be seen from the example, users are suppose to search like 'find page about conditions'
          // Therefore, we have to pluralise 'page' to 'pages' to match with Magnolia standard workspace naming conventions.
          String appName = matcher.group("appName").toLowerCase();
          String nodeName = matcher.group("content").toLowerCase();
  
          Optional<AppDetail> appDetailOptional = periscopeAppDetailCreator.createAppDetail(appName);
          if (!appDetailOptional.isPresent()) {
              return new OperationResult(false, String.format("App configuration cannot be found for app: '%s'.", appName));
          }
  
          String searchQuery = buildQuery(nodeName);
  
          try {
              AppDetail appDetail = appDetailOptional.get();
              String workspaceName = appDetail.getWorkspace();
              NodeIterator searchResults = QueryUtil.search(workspaceName, searchQuery, Query.JCR_SQL2);
             if (!searchResults.hasNext()) {
                 return new OperationResult(false, "No matching node found.");
             }
 
             Node matchingNode = searchResults.nextNode();
             String path = matchingNode.getPath();
 
             DetailLocation location = new DetailLocation(appDetail.getAppName(), appDetail.getSubAppName(), DetailView.ViewType.VIEW, path, null);
             locationController.goTo(location);
             return successfulResult();
         } catch (RepositoryException e) {
             return new OperationResult(false, e.getMessage());
         }
     }
 }