/*
* 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.ui.pages;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import com.google.common.base.Strings;
import com.google.inject.Inject;
import com.google.inject.name.Named;
import org.apache.wicket.Application;
import org.apache.wicket.RestartResponseAtInterceptPageException;
import org.apache.wicket.markup.head.CssReferenceHeaderItem;
import org.apache.wicket.markup.head.IHeaderResponse;
import org.apache.wicket.markup.head.JavaScriptHeaderItem;
import org.apache.wicket.markup.head.JavaScriptReferenceHeaderItem;
import org.apache.wicket.markup.head.OnDomReadyHeaderItem;
import org.apache.wicket.markup.head.PriorityHeaderItem;
import org.apache.wicket.markup.html.WebPage;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.link.ExternalLink;
import org.apache.wicket.markup.html.link.Link;
import org.apache.wicket.model.IModel;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.request.resource.JavaScriptResourceReference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.isis.applib.services.exceprecog.ExceptionRecognizer;
import org.apache.isis.applib.services.exceprecog.ExceptionRecognizerComposite;
import org.apache.isis.core.commons.authentication.AuthenticationSession;
import org.apache.isis.core.commons.authentication.MessageBroker;
import org.apache.isis.core.metamodel.services.ServicesInjectorSpi;
import org.apache.isis.core.metamodel.spec.SpecificationLoaderSpi;
import org.apache.isis.core.runtime.system.context.IsisContext;
import org.apache.isis.core.runtime.system.persistence.PersistenceSession;
import org.apache.isis.viewer.wicket.model.mementos.PageParameterNames;
import org.apache.isis.viewer.wicket.model.models.ApplicationActionsModel;
import org.apache.isis.viewer.wicket.model.models.BookmarkableModel;
import org.apache.isis.viewer.wicket.model.models.BookmarkedPagesModel;
import org.apache.isis.viewer.wicket.ui.ComponentFactory;
import org.apache.isis.viewer.wicket.ui.ComponentType;
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.errors.ExceptionModel;
import org.apache.isis.viewer.wicket.ui.errors.JGrowlUtil;
import org.apache.isis.viewer.wicket.ui.pages.about.AboutPage;
import org.apache.isis.viewer.wicket.ui.pages.login.WicketSignInPage;
import org.apache.isis.viewer.wicket.ui.util.Components;
/**
* Convenience adapter for {@link WebPage}s built up using {@link ComponentType}s.
*/
public abstract class PageAbstract extends WebPage {
private static Logger LOG = LoggerFactory.getLogger(PageAbstract.class);
private static final long serialVersionUID = 1L;
private static final String ID_BOOKMARKED_PAGES = "bookmarks";
private static final String ID_HOME_PAGE_LINK = "homePageLink";
private static final String ID_APPLICATION_NAME = "applicationName";
private static final String ID_USER_NAME = "userName";
private static final String ID_PAGE_TITLE = "pageTitle";
public static final String ID_MENU_LINK = "menuLink";
public static final String ID_LOGOUT_LINK = "logoutLink";
public static final String ID_ABOUT_LINK = "aboutLink";
private static final JavaScriptResourceReference JQUERY_JGROWL_JS = new JavaScriptResourceReference(PageAbstract.class, "jquery.jgrowl.js");
/**
* @see https://github.com/brandonaaron/livequery
*/
private static final JavaScriptResourceReference JQUERY_LIVEQUERY_JS = new JavaScriptResourceReference(PageAbstract.class, "jquery.livequery.js");
private static final JavaScriptResourceReference JQUERY_ISIS_WICKET_VIEWER_JS = new JavaScriptResourceReference(PageAbstract.class, "jquery.isis.wicket.viewer.js");
//private static final JavaScriptResourceReference BOOTSTRAP_JS = new JavaScriptResourceReference(PageAbstract.class, "bootstrap/js/bootstrap.min.js");
/**
* This is a bit hacky, but best way I've found to pass an exception over to the WicketSignInPage
* if there is a problem rendering this page.
*/
public static ThreadLocal<ExceptionModel> EXCEPTION = new ThreadLocal<ExceptionModel>();
private final List<ComponentType> childComponentIds;
private final PageParameters pageParameters;
/**
* {@link Inject}ed when {@link #init() initialized}.
*/
@Inject
@Named("applicationName")
private String applicationName;
/**
* {@link Inject}ed when {@link #init() initialized}.
*/
@Inject
@Named("applicationCss")
private String applicationCss;
/**
* {@link Inject}ed when {@link #init() initialized}.
*/
@Inject
@Named("applicationJs")
private String applicationJs;
protected enum ApplicationActions {
INCLUDE,
EXCLUDE
}
public PageAbstract(final PageParameters pageParameters, ApplicationActions applicationActions, final ComponentType... childComponentIds) {
try {
addApplicationActionsComponent(applicationActions);
this.childComponentIds = Collections.unmodifiableList(Arrays.asList(childComponentIds));
this.pageParameters = pageParameters;
addHomePageLinkAndApplicationName();
addUserName();
addLogoutLink();
addAboutLink();
add(new Label(ID_PAGE_TITLE, PageParameterNames.PAGE_TITLE.getStringFrom(pageParameters, applicationName)));
} catch(RuntimeException ex) {
LOG.error("Failed to construct page, going back to sign in page", ex);
// REVIEW: similar code in WebRequestCycleForIsis
final List<ExceptionRecognizer> exceptionRecognizers = getServicesInjector().lookupServices(ExceptionRecognizer.class);
final String recognizedMessageIfAny = new ExceptionRecognizerComposite(exceptionRecognizers).recognize(ex);
final ExceptionModel exceptionModel = ExceptionModel.create(recognizedMessageIfAny, ex);
getSession().invalidate();
getSession().clear();
// for the WicketSignInPage to render
EXCEPTION.set(exceptionModel);
throw new RestartResponseAtInterceptPageException(WicketSignInPage.class);
}
}
protected ExceptionModel recognizeException(Exception ex) {
List<ExceptionRecognizer> exceptionRecognizers;
try {
exceptionRecognizers = getServicesInjector().lookupServices(ExceptionRecognizer.class);
} catch(Exception ex2) {
LOG.warn("Unable to obtain exceptionRecognizers (no session?)");
exceptionRecognizers = Collections.emptyList();
}
final String recognizedMessageIfAny = new ExceptionRecognizerComposite(exceptionRecognizers).recognize(ex);
return ExceptionModel.create(recognizedMessageIfAny, ex);
}
@Override
public void renderHead(IHeaderResponse response) {
super.renderHead(response);
response.render(new PriorityHeaderItem(JavaScriptHeaderItem.forReference(Application.get().getJavaScriptLibrarySettings().getJQueryReference())));
response.render(new PriorityHeaderItem(JavaScriptReferenceHeaderItem.forReference(JQUERY_JGROWL_JS)));
response.render(new PriorityHeaderItem(JavaScriptReferenceHeaderItem.forReference(JQUERY_LIVEQUERY_JS)));
response.render(new PriorityHeaderItem(JavaScriptReferenceHeaderItem.forReference(JQUERY_ISIS_WICKET_VIEWER_JS)));
final String feedbackMsg = JGrowlUtil.asJGrowlCalls(getMessageBroker());
if (!Strings.isNullOrEmpty(feedbackMsg)) {
final OnDomReadyHeaderItem forScript = OnDomReadyHeaderItem.forScript(feedbackMsg);
response.render(forScript);
}
if(applicationCss != null) {
response.render(CssReferenceHeaderItem.forUrl(applicationCss));
}
if(applicationJs != null) {
response.render(JavaScriptReferenceHeaderItem.forUrl(applicationJs));
}
}
private void addHomePageLinkAndApplicationName() {
// this is a bit hacky, but it'll do...
ExternalLink homePageLink = new ExternalLink(ID_HOME_PAGE_LINK, "/wicket/");
homePageLink.setContextRelative(true);
add(homePageLink);
homePageLink.add(new Label(ID_APPLICATION_NAME, applicationName));
}
private void addUserName() {
add(new Label(ID_USER_NAME, getAuthenticationSession().getUserName()));
}
private void addLogoutLink() {
add(new Link<Object>(ID_LOGOUT_LINK) {
private static final long serialVersionUID = 1L;
@Override
public void onClick() {
getSession().invalidate();
throw new RestartResponseAtInterceptPageException(WicketSignInPage.class);
}
});
}
private void addAboutLink() {
add(new Link<Object>(ID_ABOUT_LINK) {
private static final long serialVersionUID = 1L;
@Override
public void onClick() {
setResponsePage(AboutPage.class);
}
});
}
/**
* As provided in the {@link #PageAbstract(ComponentType) constructor}.
*
* <p>
* This superclass doesn't do anything with this property directly, but
* requiring it to be provided enforces standardization of the
* implementation of the subclasses.
*/
public List<ComponentType> getChildModelTypes() {
return childComponentIds;
}
@Override
public PageParameters getPageParameters() {
return pageParameters;
}
private void addApplicationActionsComponent(final ApplicationActions applicationActions) {
if(applicationActions == ApplicationActions.INCLUDE) {
final ApplicationActionsModel model = new ApplicationActionsModel();
addComponent(ComponentType.APPLICATION_ACTIONS, model);
} else {
Components.permanentlyHide(this, ComponentType.APPLICATION_ACTIONS);
}
}
/**
* For subclasses to call.
*
* <p>
* Should be called in the subclass' constructor.
*
* @param model
* - used to find the best matching {@link ComponentFactory} to
* render the model.
*/
protected void addChildComponents(final IModel<?> model) {
for (final ComponentType componentType : getChildModelTypes()) {
addComponent(componentType, model);
}
}
private void addComponent(final ComponentType componentType, final IModel<?> model) {
getComponentFactoryRegistry().addOrReplaceComponent(this, componentType, model);
}
////////////////////////////////////////////////////////////////
// bookmarked pages
////////////////////////////////////////////////////////////////
/**
* Convenience for subclasses
*/
protected void addBookmarkedPages() {
getComponentFactoryRegistry().addOrReplaceComponent(this, ID_BOOKMARKED_PAGES, ComponentType.BOOKMARKED_PAGES, getBookmarkedPagesModel());
}
protected void bookmarkPage(BookmarkableModel<?> model) {
getBookmarkedPagesModel().bookmarkPage(model);
}
private BookmarkedPagesModel getBookmarkedPagesModel() {
BookmarkedPagesModelProvider application = (BookmarkedPagesModelProvider) getApplication();
return application.getBookmarkedPagesModel();
}
// ///////////////////////////////////////////////////////////////////
// Convenience
// ///////////////////////////////////////////////////////////////////
protected ComponentFactoryRegistry getComponentFactoryRegistry() {
final ComponentFactoryRegistryAccessor cfra = (ComponentFactoryRegistryAccessor) getApplication();
return cfra.getComponentFactoryRegistry();
}
// ///////////////////////////////////////////////////
// System components
// ///////////////////////////////////////////////////
protected ServicesInjectorSpi getServicesInjector() {
return getPersistenceSession().getServicesInjector();
}
protected PersistenceSession getPersistenceSession() {
return IsisContext.getPersistenceSession();
}
protected SpecificationLoaderSpi getSpecificationLoader() {
return IsisContext.getSpecificationLoader();
}
protected AuthenticationSession getAuthenticationSession() {
return IsisContext.getAuthenticationSession();
}
protected MessageBroker getMessageBroker() {
return IsisContext.getMessageBroker();
}
}