SCM-Manager/scm-webapp/src/main/java/sonia/scm/upgrade/ClientDateFormatUpgradeHandler.java

/**
 * Copyright (c) 2010, Sebastian Sdorra All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer. 2. Redistributions in
 * binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution. 3. Neither the name of SCM-Manager;
 * nor the names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * http://bitbucket.org/sdorra/scm-manager
 *
 */



package sonia.scm.upgrade;

//~--- non-JDK imports --------------------------------------------------------

import com.google.common.io.Files;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import sonia.scm.SCMContext;
import sonia.scm.plugin.PluginVersion;

//~--- JDK imports ------------------------------------------------------------

import java.io.File;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

/**
 *
 * @author Sebastian Sdorra
 */
public class ClientDateFormatUpgradeHandler extends XmlUpgradeHandler
{

  /**
   * the logger for ClientDateFormatUpgradeHandler
   */
  private static final Logger logger =
    LoggerFactory.getLogger(ClientDateFormatUpgradeHandler.class);

  //~--- methods --------------------------------------------------------------

  /**
   * Method description
   *
   *
   * @param homeDirectory
   * @param configDirectory
   * @param oldVersion
   * @param newVersion
   */
  @Override
  public void doUpgrade(File homeDirectory, File configDirectory,
    PluginVersion oldVersion, PluginVersion newVersion)
  {
    if (oldVersion.isOlder("1.23"))
    {
      if (logger.isInfoEnabled())
      {
        logger.info("data format is older than 1.23, upgrade to version {}",
          SCMContext.getContext().getVersion());
      }

      updateClientDateFormat(homeDirectory, configDirectory);
    }
  }

  /**
   * Method description
   *
   *
   * @param document
   */
  private void fixClientDateFormat(Document document)
  {
    NodeList nodes = document.getElementsByTagName("dateFormat");

    if (nodes != null)
    {
      for (int i = 0; i < nodes.getLength(); i++)
      {
        Node node = nodes.item(i);
        String value = node.getTextContent();

        value = ClientDateFormatConverter.extjsToMoments(value);
        node.setTextContent(value);
      }
    }
  }

  /**
   * Method description
   *
   *
   * @param baseDirectory
   * @param configDirectory
   *
   * @throws IOException
   */
  private void updateClientDateFormat(File baseDirectory, File configDirectory)
  {
    File configFile = new File(configDirectory, "config.xml");

    if (configFile.exists())
    {
      try
      {

        // backup config.xml
        File backupDirectory = createBackupDirectory(baseDirectory,
                                 "upgrade to version {0}");

        Files.copy(configFile, new File(backupDirectory, "config.xml"));

        // change dateformat

        DocumentBuilder builder =
          DocumentBuilderFactory.newInstance().newDocumentBuilder();
        Document document = builder.parse(configFile);

        fixClientDateFormat(document);
        writeDocument(document, configFile);
      }
      catch (Exception ex)
      {
        logger.error("could not parse document", ex);
      }
    }

  }
}