View Javadoc
1   /**
2    * This file Copyright (c) 2015 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.setup;
35  
36  import info.magnolia.module.InstallContext;
37  import info.magnolia.module.delta.AbstractRepositoryTask;
38  import info.magnolia.module.delta.TaskExecutionException;
39  import info.magnolia.repository.RepositoryConstants;
40  
41  import javax.jcr.Node;
42  import javax.jcr.PathNotFoundException;
43  import javax.jcr.RepositoryException;
44  import javax.jcr.Session;
45  
46  /**
47   * A Task which removes the virtual uri mapping at {@value #VIRTUAL_URI_PATH} if it is still configured as it was in 4.5. Also removes the whole virtualURIMappings node if it is empty.
48   */
49  class RemoveVirtualUriMappingTask extends AbstractRepositoryTask {
50      private static final String VIRTUAL_URI_PATH = "/modules/cache/virtualURIMapping/tildeCacheRessources";
51  
52      RemoveVirtualUriMappingTask() {
53          super("Remove unnecessary virtual URI mapping", "Removes the now-unnecessary virtual URI mapping for resources ~far~future~cache.");
54      }
55  
56      @Override
57      protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
58          final Session session = ctx.getJCRSession(RepositoryConstants.CONFIG);
59          try {
60              final Node n = session.getNode(VIRTUAL_URI_PATH);
61              final Node parent = n.getParent();
62              if (checkProperty(n, "class", "info.magnolia.cms.beans.config.RegexpVirtualURIMapping") &&
63                      checkProperty(n, "fromURI", "(\\.*)\\.(\\d{4}-(?:\\d{2}-){5}\\d{3})\\.cache\\.(css|js)") &&
64                      checkProperty(n, "toURI", "$1~$2~cache.$3")) {
65                  n.remove();
66                  if (!parent.hasNodes()) {
67                      parent.remove();
68                  }
69              } else {
70                  ctx.warn("Virtual URI mapping found at " + VIRTUAL_URI_PATH + " with different values than expected. Make sure you rename or remove it appropriately.");
71              }
72          } catch (PathNotFoundException e) {
73              ctx.warn("Virtual URI mapping not found at " + VIRTUAL_URI_PATH + ". If you modified or moved it, make sure you remove it appropriately.");
74          }
75      }
76  
77      private boolean checkProperty(Node n, String name, String expectedValue) throws RepositoryException {
78          return n.getProperty(name).getString().equals(expectedValue);
79      }
80  }