Script to delete all the values of a specified metadata field

dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataDeletion.java

@@ -0,0 +1,72 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+
+import java.sql.SQLException;
+
+import org.apache.commons.cli.ParseException;
+import org.dspace.content.MetadataField;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.MetadataFieldService;
+import org.dspace.content.service.MetadataValueService;
+import org.dspace.core.Context;
+import org.dspace.scripts.DSpaceRunnable;
+import org.dspace.utils.DSpace;
+
+/**
+ * {@link DSpaceRunnable} implementation to delete all the values of the given
+ * metadata field.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class MetadataDeletion extends DSpaceRunnable<MetadataDeletionScriptConfiguration<MetadataDeletion>> {
+
+    private String metadataField;
+
+    @Override
+    public void internalRun() throws Exception {
+        Context context = new Context();
+        context.turnOffAuthorisationSystem();
+
+        MetadataValueService metadataValueService = ContentServiceFactory.getInstance()
+            .getMetadataValueService();
+
+        MetadataFieldService metadataFieldService = ContentServiceFactory.getInstance()
+            .getMetadataFieldService();
+
+        try {
+
+            MetadataField field = metadataFieldService.findByString(context, metadataField, '.');
+            if (field == null) {
+                throw new IllegalArgumentException("No metadata field found with name " + metadataField);
+            }
+
+            metadataValueService.deleteByMetadataField(context, field);
+
+        } catch (SQLException e) {
+            handler.handleException(e);
+        }
+
+        context.restoreAuthSystemState();
+        context.complete();
+    }
+
+    @Override
+    @SuppressWarnings("unchecked")
+    public MetadataDeletionScriptConfiguration<MetadataDeletion> getScriptConfiguration() {
+        return new DSpace().getServiceManager()
+            .getServiceByName("metadata-deletion", MetadataDeletionScriptConfiguration.class);
+    }
+
+    @Override
+    public void setup() throws ParseException {
+        metadataField = commandLine.getOptionValue('m');
+    }
+
+}

dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataDeletionCli.java

@@ -0,0 +1,18 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+
+/**
+ * The {@link MetadataDeletion} for CLI.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class MetadataDeletionCli extends MetadataDeletion {
+
+}

dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataDeletionCliScriptConfiguration.java

@@ -0,0 +1,18 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+
+/**
+ * Script configuration for {@link MetadataDeletionCli}.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class MetadataDeletionCliScriptConfiguration extends MetadataDeletionScriptConfiguration<MetadataDeletionCli> {
+
+}

dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataDeletionScriptConfiguration.java

@@ -0,0 +1,62 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+
+import java.sql.SQLException;
+
+import org.apache.commons.cli.Options;
+import org.dspace.authorize.service.AuthorizeService;
+import org.dspace.core.Context;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+import org.springframework.beans.factory.annotation.Autowired;
+
+/**
+ * The {@link ScriptConfiguration} for the {@link MetadataDeletion} script.
+ */
+public class MetadataDeletionScriptConfiguration<T extends MetadataDeletion> extends ScriptConfiguration<T> {
+
+    @Autowired
+    private AuthorizeService authorizeService;
+
+    private Class<T> dspaceRunnableClass;
+
+    @Override
+    public boolean isAllowedToExecute(Context context) {
+        try {
+            return authorizeService.isAdmin(context);
+        } catch (SQLException e) {
+            throw new RuntimeException("SQLException occurred when checking if the current user is an admin", e);
+        }
+    }
+
+    @Override
+    public Options getOptions() {
+        if (options == null) {
+            Options options = new Options();
+            options.addOption("m", "metadata", true, "metadata field name");
+            options.getOption("m").setType(String.class);
+            super.options = options;
+        }
+        return options;
+    }
+
+    @Override
+    public Class<T> getDspaceRunnableClass() {
+        return dspaceRunnableClass;
+    }
+
+    /**
+     * Generic setter for the dspaceRunnableClass
+     * @param dspaceRunnableClass   The dspaceRunnableClass to be set on this MetadataDeletionScriptConfiguration
+     */
+    @Override
+    public void setDspaceRunnableClass(Class<T> dspaceRunnableClass) {
+        this.dspaceRunnableClass = dspaceRunnableClass;
+    }
+
+}

dspace-api/src/test/data/dspaceFolder/config/spring/api/scripts.xml

@@ -34,6 +34,11 @@
         <property name="description" value="Retry all failed commits to the OpenURLTracker"/>
         <property name="dspaceRunnableClass" value="org.dspace.statistics.export.RetryFailedOpenUrlTracker"/>
     </bean>
