1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.service.user.menu;
35
36 import java.util.ArrayList;
37 import java.util.List;
38 import java.util.ListIterator;
39 import java.util.function.Consumer;
40 import java.util.stream.Collectors;
41
42 import javax.servlet.http.HttpServletRequest;
43
44 import fr.paris.lutece.portal.business.user.menu.AdminUserMenuItem;
45 import fr.paris.lutece.portal.business.user.menu.IAdminUserMenuItemProvider;
46 import fr.paris.lutece.portal.service.util.AppLogService;
47
48 /**
49 * Registry of admin user menu item providers
50 *
51 * @since 6.2.0
52 */
53 public class AdminUserMenuService
54 {
55 public static final String BEAN_NAME = "adminUserMenuService";
56
57 private final List<IAdminUserMenuItemProvider> _itemProviders = new ArrayList<>( );
58
59 /**
60 * Add an item provider to the registry
61 *
62 * Placement of the item can be altered with strAfterName or strBeforeName
63 *
64 * @param itemProvider
65 * admin user menu item provider
66 * @param strBeforeName
67 * add the item provider before the provider with this name
68 * @param strAfterName
69 * add the item provider after the provider with this name
70 */
71 public void addItemProvider( IAdminUserMenuItemProvider itemProvider, String strAfterName, String strBeforeName )
72 {
73 if ( strAfterName != null )
74 {
75 addItemProviderInPosition( itemProvider, strAfterName, ( ListIterator<IAdminUserMenuItemProvider> i ) -> i.add( itemProvider ) );
76 }
77 else
78 if ( strBeforeName != null )
79 {
80 addItemProviderInPosition( itemProvider, strBeforeName, ( ListIterator<IAdminUserMenuItemProvider> i ) -> {
81 if ( i.hasPrevious( ) )
82 {
83 i.previous( );
84 i.add( itemProvider );
85 }
86 else
87 {
88 _itemProviders.add( 0, itemProvider );
89 }
90 } );
91 }
92 else
93 {
94 _itemProviders.add( itemProvider );
95 }
96 AppLogService.info( "New admin user menu item provider registered : {}", itemProvider.getName( ) );
97 }
98
99 private void addItemProviderInPosition( IAdminUserMenuItemProvider itemProvider, String strRefName,
100 Consumer<ListIterator<IAdminUserMenuItemProvider>> adder )
101 {
102 ListIterator<IAdminUserMenuItemProvider> iterator = _itemProviders.listIterator( );
103 boolean bFound = false;
104 while ( iterator.hasNext( ) )
105 {
106 IAdminUserMenuItemProvider anItem = iterator.next( );
107 if ( anItem.getName( ).equals( strRefName ) )
108 {
109 bFound = true;
110 adder.accept( iterator );
111 break;
112 }
113 }
114 if ( !bFound )
115 {
116 AppLogService.error( "Did not find admin user menu item provider named <{}> when registering <{}>", strRefName, itemProvider.getName( ) );
117 _itemProviders.add( itemProvider );
118 }
119 }
120
121 /**
122 * Get all invoked admin user menu items
123 *
124 * @param request
125 * the request
126 * @return invoked admin user menu items
127 */
128 public List<AdminUserMenuItem> getItems( final HttpServletRequest request )
129 {
130 return _itemProviders.stream( ).filter( p -> p.isInvoked( request ) ).map( p -> p.getItem( request ) ).collect( Collectors.toList( ) );
131 }
132 }