All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.dspace.license.CCLicenseConnectorServiceImpl Maven / Gradle / Ivy

    The newest version!
    /**
 * 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.license;

import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;
import java.text.MessageFormat;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
import org.apache.logging.log4j.Logger;
import org.dspace.services.ConfigurationService;
import org.jdom2.Attribute;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.JDOMException;
import org.jdom2.filter.Filters;
import org.jdom2.input.SAXBuilder;
import org.jdom2.xpath.XPathExpression;
import org.jdom2.xpath.XPathFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.xml.sax.InputSource;

/**
 * Implementation for the Creative commons license connector service.
 * This class is responsible for all the calls to the CC license API and parsing the response
 */
public class CCLicenseConnectorServiceImpl implements CCLicenseConnectorService, InitializingBean {

    private Logger log = org.apache.logging.log4j.LogManager.getLogger(CCLicenseConnectorServiceImpl.class);

    private CloseableHttpClient client;
    protected SAXBuilder parser = new SAXBuilder();

    private String postArgument = "answers";
    private String postAnswerFormat =
            " " +
                    "{1}" +
                    "" +
                    "{2}" +
                    "" +
                    "";


    @Autowired
    private ConfigurationService configurationService;

    @Override
    public void afterPropertiesSet() throws Exception {
        HttpClientBuilder builder = HttpClientBuilder.create();

        client = builder
                .disableAutomaticRetries()
                .setMaxConnTotal(5)
                .build();

        // disallow DTD parsing to ensure no XXE attacks can occur.
        // See https://cheatsheetseries.owasp.org/cheatsheets/XML_External_Entity_Prevention_Cheat_Sheet.html
        parser.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
    }

    /**
     * Retrieves the CC Licenses for the provided language from the CC License API
     *
     * @param language - the language to retrieve the licenses for
     * @return a map of licenses with the id and the license for the provided language
     */
    public Map retrieveLicenses(String language) {
        String ccLicenseUrl = configurationService.getProperty("cc.api.rooturl");

        String uri = ccLicenseUrl + "/?locale=" + language;
        HttpGet httpGet = new HttpGet(uri);

        List licenses;
        try (CloseableHttpResponse response = client.execute(httpGet)) {
            licenses = retrieveLicenses(response);
        } catch (JDOMException | IOException e) {
            log.error("Error while retrieving the license details using url: " + uri, e);
            licenses = Collections.emptyList();
        }

        Map ccLicenses = new HashMap<>();

        for (String license : licenses) {

            String licenseUri = ccLicenseUrl + "/license/" + license + "?locale=" + language;
            HttpGet licenseHttpGet = new HttpGet(licenseUri);
            try (CloseableHttpResponse response = client.execute(licenseHttpGet)) {
                CCLicense ccLicense = retrieveLicenseObject(license, response);
                ccLicenses.put(ccLicense.getLicenseId(), ccLicense);
            } catch (JDOMException | IOException e) {
                log.error("Error while retrieving the license details using url: " + licenseUri, e);
            }
        }

        return ccLicenses;
    }

    /**
     * Retrieve the list of licenses from the response from the CC License API and remove the licenses configured
     * to be excluded
     *
     * @param response The response from the API
     * @return a list of license identifiers for which details need to be retrieved
     * @throws IOException
     * @throws JDOMException
     */
    private List retrieveLicenses(CloseableHttpResponse response)
            throws IOException, JDOMException {

        List domains = new LinkedList<>();
        String[] excludedLicenses = configurationService.getArrayProperty("cc.license.classfilter");

        String responseString = EntityUtils.toString(response.getEntity());
        XPathExpression licenseClassXpath =
            XPathFactory.instance().compile("//licenses/license", Filters.element());

        try (StringReader stringReader = new StringReader(responseString)) {
            InputSource is = new InputSource(stringReader);
            org.jdom2.Document classDoc = this.parser.build(is);

            List elements = licenseClassXpath.evaluate(classDoc);
            for (Element element : elements) {
                String licenseId = getSingleNodeValue(element, "@id");
                if (StringUtils.isNotBlank(licenseId) && !ArrayUtils.contains(excludedLicenses, licenseId)) {
                    domains.add(licenseId);
                }
            }
        }

        return domains;

    }

    /**
     * Parse the response for a single CC License and return the corresponding CC License Object
     *
     * @param licenseId the license id of the CC License to retrieve
     * @param response  for a specific CC License response
     * @return the corresponding CC License Object
     * @throws IOException
     * @throws JDOMException
     */
    private CCLicense retrieveLicenseObject(final String licenseId, CloseableHttpResponse response)
            throws IOException, JDOMException {

        String responseString = EntityUtils.toString(response.getEntity());

        XPathExpression licenseClassXpath =
            XPathFactory.instance().compile("//licenseclass", Filters.fpassthrough());
        XPathExpression licenseFieldXpath =
            XPathFactory.instance().compile("field", Filters.element());

        try (StringReader stringReader = new StringReader(responseString)) {
            InputSource is = new InputSource(stringReader);

            org.jdom2.Document classDoc = this.parser.build(is);

            Object element = licenseClassXpath.evaluateFirst(classDoc);
            String licenseLabel = getSingleNodeValue(element, "label");

            List ccLicenseFields = new LinkedList<>();

            List licenseFields = licenseFieldXpath.evaluate(element);
            for (Element licenseField : licenseFields) {
                CCLicenseField ccLicenseField = parseLicenseField(licenseField);
                ccLicenseFields.add(ccLicenseField);
            }

            return new CCLicense(licenseId, licenseLabel, ccLicenseFields);
        }
    }