+    
+    <bean id="metadata-deletion" class="org.dspace.app.bulkedit.MetadataDeletionCliScriptConfiguration">
+        <property name="description" value="Delete all the values of the specified metadata field"/>
+        <property name="dspaceRunnableClass" value="org.dspace.app.bulkedit.MetadataDeletionCli"/>
+    </bean>
 
     <bean id="another-mock-script" class="org.dspace.scripts.MockDSpaceRunnableScriptConfiguration" scope="prototype">
         <property name="description" value="Mocking a script for testing purposes" />

dspace-api/src/test/java/org/dspace/app/bulkedit/MetadataDeletionIT.java

@@ -0,0 +1,70 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import org.dspace.AbstractIntegrationTestWithDatabase;
+import org.dspace.app.launcher.ScriptLauncher;
+import org.dspace.app.scripts.handler.impl.TestDSpaceRunnableHandler;
+import org.dspace.builder.CollectionBuilder;
+import org.dspace.builder.CommunityBuilder;
+import org.dspace.builder.ItemBuilder;
+import org.dspace.content.Collection;
+import org.dspace.content.Community;
+import org.dspace.content.MetadataField;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.MetadataFieldService;
+import org.dspace.content.service.MetadataValueService;
+import org.junit.Test;
+
+/**
+ * Integration tests for {@link MetadataDeletion}.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class MetadataDeletionIT extends AbstractIntegrationTestWithDatabase {
+
+    private MetadataValueService metadataValueService = ContentServiceFactory.getInstance().getMetadataValueService();
+
+    private MetadataFieldService metadataFieldService = ContentServiceFactory.getInstance().getMetadataFieldService();
+
+    @Test
+    public void metadataDeletionTest() throws Exception {
+
+        context.turnOffAuthorisationSystem();
+        Community community = CommunityBuilder.createCommunity(context).build();
+        Collection collection = CollectionBuilder.createCollection(context, community).build();
+        createItem(collection, "My First publication", "Mario Rossi");
+        createItem(collection, "Another publication", "John Smith");
+        context.restoreAuthSystemState();
+
+        MetadataField titleField = metadataFieldService.findByElement(context, "dc", "title", null);
+        MetadataField authorField = metadataFieldService.findByElement(context, "dc", "contributor", "author");
+
+        assertEquals(2, metadataValueService.findByField(context, titleField).size());
+        assertEquals(2, metadataValueService.findByField(context, authorField).size());
+
+        TestDSpaceRunnableHandler testDSpaceRunnableHandler = new TestDSpaceRunnableHandler();
+
+        String[] args = new String[] { "metadata-deletion", "-m", "dc.title" };
+        ScriptLauncher.handleScript(args, ScriptLauncher.getConfig(kernelImpl), testDSpaceRunnableHandler, kernelImpl);
+
+        assertTrue(metadataValueService.findByField(context, titleField).isEmpty());
+        assertEquals(2, metadataValueService.findByField(context, authorField).size());
+    }
+
+    private void createItem(Collection collection, String title, String author) {
+        ItemBuilder.createItem(context, collection)
+            .withTitle(title)
+            .withAuthor(author)
+            .build();
+    }
+}

dspace-server-webapp/src/test/data/dspaceFolder/config/spring/rest/scripts.xml

@@ -22,4 +22,9 @@
         <property name="description" value="Curation tasks"/>
         <property name="dspaceRunnableClass" value="org.dspace.curate.Curation"/>
     </bean>
+    
+     <bean id="metadata-deletion" class="org.dspace.app.bulkedit.MetadataDeletionScriptConfiguration" primary="true">
+        <property name="description" value="Delete all the values of the specified metadata field"/>
+        <property name="dspaceRunnableClass" value="org.dspace.app.bulkedit.MetadataDeletion"/>
+    </bean>
 </beans>

dspace/config/spring/api/scripts.xml

@@ -35,4 +35,9 @@
         <property name="description" value="Script for migrating submission forms to DSpace 7"/>
         <property name="dspaceRunnableClass" value="org.dspace.submit.migration.SubmissionFormsMigration"/>
     </bean>
+
+    <bean id="metadata-deletion" class="org.dspace.app.bulkedit.MetadataDeletionCliScriptConfiguration">
+        <property name="description" value="Delete all the values of the specified metadata field"/>
+        <property name="dspaceRunnableClass" value="org.dspace.app.bulkedit.MetadataDeletionCli"/>
+    </bean>
 </beans>

dspace/config/spring/rest/scripts.xml

@@ -28,4 +28,9 @@
         <property name="description" value="Script for migrating submission forms to DSpace 7"/>
         <property name="dspaceRunnableClass" value="org.dspace.submit.migration.SubmissionFormsMigration"/>
     </bean>
+    
+    <bean id="metadata-deletion" class="org.dspace.app.bulkedit.MetadataDeletionScriptConfiguration" primary="true">
+        <property name="description" value="Delete all the values of the specified metadata field"/>
+        <property name="dspaceRunnableClass" value="org.dspace.app.bulkedit.MetadataDeletion"/>
+    </bean>
 </beans>