View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.init.MagnoliaConfigurationProperties;
37  import info.magnolia.init.MagnoliaInitPaths;
38  import info.magnolia.jcr.util.PropertyUtil;
39  import info.magnolia.module.InstallContext;
40  import info.magnolia.module.cache.ehcache3.EhCache3Factory;
41  import info.magnolia.module.delta.AbstractRepositoryTask;
42  import info.magnolia.module.delta.NodeExistsDelegateTask;
43  import info.magnolia.repository.RepositoryConstants;
44  
45  import java.io.File;
46  import java.io.IOException;
47  
48  import javax.jcr.RepositoryException;
49  
50  import org.apache.commons.io.FileUtils;
51  
52  /**
53   * Removes disk store.
54   */
55  class CleanUpDiskStoreDirectoryTask extends NodeExistsDelegateTask {
56  
57      static final String DISK_STORE_PATH = "diskStorePath";
58      static final String EHCACHE_3 = "/modules/cache/config/cacheFactory/delegateFactories/ehcache3";
59  
60      CleanUpDiskStoreDirectoryTask(MagnoliaConfigurationProperties configurationProperties, MagnoliaInitPaths magnoliaInitPaths) {
61          super("Removes disk store", EHCACHE_3, new CleanUp(configurationProperties, magnoliaInitPaths));
62      }
63  
64      private static class CleanUp extends AbstractRepositoryTask {
65  
66          private final MagnoliaConfigurationProperties configurationProperties;
67          private final MagnoliaInitPaths magnoliaInitPaths;
68  
69          private CleanUp(MagnoliaConfigurationProperties configurationProperties, MagnoliaInitPaths magnoliaInitPaths) {
70              super("Remove disk store", "Clean up incompatible ehcache3 disk store");
71              this.configurationProperties = configurationProperties;
72              this.magnoliaInitPaths = magnoliaInitPaths;
73          }
74  
75          @Override
76          public void doExecute(InstallContext installContext) throws RepositoryException {
77              final File directory = new File(getPath(installContext));
78              try {
79                  FileUtils.deleteDirectory(directory);
80              } catch (IOException e) {
81                  installContext.error(String.format("Can't clean up cache store {%s} due to {%s}. Please stop the webapp and remove the directory manually.", directory, e.getMessage()), e);
82              }
83          }
84  
85          private String getPath(InstallContext installContext) throws RepositoryException {
86              String path = PropertyUtil.getString(installContext.getJCRSession(RepositoryConstants.CONFIG).getNode(EHCACHE_3), DISK_STORE_PATH);
87              if (path == null) {
88                  path = EhCache3Factory.resolveDiskStorePath(configurationProperties, magnoliaInitPaths);
89              }
90              return path;
91          }
92      }
93  
94  
95  }