src: format Java files with google-java-format

Using AOSP format so we get four spaces instead of two.
src: organize imports in VS Code
2024-11-28 09:38:21 +01:00 · 2022-10-06 14:27:51 +03:00 · 2022-10-06 14:26:44 +03:00 · 2022-10-06 14:17:41 +03:00 · 2022-10-06 14:15:58 +03:00
6 changed files with 252 additions and 178 deletions
--- a/src/main/java/io/github/ilri/cgspace/ctasks/CountriesVocabulary.java
+++ b/src/main/java/io/github/ilri/cgspace/ctasks/CountriesVocabulary.java
@ -19,7 +19,8 @@ public class CountriesVocabulary {
        private String alpha_2; // required
        private String alpha_3; // required

-        public Country(String name,
+        public Country(
+                String name,
                @Nullable String common_name,
                @Nullable String official_name,
                @Nullable String cgspace_name,
@ -30,7 +31,9 @@ public class CountriesVocabulary {
            this.common_name = common_name;
            this.official_name = official_name;
            this.cgspace_name = cgspace_name;
-            this.numeric = numeric; // fuuuuu this is a string and we can't cast to Integer because some values are zeropadded like "004"
+            this.numeric =
+                    numeric; // fuuuuu this is a string and we can't cast to Integer because some
+                             // values are zeropadded like "004"
            this.alpha_2 = alpha_2;
            this.alpha_3 = alpha_3;
        }
--- a/src/main/java/io/github/ilri/cgspace/ctasks/CountryCodeTagger.java
+++ b/src/main/java/io/github/ilri/cgspace/ctasks/CountryCodeTagger.java
@ -7,6 +7,7 @@
 package io.github.ilri.cgspace.ctasks;

 import com.google.gson.Gson;
+
 import org.apache.log4j.Logger;
 import org.dspace.authorize.AuthorizeException;
 import org.dspace.content.DSpaceObject;
@ -23,11 +24,11 @@ import java.sql.SQLException;
 import java.util.ArrayList;
 import java.util.List;

-public class CountryCodeTagger extends AbstractCurationTask
-{
+public class CountryCodeTagger extends AbstractCurationTask {
    public class CountryCodeTaggerConfig {
        private final String isocodesJsonPath = "/io/github/ilri/cgspace/ctasks/iso_3166-1.json";
-        private final String cgspaceCountriesJsonPath = "/io/github/ilri/cgspace/ctasks/cgspace-countries.json";
+        private final String cgspaceCountriesJsonPath =
+                "/io/github/ilri/cgspace/ctasks/cgspace-countries.json";
        private final String iso3166Field = taskProperty("iso3166.field");
        private final String iso3166Alpha2Field = taskProperty("iso3166-alpha2.field");
        private final boolean forceupdate = taskBooleanProperty("forceupdate", false);
@ -57,13 +58,11 @@ public class CountryCodeTagger extends AbstractCurationTask
    }

    @Override
-    public int perform(DSpaceObject dso) throws IOException
-    {
+    public int perform(DSpaceObject dso) throws IOException {
        // gotta define this here so we can access it after the if context...
        CountryCodeTaggerResult alpha2Result = new CountryCodeTaggerResult();

-		if (dso.getType() == Constants.ITEM)
-        {
+        if (dso.getType() == Constants.ITEM) {
            // Load configuration
            CountryCodeTaggerConfig config = new CountryCodeTaggerConfig();

@ -82,11 +81,13 @@ public class CountryCodeTagger extends AbstractCurationTask
        return alpha2Result.getStatus();
    }

-    public CountryCodeTaggerResult performAlpha2(Item item, CountryCodeTaggerConfig config) throws IOException, SQLException {
+    public CountryCodeTaggerResult performAlpha2(Item item, CountryCodeTaggerConfig config)
+            throws IOException, SQLException {
        CountryCodeTaggerResult alpha2Result = new CountryCodeTaggerResult();
        String itemHandle = item.getHandle();

-        List<MetadataValue> itemCountries = itemService.getMetadataByMetadataString(item, config.iso3166Field);
+        List<MetadataValue> itemCountries =
+                itemService.getMetadataByMetadataString(item, config.iso3166Field);

        // skip items that don't have country metadata
        if (itemCountries.size() == 0) {
@ -95,31 +96,55 @@ public class CountryCodeTagger extends AbstractCurationTask
        } else {
            Gson gson = new Gson();

-            // TODO: convert to try: https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html
-            BufferedReader reader = new BufferedReader(new InputStreamReader(this.getClass().getResourceAsStream(config.isocodesJsonPath)));
-            ISO3166CountriesVocabulary isocodesCountriesJson = gson.fromJson(reader, ISO3166CountriesVocabulary.class);
+            // TODO: convert to try:
+            // https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html
+            BufferedReader reader =
+                    new BufferedReader(
+                            new InputStreamReader(
+                                    this.getClass().getResourceAsStream(config.isocodesJsonPath)));
+            ISO3166CountriesVocabulary isocodesCountriesJson =
+                    gson.fromJson(reader, ISO3166CountriesVocabulary.class);
            reader.close();

-            reader = new BufferedReader(new InputStreamReader(this.getClass().getResourceAsStream(config.cgspaceCountriesJsonPath)));
-            CGSpaceCountriesVocabulary cgspaceCountriesJson = gson.fromJson(reader, CGSpaceCountriesVocabulary.class);
+            reader =
+                    new BufferedReader(
+                            new InputStreamReader(
+                                    this.getClass()
+                                            .getResourceAsStream(config.cgspaceCountriesJsonPath)));
+            CGSpaceCountriesVocabulary cgspaceCountriesJson =
+                    gson.fromJson(reader, CGSpaceCountriesVocabulary.class);
            reader.close();

-            // split the alpha2 country code field into schema, element, and qualifier so we can use it with item.addMetadata()
+            // split the alpha2 country code field into schema, element, and qualifier so we can use
+            // it with item.addMetadata()
            String[] iso3166Alpha2FieldParts = config.iso3166Alpha2Field.split("\\.");

            if (config.forceupdate) {
-                itemService.clearMetadata(Curator.curationContext(), item, iso3166Alpha2FieldParts[0], iso3166Alpha2FieldParts[1], iso3166Alpha2FieldParts[2], Item.ANY);
+                itemService.clearMetadata(
+                        Curator.curationContext(),
+                        item,
+                        iso3166Alpha2FieldParts[0],
+                        iso3166Alpha2FieldParts[1],
+                        iso3166Alpha2FieldParts[2],
+                        Item.ANY);
            }

            // check the item's country codes, if any
-            List<MetadataValue> itemAlpha2CountryCodes = itemService.getMetadataByMetadataString(item, config.iso3166Alpha2Field);
+            List<MetadataValue> itemAlpha2CountryCodes =
+                    itemService.getMetadataByMetadataString(item, config.iso3166Alpha2Field);

            if (itemAlpha2CountryCodes.size() == 0) {
                List<String> newAlpha2Codes = new ArrayList<String>();
                for (MetadataValue itemCountry : itemCountries) {
                    // check ISO 3166-1 countries
                    for (CountriesVocabulary.Country country : isocodesCountriesJson.countries) {
-                        if (itemCountry.getValue().equalsIgnoreCase(country.getName()) || itemCountry.getValue().equalsIgnoreCase(country.get_official_name()) || itemCountry.getValue().equalsIgnoreCase(country.get_common_name())) {
+                        if (itemCountry.getValue().equalsIgnoreCase(country.getName())
+                                || itemCountry
+                                        .getValue()
+                                        .equalsIgnoreCase(country.get_official_name())
+                                || itemCountry
+                                        .getValue()
+                                        .equalsIgnoreCase(country.get_common_name())) {
                            newAlpha2Codes.add(country.getAlpha_2());
                        }
                    }
@ -134,7 +159,14 @@ public class CountryCodeTagger extends AbstractCurationTask

                if (newAlpha2Codes.size() > 0) {
                    try {
-                        itemService.addMetadata(Curator.curationContext(), item, iso3166Alpha2FieldParts[0], iso3166Alpha2FieldParts[1], iso3166Alpha2FieldParts[2], "en_US", newAlpha2Codes);
+                        itemService.addMetadata(
+                                Curator.curationContext(),
+                                item,
+                                iso3166Alpha2FieldParts[0],
+                                iso3166Alpha2FieldParts[1],
+                                iso3166Alpha2FieldParts[2],
+                                "en_US",
+                                newAlpha2Codes);
                        itemService.update(Curator.curationContext(), item);
                    } catch (SQLException | AuthorizeException sqle) {
                        config.log.debug(sqle.getMessage());
@ -142,7 +174,11 @@ public class CountryCodeTagger extends AbstractCurationTask
                        alpha2Result.setStatus(Curator.CURATE_ERROR);
                    }

-                    alpha2Result.setResult(itemHandle + ": added " + newAlpha2Codes.size() + " alpha2 country code(s)");
+                    alpha2Result.setResult(
+                            itemHandle
+                                    + ": added "
+                                    + newAlpha2Codes.size()
+                                    + " alpha2 country code(s)");
                } else {
                    alpha2Result.setResult(itemHandle + ": no matching countries found");
                }
--- a/src/main/java/io/github/ilri/cgspace/ctasks/ISO3166CountriesVocabulary.java
+++ b/src/main/java/io/github/ilri/cgspace/ctasks/ISO3166CountriesVocabulary.java
@ -7,9 +7,12 @@
 package io.github.ilri.cgspace.ctasks;

 import com.google.gson.annotations.SerializedName;
+
 import java.util.List;

 public class ISO3166CountriesVocabulary extends CountriesVocabulary {
-    // support reading iso_3166-1.json from Debian's iso-codes package using SerializedName since our class needs to match the JSON exactly
-    @SerializedName("3166-1") List<Country> countries;
+    // support reading iso_3166-1.json from Debian's iso-codes package using SerializedName since
+    // our class needs to match the JSON exactly
+    @SerializedName("3166-1")
+    List<Country> countries;
 }
--- a/src/main/java/io/github/ilri/cgspace/scripts/FixJpgJpgThumbnails.java
+++ b/src/main/java/io/github/ilri/cgspace/scripts/FixJpgJpgThumbnails.java
@ -8,14 +8,20 @@ package io.github.ilri.cgspace.scripts;

 import org.apache.commons.lang.StringUtils;
 import org.dspace.authorize.AuthorizeException;
-import org.dspace.content.*;
+import org.dspace.content.Bitstream;
+import org.dspace.content.Bundle;
+import org.dspace.content.Collection;
+import org.dspace.content.Community;
+import org.dspace.content.DSpaceObject;
+import org.dspace.content.Item;
+import org.dspace.content.MetadataValue;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.BundleService;
+import org.dspace.content.service.ItemService;
 import org.dspace.core.Constants;
 import org.dspace.core.Context;
-import org.dspace.content.factory.ContentServiceFactory;
-import org.dspace.content.service.ItemService;
 import org.dspace.handle.factory.HandleServiceFactory;
 import org.dspace.handle.service.HandleService;
-import org.dspace.content.service.BundleService;

 import java.io.IOException;
 import java.sql.SQLException;
@ -31,8 +37,10 @@ import java.util.List;
 public class FixJpgJpgThumbnails {
    // note: static members belong to the class itself, not any one instance
    public static ItemService itemService = ContentServiceFactory.getInstance().getItemService();
-	public static HandleService handleService = HandleServiceFactory.getInstance().getHandleService();
-	public static BundleService bundleService = ContentServiceFactory.getInstance().getBundleService();
+    public static HandleService handleService =
+            HandleServiceFactory.getInstance().getHandleService();
+    public static BundleService bundleService =
+            ContentServiceFactory.getInstance().getBundleService();

    public static void main(String[] args) {
        String parentHandle = null;
@ -52,12 +60,16 @@ public class FixJpgJpgThumbnails {
                if (parent != null) {
                    switch (parent.getType()) {
                        case Constants.COLLECTION:
-							process(context, itemService.findByCollection(context, (Collection) parent));
+                            process(
+                                    context,
+                                    itemService.findByCollection(context, (Collection) parent));
                            break;
                        case Constants.COMMUNITY:
                            List<Collection> collections = ((Community) parent).getCollections();
                            for (Collection collection : collections) {
-								process(context, itemService.findAllByCollection(context, collection));
+                                process(
+                                        context,
+                                        itemService.findAllByCollection(context, collection));
                            }
                            break;
                        case Constants.SITE:
@ -79,7 +91,8 @@ public class FixJpgJpgThumbnails {
        }
    }

-	private static void process(Context context, Iterator<Item> items) throws SQLException, IOException, AuthorizeException {
+    private static void process(Context context, Iterator<Item> items)
+            throws SQLException, IOException, AuthorizeException {
        while (items.hasNext()) {
            Item item = items.next();
            processItem(context, item);
@ -87,14 +100,18 @@ public class FixJpgJpgThumbnails {
        }
    }

-	private static void processItem(Context context, Item item) throws SQLException, AuthorizeException, IOException {
-		// Some bitstreams like Infographics are large JPGs and put in the ORIGINAL bundle on purpose so we shouldn't
+    private static void processItem(Context context, Item item)
+            throws SQLException, AuthorizeException, IOException {
+        // Some bitstreams like Infographics and Maps are large JPEGs and put in the ORIGINAL bundle
+        // on purpose so we shouldn't
        // swap them.
-		List<MetadataValue> itemTypes = itemService.getMetadataByMetadataString(item, "dcterms.type");
-		boolean itemHasInfographic = false;
+        List<MetadataValue> itemTypes =
+                itemService.getMetadataByMetadataString(item, "dcterms.type");
        for (MetadataValue itemType : itemTypes) {
-			if (itemType.getValue().equals("Infographic")) {
-				itemHasInfographic = true;
+            if (itemType.getValue().equals("Infographic") || itemType.getValue().equals("Map")) {
+                System.out.println(
+                        item.getHandle() + ": item has an Infographic or Map, skipping.");
+                return;
            }
        }

@ -103,6 +120,12 @@ public class FixJpgJpgThumbnails {
            List<Bitstream> thumbnailBundleBitstreams = thumbnailBundle.getBitstreams();
            for (Bitstream thumbnailBitstream : thumbnailBundleBitstreams) {
                String thumbnailName = thumbnailBitstream.getName();
+                String thumbnailDescription = thumbnailBitstream.getDescription();
+
+                // There is no point continuing if the thumbnail's description is empty or null
+                if (StringUtils.isEmpty(thumbnailDescription)) {
+                    continue;
+                }

                if (thumbnailName.toLowerCase().contains(".jpg.jpg")) {
                    List<Bundle> originalBundles = item.getBundles("ORIGINAL");
@ -117,21 +140,25 @@ public class FixJpgJpgThumbnails {
                            /*
                            - check if the original file name is the same as the thumbnail name minus the extra ".jpg"
                            - check if the thumbnail description indicates it was automatically generated
-							- check if the item has dc.type Infographic (JPG could be the "real" item!)
                            - check if the original bitstream is less than ~100KiB
                                - Note: in my tests there were 4022 items with ".jpg.jpg" thumbnails totaling 394549249
                                  bytes for an average of about 98KiB so ~100KiB seems like a good cut off
                            */
-							if (
-									originalName.equalsIgnoreCase(StringUtils.removeEndIgnoreCase(thumbnailName, ".jpg"))
-									&& ("Generated Thumbnail".equals(thumbnailBitstream.getDescription()) || "IM Thumbnail".equals(thumbnailBitstream.getDescription()))
-									&& !itemHasInfographic
-									&& originalBitstreamBytes < 100000
-							) {
-								System.out.println(item.getHandle() + ": replacing " + thumbnailName + " with " + originalName);
+                            if (originalName.equalsIgnoreCase(
+                                            StringUtils.removeEndIgnoreCase(thumbnailName, ".jpg"))
+                                    && ("Generated Thumbnail".equals(thumbnailDescription)
+                                            || "IM Thumbnail".equals(thumbnailDescription))
+                                    && originalBitstreamBytes < 100000) {
+                                System.out.println(
+                                        item.getHandle()
+                                                + ": replacing "
+                                                + thumbnailName
+                                                + " with "
+                                                + originalName);

                                // add the original bitstream to the THUMBNAIL bundle
-								bundleService.addBitstream(context, thumbnailBundle, originalBitstream);
+                                bundleService.addBitstream(
+                                        context, thumbnailBundle, originalBitstream);
                                // remove the original bitstream from the ORIGINAL bundle
                                originalBundle.removeBitstream(originalBitstream);
                                // remove the JpgJpg bitstream from the THUMBNAIL bundle
--- a/src/main/java/io/github/ilri/cgspace/scripts/FixLowQualityThumbnails.java
+++ b/src/main/java/io/github/ilri/cgspace/scripts/FixLowQualityThumbnails.java
@ -8,7 +8,12 @@ package io.github.ilri.cgspace.scripts;

 import org.apache.commons.lang.StringUtils;
 import org.dspace.authorize.AuthorizeException;
-import org.dspace.content.*;
+import org.dspace.content.Bitstream;
+import org.dspace.content.Bundle;
+import org.dspace.content.Collection;
+import org.dspace.content.Community;
+import org.dspace.content.DSpaceObject;
+import org.dspace.content.Item;
 import org.dspace.content.factory.ContentServiceFactory;
 import org.dspace.content.service.BundleService;
 import org.dspace.content.service.ItemService;
Author	SHA1	Message	Date
Alan Orth	b396fba043	src: format Java files with google-java-format Using AOSP format so we get four spaces instead of two.	2022-10-06 14:27:51 +03:00
Alan Orth	38a9cc5188	src: organize imports in VS Code	2022-10-06 14:26:44 +03:00
Alan Orth	16db38967b	src: handle null descriptions in FixJpgJpgThumbnails	2022-10-06 14:17:41 +03:00
Alan Orth	2604dc3cce	src: skip Infographics and Maps in FixJpgJpgThumbnails Instead of checking whether they exist and then skipping them just at the moment when we want to swap the bitstreams let's bail early when we know an item is an Infographic or a Map.	2022-10-06 14:15:58 +03:00