Skip to content

Commit

Permalink
Merge pull request IQSS#8682 from IQSS/8580-sword-rights
Browse files Browse the repository at this point in the history 
SWORD: if custom terms disabled, report error IQSS#8580
  • Loading branch information
@kcondon
kcondon authored May 18, 2022
2 parents bbb9a4d + 593213a commit 013fcd8
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 74 deletions.
2 changes: 1 addition & 1 deletion doc/sphinx-guides/source/api/sword.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ New features as of v1.1

- "Contributor" can now be populated and the "Type" (Editor, Funder, Researcher, etc.) can be specified with an XML attribute. For example: ``<dcterms:contributor type="Funder">CaffeineForAll</dcterms:contributor>``

- "License" can now be set with ``dcterms:license`` and the possible values determined by the installation ("CC0 1.0" and "CC BY 4.0" by default). "License" interacts with "Terms of Use" (``dcterms:rights``) in that if you include ``dcterms:rights`` in the XML and don't include ``dcterms:license``, the license will be "Custom Dataset Terms" and "Terms of Use" will be populated. If you don't include ``dcterms:rights``, the default license will be used. It is invalid to specify a license and also include ``dcterms:rights``; an error will be returned. For backwards compatibility, ``dcterms:rights`` is allowed to be blank (i.e. ``<dcterms:rights></dcterms:rights>``) but blank values will not be persisted to the database and the license will be set to "Custom Dataset Terms".
- "License" can now be set with ``dcterms:license`` and the possible values determined by the installation ("CC0 1.0" and "CC BY 4.0" by default). "License" interacts with "Terms of Use" (``dcterms:rights``) in that if you include ``dcterms:rights`` in the XML and don't include ``dcterms:license``, the license will be "Custom Dataset Terms" and "Terms of Use" will be populated. If you don't include ``dcterms:rights``, the default license will be used. It is invalid to specify a license and also include ``dcterms:rights``; an error will be returned. For backwards compatibility, ``dcterms:rights`` is allowed to be blank (i.e. ``<dcterms:rights></dcterms:rights>``) but blank values will not be persisted to the database and the license will be set to "Custom Dataset Terms". Note that if admins of an installation have disabled "Custom Dataset Terms" you will get an error if you try to pass ``dcterms:rights``.

- "Contact E-mail" is automatically populated from dataset owner's email.

Expand Down
8 changes: 8 additions & 0 deletions src/main/java/edu/harvard/iq/dataverse/api/datadeposit/SwordServiceBean.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import edu.harvard.iq.dataverse.license.License;
import edu.harvard.iq.dataverse.license.LicenseServiceBean;
import edu.harvard.iq.dataverse.util.BundleUtil;
import edu.harvard.iq.dataverse.util.SystemConfig;
import java.util.ArrayList;

