/**
    * This file Copyright (c) 2016-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.ui.framework.ioc;
  
  import static java.util.Comparator.naturalOrder;
  
  import java.lang.annotation.Annotation;
  import java.util.List;
  import java.util.Objects;
  import java.util.Optional;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Utility class which is capable of converting string identifiers
   * into {@link com.google.inject.BindingAnnotation
   * Magnolia UI binding annotations}.
   *
   * Useful when preparing the Guice bindings or looking up annotated types.
   *
   * @see UiBaseModule
   * @see UiComponentConfigurationAggregator
   * @see UiContextReference
   */
  public class UiAnnotations {
  
      private static final Logger log = LoggerFactory.getLogger(UiAnnotations.class);
  
      private UiAnnotations() {
      }
  
      public static UiContextAnnotation forAdmincentral() {
          return new AdmincentralImpl();
      }
  
      public static UiContextAnnotation forM5Admincentral() {
          return new AdmincentralImpl("m5");
      }
  
      public static UiContextAnnotation forSubApp(String appName, String subAppName) {
          return new SubAppImpl(appName, subAppName);
      }
  
      public static UiContextAnnotation forSubApps() {
          return new SubAppImpl("", "");
      }
  
      public static UiContextAnnotation forApp(String appName) {
          return new AppImpl(appName);
      }
  
      public static UiContextAnnotation forApps() {
          return new AppImpl("");
      }
  
      public static UiContextAnnotation forView(String viewName) {
          return new ViewImpl(viewName);
      }
  
      public static UiContextAnnotation forViews() {
          return new ViewImpl();
      }
  
      static UiContextAnnotation cast(Annotation annotation) {
          if (annotation instanceof UiContextAnnotation) {
              return (UiContextAnnotation) annotation;
         }
 
         throw new IllegalArgumentException("Provided annotation [" + annotation + "] is not an instance of UI context annotation");
     }
 
     static Annotation parseAnnotation(String id, List<String> appNames) {
         switch (id) {
         case "admincentral":
             return new AdmincentralImpl();
         case "admincentral-m5":
             return new AdmincentralImpl("m5");
         case "app":
             return new AppImpl();
         case "subapp":
             return new SubAppImpl();
         case "choosedialog":
             return new ViewImpl("choosedialog");
         case "mediaeditor":
             return new ViewImpl("mediaeditor");
         default:
             final String appWithSubApp = StringUtils.removeStart(id, "app-");
             // Find the app name that matches the components id most (longest app name that is a prefix of the id string)
             final Optional<String> correspondingApp = appNames.stream().filter(appWithSubApp::startsWith).max(naturalOrder());
 
             // If such app even exists - check if sub-app is also provided and then return the resulting annotation
             return correspondingApp.map(appName -> {
                 if (Objects.equals(appName, appWithSubApp)) {
                     return UiAnnotations.forApp(appName);
                 }
 
                 final String subAppName = StringUtils.removeStart(appWithSubApp, appName + "-");
                 return UiAnnotations.forSubApp(appName, subAppName);
             }).orElseGet(() -> {
                 // If no such app/sub-app is resolved gracefully - there's no such app in the system at all, make a guess, warn and return
                 // the guessed annotation
                 final String appName = StringUtils.substringBeforeLast(appWithSubApp, "-");
                 final String subAppName = StringUtils.substringAfterLast(appWithSubApp, "-");
                 if (StringUtils.isNotBlank(subAppName)) {
                     log.warn("Failed to match {} to any app/sub-app, will treat it as sub-app {} of app {}", appWithSubApp, subAppName, appName);
                     return  UiAnnotations.forSubApp(appName, subAppName);
                 } else {
                     log.warn("Failed to match {} to any app/sub-app, will treat it as app {}", appWithSubApp, appName);
                     return  UiAnnotations.forApp(appName);
                 }
             });
         }
     }
 }