1 /* 2 * Copyright (c) 2002-2014, Mairie de 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.workgroup; 35 36 import fr.paris.lutece.portal.business.user.AdminUser; 37 import fr.paris.lutece.portal.business.workgroup.AdminWorkgroupHome; 38 import fr.paris.lutece.portal.service.i18n.I18nService; 39 import fr.paris.lutece.util.ReferenceList; 40 41 import java.util.ArrayList; 42 import java.util.Collection; 43 import java.util.Locale; 44 45 46 /** 47 * AdminWorkgroupService 48 */ 49 public final class AdminWorkgroupService 50 { 51 public static final String ALL_GROUPS = "all"; 52 private static final String PROPERTY_LABEL_ALL_GROUPS = "portal.workgroup.labelAllGroups"; 53 54 /** 55 * Private constructor 56 */ 57 private AdminWorkgroupService( ) 58 { 59 } 60 61 /** 62 * Check if a resource should be visible to the user according its workgroup 63 * @param resource The resource to check 64 * @param user The current user 65 * @return true if authorized, otherwise false 66 */ 67 public static boolean isAuthorized( AdminWorkgroupResource resource, AdminUser user ) 68 { 69 String strWorkgroup = normalizeWorkgroupKey( resource.getWorkgroup( ) ); 70 71 if ( !strWorkgroup.equals( ALL_GROUPS ) ) 72 { 73 return AdminWorkgroupHome.isUserInWorkgroup( user, strWorkgroup ); 74 } 75 76 return true; 77 } 78 79 /** 80 * Filter a collection of resources for a given user 81 * 82 * @return A filtered collection of resources 83 * @param <E> The workgroup resource 84 * @param collection The collection to filter 85 * @param user The user 86 */ 87 public static <E extends AdminWorkgroupResource> Collection<E> getAuthorizedCollection( Collection<E> collection, 88 AdminUser user ) 89 { 90 ArrayList<E> list = new ArrayList<E>( ); 91 92 for ( E resource : collection ) 93 { 94 if ( isAuthorized( resource, user ) ) 95 { 96 list.add( resource ); 97 } 98 } 99 100 return list; 101 } 102 103 /** 104 * Gets all workgroups of the user 105 * @param user The current user 106 * @param locale The Locale 107 * @return A list of workgroup 108 */ 109 public static ReferenceList getUserWorkgroups( AdminUser user, Locale locale ) 110 { 111 ReferenceList list = AdminWorkgroupHome.getUserWorkgroups( user ); 112 list.addItem( ALL_GROUPS, I18nService.getLocalizedString( PROPERTY_LABEL_ALL_GROUPS, locale ) ); 113 114 return list; 115 } 116 117 /** 118 * Normalized an empty or null workgroup key 119 * @param strAdminWorkgroup The workgroup key to normalize 120 * @return The workgroup key normalized 121 */ 122 public static String normalizeWorkgroupKey( String strAdminWorkgroup ) 123 { 124 String strNormalized = strAdminWorkgroup; 125 126 if ( ( strAdminWorkgroup == null ) || ( strAdminWorkgroup.equals( "" ) ) ) 127 { 128 strNormalized = AdminWorkgroupService.ALL_GROUPS; 129 } 130 131 return strNormalized; 132 } 133 }