BatchFileAdminAuthorizationServiceImpl

/*
 * Copyright 2009 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 *
 * 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 org.kuali.ole.sys.batch.service.impl;

import java.io.File;
import java.util.*;

import org.kuali.ole.sys.FinancialSystemModuleConfiguration;
import org.kuali.ole.sys.OLEConstants;
import org.kuali.ole.sys.batch.BatchFile;
import org.kuali.ole.sys.batch.BatchFileUtils;
import org.kuali.ole.sys.batch.service.BatchFileAdminAuthorizationService;
import org.kuali.ole.sys.context.SpringContext;
import org.kuali.ole.sys.identity.OleKimAttributes;
import org.kuali.rice.kim.api.KimConstants;
import org.kuali.rice.kim.api.identity.Person;
import org.kuali.rice.kim.api.services.IdentityManagementService;
import org.kuali.rice.krad.bo.ModuleConfiguration;
import org.kuali.rice.krad.service.KualiModuleService;
import org.kuali.rice.krad.service.ModuleService;
import org.kuali.rice.krad.util.KRADConstants;

public class BatchFileAdminAuthorizationServiceImpl implements BatchFileAdminAuthorizationService {

    private IdentityManagementService identityManagementService;
    private KualiModuleService kualiModuleService;

    @Override
    public boolean canDownload(BatchFile batchFile, Person user) {
        return getIdentityManagementService().isAuthorizedByTemplateName(user.getPrincipalId(),
                OLEConstants.PermissionTemplate.VIEW_BATCH_FILES.namespace, OLEConstants.PermissionTemplate.VIEW_BATCH_FILES.name,
                generateDownloadCheckPermissionDetails(batchFile, user), generateDownloadCheckRoleQualifiers(batchFile, user));
    }

    @Override
    public boolean canDelete(BatchFile batchFile, Person user) {
        return getIdentityManagementService().isAuthorizedByTemplateName(user.getPrincipalId(),
                OLEConstants.PermissionTemplate.VIEW_BATCH_FILES.namespace, OLEConstants.PermissionTemplate.VIEW_BATCH_FILES.name,
                generateDownloadCheckPermissionDetails(batchFile, user), generateDownloadCheckRoleQualifiers(batchFile, user));
    }

    protected String determineNamespaceCode(BatchFile batchFile) {
        for (ModuleService moduleService : getKualiModuleService().getInstalledModuleServices()) {
            ModuleConfiguration moduleConfiguration = moduleService.getModuleConfiguration();
            if (moduleConfiguration instanceof FinancialSystemModuleConfiguration) {
                List<String> batchFileDirectories = ((FinancialSystemModuleConfiguration) moduleConfiguration).getBatchFileDirectories();
                for (String batchFileDirectoryName : batchFileDirectories) {
                    File directory = new File(batchFileDirectoryName).getAbsoluteFile();
                    String fileName = batchFile.getFileName();
                    if(isFileNamePatternAvailable(fileName)){
                        return moduleConfiguration.getNamespaceCode();
                    } else if (BatchFileUtils.isSuperDirectoryOf(directory, batchFile.retrieveFile())) {
                        return moduleConfiguration.getNamespaceCode();
                    }
                }
            }
        }
        return null;
    }

    private boolean isFileNamePatternAvailable(String fileName){
        //Set<String> filePatterns = new HashSet();
        List<String> filePatterns = new ArrayList<String>();
        filePatterns.add(OLEConstants.REENCUM_RECURR);
        filePatterns.add(OLEConstants.PO_BULK_AMEND_OUT_FILE_NM);
        filePatterns.add(OLEConstants.POBA_FILE);
        filePatterns.add(OLEConstants.POBA_LOG_FILE);

        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.PROFILE_JOB);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.PROFILE_SCHEDULE);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.BATCH_JOB);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.RECORDS_CREATED_WITHOUT_LINK);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.RECORDS_CREATED_WITH_MORE_THAN_ONE_LINK);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.BIBS_MATCHED);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.HOLDINGS_MATCHED);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.ITEMS_MATCHED);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.BIBS_NO_MATCHED);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.HOLDINGS_NO_MATCHED);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.ITEMS_NO_MATCHED);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.MATCHED_BIB_IDS_FILE_NAME);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.MATCHED_HOLDINGS_IDS_FILE_NAME);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.MATCHED_ITEM_IDS_FILE_NAME);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.NO_MATCHED_BIB_FILE_NAME);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.NO_MATCHED_HOLDINGS_FILE_NAME);
        filePatterns.add(org.kuali.ole.OLEConstants.OLEBatchProcess.NO_MATCHED_ITEM_FILE_NAME);

        for(String allowedFilePattern:filePatterns){
            if (fileName.contains(allowedFilePattern)) {
                return true;
            }
        }
        return false;
    }
    protected Map<String,String> generateDownloadCheckPermissionDetails(BatchFile batchFile, Person user) {
        return generatePermissionDetails(batchFile, user);
    }

    protected Map<String,String> generateDownloadCheckRoleQualifiers(BatchFile batchFile, Person user) {
        return generateRoleQualifiers(batchFile, user);
    }

    protected Map<String,String> generateDeleteCheckPermissionDetails(BatchFile batchFile, Person user) {
        return generatePermissionDetails(batchFile, user);
    }

    protected Map<String,String> generateDeleteCheckRoleQualifiers(BatchFile batchFile, Person user) {
        return generateRoleQualifiers(batchFile, user);
    }

    protected Map<String,String> generatePermissionDetails(BatchFile batchFile, Person user) {
        Map<String,String> permissionDetails = new HashMap<String,String>();
        permissionDetails.put(KimConstants.AttributeConstants.NAMESPACE_CODE, determineNamespaceCode(batchFile));
        permissionDetails.put(OleKimAttributes.FILE_PATH, replaceSlashes(batchFile.getPath() + File.separator + batchFile.getFileName()));
        return permissionDetails;
    }

    /**
     * The permissions for the filePath will be added using '/' directory separators.
     * This method will replace any '\\' directory separators with '/'
     *
     * @param filePath
     * @return
     */
    private String replaceSlashes(String filePath) {

        if (File.separatorChar == '\\') {
            filePath = filePath.replace(File.separatorChar, '/');
        }

        return filePath;
    }

    protected Map<String,String> generateRoleQualifiers(BatchFile batchFile, Person user) {
        return new HashMap<String,String>();
    }

    protected IdentityManagementService getIdentityManagementService() {
        if (identityManagementService == null) {
            identityManagementService = SpringContext.getBean(IdentityManagementService.class);
        }
        return identityManagementService;
    }

    public KualiModuleService getKualiModuleService() {
        if (kualiModuleService == null) {
            kualiModuleService = SpringContext.getBean(KualiModuleService.class);
        }
        return kualiModuleService;
    }
}