View Javadoc
1   /**
2    * This file Copyright (c) 2015-2017 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.cache.browser.setup;
35  
36  import info.magnolia.cache.browser.app.BrowserCacheApp;
37  import info.magnolia.module.DefaultModuleVersionHandler;
38  import info.magnolia.module.InstallContext;
39  import info.magnolia.module.cache.app.CacheApp;
40  import info.magnolia.module.delta.AbstractCondition;
41  import info.magnolia.module.delta.AddURIPermissionTask;
42  import info.magnolia.module.delta.BootstrapSingleResource;
43  import info.magnolia.module.delta.CheckAndModifyPropertyValueTask;
44  import info.magnolia.module.delta.Condition;
45  import info.magnolia.module.delta.DeltaBuilder;
46  import info.magnolia.module.delta.Task;
47  import info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor;
48  import info.magnolia.ui.contentapp.ContentAppDescriptor;
49  
50  import java.util.ArrayList;
51  import java.util.List;
52  
53  /**
54   * Version handler.
55   */
56  public class CacheBrowserAppModuleVersionHandler extends DefaultModuleVersionHandler {
57  
58      public CacheBrowserAppModuleVersionHandler() {
59          register(DeltaBuilder.update("5.5.3", "")
60                  .addTask(new BootstrapSingleResource("Bootstrap whitelisted classes", "","/mgnl-bootstrap/cache-browser-app/config.modules.cache-browser-app.config.xml" )));
61      }
62  
63      @Override
64      protected List<Task> getExtraInstallTasks(InstallContext installContext) {
65          List<Task> tasks = new ArrayList<>(super.getExtraInstallTasks(installContext));
66          tasks.add(new CheckAndModifyPropertyValueTask("/modules/cache-app/apps/cacheTools", "appClass", CacheApp.class.getName(), BrowserCacheApp.class.getName()));
67          tasks.add(new CheckAndModifyPropertyValueTask("/modules/cache-app/apps/cacheTools", "class", ConfiguredAppDescriptor.class.getName(), ContentAppDescriptor.class.getName()));
68          tasks.add(new AddURIPermissionTask("Add Get&Post permissions", "rest-editor", "/.rest/cache/v1*", AddURIPermissionTask.GET_POST));
69          return tasks;
70      }
71  
72      @Override
73      protected List<Condition> getInstallConditions() {
74          List<Condition> conditions = new ArrayList<>();
75          conditions.add(new PublishingOrActivationInstalledCondition());
76          return conditions;
77      }
78  
79      private class PublishingOrActivationInstalledCondition extends AbstractCondition {
80  
81          public PublishingOrActivationInstalledCondition() {
82              super("Publishing or Activation module is installed condition.", "Cache browser module requires Publishing(recommended) or Activation module installed.");
83          }
84  
85          @Override
86          public boolean check(InstallContext installContext) {
87              return installContext.isModuleRegistered("publishing-core") || installContext.isModuleRegistered("activation");
88          }
89      }
90  }