AbstractView.java

  1. /*
  2.  * Copyright 2010-2025 James Pether Sörling
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *   http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  *
  16.  *  $Id$
  17.  *  $HeadURL$
  18. */
  19. package com.hack23.cia.web.impl.ui.application.views.common;

  21. import java.util.Map;

  23. import javax.annotation.PostConstruct;

  25. import org.jsoup.Jsoup;
  26. import org.jsoup.safety.Safelist;
  27. import org.slf4j.Logger;
  28. import org.slf4j.LoggerFactory;
  29. import org.springframework.beans.factory.annotation.Autowired;
  30. import org.springframework.beans.factory.annotation.Value;
  31. import org.springframework.security.access.AccessDeniedException;
  32. import org.springframework.web.context.request.RequestContextHolder;

  34. import com.hack23.cia.service.api.action.application.LogoutRequest;
  35. import com.hack23.cia.web.impl.ui.application.action.PageActionEventHelper;
  36. import com.hack23.cia.web.impl.ui.application.util.UserContextUtil;
  37. import com.hack23.cia.web.impl.ui.application.views.common.labelfactory.LabelFactory;
  38. import com.hack23.cia.web.impl.ui.application.views.common.menufactory.api.ApplicationMenuItemFactory;
  39. import com.hack23.cia.web.impl.ui.application.views.common.pagelinks.api.PageLinkFactory;
  40. import com.hack23.cia.web.impl.ui.application.views.common.pagemode.PageModeContentFactory;
  41. import com.hack23.cia.web.impl.ui.application.views.common.sizing.ContentRatio;
  42. import com.hack23.cia.web.impl.ui.application.views.pageclicklistener.LogoutClickListener;
  43. import com.vaadin.icons.VaadinIcons;
  44. import com.vaadin.navigator.View;
  45. import com.vaadin.navigator.ViewChangeListener.ViewChangeEvent;
  46. import com.vaadin.server.ExternalResource;
  47. import com.vaadin.server.ThemeResource;
  48. import com.vaadin.ui.Alignment;
  49. import com.vaadin.ui.Button;
  50. import com.vaadin.ui.HorizontalLayout;
  51. import com.vaadin.ui.Image;
  52. import com.vaadin.ui.Label;
  53. import com.vaadin.ui.Link;
  54. import com.vaadin.ui.MenuBar;
  55. import com.vaadin.ui.Panel;
  56. import com.vaadin.ui.VerticalLayout;

  58. /**
  59.  * The Class AbstractView.
  60.  */
  61. public abstract class AbstractView extends Panel implements View {

  63.     /** The Constant LOGGER. */
  64.     private static final Logger LOGGER = LoggerFactory.getLogger(AbstractView.class);

  66.     /** The Constant LOGOUT. */
  67.     private static final String LOGOUT = "Logout";

  69.     /** The Constant ROLE_ADMIN. */
  70.     private static final String ROLE_ADMIN = "ROLE_ADMIN";

  72.     /** The Constant ROLE_USER. */
  73.     private static final String ROLE_USER = "ROLE_USER";

  75.     /** The Constant serialVersionUID. */
  76.     private static final long serialVersionUID = 1L;

  78.     /** The barmenu. */
  79.     private final MenuBar barmenu = new MenuBar();

  81.     /** The menu item factory. */
  82.     @Autowired
  83.     private transient ApplicationMenuItemFactory menuItemFactory;

  85.     /** The page action event helper. */
  86.     @Autowired
  87.     protected transient PageActionEventHelper pageActionEventHelper;

  89.     /** The page link factory. */
  90.     @Autowired
  91.     protected transient PageLinkFactory pageLinkFactory;

  93.     /** The page mode content factory map. */
  94.     private transient Map<String, PageModeContentFactory> pageModeContentFactoryMap;

  96.     /** The application name. */
  97.     @Value("${application.name}")
  98.     protected String applicationName;

  100.     /** The application version. */
  101.     @Value("${application.version}")
  102.     protected String applicationVersion;

  104.     /** The application url. */
  105.     @Value("${application.url}")
  106.     protected String applicationUrl;

  108.     /** The page name. */
  109.     private final String pageName;

  111.     /** The panel. */
  112.     private Panel panel;

  114.     /** The top header right panel. */
  115.     private final HorizontalLayout topHeaderRightPanel = new HorizontalLayout();


  118.     /**
  119.      * Instantiates a new abstract view.
  120.      *
  121.      * @param pageModeContentFactoryMap the page mode content factory map
  122.      * @param pageName the page name
  123.      */
  124.     protected AbstractView(final Map<String, PageModeContentFactory> pageModeContentFactoryMap, final String pageName) {
  125.         super();
  126.         this.pageModeContentFactoryMap = pageModeContentFactoryMap;
  127.         this.pageName = pageName;
  128.     }

  130.     /**
  131.      * Adds the logo to header.
  132.      *
  133.      * @param topHeader
  134.      *            the top header
  135.      */
  136.     private static void addLogoToHeader(final HorizontalLayout topHeader) {
  137.         final ThemeResource ciaLogoResource = new ThemeResource("cia-logo.png");
  138.         final Image ciaLogoImage = new Image(null,ciaLogoResource);
  139.         topHeader.addComponent(ciaLogoImage);
  140.         ciaLogoImage.setWidth("60px");
  141.         ciaLogoImage.setHeight("60px");
  142.         topHeader.setComponentAlignment(ciaLogoImage, Alignment.MIDDLE_LEFT);
  143.         topHeader.setExpandRatio(ciaLogoImage, ContentRatio.SMALL);
  144.     }


  147.     /**
  148.      * Creates the full size vertical layout.
  149.      *
  150.      * @return the vertical layout
  151.      */
  152.     private static VerticalLayout createFullSizeVerticalLayout() {
  153.         return createFullSizeVerticalLayout(true,true);
  154.     }

  156.     /**
  157.      * Creates the full size vertical layout.
  158.      *
  159.      * @param margin
  160.      *            the margin
  161.      * @param spacing
  162.      *            the spacing
  163.      * @return the vertical layout
  164.      */
  165.     private static VerticalLayout createFullSizeVerticalLayout(final boolean margin, final boolean spacing) {
  166.         final VerticalLayout layout = new VerticalLayout();
  167.         layout.setMargin(margin);
  168.         layout.setSpacing(spacing);
  169.         layout.setWidth(100, Unit.PERCENTAGE);
  170.         layout.setHeight(100, Unit.PERCENTAGE);
  171.         return layout;
  172.     }

  174.     /**
  175.      * Creates the top title header.
  176.      *
  177.      * @param topHeader
  178.      *            the top header
  179.      */
  180.     private static void createTopTitleHeader(final HorizontalLayout topHeader) {
  181.         final HorizontalLayout topTitleHeadertPanel = new HorizontalLayout();


  184.         final Label titleLabel = new Label("Citizen Intelligence Agency");
  185.         titleLabel.setStyleName("Header");
  186.         topTitleHeadertPanel.addComponent(titleLabel);
  187.         topTitleHeadertPanel.setComponentAlignment(titleLabel, Alignment.MIDDLE_LEFT);

  189.         final Label sloganLabel = new Label("// Tracking politicians like bugs!");
  190.         sloganLabel.setStyleName("HeaderSlogan");
  191.         topTitleHeadertPanel.addComponent(sloganLabel);
  192.         topTitleHeadertPanel.setComponentAlignment(sloganLabel, Alignment.MIDDLE_RIGHT);

  194.         topHeader.addComponent(topTitleHeadertPanel);
  195.         topHeader.setComponentAlignment(topTitleHeadertPanel, Alignment.MIDDLE_LEFT);
  196.         topHeader.setExpandRatio(topTitleHeadertPanel, ContentRatio.GRID);
  197.     }

  199.     /**
  200.      * Creates the basic layout with panel and footer.
  201.      *
  202.      * @param panelName
  203.      *            the panel name
  204.      */
  205.     protected final void createBasicLayoutWithPanelAndFooter(final String panelName) {
  206.         final VerticalLayout layout = createFullSizeVerticalLayout();
  207.         final VerticalLayout pageModeContent = createFullSizeVerticalLayout(false,false);
  208.         layout.addComponent(pageModeContent);

  210.         final HorizontalLayout topHeader = new HorizontalLayout();

  212.         addLogoToHeader(topHeader);
  213.         createTopTitleHeader(topHeader);

  215.         topHeaderRightPanel.removeAllComponents();
  216.         topHeader.addComponent(topHeaderRightPanel);
  217.         topHeader.setComponentAlignment(topHeaderRightPanel, Alignment.MIDDLE_RIGHT);
  218.         topHeader.setExpandRatio(topHeaderRightPanel, ContentRatio.LARGE);

  220.         createTopHeaderActionsForUserContext();

  222.         topHeaderRightPanel.setWidth("100%");
  223.         topHeaderRightPanel.setHeight("50px");

  225.         topHeader.setWidth("100%");
  226.         topHeader.setHeight("50px");

  228.         pageModeContent.addComponent(topHeader);
  229.         pageModeContent.setComponentAlignment(topHeader, Alignment.TOP_CENTER);

  231.         pageModeContent.addComponent(getBarmenu());
  232.         pageModeContent.setComponentAlignment(getBarmenu(), Alignment.TOP_CENTER);

  234.         panel = new Panel(panelName);
  235.         panel.addStyleName("v-panel-page-panel");

  237.         panel.setSizeFull();
  238.         pageModeContent.addComponent(panel);
  239.         pageModeContent.setExpandRatio(panel, ContentRatio.FULL_SIZE);

  241.         final HorizontalLayout footerTop = new HorizontalLayout();
  242.         final HorizontalLayout footerBottom = new HorizontalLayout();
  243.         final Link createMainViewPageLink = pageLinkFactory.createMainViewPageLink();
  244.         final Label appVersion = new Label(applicationName + " (" + applicationVersion +")(Apache License 2.0)");
  245.         final Link spdxLink = new Link("SBOM(spdx)", new ExternalResource("https://github.com/Hack23/cia/releases/download/" + applicationVersion +"/com.hack23.cia_citizen-intelligence-agency-" + applicationVersion +".spdx.json"));
  246.         final Link sourcCodeLink = new Link("https://github.com/Hack23/cia", new ExternalResource("https://github.com/Hack23/cia"));
  247.         final Label licenseLink = new Label("Open Source");

  249.         footerTop.addComponent(createMainViewPageLink);
  250.         footerTop.addComponent(appVersion);
  251.         footerBottom.addComponent(licenseLink);
  252.         footerBottom.addComponent(sourcCodeLink);
  253.         footerBottom.addComponent(spdxLink);
  254.         footerTop.setComponentAlignment(createMainViewPageLink, Alignment.MIDDLE_LEFT);
  255.         footerTop.setComponentAlignment(appVersion, Alignment.MIDDLE_LEFT);

  257.         footerBottom.setComponentAlignment(licenseLink, Alignment.MIDDLE_LEFT);
  258.         footerBottom.setComponentAlignment(sourcCodeLink, Alignment.MIDDLE_LEFT);
  259.         footerBottom.setComponentAlignment(spdxLink, Alignment.MIDDLE_LEFT);

  261.         footerTop.setWidth("100%");
  262.         footerTop.setHeight("25px");
  263.         footerBottom.setWidth("100%");
  264.         footerBottom.setHeight("25px");

  266.         pageModeContent.addComponent(footerTop);
  267.         pageModeContent.addComponent(footerBottom);

  269.         setContent(layout);

  271.         setWidth(100, Unit.PERCENTAGE);
  272.         setHeight(100, Unit.PERCENTAGE);
  273.         setSizeFull();

  275.     }

  277.     /**
  278.      * Creates the top header actions for user context.
  279.      */
  280.     private void createTopHeaderActionsForUserContext() {
  281.         if (UserContextUtil.allowRoleInSecurityContext(ROLE_ADMIN) || UserContextUtil.allowRoleInSecurityContext(ROLE_USER)) {
  282.             final Link userHomePageLink = pageLinkFactory.createUserHomeViewPageLink();
  283.             topHeaderRightPanel.addComponent(userHomePageLink);
  284.             topHeaderRightPanel.setComponentAlignment(userHomePageLink, Alignment.MIDDLE_RIGHT);

  286.             final Button logoutButton = new Button(LOGOUT,VaadinIcons.SIGN_OUT);

  288.             final LogoutRequest logoutRequest = new LogoutRequest();
  289.             logoutRequest.setSessionId(RequestContextHolder.currentRequestAttributes().getSessionId());
  290.             logoutButton.addClickListener(new LogoutClickListener(logoutRequest));

  292.             topHeaderRightPanel.addComponent(logoutButton);
  293.             topHeaderRightPanel.setComponentAlignment(logoutButton, Alignment.MIDDLE_RIGHT);

  295.         } else {
  296.             final Link createRegisterPageLink = pageLinkFactory.createRegisterPageLink();
  297.             topHeaderRightPanel.addComponent(createRegisterPageLink);
  298.             topHeaderRightPanel.setComponentAlignment(createRegisterPageLink, Alignment.MIDDLE_RIGHT);

  300.             final Link createLoginPageLink = pageLinkFactory.createLoginPageLink();
  301.             topHeaderRightPanel.addComponent(createLoginPageLink);
  302.             topHeaderRightPanel.setComponentAlignment(createLoginPageLink, Alignment.MIDDLE_RIGHT);
  303.         }
  304.     }

  306.     @Override
  307.     public final void enter(final ViewChangeEvent event) {
  308.         try {

  310.             final String parameters = Jsoup.clean(event.getParameters(), Safelist.basic());

  312.             for (final PageModeContentFactory pageModeContentFactory : pageModeContentFactoryMap.values()) {
  313.                 if (pageModeContentFactory.matches(pageName, parameters) && pageModeContentFactory.validReference(parameters)) {
  314.                     getPanel().setContent(pageModeContentFactory.createContent(parameters, getBarmenu(), getPanel()));
  315.                     return;
  316.                 }
  317.             }

  319.             LOGGER.warn("SECURITY:Invalid reference, content not found:{}/{}",pageName, parameters);
  320.             final VerticalLayout panelContent = createFullSizeVerticalLayout();

  322.             menuItemFactory.createMainPageMenuBar(getBarmenu());

  324.             LabelFactory.createHeader2Label(panelContent,"Invalid reference, content not found:" +pageName+ "/"+ parameters);

  326.             getPanel().setContent(panelContent);
  327.             getPanel().setCaption("Invalid Reference");
  328.         } catch (final AccessDeniedException e ) {
  329.             LOGGER.warn("Security:Authorization Failure:: {} : {}  exception : {}",e.getMessage(),pageName,e.getClass().getName());
  330.             final VerticalLayout panelContent = createFullSizeVerticalLayout();
  331.             LabelFactory.createHeader2Label(panelContent,"Access denied:" +pageName);
  332.             getPanel().setContent(panelContent);
  333.             getPanel().setCaption("Access denied");
  334.         }
  335.     }

  337.     /**
  338.      * Gets the barmenu.
  339.      *
  340.      * @return the barmenu
  341.      */
  342.     public final MenuBar getBarmenu() {
  343.         return barmenu;
  344.     }

  346.     /**
  347.      * Gets the panel.
  348.      *
  349.      * @return the panel
  350.      */
  351.     protected final Panel getPanel() {
  352.         return panel;
  353.     }

  355.     /**
  356.      * Post construct.
  357.      */
  358.     @PostConstruct
  359.     public final void postConstruct() {
  360.         setSizeFull();
  361.         createBasicLayoutWithPanelAndFooter(pageName);
  362.     }

  364. }
Created with JaCoCo 0.8.12.202403310830