View Javadoc
1   /**
2    * This file Copyright (c) 2017-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.cache.ehcache3.setup;
35  
36  import info.magnolia.cms.core.FileSystemHelper;
37  import info.magnolia.init.MagnoliaConfigurationProperties;
38  import info.magnolia.init.MagnoliaInitPaths;
39  import info.magnolia.module.InstallContext;
40  import info.magnolia.module.delta.AbstractTask;
41  import info.magnolia.module.delta.TaskExecutionException;
42  import info.magnolia.objectfactory.Components;
43  
44  import java.io.File;
45  import java.io.IOException;
46  import java.nio.file.FileSystems;
47  
48  import org.apache.commons.io.FileUtils;
49  import org.apache.commons.lang3.StringUtils;
50  
51  /**
52   * Moves disk store to correct location.
53   */
54  public class MoveDiskStoreDirectoryTask extends AbstractTask {
55  
56      //javax.management.ObjectName invalid characters
57      private static final String CACHE_MANAGER_ID_INVALID_CHARS = "*?=:,\n\"";
58      private static final String MAGNOLIA_PROPERTY_CACHE_MANAGER_ID = "magnolia.cache.manager.id";
59  
60      public MoveDiskStoreDirectoryTask() {
61          super("Move disk store to correct location", String.format("Move {%s} to {%s}", getOldDirectory(), getNewDirectory()));
62      }
63  
64      @Override
65      public void execute(InstallContext installContext) throws TaskExecutionException {
66          final File oldDirectory = getOldDirectory();
67          if (oldDirectory.exists()) {
68              final File newDirectory = getNewDirectory();
69              try {
70                  File oldParent = new File(oldDirectory.getParent());
71                  FileUtils.moveDirectory(oldDirectory, newDirectory);
72  
73                  while (oldParent != newDirectory.getParentFile()) {
74                      if (oldParent.listFiles().length == 0) {
75                          FileUtils.deleteDirectory(oldParent);
76                          oldParent = oldParent.getParentFile();
77                      } else {
78                          break;
79                      }
80                  }
81              } catch (IOException e) {
82                  installContext.error(String.format("Can't move cache store {%s} to correct location {%s} due to {%s}. Please stop the webapp and move the directory manually.", oldDirectory, newDirectory, e.getMessage()), e);
83              }
84          }
85      }
86  
87      static File getOldDirectory() {
88          return new File(getCacheDirectoryPath() + getCacheManagerIdentifier());
89      }
90  
91      static File getNewDirectory() {
92          return new File(getCacheDirectoryPath() + Components.getComponent(MagnoliaInitPaths.class).getContextPath());
93      }
94  
95      private static String getCacheDirectoryPath() {
96          String path = Components.getComponent(MagnoliaConfigurationProperties.class).getProperty(MagnoliaConfigurationProperties.MAGNOLIA_CACHE_STARTDIR);
97          File dir = FileSystems.getDefault().getPath(path).isAbsolute() ? new File(path) : new File(Components.getComponent(FileSystemHelper.class).getAppRootDir(), path);
98          dir.mkdirs();
99          return dir.getAbsolutePath();
100     }
101 
102     private static String getCacheManagerIdentifier() {
103         final MagnoliaConfigurationProperties magnoliaConfigurationProperties = Components.getComponent(MagnoliaConfigurationProperties.class);
104         if (magnoliaConfigurationProperties.hasProperty(MAGNOLIA_PROPERTY_CACHE_MANAGER_ID)) {
105             return magnoliaConfigurationProperties.getProperty(MAGNOLIA_PROPERTY_CACHE_MANAGER_ID);
106         } else {
107             return StringUtils.replaceChars(Components.getComponent(MagnoliaInitPaths.class).getRootPath(), CACHE_MANAGER_ID_INVALID_CHARS, "-");
108         }
109     }
110 }