/**
    * This file Copyright (c) 2013-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.contentapp.detail;
  
  import static java.util.stream.Collectors.*;
  
  import info.magnolia.ui.CloseHandler;
  import info.magnolia.ui.ViewType;
  import info.magnolia.ui.api.app.SubAppContext;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.api.location.DefaultLocation;
  import info.magnolia.ui.api.location.Location;
  import info.magnolia.ui.contentapp.ItemDescriber;
  import info.magnolia.ui.ValueContext;
  import info.magnolia.ui.dialog.ActionExecution;
  import info.magnolia.ui.dialog.EditorActionBar;
  import info.magnolia.ui.field.LocaleSelector;
  import info.magnolia.ui.editor.FormDefinition;
  import info.magnolia.ui.editor.LocaleContext;
  import info.magnolia.ui.framework.ContextProperty;
  import info.magnolia.ui.UIComponent;
  import info.magnolia.ui.framework.UiComponentContext;
  import info.magnolia.ui.editor.ItemProviderStrategy;
  import info.magnolia.ui.editor.EditorView;
  import info.magnolia.ui.editor.FormView;
  
  import java.util.List;
  import java.util.Map;
  import java.util.Optional;
  import java.util.stream.Collectors;
  
  import javax.inject.Inject;
  
  import org.apache.commons.lang3.StringUtils;
  
  import com.vaadin.event.ShortcutListener;
  import com.vaadin.ui.Component;
  import com.vaadin.ui.CssLayout;
  import com.vaadin.ui.Panel;
  
  import lombok.AccessLevel;
  import lombok.Getter;
  
  /**
   * Generic form detail subapp.
   *
   * @param <T> item type.
   */
  public class ContentDetailSubApp<T> extends AbstractDetailSubApp<ContentDetailSubApp.SubAppView> {
  
      private final DetailDescriptor<T, ?> subAppDescriptor;
      private final I18NAuthoringSupport<T> i18NAuthoringSupport;
      private final LocaleContext localeContext;
      private final ValueContext<T> valueContext;
      private final ItemDescriber<T> itemDescriber;
  
      @Inject
      protected ContentDetailSubApp(
              SubAppContext subAppContext,
              I18NAuthoringSupport<T> i18NAuthoringSupport,
              DetailDescriptor<T, ?> descriptor,
              LocaleContext localeContext,
              ValueContext<T> valueContext,
              ItemDescriber<T> itemDescriber) {
          super(subAppContext, new SubAppView());
          this.valueContext = valueContext;
          this.localeContext = localeContext;
          this.subAppDescriptor = descriptor;
         this.i18NAuthoringSupport = i18NAuthoringSupport;
         this.itemDescriber = itemDescriber;
     }
 
     @Override
     public SubAppView start(Location location) {
         super.start(location);
 
         final SubAppView view = getView();
 
         localeContext.defaultLocale().set(getSubAppContext().getAuthoringLocale());
 
         bindInstance(UIComponent.class, view);
         bindInstance(CloseHandler.class, () -> getSubAppContext().close());
 
         ItemProviderStrategy<T, DetailLocation> itemProviderStrategy = create(subAppDescriptor.getItemProvider());
         Optional<T> item = itemProviderStrategy.read(DetailLocation.wrap(location));
 
         item.ifPresent(it -> localeContext.populateFromI18NAuthoringSupport(it, i18NAuthoringSupport));
 
         FormDefinition<T> formDefinition = subAppDescriptor.getForm();
         FormView<T> form = (FormView<T>) create(formDefinition);
 
         EditorActionBar<T> editorActionBar = view.create(EditorActionBar.class);
         List<ActionExecution<T>> actionExecutions =
                 ActionExecution.<T>fromDefinitions(subAppDescriptor.getActions().values(), getComponentProvider())
                         .collect(toList());
 
         editorActionBar
                 .withActions(actionExecutions)
                 .withLayoutDefinition(subAppDescriptor.getFooterLayout());
 
         if (formDefinition.hasI18NProperties()) {
             editorActionBar = editorActionBar.withLabeledControl("localeSelector", create(LocaleSelector.class));
         }
 
         Map<Integer, Runnable> shortcuts = actionExecutions.stream()
                 .filter(execution -> execution.getDefinition().getShortcut() > 0)
                 .collect(toMap(execution -> execution.getDefinition().getShortcut(), actionExecution -> actionExecution::execute));
 
         view.bindInstance(EditorView.class, form);
         view.setShortcuts(shortcuts);
 
         view.getLayout().setTitle(subAppDescriptor.getLabel());
         view.getLayout().setMargin(false);
         view.getLayout().setForm(form.asVaadinComponent());
         view.getLayout().setFooter(editorActionBar.layout());
         view.getLayout().construct();
 
         item.ifPresent(valueContext::set);
 
         switch (DetailLocation.wrap(location).viewType) {
             case "add":
                 form.applyDefaults();
                 break;
             default:
                 item.ifPresent(form::populate);
                 break;
         }
 
         return view;
     }
 
     @Override
     public String getCaption() {
         return itemDescriber.apply(valueContext.get().collect(Collectors.toList()));
     }
 
     @Override
     public void locationChanged(Location location) {
         // do nothing, detail sub-app isn't really designed to support
         // locale changes
     }
 
     /**
      * LocationContext.
      */
     public interface LocationContext extends UiComponentContext {
         ContextProperty<DetailLocation> location();
     }
 
     /**
      * ItemLocation used by implementations of {@link ContentDetailSubApp}.
      * Extends the Default Location by adding fields for:
      * <ul>
      * <li>the nodePath (some/node/path)</li>
      * <li>the viewType</li>
      * <li>the node version (version)</li>
      * </ul>
      * <p>
      * {@code appType:appName:subAppId;some/node/path:viewType:version}
      */
     public static class DetailLocation extends DefaultLocation {
 
         private String viewType;
         private String nodePath;
         private String version;
         // Position of the parameter based on the ':' used as separator.
         private final static int NODE_PATH_PARAM_POSITION = 0;
         private final static int VIEW_TYPE_PARAM_POSITION = 1;
         private final static int VERSION_PARAM_POSITION = 2;
 
         public DetailLocation(String appName, String subAppId, String parameter) {
             super(LOCATION_TYPE_APP, appName, subAppId, parameter);
 
             setNodePath(extractNodePath(parameter));
             setViewType(extractViewType(parameter));
             setVersion(extractVersion(parameter));
         }
 
         public DetailLocation(String appName, String subAppId, String viewType, String nodePath, String version) {
             super(LOCATION_TYPE_APP, appName, subAppId);
 
             setNodePath(nodePath);
             setViewType(viewType);
             setVersion(version);
             updateParameter();
         }
 
         public String getNodePath() {
             return unescapeSpecialCharacters(nodePath);
         }
 
         /**
          * If the node path is empty, assume root path.
          */
         private void setNodePath(String nodePath) {
             this.nodePath = (nodePath == null || nodePath.isEmpty()) ? "/" : escapeSpecialCharacters(nodePath);
         }
 
         public String getViewType() {
             return viewType;
         }
 
         public void setViewType(String viewType) {
             this.viewType = viewType;
         }
 
         public String getVersion() {
             return unescapeSpecialCharacters(version);
         }
 
         public void setVersion(String version) {
             this.version = escapeSpecialCharacters(version);
         }
 
         public boolean hasVersion() {
             return StringUtils.isNotBlank(version);
         }
 
         /**
          * Extract the Node path from the parameter.
          *
          * @param parameter some/node/path:viewType:version
          * @return some/node/path
          */
         private String extractNodePath(String parameter) {
             return getParameter(parameter, NODE_PATH_PARAM_POSITION);
         }
 
         /**
          * Extract the viewType from the parameter.
          *
          * @param parameter some/node/path:viewType:version
          * @return viewType
          */
         private String extractViewType(String parameter) {
             String action = getParameter(parameter, VIEW_TYPE_PARAM_POSITION);
             return action;
         }
 
         /**
          * Extract the Node Version from the parameter.
          *
          * @param parameter some/node/path:viewType:version
          * @return version
          */
         private String extractVersion(String parameter) {
             return getParameter(parameter, VERSION_PARAM_POSITION);
         }
 
         protected String getParameter(String parameter, int position) {
             String arguments[] = StringUtils.split(parameter, ':');
             if (position <= arguments.length - 1) {
                 return arguments[position];
             }
             return "";
         }
 
         protected void updateParameter() {
             StringBuilder sb = new StringBuilder();
             sb.append(nodePath);
             sb.append(":");
             sb.append(viewType);
             if (StringUtils.isNotBlank(version)) {
                 sb.append(":");
                 sb.append(version);
             }
             super.setParameter(sb.toString());
         }
 
         public static DetailLocation wrap(Location location) {
             return new DetailLocation(location.getAppName(), location.getSubAppId(), location.getParameter());
         }
 
         public void updateNodePath(String newNodePath) {
             setNodePath(newNodePath);
             updateParameter();
         }
 
         public void updateViewtype(String newViewType) {
             setViewType(newViewType);
             updateParameter();
         }
 
         public void updateVersion(String newVersion) {
             setVersion(newVersion);
             updateParameter();
         }
     }
 
     @Getter(AccessLevel.PACKAGE)
     public static class SubAppView extends Panel implements UIComponent {
 
         private DetailViewLayoutDetailViewLayout.html#DetailViewLayout">DetailViewLayout layout = new DetailViewLayout();
 
         public SubAppView() {
             setSizeFull();
             addStyleName("detail");
             CssLayout contentViewWrapper = new CssLayout();
             contentViewWrapper.addStyleName("detailview");
             contentViewWrapper.setSizeFull();
             contentViewWrapper.addComponent(layout);
             layout.setSizeFull();
 
             setContent(contentViewWrapper);
         }
 
         @Override
         public Component asVaadinComponent() {
             return this;
         }
 
         public void setShortcuts(Map<Integer, Runnable> shortcuts) {
             shortcuts.forEach((keyCode, execution) -> {
                 addShortcutListener(new ShortcutListener("", keyCode, new int[]{}) {
                     @Override
                     public void handleAction(Object sender, Object target) {
                         execution.run();
                     }
                 });
             });
         }
     }
 }