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.ui;
35  
36  import info.magnolia.module.InstallStatus;
37  import info.magnolia.module.ModuleManagementException;
38  import info.magnolia.module.ModuleManager;
39  
40  import java.io.Writer;
41  
42  /**
43   * An implementation of ModuleManagerUI which does everything by itself,
44   * with no human intervention and simply logs its results.
45   */
46  public class ModuleManagerNullUI implements ModuleManagerUI {
47      private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(ModuleManagerNullUI.class);
48  
49      private final ModuleManager moduleManager;
50  
51      public ModuleManagerNullUI(ModuleManager moduleManager) {
52          this.moduleManager = moduleManager;
53      }
54  
55      @Override
56      public void onStartup() throws ModuleManagementException {
57          final ModuleManager.ModuleManagementState moduleMgtState = moduleManager.getStatus();
58          if (moduleMgtState.needsUpdateOrInstall()) {
59              log.info("\n" +
60                      "*********************************************************************************************************\n" +
61                      "*                                                                                                       *\n" +
62                      "* Magnolia needs module updates or installs, and the magnolia.update.auto property is set to true,      *\n" +
63                      "* so they will be applied automatically now.                                                            *\n" +
64                      "*                                                                                                       *\n" +
65                      "*********************************************************************************************************");
66              moduleManager.performInstallOrUpdate();
67              final InstallStatus status = moduleManager.getInstallContext().getStatus();
68              if (!InstallStatus.installDone.equals(status)) {
69                  log.warn("Install could not be performed. Please check your logs and fix the appropriate issues before trying again.");
70                  return;
71              }
72              moduleManager.startModules();
73          } else {
74              moduleManager.startModules();
75          }
76      }
77  
78      @Override
79      public boolean execute(Writer out, String command) throws ModuleManagementException {
80          throw new IllegalStateException("This implementation of ModuleManagerUI is only meant to be used at startup.");
81      }
82  
83      @Override
84      public void renderTempPage(Writer out) {
85          throw new IllegalStateException("This implementation of ModuleManagerUI is only meant to be used at startup.");
86      }
87  }