Skip to content

Commit

Permalink
BXC-4415 add object_type column to permissions csv (#86)
Browse files Browse the repository at this point in the history 
* add object type column to perms csv, update perms validator and tests

* object type column after id column, mappedIdsAndObjectType returns list, change isWork to getObjectType and have it return object type, work query constant, remove distinct from queries
  • Loading branch information
@krwong
krwong committed Mar 8, 2024
1 parent b269d47 commit a0483be
Show file tree
Hide file tree
Showing 6 changed files with 132 additions and 105 deletions.
3 changes: 2 additions & 1 deletion src/main/java/edu/unc/lib/boxc/migration/cdm/model/PermissionsInfo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
public class PermissionsInfo {
public static final String DEFAULT_ID = "default";
public static final String ID_FIELD = "id";
public static final String OBJECT_TYPE = "object_type";
public static final String[] CSV_HEADERS = new String[] {
ID_FIELD, PUBLIC_PRINC, AUTHENTICATED_PRINC };
ID_FIELD, OBJECT_TYPE, PUBLIC_PRINC, AUTHENTICATED_PRINC };

private List<PermissionMapping> mappings;

Expand Down
86 changes: 55 additions & 31 deletions src/main/java/edu/unc/lib/boxc/migration/cdm/services/PermissionsService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,15 @@
import java.nio.file.NoSuchFileException;
import java.nio.file.Path;
import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import static org.slf4j.LoggerFactory.getLogger;

Expand All @@ -39,6 +40,14 @@
*/
public class PermissionsService {
private static final Logger log = getLogger(PermissionsService.class);
public static final String WORK_OBJECT_TYPE = "work";
public static final String FILE_OBJECT_TYPE = "file";
private static final String WORK_QUERY = "select " + CdmFieldInfo.CDM_ID
+ " from " + CdmIndexService.TB_NAME
+ " where " + CdmIndexService.ENTRY_TYPE_FIELD + " = '" + CdmIndexService.ENTRY_TYPE_GROUPED_WORK + "'"
+ " or " + CdmIndexService.ENTRY_TYPE_FIELD + " = '" + CdmIndexService.ENTRY_TYPE_COMPOUND_OBJECT + "'"
+ " or " + CdmIndexService.ENTRY_TYPE_FIELD + " is null"
+ " and " + CdmIndexService.PARENT_ID_FIELD + " is null";

private MigrationProject project;
private CdmIndexService indexService;
Expand Down Expand Up @@ -71,13 +80,15 @@ public void generatePermissions(PermissionMappingOptions options) throws Excepti
) {
if (options.isWithDefault()) {
csvPrinter.printRecord(PermissionsInfo.DEFAULT_ID,
"",
everyoneField,
authenticatedField);
}

List<String> mappedIds = queryForMappedIds(options);
for (String id : mappedIds) {
csvPrinter.printRecord(id,
List<Map.Entry<String, String>> mappedIdsAndObjectType = queryForMappedIds(options);
for (Map.Entry<String, String> entry : mappedIdsAndObjectType) {
csvPrinter.printRecord(entry.getKey(),
entry.getValue(),
everyoneField,
authenticatedField);
}
Expand Down Expand Up @@ -108,7 +119,7 @@ public void setPermissions(PermissionMappingOptions options) throws Exception {
CSVPrinter csvPrinter = new CSVPrinter(writer, CSVFormat.DEFAULT.withHeader(PermissionsInfo.CSV_HEADERS));
) {
for (List<String> record : records) {
csvPrinter.printRecord(record.get(0), record.get(1), record.get(2));
csvPrinter.printRecord(record.get(0), record.get(1), record.get(2), record.get(3));
}
}
}
Expand All @@ -132,8 +143,8 @@ public static PermissionsInfo loadMappings(MigrationProject project) throws IOEx
for (CSVRecord csvRecord : csvParser) {
PermissionsInfo.PermissionMapping mapping = new PermissionsInfo.PermissionMapping();
mapping.setId(csvRecord.get(0));
mapping.setEveryone(csvRecord.get(1));
mapping.setAuthenticated(csvRecord.get(2));
mapping.setEveryone(csvRecord.get(2));
mapping.setAuthenticated(csvRecord.get(3));
mappings.add(mapping);
}
return info;
Expand Down Expand Up @@ -208,41 +219,35 @@ private List<String> getIds(String query) {
}
}

private List<String> queryForMappedIds(PermissionMappingOptions options) {
List<String> mappedIds = new ArrayList<>();

// works and files
if (options.isWithWorks() && options.isWithFiles()) {
String workAndFileQuery = "select distinct " + CdmFieldInfo.CDM_ID +
" from " + CdmIndexService.TB_NAME;
mappedIds = getIds(workAndFileQuery);
}
private List<Map.Entry<String, String>> queryForMappedIds(PermissionMappingOptions options) {
List<String> mappedIds;
List<Map.Entry<String, String>> mappedIdsAndObjType = new ArrayList<>();

// works
if (options.isWithWorks() && !options.isWithFiles()) {
if (options.isWithWorks()) {
// for every work in the project (grouped works, compound objects, and single file works)
String workQuery = "select distinct " + CdmFieldInfo.CDM_ID
+ " from " + CdmIndexService.TB_NAME
+ " where " + CdmIndexService.ENTRY_TYPE_FIELD + " = '" + CdmIndexService.ENTRY_TYPE_GROUPED_WORK + "'"
+ " or " + CdmIndexService.ENTRY_TYPE_FIELD + " = '" + CdmIndexService.ENTRY_TYPE_COMPOUND_OBJECT + "'"
+ " or " + CdmIndexService.ENTRY_TYPE_FIELD + " is null"
+ " and " + CdmIndexService.PARENT_ID_FIELD + " is null";
mappedIds = getIds(workQuery);
mappedIds = getIds(WORK_QUERY);
for (String id : mappedIds) {
mappedIdsAndObjType.add(new AbstractMap.SimpleEntry<>(id, WORK_OBJECT_TYPE));
}
}

// files
if (options.isWithFiles() && !options.isWithWorks()) {
if (options.isWithFiles()) {
// for every file in the project (compound children and grouped children)
// If the entry type is null, the object is a individual cdm object
String fileQuery = "select distinct " + CdmFieldInfo.CDM_ID +
String fileQuery = "select " + CdmFieldInfo.CDM_ID +
" from " + CdmIndexService.TB_NAME
+ " where " + CdmIndexService.ENTRY_TYPE_FIELD + " = '" + CdmIndexService.ENTRY_TYPE_COMPOUND_CHILD + "'"
+ " or " + CdmIndexService.ENTRY_TYPE_FIELD + " is null"
+ " and " + CdmIndexService.PARENT_ID_FIELD + " is not null";
mappedIds = getIds(fileQuery);
for (String id : mappedIds) {
mappedIdsAndObjType.add(new AbstractMap.SimpleEntry<>(id, FILE_OBJECT_TYPE));
}
}

return mappedIds;
return mappedIdsAndObjType.stream().sorted(Map.Entry.comparingByKey()).collect(Collectors.toList());
}

private boolean doesIdExistInIndex(String id) {
Expand All @@ -265,6 +270,24 @@ private boolean doesIdExistInIndex(String id) {
}
}

private String getObjectType(String id) {
String query = WORK_QUERY + " and " + CdmFieldInfo.CDM_ID + " = '" + id + "'";

getIndexService();
try (Connection conn = indexService.openDbConnection()) {
var stmt = conn.createStatement();
var rs = stmt.executeQuery(query);
while (rs.next()) {
if (!rs.getString(1).isEmpty()) {
return WORK_OBJECT_TYPE;
}
}
return FILE_OBJECT_TYPE;
} catch (SQLException e) {
throw new MigrationException("Error interacting with export index", e);
}
}

private List<List<String>> updateCsvRecords(PermissionMappingOptions options) {
List<CSVRecord> previousRecords = getPermissions();
List<List<String>> updatedRecords = new ArrayList<>();
Expand All @@ -276,15 +299,16 @@ private List<List<String>> updateCsvRecords(PermissionMappingOptions options) {
for (CSVRecord record : previousRecords) {
cdmIds.add(record.get(0));
if (record.get(0).equals(options.getCdmId())) {
updatedRecords.add(Arrays.asList(record.get(0), everyoneField, authenticatedField));
updatedRecords.add(Arrays.asList(record.get(0), record.get(1), everyoneField, authenticatedField));
} else {
updatedRecords.add(Arrays.asList(record.get(0), record.get(1), record.get(2)));
updatedRecords.add(Arrays.asList(record.get(0), record.get(1), record.get(2), record.get(3)));
}
}

// add new entry
if (!cdmIds.contains(options.getCdmId())) {
updatedRecords.add(Arrays.asList(options.getCdmId(), everyoneField, authenticatedField));
String objectType = getObjectType(options.getCdmId());
updatedRecords.add(Arrays.asList(options.getCdmId(), objectType, everyoneField, authenticatedField));
}

return updatedRecords;
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/edu/unc/lib/boxc/migration/cdm/validators/PermissionsValidator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ public List<String> validateMappings() {
) {
int i = 2;
for (CSVRecord csvRecord : csvParser) {
if (csvRecord.size() != 3) {
errors.add("Invalid entry at line " + i + ", must be 3 columns but were " + csvRecord.size());
if (csvRecord.size() != 4) {
errors.add("Invalid entry at line " + i + ", must be 4 columns but were " + csvRecord.size());
i++;
continue;
}
String id = csvRecord.get(0);
String everyone = csvRecord.get(1);
String authenticated = csvRecord.get(2);
String everyone = csvRecord.get(2);
String authenticated = csvRecord.get(3);

// default values
if (PermissionsInfo.DEFAULT_ID.equals(id)) {
Expand Down
4 changes: 2 additions & 2 deletions src/test/java/edu/unc/lib/boxc/migration/cdm/PermissionsCommandIT.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ public void validateInvalidDefaultPermissions() throws Exception {

// Add a duplicate default permissions mapping
FileUtils.write(project.getPermissionsPath().toFile(),
"default,none,none", StandardCharsets.UTF_8, true);
"default,,none,none", StandardCharsets.UTF_8, true);

String[] args2 = new String[] {
"-w", project.getProjectPath().toString(),
Expand All @@ -299,7 +299,7 @@ public void validateInvalidDefaultPermissions() throws Exception {
@Test
public void validateValidSetPermissions() throws Exception {
FileUtils.write(project.getPermissionsPath().toFile(),
"25,canViewOriginals,canViewOriginals", StandardCharsets.UTF_8, true);
"25,work,canViewOriginals,canViewOriginals", StandardCharsets.UTF_8, true);

testHelper.indexExportData("mini_gilmer");
String[] args = new String[] {
Expand Down
Loading

0 comments on commit a0483be

Please sign in to comment.