/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.isis.viewer.wicket.viewer;
import java.util.Collection;
import java.util.List;
import java.util.ServiceLoader;
import javax.servlet.ServletContext;
import com.google.inject.Guice;
import com.google.inject.Inject;
import com.google.inject.Injector;
import com.google.inject.Module;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.wicket.Application;
import org.apache.wicket.ConverterLocator;
import org.apache.wicket.IConverterLocator;
import org.apache.wicket.Page;
import org.apache.wicket.RuntimeConfigurationType;
import org.apache.wicket.authroles.authentication.AuthenticatedWebApplication;
import org.apache.wicket.authroles.authentication.AuthenticatedWebSession;
import org.apache.wicket.guice.GuiceComponentInjector;
import org.apache.wicket.markup.html.WebPage;
import org.apache.wicket.request.Request;
import org.apache.wicket.request.Response;
import org.apache.wicket.settings.IRequestCycleSettings.RenderStrategy;
import org.apache.isis.core.commons.authentication.AuthenticationSession;
import org.apache.isis.core.commons.authentication.AuthenticationSessionProvider;
import org.apache.isis.core.commons.authentication.AuthenticationSessionProviderAware;
import org.apache.isis.core.commons.config.IsisConfiguration;
import org.apache.isis.core.commons.config.IsisConfigurationBuilder;
import org.apache.isis.core.commons.config.IsisConfigurationBuilderPrimer;
import org.apache.isis.core.commons.config.IsisConfigurationBuilderResourceStreams;
import org.apache.isis.core.commons.resource.ResourceStreamSourceComposite;
import org.apache.isis.core.commons.resource.ResourceStreamSourceContextLoaderClassPath;
import org.apache.isis.core.commons.resource.ResourceStreamSourceCurrentClassClassPath;
import org.apache.isis.core.commons.resource.ResourceStreamSourceFileSystem;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.core.metamodel.adapter.oid.Oid;
import org.apache.isis.core.metamodel.facets.actions.homepage.HomePageFacet;
import org.apache.isis.core.metamodel.services.ServiceUtil;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import org.apache.isis.core.runtime.logging.IsisLoggingConfigurer;
import org.apache.isis.core.runtime.runner.IsisInjectModule;
import org.apache.isis.core.runtime.system.DeploymentType;
import org.apache.isis.core.runtime.system.IsisSystem;
import org.apache.isis.core.runtime.system.context.IsisContext;
import org.apache.isis.core.webapp.IsisWebAppBootstrapperUtil;
import org.apache.isis.core.webapp.WebAppConstants;
import org.apache.isis.core.webapp.config.ResourceStreamSourceForWebInf;
import org.apache.isis.viewer.wicket.model.isis.WicketViewerSettings;
import org.apache.isis.viewer.wicket.model.mementos.ObjectAdapterMemento;
import org.apache.isis.viewer.wicket.model.models.BookmarkedPagesModel;
import org.apache.isis.viewer.wicket.model.models.ImageResourceCache;
import org.apache.isis.viewer.wicket.model.models.PageType;
import org.apache.isis.viewer.wicket.ui.ComponentFactory;
import org.apache.isis.viewer.wicket.ui.app.registry.ComponentFactoryRegistrar;
import org.apache.isis.viewer.wicket.ui.app.registry.ComponentFactoryRegistry;
import org.apache.isis.viewer.wicket.ui.app.registry.ComponentFactoryRegistryAccessor;
import org.apache.isis.viewer.wicket.ui.pages.BookmarkedPagesModelProvider;
import org.apache.isis.viewer.wicket.ui.pages.PageClassList;
import org.apache.isis.viewer.wicket.ui.pages.PageClassRegistry;
import org.apache.isis.viewer.wicket.ui.pages.PageClassRegistryAccessor;
import org.apache.isis.viewer.wicket.viewer.integration.isis.DeploymentTypeWicketAbstract;
import org.apache.isis.viewer.wicket.viewer.integration.isis.WicketServer;
import org.apache.isis.viewer.wicket.viewer.integration.isis.WicketServerPrototype;
import org.apache.isis.viewer.wicket.viewer.integration.wicket.AuthenticatedWebSessionForIsis;
import org.apache.isis.viewer.wicket.viewer.integration.wicket.ConverterForObjectAdapter;
import org.apache.isis.viewer.wicket.viewer.integration.wicket.ConverterForObjectAdapterMemento;
import org.apache.isis.viewer.wicket.viewer.integration.wicket.WebRequestCycleForIsis;
/**
* Main application, subclassing the Wicket {@link Application} and
* bootstrapping Isis.
*
* <p>
* Its main responsibility is to allow the set of {@link ComponentFactory}s used
* to render the domain objects to be registered. This type of customisation is
* commonplace. At a more fundamental level, also allows the {@link Page}
* implementation for each {@link PageType page type} to be overridden. This is
* probably less common, because CSS can also be used for this purpose.
*
* <p>
* New {@link ComponentFactory}s can be specified in two ways. The preferred
* approach is to use the {@link ServiceLoader} mechanism, whereby the
* {@link ComponentFactory} implementation class is specified in a file under
* <tt>META-INF/services</tt>. See <tt>views-gmaps2</tt> for an example of this.
* Including a jar that uses this mechanism on the classpath will automatically
* make the {@link ComponentFactory} defined within it available.
*
* <p>
* Alternatively, {@link ComponentFactory}s can be specified by overridding
* {@link #newComponentFactoryList()}. This offers more fine-grained control for
* the ordering, but is more fiddly.
*
* <p>
* There are also a number of other pluggable hooks (similar way to other Wicket
* customizations)
* <ul>
* <li> {@link #newComponentFactoryList()} (mentioned above)</li>
* <li> {@link #newComponentFactoryRegistry()} (uses the
* {@link ComponentFactoryRegistrar} provided by {@link #newComponentFactoryList()})</li>
* <li> {@link #newPageClassList()}</li>
* <li> {@link #newPageRegistry()} (uses the {@link PageClassList} provided by
* {@link #newPageClassList()})</li>
* <li> {@link #newConverterLocator()} (probably should not be changed.)</li>
* <li> {@link #newRequestCycle(Request, Response)} (probably should not be
* changed.)</li>
* </ul>
*/
public class IsisWicketApplication extends AuthenticatedWebApplication implements ComponentFactoryRegistryAccessor, PageClassRegistryAccessor, AuthenticationSessionProvider, BookmarkedPagesModelProvider {
private static final long serialVersionUID = 1L;
private static final Logger LOG = LoggerFactory.getLogger(IsisWicketApplication.class);
private final IsisLoggingConfigurer loggingConfigurer = new IsisLoggingConfigurer();
/**
* Convenience locator, downcasts inherited functionality.
*/
public static IsisWicketApplication get() {
return (IsisWicketApplication) AuthenticatedWebApplication.get();
}
/**
* {@link Inject}ed when {@link #init() initialized}.
*/
@Inject
private ComponentFactoryRegistry componentFactoryRegistry;
/**
* {@link Inject}ed when {@link #init() initialized}.
*/
@SuppressWarnings("unused")
@Inject
private ImageResourceCache imageCache;
/**
* {@link Inject}ed when {@link #init() initialized}.
*/
@SuppressWarnings("unused")
@Inject
private WicketViewerSettings wicketViewerSettings;
/**
* {@link Inject}ed when {@link #init() initialized}.
*/
@Inject
private PageClassRegistry pageClassRegistry;
/**
* {@link Inject}ed when {@link #init() initialized}.
*/
@SuppressWarnings("unused")
@Inject
private IsisSystem system;
private BookmarkedPagesModel bookmarkedPagesModel;
private boolean determiningDeploymentType;
private DeploymentTypeWicketAbstract deploymentType;
// /////////////////////////////////////////////////
// constructor, init
// /////////////////////////////////////////////////
public IsisWicketApplication() {
}
/**
* Initializes the application; in particular, bootstrapping the Isis
* backend, and initializing the {@link ComponentFactoryRegistry} to be used
* for rendering.
*/
@Override
protected void init() {
try {
super.init();
final String webInfDir = getServletContext().getRealPath("/WEB-INF");
loggingConfigurer.configureLogging(webInfDir, new String[0]);
getRequestCycleSettings().setRenderStrategy(RenderStrategy.REDIRECT_TO_RENDER);
getRequestCycleListeners().add(new WebRequestCycleForIsis());
getResourceSettings().setParentFolderPlaceholder("$up$");
determineDeploymentTypeIfRequired();
final IsisConfigurationBuilder isisConfigurationBuilder = createConfigBuilder();
final IsisInjectModule isisModule = newIsisModule(deploymentType, isisConfigurationBuilder);
final Injector injector = Guice.createInjector(isisModule, newIsisWicketModule());
injector.injectMembers(this);
final IsisConfiguration configuration = isisConfigurationBuilder.getConfiguration();
this.getMarkupSettings().setStripWicketTags(determineStripWicketTags(configuration));
this.bookmarkedPagesModel = new BookmarkedPagesModel();
initWicketComponentInjection(injector);
} catch(RuntimeException ex) {
// because Wicket's handling in its WicketFilter (that calls this method) does not log the exception.
LOG.error("Failed to initialize", ex);
throw ex;
}
}
private void determineDeploymentTypeIfRequired() {
if(deploymentType != null) {
return;
}
determiningDeploymentType = true;
try {
final IsisConfigurationBuilder isisConfigurationBuilder = createConfigBuilder();
final IsisConfiguration configuration = isisConfigurationBuilder.getConfiguration();
String deploymentTypeFromConfig = configuration.getString("isis.deploymentType");
deploymentType = determineDeploymentType(deploymentTypeFromConfig);
} finally {
determiningDeploymentType = false;
}
}
private boolean determineStripWicketTags(IsisConfiguration configuration) {
final boolean strip = configuration.getBoolean("isis.viewer.wicket.stripWicketTags", true);
return strip;
}
@Override
protected void onDestroy() {
try {
IsisContext.shutdown();
super.onDestroy();
} catch(final RuntimeException ex) {
// symmetry with #init()
LOG.error("Failed to destroy", ex);
throw ex;
}
}
@Override
public RuntimeConfigurationType getConfigurationType() {
if(determiningDeploymentType) {
// avoiding an infinite loop; have already passed through here once before
// this time around, just delegate to web-inf
return super.getConfigurationType();
}
determineDeploymentTypeIfRequired();
return deploymentType.getConfigurationType();
}
protected IsisInjectModule newIsisModule(final DeploymentType deploymentType, final IsisConfigurationBuilder isisConfigurationBuilder) {
return new IsisInjectModule(deploymentType, isisConfigurationBuilder);
}
private DeploymentTypeWicketAbstract determineDeploymentType(String deploymentTypeFromConfig) {
final DeploymentTypeWicketAbstract prototype = new WicketServerPrototype();
final DeploymentTypeWicketAbstract deployment = new WicketServer();
if(deploymentTypeFromConfig != null) {
final DeploymentType deploymentType = DeploymentType.lookup(deploymentTypeFromConfig);
return !deploymentType.getDeploymentCategory().isProduction()
? prototype
: deployment;
} else {
return usesDevelopmentConfig()
? prototype
: deployment;
}
}
private IsisConfigurationBuilder createConfigBuilder() {
return createConfigBuilder(getServletContext());
}
protected IsisConfigurationBuilder createConfigBuilder(final ServletContext servletContext) {
final String configLocation = servletContext.getInitParameter(WebAppConstants.CONFIG_DIR_PARAM);
final ResourceStreamSourceForWebInf rssWebInf = new ResourceStreamSourceForWebInf(servletContext);
final ResourceStreamSourceContextLoaderClassPath rssContextLoaderClassPath = ResourceStreamSourceContextLoaderClassPath.create();
final ResourceStreamSourceCurrentClassClassPath rssCurrentClassPath = new ResourceStreamSourceCurrentClassClassPath();
final ResourceStreamSourceComposite compositeSource = new ResourceStreamSourceComposite(rssWebInf, rssContextLoaderClassPath, rssCurrentClassPath);
if ( configLocation != null ) {
LOG.info( "Config override location: " + configLocation );
compositeSource.addResourceStreamSource(ResourceStreamSourceFileSystem.create(configLocation));
} else {
LOG.info( "Config override location: No override location configured!" );
}
final IsisConfigurationBuilder configurationBuilder = new IsisConfigurationBuilderResourceStreams(compositeSource);
primeConfigurationBuilder(configurationBuilder, servletContext);
configurationBuilder.addDefaultConfigurationResources();
IsisWebAppBootstrapperUtil.addConfigurationResourcesForViewers(configurationBuilder, servletContext);
return configurationBuilder;
}
@SuppressWarnings("unchecked")
private static void primeConfigurationBuilder(final IsisConfigurationBuilder isisConfigurationBuilder, final ServletContext servletContext) {
final List<IsisConfigurationBuilderPrimer> isisConfigurationBuilderPrimers = (List<IsisConfigurationBuilderPrimer>) servletContext.getAttribute(WebAppConstants.CONFIGURATION_PRIMERS_KEY);
if (isisConfigurationBuilderPrimers == null) {
return;
}
for (final IsisConfigurationBuilderPrimer isisConfigurationBuilderPrimer : isisConfigurationBuilderPrimers) {
isisConfigurationBuilderPrimer.primeConfigurationBuilder(isisConfigurationBuilder);
}
}
protected void initWicketComponentInjection(final Injector injector) {
getComponentInstantiationListeners().add(new GuiceComponentInjector(this, injector));
}
/**
* Override if required
*/
protected Module newIsisWicketModule() {
return new IsisWicketModule();
}
// /////////////////////////////////////////////////
// Wicket Hooks
// /////////////////////////////////////////////////
/**
* Installs a {@link AuthenticatedWebSessionForIsis custom implementation}
* of Wicket's own {@link AuthenticatedWebSession}, effectively associating
* the Wicket session with the Isis's equivalent session object.
*
* <p>
* In general, it shouldn't be necessary to override this method.
*/
@Override
protected Class<? extends AuthenticatedWebSession> getWebSessionClass() {
return AuthenticatedWebSessionForIsis.class;
}
/**
* Installs a {@link ConverterLocator} preconfigured with a number of
* implementations to support Isis specific objects.
*/
@Override
protected IConverterLocator newConverterLocator() {
final ConverterLocator converterLocator = new ConverterLocator();
converterLocator.set(ObjectAdapter.class, new ConverterForObjectAdapter());
converterLocator.set(ObjectAdapterMemento.class, new ConverterForObjectAdapterMemento());
return converterLocator;
}
// /////////////////////////////////////////////////
// Component Factories
// /////////////////////////////////////////////////
/**
* The {@link ComponentFactoryRegistry} created in
* {@link #newComponentFactoryRegistry()}.
*/
@Override
public final ComponentFactoryRegistry getComponentFactoryRegistry() {
return componentFactoryRegistry;
}
// /////////////////////////////////////////////////
// Page Registry
// /////////////////////////////////////////////////
/**
* Access to other page types.
*
* <p>
* Non-final only for testing purposes; should not typically be overridden.
*/
@Override
public PageClassRegistry getPageClassRegistry() {
return pageClassRegistry;
}
/**
* Delegates to the {@link #getPageClassRegistry() PageClassRegistry}.
*/
@Override
public Class<? extends Page> getHomePage() {
return getPageClassRegistry().getPageClass(PageType.HOME);
}
/**
* Delegates to the {@link #getPageClassRegistry() PageClassRegistry}.
*/
@SuppressWarnings("unchecked")
@Override
public Class<? extends WebPage> getSignInPageClass() {
return (Class<? extends WebPage>) getPageClassRegistry().getPageClass(PageType.SIGN_IN);
}
// /////////////////////////////////////////////////
// Authentication Session
// /////////////////////////////////////////////////
@Override
public AuthenticationSession getAuthenticationSession() {
return IsisContext.getAuthenticationSession();
}
// /////////////////////////////////////////////////
// Breadcrumbs support
// /////////////////////////////////////////////////
@Override
public BookmarkedPagesModel getBookmarkedPagesModel() {
return bookmarkedPagesModel;
}
// /////////////////////////////////////////////////
// *Provider impl.
// /////////////////////////////////////////////////
@Override
public void injectInto(final Object candidate) {
if (AuthenticationSessionProviderAware.class.isAssignableFrom(candidate.getClass())) {
final AuthenticationSessionProviderAware cast = AuthenticationSessionProviderAware.class.cast(candidate);
cast.setAuthenticationSessionProvider(this);
}
}
}