import java.util.List;
Expand All @@ -36,6 +37,8 @@ public class SwordServiceBean {
DatasetFieldServiceBean datasetFieldService;
@Inject
LicenseServiceBean licenseServiceBean;
@EJB
SystemConfig systemConfig;

/**
* Mutate the dataset version, adding a datasetContact (email address) from
Expand Down Expand Up @@ -150,6 +153,11 @@ public void addDatasetSubjectIfMissing(DatasetVersion datasetVersion) {
public void setDatasetLicenseAndTermsOfUse(DatasetVersion datasetVersionToMutate, SwordEntry swordEntry) throws SwordError {
Map<String, List<String>> dcterms = swordEntry.getDublinCore();
List<String> listOfLicensesProvided = dcterms.get("license");
List<String> rights = dcterms.get("rights");
if (rights != null && !systemConfig.isAllowCustomTerms()) {
throw new SwordError("Custom Terms (dcterms:rights) are not allowed.");
}

TermsOfUseAndAccess terms = new TermsOfUseAndAccess();
datasetVersionToMutate.setTermsOfUseAndAccess(terms);
terms.setDatasetVersion(datasetVersionToMutate);
Expand Down
78 changes: 5 additions & 73 deletions src/main/java/edu/harvard/iq/dataverse/api/imports/ImportGenericServiceBean.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import edu.harvard.iq.dataverse.api.dto.*;
import edu.harvard.iq.dataverse.api.dto.FieldDTO;
import edu.harvard.iq.dataverse.api.dto.MetadataBlockDTO;
import edu.harvard.iq.dataverse.license.LicenseServiceBean;
import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
import edu.harvard.iq.dataverse.util.StringUtil;
import edu.harvard.iq.dataverse.util.json.JsonParseException;
Expand Down Expand Up @@ -67,6 +68,9 @@ public class ImportGenericServiceBean {
@EJB
SettingsServiceBean settingsService;

@EJB
LicenseServiceBean licenseService;

@PersistenceContext(unitName = "VDCNet-ejbPU")
private EntityManager em;

Expand Down Expand Up @@ -103,7 +107,7 @@ public void importXML(String xmlToParse, String foreignFormat, DatasetVersion da
logger.fine(json);
JsonReader jsonReader = Json.createReader(new StringReader(json));
JsonObject obj = jsonReader.readObject();
DatasetVersion dv = new JsonParser(datasetFieldSvc, blockService, settingsService).parseDatasetVersion(obj, datasetVersion);
DatasetVersion dv = new JsonParser(datasetFieldSvc, blockService, settingsService, licenseService).parseDatasetVersion(obj, datasetVersion);
} catch (XMLStreamException ex) {
//Logger.getLogger("global").log(Level.SEVERE, null, ex);
throw new EJBException("ERROR occurred while parsing XML fragment ("+xmlToParse.substring(0, 64)+"...); ", ex);
Expand All @@ -115,50 +119,6 @@ public void importXML(String xmlToParse, String foreignFormat, DatasetVersion da
} catch (XMLStreamException ex) {}
}
}

public void importXML(File xmlFile, String foreignFormat, DatasetVersion datasetVersion) {

FileInputStream in = null;
XMLStreamReader xmlr = null;

// look up the foreign metadata mapping for this format:

ForeignMetadataFormatMapping mappingSupported = findFormatMappingByName (foreignFormat);
if (mappingSupported == null) {
throw new EJBException("Unknown/unsupported foreign metadata format "+foreignFormat);
}

try {
in = new FileInputStream(xmlFile);
XMLInputFactory xmlFactory = javax.xml.stream.XMLInputFactory.newInstance();
xmlr = xmlFactory.createXMLStreamReader(in);
DatasetDTO datasetDTO = processXML(xmlr, mappingSupported);

Gson gson = new Gson();
String json = gson.toJson(datasetDTO.getDatasetVersion());
logger.info("Json:\n"+json);
JsonReader jsonReader = Json.createReader(new StringReader(json));
JsonObject obj = jsonReader.readObject();
DatasetVersion dv = new JsonParser(datasetFieldSvc, blockService, settingsService).parseDatasetVersion(obj, datasetVersion);
} catch (FileNotFoundException ex) {
//Logger.getLogger("global").log(Level.SEVERE, null, ex);
throw new EJBException("ERROR occurred in mapDDI: File Not Found!");
} catch (XMLStreamException ex) {
//Logger.getLogger("global").log(Level.SEVERE, null, ex);
throw new EJBException("ERROR occurred while parsing XML (file "+xmlFile.getAbsolutePath()+"); ", ex);
} catch (JsonParseException ex) {
Logger.getLogger(ImportGenericServiceBean.class.getName()).log(Level.SEVERE, null, ex);
} finally {
try {
if (xmlr != null) { xmlr.close(); }
} catch (XMLStreamException ex) {}

try {
if (in != null) { in.close();}
} catch (IOException ex) {}
}

}

public DatasetDTO processXML( XMLStreamReader xmlr, ForeignMetadataFormatMapping foreignFormatMapping) throws XMLStreamException {
// init - similarly to what I'm doing in the metadata extraction code?
Expand Down Expand Up @@ -551,34 +511,6 @@ public DatasetDTO doImport(String xmlToParse) throws XMLStreamException {
}
return datasetDTO;
}

public void importDCTerms(String xmlToParse, DatasetVersion datasetVersion, DatasetFieldServiceBean datasetFieldSvc, MetadataBlockServiceBean blockService, SettingsServiceBean settingsService) {
DatasetDTO datasetDTO = this.initializeDataset();
try {
// Read docDescr and studyDesc into DTO objects.
Map<String, String> fileMap = mapDCTerms(xmlToParse, datasetDTO);
//
// convert DTO to Json,
Gson gson = new Gson();
String json = gson.toJson(datasetDTO.getDatasetVersion());
JsonReader jsonReader = Json.createReader(new StringReader(json));
JsonObject obj = jsonReader.readObject();
//and call parse Json to read it into a datasetVersion
DatasetVersion dv = new JsonParser(datasetFieldSvc, blockService, settingsService).parseDatasetVersion(obj, datasetVersion);
} catch (XMLStreamException | JsonParseException e) {
// EMK TODO: exception handling
e.printStackTrace();
}

//EMK TODO: Call methods for reading FileMetadata and related objects from xml, return list of FileMetadata objects.
/*try {
Map<String, DataTable> dataTableMap = new DataTableImportDDI().processDataDscr(xmlr);
} catch(Exception e) {
}*/
// Save Dataset and DatasetVersion in database
}

