/**
    * This file Copyright (c) 2012-2014 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.form.field.factory;
  
  import info.magnolia.i18nsystem.SimpleTranslator;
  import info.magnolia.repository.RepositoryConstants;
  import info.magnolia.ui.api.app.AppController;
  import info.magnolia.ui.api.app.ChooseDialogCallback;
  import info.magnolia.ui.api.context.UiContext;
  import info.magnolia.ui.form.field.definition.RichTextFieldDefinition;
  import info.magnolia.ui.vaadin.integration.jcr.JcrItemId;
  import info.magnolia.ui.vaadin.integration.jcr.JcrItemUtil;
  import info.magnolia.ui.vaadin.richtext.MagnoliaRichTextField;
  import info.magnolia.ui.vaadin.richtext.MagnoliaRichTextFieldConfig;
  import info.magnolia.ui.vaadin.richtext.MagnoliaRichTextFieldConfig.ToolbarGroup;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import javax.jcr.Node;
  
  import org.apache.commons.lang.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import com.google.gson.Gson;
  import com.google.inject.Inject;
  import com.vaadin.data.Item;
  import com.vaadin.server.ClientConnector.AttachEvent;
  import com.vaadin.server.ClientConnector.AttachListener;
  import com.vaadin.server.Page;
  import com.vaadin.server.Sizeable.Unit;
  import com.vaadin.server.VaadinService;
  import com.vaadin.server.WebBrowser;
  import com.vaadin.ui.Field;
  
  /**
   * Creates and configures a rich-text field based on its definition.
   */
  public class RichTextFieldFactory extends AbstractFieldFactory<RichTextFieldDefinition, String> {
  
      private static final Logger log = LoggerFactory.getLogger(LinkFieldFactory.class);
  
      private static final String PLUGIN_NAME_MAGNOLIALINK = "magnolialink";
  
      private static final String PLUGIN_PATH_MAGNOLIALINK = "/VAADIN/js/magnolialink/";
  
      /**
       * Event is transmitted from server to client when link has been selected.
       */
      public static final String EVENT_SEND_MAGNOLIA_LINK = "mgnlLinkSelected";
  
      /**
       * Event is transmitted from server to client when link dialog has been
       * canceled or exception has occurred. In case of exception
       * the event will carry error message.
       */
      public static final String EVENT_CANCEL_LINK = "mgnlLinkCancel";
  
      /**
       * Event is transmitted from client to server when user requests a link dialog.
       * Event carries optional link that should be treated as default link value.
       */
      public static final String EVENT_GET_MAGNOLIA_LINK = "mgnlGetLink";
  
      protected final AppController appController;
      protected final UiContext uiContext;
      protected final SimpleTranslator i18n;
     protected MagnoliaRichTextField richTextEditor;
 
     @Inject
     public RichTextFieldFactory(RichTextFieldDefinition definition, Item relatedFieldItem, AppController appController, UiContext uiContext, SimpleTranslator i18n) {
         super(definition, relatedFieldItem);
         this.appController = appController;
         this.uiContext = uiContext;
         this.i18n = i18n;
     }
 
     @Override
     protected Field<String> createFieldComponent() {
 
         MagnoliaRichTextFieldConfig config = initializeCKEditorConfig();
         richTextEditor = new MagnoliaRichTextField(config);
         if (definition.getHeight() > 0) {
             richTextEditor.setHeight(definition.getHeight(), Unit.PIXELS);
         }
 
         richTextEditor.addAttachListener(new AttachListener() {
             @Override
             public void attach(AttachEvent event) {
                 WebBrowser browser = Page.getCurrent().getWebBrowser();
                 if (browser.isIOS() || browser.isAndroid()) {
                     // MGNLUI-1582: Workaround disabling non-operational ckeditor on the iPad or on android devices.
                     richTextEditor.setEnabled(false);
                     richTextEditor.setReadOnly(true);
                     richTextEditor.addStyleName("richtextfield-disabled");
                 }
             }
         });
 
         richTextEditor.addListener(new MagnoliaRichTextField.PluginListener() {
             @Override
             public void onPluginEvent(String eventName, String value) {
                 if (eventName.equals(EVENT_GET_MAGNOLIA_LINK)) {
                     try {
                         Gson gson = new Gson();
                         PluginData pluginData = gson.fromJson(value, PluginData.class);
                         openLinkDialog(pluginData.path, pluginData.workspace);
                     } catch (Exception e) {
                         log.error("openLinkDialog failed", e);
                         richTextEditor.firePluginEvent(EVENT_CANCEL_LINK, i18n.translate("ui-form.richtexteditorexception.opentargetappfailure"));
                     }
                 }
             }
         });
 
         return richTextEditor;
     }
 
     protected MagnoliaRichTextFieldConfig initializeCKEditorConfig() {
 
         MagnoliaRichTextFieldConfig config = new MagnoliaRichTextFieldConfig();
         config.setBaseFloatZIndex(150);
         String path = VaadinService.getCurrentRequest().getContextPath();
 
         // CUSTOM CKEDITOR CONFIGURATION
         // config.js file provided, skip further configuration since CKEditor wrapper add-on ignores it too.
         if (StringUtils.isNotBlank(definition.getConfigJsFile())) {
             config.addExtraConfig("customConfig", "'" + path + definition.getConfigJsFile() + "'");
             return config;
         }
 
         // BASIC CONFIGURATION FROM DEFINITION
         if (!definition.isAlignment()) {
             config.addToRemovePlugins("justify");
         }
         if (!definition.isImages()) {
             config.addToRemovePlugins("image");
         }
         if (!definition.isLists()) {
             // In CKEditor 4.1.1 enterkey depends on indent which itself depends on list
             config.addToRemovePlugins("enterkey");
             config.addToRemovePlugins("indent");
             config.addToRemovePlugins("list");
         }
         if (!definition.isSource()) {
             config.addToRemovePlugins("sourcearea");
         }
         if (!definition.isTables()) {
             config.addToRemovePlugins("table");
             config.addToRemovePlugins("tabletools");
         }
 
         if (definition.getColors() != null) {
             config.addExtraConfig("colorButton_colors", "'" + definition.getColors() + "'");
             config.addExtraConfig("colorButton_enableMore", "'false'");
             config.addToRemovePlugins("colordialog");
         } else {
             config.addToRemovePlugins("colorbutton");
             config.addToRemovePlugins("colordialog");
         }
         if (definition.getFonts() != null) {
             config.addExtraConfig("font_names", "'" + definition.getFonts() + "'");
         } else {
             config.addExtraConfig("removeButtons", "'Font'");
         }
         if (definition.getFontSizes() != null) {
             config.addExtraConfig("fontSize_sizes", "'" + definition.getFontSizes() + "'");
         } else {
             config.addExtraConfig("removeButtons", "'FontSize'");
         }
         if (definition.getFonts() == null && definition.getFontSizes() == null) {
             config.addToRemovePlugins("font");
             config.addToRemovePlugins("fontSize");
         }
 
         // STATIC CONFIGURATION
         List<ToolbarGroup> toolbars = initializeToolbarConfig();
         config.addToolbarLine(toolbars);
 
         config.addToRemovePlugins("elementspath");
         config.addToRemovePlugins("filebrowser");
         config.setResizeEnabled(false);
 
         config.addPlugin(PLUGIN_NAME_MAGNOLIALINK, path + PLUGIN_PATH_MAGNOLIALINK);
         config.addListenedEvent(EVENT_GET_MAGNOLIA_LINK);
         return config;
     }
 
     protected List<ToolbarGroup> initializeToolbarConfig() {
         List<ToolbarGroup> toolbars = new ArrayList<ToolbarGroup>();
         toolbars.add(new ToolbarGroup("basicstyles", new String[] { "Bold", "Italic", "Underline", "SpecialChar" }));
         toolbars.add(new ToolbarGroup("paragraph", new String[] { "NumberedList", "BulletedList", "JustifyLeft", "JustifyCenter", "JustifyRight", "JustifyBlock", "Image", "Table" }));
         toolbars.add(new ToolbarGroup("links", new String[] { "Link", "InternalLink", "DamLink", "Unlink" }));
         toolbars.add(new ToolbarGroup("styles", new String[] { "Font", "FontSize", "TextColor" }));
         toolbars.add(new ToolbarGroup("clipboard", new String[] { "Cut", "Copy", "Paste", "PasteText", "PasteFromWord" }));
         toolbars.add(new ToolbarGroup("undo", new String[] { "Undo", "Redo" }));
         toolbars.add(new ToolbarGroup("tools", new String[] { "Source" }));
         return toolbars;
     }
 
     private String mapWorkSpaceToApp(String workspace) {
         if (workspace.equalsIgnoreCase("dam")) {
             return "assets";
         } else if (workspace.equalsIgnoreCase(RepositoryConstants.WEBSITE)) {
             return "pages";
         }
 
         return "";
     }
 
     private void openLinkDialog(String path, String workspace) {
         appController.openChooseDialog(mapWorkSpaceToApp(workspace), uiContext, null, new ChooseDialogCallback() {
             @Override
             public void onItemChosen(String actionName, Object chosenValue) {
                 if (!(chosenValue instanceof JcrItemId)) {
                     richTextEditor.firePluginEvent(EVENT_CANCEL_LINK);
                     return;
                 }
                 try {
                     javax.jcr.Item jcrItem = JcrItemUtil.getJcrItem((JcrItemId) chosenValue);
                     if (!jcrItem.isNode()) {
                         return;
                     }
                     final Node selected = (Node) jcrItem;
                     Gson gson = new Gson();
                     MagnoliaLink mlink = new MagnoliaLink();
                     mlink.identifier = selected.getIdentifier();
                     mlink.repository = selected.getSession().getWorkspace().getName();
                     mlink.path = selected.getPath();
                     if (selected.hasProperty("title")) {
                         mlink.caption = selected.getProperty("title").getString();
                     } else {
                         mlink.caption = selected.getName();
                     }
 
                     richTextEditor.firePluginEvent(EVENT_SEND_MAGNOLIA_LINK, gson.toJson(mlink));
                 } catch (Exception e) {
                     String error = i18n.translate("ui-form.richtexteditorexception.cannotaccessselecteditem");
                     log.error(error, e);
                     richTextEditor.firePluginEvent(EVENT_CANCEL_LINK, error);
                 }
             }
 
             @Override
             public void onCancel() {
                 richTextEditor.firePluginEvent(EVENT_CANCEL_LINK);
             }
         });
     }
 
     /**
      * Link info wrapper.
      */
     protected static class MagnoliaLink {
 
         public String identifier;
 
         public String repository;
 
         public String path;
 
         public String caption;
 
     }
 
     /**
      * Plugin data wrapper.
      */
     protected static class PluginData {
         public String workspace;
         public String path;
     }
 }