/**
    * 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.rest.tools.setup;
  
  import static info.magnolia.repository.RepositoryConstants.CONFIG;
  
  import info.magnolia.cms.security.Permission;
  import info.magnolia.module.DefaultModuleVersionHandler;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.AddPermissionTask;
  import info.magnolia.module.delta.CheckAndModifyPropertyValueTask;
  import info.magnolia.module.delta.DeltaBuilder;
  import info.magnolia.module.delta.RemoveNodesTask;
  import info.magnolia.module.delta.RemovePermissionTask;
  import info.magnolia.module.delta.RemovePropertyTask;
  import info.magnolia.module.delta.RenameNodeTask;
  import info.magnolia.module.delta.SetPropertyTask;
  import info.magnolia.module.delta.Task;
  import info.magnolia.module.delta.ValueOfPropertyDelegateTask;
  import info.magnolia.repository.RepositoryConstants;
  import info.magnolia.rest.RestDispatcherServlet;
  import info.magnolia.rest.tools.SwaggerRestDispatcherServlet;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.List;
  
  /**
   * Module version handler.
   */
  public class RestToolsModuleVersionHandler extends DefaultModuleVersionHandler {
  
      private final static String REST_DISPATCHER_SERVLET_PATH = "/server/filters/servlets/RestDispatcherServlet";
      private final static String PATH_TO_REST_INTEGRATION_MODULE = "/modules/rest-integration";
  
      public RestToolsModuleVersionHandler() {
          super();
  
          register(DeltaBuilder.update("1.2.0", "Update to 1.2.0")
                  .addTask(new SetPropertyTask("Update apiDeclarationProvider class for new Swagger version",
                          CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders/apiDeclarationProvider", "providerClass", "io.swagger.jaxrs.listing.ApiListingResource"))
                  .addTask(new SetPropertyTask("Update resourceListingProvider class for new Swagger version",
                          CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders/resourceListingProvider", "providerClass", "io.swagger.jaxrs.listing.SwaggerSerializers"))
                  .addTask(new RenameNodeTask("Rename additional provider node 'apiDeclarationProvider' to 'apiListingResource'",
                          CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders", "apiDeclarationProvider", "apiListingResource", true))
                  .addTask(new RenameNodeTask("Rename additional provider node 'resourceListingProvider' to 'swaggerSerializers'",
                          CONFIG, PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders", "resourceListingProvider", "swaggerSerializers", true))
                  .addTask(new ValueOfPropertyDelegateTask("Update Swagger API version in configuration", "/modules/rest-tools/config", "apiVersion", "1.0.0", true,
                          new SetPropertyTask(RepositoryConstants.CONFIG, "/modules/rest-tools/config", "apiVersion", "1.5.4")))
                  .addTask(new RemovePermissionTask("Remove old swagger doc access in 'rest' role (/.rest/api-docs*)", "rest", "uri", "/.rest/api-docs*", Permission.ALL))
                  .addTask(new AddPermissionTask("Enable swagger doc access in 'rest' role (/.rest/swagger*)", "rest", "uri", "/.rest/swagger*", Permission.ALL, false))
                  .addTask(new SetPropertyTask(RepositoryConstants.CONFIG, "/modules/rest-tools/apps/restTools/subApps/apiDocs", "url", "/.resources/rest-tools/webresources/swagger-ui/index.html")));
  
          register(DeltaBuilder.update("2.2.7", "Update to 2.2.7")
                  .addTask(new RemoveNodesTask("Remove obsolete additionalProviders", CONFIG, Arrays.asList(
                          PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders/apiListingResource",
                          PATH_TO_REST_INTEGRATION_MODULE + "/config/additionalProviders/swaggerSerializers"), false))
                  .addTask(new RemovePropertyTask("Remove obsolete apiVersion", "/modules/rest-tools/config", "apiVersion")));
      }
  
      @Override
      protected List<Task> getExtraInstallTasks(InstallContext installContext) {
          List<Task> list = new ArrayList<Task>();
  
          list.add(new CheckAndModifyPropertyValueTask("Replace dispatcher servlet", "Replace default dispatcher servlet with API-aware dispatcher servlet", RepositoryConstants.CONFIG,
                  REST_DISPATCHER_SERVLET_PATH, "servletClass", RestDispatcherServlet.class.getName(), SwaggerRestDispatcherServlet.class.getName()));
  
          // Allow web access to '/.rest/api-docs' in role 'rest'
         list.add(new AddPermissionTask("Update 'rest-editor' role", "Allows access to the REST API documentation interface residing under '/.rest/swagger' in role 'rest-editor'.", "rest-editor", "uri", "/.rest/swagger*", Permission.ALL, false));
 
         return list;
     }
 }