    private CCLicenseField parseLicenseField(final Element licenseField) {
        String id = getSingleNodeValue(licenseField, "@id");
        String label = getSingleNodeValue(licenseField, "label");
        String description = getSingleNodeValue(licenseField, "description");

        XPathExpression enumXpath =
            XPathFactory.instance().compile("enum", Filters.element());
        List enums = enumXpath.evaluate(licenseField);

        List ccLicenseFieldEnumList = new LinkedList<>();

        for (Element enumElement : enums) {
            CCLicenseFieldEnum ccLicenseFieldEnum = parseEnum(enumElement);
            ccLicenseFieldEnumList.add(ccLicenseFieldEnum);
        }

        return new CCLicenseField(id, label, description, ccLicenseFieldEnumList);

    }

    private CCLicenseFieldEnum parseEnum(final Element enumElement) {
        String id = getSingleNodeValue(enumElement, "@id");
        String label = getSingleNodeValue(enumElement, "label");
        String description = getSingleNodeValue(enumElement, "description");

        return new CCLicenseFieldEnum(id, label, description);
    }


    private String getNodeValue(final Object el) {
        if (el instanceof Element) {
            return ((Element) el).getValue();
        } else if (el instanceof Attribute) {
            return ((Attribute) el).getValue();
        } else if (el instanceof String) {
            return (String) el;
        } else {
            return null;
        }
    }

    private String getSingleNodeValue(final Object t, String query) {
        XPathExpression xpath =
            XPathFactory.instance().compile(query, Filters.fpassthrough());
        Object singleNode = xpath.evaluateFirst(t);

        return getNodeValue(singleNode);
    }

    /**
     * Retrieve the CC License URI based on the provided license id, language and answers to the field questions from
     * the CC License API
     *
     * @param licenseId - the ID of the license
     * @param language  - the language for which to retrieve the full answerMap
     * @param answerMap - the answers to the different field questions
     * @return the CC License URI
     */
    public String retrieveRightsByQuestion(String licenseId,
                                           String language,
                                           Map answerMap) {

        String ccLicenseUrl = configurationService.getProperty("cc.api.rooturl");


        HttpPost httpPost = new HttpPost(ccLicenseUrl + "/license/" + licenseId + "/issue");


        String answers = createAnswerString(answerMap);
        MultipartEntityBuilder builder = MultipartEntityBuilder.create();
        String text = MessageFormat.format(postAnswerFormat, licenseId, language, answers);
        builder.addTextBody(postArgument, text);

        HttpEntity multipart = builder.build();

        httpPost.setEntity(multipart);

        try (CloseableHttpResponse response = client.execute(httpPost)) {
            return retrieveLicenseUri(response);
        } catch (JDOMException | IOException e) {
            log.error("Error while retrieving the license uri for license : " + licenseId + " with answers "
                              + answerMap.toString(), e);
        }
        return null;
    }

    /**
     * Parse the response for the CC License URI request and return the corresponding CC License URI
     *
     * @param response for a specific CC License URI response
     * @return the corresponding CC License URI as a string
     * @throws IOException
     * @throws JDOMException
     */
    private String retrieveLicenseUri(final CloseableHttpResponse response)
            throws IOException, JDOMException {

        String responseString = EntityUtils.toString(response.getEntity());
        XPathExpression licenseClassXpath =
            XPathFactory.instance().compile("//result/license-uri", Filters.fpassthrough());

        try (StringReader stringReader = new StringReader(responseString)) {
            InputSource is = new InputSource(stringReader);
            org.jdom2.Document classDoc = this.parser.build(is);

            Object node = licenseClassXpath.evaluateFirst(classDoc);
            String nodeValue = getNodeValue(node);

            if (StringUtils.isNotBlank(nodeValue)) {
                return nodeValue;
            }
        }
        return null;
    }

    private String createAnswerString(final Map parameterMap) {
        StringBuilder sb = new StringBuilder();
        for (String key : parameterMap.keySet()) {
            sb.append("<");
            sb.append(key);
            sb.append(">");
            sb.append(parameterMap.get(key));
            sb.append("");
        }
        return sb.toString();
    }

    /**
     * Retrieve the license RDF document based on the license URI
     *
     * @param licenseURI - The license URI for which to retrieve the license RDF document
     * @return the license RDF document
     * @throws IOException
     */
    @Override
    public Document retrieveLicenseRDFDoc(String licenseURI) throws IOException {
        String ccLicenseUrl = configurationService.getProperty("cc.api.rooturl");

        String issueUrl = ccLicenseUrl + "/details?license-uri=" + licenseURI;

        URL request_url;
        try {
            request_url = new URL(issueUrl);
        } catch (MalformedURLException e) {
            return null;
        }
        URLConnection connection = request_url.openConnection();
        connection.setDoOutput(true);
        try {
            // parsing document from input stream
            InputStream stream = connection.getInputStream();
            Document doc = parser.build(stream);
            return doc;

        } catch (Exception e) {
            log.error("Error while retrieving the license document for URI: " + licenseURI, e);
        }
        return null;
    }

    /**
     * Retrieve the license Name from the license document
     *
     * @param doc - The license document from which to retrieve the license name
     * @return the license name
     */
    public String retrieveLicenseName(final Document doc) {
        return getSingleNodeValue(doc, "//result/license-name");
    }

}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy