View Javadoc
1   /**
2    * This file Copyright (c) 2003-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.delta;
35  
36  import info.magnolia.cms.exchange.ActivationManager;
37  import info.magnolia.cms.exchange.ActivationManagerFactory;
38  import info.magnolia.cms.exchange.Subscriber;
39  import info.magnolia.cms.security.Permission;
40  import info.magnolia.context.MgnlContext;
41  import info.magnolia.jcr.util.NodeTypes;
42  import info.magnolia.jcr.util.NodeUtil;
43  import info.magnolia.module.InstallContext;
44  import info.magnolia.module.model.ModuleDefinition;
45  import info.magnolia.module.model.RepositoryDefinition;
46  import info.magnolia.repository.RepositoryConstants;
47  
48  import javax.jcr.Node;
49  import javax.jcr.RepositoryException;
50  
51  /**
52   * Bootstrap empty repositories for the current module. (loading is already performed before install tasks)
53   */
54  public class SetupModuleRepositoriesTask extends AbstractTask {
55  
56      public SetupModuleRepositoriesTask() {
57          super("Setup module repositories", "Bootstrap empty repositories, grant them to superuser and subscribe them so that activation can be used.");
58      }
59  
60      // TODO finer exception handling ?
61      @Override
62      public void execute(InstallContext ctx) throws TaskExecutionException {
63          try {
64              final ModuleDefinition def = ctx.getCurrentModuleDefinition();
65              // register repositories
66              for (RepositoryDefinition repDef : def.getRepositories()) {
67                  for (final String workspace : repDef.getWorkspaces()) {
68                      ArrayDelegateTaskArrayDelegateTask">ArrayDelegateTask arrayDelegateTask = new ArrayDelegateTask(String.format("Bootstrap the %s if empty, grant it to superuser and subscribe it if activation is installed so that activation can be used.", workspace),
69                              new AddPermissionTask("", "superuser", workspace, "/*", Permission.ALL, false),
70                              new SubscribeWorkspaceTask(workspace));
71                      arrayDelegateTask.execute(ctx);
72                  }
73              }
74          } catch (Throwable e) {
75              throw new TaskExecutionException("Could not bootstrap workspace: " + e.getMessage(), e);
76          }
77      }
78  
79      /**
80       * Register the repository to get used for activation.
81       */
82      private class SubscribeWorkspaceTask extends AbstractRepositoryTask {
83  
84          private String workspace;
85  
86          public SubscribeWorkspaceTask(String workspace) {
87              super("Register workspace to subscribers", "If activation module is registered than register workspace to all subscribers");
88              this.workspace = workspace;
89          }
90  
91          @Override
92          protected void doExecute(InstallContext installContext) throws RepositoryException, TaskExecutionException {
93              if (installContext.isModuleRegistered("activation")) { // register workspace to subscribers only if activation module is registered
94                  ActivationManager sManager = ActivationManagerFactory.getActivationManager();
95                  for (Subscriber subscriber : sManager.getSubscribers()) {
96                      if (!subscriber.isSubscribed("/", workspace)) {
97                          Node newSubscription = NodeUtil.createPath(MgnlContext.getJCRSession(RepositoryConstants.CONFIG).getRootNode(),
98                                  sManager.getConfigPath() + "/" + subscriber.getName() + "/subscriptions/" + workspace, NodeTypes.ContentNode.NAME);
99                          newSubscription.setProperty("toURI", "/");
100                         newSubscription.setProperty("repository", workspace);
101                         newSubscription.setProperty("fromURI", "/");
102                     }
103                 }
104             }
105         }
106     }
107 }