BDI/BGE: Update FLS to check only populated fields for DI & target objects

src/classes/BDI_ContactService.cls

@@ -72,7 +72,9 @@ public with sharing class BDI_ContactService {
     private Map<String, String> mapDIFieldToC1Field {
         get {
             if (mapDIFieldToC1Field == null) {
-                mapDIFieldToC1Field = BDI_DataImportService.mapFieldsForDIObject('Contact1', 'Contact', BDI_DataImportService.listStrDataImportFields);
+                mapDIFieldToC1Field = BDI_DataImportService.mapFieldsForDIObject(
+                    'Contact1', 'Contact', BDI_DataImportService.relevantDataImportFields
+                );
             }
             return mapDIFieldToC1Field;
         }
@@ -85,7 +87,9 @@ public with sharing class BDI_ContactService {
     private Map<String, String> mapDIFieldToC2Field {
         get {
             if (mapDIFieldToC2Field == null) {
-                mapDIFieldToC2Field = BDI_DataImportService.mapFieldsForDIObject('Contact2', 'Contact', BDI_DataImportService.listStrDataImportFields);
+                mapDIFieldToC2Field = BDI_DataImportService.mapFieldsForDIObject(
+                    'Contact2', 'Contact', BDI_DataImportService.relevantDataImportFields
+                );
             }
             return mapDIFieldToC2Field;
         }

src/classes/BDI_DataImportBatch_SEL.cls

@@ -45,6 +45,7 @@ public with sharing class BDI_DataImportBatch_SEL {
         return [SELECT Id,
                     Name,
                     Account_Custom_Unique_ID__c,
+                    Active_Fields__c,
                     Batch_Description__c,
                     Batch_Process_Size__c,
                     Contact_Custom_Unique_ID__c,
@@ -53,13 +54,13 @@ public with sharing class BDI_DataImportBatch_SEL {
                     Donation_Matching_Implementing_Class__c,
                     Donation_Matching_Rule__c,
                     Donation_Date_Range__c,
-                    Process_Using_Scheduled_Job__c,
+                    GiftBatch__c,
                     Last_Processed_On__c,
+                    Process_Using_Scheduled_Job__c,
                     Records_Failed__c,
                     Records_Successfully_Processed__c,
                     Post_Process_Implementing_Class__c,
-                    Run_Opportunity_Rollups_while_Processing__c,
-                    GiftBatch__c
+                    Run_Opportunity_Rollups_while_Processing__c
             FROM DataImportBatch__c
             WHERE Id in :setBatchId];
     }

src/classes/BDI_DataImportService.cls

@@ -78,10 +78,14 @@ global with sharing class BDI_DataImportService {
     * @return DataImportBatch__c
     */
     private static DataImportBatch__c loadBatch(Id batchId) {
-
         List<DataImportBatch__c> dataImportBatches = BDI_DataImportBatch_SEL.selectByIds(new Set<Id>{ batchId });
         if (dataImportBatches.size() == 1) {
-            return dataImportBatches[0];
+            DataImportBatch__c currentBatch = dataImportBatches[0];
+            if (!String.isBlank(currentBatch.Active_Fields__c)) {
+                relevantDataImportFields = BGE_BatchGiftEntry_UTIL.getDataImportFields(batchId, false);
+                batchFromBGE = true;
+            }
+            return currentBatch;
         } else {
             throw(new BDIException(String.format(Label.bdiInvalidBatchId, new List<String>{ batchId })));
         }
@@ -489,12 +493,26 @@ global with sharing class BDI_DataImportService {
             this.listDI = dataImports;
             this.diSettings = dataImportSettings;
 
+            // list of populated data import fields
+            Set<String> populatedDataImportFieldsSet = new Set<String>();
+
             // first set a clean state for each DI
             for (DataImport__c dataImport : dataImports) {
                 dataImport.Status__c = null;
                 dataImport.ImportedDate__c = null;
                 dataImport.ApexJobId__c = null;
                 dataImport.FailureInformation__c = null;
+
+                // collect populated DI fields to use for later mapping
+                if (batchFromBGE != true) {
+                    Map<String, Object> populatedFieldsMap = dataImport.getPopulatedFieldsAsMap();
+                    List<String> populatedFields = new List<String>(populatedFieldsMap.keySet());
+                    populatedDataImportFieldsSet.addAll(populatedFields);
+                }
+            }
+
+            if (batchFromBGE != true && populatedDataImportFieldsSet != null && populatedDataImportFieldsSet.size() > 0) {
+                relevantDataImportFields = new List<String>(populatedDataImportFieldsSet);
             }
 
             // do any performance optimizations to avoid unnecessary code
@@ -674,6 +692,28 @@ global with sharing class BDI_DataImportService {
         }
     }
 
+    /*******************************************************************************************************
+    * @description flag to let us know if we came from BGE
+    */
+    global static Boolean batchFromBGE { get; set; }
+
+    /*******************************************************************************************************
+    * @description list of the fields in the Data Import object that we care about for FLS checks because
+    * they are present in the Batch we are processing
+    * This list gets set in the loadBatch method.
+    * If no batch is loaded, we use the full list of all DI fields listStrDataImportFields
+    */
+    global static List<String> relevantDataImportFields {
+        get {
+            if (relevantDataImportFields == null || relevantDataImportFields.isEmpty()) {
+                return listStrDataImportFields;
+            } else {
+                return relevantDataImportFields;
+            }
+        }
+        set;
+    }
+
     /*******************************************************************************************************
     * @description list of all the fields in the Data Import object
     */
@@ -940,7 +980,7 @@ global with sharing class BDI_DataImportService {
         }
 
         // get our mapping of household custom fields
-        Map<String, String> mapDIFieldToHHField = mapFieldsForDIObject('Household', 'Account', listStrDataImportFields);
+        Map<String, String> mapDIFieldToHHField = mapFieldsForDIObject('Household', 'Account', relevantDataImportFields);
 
         // bail out if no custom fields
         if (mapDIFieldToHHField.size() == 0) {
@@ -1491,7 +1531,7 @@ global with sharing class BDI_DataImportService {
         get {
             if (mapDIFieldToA1Field == null) {
                 mapDIFieldToA1Field = BDI_DataImportService.mapFieldsForDIObject(
-                    'Account1', 'Account', BDI_DataImportService.listStrDataImportFields
+                    'Account1', 'Account', BDI_DataImportService.relevantDataImportFields
                 );
             }
             return mapDIFieldToA1Field;
@@ -1507,7 +1547,7 @@ global with sharing class BDI_DataImportService {
             if (mapDIFieldToA2Field == null) {
                 mapDIFieldToA2Field =
                     BDI_DataImportService.mapFieldsForDIObject(
-                        'Account2', 'Account', BDI_DataImportService.listStrDataImportFields
+                        'Account2', 'Account', BDI_DataImportService.relevantDataImportFields
                     );
             }
             return mapDIFieldToA2Field;
@@ -1563,7 +1603,8 @@ global with sharing class BDI_DataImportService {
         }
 
         Map<String, String> mapDIFieldToAddrField =
-            mapFieldsForDIObject('Address', UTIL_Namespace.StrTokenNSPrefix('Address__c'), listStrDataImportFields);
+            mapFieldsForDIObject('Address', UTIL_Namespace.StrTokenNSPrefix('Address__c'), relevantDataImportFields);
+
         List<Address__c> addressesToInsert = new List<Address__c>();
         List<DataImport__c> dataImportsToInsert = new List<DataImport__c>();
         Map<String, Address__c> mapHHAddrKeyToAddrNew = new Map<String, Address__c>();

src/classes/BDI_Donations.cls

@@ -111,7 +111,7 @@ public class BDI_Donations {
             if (dataImportFieldToOpportunityField == null) {
                 dataImportFieldToOpportunityField = BDI_DataImportService.mapFieldsForDIObject(
                     'Opportunity', 'Opportunity',
-                    BDI_DataImportService.listStrDataImportFields
+                    BDI_DataImportService.relevantDataImportFields
                 );
             }
             return dataImportFieldToOpportunityField;
@@ -127,7 +127,7 @@ public class BDI_Donations {
             if (dataImportFieldToPaymentField == null) {
                 dataImportFieldToPaymentField = BDI_DataImportService.mapFieldsForDIObject(
                     'Payment', 'npe01__OppPayment__c',
-                    BDI_DataImportService.listStrDataImportFields);
+                    BDI_DataImportService.relevantDataImportFields);
             }
             return dataImportFieldToPaymentField;
         }

src/classes/BDI_MatchDonations.cls

@@ -50,7 +50,7 @@ public with sharing class BDI_MatchDonations implements BDI_IMatchDonations {
         get {
             if (mapDIFieldToOppField == null) {
                 mapDIFieldToOppField = BDI_DataImportService.mapFieldsForDIObject('Opportunity', 'Opportunity', 
-                    BDI_DataImportService.listStrDataImportFields);
+                    BDI_DataImportService.relevantDataImportFields);
             }
             return mapDIFieldToOppField;
         }
@@ -64,7 +64,7 @@ public with sharing class BDI_MatchDonations implements BDI_IMatchDonations {
         get {
             if (mapDIFieldToPmtField == null) {
                 mapDIFieldToPmtField = BDI_DataImportService.mapFieldsForDIObject('Payment', 'npe01__OppPayment__c', 
-                    BDI_DataImportService.listStrDataImportFields);
+                    BDI_DataImportService.relevantDataImportFields);
                 // special case Donation fields we defaultly map to Opp fields, but we will use with Payments too!
                 // note that these two work for matching rules.  
                 mapDIFieldToPmtField.put(UTIL_Namespace.StrTokenNSPrefix('Donation_Amount__c').toLowercase(), 'npe01__Payment_Amount__c');

src/classes/BGE_BatchGiftEntry_UTIL.cls

@@ -36,6 +36,108 @@
 */
 public with sharing class BGE_BatchGiftEntry_UTIL {
 
+    /*******************************************************************************************************
+    * @description returns a list of DataImport__c fields the Batch Gift Entry UI needs in SOQL
+    * @param batchId the batch for which to get all fields for soql
+    * @return List<String> list of DataImport__c field api names
+    */
+    public static List<String> getDataImportFields(Id batchId) {
+        return getDataImportFields(batchId, true);
+    }
+
+    /*******************************************************************************************************
+    * @description returns a list of DataImport__c fields the Batch Gift Entry UI needs in SOQL
+    * @param batchId the batch for which to get all fields for soql
+    * @param includeRelationshipFields whether to include relationship fields in the returned list
+    * @return List<String> list of DataImport__c field api names
+    */
+    public static List<String> getDataImportFields(Id batchId, Boolean includeRelationshipFields) {
+
+        List<String> fields = getCoreDataImportFields(includeRelationshipFields);
+        fields.addAll(getActiveFieldNamesFromBatch(batchId));
+
+        return fields;
+    }
+
+    /*******************************************************************************************************
+    * @description Returns the subset of DataImport__c fields that are part of every batch
+    * @param includeRelationshipFields whether to include relationship fields in the returned list
+    * @return list of DataImport__c field api names
+    */
+    private static List<String> getCoreDataImportFields(Boolean includeRelationshipFields) {
+        List<String> fields = new List<String> {
+            'Id',
+            'Account1Imported__c',
+            'Contact1Imported__c',
+            'Donation_Donor__c',
+            'DonationImported__c',
+            'DonationImportStatus__c',
+            'FailureInformation__c',
+            'NPSP_Data_Import_Batch__c',
+            'PaymentImported__c',
+            'PaymentImportStatus__c',
+            'Status__c'
+        };
+
+        if (includeRelationshipFields) {
+            fields.addAll(new List<String> {
+                'Account1Imported__r.Name',
+                'Contact1Imported__r.Name',
+                'DonationImported__r.Name',
+                'PaymentImported__r.Name'
+            });
+        }
+
+        // Maybe create new method in UTIL_Namespace for lists
+        List<String> namespacedFields = new List<String>();
+        for(String fieldName : fields) {
+            namespacedFields.add(UTIL_Namespace.StrAllNSPrefix(fieldName));
+        }
+
+        return namespacedFields;
+    }
+
+     /*******************************************************************************************************
+    * @description parses Active_Fields__c for the list of user-defined fields included in the batch config
+    * @param batchId: ID of the NPSP_Data_Import_Batch__c
+    * @return list of field api names
+    */
+    public static List<String> getActiveFieldNamesFromBatch(Id batchId) {
+        DataImportBatch__c batch = [SELECT Active_Fields__c FROM DataImportBatch__c WHERE Id = :batchId];
+        String activeFieldsJSON = batch.Active_Fields__c;
+        List<String> activeFieldNames = new List<String>();
+
+        if (activeFieldsJSON != null) {
+            List<BGE_ConfigurationWizard_CTRL.BGEField> activeFields =
+                (List<BGE_ConfigurationWizard_CTRL.BGEField>)JSON.deserialize(
+                    activeFieldsJSON,
+                    List<BGE_ConfigurationWizard_CTRL.BGEField>.class
+                );
+            for (BGE_ConfigurationWizard_CTRL.BGEField field : activeFields) {
+                activeFieldNames.add(field.name);
+                if (field.type == 'reference') {
+                    DescribeFieldResult lookupDFR = UTIL_Describe.getFieldDescribe(
+                        UTIL_Namespace.StrTokenNSPrefix('DataImport__c'),
+                        field.name.toLowerCase()
+                    );
+                    String referencedObjectName = lookupDFR.getReferenceTo()[0].getDescribe().name;
+                    activeFieldNames.add(field.name.substringBefore('__c') + '__r.' + UTIL_Describe.getNameField(referencedObjectName));
+                }
+            }
+        }
+
+        return activeFieldNames;
+    }
+
+    /*******************************************************************************************************
+    * @description checks for read, create, and edit FLS for a given field
+    * @param dfr DescribeFieldResult of the field to check
+    * @return Boolean
+    */
+    public static Boolean canUpdateField(DescribeFieldResult dfr) {
+        return dfr.isCreateable() && dfr.isUpdateable();
+    }
+
     /*******************************************************************************************************
     * @description Returns the relevant Batch fields for soql
     * @return list of field API names

src/classes/BGE_DataImportBatchEntry_CTRL.cls

@@ -372,8 +372,10 @@ public with sharing class BGE_DataImportBatchEntry_CTRL {
         String activeFieldsJSON = batch.Active_Fields__c;
         if (activeFieldsJSON != null) {
             List<BGE_ConfigurationWizard_CTRL.BGEField> activeFields =
-                (List<BGE_ConfigurationWizard_CTRL.BGEField>)JSON.deserialize(activeFieldsJSON,
-                        List<BGE_ConfigurationWizard_CTRL.BGEField>.class);
+                (List<BGE_ConfigurationWizard_CTRL.BGEField>)JSON.deserialize(
+                    activeFieldsJSON,
+                    List<BGE_ConfigurationWizard_CTRL.BGEField>.class
+                );
 
             Map<String, Schema.DescribeFieldResult> fieldMap = UTIL_Describe.getAllFieldsDescribe(
                     UTIL_Namespace.StrTokenNSPrefix('DataImport__c')
@@ -520,7 +522,7 @@ public with sharing class BGE_DataImportBatchEntry_CTRL {
     * @return Query string
     */
     public static String getDataImportQuery(Id batchId, List<Id> dataImportIds, Integer numRows, Integer offset) {
-        List<String> dataImportFields = getDataImportFields(batchId);
+        List<String> dataImportFields = BGE_BatchGiftEntry_UTIL.getDataImportFields(batchId);
 
         String query =  'SELECT ' + String.join(dataImportFields,', ') +
                         ' FROM DataImport__c' +
@@ -567,42 +569,14 @@ public with sharing class BGE_DataImportBatchEntry_CTRL {
         };
     }
 
-    /*******************************************************************************************************
-    * @description reads the Active_Fields__c field to get active configured fields for the batch
-    * @param batchId: ID of the NPSP_Data_Import_Batch__c
-    * @return list of field API names
-    */
-    private static List<String> getActiveFieldNamesFromBatch(Id batchId) {
-
-        DataImportBatch__c batch = [SELECT Active_Fields__c FROM DataImportBatch__c WHERE Id = :batchId];
-        String activeFieldsJSON = batch.Active_Fields__c;
-        List<String> activeFieldNames = new List<String>();
-
-        if (activeFieldsJSON != null) {
-            List<BGE_ConfigurationWizard_CTRL.BGEField> activeFields =
-                    (List<BGE_ConfigurationWizard_CTRL.BGEField>)
-                            JSON.deserialize(activeFieldsJSON, List<BGE_ConfigurationWizard_CTRL.BGEField>.class);
-            for (BGE_ConfigurationWizard_CTRL.BGEField field : activeFields) {
-                activeFieldNames.add(field.name);
-                if (field.type == 'reference') {
-                    DescribeFieldResult lookupDFR = UTIL_Describe.getFieldDescribe(UTIL_Namespace.StrTokenNSPrefix('DataImport__c'), field.name.toLowerCase());
-                    String referencedObjectName = lookupDFR.getReferenceTo()[0].getDescribe().name;
-                    activeFieldNames.add(field.name.substringBefore('__c') + '__r.' + UTIL_Describe.getNameField(referencedObjectName));
-                }
-            }
-        }
-
-        return activeFieldNames;
-    }
-
     /*******************************************************************************************************
     * @description returns a list of DataImport__c fields the Batch Gift Entry UI needs in SOQL
     * @return List<String> list of DataImport__c field api names
     */
     private static List<String> getDataImportFields(Id batchId) {
 
         List<String> fields = getDataImportFields();
-        fields.addAll(getActiveFieldNamesFromBatch(batchId));
+        fields.addAll(BGE_BatchGiftEntry_UTIL.getActiveFieldNamesFromBatch(batchId));
         return fields;
     }