gh-5042 Allow the import of deleted proc filters

Author: at055612

stroom-core-client/src/main/java/stroom/importexport/client/presenter/ImportConfigConfirmPresenter.java

@@ -35,10 +35,12 @@
 import stroom.importexport.shared.ImportSettings;
 import stroom.importexport.shared.ImportSettings.ImportMode;
 import stroom.importexport.shared.ImportState;
+import stroom.importexport.shared.ImportState.State;
 import stroom.security.shared.DocumentPermission;
 import stroom.svg.client.Preset;
 import stroom.svg.client.SvgPresets;
 import stroom.util.shared.Message;
+import stroom.util.shared.NullSafe;
 import stroom.util.shared.ResourceKey;
 import stroom.util.shared.Severity;
 import stroom.widget.popup.client.event.HidePopupRequestEvent;
@@ -67,7 +69,10 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.function.Consumer;
+import java.util.function.Function;
+import java.util.stream.Collectors;
 
 public class ImportConfigConfirmPresenter extends
         MyPresenter<ImportConfigConfirmPresenter.ImportConfigConfirmView,
@@ -158,7 +163,9 @@ public void onConfirmImport(final ImportConfigConfirmEvent event) {
 
     @Override
     protected void revealInParent() {
-        final PopupSize popupSize = PopupSize.resizable(800, 800, 380, 480);
+        final PopupSize popupSize = PopupSize.resizable(
+                1200, 800,
+                380, 480);
         ShowPopupEvent.builder(this)
                 .popupType(PopupType.OK_CANCEL_DIALOG)
                 .popupSize(popupSize)
@@ -226,26 +233,75 @@ public void onHideRequest(final HidePopupRequestEvent e) {
                 AlertEvent.fireWarn(
                         ImportConfigConfirmPresenter.this,
                         "No items are selected for import", e::reset);
-            } else if (warnings) {
-                ConfirmEvent.fireWarn(ImportConfigConfirmPresenter.this,
-                        "There are warnings in the items selected.  Are you sure you want to import?.",
-                        result -> {
-                            if (result) {
-                                importData(e);
-                            } else {
-                                // Re-enable popup buttons.
-                                e.reset();
-                            }
-                        });
-
             } else {
-                importData(e);
+                final String ownedDocumentsMsg = checkOwnedDocuments();
+                if (NullSafe.isNonEmptyString(ownedDocumentsMsg)) {
+                    AlertEvent.fireWarn(ImportConfigConfirmPresenter.this, ownedDocumentsMsg, e::reset);
+                } else if (warnings) {
+                    ConfirmEvent.fireWarn(ImportConfigConfirmPresenter.this,
+                            "There are warnings in the items selected.  Are you sure you want to import?.",
+                            result -> {
+                                if (result) {
+                                    importData(e);
+                                } else {
+                                    // Re-enable popup buttons.
+                                    e.reset();
+                                }
+                            });
+                } else {
+                    importData(e);
+                }
             }
         } else {
             abortImport(e);
         }
     }
 
