com.foreach.across.modules.adminweb.ui.AdminWebLayoutTemplate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of admin-web-module Show documentation
There is a newer version: 6.0.0
/*
 * Copyright 2014 the original author or authors
 *
 * Licensed 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 com.foreach.across.modules.adminweb.ui;

import com.foreach.across.core.development.AcrossDevelopmentMode;
import com.foreach.across.modules.adminweb.AdminWeb;
import com.foreach.across.modules.adminweb.menu.AdminMenu;
import com.foreach.across.modules.adminweb.resource.AdminWebWebResources;
import com.foreach.across.modules.bootstrapui.styles.AcrossBootstrapStyles;
import com.foreach.across.modules.web.menu.Menu;
import com.foreach.across.modules.web.menu.MenuFactory;
import com.foreach.across.modules.web.resource.WebResource;
import com.foreach.across.modules.web.resource.WebResourceRegistry;
import com.foreach.across.modules.web.resource.WebResourceRule;
import com.foreach.across.modules.web.template.LayoutTemplateProcessorAdapterBean;
import com.foreach.across.modules.web.template.WebTemplateRegistry;
import lombok.Getter;
import lombok.Setter;
import org.apache.commons.lang3.ArrayUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.ModelAndView;
import org.thymeleaf.spring6.SpringTemplateEngine;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.util.Map;
import java.util.Optional;
import java.util.function.Predicate;

import static com.foreach.across.modules.bootstrapui.ui.factories.BootstrapViewElements.bootstrap;

/**
 * Represents the admin web layout with top and left navigation.
 * Will also register static paths and admin web root path as javascript data values.
 *
 * @author Arne Vandamme
 * @since 2.1.0
 */
@ConditionalOnBean(SpringTemplateEngine.class)
@Component
public class AdminWebLayoutTemplate extends LayoutTemplateProcessorAdapterBean
{
	/**
	 * Nav positions used in this layout.
	 */
	public static final String NAVBAR = "navbar";
	public static final String NAVBAR_RIGHT = "navbar-right";
	public static final String SIDEBAR = "sidebar";

	/**
	 * Model attributes for different navigational components.
	 */
	public static final String MODEL_ATTR_NAVBAR = "adminWebNavbarNavigation";
	public static final String MODEL_ATTR_NAVBAR_RIGHT = "adminWebNavbarRightNavigation";
	public static final String MODEL_ATTR_SIDEBAR = "adminWebSidebarNavigation";
	public static final String MODEL_ATTR_BREADCRUMB = "adminWebBreadcrumb";

	/**
	 * Should the {@link Menu#getPath()} value be included as data attribute on nav components.
	 * By default this will be enabled if {@link AcrossDevelopmentMode} is active.
	 */
	@Setter
	@Getter
	private boolean includeNavPathAsDataAttribute = false;

	/**
	 * Create a default template.
	 */
	public AdminWebLayoutTemplate() {
		this( AdminWeb.NAME, AdminWeb.LAYOUT_TEMPLATE );
	}

	/**
	 * Create a new {@link AdminWebLayoutTemplate} implementation with a specific name and layout template.
	 *
	 * @param name           of this layout
	 * @param layoutTemplate view template to use
	 */
	public AdminWebLayoutTemplate( String name, String layoutTemplate ) {
		super( name, layoutTemplate );
	}

	@Autowired
	void registerAdminWebLayoutTemplate( WebTemplateRegistry adminWebTemplateRegistry ) {
		adminWebTemplateRegistry.register( this );
	}

	@Autowired
	void activateDevelopmentMode( AcrossDevelopmentMode acrossDevelopmentMode ) {
		includeNavPathAsDataAttribute = acrossDevelopmentMode.isActive();
	}

	@Override
	protected void registerWebResources( WebResourceRegistry registry ) {
		registry.apply(
				WebResourceRule.addPackage( AdminWebWebResources.NAME ),
				WebResourceRule.add( WebResource.css( "@static:/adminweb/css/adminweb.css" ) ).withKey( AdminWeb.MODULE ).toBucket( WebResource.CSS )
		);
	}

	@Override
	protected void buildMenus( MenuFactory menuFactory ) {
		// todo only build the menu if a user is authenticated
		menuFactory.buildMenu( AdminMenu.NAME, AdminMenu.class );
	}

	@Override
	public void applyTemplate( HttpServletRequest request,
	                           HttpServletResponse response,
	                           Object handler,
	                           ModelAndView modelAndView ) {
		if ( modelAndView != null ) {
			Map model = modelAndView.getModel();
			AdminMenu adminMenu = (AdminMenu) request.getAttribute( AdminMenu.NAME );

			if ( adminMenu != null ) {
				model.computeIfAbsent(
						MODEL_ATTR_NAVBAR,
						key -> bootstrap.builders.nav()
						                         .menu( adminMenu )
						                         .navbar()
						                         .keepGroupsAsGroup( true )
						                         .replaceGroupBySelectedItem( false )
						                         .includePathAsDataAttribute( isIncludeNavPathAsDataAttribute() )
						                         .filter( navPosition( NAVBAR, true ) )
						                         .css( "navbar-nav axu-mr-auto" )
						                         .build()
				);
				model.computeIfAbsent(
						MODEL_ATTR_NAVBAR_RIGHT,
						key -> bootstrap.builders.nav()
						                         .menu( adminMenu )
						                         .navbar()
						                         .css( "navbar-nav" )
						                         .keepGroupsAsGroup( true )
						                         .replaceGroupBySelectedItem( false )
						                         .includePathAsDataAttribute( isIncludeNavPathAsDataAttribute() )
						                         .filter( navPosition( NAVBAR_RIGHT, false ) )
						                         .build()
				);
				model.computeIfAbsent(
						MODEL_ATTR_SIDEBAR,
						key -> bootstrap.builders.panels()
						                         .menu( adminMenu )
						                         .keepGroupsAsGroup( true )
						                         .includePathAsDataAttribute( isIncludeNavPathAsDataAttribute() )
						                         .filter( navPosition( SIDEBAR, true ) )
						                         .build()
						                         .set( AcrossBootstrapStyles.css.flex.nowrap )
				);
				model.computeIfAbsent(
						MODEL_ATTR_BREADCRUMB,
						key -> bootstrap.builders
								.breadcrumb()
								.menu( adminMenu )
								.includePathAsDataAttribute( isIncludeNavPathAsDataAttribute() )
								.filter( item -> !Boolean.FALSE.equals( item.getAttribute( AdminMenu.ATTR_BREADCRUMB ) ) )
								.build()
				);
			}

			super.applyTemplate( request, response, handler, modelAndView );
		}
	}

	@SuppressWarnings("all")
	private Predicate navPosition( String position, boolean defaultInclude ) {
		return menu ->
				Optional.ofNullable( menu.getAttribute( AdminMenu.ATTR_NAV_POSITION ) )
				        .map(
						        value -> value instanceof String[]
								        ? ArrayUtils.contains( (String[]) value, position )
								        : position.equals( value )
				        )
				        .orElse( defaultInclude || menu.getLevel() > 1 );
	}
}