*  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.

*/

* Convenience adapter for {@link WebPage}s built up using {@link ComponentType}s.

*/

    private static Logger LOG = LoggerFactory.getLogger(PageAbstract.class);

    private static final long serialVersionUID = 1L;

    private static final JavaScriptResourceReference JQUERY_JGROWL_JS = new JavaScriptResourceReference(PageAbstract.class, "jquery.jgrowl.js");

    private static final String REGULAR_CASE_KEY = "isis.viewer.wicket.regularCase";

    /**

     * @see  http://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");

    private static final String ID_THEME = "theme";

    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_ACTION_PROMPT_MODAL_WINDOW = "actionPromptModalWindow";

   

    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_LOGOUT_TEXT = "logoutText";

    public static final String ID_ABOUT_LINK = "aboutLink";

    private static final String ID_COPY_LINK = "copyLink";

    private static final String ID_BREADCRUMBS = "breadcrumbs";

    /**

     * 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;

    /**

     * {@link Inject}ed when {@link #init() initialized}.

     */

    @Inject

    private PageClassRegistry pageClassRegistry;

    protected enum ApplicationActions {

        INCLUDE,

        EXCLUDE

    }

   

    public PageAbstract(

            final PageParameters pageParameters,

            final ApplicationActions applicationActions,

            final String title,

            final ComponentType... childComponentIds) {

        try {

            // for breadcrumbs support

            getSession().bind();

           

            setTitle(title);

           

            themeDiv = new WebMarkupContainer(ID_THEME);

            add(themeDiv);

            if(applicationName != null) {

                themeDiv.add(new CssClassAppender(asCssStyle(applicationName)));

            }

           

            addApplicationActions(themeDiv, applicationActions);

            this.childComponentIds = Collections.unmodifiableList(Arrays.asList(childComponentIds));

            this.pageParameters = pageParameters;

            addHomePageLinkAndApplicationName();

            addUserName();

            addLogoutLink();

            addAboutLink();

            addBreadcrumbs();

            addCopyLink();

            // ensure that all collected JavaScript contributions are loaded at the page footer

            add(new HeaderResponseContainer("footerJS", "footerJS"));

           

        } 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(getSignInPage());

        }

    }

    protected void setTitle(final String title) {

        addOrReplace(new Label(ID_PAGE_TITLE, title != null? title: applicationName));

    }

    private Class<? extends Page> getSignInPage() {

        return pageClassRegistry.getPageClass(PageType.SIGN_IN);

    }

    private static String asCssStyle(final String str) {

        return StringExtensions.asLowerDashed(str);

    }

    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(CssReferenceHeaderItem.forReference(new CssResourceReference(PageAbstract.class, "cssreset.css"))));

       

        // the following line, using wicket-webjars, does work, but renders slightly differently

        // (even though the link is rendered in same place as when having the link directly in PageAbstract.html)

        // I'm guessing that our bootstrap is customized (was not a 'vanilla' installation).

        // Am therefore continuing to use our own copy, linked from PageAbstract.html, and have commented the line below out.

        //

        // NB: the use of 'current' in the link means to use the version referenced in the pom.xml.

       

        //response.render(new PriorityHeaderItem(CssHeaderItem.forReference(new WebjarsCssResourceReference("bootstrap/current/css/bootstrap.css"))));

       

        response.render(JavaScriptReferenceHeaderItem.forReference(JQUERY_JGROWL_JS));

        response.render(JavaScriptReferenceHeaderItem.forReference(JQUERY_LIVEQUERY_JS));

        response.render(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);

        }

       

       

        // overlays

        if(getConfiguration().getBoolean(REGULAR_CASE_KEY, false)) {

            response.render(CssReferenceHeaderItem.forReference(PanelUtil.cssResourceReferenceFor(Overlays.class, "regular-case")));

        }

        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);

        themeDiv.add(homePageLink);

        homePageLink.add(new Label(ID_APPLICATION_NAME, applicationName));

    }

   

    private void addUserName() {

        themeDiv.add(new Label(ID_USER_NAME, getAuthenticationSession().getUserName()));

    }

    private void addLogoutLink() {

        themeDiv.add(new Link<Object>(ID_LOGOUT_LINK) {

            private static final long serialVersionUID = 1L;

            @Override

            public void onClick() {

                getSession().invalidate();

                setResponsePage(getSignInPage());

            }

        });

    }

    private void addAboutLink() {

        themeDiv.add(new Link<Object>(ID_ABOUT_LINK) {

            private static final long serialVersionUID = 1L;

            @Override

            public void onClick() {

                setResponsePage(AboutPage.class);

            }

        });

    }

    private void addBreadcrumbs() {

        BreadcrumbPanel breadcrumbPanel = new BreadcrumbPanel(ID_BREADCRUMBS);

        themeDiv.addOrReplace(breadcrumbPanel);

    }

   

    private void addCopyLink() {

        ZeroClipboardPanel zClipCopyLink = new ZeroClipboardPanel(ID_COPY_LINK);

        themeDiv.addOrReplace(zClipCopyLink);

    }

   

    /**

     * As provided in the {@link #PageAbstract(org.apache.wicket.request.mapper.parameter.PageParameters, org.apache.isis.viewer.wicket.ui.pages.PageAbstract.ApplicationActions, String, org.apache.isis.viewer.wicket.ui.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 addApplicationActions(MarkupContainer container, final ApplicationActions applicationActions) {

        if(applicationActions == ApplicationActions.INCLUDE) {

            addActionPromptModalWindow();

            final ApplicationActionsModel model = new ApplicationActionsModel();

            model.setActionPromptProvider(this);

            addComponent(container, ComponentType.APPLICATION_ACTIONS, model);

        } else {

            Components.permanentlyHide(container, ComponentType.APPLICATION_ACTIONS);

            Components.permanentlyHide(container, ID_ACTION_PROMPT_MODAL_WINDOW);

        }

    }

    /**

     * 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(MarkupContainer container, final IModel<?> model) {

        for (final ComponentType componentType : getChildModelTypes()) {

            addComponent(container, componentType, model);

        }

    }

    private void addComponent(MarkupContainer container, final ComponentType componentType, final IModel<?> model) {

        getComponentFactoryRegistry().addOrReplaceComponent(container, componentType, model);

    }

    ////////////////////////////////////////////////////////////////

    // bookmarked pages

    ////////////////////////////////////////////////////////////////

    /**

     * Convenience for subclasses

     */

    protected void addBookmarkedPages() {

        getComponentFactoryRegistry().addOrReplaceComponent(themeDiv, ID_BOOKMARKED_PAGES, ComponentType.BOOKMARKED_PAGES, getBookmarkedPagesModel());

    }

    protected void bookmarkPage(BookmarkableModel<?> model) {

        getBookmarkedPagesModel().bookmarkPage(model);

    }

    protected void removeAnyBookmark(EntityModel model) {

        getBookmarkedPagesModel().remove(model);

    }

    private BookmarkedPagesModel getBookmarkedPagesModel() {

        BookmarkedPagesModelProvider session = (BookmarkedPagesModelProvider) getSession();

        return session.getBookmarkedPagesModel();

    }

    // ///////////////////////////////////////////////////////////////////

    // ActionPromptModalWindowProvider

    // ///////////////////////////////////////////////////////////////////

   

    private ActionPromptModalWindow actionPromptModalWindow;

    protected MarkupContainer themeDiv;

    public ActionPrompt getActionPrompt() {

        return ActionPromptModalWindow.getActionPromptModalWindowIfEnabled(actionPromptModalWindow);

    }

    private void addActionPromptModalWindow() {

        actionPromptModalWindow = ActionPromptModalWindow.newModalWindow(ID_ACTION_PROMPT_MODAL_WINDOW);

        themeDiv.addOrReplace(actionPromptModalWindow);

    }

   

    // ///////////////////////////////////////////////////////////////////

    // UI Hint

    // ///////////////////////////////////////////////////////////////////

    /**

     * Propogates all {@link org.apache.isis.viewer.wicket.model.hints.IsisEventLetterAbstract letter} events down to

     * all child components, wrapped in an {@link org.apache.isis.viewer.wicket.model.hints.IsisEnvelopeEvent envelope} event.

     */

    public void onEvent(org.apache.wicket.event.IEvent<?> event) {

        Object payload = event.getPayload();

        if(payload instanceof IsisEventLetterAbstract) {

            IsisEventLetterAbstract letter = (IsisEventLetterAbstract)payload;

            IsisEnvelopeEvent broadcastEv = new IsisEnvelopeEvent(letter);

            send(this, Broadcast.BREADTH, broadcastEv);

        }

    }

   

    // ///////////////////////////////////////////////////////////////////

    // 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();

    }

   

    protected IsisConfiguration getConfiguration() {

        return IsisContext.getConfiguration();

    }

}