+    private String checkOwnedDocuments() {
+        //noinspection SimplifyStreamApiCallChains // Cos GWT
+        final List<ImportState> selectedAndOwned = NullSafe.stream(confirmList)
+                .filter(ImportState::isAction)
+                .filter(importState -> importState.getState() != State.IGNORE)
+                .filter(importState -> importState.getOwnerDocRef() != null)
+                .collect(Collectors.toList());
+
+        if (!selectedAndOwned.isEmpty()) {
+            final Map<DocRef, ImportState> selectedDocRefToStateMap = NullSafe.stream(confirmList)
+                    .collect(Collectors.toMap(ImportState::getDocRef, Function.identity()));
+
+            for (final ImportState importState : selectedAndOwned) {
+                final DocRef ownerDocRef = importState.getOwnerDocRef();
+                final ImportState ownerImportState = selectedDocRefToStateMap.get(ownerDocRef);
+
+                final DocRef ownedDocRef = importState.getDocRef();
+                if (ownerImportState == null
+                    || (!ownerImportState.isAction()
+                        && (ownerImportState.getState() == State.NEW || ownerImportState.getState() == State.IGNORE))) {
+                    return "You have selected " + docRefToString(ownedDocRef)
+                           + " without selecting its parent document " + docRefToString(ownerDocRef)
+                           + ". You must also select its parent.";
+                } else if (ownerImportState.getSeverity().greaterThanOrEqual(Severity.ERROR)) {
+                    return "You have selected " + docRefToString(ownedDocRef)
+                           + " but its parent document " + docRefToString(ownerDocRef)
+                           + " cannot be imported due to an error. You cannot import this document.";
+                }
+            }
+        }
+        return null;
+    }
+
+    private String docRefToString(final DocRef docRef) {
+        if (docRef == null) {
+            return "";
+        } else {
+            if (docRef.getName() != null) {
+                return docRef.getType() + " '" + docRef.getName() + "' (" + docRef.getUuid() + ")";
+            } else {
+                return docRef.getType() + " " + docRef.getUuid();
+            }
+        }
+    }
+
     private void addColumns() {
         addSelectedColumn();
         addInfoColumn();
@@ -445,13 +501,16 @@ public void abortImport(final HidePopupRequestEvent e) {
 
         restFactory
                 .create(CONTENT_RESOURCE)
-                .method(res -> res.importContent(new ImportConfigRequest(resourceKey,
-                        importSettingsBuilder.build(),
-                        new ArrayList<>())))
-                .onSuccess(result2 -> AlertEvent.fireWarn(ImportConfigConfirmPresenter.this,
+                .method(res -> {
+                    res.abortImport(resourceKey);
+                    return null;
+                })
+                .onSuccess(ignored -> AlertEvent.fireWarn(
+                        ImportConfigConfirmPresenter.this,
                         "Import Aborted",
                         e::hide))
-                .onFailure(caught -> AlertEvent.fireError(ImportConfigConfirmPresenter.this,
+                .onFailure(caught -> AlertEvent.fireError(
+                        ImportConfigConfirmPresenter.this,
                         caught.getMessage(),
                         e::hide))
                 .taskMonitorFactory(this)

stroom-core-client/src/main/java/stroom/processor/client/presenter/ProcessorPresenter.java

@@ -429,23 +429,22 @@ private void removeProcessor() {
                     .filter(s -> s instanceof ProcessorFilterRow)
                     .map(s -> (ProcessorFilterRow) s)
                     .collect(Collectors.toList());
-            if (rows.size() > 0) {
+            if (!rows.isEmpty()) {
                 String message = "Are you sure you want to delete the selected filter?";
                 if (rows.size() > 1) {
                     message = "Are you sure you want to delete the selected filters?";
                 }
                 ConfirmEvent.fire(this, message, result -> {
                     if (result) {
-                        final CountDownAndRun countDownAndRun = new CountDownAndRun(rows.size(), () ->
-                                processorListPresenter.refresh());
+                        final CountDownAndRun countDownAndRun = new CountDownAndRun(
+                                rows.size(), processorListPresenter::refresh);
                         for (final ProcessorFilterRow row : rows) {
                             restFactory
                                     .create(PROCESSOR_FILTER_RESOURCE)
                                     .method(res -> res.delete(row.getProcessorFilter().getId()))
                                     .onSuccess(res ->
                                             countDownAndRun.countdown())
-                                    .onFailure(new DefaultErrorHandler(this, () ->
-                                            countDownAndRun.countdown()))
+                                    .onFailure(new DefaultErrorHandler(this, countDownAndRun::countdown))
                                     .taskMonitorFactory(this)
                                     .exec();
                         }

stroom-core-shared/src/main/java/stroom/importexport/shared/ContentResource.java

@@ -18,6 +18,7 @@
 
 import stroom.util.shared.DocRefs;
 import stroom.util.shared.ResourceGeneration;
+import stroom.util.shared.ResourceKey;
 import stroom.util.shared.ResourcePaths;
 import stroom.util.shared.RestResource;
 import stroom.util.shared.ResultPage;
@@ -47,6 +48,14 @@ public interface ContentResource extends RestResource, DirectRestService {
     ImportConfigResponse importContent(
             @NotNull @Parameter(description = "request", required = true) ImportConfigRequest request);
 
+    @POST
+    @Path("abortImport")
+    @Operation(
+            summary = "Abort Import",
+            operationId = "abortImport")
+    void abortImport(
+            @NotNull @Parameter(description = "request", required = true) ResourceKey resourceKey);
+
     @POST
     @Path("export")
     @Operation(

stroom-core-shared/src/main/java/stroom/importexport/shared/ImportSettings.java

@@ -74,7 +74,7 @@ public static boolean ok(final ImportSettings importSettings,
         }
 
         return ImportMode.IGNORE_CONFIRMATION.equals(importSettings.getImportMode())
-                || (ImportMode.ACTION_CONFIRMATION.equals(importSettings.getImportMode()) && importState.isAction());
+               || (ImportMode.ACTION_CONFIRMATION.equals(importSettings.getImportMode()) && importState.isAction());
     }
 
     public static Builder builder() {
@@ -108,15 +108,16 @@ public boolean equals(final Object o) {
         }
         final ImportSettings that = (ImportSettings) o;
         return enableFilters == that.enableFilters &&
-                useImportNames == that.useImportNames &&
-                useImportFolders == that.useImportFolders &&
-                importMode == that.importMode &&
-                Objects.equals(enableFiltersFromTime, that.enableFiltersFromTime) &&
-                Objects.equals(rootDocRef, that.rootDocRef);
+               useImportNames == that.useImportNames &&
+               useImportFolders == that.useImportFolders &&
+               importMode == that.importMode &&
+               Objects.equals(enableFiltersFromTime, that.enableFiltersFromTime) &&
+               Objects.equals(rootDocRef, that.rootDocRef);
     }
 
     /**
      * toString to aid debugging import
+     *
      * @return Meaningful string describing the object.
      */
     @Override
@@ -141,14 +142,20 @@ public int hashCode() {
                 rootDocRef);
     }
 
+
+    // --------------------------------------------------------------------------------
+
+
     public enum ImportMode {
         CREATE_CONFIRMATION,
         ACTION_CONFIRMATION,
         IGNORE_CONFIRMATION
     }
 
+
     // --------------------------------------------------------------------------------
 
+
     public static class Builder {
 
         private ImportMode importMode;

stroom-core-shared/src/main/java/stroom/importexport/shared/ImportState.java

@@ -50,6 +50,8 @@ public class ImportState {
     private final List<String> updatedFieldList;
     @JsonProperty
     private State state;
+    @JsonProperty
+    private DocRef ownerDocRef;
 
     @JsonCreator
     public ImportState(@JsonProperty("docRef") final DocRef docRef,
@@ -58,14 +60,16 @@ public ImportState(@JsonProperty("docRef") final DocRef docRef,
                        @JsonProperty("action") final boolean action,
                        @JsonProperty("messageList") final List<Message> messageList,
                        @JsonProperty("updatedFieldList") final List<String> updatedFieldList,
-                       @JsonProperty("state") final State state) {
+                       @JsonProperty("state") final State state,
+                       @JsonProperty("ownerDocRef") final DocRef ownerDocRef) {
         this.docRef = docRef;
         this.sourcePath = sourcePath;
         this.destPath = destPath;
         this.action = action;
         this.messageList = messageList;
         this.updatedFieldList = updatedFieldList;
         this.state = state;
+        this.ownerDocRef = ownerDocRef;
     }
 
     public ImportState(final DocRef docRef, final String sourcePath) {
@@ -95,6 +99,25 @@ public void setDestPath(final String destPath) {
         this.destPath = destPath;
     }
 
+    /**
+     * @return The owner document, if this is a non-explorer document that belongs to another document,
+     * e.g. a processor filter belongs to a Pipeline.
+     */
+    public DocRef getOwnerDocRef() {
+        return ownerDocRef;
+    }
+
+    /**
+     * @param ownerDocRef The owner document, if this is a non-explorer document that belongs to another document,
+     *                    e.g. a processor filter belongs to a Pipeline.
+     */
+    public void setOwnerDocRef(final DocRef ownerDocRef) {
+        this.ownerDocRef = ownerDocRef;
+    }
+
+    /**
+     * @return True if this item has been selected for import by the user.
+     */
     public boolean isAction() {
         return action;
     }
@@ -158,11 +181,16 @@ public String toString() {
         return docRef.toString();
     }
 
+
+    // --------------------------------------------------------------------------------
+
+
     public enum State implements HasDisplayValue {
         NEW("New"),
         UPDATE("Update"),
         EQUAL("Equal"),
-        IGNORE("Ignore");
+        IGNORE("Ignore"),
+        ;
 
         private final String displayValue;
 

stroom-core-shared/src/main/java/stroom/processor/shared/Processor.java

@@ -228,17 +228,17 @@ public void setDeleted(final boolean deleted) {
     @Override
     public String toString() {
         return "Processor{" +
-                "id=" + id +
-                ", version=" + version +
-                ", createTimeMs=" + createTimeMs +
-                ", createUser='" + createUser + '\'' +
-                ", updateTimeMs=" + updateTimeMs +
-                ", updateUser='" + updateUser + '\'' +
-                ", processorType='" + processorType + '\'' +
-                ", pipelineUuid='" + pipelineUuid + '\'' +
-                ", enabled=" + enabled +
-                ", deleted=" + deleted +
-                '}';
+               "id=" + id +
+               ", version=" + version +
+               ", createTimeMs=" + createTimeMs +
+               ", createUser='" + createUser + '\'' +
+               ", updateTimeMs=" + updateTimeMs +
+               ", updateUser='" + updateUser + '\'' +
+               ", processorType='" + processorType + '\'' +
+               ", pipelineUuid='" + pipelineUuid + '\'' +
+               ", enabled=" + enabled +
+               ", deleted=" + deleted +
+               '}';
     }
 
     @Override
@@ -257,4 +257,20 @@ public boolean equals(final Object o) {
     public int hashCode() {
         return Objects.hash(id);
     }
+
+    /**
+     * @return A new {@link DocRef} for this document's type with the supplied uuid.
+     */
+    public static DocRef getDocRef(final String uuid) {
+        return DocRef.builder(ENTITY_TYPE)
+                .uuid(uuid)
+                .build();
+    }
+
+    /**
+     * @return A new builder for creating a {@link DocRef} for this document's type.
+     */
+    public static DocRef.TypedBuilder buildDocRef() {
+        return DocRef.builder(ENTITY_TYPE);
+    }
 }