View Javadoc

1   /**
2    * This file Copyright (c) 2003-2012 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.exchangesimple.setup;
35  
36  import info.magnolia.cms.core.MgnlNodeType;
37  import info.magnolia.cms.security.SecurityUtil;
38  import info.magnolia.module.DefaultModuleVersionHandler;
39  import info.magnolia.module.InstallContext;
40  import info.magnolia.module.delta.AbstractTask;
41  import info.magnolia.module.delta.ArrayDelegateTask;
42  import info.magnolia.module.delta.BootstrapSingleModuleResource;
43  import info.magnolia.module.delta.BootstrapSingleResource;
44  import info.magnolia.module.delta.Condition;
45  import info.magnolia.module.delta.CreateNodeTask;
46  import info.magnolia.module.delta.DeltaBuilder;
47  import info.magnolia.module.delta.FilterOrderingTask;
48  import info.magnolia.module.delta.IsAuthorInstanceDelegateTask;
49  import info.magnolia.module.delta.SetPropertyTask;
50  import info.magnolia.module.delta.Task;
51  import info.magnolia.module.delta.TaskExecutionException;
52  //import info.magnolia.module.delta.WebXmlConditionsUtil;
53  //import info.magnolia.module.delta.WorkspaceXmlConditionsUtil;
54  import info.magnolia.repository.RepositoryConstants;
55  //import info.magnolia.setup.SystemTmpDirCondition;
56  
57  import java.security.NoSuchAlgorithmException;
58  import java.util.ArrayList;
59  import java.util.List;
60  
61  /**
62   * VersionHandler of the ExchangeSimple module.
63   *
64   * @version $Id$
65   */
66  public class ExchangeSimpleModuleVersionHandler extends DefaultModuleVersionHandler {
67      private final Task createEmptyActivationConfig = new ArrayDelegateTask("Activation configuration", "Creates an empty activation configuration", new Task[] {
68              new CreateNodeTask("Activation configuration", "Creates empty activation configuration", RepositoryConstants.CONFIG, "/server", "activation", MgnlNodeType.NT_CONTENT),
69              new SetPropertyTask(RepositoryConstants.CONFIG, "/server/activation", "class", info.magnolia.module.exchangesimple.DefaultActivationManager.class.getName()),
70              new CreateNodeTask("Activation configuration", "Creates empty subscribers node", RepositoryConstants.CONFIG, "/server/activation", "subscribers", MgnlNodeType.NT_CONTENT)
71      });
72  
73      public ExchangeSimpleModuleVersionHandler() {
74          super();
75  
76          register(DeltaBuilder.checkPrecondition("4.4.6", "4.5"));
77  
78          register(DeltaBuilder.update("4.5", "URL of activation filter is no longer password protected but uses encryption instead.")
79                  .addTask(new BootstrapSingleModuleResource("Configure ActivationPage", "Register class to be used.", "config.modules.exchange-simple.pages.activationPage.xml"))
80                  .addTask(new BootstrapSingleModuleResource("ActivationPage Menu", "Configure menu in AdminInterface.", "config.modules.adminInterface.config.menu.tools.activationPage.xml"))
81                  .addTask(new IsAuthorInstanceDelegateTask("Security update", "Update security keys if on author instance.", new AbstractTask("", "") {
82  
83                      @Override
84                      public void execute(InstallContext installContext) throws TaskExecutionException {
85                          try {
86                              SecurityUtil.updateKeys(SecurityUtil.generateKeyPair(1024));
87                          } catch (NoSuchAlgorithmException e) {
88                              throw new TaskExecutionException(e.getMessage(), e);
89                          }
90                      }
91                  }))
92                  .addTask(new FilterOrderingTask("activation", new String[] { "context", "login", "multipartRequest" })));
93  
94      }
95  
96      @Override
97      protected List<Task> getBasicInstallTasks(InstallContext installContext) {
98          final List<Task> installTasks = new ArrayList<Task>(super.getBasicInstallTasks(installContext));
99          installTasks.add(new FilterOrderingTask("activation", new String[] { "context", "login", "multipartRequest" }));
100         installTasks.add(new IsAuthorInstanceDelegateTask("", "", new BootstrapSingleResource("Bootstrap new activation configuration", "Bootstrap new activation configuration",
101                 "/info/magnolia/module/exchangesimple/setup/config.server.activation.xml"), createEmptyActivationConfig));
102 
103         return installTasks;
104     }
105 
106     @Override
107     protected List<Task> getExtraInstallTasks(InstallContext installContext) {
108         List<Task> tasks = new ArrayList<Task>();
109         tasks.addAll(super.getExtraInstallTasks(installContext));
110         tasks.add(new IsAuthorInstanceDelegateTask("Activation Keys", "Generate new Activation Key Pair.", new AbstractTask("", "") {
111 
112             @Override
113             public void execute(InstallContext installContext) throws TaskExecutionException {
114                 try {
115                     SecurityUtil.updateKeys(SecurityUtil.generateKeyPair(1024));
116                 } catch (NoSuchAlgorithmException e) {
117                     throw new TaskExecutionException(e.getMessage(), e);
118                 }
119             }
120         }));
121 
122         return tasks;
123     }
124     
125     @Override
126     protected List<Condition> getInstallConditions() {
127         final ArrayList<Condition> conditions = new ArrayList<Condition>();
128 
129         conditions.add(new CheckKeyProperty());
130 
131         return conditions;
132     }
133 }