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.cms.beans.config;
35  
36  import info.magnolia.cms.core.FileSystemHelper;
37  import info.magnolia.cms.i18n.MessagesManager;
38  import info.magnolia.cms.license.LicenseFileExtractor;
39  import info.magnolia.cms.pddescriptor.ProductDescriptorExtractor;
40  import info.magnolia.module.ModuleManagementException;
41  import info.magnolia.module.ModuleManager;
42  import info.magnolia.module.ModuleRegistry;
43  import info.magnolia.objectfactory.Components;
44  import info.magnolia.objectfactory.configuration.ComponentProviderConfiguration;
45  import info.magnolia.objectfactory.configuration.ComponentProviderConfigurationBuilder;
46  import info.magnolia.objectfactory.guice.GuiceComponentProvider;
47  import info.magnolia.objectfactory.guice.GuiceComponentProviderBuilder;
48  import info.magnolia.repository.RepositoryManager;
49  
50  import javax.inject.Inject;
51  import javax.inject.Singleton;
52  import javax.servlet.ServletContext;
53  
54  import org.apache.commons.lang3.StringUtils;
55  import org.slf4j.Logger;
56  import org.slf4j.LoggerFactory;
57  
58  
59  /**
60   * This class is an entry point to all config.
61   */
62  @Singleton
63  public class ConfigLoader {
64      private static final Logger log = LoggerFactory.getLogger(ConfigLoader.class);
65      private static final String JAAS_PROPERTYNAME = "java.security.auth.login.config";
66  
67      private final ModuleManager moduleManager;
68      private final ModuleRegistry moduleRegistry;
69      private final ProductDescriptorExtractor productDescriptorExtractor;
70      private final MessagesManager messagesManager;
71      private final VersionConfig versionConfig;
72      private GuiceComponentProvider main;
73  
74      /**
75       * Initialize a ConfigLoader instance. All the supplied parameters will be set in
76       * <code>info.magnolia.cms.beans.runtime.SystemProperty</code>
77       *
78       * @param context ServletContext
79       * @see info.magnolia.cms.core.SystemProperty
80       *
81       *      TODO - some of the dependencies here don't belong, we're only calling init() on those, which should be moved to a lifecycle management api (IoC has one)
82       */
83      @Inject
84      public ConfigLoader(ModuleManager moduleManager, ModuleRegistry moduleRegistry, ProductDescriptorExtractor productDescriptorExtractor, MessagesManager messagesManager, VersionConfig versionConfig, ServletContext context) {
85          this.moduleManager = moduleManager;
86          this.moduleRegistry = moduleRegistry;
87          this.productDescriptorExtractor = productDescriptorExtractor;
88          this.messagesManager = messagesManager;
89          this.versionConfig = versionConfig;
90      }
91  
92      /**
93       * @deprecated since 5.4.3, use {@link ConfigLoader#ConfigLoader(info.magnolia.module.ModuleManager, info.magnolia.module.ModuleRegistry, info.magnolia.cms.pddescriptor.ProductDescriptorExtractor, info.magnolia.cms.i18n.MessagesManager, info.magnolia.cms.beans.config.VersionConfig, javax.servlet.ServletContext)} instead.
94       */
95      @Deprecated
96      public ConfigLoader(ModuleManager moduleManager, ModuleRegistry moduleRegistry, LicenseFileExtractor licenseFileExtractor, MessagesManager messagesManager, VersionConfig versionConfig, ServletContext context) {
97          this(moduleManager, moduleRegistry, (ProductDescriptorExtractor) licenseFileExtractor, messagesManager, versionConfig, context);
98      }
99  
100     public void unload() {
101         // See comment in GuiceServletContextListener
102         if (main != null) {
103             Components.setComponentProvider(main.getParent());
104             main.destroy();
105         }
106         Components.getComponent(RepositoryManager.class).shutdown();
107     }
108 
109     public void loadJaasConfig(FileSystemHelper fileSystemHelper) {
110         if (StringUtils.isEmpty(System.getProperty(JAAS_PROPERTYNAME))) {
111             try {
112                 System.setProperty(JAAS_PROPERTYNAME, fileSystemHelper.getAbsoluteFileSystemPath("WEB-INF/config/jaas.config"));
113             } catch (SecurityException se) {
114                 log.error("Failed to set {}, check application server settings", JAAS_PROPERTYNAME);
115                 log.error(se.getMessage(), se);
116                 log.info("Aborting startup");
117                 return;
118             }
119         } else {
120             log.info("JAAS config file set by parent container or some other application");
121             log.info("Config in use {}", System.getProperty(JAAS_PROPERTYNAME));
122             log.info("Please make sure JAAS config has all necessary modules (refer config/jaas.config) configured");
123         }
124     }
125 
126     /**
127      * Load magnolia configuration from repositories.
128      */
129     public void load() {
130         productDescriptorExtractor.init();
131         productDescriptorExtractor.printVersionInfo();
132 
133         final long millis = System.currentTimeMillis();
134         log.info("Initializing content repositories");
135 
136         Components.getComponent(RepositoryManager.class).init();
137 
138         GuiceComponentProviderBuilderroviderBuilder.html#GuiceComponentProviderBuilder">GuiceComponentProviderBuilder builder = new GuiceComponentProviderBuilder();
139         builder.withConfiguration(getMainComponents());
140         builder.withParent((GuiceComponentProvider) Components.getComponentProvider());
141         builder.exposeGlobally();
142         main = builder.build();
143 
144         try {
145             moduleManager.checkForInstallOrUpdates();
146             moduleManager.getUI().onStartup();
147 
148             // TODO use container lifecycle instead of manually calling init() ??
149             messagesManager.init();
150             // TODO : de-staticize MimeMapping
151             MIMEMapping.init();
152             versionConfig.init();
153 
154             // finished
155             log.info("Configuration loaded (took {} seconds)", Long.toString((System.currentTimeMillis() - millis) / 1000));
156 
157         } catch (ModuleManagementException e) {
158             log.error("A module error occurred during initialization: {}", e.getMessage(), e);
159         } catch (ConfigurationException e) {
160             log.error("A configuration error occurred during initialization: {}", e.getMessage(), e);
161         } catch (Throwable e) {
162             log.error("An unspecified error occurred during initialization: {}", e.getMessage(), e);
163         }
164 
165     }
166 
167     protected ComponentProviderConfiguration getMainComponents() {
168         ComponentProviderConfigurationBuilderonBuilder.html#ComponentProviderConfigurationBuilder">ComponentProviderConfigurationBuilder configurationBuilder = new ComponentProviderConfigurationBuilder();
169         return configurationBuilder.getComponentsFromModules("main", moduleRegistry.getModuleDefinitions());
170     }
171 }