cgspace-java-helpers/src/main/java/org/cgiar/cgspace/ctasks/CountryCodeTagger.java

/*
    DSpace Curation Tasks
    Copyright (C) 2020  Alan Orth

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

package org.cgiar.cgspace.ctasks;

import com.google.gson.Gson;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.DSpaceObject;
import org.dspace.content.Item;
import org.dspace.content.Metadatum;
import org.dspace.core.ConfigurationManager;
import org.dspace.core.Constants;
import org.dspace.curate.AbstractCurationTask;
import org.dspace.curate.Curator;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import org.apache.log4j.Logger;

public class CountryCodeTagger extends AbstractCurationTask
{
    private int status = Curator.CURATE_UNSET;
    private String result = null;

    private static final String PLUGIN_PREFIX = "ilri";
    private static String isocodesJsonPath;
    private static String cgspaceCountriesJsonPath;
    private static String iso3166Field;
    private static String iso3166Alpha2Field;

    private List<String> results = new ArrayList<String>();

    private static Logger log = Logger.getLogger(CountryCodeTagger.class);

    @Override
    public int perform(DSpaceObject dso) throws IOException
    {
        // Load configuration
        isocodesJsonPath = "/org/cgiar/cgspace/ctasks/iso_3166-1.json";
        cgspaceCountriesJsonPath = "/org/cgiar/cgspace/ctasks/cgspace-countries.json";
        iso3166Field = ConfigurationManager.getProperty(PLUGIN_PREFIX, "countrycodes.iso3166.field");
        iso3166Alpha2Field = ConfigurationManager.getProperty(PLUGIN_PREFIX, "countrycodes.iso3166-alpha2.field");

		if (dso.getType() == Constants.ITEM)
        {
            Item item = (Item)dso;
            String itemHandle = item.getHandle();

            Metadatum[] itemCountries = item.getMetadataByMetadataString(iso3166Field);

            // skip items that don't have country metadata
            if (itemCountries.length == 0) {
                result = itemHandle + ": no countries, skipping.";
                status = Curator.CURATE_SKIP;
            } 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(isocodesJsonPath)));
                ISO3166CountriesVocabulary isocodesCountriesJson = gson.fromJson(reader, ISO3166CountriesVocabulary.class);
                reader.close();

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

                //System.out.println(itemHandle + ": " + itemCountries.length + " countries possibly need tagging");

                // check the item's country codes, if any
                Metadatum[] itemAlpha2CountryCodes = item.getMetadataByMetadataString(iso3166Alpha2Field);

                if (itemAlpha2CountryCodes.length == 0) {
                    //System.out.println(itemHandle + ": Should add codes for " + itemCountries.length + " countries.");

                    // split the alpha2 country code field into schema, element, and qualifier so we can use it with item.addMetadata()
                    String[] iso3166Alpha2FieldParts = iso3166Alpha2Field.split("\\.");
                    System.out.println("schema:" + iso3166Alpha2FieldParts[0]);
                    System.out.println("element:" + iso3166Alpha2FieldParts[1]);
                    System.out.println("qualifier:" + iso3166Alpha2FieldParts[2]);

                    Integer addedCodeCount = 0;
                    for (Metadatum itemCountry : itemCountries) {
                        //check ISO 3166-1 countries
                        for (CountriesVocabulary.Country country : isocodesCountriesJson.countries) {
                            if (itemCountry.value.equalsIgnoreCase(country.getName()) || itemCountry.value.equalsIgnoreCase(country.get_official_name()) || itemCountry.value.equalsIgnoreCase(country.get_common_name())) {
                                System.out.println(itemHandle + ": adding country code " + country.getAlpha_2());

                                try {
                                    // we have the field as a string, so we need to split/tokenize it here actually
                                    item.addMetadata("cg", "coverage", "iso3166-alpha2", "en_US", country.getAlpha_2());
                                    item.update();

                                    addedCodeCount++;

                                    result = itemHandle + ": added " + addedCodeCount + " country code(s)";
                                    status = Curator.CURATE_SUCCESS;
                                } catch (SQLException | AuthorizeException sqle) {
                                    log.debug(sqle.getMessage());
                                    result = itemHandle + ": error";
                                    status = Curator.CURATE_ERROR;
                                }
                            }
                        }
                        //check CGSpace countries
                        for (CountriesVocabulary.Country country : cgspaceCountriesJson.countries) {
                            if (itemCountry.value.equalsIgnoreCase(country.getCgspace_name())) {
                                System.out.println(itemHandle + ": adding country code " + country.getAlpha_2());

                                try {
                                    // we have the field as a string, so we need to split/tokenize it here actually
                                    item.addMetadata("cg", "coverage", "iso3166-alpha2", "en_US", country.getAlpha_2());
                                    item.update();

                                    addedCodeCount++;

                                    result = itemHandle + ": added " + addedCodeCount + " country code(s)";
                                    status = Curator.CURATE_SUCCESS;
                                } catch (SQLException | AuthorizeException sqle) {
                                    log.debug(sqle.getMessage());
                                    result = itemHandle + ": error";
                                    status = Curator.CURATE_ERROR;
                                }
                            }
                        }
                    }
                } else {
                    result = itemHandle + ": oh snap, we have countries and codes... not sure what to do";
                    status = Curator.CURATE_SUCCESS;
                }
            }

            setResult(result);
            report(result);
		}

        return status;
    }
}