public Map<String, String> mapDCTerms(String xmlToParse, DatasetDTO datasetDTO) throws XMLStreamException {

Expand Down
1 change: 1 addition & 0 deletions src/main/java/edu/harvard/iq/dataverse/util/json/JsonParser.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ public class JsonParser {
*/
boolean lenient = false;

@Deprecated
public JsonParser(DatasetFieldServiceBean datasetFieldSvc, MetadataBlockServiceBean blockService, SettingsServiceBean settingsService) {
this.datasetFieldSvc = datasetFieldSvc;
this.blockService = blockService;
Expand Down
16 changes: 16 additions & 0 deletions src/test/java/edu/harvard/iq/dataverse/api/SwordIT.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import com.jayway.restassured.response.Response;
import edu.harvard.iq.dataverse.GlobalId;
import edu.harvard.iq.dataverse.api.datadeposit.SwordConfigurationImpl;
import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
import java.io.File;
import java.io.IOException;
import java.nio.file.Paths;
Expand Down Expand Up @@ -725,6 +726,19 @@ public void testCustomTerms() {
.statusCode(OK.getStatusCode())
.body("data.latestVersion.termsOfUse", equalTo("Call me"))
.body("data.latestVersion.license", equalTo(null));

UtilIT.setSetting(SettingsServiceBean.Key.AllowCustomTermsOfUse, "false")
.then().assertThat().statusCode(OK.getStatusCode());

Response createDatasetCustomTermsDisabled = UtilIT.createDatasetViaSwordApi(dataverseAlias, title, description, license, rights, apiToken);
createDatasetCustomTermsDisabled.prettyPrint();
createDatasetCustomTermsDisabled.then().assertThat()
// <summary>Custom Terms (dcterms:rights) are not allowed.</summary>
.statusCode(BAD_REQUEST.getStatusCode());

// cleanup, allow custom terms again (delete because it defaults to true)
UtilIT.deleteSetting(SettingsServiceBean.Key.AllowCustomTermsOfUse);

}

@Test
Expand Down Expand Up @@ -958,6 +972,8 @@ public void testDeleteFiles() {

@AfterClass
public static void tearDownClass() {
// cleanup, allow custom terms again (delete because it defaults to true)
UtilIT.deleteSetting(SettingsServiceBean.Key.AllowCustomTermsOfUse);
UtilIT.deleteUser(superuser);
}

Expand Down

0 comments on commit 013fcd8

Please sign in to comment.