/**
    * This file Copyright (c) 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.module.forum.setup;
  
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.TaskExecutionException;
  import info.magnolia.ui.dialog.setup.DialogMigrationTask;
  import info.magnolia.ui.dialog.setup.migration.CheckBoxSwitchControlMigrator;
  import info.magnolia.ui.dialog.setup.migration.ControlMigrator;
  import info.magnolia.ui.dialog.setup.migration.EditControlMigrator;
  import info.magnolia.ui.dialog.setup.migration.LinkControlMigrator;
  
  import java.util.ArrayList;
  import java.util.Collection;
  
  import javax.jcr.Node;
  import javax.jcr.Property;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * {@link DialogMigrationTask} for forum module.
   */
  public class ForumDialogMigrationTask extends DialogMigrationTask {
  
      private static Logger log = LoggerFactory.getLogger(ForumDialogMigrationTask.class);
      private static final String DIALOG_PATH = "/modules/forum/dialogs";
      private static final String TABS_PATH = "form/tabs";
      private static final String NEW_TAB_NAME = "tabMain";
      private static final String PROPERTY_JS = "jsExecutedAfterSaving";
      private final Collection<Node> controlsToRemove = new ArrayList<Node>();
  
      public ForumDialogMigrationTask(String moduleName) {
          super("forum");
      }
  
      @Override
      public void execute(InstallContext installContext) throws TaskExecutionException {
          super.execute(installContext);
          this.adjustTabs(installContext);
          this.removeObsoleteControls();
      }
  
      private void adjustTabs(InstallContext installContext) {
          try {
              Session config = installContext.getConfigJCRSession();
              if (!config.nodeExists(DIALOG_PATH)) {
                  log.warn("No dialogs found.");
                  return;
              }
              Node dialogs = config.getNode("/modules/forum/dialogs");
              for (Node dialog : NodeUtil.getNodes(dialogs)) {
  
                  if (dialog.hasProperty(PROPERTY_JS)) {
                      dialog.getProperty(PROPERTY_JS).remove();
                  }
  
                  if (!dialog.hasNode(TABS_PATH)) {
                      continue;
                  }
                  Node firstTab = dialog.getNode(TABS_PATH).getNodes().nextNode();
                  NodeUtil.renameNode(firstTab, NEW_TAB_NAME);
              }
          } catch (RepositoryException e) {
             log.warn("Cannot rename tabs in forum dialogs.", e);
         }
     }
 
     private void removeObsoleteControls() {
         for (Node node : controlsToRemove) {
             try {
                 node.remove();
             } catch (RepositoryException e) {
                 log.warn("Cannot remove old control: '{}'.", node);
             }
         }
     }
 
     private void removeObsoleteProperty(Node controlNode, String propertyName) throws RepositoryException {
         this.removeObsoleteProperty(controlNode, propertyName, null);
     }
 
     private void removeObsoleteProperty(Node controlNode, String propertyName, String onlyIfHasThisValue) throws RepositoryException {
         if (controlNode.hasProperty(propertyName)) {
             if (onlyIfHasThisValue != null) {
                 if (!controlNode.getProperty(propertyName).getString().equals(onlyIfHasThisValue)) {
                     return;
                 }
             }
             controlNode.getProperty(propertyName).remove();
         }
     }
 
     private void renameObsoleteProperty(Node controlNode, String oldName, String newName) throws RepositoryException {
         if (!controlNode.hasProperty(oldName)) {
             return;
         }
         Property property = controlNode.getProperty(oldName);
         controlNode.setProperty(newName, property.getValue());
         property.remove();
     }
 
     /**
      * Forum specific {@link EditControlMigrator}.
      */
     protected class ForumEditControlMigrator extends EditControlMigrator {
         @Override
         public void migrate(Node controlNode, InstallContext installContext) throws RepositoryException {
             super.migrate(controlNode, installContext);
             if (!controlNode.hasProperty("type")) {
                 controlNode.setProperty("type", "String");
             }
 
             if ("auhtor".equals(controlNode.getName())) {
                 NodeUtil.renameNode(controlNode, "author");
             }
         }
     }
 
     /**
      * Forum specific {@link LinkControlMigrator}.
      */
     protected class ForumLinkControlMigrator extends LinkControlMigrator {
 
         @Override
         public void migrate(Node controlNode, InstallContext installContext) throws RepositoryException {
             super.migrate(controlNode, installContext);
 
             removeObsoleteProperty(controlNode, "tree");
             renameObsoleteProperty(controlNode, "repository", "targetWorkspace");
 
             String controlName = controlNode.getName();
             if ("threadId".equals(controlName) || "forumId".equals(controlName)) {
                 controlNode.setProperty("appName", "forum");
                 controlNode.setProperty("targetWorkspace", "forum");
             } else {
                 controlNode.setProperty("appName", "pages");
             }
         }
     }
 
     /**
      * RemoveControlMigrator.
      */
     protected class RemoveControlMigrator implements ControlMigrator {
         @Override
         public void migrate(Node controlNode, InstallContext installContext) throws RepositoryException {
             controlsToRemove.add(controlNode);
         }
     }
 
     /**
      * Forum specific {@link CheckBoxSwitchControlMigrator}.
      */
     protected class ForumCheckBoxSwitchControlMigrator extends CheckBoxSwitchControlMigrator {
         @Override
         public void migrate(Node controlNode, InstallContext installContext) throws RepositoryException {
             super.migrate(controlNode, installContext);
             removeObsoleteProperty(controlNode, "defaultValue");
         }
     }
 }