Coverage Report - org.kuali.rice.kim.lookup.PermissionLookupableHelperServiceImpl
 
Classes in this File Line Coverage Branch Coverage Complexity
PermissionLookupableHelperServiceImpl
0%
0/126
0%
0/82
3.733
 
 1  
 /*
 2  
  * Copyright 2007-2009 The Kuali Foundation
 3  
  *
 4  
  * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 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  
 package org.kuali.rice.kim.lookup;
 17  
 
 18  
 import java.util.ArrayList;
 19  
 import java.util.HashMap;
 20  
 import java.util.List;
 21  
 import java.util.Map;
 22  
 import java.util.Properties;
 23  
 
 24  
 import org.apache.commons.beanutils.PropertyUtils;
 25  
 import org.apache.commons.lang.StringUtils;
 26  
 import org.apache.log4j.Logger;
 27  
 import org.kuali.rice.core.util.MaxAgeSoftReference;
 28  
 import org.kuali.rice.kim.bo.impl.GenericPermission;
 29  
 import org.kuali.rice.kim.bo.impl.PermissionImpl;
 30  
 import org.kuali.rice.kim.bo.impl.RoleImpl;
 31  
 import org.kuali.rice.kim.bo.role.impl.KimPermissionImpl;
 32  
 import org.kuali.rice.kim.bo.role.impl.RolePermissionImpl;
 33  
 import org.kuali.rice.kim.bo.types.dto.AttributeSet;
 34  
 import org.kuali.rice.kim.service.KIMServiceLocator;
 35  
 import org.kuali.rice.kim.service.RoleService;
 36  
 import org.kuali.rice.kim.util.KimConstants;
 37  
 import org.kuali.rice.kns.bo.BusinessObject;
 38  
 import org.kuali.rice.kns.lookup.CollectionIncomplete;
 39  
 import org.kuali.rice.kns.lookup.HtmlData;
 40  
 import org.kuali.rice.kns.service.KNSServiceLocator;
 41  
 import org.kuali.rice.kns.service.LookupService;
 42  
 import org.kuali.rice.kns.util.KNSConstants;
 43  
 import org.kuali.rice.kns.util.UrlFactory;
 44  
 
 45  
 /**
 46  
  * This is a description of what this class does - bhargavp don't forget to fill this in. 
 47  
  * 
 48  
  * @author Kuali Rice Team (rice.collab@kuali.org)
 49  
  *
 50  
  */
 51  0
 public class PermissionLookupableHelperServiceImpl extends RoleMemberLookupableHelperServiceImpl {
 52  
 
 53  
         private static final long serialVersionUID = -3578448525862270477L;
 54  
 
 55  0
         private static final Logger LOG = Logger.getLogger( PermissionLookupableHelperServiceImpl.class );
 56  
         
 57  
         private static LookupService lookupService;
 58  
         private static RoleService roleService;
 59  
 
 60  0
         private static boolean genericPermissionDocumentTypeNameLoaded = false;
 61  0
         private static String genericPermissionDocumentTypeName = null;
 62  
         
 63  
         /**
 64  
          * This overridden method ...
 65  
          * 
 66  
          * @see org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl#getCustomActionUrls(org.kuali.rice.kns.bo.BusinessObject, java.util.List)
 67  
          */
 68  
         @SuppressWarnings("unchecked")
 69  
         @Override
 70  
         public List<HtmlData> getCustomActionUrls(BusinessObject businessObject, List pkNames) {
 71  0
             List<HtmlData> htmlDataList = new ArrayList<HtmlData>();
 72  
             // convert the PermissionImpl class into a GenericPermission object
 73  0
             businessObject = new GenericPermission( (PermissionImpl)businessObject );
 74  0
         if (allowsMaintenanceEditAction(businessObject)) {
 75  0
                 htmlDataList.add(getUrlData(businessObject, KNSConstants.MAINTENANCE_EDIT_METHOD_TO_CALL, pkNames));
 76  
         }
 77  0
         if (allowsMaintenanceNewOrCopyAction()) {
 78  0
                 htmlDataList.add(getUrlData(businessObject, KNSConstants.MAINTENANCE_COPY_METHOD_TO_CALL, pkNames));
 79  
         }
 80  0
         return htmlDataList;
 81  
         }
 82  
 
 83  
     @SuppressWarnings("unchecked")
 84  
         protected String getActionUrlHref(BusinessObject businessObject, String methodToCall, List pkNames){
 85  0
         Properties parameters = new Properties();
 86  0
         parameters.put(KNSConstants.DISPATCH_REQUEST_PARAMETER, methodToCall);
 87  0
         parameters.put(KNSConstants.BUSINESS_OBJECT_CLASS_ATTRIBUTE, businessObject.getClass().getName());
 88  0
         parameters.put(KNSConstants.OVERRIDE_KEYS, KimConstants.PrimaryKeyConstants.PERMISSION_ID);
 89  0
         parameters.put(KNSConstants.COPY_KEYS, KimConstants.PrimaryKeyConstants.PERMISSION_ID);
 90  0
         if (StringUtils.isNotBlank(getReturnLocation())) {
 91  0
                 parameters.put(KNSConstants.RETURN_LOCATION_PARAMETER, getReturnLocation());         
 92  
                 }
 93  0
         parameters.putAll(getParametersFromPrimaryKey(businessObject, pkNames));
 94  0
         return UrlFactory.parameterizeUrl(KNSConstants.MAINTENANCE_ACTION, parameters);
 95  
     }
 96  
         
 97  
         /**
 98  
          * This overridden method ...
 99  
          * 
 100  
          * @see org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl#getMaintenanceDocumentTypeName()
 101  
          */
 102  
         @Override
 103  
         protected String getMaintenanceDocumentTypeName() {
 104  0
                 if ( !genericPermissionDocumentTypeNameLoaded ) {
 105  0
                         genericPermissionDocumentTypeName = getMaintenanceDocumentDictionaryService().getDocumentTypeName(GenericPermission.class);
 106  0
                         genericPermissionDocumentTypeNameLoaded = true;
 107  
                 }
 108  0
                 return genericPermissionDocumentTypeName;
 109  
         }
 110  
                 
 111  
         /**
 112  
          * @see org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl#getSearchResults(java.util.Map)
 113  
          */
 114  
         @Override
 115  
         protected List<? extends BusinessObject> getMemberSearchResults(Map<String, String> searchCriteria, boolean unbounded) {
 116  0
                 Map<String, String> permissionSearchCriteria = buildSearchCriteria(searchCriteria);
 117  0
                 Map<String, String> roleSearchCriteria = buildRoleSearchCriteria(searchCriteria);
 118  0
                 boolean permissionCriteriaEmpty = permissionSearchCriteria==null || permissionSearchCriteria.isEmpty();
 119  0
                 boolean roleCriteriaEmpty = roleSearchCriteria==null || roleSearchCriteria.isEmpty();
 120  
                 
 121  0
                 List<PermissionImpl> permissionSearchResultsCopy = new CollectionIncomplete<PermissionImpl>(new ArrayList<PermissionImpl>(), new Long(0));
 122  0
                 if(!permissionCriteriaEmpty && !roleCriteriaEmpty){
 123  0
                         permissionSearchResultsCopy = getCombinedSearchResults(permissionSearchCriteria, roleSearchCriteria, unbounded);
 124  0
                 } else if(permissionCriteriaEmpty && !roleCriteriaEmpty){
 125  0
                         permissionSearchResultsCopy = getPermissionsWithRoleSearchCriteria(roleSearchCriteria, unbounded);
 126  0
                 } else if(!permissionCriteriaEmpty && roleCriteriaEmpty){
 127  0
                         permissionSearchResultsCopy = getPermissionsWithPermissionSearchCriteria(permissionSearchCriteria, unbounded);
 128  0
                 } else if(permissionCriteriaEmpty && roleCriteriaEmpty){
 129  0
                         return getAllPermissions(unbounded);
 130  
                 }
 131  0
                 return permissionSearchResultsCopy;
 132  
         }
 133  
         
 134  
         private List<PermissionImpl> getAllPermissions(boolean unbounded){
 135  0
                 List<PermissionImpl> permissions = searchPermissions(new HashMap<String, String>(), unbounded);
 136  0
                 for(PermissionImpl permission: permissions)
 137  0
                         populateAssignedToRoles(permission);
 138  0
                 return permissions;
 139  
         }
 140  
         
 141  
         private List<PermissionImpl> getCombinedSearchResults(
 142  
                         Map<String, String> permissionSearchCriteria, Map<String, String> roleSearchCriteria, boolean unbounded){
 143  0
                 List<PermissionImpl> permissionSearchResults = searchPermissions(permissionSearchCriteria, unbounded);
 144  0
                 List<RoleImpl> roleSearchResults = searchRoles(roleSearchCriteria, unbounded);
 145  0
                 List<PermissionImpl> permissionsForRoleSearchResults = getPermissionsForRoleSearchResults(roleSearchResults, unbounded);
 146  0
                 List<PermissionImpl> matchedPermissions = new CollectionIncomplete<PermissionImpl>(
 147  
                         new ArrayList<PermissionImpl>(), getActualSizeIfTruncated(permissionsForRoleSearchResults));
 148  0
                 if((permissionSearchResults!=null && !permissionSearchResults.isEmpty()) && 
 149  
                                 (permissionsForRoleSearchResults!=null && !permissionsForRoleSearchResults.isEmpty())){
 150  0
                         for(PermissionImpl permission: permissionSearchResults){
 151  0
                                 for(PermissionImpl permissionFromRoleSearch: permissionsForRoleSearchResults){
 152  0
                                         if(permissionFromRoleSearch.getPermissionId().equals(permission.getPermissionId()))
 153  0
                                                 matchedPermissions.add(permissionFromRoleSearch);
 154  
                                 }
 155  
                         }
 156  
                 }
 157  0
                 return matchedPermissions;
 158  
         }
 159  
         
 160  
         @SuppressWarnings("unchecked")
 161  
         private List<PermissionImpl> searchPermissions(Map<String, String> permissionSearchCriteria, boolean unbounded){
 162  0
                 return getPermissionsSearchResultsCopy((List<KimPermissionImpl>)getLookupService().findCollectionBySearchHelper(
 163  
                                 KimPermissionImpl.class, permissionSearchCriteria, unbounded));        
 164  
         }
 165  
         
 166  
         private List<PermissionImpl> getPermissionsWithRoleSearchCriteria(Map<String, String> roleSearchCriteria, boolean unbounded){
 167  0
                 return getPermissionsForRoleSearchResults(searchRoles(roleSearchCriteria, unbounded), unbounded);
 168  
         }
 169  
 
 170  
         private List<PermissionImpl> getPermissionsForRoleSearchResults(List<RoleImpl> roleSearchResults, boolean unbounded){
 171  0
                 Long actualSizeIfTruncated = getActualSizeIfTruncated(roleSearchResults);
 172  0
                 List<PermissionImpl> permissions = new ArrayList<PermissionImpl>();
 173  
                 List<PermissionImpl> tempPermissions;
 174  0
                 List<String> collectedPermissionIds = new ArrayList<String>();
 175  
                 Map<String, String> permissionCriteria;
 176  
                 
 177  0
                 for(RoleImpl roleImpl: roleSearchResults){
 178  0
                         permissionCriteria = new HashMap<String, String>();
 179  0
                         permissionCriteria.put("rolePermissions.roleId", roleImpl.getRoleId());
 180  0
                         tempPermissions = searchPermissions(permissionCriteria, unbounded);
 181  0
                         actualSizeIfTruncated += getActualSizeIfTruncated(tempPermissions);
 182  0
                         for(PermissionImpl permission: tempPermissions){
 183  0
                                 if(!collectedPermissionIds.contains(permission.getPermissionId())){
 184  0
                                         populateAssignedToRoles(permission);
 185  0
                                         collectedPermissionIds.add(permission.getPermissionId());
 186  0
                                         permissions.add(permission);
 187  
                                 }
 188  
                         }
 189  
                         //need to find roles that current role is a member of and build search string
 190  0
                         List<String> parentRoleIds = KIMServiceLocator.getRoleService().getMemberParentRoleIds(KimConstants.KimUIConstants.MEMBER_TYPE_ROLE_CODE, roleImpl.getRoleId());
 191  0
                         for (String parentRoleId : parentRoleIds) {
 192  0
                                 Map<String, String> roleSearchCriteria = new HashMap<String, String>();
 193  0
                                 roleSearchCriteria.put("roleId", parentRoleId);
 194  
                                 //get all parent role permissions and merge them with current permissions
 195  0
                                 permissions = mergePermissionLists(permissions, getPermissionsWithRoleSearchCriteria(roleSearchCriteria, unbounded));
 196  0
                         }
 197  0
                 }
 198  
                 
 199  0
                 return new CollectionIncomplete<PermissionImpl>(permissions, actualSizeIfTruncated);
 200  
         }
 201  
         
 202  
 
 203  
         private void populateAssignedToRoles(PermissionImpl permission){
 204  
                 AttributeSet criteria;
 205  0
                 for(RolePermissionImpl rolePermission: permission.getRolePermissions()){
 206  0
                         if ( rolePermission.isActive() ) {
 207  0
                                 criteria = new AttributeSet();
 208  0
                                 criteria.put("roleId", rolePermission.getRoleId());
 209  0
                                 permission.getAssignedToRoles().add((RoleImpl)getBusinessObjectService().findByPrimaryKey(RoleImpl.class, criteria));
 210  
                         }
 211  
                 }
 212  0
         }
 213  
         
 214  
         /* Since most queries will only be on the template namespace and name, cache the results for 30 seconds
 215  
          * so that queries against the details, which are done in memory, do not require repeated database trips.
 216  
          */
 217  0
     private static final HashMap<Map<String,String>,MaxAgeSoftReference<List<PermissionImpl>>> permResultCache = new HashMap<Map<String,String>, MaxAgeSoftReference<List<PermissionImpl>>>(); 
 218  
         private static final long PERM_CACHE_EXPIRE_SECONDS = 30L;
 219  
         
 220  
         private List<PermissionImpl> getPermissionsWithPermissionSearchCriteria(
 221  
                         Map<String, String> permissionSearchCriteria, boolean unbounded){
 222  0
                 String detailCriteriaStr = permissionSearchCriteria.remove( DETAIL_CRITERIA );
 223  0
                 AttributeSet detailCriteria = parseDetailCriteria(detailCriteriaStr);
 224  
 
 225  0
                 MaxAgeSoftReference<List<PermissionImpl>> cachedResult = permResultCache.get(permissionSearchCriteria);
 226  0
                 List<PermissionImpl> permissions = null;
 227  0
                 if ( cachedResult == null || cachedResult.get() == null ) {
 228  0
                         permissions = searchPermissions(permissionSearchCriteria, unbounded);
 229  0
                         synchronized (permResultCache) {
 230  0
                                 permResultCache.put(permissionSearchCriteria, new MaxAgeSoftReference<List<PermissionImpl>>( PERM_CACHE_EXPIRE_SECONDS, permissions ) ); 
 231  0
                         } 
 232  
                 } else {
 233  0
                         permissions = cachedResult.get();
 234  
                 }
 235  0
                 List<PermissionImpl> filteredPermissions = new CollectionIncomplete<PermissionImpl>(
 236  
                                 new ArrayList<PermissionImpl>(), getActualSizeIfTruncated(permissions)); 
 237  0
                 for(PermissionImpl perm: permissions){
 238  0
                         if ( detailCriteria.isEmpty() ) {
 239  0
                                 filteredPermissions.add(perm);
 240  0
                                 populateAssignedToRoles(perm);
 241  
                         } else {
 242  0
                                 if ( isMapSubset( perm.getDetails(), detailCriteria ) ) {
 243  0
                                         filteredPermissions.add(perm);
 244  0
                                         populateAssignedToRoles(perm);
 245  
                                 }
 246  
                         }
 247  
                 }
 248  0
                 return filteredPermissions;
 249  
         }
 250  
         
 251  
         private List<PermissionImpl> getPermissionsSearchResultsCopy(List<KimPermissionImpl> permissionSearchResults){
 252  0
                 List<PermissionImpl> permissionSearchResultsCopy = new CollectionIncomplete<PermissionImpl>(
 253  
                         new ArrayList<PermissionImpl>(), getActualSizeIfTruncated(permissionSearchResults));
 254  0
                 for(KimPermissionImpl permissionImpl: permissionSearchResults){
 255  0
                         PermissionImpl permissionCopy = new PermissionImpl();
 256  
                         try{
 257  0
                                 PropertyUtils.copyProperties(permissionCopy, permissionImpl);
 258  0
                         } catch(Exception ex){
 259  0
                                 LOG.error( "Unable to copy properties from KimPermissionImpl to PermissionImpl, skipping.", ex );
 260  0
                                 continue;
 261  0
                         }
 262  0
                         permissionSearchResultsCopy.add(permissionCopy);
 263  0
                 }
 264  0
                 return permissionSearchResultsCopy;
 265  
         }
 266  
 
 267  
         /**
 268  
          * @return the lookupService
 269  
          */
 270  
         public LookupService getLookupService() {
 271  0
                 if ( lookupService == null ) {
 272  0
                         lookupService = KNSServiceLocator.getLookupService();
 273  
                 }
 274  0
                 return lookupService;
 275  
         }
 276  
 
 277  
         public RoleService getRoleService() {
 278  0
                 if (roleService == null) {
 279  0
                         roleService = KIMServiceLocator.getRoleService();
 280  
                 }
 281  0
                 return roleService;
 282  
         }
 283  
 
 284  
         private List<PermissionImpl> mergePermissionLists(List<PermissionImpl> perm1, List<PermissionImpl> perm2) {
 285  0
                 List<PermissionImpl> returnList = new ArrayList<PermissionImpl>(perm1);
 286  0
                 List<String> permissionIds = new ArrayList<String>(perm1.size());
 287  0
                 for (PermissionImpl perm : returnList) {
 288  0
                         permissionIds.add(perm.getPermissionId());
 289  
                 }
 290  0
                 for (int i=0; i<perm2.size(); i++) {
 291  0
                     if (!permissionIds.contains(perm2.get(i).getPermissionId())) {
 292  0
                             returnList.add(perm2.get(i));
 293  
                     }
 294  
                 }
 295  0
                 return returnList;
 296  
         }
 297  
 }